Class LedgerReadConn

Hierarchy

LedgerReadConn
- LedgerWriteConn

Implements

LedgerReader

Index

Constructors

constructor

new LedgerReadConn(contract: Erdstall, tokenCache: TokenProvider): LedgerReadConn
Parameters
- contract: Erdstall
- tokenCache: TokenProvider
Returns LedgerReadConn
- Defined in src/ledger/backend/readconn.ts:31

Properties

`Readonly` contract

contract: Erdstall

`Private` eventCache

`Private` metadataCache

metadataCache: Map<string, NFTMetadata>

`Readonly` tokenCache

tokenCache: TokenProvider

Methods

erdstall

erdstall(): Address
Returns
The address of the onchain erdstall contract.

Returns Address
Implementation of LedgerReader.erdstall
- Defined in src/ledger/backend/readconn.ts:65

getNftMetadata

getNftMetadata(token: Address, id: bigint, useCache?: boolean): Promise<NFTMetadata>
Parameters
- token: Address
- id: bigint
- Optional useCache: boolean
Returns Promise<NFTMetadata>
Implementation of LedgerReader.getNftMetadata
- Defined in src/ledger/backend/readconn.ts:69

off

off<T>(ev: T, cb: ErdstallEventHandler<T>): void
Unregisters a callback for the given event.
Type Parameters
- T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"
  
  Type of event the callback is parameterized on.
Parameters
- ev: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of LedgerReader.off
- Defined in src/ledger/backend/readconn.ts:51

on

on<T>(ev: T, cb: ErdstallEventHandler<T>): void
Registers a callback for the given event, s.t. it fires everytime until manually unregistered with off(ev, cb).

Remarks
The registered callback should always be manually unregistered.
Type Parameters
- T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"
  
  Type of event the callback is parameterized on.
Parameters
- ev: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of LedgerReader.on
- Defined in src/ledger/backend/readconn.ts:38

once

once<T>(ev: T, cb: ErdstallEventHandler<T>): void
Registers a callback for the given event, s.t. it fires only ONCE. Once registered, a callback cannot be unregistered again.
Type Parameters
- T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"
  
  Type of event the callback is parameterized on.
Parameters
- ev: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of LedgerReader.once
- Defined in src/ledger/backend/readconn.ts:44

removeAllListeners

removeAllListeners(): void
Removes all registered callbacks for all events.

Returns void
Implementation of LedgerReader.removeAllListeners
- Defined in src/ledger/backend/readconn.ts:60

Class LedgerReadConn

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

contract: Erdstall

tokenCache: TokenProvider

Returns LedgerReadConn

Properties

Readonly contract

Private eventCache

Private metadataCache

Readonly tokenCache

Methods

erdstall

Returns

Returns Address

getNftMetadata

Parameters

token: Address

id: bigint

Optional useCache: boolean

Returns Promise<NFTMetadata>

off

Type Parameters

T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"

Parameters

ev: T

cb: ErdstallEventHandler<T>

Returns void

on

Remarks

Type Parameters

T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"

Parameters

ev: T

cb: ErdstallEventHandler<T>

Returns void

once

Type Parameters

T extends "Frozen" | "Deposited" | "Withdrawn" | "Challenged" | "ChallengeResponded" | "TokenTypeRegistered" | "TokenRegistered"

Parameters

ev: T

cb: ErdstallEventHandler<T>

Returns void

removeAllListeners

Returns void

Settings

Member Visibility

Theme

`Readonly` contract

`Private` eventCache

`Private` metadataCache

`Readonly` tokenCache

`Optional` useCache: boolean