Cleos

 

Subcommands

version client - Retrieve version information of the client

Suggest Edits

version client

Retrieve version information of the client

 

Positionals

none

Usage

$ ./cleos version client
Suggest Edits

convert

Pack and unpack transactions

 

subcommands

Suggest Edits

pack_transaction

From plain signed json to packed form

 

Positionals

  • transaction TEXT - The plain signed json (string)

Options

  • --pack-action-data - Pack all action data within transaction, needs interaction with nodeos

Usage

cleos convert pack_transaction '{
  "expiration": "2018-08-02T20:24:36",
  "ref_block_num": 14207,
  "ref_block_prefix": 1438248607,
  "max_net_usage_words": 0,
  "max_cpu_usage_ms": 0,
  "delay_sec": 0,
  "context_free_actions": [],
  "actions": [{
      "account": "eosio",
      "name": "newaccount",
      "authorization": [{
          "actor": "eosio",
          "permission": "active"
        }
      ],
      "data": "0000000000ea305500a6823403ea30550100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d8010000000100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d801000000"
    }
  ],
  "transaction_extensions": []
}'

Output

{
  "signatures": [],
  "compression": "none",
  "packed_context_free_data": "",
  "packed_trx": "8468635b7f379feeb95500000000010000000000ea305500409e9a2264b89a010000000000ea305500000000a8ed3232660000000000ea305500a6823403ea30550100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d8010000000100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d80100000000"
}
Suggest Edits

unpack_transaction

From packed to plain signed json form

 

Positionals

  • transaction TEXT - The packed transaction json (string containing packed_trx and optionally compression fields.)

Options

  • --unpack-action-data - Unpack all action data within transaction, needs interaction with nodeos

Usage

cleos convert unpack_transaction '{
  "signatures": [
    "SIG_K1_KmRbWahefwxs6uyCGNR6wNRjw7cntEeFQhNCbyg8S92Kbp7zdSSVGTD2QS7pNVWgcU126zpxaBp9CwUxFpRwSnfkjd46bS"
  ],
  "compression": "none",
  "packed_context_free_data": "",
  "packed_trx": "8468635b7f379feeb95500000000010000000000ea305500409e9a2264b89a010000000000ea305500000000a8ed3232660000000000ea305500a6823403ea30550100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d8010000000100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d80100000000"
}'

Output

{
  "expiration": "2018-08-02T20:24:36",
  "ref_block_num": 14207,
  "ref_block_prefix": 1438248607,
  "max_net_usage_words": 0,
  "max_cpu_usage_ms": 0,
  "delay_sec": 0,
  "context_free_actions": [],
  "actions": [{
      "account": "eosio",
      "name": "newaccount",
      "authorization": [{
          "actor": "eosio",
          "permission": "active"
        }
      ],
      "data": "0000000000ea305500a6823403ea30550100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d8010000000100000001000240cc0bf90a5656c8bb81f0eb86f49f89613c5cd988c018715d4646c6bd0ad3d801000000"
    }
  ],
  "transaction_extensions": [],
  "signatures": [
    "SIG_K1_KmRbWahefwxs6uyCGNR6wNRjw7cntEeFQhNCbyg8S92Kbp7zdSSVGTD2QS7pNVWgcU126zpxaBp9CwUxFpRwSnfkjd46bS"
  ],
  "context_free_data": []
}
Suggest Edits

pack_action_data

From json action data to packed form

 

Positionals

  • account TEXT - The name of the account that hosts the contract
  • name TEXT - The name of the function that's called by this action
  • unpacked_action_data TEXT - The action data expressed as json

Options

none

Usage

 cleos convert pack_action_data eosio unlinkauth '{"account":"test1", "code":"test2", "type":"eosioeosio"}'

Output

000000008090b1ca000000000091b1ca000075982aea3055
Suggest Edits

unpack_action_data

From packed to json action data form

 

Positionals

  • account TEXT - The name of the account that hosts the contract
  • name TEXT - The name of the function that's called by this action
  • packed_action_data TEXT - The action data expressed as packed hex string

Options

Usage

 cleos convert unpack_action_data eosio unlinkauth 000000008090b1ca000000000091b1ca000075982aea3055

Output

{
  "account": "test1",
  "code": "test2",
  "type": "eosioeosio"
}
Suggest Edits

create

Create various items, on and off the blockchain

 

Subcommands

key - Create a new keypair and print the public and private keys
account - Create a new account on the blockchain

Suggest Edits

create key

Creates a new keypair and prints the public and private keys.

 

Positionals

None

Options

  • --r1 - Generate a key using the R1 curve (iPhone), instead of the K1 curve (Bitcoin)
  • -f, --file TEXT - Name of file to write private/public key output to. (Must be set, unless "--to-console" is passed.
  • --to-console - Print private/public keys to console.

Usage

$ ./cleos create key -f myKey.txt
$ ./cleos create key --to-console

Output



Private key: 5KCkcSxYKZfh5Cr8CCunS2PiUKzNZLhtfBjudaUnad3PDargFQo
Public key: EOS5uHeBsURAT6bBXNtvwKtWaiDSDJSdSmc96rHVws5M1qqVCkAm6
Suggest Edits

create account

Creates a new account on the blockchain.

 

Positionals

  • creator TEXT - The name of the account creating the new account
  • name TEXT - The name of the new account
  • OwnerKey TEXT - The owner public key for the new account
  • ActiveKey TEXT - The active public key for the new account

Options

  • --stake-net TEXT - The amount of EOS delegated for net bandwidth
  • --stake-cpu TEXT - The amount of EOS delegated for CPU bandwidth
  • --buy-ram-kbytes _UINT32 - The amount of RAM bytes to purchase for the new account in kibibytes (KiB), default is 8 KiB
  • --buy-ram TEXT - The amount of RAM bytes to purchase for the new account in EOS
  • --transfer BOOL - Transfer voting power and right to unstake EOS to receiver

Important Note

If the system contract is loaded, (for example a production network) then use cleos system newaccount instead

Usage

Usage: ./cleos create account [OPTIONS] creator name OwnerKey ActiveKey

Positionals:
  creator TEXT                The name of the account creating the new account
  name TEXT                   The name of the new account
  OwnerKey TEXT               The owner public key for the new account
  ActiveKey TEXT              The active public key for the new account

Options:
  -x,--expiration             set the time in seconds before a transaction expires, defaults to 30s
  -f,--force-unique           force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  -s,--skip-sign              Specify if unlocked wallet keys should be used to sign transaction
  -d,--dont-broadcast         don't broadcast transaction to the network (just print to stdout)
  -p,--permission TEXT ...    An account and permission level to authorize, as in 'account@permission' (defaults to 'creator@active')

Command

A set of EOS keys is required to create an account. A set of EOS keys can be generated by using ./cleos create key.

$ ./cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA

Output

{
  "transaction_id": "6acd2ece68c4b86c1fa209c3989235063384020781f2c67bbb80bc8d540ca120",
  "processed": {
    "refBlockNum": "25217",
    "refBlockPrefix": "2095475630",
    "expiration": "2017-07-25T17:54:55",
    "scope": [
      "eos",
      "inita"
    ],
    "signatures": [],
    "messages": [{
        "code": "eos",
        "type": "newaccount",
        "authorization": [{
            "account": "inita",
            "permission": "active"
          }
        ],
        "data": "c9251a0000000000b44c5a2400000000010000000102bcca6347d828d4e1868b7dfa91692a16d5b20d0ee3d16a7ca2ddcc7f6dd03344010000010000000102bcca6347d828d4e1868b7dfa91692a16d5b20d0ee3d16a7ca2ddcc7f6dd03344010000010000000001c9251a000000000061d0640b000000000100010000000000000008454f5300000000"
      }
    ],
    "output": [{
        "notify": [],
        "sync_transactions": [],
        "async_transactions": []
      }
    ]
  }
}
Suggest Edits

get

Retrieves various items and information from the blockchain.

 

Subcommands

  • info Get current blockchain information
  • block Retrieve a full block from the blockchain
  • account Retrieve an account from the blockchain
  • code Retrieve the code and ABI for an account
  • table Retrieve the contents of a database table
  • currency Retrieve information related to standard currencies
  • accounts Retrieve accounts associated with a public key
  • servants Retrieve accounts which are servants of a given
Suggest Edits

get info

Gets current blockchain information.

 

Positionals

This command does not accept any parameters.

Options

This command has no options

Example

$ ./cleos get info

This command simply returns the current blockchain state information.

{
  "server_version": "7451e092",
  "head_block_num": 6980,
  "last_irreversible_block_num": 6963,
  "head_block_id": "00001b4490e32b84861230871bb1c25fb8ee777153f4f82c5f3e4ca2b9877712",
  "head_block_time": "2017-12-07T09:18:48",
  "head_block_producer": "initp",
  "recent_slots": "1111111111111111111111111111111111111111111111111111111111111111",
  "participation_rate": "1.00000000000000000"
}
Suggest Edits

get block

Retrieves a full block from the blockchain.

 

Positionals

  • block TEXT - The number or ID of the block to retrieve

Options

This command has no options

Example

$ ./cleos get block 1
$ ./cleos get block
#0000000130d70e94e0022fd2fa035cabb9e542c34ea27f572ac90b5a7aa3d891

This will output a block object similar to the following

{
  "timestamp": "2018-03-02T12:00:00.000",
  "producer": "",
  "confirmed": 1,
  "previous": "0000000000000000000000000000000000000000000000000000000000000000",
  "transaction_mroot": "0000000000000000000000000000000000000000000000000000000000000000",
  "action_mroot": "0000000000000000000000000000000000000000000000000000000000000000",
  "schedule_version": 0,
  "new_producers": null,
  "header_extensions": [],
  "producer_signature": "SIG_K1_111111111111111111111111111111111111111111111111111111111111111116uk5ne",
  "transactions": [],
  "block_extensions": [],
  "id": "0000000130d70e94e0022fd2fa035cabb9e542c34ea27f572ac90b5a7aa3d891",
  "block_num": 1,
  "ref_block_prefix": 3526296288
}
Suggest Edits

get account

Retrieves an account from the blockchain.

 

Positionals

  • name TEXT - The name of the account to retrieve

Options

  • -j,--json - Output in JSON format

Example

Get formatted data for user eosio

$ cleos get account eosio
privileged: true
permissions: 
     owner     1:    1 EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV
        active     1:    1 EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV
memory: 
     quota:        -1 bytes  used:      1.22 Mb   

net bandwidth: (averaged over 3 days)
     used:                -1 bytes
     available:           -1 bytes
     limit:               -1 bytes

cpu bandwidth: (averaged over 3 days)
     used:                -1 us   
     available:           -1 us   
     limit:               -1 us   

producers:     <not voted>

Get JSON data for user eosio

$ cleos get account eosio --json
{
  "account_name": "eosio",
  "privileged": true,
  "last_code_update": "2018-05-23T18:00:25.500",
  "created": "2018-03-02T12:00:00.000",
  "ram_quota": -1,
  "net_weight": -1,
  "cpu_weight": -1,
  "net_limit": {
    "used": -1,
    "available": -1,
    "max": -1
  },
  "cpu_limit": {
    "used": -1,
    "available": -1,
    "max": -1
  },
  "ram_usage": 1279625,
  "permissions": [{
      "perm_name": "active",
      "parent": "owner",
      "required_auth": {
        "threshold": 1,
        "keys": [{
            "key": "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV",
            "weight": 1
          }
        ],
        "accounts": [],
        "waits": []
      }
    },{
      "perm_name": "owner",
      "parent": "",
      "required_auth": {
        "threshold": 1,
        "keys": [{
            "key": "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV",
            "weight": 1
          }
        ],
        "accounts": [],
        "waits": []
      }
    }
  ],
  "total_resources": null,
  "delegated_bandwidth": null,
  "voter_info": {
    "owner": "eosio",
    "proxy": "",
    "producers": [],
    "staked": 0,
    "last_vote_weight": "0.00000000000000000",
    "proxied_vote_weight": "0.00000000000000000",
    "is_proxy": 0,
    "deferred_trx_id": 0,
    "last_unstake_time": "1970-01-01T00:00:00",
    "unstaking": "0.0000 SYS"
  }
}
Suggest Edits

get code

Retrieves the code and ABI for an account.

 

Positionals

  • name TEXT - The name of the account whose code should be retrieved

Options

  • -c,--code TEXT - The name of the file to save the contract .wast to
  • -a,--abi TEXT - The name of the file to save the contract .abi to

Examples

Simply output the hash of eosio.token contract

$ cleos get code eosio.token
code hash: f675e7aeffbf562c033acfaf33eadff255dacb90d002db51c7ad7cbf057eb791

Retrieve and save abi for eosio.token contract

$ cleos get code eosio.token -a eosio.token.abi
code hash: f675e7aeffbf562c033acfaf33eadff255dacb90d002db51c7ad7cbf057eb791
saving abi to eosio.token.abi

Retrieve and save wast code for eosio.token contract

$ cleos get code eosio.token -c eosio.token.wast
code hash: f675e7aeffbf562c033acfaf33eadff255dacb90d002db51c7ad7cbf057eb791
saving wast to eosio.token.wast
Suggest Edits

get table

Retrieves the contents of a database table.

 

Positionals

contract TEXT - The contract who owns the table
scope TEXT - The scope within the contract in which the table is found
table TEXT - The name of the table as specified by the contract abi

Options

-b,--binary UINT - Return the value as BINARY rather than using abi to interpret as JSON
-l,--limit UINT - The maximum number of rows to return
-L,--lower TEXT - JSON representation of lower bound value of key, defaults to first
--show-payer BOOLEAN - show RAM payer (default: false)
-r,--reverse BOOLEAN - Iterate in reverse order (default: false)
-U,--upper TEXT - JSON representation of upper bound value value of key, defaults to last
--index TEXT - Index number, 1 - primary (first), 2 - secondary index (in order defined by multi_index), 3 - third index, etc. Number or name of index can be specified, e.g. 'secondary' or '2'.
--key-type TEXT - The key type of --index, primary only supports (i64), all others support (i64, i128, i256, float64, float128, sha256). Special type 'name' indicates an account name.

Example

Find the bid name with the lowest bid

cleos get table eosio eosio namebids --key-type i64 --index 2 -r -l 1
{
  "rows": [{
      "newname": "com",
      "high_bidder": "a123",
      "high_bid": 100000,
      "last_bid_time": "1541667021500000"
    }
  ],
  "more": true
}

Or to show all name bids from high to low, including the RAM payer information

cleos get table eosio eosio namebids --key-type i64 --index 2 -r --show-payer
{
  "rows": [{
      "data": {
        "newname": "com",
        "high_bidder": "a123",
        "high_bid": 100000,
        "last_bid_time": "1541667021500000"
      },
      "payer": "a123"
    },{
      "data": {
        "newname": "abc",
        "high_bidder": "a123",
        "high_bid": 110000,
        "last_bid_time": "1541667021500000"
      },
      "payer": "a123"
    },{
      "data": {
        "newname": "ddd",
        "high_bidder": "a123",
        "high_bid": 120000,
        "last_bid_time": "1541667021500000"
      },
      "payer": "a123"
    },{
      "data": {
        "newname": "zoo",
        "high_bidder": "a123",
        "high_bid": 9990000,
        "last_bid_time": "1541667022000000"
      },
      "payer": "a123"
    }
  ],
  "more": false
}
Suggest Edits

get currency

Exposes subcommands for accessing standard currencies.

 

Subcommands

currency balance - Retrieve the balance of an account for a given currency
currency stats - Retrieve the stats of for a given currency

Suggest Edits

get currency balance

Retrieve the balance of an account for a given currency

 

Positionals

contract TEXT - The contract that operates the currency
account TEXT - The account to query balances for
symbol TEXT - The symbol for the currency if the contract operates multiple currencies

Options

There are no options for this subcommand

Example

Get balance of eosio from eosio.token contract for SYS symbol.

$ cleos get currency balance eosio.token eosio SYS
999999920.0000 SYS
Suggest Edits

get currency stats

Retrieve the stats of for a given currency

 

Positionals

contract TEXT - The contract that operates the currency
symbol TEXT - The symbol for the currency if the contract operates multiple currencies

Options

There are no options for this subcommand

Example

Get stats of the SYS token from the eosio.token contract.

$ cleos get currency stats eosio.token SYS
{
  "SYS": {
    "supply": "1000000000.0000 SYS",
    "max_supply": "10000000000.0000 SYS",
    "issuer": "eosio"
  }
}
Suggest Edits

get accounts

Retrieves all accounts associated with a defined public key.

 

This command will not return privileged accounts.

Positionals

public_key TEXT - The public key to retrieve accounts for

Options

There are no options for this command

Example

$ cleos get accounts EOS8mUftJXepGzdQ2TaCduNuSPAfXJHf22uex4u41ab1EVv9EAhWt
{
  "account_names": [
    "testaccount"
  ]
}
Suggest Edits

get servants

 

Positionals

  • account Text - Reference account to return accounts created by this account.

Usage

$ cleos get servants eosio
Suggest Edits

get transaction

Retrieves a transaction from the blockchain.

 

Positionals

`id`` TEXT - ID of the transaction to retrieve

Options

There are no options for this command

Info

Command

$ ./cleos get transaction

Output

Example

$ ./cleos get transaction eb4b94b72718a369af09eb2e7885b3f494dd1d8a20278a6634611d5edd76b703
{
  "transaction_id": "eb4b94b72718a369af09eb2e7885b3f494dd1d8a20278a6634611d5edd76b703",
  "processed": {
    "refBlockNum": 2206,
    "refBlockPrefix": 221394282,
    "expiration": "2017-09-05T08:03:58",
    "scope": [
      "inita",
      "tester"
    ],
    "signatures": [
      "1f22e64240e1e479eee6ccbbd79a29f1a6eb6020384b4cca1a958e7c708d3e562009ae6e60afac96f9a3b89d729a50cd5a7b5a7a647540ba1678831bf970e83312"
    ],
    "messages": [{
        "code": "eos",
        "type": "transfer",
        "authorization": [{
            "account": "inita",
            "permission": "active"
          }
        ],
        "data": {
          "from": "inita",
          "to": "tester",
          "amount": 1000,
          "memo": ""
        },
        "hex_data": "000000008040934b00000000c84267a1e80300000000000000"
      }
    ],
    "output": [{
        "notify": [{
            "name": "tester",
            "output": {
              "notify": [],
              "sync_transactions": [],
              "async_transactions": []
            }
          },{
            "name": "inita",
            "output": {
              "notify": [],
              "sync_transactions": [],
              "async_transactions": []
            }
          }
        ],
        "sync_transactions": [],
        "async_transactions": []
      }
    ]
  }
}

Important Note

The above transaction id will not exist on your blockchain

Suggest Edits

get actions

Retrieves all actions with specific account name referenced in their scope.

 

We can also query list of actions that have an account as a receiver. The only accounts queryable are those listed as the receiver in the --filter-on receiver:action:actor option.

Positionals

  • account_name TEXT - name of account to query on

Usage

Get actions belonging to eosio, the response you receive will differ.

$ ./cleos get actions eosio.token
#  seq  when                              contract::action => receiver      trx id...   args
================================================================================================================
#  976   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   1d1fe154... {"from":"useraaaaaaae","to":"useraaaaaaaa","quantity":"0.000...
#  977   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   a0c9e5bc... {"from":"useraaaaaaab","to":"useraaaaaaaa","quantity":"0.000...
#  978   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   3749d0d1... {"from":"useraaaaaaab","to":"useraaaaaaah","quantity":"0.000...
#  979   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   dda205b0... {"from":"useraaaaaaai","to":"useraaaaaaaj","quantity":"0.000...
#  980   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   14089e9b... {"from":"useraaaaaaab","to":"useraaaaaaae","quantity":"0.000...
#  981   2018-06-01T19:54:05.000     eosio.token::transfer => eosio.token   6882cefc... {"from":"useraaaaaaaj","to":"useraaaaaaab","quantity":"0.000...
...

Description

Sets or updates the blockchain state.

Commands

  • [code] Create or update the code on an account
    abi Create or update the abi on an account
    contract Create or update the contract on an account
    account set or update blockchain account state
    action set or update blockchain action state
Suggest Edits

set contract

Creates or updates the contract on an account.

 

Positionals

  • account TEXT - The account to publish a contract for
  • contract-dir TEXT - The path containing the .wasm and .abi
  • wast-file TEXT - The file containing the contract or .wasm
  • abi-file TEXT - The .abi for the contract

Options

  • -h,--help Print this help message and exit
  • -a,--abi TEXT - The ABI for the contract
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

Here we deploy the standard currency contract.

$ ./cleos set contract currency ../../../contracts/currency/currency.wast ../../../contracts/currency/currency.abi

This will output something similar to...

Reading WAST...
Assembling WASM...
Publishing contract...
{
  "transaction_id": "9990306e13f630a9c5436a5a0b6fb8fe2c7f3da2f342b4898a39c4a2c17dcdb3",
  "processed": {
    "refBlockNum": 1208,
    "refBlockPrefix": 3058534156,
    "expiration": "2017-08-24T18:29:52",
    "scope": [
      "currency",
      "eos"
    ],
    "signatures": [],
    "messages": [{
        "code": "eos",
        "type": "setcode",
        "authorization": [{
            "account": "currency",
            "permission": "active"
          }
        ],
        "data": "00000079b822651d0000e8150061736d0100000001390a60017e0060037e7e7f017f60047e7e7f7f017f60017f0060057e7e7e7f7f017f60027f7f0060027f7f017f60027e7f0060000060027e7e00029d010a03656e7606617373657274000503656e76086c6f61645f693634000403656e76067072696e7469000003656e76067072696e746e000003656e76067072696e7473000303656e760b726561644d657373616765000603656e760a72656d6f76655f693634000103656e760b7265717569726541757468000003656e760d726571756972654e6f74696365000003656e760973746f72655f6936340002030706000007030809040401700000050301000107cc0107066d656d6f72790200205f5a4e33656f733133726571756972654e6f74696365454e535f344e616d6545000a1e5f5a4e33656f7331317265717569726541757468454e535f344e616d6545000b345f5a4e3863757272656e6379313273746f72654163636f756e74454e33656f73344e616d6545524b4e535f374163636f756e7445000c355f5a4e3863757272656e637932336170706c795f63757272656e63795f7472616e7366657245524b4e535f385472616e7366657245000d04696e6974000e056170706c79000f0a9d0d060600200010080b0600200010070b3400024020012903084200510d0020004280808080a8d7bee3082001411010091a0f0b20004280808080a8d7bee308200110061a0b8a0604017e027f047e017f4100410028020441206b2208360204200029030821052000290300210720002903102104411010042004100241c000100442808080c887d7c8b21d100341d00010042007100341e000100420051003200029030021052000290308100820051008200029030010072000290300210142002105423b210441f00021034200210603400240024002400240024020054206560d0020032c00002202419f7f6a41ff017141194b0d01200241a0016a21020c020b420021072005420b580d020c030b200241ea016a41002002414f6a41ff01714105491b21020b2002ad42388642388721070b2007421f83200442ffffffff0f838621070b200341016a2103200542017c2105200720068421062004427b7c2204427a520d000b420021052008420037031820082006370310200142808080c887d7c8b21d4280808080a8d7bee308200841106a411010011a200041086a2903002101423b210441f00021034200210603400240024002400240024020054206560d0020032c00002202419f7f6a41ff017141194b0d01200241a0016a21020c020b420021072005420b580d020c030b200241ea016a41002002414f6a41ff01714105491b21020b2002ad42388642388721070b2007421f83200442ffffffff0f838621070b200341016a2103200542017c2105200720068421062004427b7c2204427a520d000b2008200637030020084200370308200142808080c887d7c8b21d4280808080a8d7bee3082008411010011a200841186a2203290300200041106a22022903005a418001100020032003290300200229030022057d370300200520082903087c20055a41b00110002008200829030820022903007c370308200029030021050240024020032903004200510d0020054280808080a8d7bee308200841106a411010091a0c010b20054280808080a8d7bee308200841106a10061a0b200041086a290300210502400240200841086a2903004200510d0020054280808080a8d7bee3082008411010091a0c010b20054280808080a8d7bee308200810061a0b4100200841206a3602040b980303027f057e017f4100410028020441106b220736020442002103423b210241e00121014200210403400240024002400240024020034207560d0020012c00002200419f7f6a41ff017141194b0d01200041a0016a21000c020b420021052003420b580d020c030b200041ea016a41002000414f6a41ff01714105491b21000b2000ad42388642388721050b2005421f83200242ffffffff0f838621050b200141016a2101200342017c2103200520048421042002427b7c2202427a520d000b42002103423b210241f00021014200210603400240024002400240024020034206560d0020012c00002200419f7f6a41ff017141194b0d01200041a0016a21000c020b420021052003420b580d020c030b200041ea016a41002000414f6a41ff01714105491b21000b2000ad42388642388721050b2005421f83200242ffffffff0f838621050b200141016a2101200342017c2103200520068421062002427b7c2202427a520d000b2007428094ebdc033703082007200637030020044280808080a8d7bee3082007411010091a4100200741106a3602040bb10303027f047e017f4100410028020441206b220836020442002105423b210441e00121034200210603400240024002400240024020054207560d0020032c00002202419f7f6a41ff017141194b0d01200241a0016a21020c020b420021072005420b580d020c030b200241ea016a41002002414f6a41ff01714105491b21020b2002ad42388642388721070b2007421f83200442ffffffff0f838621070b200341016a2103200542017c2105200720068421062004427b7c2204427a520d000b024020062000520d0042002105423b210441f00121034200210603400240024002400240024020054207560d0020032c00002202419f7f6a41ff017141194b0d01200241a0016a21020c020b420021072005420b580d020c030b200241ea016a41002002414f6a41ff01714105491b21020b2002ad42388642388721070b2007421f83200442ffffffff0f838621070b200341016a2103200542017c2105200720068421062004427b7c2204427a520d000b20062001520d00200842003703102008420037030820084200370318200841086a4118100541174b4180021000200841086a100d0b4100200841206a3602040b0bff010b0041040b04200500000041100b2254686973206170706561727320746f2062652061207472616e73666572206f6620000041c0000b0220000041d0000b072066726f6d20000041e0000b0520746f20000041f0000b086163636f756e7400004180010b2c696e746567657220756e646572666c6f77207375627472616374696e6720746f6b656e2062616c616e6365000041b0010b26696e7465676572206f766572666c6f7720616464696e6720746f6b656e2062616c616e6365000041e0010b0963757272656e6379000041f0010b097472616e7366657200004180020b1e6d6573736167652073686f72746572207468616e2065787065637465640000fd02046e616d651006617373657274020000086c6f61645f693634050000000000067072696e74690100067072696e746e0100067072696e747301000b726561644d6573736167650200000a72656d6f76655f693634030000000b726571756972654175746801000d726571756972654e6f7469636501000973746f72655f6936340400000000205f5a4e33656f733133726571756972654e6f74696365454e535f344e616d65450101301e5f5a4e33656f7331317265717569726541757468454e535f344e616d6545010130345f5a4e3863757272656e6379313273746f72654163636f756e74454e33656f73344e616d6545524b4e535f374163636f756e74450201300131355f5a4e3863757272656e637932336170706c795f63757272656e63795f7472616e7366657245524b4e535f385472616e73666572450901300131013201330134013501360137013804696e69740801300131013201330134013501360137056170706c7909013001310132013301340135013601370138010b4163636f756e744e616d65044e616d6502087472616e7366657200030466726f6d0b4163636f756e744e616d6502746f0b4163636f756e744e616d65087175616e746974790655496e743634076163636f756e740002036b65790655496e7436340762616c616e63650655496e74363401000000b298e982a4087472616e736665720100000080bafac608076163636f756e74"
      }
    ],
    "output": [{
        "notify": [],
        "sync_transactions": [],
        "async_transactions": []
      }
    ]
  }
}
Suggest Edits

set account permission

Creates or updates an account's permission

 

Positionals

  • account TEXT - The account to set/delete a permission authority for
  • permission TEXT - The permission name to set/delete an authority for
  • authority TEXT - [delete] NULL, [create/update] public key, JSON string, or filename defining the authority
  • parent TEXT - [create] The permission name of this parents permission (Defaults to: "Active")

Options

  • -h,--help Print this help message and exit
  • --add-code [code] add 'eosio.code' permission to specified permission authority
  • --remove-code [code] remove 'eosio.code' permission from specified permission authority
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)
  • --add-code Add eosio.code permission level to the account
  • -j,--json Print result as json

Usage

To modify permissions of an account, you must have the authority over the account and the permission of which you are modifying.

Basic usage, set new key to a permission

$ ./cleos set account permission testaccount active EOSPUBLICKEY owner -p testaccount@owner

Basic usage, set an account (instead of a key) as authority for a permission.

$ ./cleos set account permission testaccount active diffaccount owner -p testaccount@owner

Advanced Usage, weight/thresholds

$ ./cleos set account permission testaccount active '{"threshold" : 100, "keys" : [], "accounts" : [{"permission":{"actor":"user1","permission":"active"},"weight":25}, {"permission":{"actor":"user2","permission":"active"},"weight":75}]}' owner -p testaccount@owner

The JSON object used in this command is actually composed of two different types of objects

The authority JSON object ...

{
  "threshold"       : 100,    /*An integer that defines cumulative signature weight required for authorization*/
  "keys"            : [],     /*An array made up of individual permissions defined with an EOSIO-style PUBLIC KEY*/
  "accounts"        : []      /*An array made up of individual permissions defined with an EOSIO-style ACCOUNT*/
}

Returns

...contains 0 or more objects in the keys array

{
  "key"           : "EOS8X7Mp7apQWtL6T2sfSZzBcQNUqZB7tARFEm9gA9Tn9nbMdsvBB",
  "weight"        : 25      /*Set the weight of a signature from this permission*/
}

...contains 0 or more objects in the accounts array

{
  "permission" : {
    "actor"       : "sandwich",
    "permission"  : "active"
  },
  "weight"      : 75      /*Set the weight of a signature from this permission*/
}
Suggest Edits

set action permission

Set's authorization for a contract's specific action

 

Positionals

  • account TEXT - The account to set/delete a permission authority for (required)
  • code TEXT - The account that owns the code for the action
  • type TEXT the type of the action
  • requirement TEXT - The permission name require for executing the given action

Options

  • -h,--help - Print this help message and exit
  • `-a,--abi' TEXT - The ABI for the contract
  • `-x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign - Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - Set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - Set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

#cleos set action permission @ACCOUNT @CONTRACT ACTION_NAME PERMISSION_NAME

#Link a `voteproducer` action to the 'vote' permissions
cleos set action permission sandwichfarm eosio.system voteproducer voting -p sandwichfarm@voting

#Now can execute the transaction with the previously set permissions. 
cleos system voteproducer approve sandwichfarm someproducer -p sandwichfarm@voting
 

Positionals

  • account TEXT - The account to set code for (required)
  • code-file TEXT - The fullpath containing the contract WAST or WASM (required)

Options

  • -h,--help Print this help message and exit
  • `-a,--abi' TEXT - The ABI for the contract
  • `-x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)
  • --add-code Add eosio.code permission level to the account's active authority
  • --remove-code Remove eosio.code permission level to the account's active authority

Usage

cleos set code someaccount1 ./path/to/wasm
Suggest Edits

set abi

Create or update the abi on an account

 

Positionals

  • account TEXT - The account to set code for (required)
  • abi-file TEXT - The fullpath containing the contract WAST or WASM (required)

Options

  • -h,--help Print this help message and exit
  • `-a,--abi' TEXT - The ABI for the contract
  • `-x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos set abi someaccount1 ./path/to/abi.abi
Suggest Edits

transfer

Transfer a token

 

Positional Parameters

  • sender TEXT - The account sending tokens
  • recipient TEXT - The account receiving tokens
  • amount TEXT - The amount of tokens to send and the token symbol
  • memo TEXT - The memo for the transfer

Options

  • -c, --contractTEXT - The contract which controls the token. Defaults to eosio.token.

Usage

Transfer 1 SYS from inita to tester

$ ./cleos transfer useraaaaaaaa useraaaaaaac "1.0000 SYS" "hello world"
$ ./cleos transfer useraaaaaaaa useraaaaaaac -c eosio.token "1.0000 SYS" "hello world"

The response will look something like this

executed transaction: ac989464a987e9061d4eabdfad0e5707a23ba769798a01f3ce010c5b3775b554  128 bytes  490 us
#   eosio.token <= eosio.token::transfer        {"from":"useraaaaaaaa","to":"useraaaaaaac","quantity":"1.0000 SYS","memo":"hello world"}

Subcommands

Suggest Edits

net connect

Connect to a peer

 

Positionals

  • host TEXT - The hostname:port to connect to. (required)

Options

None

Example

cleos net connect http://somehost.com:1234
Suggest Edits

net disconnect

Disconnect from a peer

 

Positionals

  • host TEXT - The hostname:port to disconnect from (required)

Options

none

Usage

cleos net disconnect http://somehost.com:1234
Suggest Edits

net status

Returns status of a specific peer defined by url

 

Positionals

  • host TEXT - The hostname:port to query status of connection (required)

Options

None

Example

cleos net status http://somepeer:1234
#returns status of a configured peer
Suggest Edits

net peers

Returns JSON of currently connected peers

 

Positionals

None

Options

None

Usage

cleos net peers 
#returns JSON of currently connected peers

Description

Subcommand used to interact with the local wallet.

Subcommands

  • create Create a new wallet locally
  • open Open an existing wallet
  • lock Lock wallet
  • lock_all Lock all unlocked wallets
  • unlock Unlock wallet
  • import Import private key into wallet
  • list List opened wallets, * = unlocked
  • keys List of private keys from all unlocked wallets in wif format.
  • create_key Create a public/private key pair.
  • private_keys List of private keys from all unlocked wallets in wif format.
Suggest Edits

create

Creates a wallet with the specified name. If no name is given, the wallet will be created with the name 'default'.

 

Positionals

None

Options

  • -n, --name TEXT - The name of the new wallet
  • -f, --file TEXT - Name of file to write wallet password output to. (Must be set, unless "--to-console" is passed
  • --to-console - Print password to console

Usage

$ ./cleos wallet create --to-console
or
$ ./cleos wallet create -n second-wallet --to-console
or
$ ./cleos wallet create --name my-new-wallet --file my-new-wallet.txt

Outputs

Creating wallet: default
Save password to use in the future to unlock this wallet.
Without password imported keys will not be retrievable.
"PW5JD9cw9YY288AXPvnbwUk5JK4Cy6YyZ83wzHcshu8F2akU9rRWE"
or
Creating wallet: second-wallet
Save password to use in the future to unlock this wallet.
Without password imported keys will not be retrievable.
"PW5Ji6JUrLjhKAVn68nmacLxwhvtqUAV18J7iycZppsPKeoGGgBEw"
Suggest Edits

open

Opens an existing wallet.

 

Positionals

None

Options

  • -n, --name TEXT - The name of the wallet to open.

Usage

$ ./cleos wallet open
or
$ ./cleos wallet open -n second-wallet

Outputs

Opened: default
Suggest Edits

lock

Locks a wallet.

 

Positionals

None

Options

  • -n, --name TEXT - The name of the wallet to lock

Usage

$ cleos wallet lock
or
$ ./cleos wallet lock -n second-wallet

Outputs

Locked: 'default'
or
Locked: 'second-wallet'
Suggest Edits

lock_all

Locks all unlocked wallets.

 

Positionals

None

Options

None

Usage

$ ./cleos wallet lock_all

Outputs

Locked All Wallets
Suggest Edits

unlock

Unlocks a wallet.

 

Positionals

None

Options

  • -n, --name TEXT - The name of the wallet to unlock.
  • --password TEXT - The password returned by wallet create.

Usage

To unlock a wallet, specify the password provided when it was created.

$ ./cleos wallet unlock -n second-wallet --password PW5Ji6JUrLjhKAVn68nmacLxwhvtqUAV18J7iycZppsPKeoGGgBEw

Outputs

Unlocked: 'second-wallet'
Suggest Edits

import

Imports private key into wallet.

 

Positionals

None

Options

  • -n, --name TEXT - The name of the wallet to import key into.
  • --private-key TEXT - Private key in WIF format to import.

Usage

$ ./cleos wallet import 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3

Outputs

imported private key for: EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV
Suggest Edits

list

Lists opened wallets, * = unlocked.

 

Positionals

None

Options

None

Usage

$ ./cleos wallet list

Outputs

Wallets:
[
  "default *",
  "second-wallet *"
]

or when there are no wallets
Wallets:
[
]
Suggest Edits

keys

List of public keys from all unlocked wallets. These are the keys that could be used to sign transactions.

 

Positionals

None.

Options

None.

Usage

$ ./cleos wallet keys

Outputs

[[
    "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV",
    "5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"
  ]
]
Suggest Edits

create_key

Creates a key pair within the wallet so that you don't need to manually import it like you would with cleos create key. By default this will create a key with the type "favored" by the wallet, which is a K1 key. But this command also lets you create a key in R1 format.

 

Positionals

key_type TEXT - "K1" or "R1" Key type to create

Options

-n,--name TEXT=default The name of the wallet to create key into

Usage

$ cleos wallet create_key K1

Outputs

Created new private key with a public key of: "EOS67xHKzQArkWZN6rKLCq7NLvaj8kurwxzRxoTVz6cgDJkiWdGug"
Suggest Edits

private_keys

It is possible to query for the public and private key pairs of an individual wallet. The wallet must already be unlocked and you must give the password again.

 

Positionals

None

Options

-n,--name TEXT - The name of the wallet to list keys from, otherwise - default
--password TEXT - The password returned by wallet create

Usage

cleos wallet private_keys

Outputs

Positionals

  • transaction TEXT - The JSON string or filename defining the transaction to sign (required)

Options

  • -k,--private-key TEXT - The private key that will be used to sign the transaction
    *-c,--chain-id TEXT - The chain id that will be used to sign the transaction
  • -p,--push-transaction - Push transaction after signing

Description

Pushes arbitrary transactions to the blockchain.

Commands

push action Push a transaction with a single action
push transaction Push an arbitrary JSON transaction
push transactions Push an array of arbitrary JSON transactions

Suggest Edits

push action

Push a transaction with a single action

 

Positionals

  • contract Type: Text - The account providing the contract to execute
  • action Type: Text - The action to execute on the contract
  • data Type: Text - The arguments to the contract

Output

Options

  • -h,--help - Print this help message and exit
  • -x,--expiration - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign - Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - don't broadcast transaction to the network (just print to stdout)
  • -p,--permission Type: Text - An account and permission level to authorize, as in 'account@permission'

Example

cleos push action eosio.token transfer '{"from":"bob","to":"alice","quantity":"20.0000 SYS","memo":"some SYS for you alice!"}' -p bob@active
Suggest Edits

push transaction

Push an arbitrary JSON transaction

 

Positionals

  • transaction (text) The JSON of the transaction to push, or the name of a JSON file containing the transaction

Options

This command has no options

Example

cleos push transaction {}
Suggest Edits

push transactions

 

Positionals

Pushes an array of arbitrary JSON transactions.

Options

This command has no options

Examples

 

Subcommands

Suggest Edits

multisig propose

 

Positionals

proposal_name TEXT - Proposal name (string)
requested_permissions TEXT - The JSON string or filename defining requested permissions
trx_permissions TEXT - The JSON string or filename defining transaction permissions
contract TEXT - Contract to wich deferred transaction should be delivered
action TEXT - Action of deferred transaction
data TEXT - The JSON string or filename defining the action to propose
proposer TEXT - Account proposing the transaction
proposal_expiration UINT - Proposal expiration interval in hours

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Suggest Edits

multisig review

 

Positionals

  • proposer TEXT - Proposer name (string)
  • proposal_name TEXT - Proposal name (string)

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Suggest Edits

multisig approve

 

Positionals

  • proposer TEXT - Proposer name (string)
  • proposal_name TEXT - Proposal name (string)
  • permissions TEXT - The JSON string of filename defining approving permissions

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Suggest Edits

multisig unapprove

 

Positionals

  • proposer TEXT - Proposer name (string)
  • proposal_name TEXT - Proposal name (string)
  • permissions TEXT - The JSON string of filename defining approving permissions

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Suggest Edits

multisig cancel

 

Positionals

  • proposer TEXT - Proposer name (string)
  • proposal_name TEXT - Proposal name (string)
  • canceler TEXT - Canceler name (string)

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Suggest Edits

multisig exec

 

Positionals

  • proposer TEXT - Proposer name (string)
  • proposal_name TEXT - Proposal name (string)
  • executer TEXT - Account paying for execution (string)

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

System commands can only be used on installations that have the system contracts loaded. Please see here for more details.

Suggest Edits

system newaccount

Create an account, buy ram, stake for bandwidth for the account

 

Positionals

  • creator TEXT - The name of the account creating the new account
  • name TEXT - The name of the new account
  • OwnerKey TEXT - The owner public key for the new account
  • ActiveKey TEXT - The active public key for the new account

Options

  • -h,--help Print this help message and exit
  • --stake-net TEXT - The amount of EOS delegated for net bandwidth
  • --stake-cpu TEXT - The amount of EOS delegated for CPU bandwidth
  • --buy-ram-kbytes UINT - The amount of RAM bytes to purchase for the new account in kibibytes (KiB), default is 8 KiB
  • --buy-ram TEXT - The amount of RAM bytes to purchase for the new account in EOS
  • --transfer - Transfer voting power and right to unstake EOS to receiver
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

Prerequisites

  • An existing account
  • A username that follows naming conventions
  • two keypairs (for maximum security)
cleos system newaccount eosio someusername EOS123456.. EOS123456...
Suggest Edits

system regproducer

Register a new producer

 

Positionals

  • account TEXT - The account to register as a producer
  • producer_key TEXT - The producer's public key
  • url TEXT - URL where info about producer can be found
  • location UINT - Relative location for purpose of nearest neighbor scheduling

Options

  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

cleos system regproducer accountname1 EOS1234534... http://producer.site Antarctica
Suggest Edits

system unregprod

Unregister an existing producer

 

Positionals

account TEXT - The account to unregister as a producer

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system unregprod accountname1
Suggest Edits

system voteproducer

Vote for a producer

 

Subcommands

voteproducer proxy - Vote your stake through a proxy
voteproducer prods - Vote for one or more producers
voteproducer approve -Add one producer to list of voted producers
voteproducer unapprove - Remove one producer from list of voted producers

Suggest Edits

system voteproducer proxy

Vote your stake through a proxy

 

Positionals

  • voter TEXT - The voting account
  • proxy TEXT - The proxy account

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - Force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT - Set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - Set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - Set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

cleos system voteproducer proxy accountname1 proxyaccount
Suggest Edits

system voteproducer prods

Vote for one or more producers

 

Positionals

  • voter TEXT - The voting account
  • producers TEXT ... - The account(s) to vote for. All options from this position and following will be treated as the producer list.

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system voteproducer prods someproducr1 someproducr2 someproducr3 someproducr4
Suggest Edits

system voteproducer approve

Add one producer to list of voted producers

 

Positionals

  • voter TEXT - The voting account
  • producer TEXT - The account to vote for

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

cleo system voteproducer approve someproducr1
Suggest Edits

system voteproducer unapprove

Remove one producer from list of voted producers

 

Positionals

  • voter TEXT - The voting account
  • producer TEXT - The account to remove from voted producers

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system voteproducer unapprove someproducr1
Suggest Edits

system listproducers

Returns a list of producers

 

Returns a list of producers in text or json format including

  • Producer account name
  • Producer key
  • Producer URL
  • Producer's scaled votes

Positionals

None

Options

-h,--help - Print this help message and exit
-j,--json - Output in JSON format
-l,--limit UINT - The maximum number of rows to return
-L,--lower TEXT - Lower bound value of key, defaults to first

Usage

cleos system listproducers
Suggest Edits

system delegatebw

Delegate bandwidth

 

Positionals

  • from TEXT - The account delegating bandwidth
  • receiver TEXT - The account to delegate bandwidth from
  • stake_net_quantity TEXT - The amount of EOS to delegate for network bandwidth
  • stake_cpu_quantity TEXT - The amount of EOS to delegate for CPU bandwidth

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system delegatebw accountname1 accountname2 "1 SYS" "1 SYS"
Suggest Edits

system undelegatebw

Undelegate bandwidth

 

Positionals

  • from TEXT - The account undelegating bandwidth
  • receiver TEXT - The account to undelegate bandwidth from
  • unstake_net_quantity TEXT - The amount of EOS to undelegate for network bandwidth
  • unstake_cpu_quantity TEXT - The amount of EOS to undelegate for CPU bandwidth

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Examples

Usage

cleos system undelegatebw accountname1 accountname2 "0.5 SYS" "0.5 SYS"
Suggest Edits

system listbw

List bandwidth delegated from an account

 

Returns list of delegated bandwidth from an account in either text or json.

Positionals

  • account TEXT - The account delegated bandwidth

Options

-h,--help - Print this help message and exit
-j,--json - Output in JSON format

Usage

cleos system listbw someaccount1
Suggest Edits

system bidname

place a bid on "premium" usernames (account names less than 12 characters)

 

Positionals

  • bidder TEXT - The bidding account (required)
  • newname TEXT - The bidding name (required)
  • bid TEXT - The amount of CORE SYMBOL to bid (required)

Options

  • -h,--help - Print this help message and exit
  • -x,--expiration - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign - Specify if unlocked wallet keys should be used to sign transaction
  • -j,--json - print result as json
  • -d,--dont-broadcast - don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT - set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission'
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system bidname accountname1 bob "10 SYS"
Suggest Edits

system buyram

Buy RAM

 

Positionals

  • payer TEXT - Theaccount paying for RAM
  • receiver TEXT - The account receiving bought RAM
  • tokens TEXT - The amount of EOS to pay for RAM

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

#buy ram for yourself
cleos system buyram someaccount1 someaccount1 "10 EOS"

#buy ram for someone else
cleos system buyram someaccount1 someaccount2 "1 EOS"
Suggest Edits

system sellram

Sell RAM

 

Positionals

  • account TEXT - The account to receive EOS for sold RAM
  • bytes UINT - Number of RAM bytes to sell

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

#sell 1000 bytes
cleos system sellram someaccount1 1000 
Suggest Edits

system claimrewards

Claim producer rewards

 

Positionals

  • owner TEXT - The account to claim rewards for

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system claimrewards smeproducr22
Suggest Edits

system regproxy

Register an account as a proxy (for voting)

 

Positionals

proxy TEXT - The proxy account to register

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system regproxy someaccount1
Suggest Edits

system unregproxy

Unregister an account as a proxy (for voting)

 

Positionals

  • proxy TEXT - The proxy account to unregister

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system unregproxy someaccount1
Suggest Edits

system canceldelay

Cancel a delayed transaction

 

Positionals

  • canceling_account TEXT - Account from authorization on the original delayed transaction
  • canceling_permission TEXT - Permission from authorization on the original delayed transaction
  • trx_id TEXT - The transaction id of the original delayed transaction

Options

  • -h,--help Print this help message and exit
  • -x,--expiration TEXT - set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign Specify if unlocked wallet keys should be used to sign transaction
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission' (defaults to 'account@active')
  • --max-cpu-usage-ms UINT - set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system canceldelay someaccount1 active s0MEtxID...
Suggest Edits

bidnameinfo

Returns data about a particular name and it's bidding status

 

Positionals

  • name TEXT - The name to lookup

Options

  • -h,--help - Print this help message and exit
  • -x,--expiration - Set the time in seconds before a transaction expires, defaults to 30s
  • -f,--force-unique - Force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  • -s,--skip-sign - Specify if unlocked wallet keys should be used to sign transaction
  • -j,--json - Print result as json
  • -d,--dont-broadcast - Don't broadcast transaction to the network (just print to stdout)
  • -r,--ref-block TEXT - Set the reference block num or block id used for TAPOS (Transaction as Proof-of-Stake)
  • -p,--permission TEXT - An account and permission level to authorize, as in 'account@permission'
  • --max-cpu-usage-ms UINT - Set an upper limit on the milliseconds of cpu usage budget, for the execution of the transaction (defaults to 0 which means no limit)
  • --max-net-usage UINT - Set an upper limit on the net usage budget, in bytes, for the transaction (defaults to 0 which means no limit)

Usage

cleos system bidnameinfo bob