Interface TokenProviderAdapter

Hierarchy

TokenProviderAdapter

Implemented by

EthereumProviderAdapter

Index

Methods

getAllAssetTransfersIterator getAllTokenBalances getAssetTransfers getAssetTransfersIterator getContractTokenBalances getContractTokenMetadata getNativeTokenBalance getNativeTokenMetadata getTokenBalances getTokenMetadata

Methods

getAllAssetTransfersIterator

getAllAssetTransfersIterator(address: string, tokenType?: TokenType[], options?: GetAssetTransfersIteratorOptions): AsyncGenerator<AssetTransfer, any, unknown>
Get a iterators of all transfer transactions from given tokens.
Parameters
- address: string
- Optional tokenType: TokenType[]
- Optional options: GetAssetTransfersIteratorOptions
Returns AsyncGenerator<AssetTransfer, any, unknown>
- Defined in walletkit/src/adapter/types.ts:145

getAllTokenBalances

getAllTokenBalances(ownerAddress: string, filter?: GetAllTokenBalancesFilter): Promise<TokenBalance[]>
Get token balances associated with the owner address by applying the passing filter.

If no filter specified, this function will return by combining the result of getNativeTokenBalance and getContractTokenBalances.
Parameters
- ownerAddress: string
- Optional filter: GetAllTokenBalancesFilter
Returns Promise<TokenBalance[]>
- Defined in walletkit/src/adapter/types.ts:95

getAssetTransfers

getAssetTransfers(address: string, tokenType?: TokenType, contractAddress?: string): Promise<AssetTransfer[]>
Get a list of transfer transactions.
Parameters
- address: string
- Optional tokenType: TokenType
- Optional contractAddress: string
Returns Promise<AssetTransfer[]>
- Defined in walletkit/src/adapter/types.ts:129

getAssetTransfersIterator

getAssetTransfersIterator(address: string, token?: FungibleToken, options?: GetAssetTransfersIteratorOptions): AsyncGenerator<AssetTransfer, any, unknown>
Get a iterator of transfer transactions.
Parameters
- address: string
- Optional token: FungibleToken
- Optional options: GetAssetTransfersIteratorOptions
Returns AsyncGenerator<AssetTransfer, any, unknown>
- Defined in walletkit/src/adapter/types.ts:137

getContractTokenBalances

getContractTokenBalances(ownerAddress: string, contractAddresses?: string[]): Promise<ContractTokenBalance[]>
Get the contract token balances associated with the owner address.

If contractAddresses is not specified, this function will return a list of balances of known tokens for the owner address. The behavior for which token is known is chain-specific.
Parameters
- ownerAddress: string
- Optional contractAddresses: string[]
Returns Promise<ContractTokenBalance[]>
- Defined in walletkit/src/adapter/types.ts:85

getContractTokenMetadata

getContractTokenMetadata(contractAddress: string): Promise<ContractTokenMetadata>
Get the metadata of the contract token for a contract
Parameters
- contractAddress: string
Returns Promise<ContractTokenMetadata>
- Defined in walletkit/src/adapter/types.ts:113

getNativeTokenBalance

getNativeTokenBalance(ownerAddress: string): Promise<NativeTokenBalance>
Get the balance of the chain native token held by the owner.
Parameters
- ownerAddress: string
Returns Promise<NativeTokenBalance>
- Defined in walletkit/src/adapter/types.ts:77

getNativeTokenMetadata

getNativeTokenMetadata(): Promise<NativeTokenMetadata>
Get the metadata of the native token.

Returns Promise<NativeTokenMetadata>
- Defined in walletkit/src/adapter/types.ts:109

getTokenBalances

getTokenBalances(ownerAddress: string, tokens: FungibleToken[]): Promise<TokenBalance[]>
Returns balances of the tokens in the argument held by the owner.
Parameters
- ownerAddress: string
- tokens: FungibleToken[]
Returns Promise<TokenBalance[]>
- Defined in walletkit/src/adapter/types.ts:102

getTokenMetadata

getTokenMetadata(__namedParameters: {
contractAddress?: string;
type: TokenType;
}): Promise<TokenMetadata>
Get the metadata of a token.
Parameters
- __namedParameters: {
  contractAddress?: string;
  type: TokenType;
  }
  - Optional contractAddress?: string
  - type: TokenType
Returns Promise<TokenMetadata>
- Defined in walletkit/src/adapter/types.ts:119

Interface TokenProviderAdapter

Hierarchy

Implemented by

Index

Methods

Methods

getAllAssetTransfersIterator

Parameters

address: string

Optional tokenType: TokenType[]

Optional options: GetAssetTransfersIteratorOptions

Returns AsyncGenerator<AssetTransfer, any, unknown>

getAllTokenBalances

Parameters

ownerAddress: string

Optional filter: GetAllTokenBalancesFilter

Returns Promise<TokenBalance[]>

getAssetTransfers

Parameters

address: string

Optional tokenType: TokenType

Optional contractAddress: string

Returns Promise<AssetTransfer[]>

getAssetTransfersIterator

Parameters

address: string

Optional token: FungibleToken

Optional options: GetAssetTransfersIteratorOptions

Returns AsyncGenerator<AssetTransfer, any, unknown>

getContractTokenBalances

Parameters

ownerAddress: string

Optional contractAddresses: string[]

Returns Promise<ContractTokenBalance[]>

getContractTokenMetadata

Parameters

contractAddress: string

Returns Promise<ContractTokenMetadata>

getNativeTokenBalance

Parameters

ownerAddress: string

Returns Promise<NativeTokenBalance>

getNativeTokenMetadata

Returns Promise<NativeTokenMetadata>

getTokenBalances

Parameters

ownerAddress: string

tokens: FungibleToken[]

Returns Promise<TokenBalance[]>

getTokenMetadata

Parameters

__namedParameters: { contractAddress?: string; type: TokenType; }

Optional contractAddress?: string

type: TokenType

Returns Promise<TokenMetadata>

Settings

Member Visibility

Theme

`Optional` tokenType: TokenType[]

`Optional` options: GetAssetTransfersIteratorOptions

`Optional` filter: GetAllTokenBalancesFilter

`Optional` tokenType: TokenType

`Optional` contractAddress: string

`Optional` token: FungibleToken

`Optional` options: GetAssetTransfersIteratorOptions

`Optional` contractAddresses: string[]

__namedParameters: {
contractAddress?: string;
type: TokenType;
}

`Optional` contractAddress?: string