Contents

• Info and help

  • ​info​

  • ​about​

  • ​help​

• Objects

  • ​get_object​

• Blocks and transactions

  • ​get_block​

  • ​get_block_virtual_ops​

  • ​get_transaction​

  • ​get_transaction_by_id​

  • ​get_transaction_id​

  • ​serialize_transaction​

  • ​sign_transaction​

• Accounts

  • ​get_account_count​

  • ​list_my_accounts​

  • ​list_accounts​

  • ​get_account_history​

  • ​get_relative_account_history​

  • ​get_account​

  • ​get_account_id​

  • ​get_account_addresses​

  • ​get_account_by_address​

  • ​get_evm_addresses​

  • ​get_account_address_by_label​

  • ​register_account​

  • ​register_account_with_api​

  • ​create_account_with_brain_key​

  • ​generate_account_address​

  • ​whitelist_account​

  • ​update_account​

  • ​get_account_address_history​

  • ​get_account_history_operations​

• Keys

  • ​import_key​

  • ​create_eddsa_keypair​

  • ​get_private_key​

  • ​is_public_key_registered​

  • ​suggest_brain_key​

  • ​normalize_brain_key​

  • ​derive_keys_from_brain_key​

  • ​dump_private_keys​

• Password & lock

  • ​is_new​

  • ​is_locked​

  • ​lock​

  • ​unlock​

  • ​set_password​

  • ​exit​

• Wallet file

  • ​load_wallet_file​

  • ​save_wallet_file​

  • ​set_wallet_filename​

  • ​get_wallet_filename​

• Balances

  • ​import_balance​

  • ​list_account_balances​

  • ​list_id_balances​

  • ​get_vesting_balances​

  • ​withdraw_vesting​

  • ​transfer​

  • ​list_frozen_balances​

  • ​get_committee_frozen_balance​

  • ​freeze_balance​

  • ​request_unfreeze_balance​

  • ​committee_freeze_balance​

  • ​committee_withdraw_balance​

  • ​transfer_to_address​

  • ​create_vesting_linear_policy​

  • ​create_vesting_cdd_policy​

• Assets

  • ​list_assets​

  • ​create_asset​

  • ​update_asset​

  • ​update_bitasset​

  • ​update_asset_feed_producers​

  • ​publish_asset_feed​

  • ​issue_asset​

  • ​get_asset​

  • ​get_asset_id​

  • ​get_bitasset_data​

  • ​fund_asset_fee_pool​

  • ​reserve_asset​

• Committee members

  • ​create_committee_member​

  • ​update_committee_member​

  • ​create_activate_committee_member_proposal​

  • ​create_deactivate_committee_member_proposal​

  • ​list_committee_members​

  • ​get_committee_member​

• Globals

  • ​get_chain_properties​

  • ​get_global_properties​

  • ​get_dynamic_global_properties​

  • ​propose_parameter_change​

  • ​propose_fee_change​

  • ​approve_proposal​

  • ​get_current_incentives_info​

  • ​get_incentives_info​

• Contracts

  • ​get_contract_object​

  • ​get_contract​

  • ​get_contract_result​

  • ​get_contract_history​

  • ​get_relative_contract_history​

  • ​create_contract​

  • ​call_contract​

  • ​call_contract_no_changing_state​

• Contract pool

  • ​get_contract_pool_balance​

  • ​get_contract_pool_whitelist​

  • ​contract_fund_fee_pool​

  • ​whitelist_contract_pool​

• Network

  • ​network_add_nodes​

  • ​network_get_connected_peers​

• Sidechain

  • ​get_account_deposits​

  • ​get_account_withdrawals​

  • ​get_account_stake_objects​

• Sidechain-Ethereum

  • ​get_eth_address​

  • ​create_eth_address​

  • ​withdraw_eth​

  • ​propose_eth_update_contract_address​

• Sidechain-ERC20

  • ​get_erc20_token​

  • ​check_erc20_token​

  • ​get_erc20_account_deposits​

  • ​get_erc20_account_withdrawals​

  • ​register_erc20_token​

  • ​withdraw_erc20_token​

  • ​propose_register_asset_in_sidechain​

  • ​transfer_to_eth_erc20​

• Sidechain-Bitcoin

  • ​create_btc_address​

  • ​get_btc_address​

  • ​get_btc_deposit_script​

  • ​withdraw_btc​

  • ​create_btc_stake_address​

  • ​get_btc_stake_address​

• Transaction Builder

  • ​begin_builder_transaction​

  • ​add_operation_to_builder_transaction​

  • ​replace_operation_in_builder_transaction​

  • ​set_fees_on_builder_transaction​

  • ​preview_builder_transaction​

  • ​sign_builder_transaction​

  • ​propose_builder_transaction​

  • ​propose_builder_transaction2​

  • ​remove_builder_transaction​

  • ​get_prototype_operation​

• Verifiable Credentials

  • ​add_verifiable_credential​

  • ​get_verifiable_credential_keywords​

  • ​get_verifiable_credential​

  • ​get_all_verifiable_credentials​

  • ​get_did_object_key​

  • ​get_verifiable_presentation​

  • ​validate_verifiable_presentation​

  • ​validate_verifiable_credential​

Info and help

info

Returns info about current chain and active committee members.

info

about

Returns info such as client version, git version of graphene/fc, version of boost, openssl.

about

help

Returns a list of all commands supported by the wallet API or detailed help on a single command.

This lists each command, along with its arguments and return types.

help
help get_object

Objects

get_object object_id

Returns the blockchain object corresponding to the given id.

get_object 1.2.0

Blocks and transactions

get_block block_num

Retrieve a full, signed block.

get_block 10

get_block_virtual_ops block_num

Get virtual ops from the block.

get_block_virtual_ops 10

get_transaction_id tx

This method is used to convert a JSON transaction to its transaction ID.

get_transaction_id JSON_transaction

get_transaction block_num tx_index

This method is to get transaction by index in block

get_transaction_by_id tx_id

This method is to get transaction by index in block

serialize_transaction tx

Converts a signed_transaction in JSON form to its binary representation.

serialize_transaction JSON_transaction

sign_transaction tx broadcast

Signs a transaction. Given a fully-formed transaction that is only lacking signatures, this signs the transaction with the necessary keys and std::optionally broadcasts the transaction.

sign_transaction JSON_transaction true

Accounts

get_account_count

Returns the number of accounts registered on the blockchain.

get_account_count

list_my_accounts

Lists all accounts controlled by this wallet. This returns a list of the full account objects for all accounts whose private keys we possess.

list_my_accounts

list_accounts lowerbound limit

Lists all accounts registered in the blockchain. This returns a list of all account names and their account ids, sorted by account name.

Use the lowerbound and limit parameters to page through the list. To retrieve all accounts, start by setting lowerbound to the empty string "", and then each iteration, pass the last account name returned as the lowerbound for the next list_accounts call.

Returns a list of accounts mapping account names to account ids.

list_accounts nathan 10

get_account_history account limit

Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account.

get_account_history nathan 10

get_relative_account_history account stop limit start

Returns the relative operations on the named account from start number.

get_relative_account_history nathan 0 10 20

get_account account

Returns information about the given account.

get_account nathan
get_account 1.2.26

get_account_id account

Lookup the id of a named account.

get_account_id 1.2.26

get_account_addresses account from limit

Get addresses owned by account in specified ids interval

get_account_addresses 1.2.26 0 10
get_account_addresses nathan 0 10

get_account_by_address address

Get owner of specified address.

Returns account id of owner.

get_account_by_address 8815c69de5d32d3061e52ca9386446332225b43d

get_evm_addresses account

Get EVM addresses, if exist, for the given account id

get_evm_addresses nathan
get_evm_addresses 1.2.26

get_account_address_by_label account label

Get account address by owner account and label

get_account_address_by_label 1.2.26 primary

register_account name active echorand-key registrar-account evm-address broadcast

Registers a third party's account on the blockckain. This function is used to register an account for which you do not own the private keys. When acting as a registrar, an end user will generate their own private keys and send you the public keys. The registrar will use this function to register the account on behalf of the end user.

register_account new_acc ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu nathan E8fd4Db0C38d48493AD167A268683fAb7230a88A true

register_account_with_api name active_key echorand_key evm_address

Request connected node to register account with provided name and keys.

register_account_with_api nathan ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu 517CF26a16127c4A58072FB7C24D1140F1b63A67

create_account_with_brain_key brain_key account_name registrar_account evm_address broadcast save_wallet

Creates a new account and registers it on the blockchain.

create_account_with_brain_key "brain_key" new_acc nathan 517CF26a16127c4A58072FB7C24D1140F1b63A67 true true

generate_account_address owner_account label broadcast

Creates a transaction to generate account address.

generate_account_address nathan label true

whitelist_account authorizing_account account_to_list new_listing_status broadcast

Whitelist and blacklist accounts, primarily for transacting in whitelisted assets.

Accounts can freely specify opinions about other accounts, in the form of either whitelisting or blacklisting them. This information is used in chain validation only to determine whether an account is authorized to transact in an asset type which enforces a whitelist, but third parties can use this information for other uses as well, as long as it does not conflict with the use of whitelisted assets.

An asset which enforces a whitelist specifies a list of accounts to maintain its whitelist, and a list of accounts to maintain its blacklist. In order for a given account A to hold and transact in a whitelisted asset S, A must be whitelisted by at least one of S's whitelist_authorities and blacklisted by none of S's blacklist_authorities. If A receives a balance of S, and is later removed from the whitelist(s) which allowed it to hold S, or added to any blacklist S specifies as authoritative, A's balance of S will be frozen until A's authorization is reinstated.

whitelist_account nathan acc 0 true

update_account account new_options broadcast new_active new_echorand_key

Update an existing account. It can be used to update the authorities, or adjust the options. Returns the signed transaction updating the asset

update_account nathan {"delegating_account": "1.2.10", "delegate_share": "3000"} true null null

get_account_address_history address start stop limit

Get all transfers about this address.

Parameters

get_account_address_history f149bd2883b1179965bd6706092573be4d68fec8 1.6.67 1.6.0 100

get_account_history_operations account operation_id start stop limit

Get operations relevant to the specificed account.

Parameters

get_account_history_operations 1.2.12 1 1.6.10 1.6.0 100

Keys

import_key account_name_or_id priv_key

Imports the private key for an existing account. The private key must match either an owner key or an active key for the named account.

Returns true if the key was imported.

import_key nathan private_key

create_eddsa_keypair

Create new EdDSA keypair encoded in base58 for public key and WIF for private key.

create_eddsa_keypair

get_private_key pubkey

Get the WIF private key corresponding to a public key. The private key must already be in the wallet.

get_private_key ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu

is_public_key_registered public_key

Determine whether a textual representation of a public key (in Base-58 format) is currently linked to any account on the blockchain

Returns true whether a public key is known.

is_public_key_registered ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu

suggest_brain_key

Suggests a safe brain key to use for creating your account. create_account_with_brain_key requires you to specify a 'brain key', a long passphrase that provides enough entropy to generate cyrptographic keys. This function will suggest a suitably random string that should be easy to write down (and, with effort, memorize).

suggest_brain_key

normalize_brain_key brain-key

Transforms a brain key to reduce the chance of errors when re-entering the key from memory.

This takes a user-supplied brain key and normalizes it into the form used for generating private keys. In particular, this upper-cases all ASCII characters and collapses multiple spaces into one.

Returns the brain key in its normalized form

normalize_brain_key brain_key

derive_keys_from_brain_key brain_key number_of_desired_keys

Derive any number of possible owner keys from a given brain key.

Returns a list of keys that are deterministically derived from the brainkey

NOTE: These keys may or may not match with the owner keys of any account. This function is merely intended to assist with account or key recovery.

derive_keys_from_brain_key brain_key 1

dump_private_keys

Dumps all private keys owned by the wallet. The keys are printed in WIF format. You can import these keys into another wallet using import_key. Returns a map containing the private keys, indexed by their public key

dump_private_keys

Password & lock

is_new

Checks whether the wallet has just been created and has not yet had a password set. Calling set_password will transition the wallet to the locked state.

Returns true if the wallet is new.

is_new

is_locked

Checks whether the wallet is locked (is unable to use its private keys). This state can be changed by calling lock or unlock.

Returns true if the wallet in locked.

is_locked

lock

Locks the wallet immediately.

lock

unlock password

Unlocks the wallet. The wallet remain unlocked until the lock is called or the program exits.

unlock some_password

set_password password

Sets a new password on the wallet. The wallet must be either 'new' or 'unlocked' to execute this command.

set_password your_password

exit

Exit from wallet

exit

Wallet file

load_wallet_file wallet_filename

Loads a specified Graphene wallet. The current wallet is closed before the new wallet is loaded. This does not change the filename that will be used for future wallet writes, so this may cause you to overwrite your original wallet unless you also call set_wallet_filename Returns true if the specified wallet is loaded

load_wallet_file wallet.json

save_wallet_file wallet_filename

Saves the current wallet to the given filename. This does not change the wallet filename that will be used for future writes, so think of this function as 'Save a Copy As...' instead of 'Save As...'. Use set_wallet_filename to make the filename persist.

save_wallet_file wallet.json

set_wallet_filename wallet_filename

Sets the wallet filename used for future writes. This does not trigger a save, it only changes the default filename that will be used the next time a save is triggered.

set_wallet_filename wallet.json

get_wallet_filename

This is the filename that will be used when automatically saving the wallet.

Returns the current wallet filename.

get_wallet_filename

Balances

import_balance account broadcast private_keys

This call will construct transaction(s) that will claim all balances controled by wif_keys and deposit them into the given account. wif_key should be input interactively

import_balance nathan true [ private_keys ]

list_account_balances account

List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account. The returned list will only contain assets for which the account has a nonzero balance. Returns a list of the given account's balances

list_account_balances nathan
list_account_balances 1.2.26

list_id_balances id

List the balances of an account or a contract.

list_id_balances 1.11.0
list_id_balances 1.2.26

list_frozen_balances account

List frozen balances of an account.

list_frozen_balances nathan
list_frozen_balances 1.2.26

get_committee_frozen_balance owner_account

List frozen balances of an committee member account.

get_committee_frozen_balance nathan
get_committee_frozen_balance 1.2.26

freeze_balance account amount asset duration broadcast

Freezes part of your balance for the specified amount of time.

freeze_balance nathan 1 ECHO 90 true

request_unfreeze_balance account objects_to_unfreeze broadcast

Request to unfreeze your frozen balance's.

request_unfreeze_balance nathan ["1.9.1", "1.9.2"] true

committee_freeze_balance owner_account amount broadcast

Freezes balance required for committee members to operate.

committee_freeze_balance nathan 10 true

committee_withdraw_balance owner_account amount broadcast

Withdraws part of frozen committee members balance.

committee_withdraw_balance nathan 1 true

transfer_to_address from address amount asset_symbol broadcast

Transfer an amount from one account to address.

transfer_to_address 1.2.0 f149bd2883b1179965bd6706092573be4d68fec8 10 ECHO true

create_vesting_linear_policy creator owner amount asset_symbol begin_timestamp vesting_cliff_seconds vesting_duration_seconds broadcast

Create a vesting balance with linear policy.

create_vesting_linear_policy nathan nathan 10 ECHO "2093-12-11T10:26:00" 10 10 true

create_vesting_cdd_policy creator owner amount asset_symbol start_claim vesting_second broadcast

Create a vesting balance with cdd policy.

create_vesting_cdd_policy nathan nathan 10 ECHO "2093-12-11T10:26:00" 10 true

get_vesting_balances account

Get information about a vesting balance object.

get_vesting_balances nathan
get_vesting_balances 1.2.26

withdraw_vesting account amount asset_symbol broadcast

Withdraw a vesting balance.

withdraw_vesting nathan 10 ECHO true

transfer from to amount asset_symbol broadcast

Transfer an amount from one account to another. Returns the signed transaction transferring funds

transfer 1.2.0 1.2.1 10 ECHO true
transfer nathan alice 10 EBTC true

Assets

list_assets lowerbound limit

Lists all assets registered on the blockchain. To list all assets, pass the empty string "" for the lowerbound to start at the beginning of the list, and iterate as necessary.

Returns the list of asset objects, ordered by symbol

list_assets ECHO 10
list_assets "" 10

create_asset issuer symbol precision asset_opts bitasset_opts broadcast

Creates a new user-issued or market-issued asset. Many options can be changed later using update_asset. Right now this function is difficult to use because you must provide raw JSON data structures for the options objects, and those include prices and asset ids.

Returns the signed transaction creating a new asset

create_asset nathan myasset 10 {asset_opts} null true

update_asset symbol new_issuer new_options broadcast

Update the core options on an asset. There are a number of options which all assets in the network use. These options are enumerated in the asset_object::asset_options struct. This command is used to update these options for an existing asset. This operation cannot be used to update BitAsset-specific options. For these options, update_bitasset instead.

Returns the signed transaction updating the asset

update_asset myasset nathan {asset_opts} true

update_bitasset symbol new_options broadcast

Update the options specific to a BitAsset. BitAssets have some options which are not relevant to other asset types. This operation is used to update those options an an existing BitAsset.

Returns the signed transaction updating the bitasset

update_bitasset myasset {bitasset_opts} true

update_asset_feed_producers symbol new_feed_producers broadcast

Update the set of feed-producing accounts for a BitAsset. BitAssets have price feeds selected by taking the median values of recommendations from a set of feed producers. This command is used to specify which accounts may produce feeds for a given BitAsset.

Returns the signed transaction updating the bitasset's feed producers

update_asset_feed_producers UIA [nathan, foobar] true

publish_asset_feed publishing_account symbol core_exchange_rate broadcast

Publishes a price feed for the named asset. Price feed providers use this command to publish their price feeds for market-issued assets. A price feed is used to tune the market for a particular market-issued asset. For each value in the feed, the median across all committee_member feeds for that asset is calculated and the market for the asset is configured with the median of that value. The feed object in this command contains three prices: a call price limit, a short price limit, and a settlement price. The call limit price is structured as (collateral asset) / (debt asset) and the short limit price is structured as (asset for sale) / (collateral asset). Note that the asset IDs are opposite to eachother, so if we're publishing a feed for USD, the call limit price will be ECHO/USD and the short limit price will be USD/ECHO. The settlement price may be flipped either direction, as long as it is a ratio between the market-issued asset and its collateral.

Returns the signed transaction updating the price feed for the given asset

publish_asset_fee nathan myasset {price} true

issue_asset to_account amount symbol broadcast

Issue new shares of an asset.

Returns the signed transaction issuing the new shares

issue_asset nathan 10 myasset true

get_asset asset_name_or_id

Returns information about the given asset.

get_asset ECHO

get_asset_id asset_name

Lookup the id of a named asset.

get_asset_id ECHO

get_bitasset_data asset_name_or_id

Returns the BitAsset-specific data for a given asset. Market-issued assets's behavior are determined both by their "BitAsset Data" and their basic asset data, as returned by get_asset.

get_bitasset_data ECHO

fund_asset_fee_pool from symbol amount broadcast

Pay into the fee pool for the given asset. User-issued assets can fc::optionally have a pool of the core asset which is automatically used to pay transaction fees for any transaction using that asset (using the asset's core exchange rate). This command allows anyone to deposit the core asset into this fee pool.

Returns the signed transaction funding the fee pool

fund_asset_fee_pool nathan myasset 10 true

reserve_asset from amount symbol broadcast

Burns the given user-issued asset. This command burns the user-issued asset to reduce the amount in circulation. you cannot burn market-issued assets.

Returns the signed transaction burning the asset

reserve_asset nathan 10 ECHO true

Committee members

create_committee_member owner_account url amount eth_address btc_public_key broadcast

Creates a committee_member object owned by the given account. An account can have at most one committee_member object.

Returns the signed transaction registering a committee_member

create_committee_member nathan example.com 1000 E8fd4Db0C38d48493AD167A268683fAb7230a88A 02c16e97132e72738c9c0163656348cd1be03521de17efeb07e496e742ac84512e true

update_committee_member owner_account committee_member new_url new_eth_address new_btc_public_key broadcast

Updates a committee_member object owned by the given account.

Returns the signed transaction updating a committee_member.

update_committee_member nathan new_url E8fd4Db0C38d48493AD167A268683fAb7230a88A 02c16e97132e72738c9c0163656348cd1be03521de17efeb07e496e742ac84512e true

create_activate_committee_member_proposal sender committee_to_activate expiration_time

Creates a proposal to activate given commitee. An account can have at most one committee_member object.

Returns the signed transaction registering a committee_member

create_activate_committee_member_proposal nathan 1.4.0 1970-01-01T00:00:00

create_deactivate_committee_member_proposal sender committee_to_activate expiration_time)

Creates a proposal to deactivate given commitee. An account can have at most one committee_member object.

Returns the signed transaction registering a committee_member

create_deactivate_committee_member_proposal nathan 1.4.0 1970-01-01T00:00:00

list_committee_members lowerbound limit

Lists all committee_members registered in the blockchain. This returns a list of all account names that own committee_members, and the associated committee_member id, sorted by name. This lists committee_members whether they are currently voted in or not.

Use the lowerbound and limit parameters to page through the list. To retrieve all committee_members, start by setting lowerbound to the empty string "", and then each iteration, pass the last committee_member name returned as the lowerbound for the next list_committee_members call.