Class TokenFetcher

Describes an entity with the ability to query token information related to Erdstall and its onchain contracts.

Hierarchy

TokenFetcher

Implements

TokenProvider

Index

Constructors

constructor

new TokenFetcher(): TokenFetcher
Returns TokenFetcher
- Defined in src/ledger/backend/tokencache.ts:104

Properties

`Private` `Optional` bigbang

bigbang?: number

`Readonly` holderCache

holderCache: TokenHolders

`Readonly` typeCache

typeCache: TokenTypes

Methods

findRegisteredTokenWithSymbol

findRegisteredTokenWithSymbol(erdstall: Erdstall, symbol: string, fromBlock?: number): Promise<undefined | Address>
Finds the address of the first registered token contract in Erdstall, which has the given symbol as its symbol according to the ERC20Detailed specification.

Returns
The address when a token contract matching the symbol could be found, otherwise undefined.

Remarks
ERC20Detailed
Parameters
- erdstall: Erdstall
  
  The Erdstall contract.
- symbol: string
  
  The symbol to search for.
- Optional fromBlock: number
  
  When omitted the starting block from when the Erdstall contract was deployed will be used.
Returns Promise<undefined | Address>
Implementation of TokenProvider.findRegisteredTokenWithSymbol
- Defined in src/ledger/backend/tokencache.ts:161

queryRegisteredTokenTypes

queryRegisteredTokenTypes(erdstall: Erdstall, fromBlock?: number): Promise<TokenTypeRegistered[]>
Queries the registered token types on the given Erdstall contract.

Returns
A list of TokenTypeRegistered events, which might be empty if no token types were registered.
Parameters
- erdstall: Erdstall
  
  The Erdstall contract.
- Optional fromBlock: number
  
  When omitted the starting block from when the Erdstall contract was deployed will be used.
Returns Promise<TokenTypeRegistered[]>
Implementation of TokenProvider.queryRegisteredTokenTypes
- Defined in src/ledger/backend/tokencache.ts:193

queryRegisteredTokens

queryRegisteredTokens(erdstall: Erdstall, fromBlock?: number): Promise<TokenRegistered[]>
Queries the registered tokens on the given Erdstall contract.

Returns
A list of TokenRegistered events, which might be empty if no tokens were registered.
Parameters
- erdstall: Erdstall
  
  The Erdstall contract.
- Optional fromBlock: number
  
  When omitted the starting block from when the Erdstall contract was deployed will be used.
Returns Promise<TokenRegistered[]>
Implementation of TokenProvider.queryRegisteredTokens
- Defined in src/ledger/backend/tokencache.ts:221

queryTokenType

queryTokenType(erdstall: Erdstall, tokenAddr: string): Promise<undefined | "ETH" | "ERC20" | "ERC721" | "ERC721Mintable">
Parameters
- erdstall: Erdstall
- tokenAddr: string
Returns Promise<undefined | "ETH" | "ERC20" | "ERC721" | "ERC721Mintable">
- Defined in src/ledger/backend/tokencache.ts:152

resolveTokenType

resolveTokenType(signer: Signer, ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable", token: string | Address): Responder
Parameters
- signer: Signer
- ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"
- token: string | Address
Returns Responder
- Defined in src/ledger/backend/tokencache.ts:253

setType

setType(tokenAddr: string, ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"): void
Sets the locally cached token type for the given token address.
Parameters
- tokenAddr: string
  
  The address of the token to update.
- ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"
  
  The token type.
Returns void
Implementation of TokenProvider.setType
- Defined in src/ledger/backend/tokencache.ts:110

tokenHolderFor

tokenHolderFor(erdstall: Erdstall, ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"): Promise<string>
Retrieves the address of the token holder contract for the given token type related to the given Erdstall contract.

Throws
An error when no token holder contract is registered for the given token type.

Returns
The address of the holder contract in string representation.
Parameters
- erdstall: Erdstall
  
  The Erdstall contract.
- ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"
  
  The token type which is handled by some holder contract.
Returns Promise<string>
Implementation of TokenProvider.tokenHolderFor
- Defined in src/ledger/backend/tokencache.ts:114

tokenTypeOf

tokenTypeOf(erdstall: Erdstall, tokenAddr: string): Promise<"ETH" | "ERC20" | "ERC721" | "ERC721Mintable">
Retrieves the token type for a given token address related to the given Erdstall contract.

Throws
An error when the given token address is not registered with the Erdstall contract.

Returns
The token type of the given token address.
Parameters
- erdstall: Erdstall
  
  The Erdstall contract.
- tokenAddr: string
  
  The address of a token contract.
Returns Promise<"ETH" | "ERC20" | "ERC721" | "ERC721Mintable">
Implementation of TokenProvider.tokenTypeOf
- Defined in src/ledger/backend/tokencache.ts:132

Class TokenFetcher

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TokenFetcher

Properties

Private Optional bigbang

Readonly holderCache

Readonly typeCache

Methods

findRegisteredTokenWithSymbol

Returns

Remarks

Parameters

erdstall: Erdstall

symbol: string

Optional fromBlock: number

Returns Promise<undefined | Address>

queryRegisteredTokenTypes

Returns

Parameters

erdstall: Erdstall

Optional fromBlock: number

Returns Promise<TokenTypeRegistered[]>

queryRegisteredTokens

Returns

Parameters

erdstall: Erdstall

Optional fromBlock: number

Returns Promise<TokenRegistered[]>

queryTokenType

Parameters

erdstall: Erdstall

tokenAddr: string

Returns Promise<undefined | "ETH" | "ERC20" | "ERC721" | "ERC721Mintable">

resolveTokenType

Parameters

signer: Signer

ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"

token: string | Address

Returns Responder

setType

Parameters

tokenAddr: string

ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"

Returns void

tokenHolderFor

Throws

Returns

Parameters

erdstall: Erdstall

ttype: "ETH" | "ERC20" | "ERC721" | "ERC721Mintable"

Returns Promise<string>

tokenTypeOf

Throws

Returns

Parameters

erdstall: Erdstall

tokenAddr: string

Returns Promise<"ETH" | "ERC20" | "ERC721" | "ERC721Mintable">

Settings

Member Visibility

Theme

`Private` `Optional` bigbang

`Readonly` holderCache

`Readonly` typeCache

`Optional` fromBlock: number

`Optional` fromBlock: number

`Optional` fromBlock: number