Cli_wallet Introduce

cli_wallet is a command-line tool provided by GXChain that provides functions such as transferring funds, calling contracts, and querying objects. After starting the command line tool, executing the help command will output all the commands supported by the tool. This tutorial demonstrates how to use the cli_wallet tool.

1. Start cli_wallet

Before starting the cli_wallet tool, you first need to start a node program witness_node with the API service enabled, and you need to know the Chain id of the blockchain where the node program is located. Once you have the above information, you can interact with GXChain via the cli_wallet tool.

cli_wallet can be started as follows:

#Note: The chain-id is changed to the chain id of your connection. The ip and port are specified according to the node startup configuration information
./cli_wallet --chain-id c2af30ef9340ff81fd61654295e98a1ff04b23189748f86727d0b26b40bb0ff4 -sws://127.0.0.1:28090

1.1 cli_wallet start command

Use the --help parameter to start the cli_wallet tool, you can get the startup parameters of the cli_wallet tool.

./programs/cli_wallet/cli_wallet --help
  -h [ --help ]                         Print this help message and exit.
  -D [ --data-dir ] arg (="witness_node_data_dir")
                                        Directory containing databases, for
                                        cli_wallet write logs
  -s [ --server-rpc-endpoint ] [=arg(=ws://127.0.0.1:8090)]
                                        Server websocket RPC endpoint
  -u [ --server-rpc-user ] arg          Server Username
  -p [ --server-rpc-password ] arg      Server Password
  -r [ --rpc-endpoint ] [=arg(=127.0.0.1:8091)]
                                        Endpoint for wallet websocket RPC to
                                        listen on
  -t [ --rpc-tls-endpoint ] [=arg(=127.0.0.1:8092)]
                                        Endpoint for wallet websocket TLS RPC
                                        to listen on
  -c [ --rpc-tls-certificate ] [=arg(=server.pem)]
                                        PEM certificate for wallet websocket
                                        TLS RPC
  -H [ --rpc-http-endpoint ] [=arg(=127.0.0.1:8093)]
                                        Endpoint for wallet HTTP RPC to listen
                                        on
  -d [ --daemon ]                       Run the wallet in daemon mode
  --enable-rpc-log                      enable rpc log production, in
                                        data-dir/logs/rpc/rpc.log
  -w [ --wallet-file ] [=arg(=wallet.json)]
                                        wallet to load
  --chain-id arg                        chain ID to connect to
  --suggest-brain-key                   Suggest a safe brain key to use for
                                        creating your account
  -v [ --version ]                      Display version information

-s: Connect to the specified witness_node node via websocket -r: Cli_wallet turns on the ip and port of the websocket rpc service -H: Cli_wallet turns on the ip and port of the http rpc service -d: Cli_wallet starts in daemon mode
-w: Specify wallet file path
--chain-id: The chain id of the blockchain to which it is connected

1.2 Open the RPC service example

#Start cli_wallet in daemon mode and enable http rpc service. The port is 28091.
./programs/cli_wallet/cli_wallet --chain-id c2af30ef9340ff81fd61654295e98a1ff04b23189748f86727d0b26b40bb0ff4 -s ws://127.0.0.1:28090 --daemon -H 127.0.0.1:28091
Logging RPC to file: /Users/zhaoxiangfei/code/testnet/witness_node_data_dir/logs/rpc/rpc.log
619924ms th_a       main.cpp:155                  main                 ] key_to_wif( committee_private_key ): 5KCBDTcyDqzsqehcb52tW5nU6pXife6V2rX9Yf7c3saYSzbDZ5W
619924ms th_a       main.cpp:159                  main                 ] nathan_pub_key: GXC6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV
619924ms th_a       main.cpp:160                  main                 ] key_to_wif( nathan_private_key ): 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3
619929ms th_a       main.cpp:207                  main                 ] wdata.ws_server: ws://127.0.0.1:28090
619931ms th_a       main.cpp:212                  main                 ] wdata.ws_user:  wdata.ws_password:
619949ms th_a       main.cpp:275                  main                 ] Listening for incoming HTTP RPC requests on 127.0.0.1:28091
619952ms th_a       main.cpp:303                  main                 ] Entering Daemon Mode, ^C to exit

#Call the cli_wallet command example through the curl tool. For details, see the cli_wallet common functions
curl --data '{"jsonrpc": "2.0", "method": "get_account", "params": ["1.2.426"], "id": 1}' http://127.0.0.1:28091/rpc | json_pp

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  1473  100  1398  100    75   132k   7306 --:--:-- --:--:-- --:--:--  136k
{
   "id" : 1,
   "result" : {
      "name" : "zhao-123",
      "top_n_control_flags" : 0,
      "active" : {
         "address_auths" : [],
         "weight_threshold" : 1,
         "key_auths" : [
            [
               "GXC8cQnHYf2RGgeAEAQKAT3i9Hz9rxJagcXcXD8Znvtj16vYybwxE",
               1
            ]
         ],
         "account_auths" : []
      },
      "statistics" : "2.6.354",
      "lifetime_referrer_fee_percentage" : 8000,
      "blacklisted_accounts" : [],
      "id" : "1.2.426",
      "owner" : {
         "account_auths" : [],
         "key_auths" : [
            [
               "GXC5Jp6ec2uDWuLvq2S5pP1RxM5WQ17yru7Ak3TGrni7SbFQBM1pU",
               1
            ]
         ],
         "weight_threshold" : 1,
         "address_auths" : []
      },
      "whitelisted_accounts" : [],
      "whitelisting_accounts" : [],
      "registrar" : "1.2.426",
      "options" : {
         "num_committee" : 1,
         "votes" : [
            "1:7",
            "0:18"
         ],
         "voting_account" : "1.2.5",
         "extensions" : [],
         "memo_key" : "GXC8cQnHYf2RGgeAEAQKAT3i9Hz9rxJagcXcXD8Znvtj16vYybwxE",
         "num_witness" : 1
      },
      "membership_expiration_date" : "2106-02-07T06:28:15",
      "vm_version" : "",
      "cashback_vb" : "1.13.644",
      "datasource_auth_referrer" : "1.2.0",
      "datasource_expiration_date" : "1970-01-01T00:00:00",
      "merchant_expiration_date" : "1970-01-01T00:00:00",
      "blacklisting_accounts" : [],
      "active_special_authority" : [
         0,
         {}
      ],
      "owner_special_authority" : [
         0,
         {}
      ],
      "code_version" : "",
      "vm_type" : "",
      "data_transaction_member_expiration_date" : "1970-01-01T00:00:00",
      "abi" : {
         "actions" : [],
         "structs" : [],
         "error_messages" : [],
         "types" : [],
         "tables" : [],
         "abi_extensions" : [],
         "version" : "gxc::abi/1.0"
      },
      "referrer_rewards_percentage" : 0,
      "referrer" : "1.2.426",
      "code" : "",
      "network_fee_percentage" : 2000,
      "lifetime_referrer" : "1.2.426",
      "merchant_auth_referrer" : "1.2.0"
   }
}

2. Cli_wallet Common Functions

In the cli_wallet process, the help and get_help commands can help you quickly learn the command line wallet API.

2.1 New wallet settings, private key import

2.2 Account

2.3 Get information on the chain

2.4 Transfer to other accounts

2.5 Interact with smart contracts

2.6 Manually constructing a transaction

2.7 Create brain_key

2.8 Redemption of the trust node margin

2.9 Vote for trust nodes

2.1 New wallet settings, private key import

After launching the cli_wallet tool correctly, it will enter an interactive window. If it is launched for the first time, you will be prompted to create a new wallet, the window prompts as follows:

Please use the set_password method to initialize a new wallet before continuing
new >>>

When prompted, enter the set_password command, specify the wallet password, and create a wallet.

# Replace 123456 with your own custom password
new >>> set_password 123456
set_password 123456
null

After entering the password, the wallet is created. You can see that the wallet is locked in the interface. Enter the unlock command to unlock the wallet:

# 123456 replaced with your own password
locked >>> unlock 123456
unlock 123456
null

After unlocking the wallet, if you want to use the cli_wallet tool to initiate a transaction, you need to import your own account private key. The command is as follows:

unlocked >>> import_key zhao-123 5JVtwDKFQCx9EqANKL4Qb3N6HbPiBnVXz6STz6gwzpJJusH7SqJ
import_key zhao-123 5JVtwDKFQCx9EqANKL4Qb3N6HbPiBnVXz6STz6gwzpJJusH7SqJ
2548361ms th_a       wallet.cpp:798                save_wallet_file     ] saving wallet to file wallet.json
2548365ms th_a       wallet.cpp:473                copy_wallet_file     ] backing up wallet wallet.json to after-import-key-7c829d0b.wallet
true

The interface is displayed in the unlocked state, and you can perform complex functions through the wallet.

2.2 Account

You can use the cli_wallet tool to register your account and upgrade your account to a lifetime membership. The specific commands are as follows:

upgrade_account

Interface: signed_transaction upgrade_account(string name, string asset_symbol, bool broadcast)

Description: To upgrade your account to a lifetime membership, you need to ensure that your account has at least 50GXC assets.

Parameter:

Param Type Description
name string account name
asset_symbol string asset name
broadcast bool Whether to broadcast

Example:

unlocked >>> upgrade_account test-upgrade GXC true
upgrade_account test-upgrade GXC true
{
  "ref_block_num": 13251,
  "ref_block_prefix": 906310083,
  "expiration": "2019-04-11T06:56:36",
  "operations": [[
      8,{
        "fee": {
          "amount": 5000000,
          "asset_id": "1.3.1"
        },
        "account_to_upgrade": "1.2.2575",
        "upgrade_to_lifetime_member": true,
        "extensions": []
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "202abed5a02c1b75fa804f3550416546bf389673f77d0c9b76d8a8b0b8797a6c315be31a039ff7677ee0264b0a1d2c96a236b1181bc0964b9776ba16cbaf3e56ac"
  ]
}

register_account

Interface: signed_transaction register_account(string name, public_key_type owner, public_key_type active, string registrar_account, string referrer_account, uint32_t referrer_percent, bool broadcast)

Description: Register account

Parameter:

Param Type Description
name string Account name to be registered
owner public_key_type ower public key
active public_key_type active public key
registrar_account string Referrer account
referrer_account string Referral percentage
broadcast bool Whether to broadcast

Example:

unlocked >>> register_account a111 GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ zhao-123 zhao-123 10 true
register_account a111 GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ zhao-123 zhao-123 10 true
{
  "ref_block_num": 10747,
  "ref_block_prefix": 3037397366,
  "expiration": "2019-04-11T03:47:24",
  "operations": [[
      5,{
        "fee": {
          "amount": 102,
          "asset_id": "1.3.1"
        },
        "registrar": "1.2.426",
        "referrer": "1.2.426",
        "referrer_percent": 1000,
        "name": "a111",
        "owner": {
          "weight_threshold": 1,
          "account_auths": [],
          "key_auths": [[
              "GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ",
              1
            ]
          ],
          "address_auths": []
        },
        "active": {
          "weight_threshold": 1,
          "account_auths": [],
          "key_auths": [[
              "GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ",
              1
            ]
          ],
          "address_auths": []
        },
        "options": {
          "memo_key": "GXC6vQtDEgHSickqe9itW8fbFyUrKZK5xsg4FRHzQZ7hStaWqEKhZ",
          "voting_account": "1.2.5",
          "num_witness": 0,
          "num_committee": 0,
          "votes": [],
          "extensions": []
        },
        "extensions": {}
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "1f4510f43daf1f2ecb83dd8b8c4b21b1ce1031ea0a64562ce5f20dbe3b4b8f9d9e2b438a74a0c56cc6c37f6e21e6aeeadd8619de8e916a268e964d68d9e68fc35f"
  ]
}

2.3 Get information on the chain

The cli_wallet tool can obtain the memory object information (account, asset, contract table, etc.) on the chain through related commands, and can also obtain the block information on the chain (block data, irreversible block number, etc.). (Press the Tab key to view the command prompt and complete)

get_account

Interface: account_object get_account(string account_name_or_id)

Description: Get account infor

Parameter:

Param Type Description
account_name_or_id string account name or account id(such as: init4 or 1.2.10)

Example:

unlocked >>> get_account 1.2.10
get_account 1.2.10
{
  "id": "1.2.10",
  "membership_expiration_date": "2106-02-07T06:28:15",
  "merchant_expiration_date": "1970-01-01T00:00:00",
  "datasource_expiration_date": "1970-01-01T00:00:00",
  "data_transaction_member_expiration_date": "1970-01-01T00:00:00",
  "registrar": "1.2.10",
  "referrer": "1.2.10",
  "lifetime_referrer": "1.2.10",
  "merchant_auth_referrer": "1.2.0",
  "datasource_auth_referrer": "1.2.0",
  "network_fee_percentage": 2000,
  "lifetime_referrer_fee_percentage": 8000,
  "referrer_rewards_percentage": 0,
  "name": "init4",
  "vm_type": "",
  "vm_version": "",
  "code": "",
  "code_version": "",
  "abi": {
    "version": "gxc::abi/1.0",
    "types": [],
    "structs": [],
    "actions": [],
    "tables": [],
    "error_messages": [],
    "abi_extensions": []
  },
  "owner": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [[
        "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
        1
      ]
    ],
    "address_auths": []
  },
  "active": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [[
        "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
        1
      ]
    ],
    "address_auths": []
  },
  "options": {
    "memo_key": "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
    "voting_account": "1.2.5",
    "num_witness": 0,
    "num_committee": 3,
    "votes": [
      "0:11",
      "0:16",
      "0:17"
    ],
    "extensions": []
  },
  "statistics": "2.6.10",
  "whitelisting_accounts": [],
  "blacklisting_accounts": [],
  "whitelisted_accounts": [],
  "blacklisted_accounts": [],
  "cashback_vb": "1.13.200",
  "owner_special_authority": [
    0,{}
  ],
  "active_special_authority": [
    0,{}
  ],
  "top_n_control_flags": 0
}

get_asset

Interface: asset_object get_asset(string asset_name_or_id)

Description: Get asset info

Parameter:

Param Type Description
asset_name_or_id string asset name or asset id(such as: GXC or 1.3.1)

Example:

unlocked >>> get_asset GXC
get_asset GXC
{
  "id": "1.3.1",
  "symbol": "GXC",
  "precision": 5,
  "issuer": "1.2.0",
  "options": {
    "max_supply": "10000000000000",
    "market_fee_percent": 0,
    "max_market_fee": 0,
    "issuer_permissions": 79,
    "flags": 0,
    "core_exchange_rate": {
      "base": {
        "amount": 100000,
        "asset_id": "1.3.1"
      },
      "quote": {
        "amount": 100000,
        "asset_id": "1.3.1"
      }
    },
    "whitelist_authorities": [],
    "blacklist_authorities": [],
    "whitelist_markets": [],
    "blacklist_markets": [],
    "description": "{\"main\":\"GXC是公信宝基金会在GXChain(公信链)上发行的Token,不仅具有流通价值,同时在公信链上开发、认证应⽤、使⽤链上服务(例如链上转账的矿⼯费)以及使⽤BaaS服务都需要⽀付或燃烧GXC,GXC是作为链上应⽤运⾏使⽤到的Token。 在布洛克城中也可以很方便地利用GXC进行支付结算,如居民之间互相使用GXC进行结算,使用城市公共服务需要用GXC结算,商家提供的服务也需要用GXC来购买等等。\",\"short_name\":\"\",\"market\":\"\"}",
    "extensions": []
  },
  "dynamic_asset_data_id": "2.3.1"
}

get_block

Interface: optional<signed_block_with_info> get_block(uint32_t num)

Description: Get block info

Parameter:

Param Type Description
num uint32_t block number

Example:

unlocked >>> get_block 1
get_block 1
{
  "previous": "0000000000000000000000000000000000000000",
  "timestamp": "2017-12-14T03:37:36",
  "witness": "1.6.4",
  "transaction_merkle_root": "0000000000000000000000000000000000000000",
  "extensions": [],
  "witness_signature": "207ceb3fe6a81fb77670370762bb7a9be58951534a053ef33b2bf4430d47315fe14ed3ed3b04472072ef28e06cf66715fcdc184b8683b9543f159e9fcf9e67af25",
  "transactions": [],
  "block_id": "000000010d6e163620e7a0c1144ef68e55b29607",
  "signing_key": "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
  "transaction_ids": []
}

get_dynamic_global_properties

Interface: dynamic_global_property_object get_dynamic_global_properties()

Description: Get dynamic global properties

Parameter: null

Example:

unlocked >>> get_dynamic_global_properties
get_dynamic_global_properties
{
  "id": "2.1.0",
  "head_block_number": 12839485,
  "head_block_id": "00c3ea3d8e14e164c443ddf2cb15baf597b97e9c",
  "time": "2019-04-08T06:20:00",
  "current_witness": "1.6.3",
  "next_maintenance_time": "2019-04-08T06:30:00",
  "last_budget_time": "2019-04-08T06:20:00",
  "witness_budget": 953600,
  "accounts_registered_this_interval": 0,
  "recently_missed_count": 0,
  "current_aslot": 13625993,
  "recent_slots_filled": "340282366920938463463374607431768211455",
  "dynamic_flags": 1,
  "last_irreversible_block_num": 12839471
}

get_table_rows_ex

Interface: get_table_rows_result get_table_rows_ex(string contract, string table, const get_table_rows_params & params)

Description: Get contract table

Parameter:

Param Type Description
contract string contract name
table string contract table name
params const get_table_rows_params & Query mode object, configure query mode

get_table_rows_params description:

  • lower_bound: The minimum value of the key specified during the query. The default is 0.
  • upper_bound: The maximum value of the key specified during the query. The default is -1, which is the largest unsigned integer.
  • limit: Specify the return limit bar when querying, and return 10 by default.
  • index_position: The index specified when querying, the default is 1, that is, the first index.
  • reverse: The result of the query is output in reverse order of the key. The default is 0, that is, the key is output from small to large.

All parameters of 'get_table_rows_params' have default values. If there is no need to change the default value, you can not pass in

Example:

unlocked >>> get_table_rows_ex gdice prizepool {}
get_table_rows_ex gdice prizepool {}
{
  "rows": [{
      "pool": {
        "amount": 27113974,
        "asset_id": 1
      },
      "totalbet": 580317119,
      "betcount": 3509,
      "wincount": 1753,
      "minbet": 50000,
      "minbank": 50000000,
      "investtotalpercent": 289011989,
      "profit": 8704792
    },{
      "pool": {
        "amount": 1015513750,
        "asset_id": 3
      },
      "totalbet": 38250000,
      "betcount": 17,
      "wincount": 9,
      "minbet": 50000,
      "minbank": 50000000,
      "investtotalpercent": "81684229471",
      "profit": 573750
    },{
      "pool": {
        "amount": "11029550000",
        "asset_id": 10
      },
      "totalbet": 75000000,
      "betcount": 7,
      "wincount": 2,
      "minbet": 50000,
      "minbank": 50000000,
      "investtotalpercent": "1899559049845",
      "profit": 1125000
    },{
      "pool": {
        "amount": "20073876000",
        "asset_id": 17
      },
      "totalbet": 1170000000,
      "betcount": 36,
      "wincount": 17,
      "minbet": 10000000,
      "minbank": "10000000000",
      "investtotalpercent": 1557641343,
      "profit": 17550000
    },{
      "pool": {
        "amount": "2000000110000",
        "asset_id": 27
      },
      "totalbet": 0,
      "betcount": 0,
      "wincount": 0,
      "minbet": 500,
      "minbank": 100000,
      "investtotalpercent": 200000005,
      "profit": 0
    }
  ],
  "more": false
}

get_witness

Interface: witness_object get_witness(string owner_account)

Description: Get witness node id

Parameter:

Param Type Description
owner_account string node id

Example:

unlocked >>> get_witness 1.6.1
get_witness 1.6.1
{
  "id": "1.6.1",
  "witness_account": "1.2.6",
  "last_aslot": 13626273,
  "signing_key": "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
  "pay_vb": "1.13.97",
  "vote_id": "1:0",
  "total_votes": "928209451466",
  "url": "",
  "total_missed": 35022,
  "last_confirmed_block_num": 12839765,
  "is_valid": true
}

get_account_history

Interface: vector<operation_detail> get_account_history(string name, int limit)

Description: Get the account history of the specified account

Special Instructions: Need to set the configuration options in the config.ini file as shown below

 # Account ID to track history for (may specify multiple times)
 track-account = "1.2.426"

 # Maximum number of operations per account will be kept in memory
 max-ops-per-account = 10000

Parameter:

Param Type Description
name string account
limit int limit number

Example:

unlocked >>> get_account_history zhao-123 5
get_account_history zhao-123 5
2019-04-11T06:51:18 Transfer 1 GXC from zhao-123 to nathan   (Fee: 0.01000 GXC)
2019-04-11T06:51:03 Transfer 1 GXC from zhao-123 to nathan   (Fee: 0.01000 GXC)

2.4 Transfer to other accounts

Here we use the cli_wallet command line tool to initiate a transfer. Please note: before initiating a transfer, you need to ensure that the private key of the transfer account has been imported.

Interface: signed_transaction transfer(string from, string to, string amount, string asset_symbol, string memo, bool broadcast)

Description: transfer to other account

Parameter:

Param Type Description
from string from account
to string to account
amount string Transfer amount, no need to multiply the precision (1 = 1 GXC)
asset_symbol string Asset name (eg GXC)
memo string memo
broadcast bool Whether to broadcast

Example:

unlocked >>> transfer zhao-123 nathan 1 GXC "transfer test" true
transfer zhao-123 nathan 1 GXC "transfer test" true
{
  "ref_block_num": 60407,
  "ref_block_prefix": 1572501575,
  "expiration": "2019-04-08T06:43:03",
  "operations": [[
      0,{
        "fee": {
          "amount": 1210,
          "asset_id": "1.3.1"
        },
        "from": "1.2.426",
        "to": "1.2.17",
        "amount": {
          "amount": 100000,
          "asset_id": "1.3.1"
        },
        "memo": {
          "from": "GXC8cQnHYf2RGgeAEAQKAT3i9Hz9rxJagcXcXD8Znvtj16vYybwxE",
          "to": "GXC8AoHzhXhMRV9AFTihMAcQPNXKFEZCeYNYomdcc7vh8Gzp7b7xP",
          "nonce": "7135256515508096303",
          "message": "d2d9e72e468fb8f4df7aaf8f0f3608701f95912800c96c6124eb3613699cb151"
        },
        "extensions": []
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "203cb7f17515a68026eec4a43b9651fc2ad1cc3d521ef9d93ff4612e435a36ba2718ce4e12a69163698643e7f77cdaf1f621241fabb502b65d2b471592a8f069ae"
  ]
}

2.5 Interact with smart contracts

Here we use the cli_wallet tool to interact with smart contracts, including deploying contracts, updating contracts, and invoking contracts.

deploy_contract

Interface: signed_transaction deploy_contract(string name, string account, string vm_type, string vm_version, string contract_dir, string fee_asset_symbol, bool broadcast)

Description: deploy contract

Parameter:

Param Description
name string contract name
account string Account for payment of fees
vm_type string Set to 0
vm_version string Set to 0
contract_dir string Contract directory (absolute path)
fee_asset_symbol string Asset name for payment of handling fee
broadcast bool Whether to broadcast

Example:

unlocked >>> deploy_contract hello0306 zhao-123 0 0 /Users/zhaoxiangfei/code/contracts_work/helloworld GXC true
deploy_contract hello0306 zhao-123 0 0 /Users/zhaoxiangfei/code/contracts_work/helloworld GXC true
{
  "ref_block_num": 60935,
  "ref_block_prefix": 792061404,
  "expiration": "2019-04-08T07:09:45",
  "operations": [[
      74,{
        "fee"
        ....
    }
    ]]
}

update_contract

Interface: signed_transaction update_contract(string contract, optional<string> new_owner, string contract_dir, string fee_asset_symbol, bool broadcast)

Description: unpdate contract

Parameter:

Param Type Description
contract string contract name
new_owner string Contract owner, the account that pays the fee when deploying the contract
contract_dir string Contract directory (absolute path)
fee_asset_symbol string Asset name for payment of handling fee
broadcast bool Whether to broadcast

Example:

unlocked >>> update_contract hello0306 zhao-123 /Users/zhaoxiangfei/code/contracts_work/helloworld GXC true
update_contract hello0306 zhao-123 /Users/zhaoxiangfei/code/contracts_work/helloworld GXC true
{
  "ref_block_num": 61224,
  "ref_block_prefix": 3331763629,
  "expiration": "2019-04-08T07:24:30",
  "operations": [[
      76,{
        "fee":
        ...
      }
   ]]
}

call_contract

Interface: signed_transaction call_contract(string account, string contract, optional<asset> amount, string method, string arg, string fee_asset_symbol, bool broadcast)

Description: call contract

Parameter:

Param Type Description
account string call contract
contract string contract name
amount optional<asset> The attached asset object can be filled with null.
method string contract method
arg string Contract parameters
fee_asset_symbol string Asset name for payment of handling fee
broadcast bool Whether to broadcast

Example:

unlocked >>> call_contract zhao-123 hello0306 null hi "{\"user\":\"gxchain\"}" GXC true
call_contract zhao-123 hello0306 null hi "{\"user\":\"gxchain\"}" GXC true
{
  "ref_block_num": 61393,
  "ref_block_prefix": 3449630089,
  "expiration": "2019-04-08T07:33:06",
  "operations": [[
      75,{
        "fee":
        ...
    }
    ]]
}

2.6 Manually constructing a transaction

The following is how to construct a transaction through the cli_wallet command line tool, the steps are as follows

begin_builder_transaction
add_operation_to_builder_transaction
set_fees_on_builder_transaction
sign_builder_transaction

begin_builder_transaction

Interface: transaction_handle_type begin_builder_transaction()

Description: Build a transaction instance for use with other commands that build transactions

Parameter: null

Example:

unlocked >>> begin_builder_transaction
begin_builder_transaction
0

add_operation_to_builder_transaction

Interface: void add_operation_to_builder_transaction(transaction_handle_type transaction_handle, const operation & op)

Description: Add an operation to the instance of the build and use it with other commands that build the transaction

Parameter: The operation structure added by this interface can be obtained by using the get_prototype_operation command. For the parameters, see operation type description.

Example:

Param Type Description
transaction_handle transaction_handle_type The return value of begin_builder_transaction, the index of the constructed transaction
op const operation & The operation object added to the transaction instance

Example:

unlocked >>> add_operation_to_builder_transaction 0 [0,{"from":"1.2.426","to":"1.2.425","amount":{"amount":3,"asset_id":"1.3.1"},"extensions":[]}]
add_operation_to_builder_transaction 0 [0,{"from":"1.2.426","to":"1.2.425","amount":{"amount":3,"asset_id":"1.3.1"},"extensions":[]}]
null

set_fees_on_builder_transaction

Interface: asset set_fees_on_builder_transaction(transaction_handle_type handle, string fee_asset)

Description: Set the commission for building a transaction

Parameter:

Param Type Description
handle transaction_handle_type The return value of begin_builder_transaction, the index of the constructed transaction
fee_asset string Added fee asset type

Example:

unlocked >>> set_fees_on_builder_transaction 0 GXC
set_fees_on_builder_transaction 0 GXC
{
  "amount": 1000,
  "asset_id": "1.3.1"
}

sign_builder_transaction

Interface: signed_transaction sign_builder_transaction(transaction_handle_type transaction_handle, bool broadcast)

Description: Sign the constructed transaction and select the broadcast

Parameter:

Param Type Description
transaction_handle transaction_handle_type The return value of begin_builder_transaction, the index of the constructed transaction
broadcast bool Whether to broadcast

Example:

unlocked >>> sign_builder_transaction 0 true
sign_builder_transaction 0 true
{
  "ref_block_num": 62831,
  "ref_block_prefix": 3969632163,
  "expiration": "2019-04-08T08:46:03",
  "operations": [[
      0,{
        "fee": {
          "amount": 1000,
          "asset_id": "1.3.1"
        },
        "from": "1.2.426",
        "to": "1.2.425",
        "amount": {
          "amount": 3,
          "asset_id": "1.3.1"
        },
        "extensions": []
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "207e9b0b29eb4b0dec8de0f7e64334109a3f0ebd4ce62b429b961f29a77c26799f3511f42638fdcf40811f5dab64f530c9f1f6013808c6d0d4167476e5afa52345"
  ]
}

operation

Common operations are as follows, please click operation type

transfer_operation,
account_create_operation,
account_update_operation,//6
account_whitelist_operation,//7
account_upgrade_operation,//8
account_transfer_operation,//9
asset_create_operation,//10
asset_update_operation,//11
asset_update_bitasset_operation,//12
asset_update_feed_producers_operation,//13
asset_issue_operation,//14
asset_reserve_operation,//15
asset_fund_fee_pool_operation,//16
asset_settle_operation,//17
asset_global_settle_operation,//18
asset_publish_feed_operation,//19
witness_create_operation,//20
witness_update_operation,//21
proposal_create_operation,//22
proposal_update_operation,//23
proposal_delete_operation,//24
committee_member_create_operation,//29
committee_member_update_operation,//30
committee_member_update_global_parameters_operation,//31
assert_operation,//36
balance_claim_operation,//37
account_upgrade_merchant_operation,//45
account_upgrade_datasource_operation,//46
account_upgrade_data_transaction_member_operation, // 58
balance_lock_operation,//71
balance_unlock_operation,//72
proxy_transfer_operation, //73
contract_deploy_operation, //74
contract_call_operation, //75
contract_update_operation, //76
trust_node_pledge_withdraw_operation, //77
inline_transfer_operation, //78
inter_contract_call_operation //79

2.7 Create brain_key

Interface: brain_key_info suggest_brain_key()

Description: generate a GXChain public and private key pair and brain_key

Parameter:

Example

unlocked >>> suggest_brain_key
suggest_brain_key
{
  "brain_priv_key": "JANE PUNLET SHINDLE TROPAL MORGAN FENBANK SMOLT HYMEN ABOUT ACINAR CARDED BILKER DAMINE CHYMIC FRINGE PROFIT",
  "wif_priv_key": "5Jki4BJqFhjDhujv9235e3RzXNBtJRzwEDr21sWr73ybUPwGgv6",
  "pub_key": "GXC58tBmaibqe6sYnwG9F2cVnqGkMoSzgnM8fVwVKUtbTWzjG6oTe"
}

2.8 Redemption of the trust node margin

Interface: signed_transaction withdraw_trust_node_pledge(string account_name, string fee_asset_symbol, bool broadcast)

Description: Redemption of the trust node margin

Parameter:

Param Type Description
account_name string trust node name
fee_asset_symbol string asset name
broadcast bool Whether to broadcast

Example:

unlocked >>> withdraw_trust_node_pledge zhao-123 GXC true
withdraw_trust_node_pledge zhao-123 GXC true
{
  "ref_block_num": 44471,
  "ref_block_prefix": 2738120339,
  "expiration": "2019-04-12T08:27:33",
  "operations": [[
      77,{
        "fee": {
          "amount": 100000,
          "asset_id": "1.3.1"
        },
        "witness_account": "1.2.426"
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "204f800aa97879fc80422f9325d974d8e490945466e36f86cef5346ca8065206a6309cca6267109225222b0fb551115acd7919ad5eb8acfa50d30df50bbf0a368c"
  ]
}

2.9 Vote for trust nodes

Interface: signed_transaction vote_for_trust_nodes(string voting_account, vector<string> account_names, bool broadcast)

Description: vote for trust nodes

Parameter:

Param Type Description
voting_account string vote account
account_names vector<string> Trust nodes to be voted
broadcast bool Whether to broadcast

Example:

unlocked >>> vote_for_trust_nodes zhao-123 ["zhuliting","gxcdac"] true
vote_for_trust_nodes zhao-123 ["zhuliting","gxcdac"] true
{
  "ref_block_num": 63768,
  "ref_block_prefix": 2128885974,
  "expiration": "2019-04-15T08:23:48",
  "operations": [[
      6,{
        "fee": {
          "amount": 106,
          "asset_id": "1.3.1"
        },
        "account": "1.2.426",
        "new_options": {
          "memo_key": "GXC8cQnHYf2RGgeAEAQKAT3i9Hz9rxJagcXcXD8Znvtj16vYybwxE",
          "voting_account": "1.2.5",
          "num_witness": 2,
          "num_committee": 2,
          "votes": [
            "0:85",
            "1:86",
            "0:97",
            "1:98"
          ],
          "extensions": []
        },
        "extensions": {}
      }
    ]
  ],
  "extensions": [],
  "signatures": [
    "201443e64789cbb1e0c0b6cca9405c90debdda77fadef2c89a052ddbe7f83104e60dd54e95a2430ad309daf524fa7dc92f8f7859423f2c305785e857d63bd6f201"
  ]
}

votes description

In the example, two accounts are voted, namely zhuliting and gxcdac, where the votes field can be obtained through the get_committee_member interface and the get_witness interface, indicating the voting id.

0 indicates the type of board member, 1 indicates the type of public node

get_witness zhuliting
{
  "id": "1.6.46",
  "witness_account": "1.2.71",
  "last_aslot": 13828348,
  "signing_key": "GXC8QeqwDVZCUQNMoyPmvEZvC4vEyv92663KgasXnrUCKNykn6xAr",
  "pay_vb": "1.13.156",
  "vote_id": "1:98",
  "total_votes": "922407503184",
  "url": "https://github.com/zhuliting",
  "total_missed": 162,
  "last_confirmed_block_num": 13041248,
  "is_valid": true
}
unlocked >>> get_committee_member zhuliting
get_committee_member zhuliting
{
  "id": "1.5.52",
  "committee_member_account": "1.2.71",
  "vote_id": "0:97",
  "total_votes": "922407503184",
  "url": "",
  "is_valid": false
}
Last Updated: 4/18/2019, 9:19:07 PM