System

Description The subcommands can be used to send cyber.system contract action to the blockchain.

Subcommands

System Newaccount

Description

Create a new account on the blockchain with initial resources.

Positional Parameters

  • (string) creator— The name of the account creating the new account (required).

  • (string) name— The name of the new account (required).

  • (string) OwnerKey— The owner public key or permission level for the new account (required).

  • (string) ActiveKey— The active public key or permission level for the new account.

Options

  • --stake TEXT — The amount of tokens delegated for the account

  • --transfer— Transfer voting power and right to unstake tokens to receiver.

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'creator@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Examples

'alice' creates 'bob' and transfers him 50 tokens irrevocably.

System Regproducer

Description

Register a new producer.

Positional Parameters

  • (string) account — The account to register as a producer (required).

  • (string) producer_key — The producer's public key (required).

Options

  • --min-own-stake— A min value the producer guarantees to stake.

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Unregprod

Description

Unregister an existing producer.

Positional Parameters

  • (string) account — An account to unregister from producers (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Voteproducer Proxy

Description

This subcommand can be used to vote your stake through a proxy.

Positional Parameters

  • (string) voter — The voting account (required).

  • (string) proxy — The proxy accoun (required).

  • (string) quantity — An asset quantity that the voter delegates to the proxy to vote for the producer (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'voter@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Voteproducer Prods

Description

This subcommand can be used to vote for a producer.

Positional Parameters

  • (string) voter— A voting account (required).

  • (string) producer— An account to vote for (required).

  • (string) quantity— An asset quantity that the voter votes for the producer (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'voter@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Listproducers

Description

This subcommand can be used to obtain a list of producers.

Positional Parameters

No parameters required for this subcommand.

Options

  • --json, -j— 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.

Command

System Delegatebw

Description

This subcommand can be used to delegate bandwidth.

Positional Parameters

  • (string) from — The account to delegate bandwidth from (required).

  • (string) receiver — The account to receive the delegated bandwidth (required).

  • (string) stake_quantity — The amount of tokens to stake (required).

Options

  • --transfer— Transfer voting power and right to unstake tokens to receiver.

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'from@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Examples

'alice' delegates 10 tokens to 'bob'

System Undelegatebw

Description

This subcommand can be used to undelegate bandwidth.

Positional Parameters

  • (string) from — The account undelegating bandwidth (required).

  • (string) receiver — The account to undelegate bandwidth from (required).

  • (string) unstake_quantity — The amount of tokens to undelegate (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'from@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Claimbw

Description

This subcommand can be used to claim undelegated bandwidth. This operation can only be performed 30 days after completion of undelegatebw (see Sake Usage Guide).

Positional Parameters

  • (string) from — An account claims undelegated stake (required).

  • (string) receiver — An account returning stake (required).

  • (string) token_code — An asset symbol claimed (required).

Options

No options required for this subcommand.

Command

Examples

'alice' credits the amount of staked tokens returned from 'bob' to a stake.

System Listbw

Description

This subcommand can be used to list delegated bandwidth.

Positional Parameters

  • (string) account — The account delegated bandwidth (required).

Options

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

Command

Examples

'alice' receives a list of users to whom she delegated bandwidth (staked tokens).

System Bidname

Description

Name bidding subcommand.

Positional Parameters

  • (string) bidder — The bidding account (required).

  • (string) newname — The name which the bid is done for (required).

  • (string) bid — The amount of system tokens to bid (it is asset structure) (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'bidder@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Examples

'accountname1' bids 100 tokens to buy 'alice' name at an auction.

System Bidnameinfo

Description

This subcommand can be used to get bidname info.

Positional Parameters

  • (string) newname — The name to lookup to lookup (required).

Options

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

Command

Examples

System Setproxylvl

Description

This subcommand can be used to set an account proxy level.

Positional Parameters

  • (string) account — An account whose proxy level will be set (required).

  • (uint) level — A proxy level to set (required).

Options

  • --symbol — A symbol of an asset used in the system.

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

System Regproxy

Description

This subcommand can be used to register an account as a proxy (for voting).

Positional Parameters

  • (string) proxy — A proxy account to register (required).

Options

  • --symbol TEXT — A token symbol used by producers.

  • --level UINT — A proxy level (must be greater than 0, but less than MAX_LEVEL. Default MAX_LEVEL value is 1 ).

  • --fee UINT — A part of the fee proxies get for a block producing (takes an ineteger value from 0 to 10000 inclusive (10000 means 100,00 %).

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'proxy@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Examples

'alice' registers as a proxy having level=1 and fee=50(%).

System Unregproxy

Description

Unregister an account as a proxy (for voting).

Positional Parameters

  • (string) proxy — The proxy account to unregister (required).

Options

  • --symbol TEXT — A token symbol used by producers.

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'proxy@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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Examples

'alice' stops registering as a proxy account.

System Stake

Description

This subcommand can be used to stake assets to gain resources.

Positional Parameters

  • (string) account — An account who stakes assets (required).

  • (string) quantity — Assets quantity to stake (required).

Options

  • --beneficiary TEXT — An account gaining resources.

Command

Examples

System Canceldelay

Description

This subcommand can be used to cancel a delayed transaction.

Positional Parameters

  • (string) canceling_account — Account from authorization on the original delayed transaction (required).

  • (string) canceling_permission — Permission from authorization on the original delayed transaction (required).

  • (string) trx_id — The transaction id of the original delayed transaction (required).

Options

  • -x, --expiration TEXT — Set the time (in seconds) before a transaction expires, defaults to 30 s.

  • -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 — Do not broadcast transaction to the network (just print to stdout).

  • --return-packed — Used in conjunction with --dont-broadcast to get the packed transaction.

  • -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 'canceling_account@canceling_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).

  • --max-ram-usage UINT — Set an upper limit on the ram usage budget (in bytes) for the transaction (defaults to 0 which means no limit).

  • --max-storage-usage — Set an upper limit on the storage usage budget, (in bytes) for the transaction (defaults to 0 which means no limit).

  • --delay-sec UINT — Set the delay_sec seconds, defaults to 0 s.

  • --bandwidth-provider TEXT — Set an account which provide own bandwidth for transaction.

  • --dont-declare-names — Do not add declarenames action for resolved account names.

Command

Last updated