Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update onft doc #164

Merged
merged 1 commit into from
Mar 9, 2024
Merged

doc: update onft doc #164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 43 additions & 12 deletions x/onft/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,22 @@ A denom is a collection of NFTs. It is a unique identifier for a collection of N
message Denom {
option (gogoproto.equal) = true;

string id = 1;
string symbol = 2;
string name = 3;
string schema = 4;
string creator = 5;
string description = 6;
string preview_uri = 7 [
string id = 1;
string symbol = 2;
string name = 3;
string schema = 4;
string creator = 5;
string description = 6;
string preview_uri = 7 [
(gogoproto.moretags) = "yaml:\"preview_uri\"",
(gogoproto.customname) = "PreviewURI"
];
string uri = 8;
string uri_hash = 9;
string data = 10;
repeated WeightedAddress royalty_receivers = 11 [
(gogoproto.moretags) = "yaml:\"royalty_receivers\""
];
}
```
## oNFT
Expand Down Expand Up @@ -64,6 +70,7 @@ message Metadata {
(gogoproto.moretags) = "yaml:\"preview_uri\"",
(gogoproto.customname) = "PreviewURI"
];
string uri_hash = 5;
}
```
### State
Expand Down Expand Up @@ -117,17 +124,23 @@ symbol: denom symbol
flags:
name : name of denom/collection
description: description for the denom
uri: class uri (ipfs hash of a json file which contains full collections information)
uri-hash: sha256 hash of the above file
preview-uri: display picture url for denom
schema: json schema for additional properties
royalty-receivers: list of weighted addresses that will receive royalty fees when an NFT is sold
creation-fee: denom creation-fee to create denom

Example:
```
onftd tx onft create <symbol> \
--name=<name> \
--description=<description> \
--uri=<class-uri> \
--uri-hash<class-uri-hash> \
--preview-uri=<preview-uri> \
--schema=<schema> \
--royalty-receivers=<address1,weight>,<address2,wight> \
--creation-fee=<creation-fee> \
--chain-id=<chain-id> \
--fees=<fee> \
Expand All @@ -139,11 +152,11 @@ Example:
To create an oNFT, you will need to use the "onftd tx onft mint" command with the following flags:

denom-id: the ID of the collection in which you want to mint the NFT
name: the name of the NFT
description: a description of the NFT
media-uri: the IPFS URI of the NFT
preview-uri: the preview URI of the NFT
data: any additional properties for the NFT (optional)
name: name of the NFT
description: description of the NFT
media-uri: the IPFS URI of the NFT (can be a image ipfs url or json file ipfs url that contains all the info of the nft)
preview-uri: the preview URI of the NFT (preview image of the NFT)
data: any additional properties for the NFT in json string format (optional)
recipient: the recipient of the NFT (optional, default is the minter of the NFT)
non-transferable: flag to mint a non-transferable NFT (optional, default is false)
inextensible: flag to mint an inextensible NFT (optional, default is false)
Expand All @@ -157,6 +170,7 @@ onftd tx onft mint <denom-id> \
--name="NFT name" \
--description="NFT description" \
--media-uri="https://ipfs.io/ipfs/...." \
--uri-hash="uri-hash" \
--preview-uri="https://ipfs.io/ipfs/...." \
--data="{}" \
--recipient="" \
Expand Down Expand Up @@ -226,22 +240,39 @@ service Query {
option (google.api.http).get = "/omniflix/onft/v1beta1/collections/{denom_id}";
}

rpc IBCCollection(QueryIBCCollectionRequest) returns (QueryCollectionResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/collections/ibc/{hash}";
}

rpc Denom(QueryDenomRequest) returns (QueryDenomResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/{denom_id}";
}

rpc IBCDenom(QueryIBCDenomRequest) returns (QueryDenomResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/ibc/{hash}";
}

rpc Denoms(QueryDenomsRequest) returns (QueryDenomsResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms";
}
rpc ONFT(QueryONFTRequest) returns (QueryONFTResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/{denom_id}/onfts/{id}";
}
rpc IBCDenomONFT(QueryIBCDenomONFTRequest) returns (QueryONFTResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/ibc/{hash}/onfts/{id}";
}
rpc OwnerONFTs(QueryOwnerONFTsRequest) returns (QueryOwnerONFTsResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/onfts/{denom_id}/{owner}";
}
rpc OwnerIBCDenomONFTs(QueryOwnerIBCDenomONFTsRequest) returns (QueryOwnerONFTsResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/onfts/ibc/{hash}/{owner}";
}
rpc Supply(QuerySupplyRequest) returns (QuerySupplyResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/{denom_id}/supply";
}
rpc IBCDenomSupply(QueryIBCDenomSupplyRequest) returns (QuerySupplyResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/denoms/ibc/{hash}/supply";
}
rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
option (google.api.http).get = "/omniflix/onft/v1beta1/params";
}
Expand Down
Loading