Skip to content

Commit

Permalink
docs: update proto format and related document.
Browse files Browse the repository at this point in the history
  • Loading branch information
zemyblue committed Feb 6, 2023
1 parent 8e53507 commit 8e66f25
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 17 deletions.
25 changes: 14 additions & 11 deletions docs/core/proto-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9246,12 +9246,15 @@ Params defines the parameters for the collection module.
Deprecated: use TokenClass

TokenType defines the information of token type.
It represents a NFTClass whose class_id is token_type.

Note: There is no TokenType instance for FTClass.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type defines the unique identifier of the token type. |
| `token_type` | [string](#string) | | token type defines the unique identifier of the token type. the format of the value is identical to that of class_id. |
| `name` | [string](#string) | | name defines the human-readable name of the token type. |
| `meta` | [string](#string) | | meta is a brief description of the token type. |

Expand Down Expand Up @@ -9424,7 +9427,7 @@ Since: 0.46.0 (finschia)
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `operator` | [string](#string) | | address which triggered the create. |
| `token_type` | [string](#string) | | token type associated with the token class. |
| `token_type` | [string](#string) | | token type associated with the token class. refer to TokenType for the definition. |
| `name` | [string](#string) | | name of the token class. |
| `meta` | [string](#string) | | metadata of the token class. |

Expand Down Expand Up @@ -9567,7 +9570,7 @@ Since: 0.46.0 (finschia)
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `operator` | [string](#string) | | address which triggered the modify. |
| `token_type` | [string](#string) | | token type associated with the token class. |
| `token_type` | [string](#string) | | token type associated with the token class. refer to TokenType for the definition. |
| `changes` | [Attribute](#lbm.collection.v1.Attribute) | repeated | changes of the attributes applied. possible attribute keys are same as those of MsgModify. |
| `type_name` | [string](#string) | | type name of the token class. |

Expand Down Expand Up @@ -10344,7 +10347,7 @@ QueryNFTBurntRequest is the request type for the Query/NFTBurnt RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type associated with the token type. |
| `token_type` | [string](#string) | | token type associated with the token type. refer to TokenType for the definition. |



Expand Down Expand Up @@ -10375,7 +10378,7 @@ QueryNFTMintedRequest is the request type for the Query/NFTMinted RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type associated with the token type. |
| `token_type` | [string](#string) | | token type associated with the token type. refer to TokenType for the definition. |



Expand Down Expand Up @@ -10406,7 +10409,7 @@ QueryNFTSupplyRequest is the request type for the Query/NFTSupply RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type associated with the token type. |
| `token_type` | [string](#string) | | token type associated with the token type. refer to TokenType for the definition. |



Expand Down Expand Up @@ -10565,7 +10568,7 @@ QueryTokenTypeRequest is the request type for the Query/TokenType RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type associated with the token type. |
| `token_type` | [string](#string) | | token type associated with the token type. refer to TokenType for the definition. |



Expand Down Expand Up @@ -10660,7 +10663,7 @@ QueryTokensWithTokenTypeRequest is the request type for the Query/TokensWithToke
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `token_type` | [string](#string) | | token type associated with the token type. |
| `token_type` | [string](#string) | | token type associated with the token type. refer to TokenType for the definition. |
| `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | pagination defines an optional pagination for the request. |


Expand Down Expand Up @@ -10740,7 +10743,7 @@ MintNFTParam defines a parameter for minting nft.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `token_type` | [string](#string) | | token type or class id of the nft. Note: it cannot start with zero. |
| `token_type` | [string](#string) | | token type or class id of the nft. Note: it cannot start with zero. refer to TokenType for the definition. |
| `name` | [string](#string) | | name defines the human-readable name of the nft (mandatory). Note: it has an app-specific limit in length. |
| `meta` | [string](#string) | | meta is a brief description of the nft. Note: it has an app-specific limit in length. |

Expand Down Expand Up @@ -11019,7 +11022,7 @@ MsgIssueNFTResponse is the Msg/IssueNFT response type.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `token_type` | [string](#string) | | id of the new token type. |
| `token_type` | [string](#string) | | id of the new token type. refer to TokenType for the definition. |



Expand Down Expand Up @@ -11101,7 +11104,7 @@ MsgModify is the Msg/Modify request type.
| ----- | ---- | ----- | ----------- |
| `contract_id` | [string](#string) | | contract id associated with the contract. |
| `owner` | [string](#string) | | the address of the grantee which must have modify permission. |
| `token_type` | [string](#string) | | token type of the token. |
| `token_type` | [string](#string) | | token type of the token. refer to TokenType for the definition. |
| `token_index` | [string](#string) | | token index of the token. if index is empty, it would modify the corresponding token type. if index is not empty, it would modify the corresponding nft. Note: if token type is of FTs, the index cannot be empty. |
| `changes` | [Attribute](#lbm.collection.v1.Attribute) | repeated | changes to apply. possible attribute keys on modifying collection: name, base_img_uri, meta. possible attribute keys on modifying token type and token: name, meta. |

Expand Down
2 changes: 1 addition & 1 deletion proto/cosmos/tx/v1beta1/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ message GetBlockWithTxsRequest {
message GetBlockWithTxsResponse {
// txs are the transactions in the block.
repeated cosmos.tx.v1beta1.Tx txs = 1;
.tendermint.types.BlockID block_id = 2;
.tendermint.types.BlockID block_id = 2;
.ostracon.types.Block block = 3;
// pagination defines a pagination for the response.
cosmos.base.query.v1beta1.PageResponse pagination = 4;
Expand Down
10 changes: 5 additions & 5 deletions proto/lbm/base/ostracon/v1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ message GetBlockByHeightRequest {
// GetBlockByHeightResponse is the response type for the Query/GetBlockByHeight RPC method.
message GetBlockByHeightResponse {
.tendermint.types.BlockID block_id = 1;
.ostracon.types.Block block = 2;
.ostracon.types.Block block = 2;
}

// GetBlockByHashRequest is the request type for the Query/GetBlockByHash RPC method.
Expand All @@ -106,7 +106,7 @@ message GetBlockByHashRequest {
// GetBlockByHashResponse is the response type for the Query/GetBlockByHash RPC method.
message GetBlockByHashResponse {
.tendermint.types.BlockID block_id = 1;
.ostracon.types.Block block = 2;
.ostracon.types.Block block = 2;
}

// GetBlockResultsByHeightRequest is the request type for the Query/GetBlockResultsByHeight RPC method.
Expand All @@ -116,7 +116,7 @@ message GetBlockResultsByHeightRequest {

// GetBlockResultsByHeightResponse is the response type for the Query/GetBlockResultsByHeight RPC method.
message GetBlockResultsByHeightResponse {
int64 height = 1;
int64 height = 1;
repeated .tendermint.abci.ResponseDeliverTx txs_results = 2;
.tendermint.abci.ResponseBeginBlock res_begin_block = 3;
.tendermint.abci.ResponseEndBlock res_end_block = 4;
Expand All @@ -128,7 +128,7 @@ message GetLatestBlockRequest {}
// GetLatestBlockResponse is the response type for the Query/GetLatestBlock RPC method.
message GetLatestBlockResponse {
.tendermint.types.BlockID block_id = 1;
.ostracon.types.Block block = 2;
.ostracon.types.Block block = 2;
}

// GetSyncingRequest is the request type for the Query/GetSyncing RPC method.
Expand All @@ -145,7 +145,7 @@ message GetNodeInfoRequest {}
// GetNodeInfoResponse is the request type for the Query/GetNodeInfo RPC method.
message GetNodeInfoResponse {
.tendermint.p2p.DefaultNodeInfo default_node_info = 1;
VersionInfo application_version = 2;
VersionInfo application_version = 2;
}

// VersionInfo is the type for the GetNodeInfoResponse message.
Expand Down
4 changes: 4 additions & 0 deletions x/collection/collection.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions x/collection/event.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions x/collection/query.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions x/collection/tx.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8e66f25

Please sign in to comment.