From 907bda7c0716543e73eda5ad3f6949b657d30747 Mon Sep 17 00:00:00 2001 From: Roman <44613085+Romainua@users.noreply.github.com> Date: Mon, 30 May 2022 23:46:31 +0200 Subject: [PATCH] Update wallet.md (#2313) * Update wallet.md Updated command format for `wallet merge-coin` and `wallet transfer-coin` and some minor changed to current comand version * Update wallet.md --- doc/src/build/wallet.md | 52 ++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/src/build/wallet.md b/doc/src/build/wallet.md index 5908f5f9b282f..2c3b06339dae6 100644 --- a/doc/src/build/wallet.md +++ b/doc/src/build/wallet.md @@ -240,7 +240,7 @@ The following commands are supported by the wallet: objects Obtain all objects owned by the address publish Publish Move modules split-coin Split a coin object into multiple coins - switch Switch active address + switch Switch active address and network(e.g., devnet, local rpc server) sync Synchronize client state with authorities transfer-coin Transfer coin object @@ -457,15 +457,15 @@ You can use the `objects` command to view the objects owned by the address. ```shell USAGE: - objects [FLAGS] --address
+ objects [FLAGS] --address
FLAGS: -h, --help Prints help information + -i Start interactive wallet --json Returns command outputs in JSON format - -V, --version Prints version information OPTIONS: - --address
Address owning the objects + --address
Address owning the objects ``` To view the objects owned by the accounts created in genesis, run the following command (substitute the address with one of the genesis addresses in your wallet): @@ -492,15 +492,15 @@ Usage of `object` command : ```shell USAGE: - object [FLAGS] --id + object [FLAGS] --id FLAGS: -h, --help Prints help information + -i Start interactive wallet --json Returns command outputs in JSON format - -V, --version Prints version information OPTIONS: - --id Object ID of the object to fetch + --id Object ID of the object to fetch ``` To view the object, use the following command: @@ -585,19 +585,19 @@ We will explore how to transfer coins using the wallet in this section. ```shell USAGE: - transfer-coin [FLAGS] [OPTIONS] --gas-budget --coin-object-id --to + transfer-coin [FLAGS] [OPTIONS] --to --coin-object-id --gas-budget FLAGS: -h, --help Prints help information + -i Start interactive wallet --json Returns command outputs in JSON format - -V, --version Prints version information OPTIONS: - --gas ID of the coin object for gas payment, in 20 bytes Hex string If not provided, a coin + --coin-object-id Coin to transfer, in 20 bytes Hex string + --gas ID of the coin object for gas payment, in 20 bytes Hex string If not provided, a coin object with at least gas_budget value will be selected - --gas-budget Gas budget for this transfer - --coin-object-id Coin to transfer, in 20 bytes Hex string - --to Recipient address + --gas-budget Gas budget for this transfer + --to Recipient address ``` To transfer a coin object to a recipient, you will need the recipient's address, @@ -695,19 +695,19 @@ Usage of `merge-coin`: ```shell USAGE: - merge-coin [FLAGS] [OPTIONS] --coin-to-merge --gas-budget --primary-coin + merge-coin [FLAGS] [OPTIONS] --primary-coin --coin-to-merge --gas-budget FLAGS: -h, --help Prints help information + -i Start interactive wallet --json Returns command outputs in JSON format - -V, --version Prints version information OPTIONS: - --coin-to-merge Coin to be merged, in 20 bytes Hex string - --gas ID of the gas object for gas payment, in 20 bytes Hex string If not provided, + --coin-to-merge Coin to be merged, in 20 bytes Hex string + --gas ID of the gas object for gas payment, in 20 bytes Hex string If not provided, a gas object with at least gas_budget value will be selected - --gas-budget Gas budget for this call - --primary-coin Coin to merge into, in 20 bytes Hex string + --gas-budget Gas budget for this call + --primary-coin Coin to merge into, in 20 bytes Hex string ``` Here is an example of how to merge coins. To merge coins, you will need at lease three coin objects - @@ -762,19 +762,19 @@ Usage of `split-coin`: ```shell USAGE: - split-coin [FLAGS] [OPTIONS] --coin-id --gas-budget + split-coin [FLAGS] [OPTIONS] --coin-id --gas-budget FLAGS: -h, --help Prints help information + -i Start interactive wallet --json Returns command outputs in JSON format - -V, --version Prints version information OPTIONS: - --amounts ... Amount to split out from the coin - --coin-id Coin to Split, in 20 bytes Hex string - --gas ID of the gas object for gas payment, in 20 bytes Hex string If not provided, a gas + --amounts ... Amount to split out from the coin + --coin-id Coin to Split, in 20 bytes Hex string + --gas ID of the gas object for gas payment, in 20 bytes Hex string If not provided, a gas object with at least gas_budget value will be selected - --gas-budget Gas budget for this call + --gas-budget Gas budget for this call ``` For splitting coins, you will need at lease two coins to execute the `split-coin` command, @@ -899,7 +899,7 @@ parameters one-by-one: the function is located. (Remember that the ID of the genesis Sui package containing the GAS module is defined in its manifest file, and is equal to `0x2`.) -* `args` - a list of function arguments formatted as +* `--args` - a list of function arguments formatted as [SuiJSON](sui-json.md) values (hence the preceding `0x` in address and object ID): * ID of the gas object representing the `c` parameter of the `transfer`