fix: revert #955 and add Query/HasParent into x/collection (#959)

* Revert "fix: return nil where the parent not exists in x/collection Query/Parent (#955)" This reverts commit d562b43. * Add Query/HasParent * Implement Query/HasParent * Wrap the error with gRPC NotFound * Update CHANGELOG.md * Apply feedbacks on reviews * Update comment in proto
Finschia · Apr 10, 2023 · b842111 · b842111
1 parent 0c74e6f
commit b842111
Show file tree

Hide file tree

Showing 9 changed files with 1,040 additions and 126 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -54,6 +54,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/collection) [\#953](https://github.com/line/lbm-sdk/pull/953) Allow zero amount of coin in x/collection Query/Balance
 * (x/collection) [\#954](https://github.com/line/lbm-sdk/pull/954) Remove duplicated events in x/collection Msg/Modify
 * (x/collection) [\#955](https://github.com/line/lbm-sdk/pull/955) Return nil where the parent not exists in x/collection Query/Parent
+* (x/collection) [\#959](https://github.com/line/lbm-sdk/pull/959) Revert #955 and add Query/HasParent into x/collection
 
 ### Removed
 

diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -27528,6 +27528,225 @@ paths:
           format: boolean
       tags:
         - Query
+  '/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/has_parent':
+    get:
+      summary: HasParent queries whether a given nft has its parent.
+      operationId: HasParent
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              has_parent:
+                type: boolean
+                format: boolean
+                description: whether the token has its parent.
+            description: >-
+              QueryHasParentResponse is the response type for the
+              Query/HasParent RPC method.
+        default:
+          description: An unexpected error response
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    type_url:
+                      type: string
+                      description: >-
+                        A URL/resource name that uniquely identifies the type of
+                        the serialized
+
+                        protocol buffer message. This string must contain at
+                        least
+
+                        one "/" character. The last segment of the URL's path
+                        must represent
+
+                        the fully qualified name of the type (as in
+
+                        `path/google.protobuf.Duration`). The name should be in
+                        a canonical form
+
+                        (e.g., leading "." is not accepted).
+
+
+                        In practice, teams usually precompile into the binary
+                        all types that they
+
+                        expect it to use in the context of Any. However, for
+                        URLs which use the
+
+                        scheme `http`, `https`, or no scheme, one can optionally
+                        set up a type
+
+                        server that maps type URLs to message definitions as
+                        follows:
+
+
+                        * If no scheme is provided, `https` is assumed.
+
+                        * An HTTP GET on the URL must yield a
+                        [google.protobuf.Type][]
+                          value in binary format, or produce an error.
+                        * Applications are allowed to cache lookup results based
+                        on the
+                          URL, or have them precompiled into a binary to avoid any
+                          lookup. Therefore, binary compatibility needs to be preserved
+                          on changes to types. (Use versioned type names to manage
+                          breaking changes.)
+
+                        Note: this functionality is not currently available in
+                        the official
+
+                        protobuf release, and it is not used for type URLs
+                        beginning with
+
+                        type.googleapis.com.
+
+
+                        Schemes other than `http`, `https` (or the empty scheme)
+                        might be
+
+                        used with implementation specific semantics.
+                    value:
+                      type: string
+                      format: byte
+                      description: >-
+                        Must be a valid serialized protocol buffer of the above
+                        specified type.
+                  description: >-
+                    `Any` contains an arbitrary serialized protocol buffer
+                    message along with a
+
+                    URL that describes the type of the serialized message.
+
+
+                    Protobuf library provides support to pack/unpack Any values
+                    in the form
+
+                    of utility functions or additional generated methods of the
+                    Any type.
+
+
+                    Example 1: Pack and unpack a message in C++.
+
+                        Foo foo = ...;
+                        Any any;
+                        any.PackFrom(foo);
+                        ...
+                        if (any.UnpackTo(&foo)) {
+                          ...
+                        }
+
+                    Example 2: Pack and unpack a message in Java.
+
+                        Foo foo = ...;
+                        Any any = Any.pack(foo);
+                        ...
+                        if (any.is(Foo.class)) {
+                          foo = any.unpack(Foo.class);
+                        }
+
+                     Example 3: Pack and unpack a message in Python.
+
+                        foo = Foo(...)
+                        any = Any()
+                        any.Pack(foo)
+                        ...
+                        if any.Is(Foo.DESCRIPTOR):
+                          any.Unpack(foo)
+                          ...
+
+                     Example 4: Pack and unpack a message in Go
+
+                         foo := &pb.Foo{...}
+                         any, err := ptypes.MarshalAny(foo)
+                         ...
+                         foo := &pb.Foo{}
+                         if err := ptypes.UnmarshalAny(any, foo); err != nil {
+                           ...
+                         }
+
+                    The pack methods provided by protobuf library will by
+                    default use
+
+                    'type.googleapis.com/full.type.name' as the type URL and the
+                    unpack
+
+                    methods only use the fully qualified type name after the
+                    last '/'
+
+                    in the type URL, for example "foo.bar.com/x/y.z" will yield
+                    type
+
+                    name "y.z".
+
+
+
+                    JSON
+
+                    ====
+
+                    The JSON representation of an `Any` value uses the regular
+
+                    representation of the deserialized, embedded message, with
+                    an
+
+                    additional field `@type` which contains the type URL.
+                    Example:
+
+                        package google.profile;
+                        message Person {
+                          string first_name = 1;
+                          string last_name = 2;
+                        }
+
+                        {
+                          "@type": "type.googleapis.com/google.profile.Person",
+                          "firstName": <string>,
+                          "lastName": <string>
+                        }
+
+                    If the embedded message type is well-known and has a custom
+                    JSON
+
+                    representation, that representation will be embedded adding
+                    a field
+
+                    `value` which holds the custom JSON in addition to the
+                    `@type`
+
+                    field. Example (for message [google.protobuf.Duration][]):
+
+                        {
+                          "@type": "type.googleapis.com/google.protobuf.Duration",
+                          "value": "1.212s"
+                        }
+      parameters:
+        - name: contract_id
+          description: contract id associated with the contract.
+          in: path
+          required: true
+          type: string
+        - name: token_id
+          description: token id associated wit the non-fungible token.
+          in: path
+          required: true
+          type: string
+      tags:
+        - Query
   '/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/parent':
     get:
       summary: Parent queries the parent of a given nft.
@@ -51415,6 +51634,16 @@ definitions:
     description: >-
       QueryGranteeGrantsResponse is the response type for the
       Query/GranteeGrants RPC method.
+  lbm.collection.v1.QueryHasParentResponse:
+    type: object
+    properties:
+      has_parent:
+        type: boolean
+        format: boolean
+        description: whether the token has its parent.
+    description: >-
+      QueryHasParentResponse is the response type for the Query/HasParent RPC
+      method.
   lbm.collection.v1.QueryHoldersByOperatorResponse:
     type: object
     properties:

diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -683,6 +683,8 @@
     - [QueryFTSupplyResponse](#lbm.collection.v1.QueryFTSupplyResponse)
     - [QueryGranteeGrantsRequest](#lbm.collection.v1.QueryGranteeGrantsRequest)
     - [QueryGranteeGrantsResponse](#lbm.collection.v1.QueryGranteeGrantsResponse)
+    - [QueryHasParentRequest](#lbm.collection.v1.QueryHasParentRequest)
+    - [QueryHasParentResponse](#lbm.collection.v1.QueryHasParentResponse)
     - [QueryHoldersByOperatorRequest](#lbm.collection.v1.QueryHoldersByOperatorRequest)
     - [QueryHoldersByOperatorResponse](#lbm.collection.v1.QueryHoldersByOperatorResponse)
     - [QueryIsOperatorForRequest](#lbm.collection.v1.QueryIsOperatorForRequest)
@@ -10279,6 +10281,37 @@ QueryGranteeGrantsResponse is the response type for the Query/GranteeGrants RPC
 
 
 
+<a name="lbm.collection.v1.QueryHasParentRequest"></a>
+
+### QueryHasParentRequest
+QueryHasParentRequest is the request type for the Query/HasParent RPC method.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `contract_id` | [string](#string) |  | contract id associated with the contract. |
+| `token_id` | [string](#string) |  | token id associated wit the non-fungible token. |
+
+
+
+
+
+
+<a name="lbm.collection.v1.QueryHasParentResponse"></a>
+
+### QueryHasParentResponse
+QueryHasParentResponse is the response type for the Query/HasParent RPC method.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `has_parent` | [bool](#bool) |  | whether the token has its parent. |
+
+
+
+
+
+
 <a name="lbm.collection.v1.QueryHoldersByOperatorRequest"></a>
 
 ### QueryHoldersByOperatorRequest
@@ -10624,6 +10657,7 @@ Since: 0.46.0 (finschia) | GET|/lbm/collection/v1/contracts/{contract_id}/token_
 | `TokenType` | [QueryTokenTypeRequest](#lbm.collection.v1.QueryTokenTypeRequest) | [QueryTokenTypeResponse](#lbm.collection.v1.QueryTokenTypeResponse) | TokenType queries metadata of a token type. | GET|/lbm/collection/v1/contracts/{contract_id}/token_types/{token_type}|
 | `Token` | [QueryTokenRequest](#lbm.collection.v1.QueryTokenRequest) | [QueryTokenResponse](#lbm.collection.v1.QueryTokenResponse) | Token queries a metadata of a token from its token id. | GET|/lbm/collection/v1/contracts/{contract_id}/tokens/{token_id}|
 | `Root` | [QueryRootRequest](#lbm.collection.v1.QueryRootRequest) | [QueryRootResponse](#lbm.collection.v1.QueryRootResponse) | Root queries the root of a given nft. | GET|/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/root|
+| `HasParent` | [QueryHasParentRequest](#lbm.collection.v1.QueryHasParentRequest) | [QueryHasParentResponse](#lbm.collection.v1.QueryHasParentResponse) | HasParent queries whether a given nft has its parent. | GET|/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/has_parent|
 | `Parent` | [QueryParentRequest](#lbm.collection.v1.QueryParentRequest) | [QueryParentResponse](#lbm.collection.v1.QueryParentResponse) | Parent queries the parent of a given nft. | GET|/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/parent|
 | `Children` | [QueryChildrenRequest](#lbm.collection.v1.QueryChildrenRequest) | [QueryChildrenResponse](#lbm.collection.v1.QueryChildrenResponse) | Children queries the children of a given nft. | GET|/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/children|
 | `GranteeGrants` | [QueryGranteeGrantsRequest](#lbm.collection.v1.QueryGranteeGrantsRequest) | [QueryGranteeGrantsResponse](#lbm.collection.v1.QueryGranteeGrantsResponse) | GranteeGrants queries all permissions on a given grantee. | GET|/lbm/collection/v1/contracts/{contract_id}/grants/{grantee}|

diff --git a/proto/lbm/collection/v1/query.proto b/proto/lbm/collection/v1/query.proto
@@ -80,6 +80,11 @@ service Query {
     option (google.api.http).get = "/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/root";
   }
 
+  // HasParent queries whether a given nft has its parent.
+  rpc HasParent(QueryHasParentRequest) returns (QueryHasParentResponse) {
+    option (google.api.http).get = "/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/has_parent";
+  }
+
   // Parent queries the parent of a given nft.
   rpc Parent(QueryParentRequest) returns (QueryParentResponse) {
     option (google.api.http).get = "/lbm/collection/v1/contracts/{contract_id}/nfts/{token_id}/parent";
@@ -299,6 +304,20 @@ message QueryRootResponse {
   NFT root = 1 [(gogoproto.nullable) = false];
 }
 
+// QueryHasParentRequest is the request type for the Query/HasParent RPC method.
+message QueryHasParentRequest {
+  // contract id associated with the contract.
+  string contract_id = 1;
+  // token id associated wit the non-fungible token.
+  string token_id = 2;
+}
+
+// QueryHasParentResponse is the response type for the Query/HasParent RPC method.
+message QueryHasParentResponse {
+  // whether the token has its parent.
+  bool has_parent = 1;
+}
+
 // QueryParentRequest is the request type for the Query/Parent RPC method.
 message QueryParentRequest {
   // contract id associated with the contract.