Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Address
Identifier Filter This is the container for the unique public address on the blockchain.
- Asset
Contract This container contains information about an contract.
- Batch
GetToken Balance Error Item Error generated from a failed
BatchGetTokenBalance
request.- Batch
GetToken Balance Input Item The container for the input for getting a token balance.
- Batch
GetToken Balance Output Item The container for the properties of a token balance output.
- Blockchain
Instant The container for time.
- Confirmation
Status Filter The container for the
ConfirmationStatusFilter
that filters for the finality of the results.- Contract
Filter The contract or wallet address by which to filter the request.
- Contract
Identifier Container for the blockchain address and network information about a contract.
- Contract
Metadata The metadata of the contract.
- List
Filtered Transaction Events Sort Lists all the transaction events for an address on the blockchain.
This operation is only supported on the Bitcoin blockchain networks.
- List
Transactions Sort The container for determining how the list transaction result will be sorted.
- Owner
Filter The container for the owner information to filter by.
- Owner
Identifier The container for the owner identifier.
- Time
Filter This container is used to specify a time frame.
- Token
Balance The balance of the token.
- Token
Filter The container of the token filter like the contract address on a given blockchain network or a unique token identifier on a given blockchain network.
You must always specify the network property of this container when using this operation.
- Token
Identifier The container for the identifier for the token including the unique token ID and its blockchain network.
Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
- Transaction
There are two possible types of transactions used for this data type:
-
A Bitcoin transaction is a movement of BTC from one address to another.
-
An Ethereum transaction refers to an action initiated by an externally owned account, which is an account managed by a human, not a contract. For example, if Bob sends Alice 1 ETH, Bob's account must be debited and Alice's must be credited. This state-changing action occurs within a transaction.
-
- Transaction
Event The container for the properties of a transaction event.
- Transaction
Output Item The container of the transaction output.
- Validation
Exception Field The resource passed is invalid.
- Vout
Filter This container specifies filtering attributes related to
BITCOIN_VOUT
event types
Enums§
- Confirmation
Status - When writing a match expression against
ConfirmationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Error
Type - When writing a match expression against
ErrorType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Status - When writing a match expression against
ExecutionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Filtered Transaction Events Sort By - When writing a match expression against
ListFilteredTransactionEventsSortBy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Transactions Sort By - When writing a match expression against
ListTransactionsSortBy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Query
Network - When writing a match expression against
QueryNetwork
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Query
Token Standard - When writing a match expression against
QueryTokenStandard
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Query
Transaction Event Type - When writing a match expression against
QueryTransactionEventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Resource
Type - When writing a match expression against
ResourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Sort
Order - When writing a match expression against
SortOrder
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Validation
Exception Reason - When writing a match expression against
ValidationExceptionReason
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.