Class ClientCache`Abstract`

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 Summary)

ClientCache
- ClientCacheMemory

Constructors

constructor

new ClientCache(): ClientCache
Returns ClientCache

Methods

`Abstract`markUsableNoCache

markUsableNoCache(...cellLikes: (CellLike | CellLike[])[]): Promise<void>
Parameters
- ...cellLikes: (CellLike | CellLike[])[]
Returns Promise<void>
- Defined in client/cache/cache.ts:28

markUsable

markUsable(...cellLikes: (CellLike | CellLike[])[]): Promise<void>
Parameters
- ...cellLikes: (CellLike | CellLike[])[]
Returns Promise<void>
- Defined in client/cache/cache.ts:31

`Abstract`markUnusable

markUnusable(...outPointLike: (OutPointLike | OutPointLike[])[]): Promise<void>
Parameters
- ...outPointLike: (OutPointLike | OutPointLike[])[]
Returns Promise<void>
- Defined in client/cache/cache.ts:35

markTransactions

markTransactions(
...transactionLike: (TransactionLike | TransactionLike[])[],
): Promise<void>
Parameters
- ...transactionLike: (TransactionLike | TransactionLike[])[]
Returns Promise<void>
- Defined in client/cache/cache.ts:38

`Abstract`clear

clear(): Promise<void>
Returns Promise<void>
- Defined in client/cache/cache.ts:68

`Abstract`findCells

findCells(filter: ClientCollectableSearchKeyLike): AsyncGenerator<Cell>
Parameters
- filter: ClientCollectableSearchKeyLike
Returns AsyncGenerator<Cell>
- Defined in client/cache/cache.ts:69

`Abstract`isUnusable

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

recordCells

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

getCell

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

recordTransactionResponses

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

getTransactionResponse

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

recordTransactions

recordTransactions(
...transactions: (TransactionLike | TransactionLike[])[],
): Promise<void>
Record known transactions.
Parameters
- ...transactions: (TransactionLike | TransactionLike[])[]
Returns Promise<void>
- Defined in client/cache/cache.ts:118

getTransaction

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

recordHeaders

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

getHeaderByHash

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

getHeaderByNumber

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

recordBlocks

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

getBlockByHash

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

getBlockByNumber

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

hasHeaderConfirmed

hasHeaderConfirmed(header: ClientBlockHeader): boolean
Checks if a block header is considered confirmed. The default implementation compares the header's timestamp against the current time and a configured confirmation time. Override this method for custom confirmation logic.
Parameters
- header: ClientBlockHeader
Returns boolean
- Defined in client/cache/cache.ts:196