Class ChainAPI

Hierarchy

ChainAPI

Index

Constructors

Methods

compute_transaction get_abi get_account get_accounts_by_authorizers get_activated_protocol_features get_block get_block_header_state get_currency_balance get_info get_producer_schedule get_raw_abi get_table_by_scope get_table_rows get_transaction_status push_transaction send_read_only_transaction send_transaction send_transaction2

Constructors

constructor

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

Methods

compute_transaction

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

get_abi

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

get_account

get_account(accountName: NameType): Promise<AccountObject>
Parameters
- accountName: NameType
Returns Promise<AccountObject>
- Defined in src/api/v1/chain.ts:70

get_accounts_by_authorizers

get_accounts_by_authorizers(keys: PublicKeyType[]): Promise<AccountsByAuthorizers>
Parameters
- keys: PublicKeyType[]
Returns Promise<AccountsByAuthorizers>
- Defined in src/api/v1/chain.ts:78

get_activated_protocol_features

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

get_block

get_block(block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
blockNum: UInt32Type;
checksum: Checksum256Type;
}): 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 src/api/v1/chain.ts:94

get_block_header_state

get_block_header_state(block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
blockNum: UInt32Type;
checksum: Checksum256Type;
}): 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 src/api/v1/chain.ts:102

get_currency_balance

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

get_info

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

get_producer_schedule

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

get_raw_abi

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

get_table_by_scope

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

get_table_rows

get_table_rows<Index>(params: GetTableRowsParams<Index>): Promise<GetTableRowsResponse<Index, any>>
Type Parameters
- Index extends TableIndexType = Name
Parameters
- params: GetTableRowsParams<Index>
Returns Promise<GetTableRowsResponse<Index, any>>
- Defined in src/api/v1/chain.ts:202
get_table_rows<Key>(params: GetTableRowsParamsKeyed<TableIndexTypes[Key], Key>): 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 src/api/v1/chain.ts:205
get_table_rows<Row, Index>(params: GetTableRowsParamsTyped<Index, Row>): 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 src/api/v1/chain.ts:208
get_table_rows<Row, Key>(params: GetTableRowsParamsTyped<TableIndexTypes[Key], Row> & GetTableRowsParamsKeyed<TableIndexTypes[Key], Key>): 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 src/api/v1/chain.ts:214

Class ChainAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: APIClient

Returns ChainAPI

Methods

compute_transaction

Parameters

tx: SignedTransactionType | PackedTransaction

Returns Promise<SendTransactionResponse>

get_abi

Parameters

accountName: NameType

Returns Promise<GetAbiResponse>

get_account

Parameters

accountName: NameType

Returns Promise<AccountObject>

get_accounts_by_authorizers

Parameters

keys: PublicKeyType[]

Returns Promise<AccountsByAuthorizers>

get_activated_protocol_features

Parameters

Optional params: GetProtocolFeaturesParams

Returns Promise<GetProtocolFeaturesResponse>

get_block

Parameters

block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | { blockNum: UInt32Type; checksum: Checksum256Type; }

Returns Promise<GetBlockResponse>

get_block_header_state

Parameters

block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | { blockNum: UInt32Type; checksum: Checksum256Type; }

Returns Promise<GetBlockHeaderStateResponse>

get_currency_balance

Parameters

contract: NameType

accountName: NameType

Optional symbol: string

Returns Promise<Asset[]>

get_info

Returns Promise<GetInfoResponse>

get_producer_schedule

Returns Promise<GetProducerScheduleResponse>

get_raw_abi

Parameters

accountName: NameType

Returns Promise<GetRawAbiResponse>

get_table_by_scope

Parameters

params: GetTableByScopeParams

Returns Promise<GetTableByScopeResponse>

get_table_rows

Type Parameters

Index extends TableIndexType = Name

Parameters

params: GetTableRowsParams<Index>

Returns Promise<GetTableRowsResponse<Index, any>>

Type Parameters

Key extends keyof TableIndexTypes

Parameters

params: GetTableRowsParamsKeyed<TableIndexTypes[Key], Key>

Returns Promise<GetTableRowsResponse<TableIndexTypes[Key], any>>

Type Parameters

Row extends ABISerializableConstructor

Index extends TableIndexType = Name

Parameters

params: GetTableRowsParamsTyped<Index, Row>

Returns Promise<GetTableRowsResponse<Index, 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>>>

`Optional` params: GetProtocolFeaturesParams

block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
blockNum: UInt32Type;
checksum: Checksum256Type;
}

block_num_or_id: string | number | ArrayBuffer | ArrayBufferView | ArrayLike<number> | Bytes | UInt32 | Int | BN | BlockId | {
blockNum: UInt32Type;
checksum: Checksum256Type;
}

`Optional` symbol: string

`Optional` options: SendTransaction2Options