From 2cfaa2d2d1783da9c402338d263f7c001fda8020 Mon Sep 17 00:00:00 2001 From: XB Date: Thu, 28 Sep 2023 09:39:59 +0800 Subject: [PATCH] update docs to append mandatory cmd options (#2862) * Update nft.md * Update distribution.md * Update mt.md * Update service.md --- docs/features/distribution.md | 2 +- docs/features/mt.md | 14 +++++++------- docs/features/nft.md | 6 +++--- docs/features/service.md | 32 ++++++++++++++++---------------- 4 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/features/distribution.md b/docs/features/distribution.md index 5943f50cc1..db23ca7dc5 100644 --- a/docs/features/distribution.md +++ b/docs/features/distribution.md @@ -31,7 +31,7 @@ By default, the reward will be paid to the wallet address which send the delegat The delegator could set a new wallet as reward paid address. To set another wallet(marked as `B`) as the paid address, delegator need to send another transaction from wallet `A`. ```bash -iris tx distribution set-withdraw-addr [withdraw-addr] [flags] +iris tx distribution set-withdraw-addr [withdraw-addr] [flags] --from= --chain-id= --fees= ``` ### Withdraw rewards diff --git a/docs/features/mt.md b/docs/features/mt.md index 0addaaf73c..48bfbf82b4 100644 --- a/docs/features/mt.md +++ b/docs/features/mt.md @@ -26,7 +26,7 @@ An asset class can be created by specifying the DenomName and the creator. `CLI` ```plain -iris tx mt issue --name= --from= +iris tx mt issue --name= --from= --chain-id= --fees= ``` ### Production @@ -36,7 +36,7 @@ After issuing an asset class, a specific asset of that class can be created, dur `CLI` ```plain -iris tx mt mint --amount= --data= --from= --recipient= +iris tx mt mint --amount= --data= --from= --recipient= --chain-id= --fees= ``` ### Increase of Issuance @@ -46,7 +46,7 @@ After issuing a specific asset, the owner of the asset class can also choose to `CLI` ```plain -iris tx mt mint --mt-id= --amount= --from= --recipient= +iris tx mt mint --mt-id= --amount= --from= --recipient= --chain-id= --fees= ``` ### Editing @@ -56,7 +56,7 @@ Updates can be made to the metadata of a specified asset. `CLI` ```plain -iris tx mt edit --data= --from= +iris tx mt edit --data= --from= --chain-id= --fees= ``` ### Transfer @@ -67,7 +67,7 @@ Assets can be transferred. The amount of assets to be transferred can be specifi `CLI` ```plain -iris tx mt transfer +iris tx mt transfer --chain-id= --fees= ``` ### Burn @@ -77,7 +77,7 @@ Assets can be burned. The amount of assets to be burned can be specified. `CLI` ```plain -iris tx mt burn --from= +iris tx mt burn --from= --chain-id= --fees= ``` ### Query a specified asset class @@ -138,4 +138,4 @@ Query all assets in a specified asset class through the DenomID. ```plain iris query mt tokens -``` \ No newline at end of file +``` diff --git a/docs/features/nft.md b/docs/features/nft.md index 64d829da41..2d9b0f71a8 100644 --- a/docs/features/nft.md +++ b/docs/features/nft.md @@ -41,7 +41,7 @@ Specify the nft Denom (nft classification) and metadata JSON Schema to issue nft `CLI` ```bash -iris tx nft issue --from= --name= --schema= --symbol= --mint-restricted= --update-restricted= --chain-id= --fees= +iris tx nft issue --name= --schema= --symbol= --mint-restricted= --update-restricted= --from= --chain-id= --fees= ``` ### transfer denom @@ -51,7 +51,7 @@ The owner of the NFT classification can transfer the ownership of the NFT classi `CLI` ```bash -iris tx nft transfer-denom +iris tx nft transfer-denom --from= --chain-id= --fees= ``` ### Additional issuance @@ -81,7 +81,7 @@ Transfer designated nft. `CLI` ```bash -iris tx nft transfer +iris tx nft transfer --from= --chain-id= --fees= ``` ### Destroy diff --git a/docs/features/service.md b/docs/features/service.md index 8fa5ffe326..04dbfa31c2 100644 --- a/docs/features/service.md +++ b/docs/features/service.md @@ -56,7 +56,7 @@ Any user can define services on the blockchain. The interface of a service must ```bash # create a new service definition -iris tx service define --name= --description= --author-description= --tags= +iris tx service define --name= --description= --author-description= --tags= --from= --chain-id= # query service definition iris q service definition @@ -112,22 +112,22 @@ Service bindings can be updated at any time by their owners to adjust pricing, i ```bash # create a new service binding -iris tx service bind --deposit= --qos= --pricing= +iris tx service bind --deposit= --qos= --pricing= --from= --chain-id= # update a service binding -iris tx service update-binding --deposit= --qos= --pricing= +iris tx service update-binding --deposit= --qos= --pricing= --from= --chain-id= # enable an inactive service binding -iris tx service enable --deposit= +iris tx service enable --deposit= --from= --chain-id= # disable an active service binding -iris tx service disable +iris tx service disable --from= --chain-id= # request refund of service binding deposit -iris tx service refund-deposit +iris tx service refund-deposit --from= --chain-id= # list all the bindings of a service -iris tx service bindings +iris tx service bindings --from= --chain-id= # list all the bindings of a service, owned by a given account iris q service bindings service bindings --owner
@@ -181,19 +181,19 @@ When a request context is successfully created, a `context id` is returned to th ```bash # create a repeated request context, with no callback -iris tx service call --service-name= --data= --providers= --service-fee-cap=1iris --timeout 50 --repeated --frequency=50 --total=100 +iris tx service call --service-name= --data= --providers= --service-fee-cap=1iris --timeout 50 --repeated --frequency=50 --total=100 --from= --chain-id= # update an existing request context -iris tx service update --frequency=20 --total=200 +iris tx service update --frequency=20 --total=200 --from= --chain-id= # pause a running request context -iris tx service pause +iris tx service pause --from= --chain-id= # start a paused request context -iris tx service start +iris tx service start --from= --chain-id= # permanently kill a request context -iris tx service kill +iris tx service kill --from= --chain-id= # query a previously created request context by its id iris q service request-context @@ -237,7 +237,7 @@ iris q service requests iris q service request # send a response back, matching a specific request -iris tx service respond --request-id= --result='{"code":200,"message":"success"}' --data= +iris tx service respond --request-id= --result='{"code":200,"message":"success"}' --data= --from= --chain-id= # query the result schema iris q service schema result @@ -261,7 +261,7 @@ Right before a service fee is paid to a provider, a _tax_, in the amount of `Ser ```bash # set withdrawal address -iris tx service set-withdraw-addr +iris tx service set-withdraw-addr --from= --chain-id= # query withdrawal address of a given account iris q service withdraw-addr
@@ -270,10 +270,10 @@ iris q service withdraw-addr
iris q service fees # withdraw earned fees from all providers -iris tx service withdraw-fees +iris tx service withdraw-fees --from= --chain-id= # withdraw earned fees from a given provider -iris tx service withdraw-fees +iris tx service withdraw-fees --from= --chain-id= ``` ## Service Governance (TODO)