Skip to content

Latest commit

 

History

History
718 lines (580 loc) · 20.5 KB

api.md

File metadata and controls

718 lines (580 loc) · 20.5 KB
Raw

Objects

eos : object

Typedefs

bytes : Buffer | hex
getCodeResult : object
getCodeHashResult : object
getAbiResult : object
getRawCodeAndAbiResult : object
abiJsonToBinResult : object
abiBinToJsonResult : object
getTableRowsResult : object
getCurrencyStatsResult : object
getProducersResult : object
getProducerScheduleResult : object
getScheduledTransactionsResult : object
pushBlockResult : object
pushTransactionResult : object
getActionsResult : object
getTransactionResult : object
getKeyAccountsResult : object
getControlledAccountsResult : object

eos : object

Kind: global namespace

eos.getInfo() ⇒ string

Return general network information.

Kind: static method of eos
Example

url_path: `/v1/chain/get_info`

Example

eos.getInfo({})

eos.getAccount(account_name) ⇒ string

Fetch a blockchain account

Kind: static method of eos

Param Type
account_name name

Example

url_path: `/v1/chain/get_account`

Example

eos.getAccount(account_name)

eos.getCode(account_name, [code_as_wasm]) ⇒ getCodeResult

Fetch smart contract code

Kind: static method of eos

Param Type Default
account_name name
[code_as_wasm] bool false

Example

url_path: `/v1/chain/get_code`

Example

eos.getCode(account_name, code_as_wasm)

eos.getCodeHash(account_name) ⇒ getCodeHashResult

Kind: static method of eos

Param Type
account_name name

Example

url_path: `/v1/chain/get_code_hash`

Example

eos.getCodeHash(account_name)

eos.getAbi(account_name) ⇒ getAbiResult

Kind: static method of eos

Param Type
account_name name

Example

url_path: `/v1/chain/get_abi`

Example

eos.getAbi(account_name)

eos.getRawCodeAndAbi(account_name) ⇒ getRawCodeAndAbiResult

Kind: static method of eos

Param Type
account_name name

Example

url_path: `/v1/chain/get_raw_code_and_abi`

Example

eos.getRawCodeAndAbi(account_name)

eos.abiJsonToBin(code, action, args) ⇒ abiJsonToBinResult

Manually serialize json into binary hex. The binayargs is usually stored in Action.data.

Kind: static method of eos

Param Type
code name
action name
args bytes

Example

url_path: `/v1/chain/abi_json_to_bin`

Example

eos.abiJsonToBin(code, action, args)

eos.abiBinToJson(code, action, binargs) ⇒ abiBinToJsonResult

Convert bin hex back into Abi json definition.

Kind: static method of eos

Param Type
code name
action name
binargs bytes

Example

url_path: `/v1/chain/abi_bin_to_json`

Example

eos.abiBinToJson(code, action, binargs)

eos.getRequiredKeys(transaction, available_keys) ⇒ Set.<public_key>

Kind: static method of eos

Param Type
transaction transaction
available_keys set.<public_key>

Example

url_path: `/v1/chain/get_required_keys`

Example

eos.getRequiredKeys(transaction, available_keys)

eos.getBlock(block_num_or_id) ⇒ variant

Fetch a block from the blockchain.

Kind: static method of eos

Param Type
block_num_or_id string

Example

url_path: `/v1/chain/get_block`

Example

eos.getBlock(block_num_or_id)

eos.getBlockHeaderState(block_num_or_id) ⇒ string

Fetch the minimum state necessary to validate transaction headers.

Kind: static method of eos

Param Type
block_num_or_id string

Example

url_path: `/v1/chain/get_block_header_state`

Example

eos.getBlockHeaderState(block_num_or_id)

eos.getTableRows([json], code, scope, table, table_key, [lower_bound], [upper_bound], [limit], key_type, index_position) ⇒ getTableRowsResult

Fetch smart contract data from an account.

Kind: static method of eos

Param Type Default Description
[json] bool false
code name
scope string
table name
table_key string
[lower_bound] string 0
[upper_bound] string -1
[limit] uint32 10
key_type string The key type of --index, primary only supports (i64), all others support (i64, i128, i256, float64, float128). Special type 'name' indicates an account name.
index_position string 1 - primary (first), 2 - secondary index (in order defined by multi_index), 3 - third index, etc

Example

url_path: `/v1/chain/get_table_rows`

Example

eos.getTableRows(json, code, scope, table, table_key, lower_bound, upper_bound, limit, key_type, index_position)

eos.getCurrencyBalance(code, account, symbol) ⇒ Array.<asset>

Kind: static method of eos

Param Type
code name
account name
symbol optional.<string>

Example

url_path: `/v1/chain/get_currency_balance`

Example

eos.getCurrencyBalance(code, account, symbol)

eos.getCurrencyStats(code, symbol) ⇒ getCurrencyStatsResult

Kind: static method of eos

Param Type
code name
symbol string

Example

url_path: `/v1/chain/get_currency_stats`

Example

eos.getCurrencyStats(code, symbol)

eos.getProducers([json], lower_bound, [limit]) ⇒ getProducersResult

Fetch smart contract data from producer.

Kind: static method of eos

Param Type Default
[json] bool false
lower_bound string
[limit] uint32 50

Example

url_path: `/v1/chain/get_producers`

Example

eos.getProducers(json, lower_bound, limit)

eos.getProducerSchedule() ⇒ getProducerScheduleResult

Kind: static method of eos
Example

url_path: `/v1/chain/get_producer_schedule`

Example

eos.getProducerSchedule()

eos.getScheduledTransactions([json], lower_bound, [limit]) ⇒ getScheduledTransactionsResult

Kind: static method of eos

Param Type Default Description
[json] bool false
lower_bound string timestamp OR transaction ID
[limit] uint32 50

Example

url_path: `/v1/chain/get_scheduled_transactions`

Example

eos.getScheduledTransactions(json, lower_bound, limit)

eos.pushBlock(block)

Append a block to the chain database.

Kind: static method of eos

Param Type
block signed_block

Example

url_path: `/v1/chain/push_block`

Example

eos.pushBlock(block)

eos.pushTransaction(signed_transaction) ⇒ pushTransactionResult

Attempts to push the transaction into the pending queue.

Kind: static method of eos

Param Type
signed_transaction signed_transaction

Example

url_path: `/v1/chain/push_transaction`

Example

eos.pushTransaction(signed_transaction)

eos.pushTransactions(signed_transaction) ⇒ vector.<push_transaction.results>

Attempts to push transactions into the pending queue.

Kind: static method of eos

Param Type
signed_transaction signed_transaction

Example

url_path: `/v1/chain/push_transactions`

Example

eos.pushTransactions(signed_transaction)

eos.getActions(account_name, [pos], [offset]) ⇒ getActionsResult

Kind: static method of eos

Param Type Description
account_name account_name
[pos] int32 An absolute sequence positon -1 is the end/last action
[offset] int32 The number of actions relative to pos, negative numbers return [pos-offset,pos), positive numbers return [pos,pos+offset)

Example

url_path: `/v1/history/get_actions`

Example

eos.getActions(account_name, pos, offset)

eos.getTransaction(id, [block_num_hint]) ⇒ getTransactionResult

Retrieve a transaction from the blockchain.

Kind: static method of eos

Param Type Default Description
id transaction_id_type
[block_num_hint] uint32 0 A non-zero block number allows shorter transaction IDs (8 hex, 4 bytes)

Example

url_path: `/v1/history/get_transaction`

Example

eos.getTransaction(id, block_num_hint)

eos.getKeyAccounts(public_key) ⇒ getKeyAccountsResult

Kind: static method of eos

Param Type
public_key public_key_type

Example

url_path: `/v1/history/get_key_accounts`

Example

eos.getKeyAccounts(public_key)

eos.getControlledAccounts(controlling_account) ⇒ getControlledAccountsResult

Kind: static method of eos

Param Type
controlling_account account_name

Example

url_path: `/v1/history/get_controlled_accounts`

Example

eos.getControlledAccounts(controlling_account)

bytes : Buffer | hex

Kind: global typedef

getCodeResult : object

Kind: global typedef
Properties

Name Type
account_name name
wast string
wasm string
code_hash sha256
abi optional.<abi_def>

getCodeHashResult : object

Kind: global typedef
Properties

Name Type
account_name name
code_hash sha256

getAbiResult : object

Kind: global typedef
Properties

Name Type
account_name name
[abi] abi_def

getRawCodeAndAbiResult : object

Kind: global typedef
Properties

Name Type
account_name name
wasm bytes
[abi] abi_def

abiJsonToBinResult : object

Kind: global typedef
Properties

Name Type
binargs bytes

abiBinToJsonResult : object

Kind: global typedef
Properties

Name Type
args bytes

getTableRowsResult : object

Kind: global typedef
Properties

Name Type Description
rows vector One row per item, either encoded as hex String or JSON object
more bool True if last element in data is not the end and sizeof data() < limit

getCurrencyStatsResult : object

Kind: global typedef
Properties

Name Type
supply asset
max_supply asset
issuer account_name

getProducersResult : object

Kind: global typedef
Properties

Name Type Description
rows vector one row per item, either encoded as hex String or JSON object
total_producer_vote_weight double total vote
more string fill lower_bound with this value to fetch more rows

getProducerScheduleResult : object

Kind: global typedef
Properties

Name Type
vector proposed

getScheduledTransactionsResult : object

Kind: global typedef
Properties

Name Type Description
vector transactions
more string fill lower_bound with this to fetch next set of transactions

pushBlockResult : object

Kind: global typedef

pushTransactionResult : object

Kind: global typedef
Properties

Name Type
transaction_id fixed_bytes32
processed bytes

getActionsResult : object

Kind: global typedef
Properties

Name Type
actions Array.<ordered_action_result>
last_irreversible_block uint32
[time_limit_exceeded_error] bool

getTransactionResult : object

Kind: global typedef
Properties

Name Type
id transaction_id_type
trx variant
block_time block_timestamp_type
block_num uint32
last_irreversible_block uint32
traces Array.<variant>

getKeyAccountsResult : object

Kind: global typedef
Properties

Name Type
account_names Array.<account_name>

getControlledAccountsResult : object

Kind: global typedef
Properties

Name Type
controlled_accounts Array.<account_name>