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_account​
​get_account_id​
​get_account_addresses​
​get_account_by_address​
​get_evm_addresses​
​register_account​
​generate_account_address​
​whitelist_account​
​update_account​
Keys
​import_key​
​create_eddsa_keypair​
​get_private_key​
​is_public_key_registered​
​suggest_brain_key​
​normalize_brain_key​
​dump_private_keys​
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​
​freeze_balance​
​request_unfreeze_balance​
​committee_freeze_balance​
​transfer_to_address​
Assets
​list_assets​
​create_asset​
​update_asset​
​update_bitasset​
​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​
​list_committee_members​
​get_committee_member​
Globals
​get_chain_properties​
​get_global_properties​
​propose_parameter_change​
​propose_fee_change​
​approve_proposal​
​get_incentives_info​
Contracts
​get_contract_object​
​get_contract​
​get_contract_result​
​get_contract_history​
​create_contract​
​call_contract​
Contract pool
​contract_fund_fee_pool​
​whitelist_contract_pool​
Network
​network_add_nodes​
Sidechain
​get_account_deposits​
​get_account_withdrawals​
Sidechain-Ethereum
​get_eth_address​
​create_eth_address​
​withdraw_eth​
Sidechain-ERC20
​get_erc20_token​
​check_erc20_token​
​register_erc20_token​
​withdraw_erc20_token​
​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
​sign_builder_transaction​
​get_prototype_operation​
Verifiable Credentials is now in the development stage.
Verifiable Credentials
​get_did_object_key​
Returns info about current chain and active committee members.
info
Returns info such as client version, git version of graphene/fc, version of boost, openssl.
about
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.
Option | Description |
| (Optional) method the name of the API command for more detailed help |
helphelp get_object
Returns the blockchain object corresponding to the given id.
Option | Description |
| the id of the object to return |
get_object 1.2.0
Retrieve a full, signed block.
Option | Description |
| height of the block to be returned |
get_block 10
Get virtual ops from the block.
Option | Description |
| height of the block to be returned |
get_block_virtual_ops 10
This method is used to convert a JSON transaction to its transaction ID.
Option | Description |
| signed transaction |
get_transaction_id JSON_transaction
This method is to get transaction by index in block
Option | Description |
| number of block with transaction |
| transaction index in block |
This method is to get transaction by index in block
Option | Description |
| id of transaction to get |
Converts a signed_transaction in JSON form to its binary representation.
Option | Description |
| the transaction to serialize |
serialize_transaction JSON_transaction
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.
Option | Description |
| the unsigned transaction |
| true if you want to broadcast the transaction |
sign_transaction JSON_transaction true
Returns the number of accounts registered on the blockchain.
get_account_count
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
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.
Option | Description |
| the name of the first account to return. If the named account does not exist, the list will start at the account that comes after |
| the maximum number of accounts to return (max: 1000) |
list_accounts nathan 10
Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account.
Option | Description |
| the name or id of the account |
| the number of entries to return (starting from the most recent) |
get_account_history nathan 10
Returns the relative operations on the named account from start number.
Option | Description |
| the name or id of the account |
| sequence number of earliest operation |
| the number of entries to return |
| the sequence number where to start looping back throw the history |
get_relative_account_history nathan 0 10 20
Returns information about the given account.
Option | Description |
| the name or id of the account to provide information about |
get_account nathanget_account 1.2.26
Lookup the id of a named account.
Option | Description |
| the name of the account to look up |
get_account_id 1.2.26
Get addresses owned by account in specified ids interval
Option | Description |
| id or name of the account |
| number of block to start retrieve from |
| maximum number of addresses to return |
get_account_addresses 1.2.26 0 10get_account_addresses nathan 0 10
Get owner of specified address.
Returns account id of owner.
Option | Description |
| address in form of ripemd160 hash |
get_account_by_address 8815c69de5d32d3061e52ca9386446332225b43d
Get EVM addresses, if exist, for the given account id
Option | Description |
| id or name of the account |
get_evm_addresses nathanget_evm_addresses 1.2.26
Get account address by owner account and label
Option | Description |
| the name or id of the owner account |
| the label of account address object |
get_account_address_by_label 1.2.26 primary
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.
Option | Description |
| the name of the account, must be unique on the blockchain. Shorter names are more expensive to register; the rules are still in flux, but in general names of more than 8 characters with at least one digit will be cheap. |
| the active key for a new account |
| the echorand key for a new account |
| the account which will pay the fee to register the user |
| (Optional) the ethereum address of the account or null |
| true to broadcast the transaction on the network |
register_account new_acc ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu nathan E8fd4Db0C38d48493AD167A268683fAb7230a88A true
Request connected node to register account with provided name and keys.
Option | Description |
| the name of the account, must be unique on the blockchain. Shorter names are more expensive to register; the rules are still in flux, but in general names of more than 8 characters with at least one digit will be cheap. |
| the active key for a new account |
| the echorand key for a new account |
| evm address related to the account |
register_account_with_api nathan ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu 517CF26a16127c4A58072FB7C24D1140F1b63A67
Creates a new account and registers it on the blockchain.
Option | Description |
| the brain key used for generating the account's private keys |
| the name of the account, must be unique on the blockchain. Shorter names are more expensive to register; the rules are still in flux, but in general names of more than 8 characters with at least one digit will be cheap. |
| the account which will pay the fee to register the user |
| evm address related to the account |
| true to broadcast the transaction on the network |
| whether to save the account to the wallet |
create_account_with_brain_key "brain_key" new_acc nathan 517CF26a16127c4A58072FB7C24D1140F1b63A67 true true
Creates a transaction to generate account address.
Option | Description |
| The account for which the address is generated. |
| The label for address |
| true if you want to broadcast the transaction |
generate_account_address nathan label true
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.
Option | Description |
| the account who is doing the whitelisting |
| the account being whitelisted |
| the new whitelisting status |
| true to broadcast the transaction on the network |
whitelist_account nathan acc 0 true
Update an existing account. It can be used to update the authorities, or adjust the options. Returns the signed transaction updating the asset
Option | Description |
| the name or id of the account to update |
| object with options field to update. The new account_options object, which will entirely replace the existing options. |
| true to broadcast the transaction on the network |
| (Optional) the new active authority. This can be updated by the current active authority. null if you don't want to change the authority |
| (Optional) the new public echorand key, which will entirely replace the existing key. null if you don't want to change the echorand key |
update_account nathan {"delegating_account": "1.2.10", "delegate_share": "3000"} true null null
Get all transfers about this address.
Option | Description |
| the address whose history should be queried |
| id of the most recent operation to retrieve |
| id of the earliest operation to retrieve |
| maximum number of operations to retrieve (must not exceed 100) |
get_account_address_history f149bd2883b1179965bd6706092573be4d68fec8 1.6.67 1.6.0 100
Get operations relevant to the specificed account.
Option | Description |
| the id or name of the account whose history should be queried |
| the ID of the operation we want to get operations in the account |
| id of the most recent operation to retrieve |
| id of the earliest operation to retrieve |
| maximum number of operations to retrieve (must not exceed 100) |
get_account_history_operations 1.2.12 1 1.6.10 1.6.0 100
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.
Option | Description |
| the account owning the key |
| the private key, should be input interactively |
import_key nathan private_key
Create new EdDSA keypair encoded in base58 for public key and WIF for private key.
create_eddsa_keypair
Get the WIF private key corresponding to a public key. The private key must already be in the wallet.
Option | Description |
| eddsa public key |
get_private_key ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu
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.
Option | Description |
| public key |
is_public_key_registered ECHO6XS3BMVnEHAzo1PhHWt9vndrZn2P27tCbU9WdqCM8sJu
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
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
Option | Description |
| the brain key as supplied by the user |
normalize_brain_key brain_key
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.
Option | Description |
| brain key |
| number of desired keys |
derive_keys_from_brain_key brain_key 1
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
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
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
Locks the wallet immediately.
lock
Unlocks the wallet. The wallet remain unlocked until the lock
is called or the program exits.
Option | Description |
| the password previously set with |
unlock some_password
Sets a new password on the wallet. The wallet must be either 'new' or 'unlocked' to execute this command.
Option | Description |
| the password, should be input automatically in the wallet |
set_password your_password
Exit from wallet
exit
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
Option | Description |
| the filename of the wallet JSON file to load. If |
load_wallet_file wallet.json
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.
Option | Description |
| the filename of the new wallet JSON file to create or overwrite. If |
save_wallet_file wallet.json
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.
Option | Description |
| the new filename to use for future saves. |
set_wallet_filename wallet.json
This is the filename that will be used when automatically saving the wallet.
Returns the current wallet filename.
get_wallet_filename
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
Option | Description |
| the name or id of the account owning the key |
| true to broadcast the transaction on the network |
| array of eddsa private keys |
import_balance nathan true [ private_keys ]
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
Option | Description |
| the name or id of the account whose balances you want |
list_account_balances nathanlist_account_balances 1.2.26
List the balances of an account or a contract.
Option | Description |
| the id of either an account or a contract |
list_id_balances 1.11.0list_id_balances 1.2.26
List frozen balances of an account.
Option | Description |
| the name or id of the account whose balances you want |
list_frozen_balances nathanlist_frozen_balances 1.2.26
List frozen balances of an committee member account.
Option | Description |
| the name or id of the committee members account whose balances you want |
get_committee_frozen_balance nathanget_committee_frozen_balance 1.2.26
Freezes part of your balance for the specified amount of time.
Option | Description |
| the name or id of the balance holder |
| the amount of asset to freeze |
| the name of asset you want to freeze |
| duration of freeze in days |
| true to broadcast the transaction on the network |
freeze_balance nathan 1 ECHO 90 true
Request to unfreeze your frozen balance's.
Option | Description |
| the name or id of the balance holder |
| the ids of the objects with frozen balance you want to unfreeze which you can get from method list_frozen_balances |
| true to broadcast the transaction on the network |
request_unfreeze_balance nathan ["1.9.1", "1.9.2"] true
Freezes balance required for committee members to operate.
Option | Description |
| the name or id of the committee member account |
| the amount of asset to freeze |
| true to broadcast the transaction on the network |
committee_freeze_balance nathan 10 true
Withdraws part of frozen committee members balance.
Option | Description |
| the name or id of the committee member account |
| the amount of frozen committee balance to withdraw |
| true to broadcast the transaction on the network |
committee_withdraw_balance nathan 1 true
Transfer an amount from one account to address.
Option | Description |
| the name or id of the account sending the funds |
| the address of the account receiving the funds in form of ripemd160 hash |
| the amount to send (in nominal units -- to send half of a ECHO, specify 0.5) |
| the symbol or id of the asset to send |
| true to broadcast the transaction on the network |
transfer_to_address 1.2.0 f149bd2883b1179965bd6706092573be4d68fec8 10 ECHO true
Create a vesting balance with linear policy.
Option | Description |
| the account name or id of vesting creator |
| the account name or id of vesting creator |
| the amount to create vesting |
| the symbol of the asset to create vesting |
| begin timestamp |
| the vesting cliff seconds |
| the vesting duration seconds |
| true to broadcast the transaction on the network |
create_vesting_linear_policy nathan nathan 10 ECHO "2093-12-11T10:26:00" 10 10 true
Create a vesting balance with cdd policy.
Option | Description |
| the account name or id of vesting creator |
| the account name or id of vesting creator |
| the amount to create vesting |
| the symbol of the asset to create vesting |
| start claim |
| the vesting duration seconds |
| true to broadcast the transaction on the network |
create_vesting_cdd_policy nathan nathan 10 ECHO "2093-12-11T10:26:00" 10 true
Get information about a vesting balance object.
Option | Description |
| account name or account ID or vesting balance object ID. |
get_vesting_balances nathanget_vesting_balances 1.2.26
Withdraw a vesting balance.
Option | Description |
| the account id or name or vesting balance ID type. |
| the amount to withdraw. |
| the symbol of the asset to withdraw. |
| true if you want to broadcast the transaction |
withdraw_vesting nathan 10 ECHO true
Transfer an amount from one account to another. Returns the signed transaction transferring funds
Option | Description |
| the name or id of the account sending the funds |
| the name or id of the account receiving the funds |
| the amount to send (in nominal units to send half of a BTS, specify 0.5) |
| the symbol or id of the asset to send |
| true to broadcast the transaction on the network |
transfer 1.2.0 1.2.1 10 ECHO truetransfer nathan alice 10 EBTC true
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
Option | Description |
| the symbol of the first asset to include in the list. |
| the maximum number of assets to return (max: 100) |
list_assets ECHO 10list_assets "" 10
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
Option | Description |
| the name or id of the account who will pay the fee and become the issuer of the new asset. This can be updated later |
| the ticker symbol of the new asset |
| the number of digits of precision to the right of the decimal point, must be less than or equal to 12 |
| asset options required for all new assets. Note that core_exchange_rate technically needs to store the asset ID of this new asset. Since this ID is not known at the time this operation is created, create this price as though the new asset has instance ID 1, and the chain will overwrite it with the new asset's ID. (asset_options) |
| (Optional) options specific to BitAssets. This may be null unless the |
| true to broadcast the transaction on the network |
create_asset nathan myasset 10 {asset_opts} null true
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
Option | Description |
| the name or id of the asset to update |
| (Optional) if changing the asset's issuer, the name or id of the new issuer. null if you want to remain the issuer of the asset |
| the new asset_options object, which will entirely replace the existing options. |
| true to broadcast the transaction on the network |
update_asset myasset nathan {asset_opts} true
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
Option | Description |
| the name or id of the asset to update, which must be a market-issued asset |
| the new bitasset_options object, which will entirely replace the existing options. |
| true to broadcast the transaction on the network |
update_bitasset myasset {bitasset_opts} true
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
Option | Description |
| the name or id of the asset to update |
| a list of account names or ids which are authorized to produce feeds for the asset. this list will completely replace the existing list |
| true to broadcast the transaction on the network |
update_asset_feed_producers UIA [nathan, foobar] true
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
Option | Description |
| the account publishing the price feed |
| the name or id of the asset whose feed we're publishing |
| the price object containing price making up the feed |
| true to broadcast the transaction on the network |
publish_asset_fee nathan myasset {price} true
Issue new shares of an asset.
Returns the signed transaction issuing the new shares
Option | Description |
| the name or id of the account to receive the new shares |
| the amount to issue, in nominal units |
| the ticker symbol of the asset to issue |
| true to broadcast the transaction on the network |
issue_asset nathan 10 myasset true
Returns information about the given asset.
Option | Description |
| the symbol or id of the asset in question |
get_asset ECHO
Lookup the id of a named asset.
Option | Description |
| the symbol of an asset to look up |
get_asset_id ECHO
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
.
Option | Description |
| the symbol or id of the BitAsset in question |
get_bitasset_data ECHO
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
Option | Description |
| the name or id of the account sending the core asset |
| the name or id of the asset whose fee pool you want to fund |
| the amount of the core asset to deposit |
| true to broadcast the transaction on the network |
fund_asset_fee_pool nathan myasset 10 true
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
Option | Description |
| the account containing the asset you want to burn |
| the amount to burn, in nominal units |
| the name or id of the asset to burn |
| true to broadcast the transaction on the network |
reserve_asset nathan 10 ECHO true
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
Option | Description |
| the name or id of the account which is creating the committee_member |
| a URL to include in the committee_member record in the blockchain. Clients may display this when showing a list of committee_members. May be blank. |
| amount of ECHO asset to freeze |
| address of the account in the ethereum network |
| public key of the account in the bitcoin network |
| true to broadcast the transaction on the network |
create_committee_member nathan example.com 1000 E8fd4Db0C38d48493AD167A268683fAb7230a88A 02c16e97132e72738c9c0163656348cd1be03521de17efeb07e496e742ac84512e true
Updates a committee_member object owned by the given account.
Returns the signed transaction updating a committee_member.
Option | Description |
| the name or id of the account which is updating the committee_member |
| (Optional) a new URL of the committee_member_object, enter empty string if you don't want to change it |
| (Optional) a new ethereum address of the committee_member object, enter empty string if you don't want to change it |
| (Optional) a new bitcoin public key of the committee_member object, enter empty string if you don't want to change it |
| true to broadcast the transaction on the network |
update_committee_member nathan new_url E8fd4Db0C38d48493AD167A268683fAb7230a88A 02c16e97132e72738c9c0163656348cd1be03521de17efeb07e496e742ac84512e true
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
Option | Description |
| the name or id of the account which is creating proposal |
| a committee member |
| expiration time of created proposal |
create_activate_committee_member_proposal nathan 1.4.0 1970-01-01T00:00:00
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
Option | Description |
| the name or id of the account which is creating proposal |
| a committee member |
| expiration time of created proposal |
create_deactivate_committee_member_proposal nathan 1.4.0 1970-01-01T00:00:00
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.
Option | Description |
| the name of the first committee_member to return. If the named committee_member does not exist, the list will start at the committee_member that comes after |
| the maximum number of committee_members to return (max: 1000) |
list_committee_members 1.4.0 10
Returns information about the given committee_member.
Option | Description |
| the name or id of the committee_member account owner, or the id of the committee_member |
get_committee_member nathanget_committee_member 1.2.26
Retrieve the chain_property_object associated with the chain
get_chain_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_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
get_dynamic_global_properties
Returns information about git revision of the running node. The returned object contains commit hash, approximate relative time of commit and revision description.
get_git_revision
Creates a transaction to propose a parameter change. Multiple parameters can be specified if an atomic change is desired.
Returns the signed transaction with new global parameters and proposal id.
Option | Description |
| the account paying the fee to propose the tx |
| timestamp specifying when the proposal will either take effect or expire. |
| the values to change; all other chain parameters are filled in with default values |
propose_parameter_change 1.2.6 "2093-12-11T10:26:00" { "sidechain_config" : { "eth_committee_update_method" : { "method" : "ffffffff" } } }
Propose a fee change.
Returns the signed transaction with new global parameters and proposal id.
Option | Description |
| the account paying the fee to propose the tx |
| timestamp specifying when the proposal will either take effect or expire. |
| map of operation type to new fee. Operations may be specified by name or ID. The "scale" key changes the scale. All other operations will maintain current values. |
propose_fee_change 1.2.6 "2014-12-11T12:42:00" { 59 : { "fee" :123 } }propose_fee_change 1.2.6 "2122-12-11T07:53:00" { "sidechain_btc_intermediate_deposit" : { "fee" :123 } }propose_fee_change 1.2.6 "2179-12-11T07:53:00" { "scale" : 1000 }
Approve or disapprove a proposal.
Option | Description |
| the account paying the fee for the op. |
| the proposal to modify. |
| members contain approvals to create or remove. In JSON you can leave empty members undefined. |
| true if you want to broadcast the transaction |
approve_proposal 1.2.6 1.5.0 {"active_approvals_to_add": ["1.2.6", "1.2.7", "1.2.8", "1.2.9", "1.2.10"],"active_approvals_to_remove": [],"key_approvals_to_add": [],"key_approvals_to_remove": []} true
Returns information about incentives. The returned object contains incentives_pool that indicates amounts that stored in pool now and incentives per block for current interval.
get_current_incentives_info
Retrieve the info about incentives in given block range [start_block, end_block]
Option | Description |
| number of start block |
| number of end block |
get_incentives_info 5 100get_incentives_info 100 100
Get the contract object from the database by it's id.
Option | Description |
| the id of the contract |
get_contract_object 1.11.0
Get the contract information by the contract's id
Option | Description |
| id of the contract |
get_contract 1.11.0
Get the result of contract execution.
Option | Description |
| the id of the conract result |
get_contract_result 1.12.0
Returns the most recent operations on the contract id. This returns a list of operation history objects, which describe activity on the contract.
Option | Description |
| the ID of the contract |
| the number of entries to return (starting from the most recent) |
get_contract_history 1.11.0 10
Returns the relative operations on the id contract from start number.
Option | Description |
| the ID of the contract |
| Sequence number of earliest operation |
| the number of entries to return (starting from the most recent) |
| the sequence number where to start looping back throw the history |
get_relative_contract_history 1.11.0 0 10 20
Upload/Create a contract.
Returns the signed transaction creating the contract
Option | Description |
| name of the account creating the contract |
| code of the contract in hex format |
| the amount of asset transfered to the contract |
| the type of the asset transfered to the contract |
| the asset that can be used to create/call the contract (see Flag of supported asset) |
| whether to use the ethereum asset accuracy (see Flag of using Ethereum accuracy) |
create_contract nathan code_contract 0 ECHO "" false
Call a contract.
Returns the signed transaction calling the contract
Option | Description |
| name of the account calling the contract |
| the id of the contract to call |
| the hash of the method to call |
| the amount of asset transfered to the contract |
| the type of the asset transfered to the contract |
call_contract nathan 1.11.0 code_contract 0 ECHO
Call the provided contract, but don't change the state.
Returns result of execution
Option | Description |
| id of the contract |
| id of the account or contract that calls contract |
| amount in ECHO. 1 ECHO is 100000000 |
| the type of the asset transfered to the contract |
| the hash of the method to call |
call_contract_no_changing_state 1.11.0 1.2.0 0 ECHO "6d4ce63c"
Get contract's feepool balance.
Option | Description |
| for getting feepool balance. |
get_contract_pool_balance 1.11.0
Get contract's whitelist and blacklist.
Option | Description |
| for getting whitelist and blacklist of feepool object. |
get_contract_pool_whitelist 1.11.0
Fund feepool of contract.
Option | Description |
| name of the account which fund contract's feepool |
| the id of the contract's feepool |
| the amount of asset transfered to the contract in default asset_id_type() |
| whether to broadcast the fund contract operation to the network |
contract_fund_fee_pool nathan 1.11.0 0 true
Whitelist or blacklist contract pool.
Returns the signed version of the transaction.
Option | Description |
| is an owner of contract which perform whitelistining or blacklistining. |
| whitelistining or blacklistining applying for this contract. |
| leave it empty if you don't want to add some account to whitelist. |
| leave it empty if you don't want to add some account to blacklist. |
| leave it empty if you don't want to remove some account from whitelist. |
| leave it empty if you don't want to remove some account from blacklist. |
| true if you want to broadcast the contract whitelist operation |
whitelist_contract_pool nathan 1.11.0 [] [] [] [] true
Adding nodes to network.
Option | Description |
| endpoints your nodes |
network_add_nodes 127.0.0.1:8090
Get connected peers.
network_get_connected_peers
Returns all deposits, for the given account id.
Option | Description |
| the id or name of the account to provide information about |
| the type of the deposits may be "", "eth" or "btc". By default "" = all deposits |
get_account_deposits 1.2.0 ""get_account_deposits nathan btc
Returns all withdrawals, for the given account id.
Option | Description |
| the id or name of the account to provide information about |
| the type of the withdrawals may be "", "eth" or "btc". By default "" = all withdrawals |
get_account_withdrawals 1.2.0 ""get_account_deposits nathan eth
Returns all stake objects, for the given account id.
Option | Description |
| the id or name of the account to provide information about |
| the type of the objects may be "", seth" or "sbtc". By default "" = all objects |
get_account_stake_objects 1.2.0 ""get_account_stake_objects nathan sbtc
Returns information about generated eth address, if exist and approved, for the given account id.
Option | Description |
| the id or name of the account to provide information about |
get_eth_address 1.2.0get_eth_address nathan
Creates a transaction to generate ethereum address.
Option | Description |
| the name or id of account for which the ethereum address is generated. |
| true if you want to broadcast the transaction |
create_eth_address 1.2.0 truecreate_eth_address nathan true
Creates a transaction to withdraw ethereum.
Option | Description |
| the account who withdraw ethereum. |
| the Ethereum address where withdraw. |
| withdraw amount. |
| true if you want to broadcast the transaction. |
withdraw_eth nathan 0102fe7702b96808f7bbc0d4a888ed1468216cfd 10 true
Creates a transaction to propose change the eth contract address.
Option | Description |
| the account paying the fee to propose the tx. |
| timestamp specifying when the proposal will either take effect or expire. |
| the new address for ethereum contract. |
propose_eth_update_contract_address 1.2.6 "2019-11-28T13:50:00" "0e7057518879d5DE1F842b77e8F6F3e22931a1be"
Get erc20 token information.
Option | Description |
| the ethereum address of token in Ethereum network or the id in ECHO |
get_erc20_token 0102fe7702b96808f7bbc0d4a888ed1468216cfdget_erc20_token 1.16.155
Checks the contract exists and is ERC20 token contract registered by register_erc20_contract operation
Option | Description |
| ID of the contract |
check_erc20_token 1.11.0
Returns all deposits, for the given account id.
Option | Description |
| the id or name of the account to provide information about |
get_erc20_account_deposits 1.2.0get_erc20_account_deposits nathan
Returns all withdrawals for the given account id.
Option | Description |
| the id or name of the account to provide information about |
get_erc20_account_withdrawals 1.2.0get_erc20_account_withdrawals nathan
Creates a transaction to register erc20_token for sidechain.
Returns the signed version of the transaction.
Option | Description |
| the account who create erc20 token and become his owner. |
| the address of token erc20 token in ethereum network. |
| name of the token in echo network. |
| symbol of the token in echo network. |
| number of the digist after the comma of the token in echo network. |
| true if you want to broadcast the transaction. |
register_erc20_token nathan E62627255a4BC0c92E190E01c515Ba28233c9207 erc20DbeVxoV QIGMPUZ 8 true
Creates a transaction to withdraw erc20_token.
Returns the signed version of the transaction.
Option | Description |
| the account who withdraw erc20 token. |
| the Ethereum address where withdraw erc20 token. |
| the erc20 token id in ECHO. |
| the amount withdraw. |
| true if you want to broadcast the transaction. |
withdraw_erc20_token nathan 545a68602db30bf5db9692267f8f84b7f1e70ec3 1.16.0 10 true
Creates a transaction to transfer assets to Ethereum erc20_token.
Returns the signed version of the transaction.
Option | Description |
| the account who make proposal. |
| timestamp specifying when the proposal will either take effect or expire. |
| object of data for erc20 contract. Should have fields |
| true if you want to broadcast the transaction. |
propose_register_asset_in_sidechain 1.2.6 "2122-12-11T07:53:00" { "code" : "some code", "args" : "some args", "address" : "2A365517AB5f70b4079Cd2dC2C3Bc9d111AaE951", "name" : "NewToken", "symbol": "ENEW", "decimals" : 8, "eth_accuracy" : false } true
Creates a transaction to transfer assets to Ethereum erc20_token.
Returns the signed version of the transaction.
Option | Description |
| the account who withdraw erc20 token. |
| the Ethereum address where transfer erc20 token. |
| the amount transfer. |
| the asset symbol. |
| true if you want to broadcast the transaction. |
transfer_to_eth_erc20 nathan 545a68602db30bf5db9692267f8f84b7f1e70ec3 100 ECHO true
Creates a transaction to generate bitcoin deposit address.
Option | Description |
| the account or id for which the bitcoin address is generated. |
| the P2PKH address to transfer satoshis back. |
| true if you want to broadcast the transaction |
create_btc_address nathan 17VZNX1SN5NtKa8UQFxwQbFeFc3iqRYhem true
Returns information about generated btc address, if exist and approved, for the given account id.
Option | Description |
| the account name or id to provide information about |
get_btc_address 1.2.0get_btc_address nathan
Returns bitcoin script for generated bitcoin deposit address, if exist, for the given address id.
Option | Description |
| the id of the bitcoin address to provide script |
get_btc_deposit_script 1.19.0
Creates a transaction to withdraw btc.
Option |