Skip to content

Commit

Permalink
feat: add Query/TokenClassTypeName (#622)
Browse files Browse the repository at this point in the history 
* Add Query/TokenClassTypeName

* Update CHANGELOG.md
  • Loading branch information
@0Tech
0Tech authored Aug 8, 2022
1 parent b9242f3 commit fed352c
Show file tree
Hide file tree
Showing 9 changed files with 1,091 additions and 123 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (server/grpc) [\#607](https://github.com/line/lbm-sdk/pull/607) revert gRPC block height header.
* (global) [\#611](https://github.com/line/lbm-sdk/pull/611) bump github.com/cosmos/cosmos-sdk from v0.45.1 to v0.45.6
* (simapp) [\#620](https://github.com/line/lbm-sdk/pull/620) chore: add iterator feature for simapp
* (x/collection) [\#622](https://github.com/line/lbm-sdk/pull/622) add Query/TokenClassTypeName

### Improvements

Expand Down
2 changes: 1 addition & 1 deletion client/docs/statik/statik.go
View file

Large diffs are not rendered by default.

244 changes: 244 additions & 0 deletions client/docs/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40418,6 +40418,238 @@ paths:
type: string
tags:
- Query
'/lbm/collection/v1/contracts/{contract_id}/token_classes/{class_id}/type_name':
get:
summary: >-
TokenClassTypeName queries the fully qualified message type name of a
token class from its class id.

Throws:

- ErrInvalidRequest
- `contract_id` is of invalid format.
- `class_id` is of invalid format.
- ErrNotFound
- there is no token class of `class_id`.
Since: 0.46.0 (finschia)
operationId: TokenClassTypeName
responses:
'200':
description: A successful response.
schema:
type: object
properties:
name:
type: string
description: type name of the token class.
description: >-
QueryTokenClassTypeNameResponse is the response type for the
Query/TokenClassTypeName RPC method.


Since: 0.46.0 (finschia)
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: class_id
description: class id associated with the token class.
in: path
required: true
type: string
tags:
- Query
'/lbm/collection/v1/contracts/{contract_id}/token_types':
get:
summary: |-
Expand Down Expand Up @@ -69400,6 +69632,18 @@ definitions:

Since: 0.46.0 (finschia)
description: QueryRootResponse is the response type for the Query/Root RPC method.
lbm.collection.v1.QueryTokenClassTypeNameResponse:
type: object
properties:
name:
type: string
description: type name of the token class.
description: >-
QueryTokenClassTypeNameResponse is the response type for the
Query/TokenClassTypeName RPC method.


Since: 0.46.0 (finschia)
lbm.collection.v1.QueryTokenResponse:
type: object
properties:
Expand Down
38 changes: 38 additions & 0 deletions docs/core/proto-docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,8 @@
- [QueryParentResponse](#lbm.collection.v1.QueryParentResponse)
- [QueryRootRequest](#lbm.collection.v1.QueryRootRequest)
- [QueryRootResponse](#lbm.collection.v1.QueryRootResponse)
- [QueryTokenClassTypeNameRequest](#lbm.collection.v1.QueryTokenClassTypeNameRequest)
- [QueryTokenClassTypeNameResponse](#lbm.collection.v1.QueryTokenClassTypeNameResponse)
- [QueryTokenRequest](#lbm.collection.v1.QueryTokenRequest)
- [QueryTokenResponse](#lbm.collection.v1.QueryTokenResponse)
- [QueryTokenTypeRequest](#lbm.collection.v1.QueryTokenTypeRequest)
Expand Down Expand Up @@ -15003,6 +15005,41 @@ QueryRootResponse is the response type for the Query/Root RPC method.



<a name="lbm.collection.v1.QueryTokenClassTypeNameRequest"></a>

### QueryTokenClassTypeNameRequest
QueryTokenClassTypeNameRequest is the request type for the Query/TokenClassTypeName RPC method.

Since: 0.46.0 (finschia)


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `class_id` | [string](#string) | | class id associated with the token class. |






<a name="lbm.collection.v1.QueryTokenClassTypeNameResponse"></a>

### QueryTokenClassTypeNameResponse
QueryTokenClassTypeNameResponse is the response type for the Query/TokenClassTypeName RPC method.

Since: 0.46.0 (finschia)


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `name` | [string](#string) | | type name of the token class. |






<a name="lbm.collection.v1.QueryTokenRequest"></a>

### QueryTokenRequest
Expand Down Expand Up @@ -15184,6 +15221,7 @@ Query defines the gRPC querier service.
| `NFTMinted` | [QueryNFTMintedRequest](#lbm.collection.v1.QueryNFTMintedRequest) | [QueryNFTMintedResponse](#lbm.collection.v1.QueryNFTMintedResponse) | NFTMinted queries the number of minted tokens from a given contract id and token type. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - `class_id` is of invalid format. - ErrNotFound - there is no token class of `class_id`. | GET|/lbm/collection/v1/contracts/{contract_id}/token_types/{token_type}/minted|
| `NFTBurnt` | [QueryNFTBurntRequest](#lbm.collection.v1.QueryNFTBurntRequest) | [QueryNFTBurntResponse](#lbm.collection.v1.QueryNFTBurntResponse) | NFTBurnt queries the number of burnt tokens from a given contract id and token type. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - `class_id` is of invalid format. - ErrNotFound - there is no token class of `class_id`. | GET|/lbm/collection/v1/contracts/{contract_id}/token_types/{token_type}/burnt|
| `Contract` | [QueryContractRequest](#lbm.collection.v1.QueryContractRequest) | [QueryContractResponse](#lbm.collection.v1.QueryContractResponse) | Contract queries a contract metadata based on its contract id. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - ErrNotFound - there is no contract of `contract_id`. | GET|/lbm/collection/v1/contracts/{contract_id}|
| `TokenClassTypeName` | [QueryTokenClassTypeNameRequest](#lbm.collection.v1.QueryTokenClassTypeNameRequest) | [QueryTokenClassTypeNameResponse](#lbm.collection.v1.QueryTokenClassTypeNameResponse) | TokenClassTypeName queries the fully qualified message type name of a token class from its class id. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - `class_id` is of invalid format. - ErrNotFound - there is no token class of `class_id`. Since: 0.46.0 (finschia) | GET|/lbm/collection/v1/contracts/{contract_id}/token_classes/{class_id}/type_name|
| `TokenType` | [QueryTokenTypeRequest](#lbm.collection.v1.QueryTokenTypeRequest) | [QueryTokenTypeResponse](#lbm.collection.v1.QueryTokenTypeResponse) | TokenType queries metadata of a token type. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - `class_id` is of invalid format. - ErrNotFound - there is no token class of `class_id`. | GET|/lbm/collection/v1/contracts/{contract_id}/token_types/{token_type}|
| `TokenTypes` | [QueryTokenTypesRequest](#lbm.collection.v1.QueryTokenTypesRequest) | [QueryTokenTypesResponse](#lbm.collection.v1.QueryTokenTypesResponse) | TokenTypes queries metadata of all the token types. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - ErrNotFound - there is no token contract of `contract_id`. | GET|/lbm/collection/v1/contracts/{contract_id}/token_types|
| `Token` | [QueryTokenRequest](#lbm.collection.v1.QueryTokenRequest) | [QueryTokenResponse](#lbm.collection.v1.QueryTokenResponse) | Token queries a metadata of a token from its token id. Throws: - ErrInvalidRequest - `contract_id` is of invalid format. - `token_id` is of invalid format. - ErrNotFound - there is no token of `token_id`. | GET|/lbm/collection/v1/contracts/{contract_id}/tokens/{token_id}|
Expand Down
30 changes: 30 additions & 0 deletions proto/lbm/collection/v1/query.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,18 @@ service Query {
option (google.api.http).get = "/lbm/collection/v1/contracts/{contract_id}";
}

// TokenClassTypeName queries the fully qualified message type name of a token class from its class id.
// Throws:
// - ErrInvalidRequest
// - `contract_id` is of invalid format.
// - `class_id` is of invalid format.
// - ErrNotFound
// - there is no token class of `class_id`.
// Since: 0.46.0 (finschia)
rpc TokenClassTypeName(QueryTokenClassTypeNameRequest) returns (QueryTokenClassTypeNameResponse) {
option (google.api.http).get = "/lbm/collection/v1/contracts/{contract_id}/token_classes/{class_id}/type_name";
}

// TokenType queries metadata of a token type.
// Throws:
// - ErrInvalidRequest
Expand Down Expand Up @@ -360,6 +372,24 @@ message QueryContractResponse {
Contract contract = 1 [(gogoproto.nullable) = false];
}

// QueryTokenClassTypeNameRequest is the request type for the Query/TokenClassTypeName RPC method.
//
// Since: 0.46.0 (finschia)
message QueryTokenClassTypeNameRequest {
// contract id associated with the contract.
string contract_id = 1;
// class id associated with the token class.
string class_id = 2;
}

// QueryTokenClassTypeNameResponse is the response type for the Query/TokenClassTypeName RPC method.
//
// Since: 0.46.0 (finschia)
message QueryTokenClassTypeNameResponse {
// type name of the token class.
string name = 1;
}

// QueryTokenTypeRequest is the request type for the Query/TokenType RPC method.
message QueryTokenTypeRequest {
// contract id associated with the contract.
Expand Down
Loading

0 comments on commit fed352c

Please sign in to comment.