From 503b8e7319af3fb3bb4e4a6b1deee361c584c5ed Mon Sep 17 00:00:00 2001 From: Marri Harish Date: Tue, 11 Apr 2023 02:14:17 +0530 Subject: [PATCH] doc(readme): update onft transactions documentation (#23) --- readme.md | 136 ++++++++++++------------------------------------------ 1 file changed, 29 insertions(+), 107 deletions(-) diff --git a/readme.md b/readme.md index 6e17a81..62c302b 100644 --- a/readme.md +++ b/readme.md @@ -16,7 +16,33 @@ Various queries are available to get details about denoms/collections, NFTs, and The module utilizes the [irismod/nft](https://github.com/irismod/nft) repository and has been modified to meet the requirements of the OmniFlix Network. It can be used through the CLI with various commands and flags to perform the desired actions. -## 1) Mint an oNFT +## 1) Create Denom (Collection) +To create an oNFT denom, you will need to use the "onftd tx onft create" command with the following args and flags: + +args: +symbol: denom symbol + +flags: +name : name of denom/collection +description: description for the denom +preview-uri: display picture url for denom +schema: json schema for additional properties +creation-fee: denom creation-fee to create denom + +Example: +``` + onftd tx onft create \ + --name= \ + --description= \ + --preview-uri= \ + --schema= \ + --creation-fee= \ + --chain-id= \ + --fees= \ + --from= +``` + +## 2) Mint an oNFT To create an oNFT, you will need to use the "onftd tx onft mint" command with the following flags: @@ -56,7 +82,7 @@ For a royalty share of 5%: --royalty-share="0.05" # 5% ``` -## 2) Transfer an oNFT +## 3) Transfer an oNFT To transfer an oNFT, you will need to use the "onftd tx onft transfer" command with the following flags: @@ -76,7 +102,7 @@ onftd tx onft transfer --from= ``` -## 3) Burn an oNFT +## 4) Burn an oNFT To burn an oNFT, you will need to use the "onftd tx onft burn" command with the following flags: @@ -122,107 +148,3 @@ onftd tx onft burn ```bash onftd query onft owner ``` - -### Transactions - - #### Create Denom / Collection - Usage - ```bash - onftd tx onft create [symbol] [flags] - ``` - - Flags: - - **name** : name of denom/collection - - **description**: description for the denom - - **preview-uri**: display picture url for denom - - **schema**: json schema for additional properties - - **creation-fee**: denom creation-fee to create denom - - Example: - ```bash - onftd tx onft create - --name= - --description= - --preview-uri= - --schema= - --creation-fee= - --chain-id= - --fees= - --from= - ``` - - #### Mint NFT - Usage - ```bash - onftd tx onft mint [denom-id] [flags] - ``` - - Flags: - - **name** : name of denom/collection (string) - - **description**: description of the denom (string) - - **media-uri**: ipfs uri of the nft (url) - - **preview-uri**: preview uri of the nft (url) - - **data**: additional nft properties (json string) - - **recipient**: recipient of the nft (optional, default: minter of the nft) - - **non-transferable**: to mint non-transferable nft (optional, default: false) - - **inextensible** : to mint inextensible nft (optional, default false) - - **nsfw**: not safe for work flag for the nft (optional, default: false) - - **royalty-share**: royalty share for nft (optional, default: 0.00) - - Example: - ```bash - onftd tx onft mint - --name= - --description= - --media-uri= - --preview-uri= - --data= - --recipient= - --chain-id= - --fees= - --from= - ``` - ```bash - onftd tx onft mint - --name="NFT name" - --description="NFT description" - --media-uri="https://ipfs.io/ipfs/...." - --preview-uri="https://ipfs.io/ipfs/...." - --data="" - --recipient="" - --non-transferable - --inextensible - --nsfw - --chain-id= - --fees= - --from= - ``` - For Royalty share - ```bash - --royalty-share="0.05" # 5% - ``` - - #### Transfer NFT - Usage - ```bash - onftd tx onft transfer [recipient] [denom-id] [onft-id] [flags] - ``` - - Example: - ```bash - onftd tx onft transfer - --chain-id= - --fees= - --from= - ``` - - - #### Burn NFT - Usage - ```bash - onftd tx onft burn [denom-id] [onft-id] [flags] - ``` - - Example: - ```bash - onftd tx onft burn - --chain-id= - --fees= - --from= - ```