Class ClientCacheMemory

The ClientCache class is mainly designed for chained transactions. Consumed & Created cells are "marked" so they can be correctly handled when composing transactions. It also act as cache for rpc requests to reduce cost, but this is optional.

Hierarchy (view full)

ClientCache
- ClientCacheMemory

Constructors

constructor

new ClientCacheMemory(maxCells?, maxTxs?, maxBlocks?): ClientCacheMemory
Parameters
- maxCells: number = 512
- maxTxs: number = 256
- maxBlocks: number = 128
Returns ClientCacheMemory
Overrides ClientCache.constructor
- Defined in client/cache/memory.ts:40

Methods

markUsable

markUsable(...cellLikes): Promise<void>
Parameters
- Rest...cellLikes: (CellLike | CellLike[])[]
Returns Promise<void>
Inherited from ClientCache.markUsable
- Defined in client/cache/cache.ts:30

markTransactions

markTransactions(...transactionLike): Promise<void>
Parameters
- Rest...transactionLike: (TransactionLike | TransactionLike[])[]
Returns Promise<void>
Inherited from ClientCache.markTransactions
- Defined in client/cache/cache.ts:37

recordTransactions

recordTransactions(...transactions): Promise<void>
Record known transactions.
Parameters
- Rest...transactions: (TransactionLike | TransactionLike[])[]
Returns Promise<void>
Inherited from ClientCache.recordTransactions
- Defined in client/cache/cache.ts:117

getTransaction

getTransaction(txHash): Promise<undefined | Transaction>
Get a known transaction by hash
Parameters
- txHash: BytesLike
Returns Promise<undefined | Transaction>
Inherited from ClientCache.getTransaction
- Defined in client/cache/cache.ts:131

markUsableNoCache

markUsableNoCache(...cellLikes): Promise<void>
Parameters
- Rest...cellLikes: (CellLike | CellLike[])[]
Returns Promise<void>
Overrides ClientCache.markUsableNoCache
- Defined in client/cache/memory.ts:58

markUnusable

markUnusable(...outPointLikes): Promise<void>
Parameters
- Rest...outPointLikes: (OutPointLike | OutPointLike[])[]
Returns Promise<void>
Overrides ClientCache.markUnusable
- Defined in client/cache/memory.ts:69

clear

clear(): Promise<void>
Returns Promise<void>
Overrides ClientCache.clear
- Defined in client/cache/memory.ts:85

findCells

findCells(keyLike): AsyncGenerator<Cell, any, any>
Parameters
- keyLike: ClientCollectableSearchKeyLike
Returns AsyncGenerator<Cell, any, any>
Overrides ClientCache.findCells
- Defined in client/cache/memory.ts:90

isUnusable

isUnusable(outPointLike): Promise<boolean>
Parameters
- outPointLike: OutPointLike
Returns Promise<boolean>
Overrides ClientCache.isUnusable
- Defined in client/cache/memory.ts:106

recordCells

recordCells(...cells): Promise<void>
Record known cells Implement this method to enable cells query caching
Parameters
- Rest...cells: (CellLike | CellLike[])[]
Returns Promise<void>
Overrides ClientCache.recordCells
- Defined in client/cache/memory.ts:112

getCell

getCell(outPointLike): Promise<undefined | Cell>
Get a known cell by out point Implement this method to enable cells query caching
Parameters
- outPointLike: OutPointLike
Returns Promise<undefined | Cell>
Overrides ClientCache.getCell
- Defined in client/cache/memory.ts:123

recordTransactionResponses

recordTransactionResponses(...transactions): Promise<void>
Record known transaction responses. Implement this method to enable transactions query caching
Parameters
- Rest...transactions: (ClientTransactionResponseLike | ClientTransactionResponseLike[])[]
Returns Promise<void>
Overrides ClientCache.recordTransactionResponses
- Defined in client/cache/memory.ts:132

getTransactionResponse

getTransactionResponse(txHashLike): Promise<undefined | ClientTransactionResponse>
Get a known transaction response by hash Implement this method to enable transactions query caching
Parameters
- txHashLike: BytesLike
Returns Promise<undefined | ClientTransactionResponse>
Overrides ClientCache.getTransactionResponse
- Defined in client/cache/memory.ts:143

recordHeaders

recordHeaders(...headers): Promise<void>
Record known block headers. Implement this method to enable block headers query caching
Parameters
- Rest...headers: (ClientBlockHeaderLike | ClientBlockHeaderLike[])[]
Returns Promise<void>
Overrides ClientCache.recordHeaders
- Defined in client/cache/memory.ts:150

getHeaderByHash

getHeaderByHash(hashLike): Promise<undefined | ClientBlockHeader>
Get a known block header by hash Implement this method to enable block headers query caching
Parameters
- hashLike: BytesLike
Returns Promise<undefined | ClientBlockHeader>
Overrides ClientCache.getHeaderByHash
- Defined in client/cache/memory.ts:165

getHeaderByNumber

getHeaderByNumber(numberLike): Promise<undefined | ClientBlockHeader>
Get a known block header by number Implement this method to enable block headers query caching
Parameters
- numberLike: NumLike
Returns Promise<undefined | ClientBlockHeader>
Overrides ClientCache.getHeaderByNumber
- Defined in client/cache/memory.ts:175

recordBlocks

recordBlocks(...blocks): Promise<void>
Record known blocks. Implement this method to enable blocks query caching
Parameters
- Rest...blocks: (ClientBlockLike | ClientBlockLike[])[]
Returns Promise<void>
Overrides ClientCache.recordBlocks
- Defined in client/cache/memory.ts:187

getBlockByHash

getBlockByHash(hashLike): Promise<undefined | ClientBlock>
Get a known block header by hash Implement this method to enable block headers query caching
Parameters
- hashLike: BytesLike
Returns Promise<undefined | ClientBlock>
Overrides ClientCache.getBlockByHash
- Defined in client/cache/memory.ts:197

getBlockByNumber

getBlockByNumber(numberLike): Promise<undefined | ClientBlock>
Get a known block header by number Implement this method to enable block headers query caching
Parameters
- numberLike: NumLike
Returns Promise<undefined | ClientBlock>
Overrides ClientCache.getBlockByNumber
- Defined in client/cache/memory.ts:208