types

package
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Amazon Web Services account doesn’t have access to this resource.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AddressIdentifierFilter

type AddressIdentifierFilter struct {

	// The container for the recipient address of the transaction.
	//
	// This member is required.
	TransactionEventToAddress []string
	// contains filtered or unexported fields
}

This is the container for the unique public address on the blockchain.

type AssetContract

type AssetContract struct {

	// The container for the contract identifier containing its blockchain network and
	// address.
	//
	// This member is required.
	ContractIdentifier *ContractIdentifier

	// The address of the contract deployer.
	//
	// This member is required.
	DeployerAddress *string

	// The token standard of the contract.
	//
	// This member is required.
	TokenStandard QueryTokenStandard
	// contains filtered or unexported fields
}

This container contains information about an contract.

type BatchGetTokenBalanceErrorItem

type BatchGetTokenBalanceErrorItem struct {

	// The error code associated with the error.
	//
	// This member is required.
	ErrorCode *string

	// The message associated with the error.
	//
	// This member is required.
	ErrorMessage *string

	// The type of error.
	//
	// This member is required.
	ErrorType ErrorType

	// The container for time.
	AtBlockchainInstant *BlockchainInstant

	// The container for the owner identifier.
	OwnerIdentifier *OwnerIdentifier

	// 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.
	TokenIdentifier *TokenIdentifier
	// contains filtered or unexported fields
}

Error generated from a failed BatchGetTokenBalance request.

type BatchGetTokenBalanceInputItem

type BatchGetTokenBalanceInputItem struct {

	// The container for the owner identifier.
	//
	// This member is required.
	OwnerIdentifier *OwnerIdentifier

	// 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.
	//
	// This member is required.
	TokenIdentifier *TokenIdentifier

	// The container for time.
	AtBlockchainInstant *BlockchainInstant
	// contains filtered or unexported fields
}

The container for the input for getting a token balance.

type BatchGetTokenBalanceOutputItem

type BatchGetTokenBalanceOutputItem struct {

	// The container for time.
	//
	// This member is required.
	AtBlockchainInstant *BlockchainInstant

	// The container for the token balance.
	//
	// This member is required.
	Balance *string

	// The container for time.
	LastUpdatedTime *BlockchainInstant

	// The container for the owner identifier.
	OwnerIdentifier *OwnerIdentifier

	// 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.
	TokenIdentifier *TokenIdentifier
	// contains filtered or unexported fields
}

The container for the properties of a token balance output.

type BlockchainInstant

type BlockchainInstant struct {

	// The container of the Timestamp of the blockchain instant.
	//
	// This timestamp will only be recorded up to the second.
	Time *time.Time
	// contains filtered or unexported fields
}

The container for time.

type ConfirmationStatus

type ConfirmationStatus string
const (
	ConfirmationStatusFinal    ConfirmationStatus = "FINAL"
	ConfirmationStatusNonfinal ConfirmationStatus = "NONFINAL"
)

Enum values for ConfirmationStatus

func (ConfirmationStatus) Values

Values returns all known values for ConfirmationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfirmationStatusFilter

type ConfirmationStatusFilter struct {

	// The container to determine whether to list results that have only reached [finality].
	// Transactions that have reached finality are always part of the response.
	//
	// [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality
	//
	// This member is required.
	Include []ConfirmationStatus
	// contains filtered or unexported fields
}

The container for the ConfirmationStatusFilter that filters for the finality of the results.

type ContractFilter

type ContractFilter struct {

	// The network address of the deployer.
	//
	// This member is required.
	DeployerAddress *string

	// The blockchain network of the contract.
	//
	// This member is required.
	Network QueryNetwork

	// The container for the token standard.
	//
	// This member is required.
	TokenStandard QueryTokenStandard
	// contains filtered or unexported fields
}

The contract or wallet address by which to filter the request.

type ContractIdentifier

type ContractIdentifier struct {

	// Container for the blockchain address about a contract.
	//
	// This member is required.
	ContractAddress *string

	// The blockchain network of the contract.
	//
	// This member is required.
	Network QueryNetwork
	// contains filtered or unexported fields
}

Container for the blockchain address and network information about a contract.

type ContractMetadata

type ContractMetadata struct {

	// The decimals used by the token contract.
	Decimals *int32

	// The name of the token contract.
	Name *string

	// The symbol of the token contract.
	Symbol *string
	// contains filtered or unexported fields
}

The metadata of the contract.

type ErrorType

type ErrorType string
const (
	// An API request validation exception
	ErrorTypeValidationException ErrorType = "VALIDATION_EXCEPTION"
	// An API request retrieving an item that can't be found
	ErrorTypeResourceNotFoundException ErrorType = "RESOURCE_NOT_FOUND_EXCEPTION"
)

Enum values for ErrorType

func (ErrorType) Values

func (ErrorType) Values() []ErrorType

Values returns all known values for ErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionStatus

type ExecutionStatus string
const (
	ExecutionStatusFailed    ExecutionStatus = "FAILED"
	ExecutionStatusSucceeded ExecutionStatus = "SUCCEEDED"
)

Enum values for ExecutionStatus

func (ExecutionStatus) Values

func (ExecutionStatus) Values() []ExecutionStatus

Values returns all known values for ExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request processing has failed because of an internal error in the service.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type ListFilteredTransactionEventsSort

type ListFilteredTransactionEventsSort struct {

	// Container on how the results will be sorted by?
	SortBy ListFilteredTransactionEventsSortBy

	// The container for the sort order for ListFilteredTransactionEvents . The
	// SortOrder field only accepts the values ASCENDING and DESCENDING . Not providing
	// SortOrder will default to ASCENDING .
	SortOrder SortOrder
	// contains filtered or unexported fields
}

Lists all the transaction events for an address on the blockchain.

This operation is only supported on the Bitcoin blockchain networks.

type ListFilteredTransactionEventsSortBy

type ListFilteredTransactionEventsSortBy string
const (
	// Timestamp of a transaction
	ListFilteredTransactionEventsSortByBlockchainInstant ListFilteredTransactionEventsSortBy = "blockchainInstant"
)

Enum values for ListFilteredTransactionEventsSortBy

func (ListFilteredTransactionEventsSortBy) Values

Values returns all known values for ListFilteredTransactionEventsSortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListTransactionsSort

type ListTransactionsSort struct {

	// Defaults to the value TRANSACTION_TIMESTAMP .
	SortBy ListTransactionsSortBy

	// The container for the sort order for ListTransactions . The SortOrder field
	// only accepts the values ASCENDING and DESCENDING . Not providing SortOrder will
	// default to ASCENDING .
	SortOrder SortOrder
	// contains filtered or unexported fields
}

The container for determining how the list transaction result will be sorted.

type ListTransactionsSortBy

type ListTransactionsSortBy string
const (
	// Timestamp of a transaction
	ListTransactionsSortByTransactionTimestamp ListTransactionsSortBy = "TRANSACTION_TIMESTAMP"
)

Enum values for ListTransactionsSortBy

func (ListTransactionsSortBy) Values

Values returns all known values for ListTransactionsSortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OwnerFilter

type OwnerFilter struct {

	// The contract or wallet address.
	//
	// This member is required.
	Address *string
	// contains filtered or unexported fields
}

The container for the owner information to filter by.

type OwnerIdentifier

type OwnerIdentifier struct {

	// The contract or wallet address for the owner.
	//
	// This member is required.
	Address *string
	// contains filtered or unexported fields
}

The container for the owner identifier.

type QueryNetwork

type QueryNetwork string
const (
	// Ethereum main network
	QueryNetworkEthereumMainnet QueryNetwork = "ETHEREUM_MAINNET"
	// SEPOLIA network (ethereum testnet)
	QueryNetworkEthereumSepoliaTestnet QueryNetwork = "ETHEREUM_SEPOLIA_TESTNET"
	// Bitcoin main network
	QueryNetworkBitcoinMainnet QueryNetwork = "BITCOIN_MAINNET"
	// Bitcoin test network
	QueryNetworkBitcoinTestnet QueryNetwork = "BITCOIN_TESTNET"
)

Enum values for QueryNetwork

func (QueryNetwork) Values

func (QueryNetwork) Values() []QueryNetwork

Values returns all known values for QueryNetwork. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryTokenStandard

type QueryTokenStandard string
const (
	QueryTokenStandardErc20   QueryTokenStandard = "ERC20"
	QueryTokenStandardErc721  QueryTokenStandard = "ERC721"
	QueryTokenStandardErc1155 QueryTokenStandard = "ERC1155"
)

Enum values for QueryTokenStandard

func (QueryTokenStandard) Values

Values returns all known values for QueryTokenStandard. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryTransactionEventType

type QueryTransactionEventType string
const (
	// An ERC20 transfer type
	QueryTransactionEventTypeErc20Transfer QueryTransactionEventType = "ERC20_TRANSFER"
	// An ERC20_MINT transfer type
	QueryTransactionEventTypeErc20Mint QueryTransactionEventType = "ERC20_MINT"
	// An ERC20_BURN transfer type
	QueryTransactionEventTypeErc20Burn QueryTransactionEventType = "ERC20_BURN"
	// An ERC20_DEPOSIT transfer type
	QueryTransactionEventTypeErc20Deposit QueryTransactionEventType = "ERC20_DEPOSIT"
	// An ERC20_WITHDRAWAL transfer type
	QueryTransactionEventTypeErc20Withdrawal QueryTransactionEventType = "ERC20_WITHDRAWAL"
	// An ERC721 transfer type
	QueryTransactionEventTypeErc721Transfer QueryTransactionEventType = "ERC721_TRANSFER"
	// An ERC1155 transfer type
	QueryTransactionEventTypeErc1155Transfer QueryTransactionEventType = "ERC1155_TRANSFER"
	// A Bitcoin Vin transfer type
	QueryTransactionEventTypeBitcoinVin QueryTransactionEventType = "BITCOIN_VIN"
	// A Bitcoin Vout transfer type
	QueryTransactionEventTypeBitcoinVout QueryTransactionEventType = "BITCOIN_VOUT"
	// An internal ETH transfer type
	QueryTransactionEventTypeInternalEthTransfer QueryTransactionEventType = "INTERNAL_ETH_TRANSFER"
	// An ETH transfer type
	QueryTransactionEventTypeEthTransfer QueryTransactionEventType = "ETH_TRANSFER"
)

Enum values for QueryTransactionEventType

func (QueryTransactionEventType) Values

Values returns all known values for QueryTransactionEventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	// contains filtered or unexported fields
}

The resource was not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType

type ResourceType string
const (
	ResourceTypeCollection ResourceType = "collection"
)

Enum values for ResourceType

func (ResourceType) Values

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

The service quota has been exceeded for this resource.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortOrder

type SortOrder string
const (
	// Result sorted in ascending order
	SortOrderAscending SortOrder = "ASCENDING"
	// Result sorted in descending order
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is when you create resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources, if possible.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TimeFilter

type TimeFilter struct {

	// The container for time.
	From *BlockchainInstant

	// The container for time.
	To *BlockchainInstant
	// contains filtered or unexported fields
}

This container is used to specify a time frame.

type TokenBalance

type TokenBalance struct {

	// The time for when the TokenBalance is requested or the current time if a time
	// is not provided in the request.
	//
	// This time will only be recorded up to the second.
	//
	// This member is required.
	AtBlockchainInstant *BlockchainInstant

	// The container of the token balance.
	//
	// This member is required.
	Balance *string

	// The Timestamp of the last transaction at which the balance for the token in the
	// wallet was updated.
	LastUpdatedTime *BlockchainInstant

	// The container for the identifier of the owner.
	OwnerIdentifier *OwnerIdentifier

	// The identifier for the token, including the unique token ID and its blockchain
	// network.
	TokenIdentifier *TokenIdentifier
	// contains filtered or unexported fields
}

The balance of the token.

type TokenFilter

type TokenFilter struct {

	// The blockchain network of the token.
	//
	// This member is required.
	Network QueryNetwork

	// This is the address of the contract.
	ContractAddress *string

	// The unique identifier of the token.
	TokenId *string
	// contains filtered or unexported fields
}

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.

type TokenIdentifier

type TokenIdentifier struct {

	// The blockchain network of the token.
	//
	// This member is required.
	Network QueryNetwork

	// This is the token's contract address.
	ContractAddress *string

	// The unique identifier of the token.
	//
	// For native tokens, use the 3 character abbreviation that best matches your
	// token. For example, btc for Bitcoin, eth for Ether, etc. For all other token
	// types you must specify the tokenId in the 64 character hexadecimal tokenid
	// format.
	TokenId *string
	// contains filtered or unexported fields
}

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.

type Transaction

type Transaction struct {

	// The blockchain network where the transaction occurred.
	//
	// This member is required.
	Network QueryNetwork

	// The number of transactions in the block.
	//
	// This member is required.
	NumberOfTransactions *int64

	// The identifier of the transaction. It is generated whenever a transaction is
	// verified and added to the blockchain.
	//
	// This member is required.
	To *string

	// The hash of a transaction. It is generated when a transaction is created.
	//
	// This member is required.
	TransactionHash *string

	// The index of the transaction within a blockchain.
	//
	// This member is required.
	TransactionIndex *int64

	// The Timestamp of the transaction.
	//
	// This member is required.
	TransactionTimestamp *time.Time

	// The block hash is a unique identifier for a block. It is a fixed-size string
	// that is calculated by using the information in the block. The block hash is used
	// to verify the integrity of the data in the block.
	BlockHash *string

	// The block number in which the transaction is recorded.
	BlockNumber *string

	// Specifies whether the transaction has reached Finality.
	ConfirmationStatus ConfirmationStatus

	// The blockchain address for the contract.
	ContractAddress *string

	// The amount of gas used up to the specified point in the block.
	CumulativeGasUsed *string

	// The effective gas price.
	EffectiveGasPrice *string

	// Identifies whether the transaction has succeeded or failed.
	ExecutionStatus ExecutionStatus

	// The initiator of the transaction. It is either in the form a public key or a
	// contract address.
	From *string

	// The amount of gas used for the transaction.
	GasUsed *string

	// The signature of the transaction. The X coordinate of a point R.
	SignatureR *string

	// The signature of the transaction. The Y coordinate of a point S.
	SignatureS *string

	// The signature of the transaction. The Z coordinate of a point V.
	SignatureV *int32

	// The transaction fee.
	TransactionFee *string

	// The identifier of a Bitcoin transaction. It is generated when a transaction is
	// created.
	TransactionId *string
	// contains filtered or unexported fields
}

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.

type TransactionEvent

type TransactionEvent struct {

	// The type of transaction event.
	//
	// This member is required.
	EventType QueryTransactionEventType

	// The blockchain network where the transaction occurred.
	//
	// This member is required.
	Network QueryNetwork

	// The hash of a transaction. It is generated when a transaction is created.
	//
	// This member is required.
	TransactionHash *string

	// The container for time.
	BlockchainInstant *BlockchainInstant

	// This container specifies whether the transaction has reached Finality.
	ConfirmationStatus ConfirmationStatus

	// The blockchain address for the contract
	ContractAddress *string

	// The wallet address initiating the transaction. It can either be a public key or
	// a contract.
	From *string

	// The position of the spent transaction output in the output list of the creating
	// transaction.
	//
	// This is only returned for BITCOIN_VIN event types.
	SpentVoutIndex *int32

	// The transactionHash that created the spent transaction output.
	//
	// This is only returned for BITCOIN_VIN event types.
	SpentVoutTransactionHash *string

	// The transactionId that created the spent transaction output.
	//
	// This is only returned for BITCOIN_VIN event types.
	SpentVoutTransactionId *string

	// The wallet address receiving the transaction. It can either be a public key or
	// a contract.
	To *string

	// The unique identifier for the token involved in the transaction.
	TokenId *string

	// The identifier of a Bitcoin transaction. It is generated when a transaction is
	// created.
	TransactionId *string

	// The value that was transacted.
	Value *string

	// The position of the transaction output in the transaction output list.
	VoutIndex *int32

	// Specifies if the transaction output is spent or unspent. This is only returned
	// for BITCOIN_VOUT event types.
	//
	// This is only returned for BITCOIN_VOUT event types.
	VoutSpent *bool
	// contains filtered or unexported fields
}

The container for the properties of a transaction event.

type TransactionOutputItem

type TransactionOutputItem struct {

	// The blockchain network where the transaction occurred.
	//
	// This member is required.
	Network QueryNetwork

	// The hash of a transaction. It is generated when a transaction is created.
	//
	// This member is required.
	TransactionHash *string

	// The time when the transaction occurred.
	//
	// This member is required.
	TransactionTimestamp *time.Time

	// Specifies whether to list transactions that have not reached Finality.
	ConfirmationStatus ConfirmationStatus

	// The identifier of a Bitcoin transaction. It is generated when a transaction is
	// created.
	TransactionId *string
	// contains filtered or unexported fields
}

The container of the transaction output.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

The resource passed is invalid.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField

type ValidationExceptionField struct {

	// The ValidationException message.
	//
	// This member is required.
	Message *string

	// The name of the field that triggered the ValidationException .
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The resource passed is invalid.

type ValidationExceptionReason

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VoutFilter

type VoutFilter struct {

	// Specifies if the transaction output is spent or unspent.
	//
	// This member is required.
	VoutSpent *bool
	// contains filtered or unexported fields
}

This container specifies filtering attributes related to BITCOIN_VOUT event types

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL