Contents

• Info and help

  • ​info​

  • ​about​

  • ​help​

  • ​help_method​

  • ​get_prototype_operation​

  • ​get_object​

• Blocks and transactions

  • ​get_block​

  • ​get_block_virtual_ops​

  • ​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​

  • ​import_accounts​

  • ​register_account_with_api​

  • ​create_account_with_brain_key​

  • ​generate_account_address​

  • ​whitelist_account​

• Keys

  • ​import_key​

  • ​import_account_keys​

  • ​create_eddsa_keypair​

  • ​get_private_key​

  • ​is_public_key_registered​

  • ​suggest_brain_key​

  • ​normalize_brain_key​

  • ​derive_keys_from_brain_key​

  • ​dump_private_keys​

  • ​old_key_to_wif​

• Password & lock

  • ​is_new​

  • ​is_locked​

  • ​lock​

  • ​unlock​

  • ​set_password​

  • ​exit​

• Wallet file

  • ​load_wallet_file​

  • ​save_wallet_file​

• Balances

  • ​import_balance​

  • ​list_account_balances​

  • ​list_id_balances​

  • ​get_vesting_balances​

  • ​withdraw_vesting​

  • ​transfer​

  • ​list_frozen_balances​

  • ​get_committee_frozen_balance​

  • ​freeze_balance​

  • ​committee_freeze_balance​

  • ​committee_withdraw_balance​

• 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​

• Contracts

  • ​get_contract_object​

  • ​get_contract​

  • ​get_contract_result​

  • ​create_contract​

  • ​call_contract​

  • ​call_contract_no_changing_state​

  • ​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​

• Sidechain-Ethereum

  • ​get_eth_address​

  • ​generate_eth_address​

  • ​withdraw_eth​

• Sidechain-ERC20

  • ​get_erc20_token​

  • ​check_erc20_token​

  • ​get_erc20_account_deposits​

  • ​get_erc20_account_withdrawals​

  • ​register_erc20_token​

  • ​withdraw_erc20_token​

• Sidechain-Bitcoin

  • ​generate_btc_deposit_address​

  • ​get_btc_addresses​

  • ​get_btc_deposit_script​

  • ​withdraw_btc​

Info and help

info

Returns info about current chain and active committee members.

about

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

help

Returns a list of all commands supported by the wallet API. This lists each command, along with its arguments and return types. For more detailed help on a single command, use help_method

help_method method

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

get_prototype_operation operation_type

Returns an uninitialized object representing a given blockchain operation. This returns a default-initialized object of the given type; it can be used during early development of the wallet when we don't yet have custom commands for creating all of the operations the blockchain supports.

• operation_type the type of operation to return, must be one of the operations described in Operation section

get_object object_id

Returns the blockchain object corresponding to the given id.

Blocks and transactions

get_block block_num

Retrieve a full, signed block.

get_block_virtual_ops block_num

Get virtual ops from the block.

get_transaction_id tx

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

serialize_transaction tx

Converts a signed_transaction in JSON form to its binary representation.

sign_transaction tx broadcast

Signs a transaction.

Accounts

get_account_count

Returns the number of accounts registered on the blockchain.

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_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.

list_accounts nathan 10

get_account_history name 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 name 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_name_or_id

Returns information about the given account.

get_account nathan or 1.2.0

get_account_id account_name_or_id

Lookup the id of a named account.

get_account_id 1.2.0

get_account_addresses account_id from limit

Get addresses owned by account in specified ids interval

get_account_addresses 1.2.0 0 10

get_account_by_address address

Get owner of specified address.

get_account_by_address 8815c69de5d32d3061e52ca9386446332225b43d

import_accounts filename password

Imports accounts from a Echo wallet file. Current wallet file must be unlocked to perform the import. Returns a map containing the accounts found and whether imported.

register_account name active registrar-account 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 nathan ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu new_acc true

register_account_with_api name active-key echorand-key

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

create_account_with_brain_key brain_key account_name registrar_account broadcast

Creates a new account and registers it on the blockchain.

create_account_with_brain_key "brain_key" new_acc nathan 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.

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

import_account_keys filename password src_account_name dest_account_name

Imports from a Echo wallet file, find keys that were bound to a given account name on the Echo chain, rebind them to an account name on the Echo chain. Current wallet file must be unlocked to perform the import.

create_eddsa_keypair

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

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

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

Example 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

old_key_to_wif b58

Dumps private key from old b58 format to new WIF. The keys are printed in WIF format. You can import these key into another wallet using import_key. Returns string new in WIF eddsa private key

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.

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.

lock

Locks the wallet immediately.

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

cancel_all_subscriptions

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

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.

Balances

import_balance account_name_or_id 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 id

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 or 1.2.0

list_id_balances id

List the balances of an account or a contract.

list_id_balances 1.11.0

list_frozen_balances account

List frozen balances of an account.

list_frozen_balances nathan

get_committee_frozen_balance owner_account

List frozen balances of an committee member account.

get_committee_frozen_balance nathan

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

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

get_vesting_balances account

Get information about a vesting balance object.

get_vesting_balances nathan

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

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

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_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_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 feed 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

issue_asset to_account amount symbol broadcast

Issue new shares of an asset.

Returns the signed transaction issuing the new shares

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

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 1.4.0 new_url E8fd4Db0C38d48493AD167A268683fAb7230a88A 02c16e97132e72738c9c0163656348cd1be03521de17efeb07e496e742ac84512e true

create_activate_committee_member_proposal sender committee_to_activate expiration_time broadcast

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 true

create_deactivate_committee_member_proposal sender committee_to_activate expiration_time broadcast)

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 true

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()](#classgraphene_1_1wallet_1_1wallet__api_1aec9eca62eb2c6748d463604632ba6508) call.

list_committee_members

get_committee_member owner_account

Returns information about the given committee_member.

get_committee_member nathan

Globals

get_chain_properties

Retrieve the chain_property_object associated with the chain

get_global_properties

Returns the block chain's slowly-changing settings. This object contains all of the properties of the blockchain that are fixed or that change only once per maintenance interval (daily) such as the current list of committee_members, block interval, etc. See also: get_dynamic_global_properties for frequently changing properties.

get_dynamic_global_properties

Returns the block chain's rapidly-changing properties. The returned object contains information that changes every block interval such as the head block number, etc. See also: get_global_properties for less-frequently changing properties

propose_parameter_change proposing_account expiration_time changed_values broadcast

Creates a transaction to propose a parameter change. Multiple parameters can be specified if an atomic change is desired.

propose_fee_change proposing_account expiration_time changed_values broadcast

Propose a fee change.

approve_proposal fee_paying_account proposal_id delta broadcast

Approve or disapprove a proposal.

Contracts

get_contract_object id

Get the contract object from the database by it's id.

get_contract_object 1.11.0

get_contract id

Get the contract information by the contract's id

get_contract 1.11.0

get_contract_result id

Get the result of contract execution.

get_contract_result 1.10.0

create_contract registrar_account code value asset_type supported_asset_id eth_accuracy save_wallet

Upload/Create a contract.

Returns the signed transaction creating the contract

create_contract nathan code_contract 0 ECHO "" false true

call_contract registrar_account receiver code value asset_type save_wallet

Call a contract.

Returns the signed transaction calling the contract

call_contract nathan 1.11.0 code_contract 0 ECHO false

call_contract_no_changing_state contract_id registrar_account asset_type code

Call the provided contract, but don't change the state.

Returns result of execution

call_contract_no_changing_state 1.11.0 1.2.0 0 ECHO "6d4ce63c"

get_contract_pool_balance id

Get contract's feepool balance.

get_contract_pool_balance 1.11.0

get_contract_pool_whitelist id

Get contract's whitelist and blacklist.

get_contract_pool_whitelist 1.11.0

contract_fund_fee_pool registrar_account receiver value broadcast

Fund feepool of contract.

contract_fund_fee_pool nathan 1.11.0 0 true

whitelist_contract_pool registrar_account contract_id add_to_whitelist add_to_blacklist rm_whitelist rm_blacklist broadcast

Whitelist or blacklist contract pool.

Returns the signed version of the transaction.

whitelist_contract_pool nathan 1.11.0 [] [] [] [] true

Network

network_add_nodes nodes

Adding nodes to network.

network_add_nodes 127.0.0.1:8090

network_get_connected_peers

Get connected peers.

Sidechain

get_account_deposits account type

Returns all deposits, for the given account id.

get_account_deposits 1.2.0 ""

get_account_withdrawals account type

Returns all withdrawals, for the given account id.

get_account_withdrawals 1.2.0 ""

Sidechain Ethereum

get_eth_address account

Returns information about generated eth address, if exist and approved, for the given account id.

get_eth_address 1.2.0

generate_eth_address account broadcast

Creates a transaction to generate ethereum address.

generate_eth_address nathan true

withdraw_eth account eth_addr value broadcast

Creates a transaction to withdraw ethereum.

withdraw_eth nathan 0102fe7702b96808f7bbc0d4a888ed1468216cfd 10 true

Sidechain ERC20

get_erc20_token eth_addr

Get erc20 token information.