@wharfkit/session - v4.0.1
Preparing search index...
ChainAPI
Class ChainAPI
Index
Constructors
constructor
Methods
compute_
transaction
get_
abi
get_
account
get_
accounts_
by_
authorizers
get_
activated_
protocol_
features
get_
block
get_
block_
header_
state
get_
block_
info
get_
code
get_
currency_
balance
get_
currency_
stats
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
Methods
compute_
transaction
compute_transaction
(
tx
:
SignedTransactionType
|
PackedTransaction
,
)
:
Promise
<
SendTransactionResponse
>
Parameters
tx
:
SignedTransactionType
|
PackedTransaction
Returns
Promise
<
SendTransactionResponse
>
get_
abi
get_abi
(
accountName
:
NameType
)
:
Promise
<
GetAbiResponse
>
Parameters
accountName
:
NameType
Returns
Promise
<
GetAbiResponse
>
get_
account
get_account
(
accountName
:
NameType
,
responseType
?:
typeof
AccountObject
,
)
:
Promise
<
AccountObject
>
Parameters
accountName
:
NameType
Optional
responseType
:
typeof
AccountObject
Returns
Promise
<
AccountObject
>
get_
accounts_
by_
authorizers
get_accounts_by_authorizers
(
params
:
GetAccountsByAuthorizersParams
,
)
:
Promise
<
AccountsByAuthorizers
>
Parameters
params
:
GetAccountsByAuthorizersParams
Returns
Promise
<
AccountsByAuthorizers
>
get_
activated_
protocol_
features
get_activated_protocol_features
(
params
?:
GetProtocolFeaturesParams
,
)
:
Promise
<
GetProtocolFeaturesResponse
>
Parameters
Optional
params
:
GetProtocolFeaturesParams
Returns
Promise
<
GetProtocolFeaturesResponse
>
get_
block
get_block
(
block_num_or_id
:
|
string
|
number
|
Bytes
|
ArrayBufferView
<
ArrayBufferLike
>
|
ArrayBuffer
|
ArrayLike
<
number
>
|
Int
|
BN
|
UInt32
|
BlockId
|
{
blockNum
:
UInt32Type
;
checksum
:
Checksum256Type
}
,
)
:
Promise
<
GetBlockResponse
>
Parameters
block_num_or_id
:
|
string
|
number
|
Bytes
|
ArrayBufferView
<
ArrayBufferLike
>
|
ArrayBuffer
|
ArrayLike
<
number
>
|
Int
|
BN
|
UInt32
|
BlockId
|
{
blockNum
:
UInt32Type
;
checksum
:
Checksum256Type
}
Returns
Promise
<
GetBlockResponse
>
get_
block_
header_
state
get_block_header_state
(
block_num_or_id
:
|
string
|
number
|
Bytes
|
ArrayBufferView
<
ArrayBufferLike
>
|
ArrayBuffer
|
ArrayLike
<
number
>
|
Int
|
BN
|
UInt32
|
BlockId
|
{
blockNum
:
UInt32Type
;
checksum
:
Checksum256Type
}
,
)
:
Promise
<
GetBlockHeaderStateResponse
>
Parameters
block_num_or_id
:
|
string
|
number
|
Bytes
|
ArrayBufferView
<
ArrayBufferLike
>
|
ArrayBuffer
|
ArrayLike
<
number
>
|
Int
|
BN
|
UInt32
|
BlockId
|
{
blockNum
:
UInt32Type
;
checksum
:
Checksum256Type
}
Returns
Promise
<
GetBlockHeaderStateResponse
>
get_
block_
info
get_block_info
(
block_num
:
UInt32Type
)
:
Promise
<
GetBlockInfoResponse
>
Parameters
block_num
:
UInt32Type
Returns
Promise
<
GetBlockInfoResponse
>
get_
code
get_code
(
accountName
:
NameType
)
:
Promise
<
GetCodeResponse
>
Parameters
accountName
:
NameType
Returns
Promise
<
GetCodeResponse
>
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
[]
>
get_
currency_
stats
get_currency_stats
(
contract
:
NameType
,
symbol
:
string
,
)
:
Promise
<
GetCurrencyStatsResponse
>
Parameters
contract
:
NameType
symbol
:
string
Returns
Promise
<
GetCurrencyStatsResponse
>
get_
info
get_info
()
:
Promise
<
GetInfoResponse
>
Returns
Promise
<
GetInfoResponse
>
get_
producer_
schedule
get_producer_schedule
()
:
Promise
<
GetProducerScheduleResponse
>
Returns
Promise
<
GetProducerScheduleResponse
>
get_
raw_
abi
get_raw_abi
(
accountName
:
NameType
)
:
Promise
<
GetRawAbiResponse
>
Parameters
accountName
:
NameType
Returns
Promise
<
GetRawAbiResponse
>
get_
table_
by_
scope
get_table_by_scope
(
params
:
GetTableByScopeParams
,
)
:
Promise
<
GetTableByScopeResponse
>
Parameters
params
:
GetTableByScopeParams
Returns
Promise
<
GetTableByScopeResponse
>
get_
table_
rows
get_table_rows
<
Index
extends
TableIndexType
=
Name
>
(
params
:
GetTableRowsParams
<
Index
>
,
)
:
Promise
<
GetTableRowsResponse
<
Index
,
any
>
>
Type Parameters
Index
extends
TableIndexType
=
Name
Parameters
params
:
GetTableRowsParams
<
Index
>
Returns
Promise
<
GetTableRowsResponse
<
Index
,
any
>
>
get_table_rows
<
Key
extends
keyof
TableIndexTypes
>
(
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
>
>
get_table_rows
<
Row
extends
ABISerializableConstructor
,
Index
extends
TableIndexType
=
Name
,
>
(
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
>
>
>
get_table_rows
<
Row
extends
ABISerializableConstructor
,
Key
extends
keyof
TableIndexTypes
,
>
(
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
>
>
>
get_
transaction_
status
get_transaction_status
(
id
:
Checksum256Type
,
)
:
Promise
<
GetTransactionStatusResponse
>
Parameters
id
:
Checksum256Type
Returns
Promise
<
GetTransactionStatusResponse
>
push_
transaction
push_transaction
(
tx
:
SignedTransactionType
|
PackedTransaction
,
)
:
Promise
<
PushTransactionResponse
>
Parameters
tx
:
SignedTransactionType
|
PackedTransaction
Returns
Promise
<
PushTransactionResponse
>
send_
read_
only_
transaction
send_read_only_transaction
(
tx
:
SignedTransactionType
|
PackedTransaction
,
)
:
Promise
<
SendTransactionResponse
>
Parameters
tx
:
SignedTransactionType
|
PackedTransaction
Returns
Promise
<
SendTransactionResponse
>
send_
transaction
send_transaction
(
tx
:
SignedTransactionType
|
PackedTransaction
,
)
:
Promise
<
SendTransactionResponse
>
Parameters
tx
:
SignedTransactionType
|
PackedTransaction
Returns
Promise
<
SendTransactionResponse
>
send_
transaction2
send_transaction2
(
tx
:
SignedTransactionType
|
PackedTransaction
,
options
?:
API
.
v1
.
SendTransaction2Options
,
)
:
Promise
<
SendTransaction2Response
>
Parameters
tx
:
SignedTransactionType
|
PackedTransaction
Optional
options
:
API
.
v1
.
SendTransaction2Options
Returns
Promise
<
SendTransaction2Response
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
compute_
transaction
get_
abi
get_
account
get_
accounts_
by_
authorizers
get_
activated_
protocol_
features
get_
block
get_
block_
header_
state
get_
block_
info
get_
code
get_
currency_
balance
get_
currency_
stats
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
@wharfkit/session - v4.0.1
Loading...