Skip to content

Commit

Permalink
Update wallet.md (MystenLabs#2313)
Browse files Browse the repository at this point in the history 
* 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
  • Loading branch information
@Romainua
Romainua authored May 30, 2022
1 parent 150b9e2 commit 907bda7
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions doc/src/build/wallet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -457,15 +457,15 @@ You can use the `objects` command to view the objects owned by the address.
```shell
USAGE:
objects [FLAGS] --address <address>
objects [FLAGS] --address <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> Address owning the objects
--address <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):
Expand All @@ -492,15 +492,15 @@ Usage of `object` command :
```shell
USAGE:
object [FLAGS] --id <id>
object [FLAGS] --id <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 <id> Object ID of the object to fetch
--id <ID> Object ID of the object to fetch
```
To view the object, use the following command:
Expand Down Expand Up @@ -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 <gas-budget> --coin-object-id <coin-object-id> --to <to>
transfer-coin [FLAGS] [OPTIONS] --to <TO> --coin-object-id <COIN_OBJECT_ID> --gas-budget <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 <gas> ID of the coin object for gas payment, in 20 bytes Hex string If not provided, a coin
--coin-object-id <COIN_OBJECT_ID> Coin to transfer, in 20 bytes Hex string
--gas <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> Gas budget for this transfer
--coin-object-id <coin-object-id> Coin to transfer, in 20 bytes Hex string
--to <to> Recipient address
--gas-budget <GAS_BUDGET> Gas budget for this transfer
--to <TO> Recipient address
```
To transfer a coin object to a recipient, you will need the recipient's address,
Expand Down Expand Up @@ -695,19 +695,19 @@ Usage of `merge-coin`:
```shell
USAGE:
merge-coin [FLAGS] [OPTIONS] --coin-to-merge <coin-to-merge> --gas-budget <gas-budget> --primary-coin <primary-coin>
merge-coin [FLAGS] [OPTIONS] --primary-coin <PRIMARY_COIN> --coin-to-merge <COIN_TO_MERGE> --gas-budget <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-merge> Coin to be merged, in 20 bytes Hex string
--gas <gas> ID of the gas object for gas payment, in 20 bytes Hex string If not provided,
--coin-to-merge <COIN_TO_MERGE> Coin to be merged, in 20 bytes Hex string
--gas <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> Gas budget for this call
--primary-coin <primary-coin> Coin to merge into, in 20 bytes Hex string
--gas-budget <GAS_BUDGET> Gas budget for this call
--primary-coin <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 -
Expand Down Expand Up @@ -762,19 +762,19 @@ Usage of `split-coin`:
```shell
USAGE:
split-coin [FLAGS] [OPTIONS] --coin-id <coin-id> --gas-budget <gas-budget>
split-coin [FLAGS] [OPTIONS] --coin-id <COIN_ID> --gas-budget <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 <amounts>... Amount to split out from the coin
--coin-id <coin-id> Coin to Split, in 20 bytes Hex string
--gas <gas> ID of the gas object for gas payment, in 20 bytes Hex string If not provided, a gas
--amounts <AMOUNTS>... Amount to split out from the coin
--coin-id <COIN_ID> Coin to Split, in 20 bytes Hex string
--gas <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> Gas budget for this call
--gas-budget <GAS_BUDGET> Gas budget for this call
```
For splitting coins, you will need at lease two coins to execute the `split-coin` command,
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 907bda7

Please sign in to comment.