Class ChainAPI

Constructors

constructor

new ChainAPI(client): ChainAPI
Parameters
- client: APIClient
Returns ChainAPI
- Defined in api/v1/chain.ts:57

Methods

compute_transaction

compute_transaction(tx): Promise<SendTransactionResponse>
Parameters
- tx: SignedTransactionType | PackedTransaction
Returns Promise<SendTransactionResponse>
- Defined in api/v1/chain.ts:181

get_abi

get_abi(accountName): Promise<GetAbiResponse>
Parameters
- accountName: NameType
Returns Promise<GetAbiResponse>
- Defined in api/v1/chain.ts:59

get_account

get_account(accountName, responseType?): Promise<AccountObject>
Parameters
- accountName: NameType
- responseType: typeof AccountObject = AccountObject
Returns Promise<AccountObject>
- Defined in api/v1/chain.ts:82

get_accounts_by_authorizers

get_accounts_by_authorizers(params): Promise<AccountsByAuthorizers>
Parameters
- params: GetAccountsByAuthorizersParams
Returns Promise<AccountsByAuthorizers>
- Defined in api/v1/chain.ts:90

get_activated_protocol_features

get_activated_protocol_features(params?): Promise<GetProtocolFeaturesResponse>
Parameters
- Optional params: GetProtocolFeaturesParams
Returns Promise<GetProtocolFeaturesResponse>
- Defined in api/v1/chain.ts:98

get_block

get_block(block_num_or_id): Promise<GetBlockResponse>
Parameters
- block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
  blockNum: UInt32Type;
  checksum: Checksum256Type;
  }
Returns Promise<GetBlockResponse>
- Defined in api/v1/chain.ts:106

get_block_header_state

get_block_header_state(block_num_or_id): Promise<GetBlockHeaderStateResponse>
Parameters
- block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
  blockNum: UInt32Type;
  checksum: Checksum256Type;
  }
Returns Promise<GetBlockHeaderStateResponse>
- Defined in api/v1/chain.ts:114

get_block_info

get_block_info(block_num): Promise<GetBlockInfoResponse>
Parameters
- block_num: UInt32Type
Returns Promise<GetBlockInfoResponse>
- Defined in api/v1/chain.ts:122

get_code

get_code(accountName): Promise<GetCodeResponse>
Parameters
- accountName: NameType
Returns Promise<GetCodeResponse>
- Defined in api/v1/chain.ts:66

get_currency_balance

get_currency_balance(contract, accountName, symbol?): Promise<Asset[]>
Parameters
- contract: NameType
- accountName: NameType
- Optional symbol: string
Returns Promise<Asset[]>
- Defined in api/v1/chain.ts:130

get_currency_stats

get_currency_stats(contract, symbol): Promise<GetCurrencyStatsResponse>
Parameters
- contract: NameType
- symbol: string
Returns Promise<GetCurrencyStatsResponse>
- Defined in api/v1/chain.ts:147

get_info

get_info(): Promise<GetInfoResponse>
Returns Promise<GetInfoResponse>
- Defined in api/v1/chain.ts:166

get_producer_schedule

get_producer_schedule(): Promise<GetProducerScheduleResponse>
Returns Promise<GetProducerScheduleResponse>
- Defined in api/v1/chain.ts:174

get_raw_abi

get_raw_abi(accountName): Promise<GetRawAbiResponse>
Parameters
- accountName: NameType
Returns Promise<GetRawAbiResponse>
- Defined in api/v1/chain.ts:74

get_table_by_scope

get_table_by_scope(params): Promise<GetTableByScopeResponse>
Parameters
- params: GetTableByScopeParams
Returns Promise<GetTableByScopeResponse>
- Defined in api/v1/chain.ts:401

get_table_rows

get_table_rows<Index>(params): Promise<GetTableRowsResponse<Index, any>>
Type Parameters
- Index extends TableIndexType = Name
Parameters
- params: GetTableRowsParams<Index>
Returns Promise<GetTableRowsResponse<Index, any>>
- Defined in api/v1/chain.ts:249
get_table_rows<Key>(params): Promise<GetTableRowsResponse<TableIndexTypes[Key], any>>
Type Parameters
- Key extends keyof TableIndexTypes
Parameters
- params: GetTableRowsParamsKeyed<TableIndexTypes[Key], Key>
Returns Promise<GetTableRowsResponse<TableIndexTypes[Key], any>>
- Defined in api/v1/chain.ts:252
get_table_rows<Row, Index>(params): Promise<GetTableRowsResponse<Index, InstanceType<Row>>>
Type Parameters
- Row extends ABISerializableConstructor
- Index extends TableIndexType = Name
Parameters
- params: GetTableRowsParamsTyped<Index, Row>
Returns Promise<GetTableRowsResponse<Index, InstanceType<Row>>>
- Defined in api/v1/chain.ts:255
get_table_rows<Row, Key>(params): Promise<GetTableRowsResponse<TableIndexTypes[Key], InstanceType<Row>>>
Type Parameters
- Row extends ABISerializableConstructor
- Key extends keyof TableIndexTypes
Parameters
- params: GetTableRowsParamsTyped<TableIndexTypes[Key], Row> & GetTableRowsParamsKeyed<TableIndexTypes[Key], Key>
Returns Promise<GetTableRowsResponse<TableIndexTypes[Key], InstanceType<Row>>>
- Defined in api/v1/chain.ts:261

get_transaction_status

get_transaction_status(id): Promise<GetTransactionStatusResponse>
Parameters
- id: Checksum256Type
Returns Promise<GetTransactionStatusResponse>
- Defined in api/v1/chain.ts:409

push_transaction

push_transaction(tx): Promise<PushTransactionResponse>
Parameters
- tx: SignedTransactionType | PackedTransaction
Returns Promise<PushTransactionResponse>
- Defined in api/v1/chain.ts:207

send_read_only_transaction

send_read_only_transaction(tx): Promise<SendTransactionResponse>
Parameters
- tx: SignedTransactionType | PackedTransaction
Returns Promise<SendTransactionResponse>
- Defined in api/v1/chain.ts:194

send_transaction

send_transaction(tx): Promise<SendTransactionResponse>
Parameters
- tx: SignedTransactionType | PackedTransaction
Returns Promise<SendTransactionResponse>
- Defined in api/v1/chain.ts:218

send_transaction2

send_transaction2(tx, options?): Promise<SendTransaction2Response>
Parameters
- tx: SignedTransactionType | PackedTransaction
- Optional options: SendTransaction2Options
Returns Promise<SendTransaction2Response>
- Defined in api/v1/chain.ts:229