@ckb-ccc/core 1.5.3 → 1.7.0

package/dist/ckb/transaction.js

@@ -6,6 +6,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 var OutPoint_1, CellOutput_1, Since_1, CellInput_1, CellDep_1, WitnessArgs_1, Transaction_1;
 import { bytesFrom } from "../bytes/index.js";
+import { ClientBlockHeader, } from "../client/index.js";
+import { KnownScript } from "../client/knownScript.js";
 import { Zero, fixedPointFrom, fixedPointToString, } from "../fixedPoint/index.js";
 import { HasherCkb, hashCkb } from "../hasher/index.js";
 import { hexFrom } from "../hex/index.js";
@@ -198,7 +200,83 @@ export class Cell {
         if (cell instanceof Cell) {
             return cell;
         }
-        return new Cell(OutPoint.from(cell.outPoint), CellOutput.from(cell.cellOutput), hexFrom(cell.outputData));
+        return new Cell(OutPoint.from("outPoint" in cell ? cell.outPoint : cell.previousOutput), CellOutput.from(cell.cellOutput), hexFrom(cell.outputData));
+    }
+    get capacityFree() {
+        const occupiedSize = fixedPointFrom(this.cellOutput.occupiedSize + bytesFrom(this.outputData).length);
+        return this.cellOutput.capacity - occupiedSize;
+    }
+    /**
+     * Occupied bytes of a cell on chain
+     * It's CellOutput.occupiedSize + bytesFrom(outputData).byteLength
+     */
+    get occupiedSize() {
+        return this.cellOutput.occupiedSize + bytesFrom(this.outputData).byteLength;
+    }
+    /**
+     * Gets confirmed Nervos DAO profit of a Cell
+     * It returns non-zero value only when the cell is in withdrawal phase 2
+     * See https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md
+     *
+     * @param client - A client for searching DAO related headers
+     * @returns Profit
+     *
+     * @example
+     * ```typescript
+     * const profit = await cell.getDaoProfit(client);
+     * ```
+     */
+    async getDaoProfit(client) {
+        if (!(await this.isNervosDao(client, "withdrew"))) {
+            return Zero;
+        }
+        const { depositHeader, withdrawHeader } = await this.getNervosDaoInfo(client);
+        if (!withdrawHeader || !depositHeader) {
+            throw new Error(`Unable to get headers of a Nervos DAO cell ${this.outPoint.txHash}:${this.outPoint.index.toString()}`);
+        }
+        return calcDaoProfit(this.capacityFree, depositHeader, withdrawHeader);
+    }
+    async isNervosDao(client, phase) {
+        const { type } = this.cellOutput;
+        const daoType = await client.getKnownScript(KnownScript.NervosDao);
+        if (!type ||
+            type.codeHash !== daoType.codeHash ||
+            type.hashType !== daoType.hashType) {
+            // Non Nervos DAO cell
+            return false;
+        }
+        const hasWithdrew = numFrom(this.outputData) !== Zero;
+        return (!phase ||
+            (phase === "deposited" && !hasWithdrew) ||
+            (phase === "withdrew" && hasWithdrew));
+    }
+    async getNervosDaoInfo(client) {
+        if (!(await this.isNervosDao(client))) {
+            // Non Nervos DAO cell
+            return {};
+        }
+        if (numFrom(this.outputData) === Zero) {
+            // Deposited Nervos DAO cell
+            const depositRes = await client.getCellWithHeader(this.outPoint);
+            if (!depositRes?.header) {
+                throw new Error(`Unable to get header of a Nervos DAO deposited cell ${this.outPoint.txHash}:${this.outPoint.index.toString()}`);
+            }
+            return {
+                depositHeader: depositRes.header,
+            };
+        }
+        // Withdrew Nervos DAO cell
+        const [depositHeader, withdrawRes] = await Promise.all([
+            client.getHeaderByNumber(numFromBytes(this.outputData)),
+            client.getCellWithHeader(this.outPoint),
+        ]);
+        if (!withdrawRes?.header || !depositHeader) {
+            throw new Error(`Unable to get headers of a Nervos DAO withdrew cell ${this.outPoint.txHash}:${this.outPoint.index.toString()}`);
+        }
+        return {
+            depositHeader,
+            withdrawHeader: withdrawRes.header,
+        };
     }
     /**
      * Clone a Cell
@@ -369,16 +447,31 @@ let CellInput = CellInput_1 = class CellInput extends mol.Entity.Base() {
         if (cellInput instanceof CellInput_1) {
             return cellInput;
         }
-        return new CellInput_1(OutPoint.from(cellInput.previousOutput), Since.from(cellInput.since ?? 0).toNum(), apply(CellOutput.from, cellInput.cellOutput), apply(hexFrom, cellInput.outputData));
+        return new CellInput_1(OutPoint.from("previousOutput" in cellInput
+            ? cellInput.previousOutput
+            : cellInput.outPoint), Since.from(cellInput.since ?? 0).toNum(), apply(CellOutput.from, cellInput.cellOutput), apply(hexFrom, cellInput.outputData));
+    }
+    async getCell(client) {
+        await this.completeExtraInfos(client);
+        if (!this.cellOutput || !this.outputData) {
+            throw new Error("Unable to complete input");
+        }
+        return Cell.from({
+            outPoint: this.previousOutput,
+            cellOutput: this.cellOutput,
+            outputData: this.outputData,
+        });
     }
     /**
-     * Complete extra infos in the input. Like the output of the out point.
+     * Complete extra infos in the input. Including
+     * - Previous cell output
+     * - Previous cell data
      * The instance will be modified.
      *
      * @returns true if succeed.
      * @example
      * ```typescript
-     * await cellInput.completeExtraInfos();
+     * await cellInput.completeExtraInfos(client);
      * ```
      */
     async completeExtraInfos(client) {
@@ -392,6 +485,20 @@ let CellInput = CellInput_1 = class CellInput extends mol.Entity.Base() {
         this.cellOutput = cell.cellOutput;
         this.outputData = cell.outputData;
     }
+    /**
+     * The extra capacity created when consume this input.
+     * This is usually NervosDAO interest, see https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md.
+     * And it can also be miners' income. (But this is not implemented yet)
+     */
+    async getExtraCapacity(client) {
+        return (await this.getCell(client)).getDaoProfit(client);
+    }
+    clone() {
+        const cloned = super.clone();
+        cloned.cellOutput = this.cellOutput;
+        cloned.outputData = this.outputData;
+        return cloned;
+    }
 };
 CellInput = CellInput_1 = __decorate([
     mol.codec(mol
@@ -399,10 +506,7 @@ CellInput = CellInput_1 = __decorate([
         since: Since,
         previousOutput: OutPoint,
     })
-        .mapIn((encodable) => ({
-        ...encodable,
-        since: encodable.since ?? 0,
-    })))
+        .mapIn((encodable) => CellInput.from(encodable)))
 ], CellInput);
 export { CellInput };
 export const CellInputVec = mol.vector(CellInput);
@@ -511,11 +615,13 @@ WitnessArgs = WitnessArgs_1 = __decorate([
 ], WitnessArgs);
 export { WitnessArgs };
 /**
+ * Convert a bytes to a num.
+ *
  * @public
  */
 export function udtBalanceFrom(dataLike) {
     const data = bytesFrom(dataLike).slice(0, 16);
-    return numFromBytes(data);
+    return data.length === 0 ? Zero : numFromBytes(data);
 }
 export const RawTransaction = mol.table({
     version: mol.Uint32,
@@ -655,6 +761,11 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
             witnesses: skeleton.witnesses.toArray(),
         });
     }
+    /**
+     * @deprecated
+     * Use ccc.stringify instead.
+     * stringify the tx to JSON string.
+     */
     stringify() {
         return JSON.stringify(this, (_, value) => {
             if (typeof value === "bigint") {
@@ -744,11 +855,8 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         for (let i = 0; i < this.witnesses.length; i += 1) {
             const input = this.inputs[i];
             if (input) {
-                await input.completeExtraInfos(client);
-                if (!input.cellOutput) {
-                    throw new Error("Unable to complete input");
-                }
-                if (!script.eq(input.cellOutput.lock)) {
+                const { cellOutput } = await input.getCell(client);
+                if (!script.eq(cellOutput.lock)) {
                     continue;
                 }
                 if (position === -1) {
@@ -783,13 +891,9 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
     async findInputIndexByLockId(scriptIdLike, client) {
         const script = Script.from({ ...scriptIdLike, args: "0x" });
         for (let i = 0; i < this.inputs.length; i += 1) {
-            const input = this.inputs[i];
-            await input.completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw new Error("Unable to complete input");
-            }
-            if (script.codeHash === input.cellOutput.lock.codeHash &&
-                script.hashType === input.cellOutput.lock.hashType) {
+            const { cellOutput } = await this.inputs[i].getCell(client);
+            if (script.codeHash === cellOutput.lock.codeHash &&
+                script.hashType === cellOutput.lock.hashType) {
                 return i;
             }
         }
@@ -809,12 +913,8 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
     async findInputIndexByLock(scriptLike, client) {
         const script = Script.from(scriptLike);
         for (let i = 0; i < this.inputs.length; i += 1) {
-            const input = this.inputs[i];
-            await input.completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw new Error("Unable to complete input");
-            }
-            if (script.eq(input.cellOutput.lock)) {
+            const { cellOutput } = await this.inputs[i].getCell(client);
+            if (script.eq(cellOutput.lock)) {
                 return i;
             }
         }
@@ -834,12 +934,8 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
     async findLastInputIndexByLock(scriptLike, client) {
         const script = Script.from(scriptLike);
         for (let i = this.inputs.length - 1; i >= 0; i -= 1) {
-            const input = this.inputs[i];
-            await input.completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw new Error("Unable to complete input");
-            }
-            if (script.eq(input.cellOutput.lock)) {
+            const { cellOutput } = await this.inputs[i].getCell(client);
+            if (script.eq(cellOutput.lock)) {
                 return i;
             }
         }
@@ -929,6 +1025,55 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         }
         this.outputsData[index] = hexFrom(witness);
     }
+    /**
+     * get input
+     *
+     * @param index - The cell input index
+     *
+     * @example
+     * ```typescript
+     * await tx.getInput(0);
+     * ```
+     */
+    getInput(index) {
+        return this.inputs[Number(numFrom(index))];
+    }
+    /**
+     * add input
+     *
+     * @param inputLike - The cell input.
+     *
+     * @example
+     * ```typescript
+     * await tx.addInput({ });
+     * ```
+     */
+    addInput(inputLike) {
+        if (this.witnesses.length > this.inputs.length) {
+            this.witnesses.splice(this.inputs.length, 0, "0x");
+        }
+        return this.inputs.push(CellInput.from(inputLike));
+    }
+    /**
+     * get output
+     *
+     * @param index - The cell output index
+     *
+     * @example
+     * ```typescript
+     * await tx.getOutput(0);
+     * ```
+     */
+    getOutput(index) {
+        const i = Number(numFrom(index));
+        if (i >= this.outputs.length) {
+            return;
+        }
+        return {
+            cellOutput: this.outputs[i],
+            outputData: this.outputsData[i] ?? "0x",
+        };
+    }
     /**
      * Add output
      *
@@ -948,8 +1093,9 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         if (output.capacity === Zero) {
             output.capacity = fixedPointFrom(output.occupiedSize + bytesFrom(outputData).length);
         }
-        const i = this.outputs.push(output) - 1;
-        this.setOutputDataAt(i, outputData);
+        const len = this.outputs.push(output);
+        this.setOutputDataAt(len - 1, outputData);
+        return len;
     }
     /**
      * Get witness at index as WitnessArgs
@@ -980,10 +1126,24 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
      * ```
      */
     setWitnessArgsAt(index, witness) {
+        this.setWitnessAt(index, witness.toBytes());
+    }
+    /**
+     * Set witness at index
+     *
+     * @param index - The index of the witness.
+     * @param witness - The witness to set.
+     *
+     * @example
+     * ```typescript
+     * await tx.setWitnessAt(0, witness);
+     * ```
+     */
+    setWitnessAt(index, witness) {
         if (this.witnesses.length < index) {
             this.witnesses.push(...Array.from(new Array(index - this.witnesses.length), () => "0x"));
         }
-        this.witnesses[index] = hexFrom(witness.toBytes());
+        this.witnesses[index] = hexFrom(witness);
     }
     /**
      * Prepare dummy witness for sighash all method
@@ -1007,28 +1167,26 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         witness.lock = hexFrom(Array.from(new Array(lockLen), () => 0));
         this.setWitnessArgsAt(position, witness);
     }
+    async getInputsCapacityExtra(client) {
+        return reduceAsync(this.inputs, async (acc, input) => acc + (await input.getExtraCapacity(client)), numFrom(0));
+    }
+    // This also includes extra amount
     async getInputsCapacity(client) {
-        return reduceAsync(this.inputs, async (acc, input) => {
-            await input.completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw new Error("Unable to complete input");
-            }
-            return acc + input.cellOutput.capacity;
-        }, numFrom(0));
+        return ((await reduceAsync(this.inputs, async (acc, input) => {
+            const { cellOutput: { capacity }, } = await input.getCell(client);
+            return acc + capacity;
+        }, numFrom(0))) + (await this.getInputsCapacityExtra(client)));
     }
     getOutputsCapacity() {
         return this.outputs.reduce((acc, { capacity }) => acc + capacity, numFrom(0));
     }
     async getInputsUdtBalance(client, type) {
         return reduceAsync(this.inputs, async (acc, input) => {
-            await input.completeExtraInfos(client);
-            if (!input.cellOutput || !input.outputData) {
-                throw new Error("Unable to complete input");
-            }
-            if (!input.cellOutput.type?.eq(type)) {
+            const { cellOutput, outputData } = await input.getCell(client);
+            if (!cellOutput.type?.eq(type)) {
                 return;
             }
-            return acc + udtBalanceFrom(input.outputData);
+            return acc + udtBalanceFrom(outputData);
         }, numFrom(0));
     }
     getOutputsUdtBalance(type) {
@@ -1055,11 +1213,7 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
             }
             acc = next;
         }
-        this.inputs.push(...collectedCells.map(({ outPoint, outputData, cellOutput }) => CellInput.from({
-            previousOutput: outPoint,
-            outputData,
-            cellOutput,
-        })));
+        collectedCells.forEach((cell) => this.addInput(cell));
         if (fulfilled) {
             return {
                 addedCount: collectedCells.length,
@@ -1115,19 +1269,12 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         throw new Error(`Insufficient coin, need ${exceptedBalance - accumulated} extra coin`);
     }
     async completeInputsAddOne(from, filter) {
-        for await (const cell of from.findCells(filter ?? {
+        const { addedCount, accumulated } = await this.completeInputs(from, filter ?? {
             scriptLenRange: [0, 1],
             outputDataLenRange: [0, 1],
-        }, true, undefined, 1)) {
-            if (this.inputs.some(({ previousOutput }) => previousOutput.eq(cell.outPoint))) {
-                continue;
-            }
-            this.inputs.push(CellInput.from({
-                previousOutput: cell.outPoint,
-                outputData: cell.outputData,
-                cellOutput: cell.cellOutput,
-            }));
-            return 1;
+        }, () => undefined, true);
+        if (accumulated === undefined) {
+            return addedCount;
         }
         throw new Error(`Insufficient CKB, need at least one new cell`);
     }
@@ -1137,12 +1284,21 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
         }
         return this.completeInputsAddOne(from, filter);
     }
+    async getFee(client) {
+        return (await this.getInputsCapacity(client)) - this.getOutputsCapacity();
+    }
+    async getFeeRate(client) {
+        return (((await this.getFee(client)) * numFrom(1000)) /
+            numFrom(this.toBytes().length + 4));
+    }
     estimateFee(feeRate) {
         const txSize = this.toBytes().length + 4;
-        return (numFrom(txSize) * numFrom(feeRate) + numFrom(1000)) / numFrom(1000);
+        // + 999 then / 1000 to ceil the calculated fee
+        return (numFrom(txSize) * numFrom(feeRate) + numFrom(999)) / numFrom(1000);
     }
-    async completeFee(from, change, expectedFeeRate, filter) {
-        const feeRate = expectedFeeRate ?? (await from.client.getFeeRate());
+    async completeFee(from, change, expectedFeeRate, filter, options) {
+        const feeRate = expectedFeeRate ??
+            (await from.client.getFeeRate(options?.feeRateBlockRange, options));
         // Complete all inputs extra infos for cache
         await this.getInputsCapacity(from.client);
         let leastFee = Zero;
@@ -1165,20 +1321,19 @@ let Transaction = Transaction_1 = class Transaction extends mol.Entity.Base() {
                 // The initial fee is calculated based on prepared transaction
                 leastFee = tx.estimateFee(feeRate);
             }
-            const extraCapacity = (await tx.getInputsCapacity(from.client)) - tx.getOutputsCapacity();
+            const fee = await tx.getFee(from.client);
             // The extra capacity paid the fee without a change
-            if (extraCapacity === leastFee) {
+            if (fee === leastFee) {
                 this.copy(tx);
                 return [collected, false];
             }
-            const needed = numFrom(await Promise.resolve(change(tx, extraCapacity - leastFee)));
+            const needed = numFrom(await Promise.resolve(change(tx, fee - leastFee)));
             // No enough extra capacity to create new cells for change
             if (needed > Zero) {
                 leastExtraCapacity = needed;
                 continue;
             }
-            if ((await tx.getInputsCapacity(from.client)) - tx.getOutputsCapacity() !==
-                leastFee) {
+            if ((await tx.getFee(from.client)) !== leastFee) {
                 throw new Error("The change function doesn't use all available capacity");
             }
             // New change cells created, update the fee
@@ -1240,3 +1395,38 @@ Transaction = Transaction_1 = __decorate([
         .mapOut((tx) => Transaction.from({ ...tx.raw, witnesses: tx.witnesses })))
 ], Transaction);
 export { Transaction };
+/**
+ * Calculate Nervos DAO profit between two blocks
+ */
+export function calcDaoProfit(profitableCapacity, depositHeaderLike, withdrawHeaderLike) {
+    const depositHeader = ClientBlockHeader.from(depositHeaderLike);
+    const withdrawHeader = ClientBlockHeader.from(withdrawHeaderLike);
+    const profitableSize = numFrom(profitableCapacity);
+    return ((profitableSize * withdrawHeader.dao.ar) / depositHeader.dao.ar -
+        profitableSize);
+}
+/**
+ * Calculate claimable epoch for Nervos DAO withdrawal
+ * See https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md
+ */
+export function calcDaoClaimEpoch(depositHeader, withdrawHeader) {
+    const depositEpoch = ClientBlockHeader.from(depositHeader).epoch;
+    const withdrawEpoch = ClientBlockHeader.from(withdrawHeader).epoch;
+    const intDiff = withdrawEpoch[0] - depositEpoch[0];
+    // deposit[1]    withdraw[1]
+    // ---------- <= -----------
+    // deposit[2]    withdraw[2]
+    if (intDiff % numFrom(180) !== numFrom(0) ||
+        depositEpoch[1] * withdrawEpoch[2] <= depositEpoch[2] * withdrawEpoch[1]) {
+        return [
+            depositEpoch[0] + (intDiff / numFrom(180) + numFrom(1)) * numFrom(180),
+            depositEpoch[1],
+            depositEpoch[2],
+        ];
+    }
+    return [
+        depositEpoch[0] + (intDiff / numFrom(180)) * numFrom(180),
+        depositEpoch[1],
+        depositEpoch[2],
+    ];
+}

package/dist/client/cache/cache.d.ts

@@ -1,35 +1,91 @@
 import { Cell, CellLike, OutPointLike, Transaction, TransactionLike } from "../../ckb/index.js";
 import { HexLike } from "../../hex/index.js";
+import { NumLike } from "../../num/index.js";
 import { ClientCollectableSearchKeyLike } from "../clientTypes.advanced.js";
+import { ClientBlock, ClientBlockHeader, ClientBlockHeaderLike, ClientBlockLike, ClientTransactionResponse, ClientTransactionResponseLike } from "../clientTypes.js";
+/**
+ * @public
+ * 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.
+ */
 export declare abstract class ClientCache {
-    abstract markUsable(...cellLikes: (CellLike | CellLike[])[]): Promise<void>;
+    abstract markUsableNoCache(...cellLikes: (CellLike | CellLike[])[]): Promise<void>;
+    markUsable(...cellLikes: (CellLike | CellLike[])[]): Promise<void>;
     abstract markUnusable(...outPointLike: (OutPointLike | OutPointLike[])[]): Promise<void>;
     markTransactions(...transactionLike: (TransactionLike | TransactionLike[])[]): Promise<void>;
     abstract clear(): Promise<void>;
     abstract findCells(filter: ClientCollectableSearchKeyLike): AsyncGenerator<Cell>;
+    abstract isUnusable(outPointLike: OutPointLike): Promise<boolean>;
+    /**
+     * Record known cells
+     * Implement this method to enable cells query caching
+     * @param _cells
+     */
+    recordCells(..._cells: (CellLike | CellLike[])[]): Promise<void>;
     /**
      * Get a known cell by out point
+     * Implement this method to enable cells query caching
      * @param _outPoint
      */
-    abstract getCell(_outPoint: OutPointLike): Promise<Cell | undefined>;
-    abstract isUnusable(outPointLike: OutPointLike): Promise<boolean>;
+    getCell(_outPoint: OutPointLike): Promise<Cell | undefined>;
     /**
-     * Record known transactions
+     * Record known transaction responses.
      * Implement this method to enable transactions query caching
      * @param _transactions
      */
-    recordTransactions(..._transactions: (TransactionLike | TransactionLike[])[]): Promise<void>;
+    recordTransactionResponses(..._transactions: (ClientTransactionResponseLike | ClientTransactionResponseLike[])[]): Promise<void>;
     /**
-     * Get a known transaction by hash
+     * Get a known transaction response by hash
      * Implement this method to enable transactions query caching
      * @param _txHash
      */
-    getTransaction(_txHash: HexLike): Promise<Transaction | undefined>;
+    getTransactionResponse(_txHash: HexLike): Promise<ClientTransactionResponse | undefined>;
     /**
-     * Record known cells
-     * Implement this method to enable cells query caching
-     * @param _cells
+     * Record known transactions.
+     * @param transactions
      */
-    recordCells(..._cells: (CellLike | CellLike[])[]): Promise<void>;
+    recordTransactions(...transactions: (TransactionLike | TransactionLike[])[]): Promise<void>;
+    /**
+     * Get a known transaction by hash
+     * @param txHash
+     */
+    getTransaction(txHash: HexLike): Promise<Transaction | undefined>;
+    /**
+     * Record known block headers.
+     * Implement this method to enable block headers query caching
+     * @param _headers
+     */
+    recordHeaders(..._headers: (ClientBlockHeaderLike | ClientBlockHeaderLike[])[]): Promise<void>;
+    /**
+     * Get a known block header by hash
+     * Implement this method to enable block headers query caching
+     * @param _hash
+     */
+    getHeaderByHash(_hash: HexLike): Promise<ClientBlockHeader | undefined>;
+    /**
+     * Get a known block header by number
+     * Implement this method to enable block headers query caching
+     * @param _number
+     */
+    getHeaderByNumber(_number: NumLike): Promise<ClientBlockHeader | undefined>;
+    /**
+     * Record known blocks.
+     * Implement this method to enable blocks query caching
+     * @param _blocks
+     */
+    recordBlocks(..._blocks: (ClientBlockLike | ClientBlockLike[])[]): Promise<void>;
+    /**
+     * Get a known block header by hash
+     * Implement this method to enable block headers query caching
+     * @param _hash
+     */
+    getBlockByHash(_hash: HexLike): Promise<ClientBlock | undefined>;
+    /**
+     * Get a known block header by number
+     * Implement this method to enable block headers query caching
+     * @param _number
+     */
+    getBlockByNumber(_number: NumLike): Promise<ClientBlock | undefined>;
 }
 //# sourceMappingURL=cache.d.ts.map

package/dist/client/cache/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/client/cache/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAE5E,8BAAsB,WAAW;IAC/B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,EAAE,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3E,QAAQ,CAAC,YAAY,CACnB,GAAG,YAAY,EAAE,CAAC,YAAY,GAAG,YAAY,EAAE,CAAC,EAAE,GACjD,OAAO,CAAC,IAAI,CAAC;IACV,gBAAgB,CACpB,GAAG,eAAe,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GAC1D,OAAO,CAAC,IAAI,CAAC;IAuBhB,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAC/B,QAAQ,CAAC,SAAS,CAChB,MAAM,EAAE,8BAA8B,GACrC,cAAc,CAAC,IAAI,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IACpE,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAEjE;;;;OAIG;IACG,kBAAkB,CACtB,GAAG,aAAa,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GACxD,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAIxE;;;;OAIG;IACG,WAAW,CAAC,GAAG,MAAM,EAAE,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CACvE"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/client/cache/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAE3B;;;;;GAKG;AACH,8BAAsB,WAAW;IAC/B,QAAQ,CAAC,iBAAiB,CACxB,GAAG,SAAS,EAAE,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,EAAE,GACtC,OAAO,CAAC,IAAI,CAAC;IACV,UAAU,CAAC,GAAG,SAAS,EAAE,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE,QAAQ,CAAC,YAAY,CACnB,GAAG,YAAY,EAAE,CAAC,YAAY,GAAG,YAAY,EAAE,CAAC,EAAE,GACjD,OAAO,CAAC,IAAI,CAAC;IACV,gBAAgB,CACpB,GAAG,eAAe,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GAC1D,OAAO,CAAC,IAAI,CAAC;IA4BhB,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAC/B,QAAQ,CAAC,SAAS,CAChB,MAAM,EAAE,8BAA8B,GACrC,cAAc,CAAC,IAAI,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAMjE;;;;OAIG;IACG,WAAW,CAAC,GAAG,MAAM,EAAE,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IACtE;;;;OAIG;IACG,OAAO,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAIjE;;;;OAIG;IACG,0BAA0B,CAC9B,GAAG,aAAa,EAAE,CACd,6BAA6B,GAC7B,6BAA6B,EAAE,CAClC,EAAE,GACF,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACG,sBAAsB,CAC1B,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IAGjD;;;OAGG;IACG,kBAAkB,CACtB,GAAG,YAAY,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GACvD,OAAO,CAAC,IAAI,CAAC;IAQhB;;;OAGG;IACG,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAIvE;;;;OAIG;IACG,aAAa,CACjB,GAAG,QAAQ,EAAE,CAAC,qBAAqB,GAAG,qBAAqB,EAAE,CAAC,EAAE,GAC/D,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACG,eAAe,CACnB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAGzC;;;;OAIG;IACG,iBAAiB,CACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAIzC;;;;OAIG;IACG,YAAY,CAChB,GAAG,OAAO,EAAE,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,GAClD,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACG,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAGtE;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;CAG3E"}