@ickb/sdk 1000.0.81 → 9000.0.1

package/dist/conversion/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/conversion/types.ts"],"names":[],"mappings":""}

package/dist/conversion/withdrawal_ring.d.ts

@@ -0,0 +1,36 @@
+import type { ccc } from "@ckb-ccc/core";
+import type { IckbDepositCell } from "../logic.js";
+/**
+ * Ring segment of pool deposits grouped by maturity around the DAO cycle.
+ */
+export interface RingSegment {
+    /** Segment index in the ring. */
+    index: number;
+    /** Deposits assigned to this segment. */
+    deposits: IckbDepositCell[];
+    /** Total iCKB value of deposits in this segment. */
+    udtValue: bigint;
+}
+/**
+ * Splits pool deposits into power-of-two maturity ring segments, one segment per two
+ * deposit caps of pool iCKB.
+ */
+export declare function ringSegments(poolDeposits: readonly IckbDepositCell[]): RingSegment[];
+/** The segment index an epoch falls in, for a deposit's claim or the tip. */
+export declare function ringSegmentIndex(epoch: ccc.Epoch, segmentCount: number): number;
+/**
+ * Returns a filter that excludes the ring anchor deposits from surplus selection: each
+ * segment keeps its anchor, the largest deposit not in `ready`, else the largest one.
+ */
+export declare function ringSurplusDepositFilter(poolDeposits: readonly IckbDepositCell[], ready: readonly IckbDepositCell[]): (deposit: IckbDepositCell) => boolean;
+/**
+ * Walks the candidates in the given order and takes each one that still fits under
+ * `maxAmount`; the caller chooses the order, earliest claim first
+ * for a user (the wait they feel), surplus before anchors for the bot. The chain stops at
+ * the most requests one transaction can carry, a request and its owner marker per deposit;
+ * completion steps down from there when change and fees need more room.
+ */
+export declare function fitWithdrawalDeposits(candidates: readonly IckbDepositCell[], maxAmount: bigint): IckbDepositCell[];
+/** Earliest claim first: the deposit that turns into CKB soonest. */
+export declare function sortByClaim(deposits: readonly IckbDepositCell[]): IckbDepositCell[];
+//# sourceMappingURL=withdrawal_ring.d.ts.map

package/dist/conversion/withdrawal_ring.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal_ring.d.ts","sourceRoot":"","sources":["../../src/conversion/withdrawal_ring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IAEd,yCAAyC;IACzC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAE5B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,SAAS,eAAe,EAAE,GAAG,WAAW,EAAE,CAuBpF;AAED,6EAA6E;AAC7E,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAS/E;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,SAAS,eAAe,EAAE,EACxC,KAAK,EAAE,SAAS,eAAe,EAAE,GAChC,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAevC;AAcD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,SAAS,eAAe,EAAE,EACtC,SAAS,EAAE,MAAM,GAChB,eAAe,EAAE,CAcnB;AAED,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,QAAQ,EAAE,SAAS,eAAe,EAAE,GAAG,eAAe,EAAE,CAEnF"}

package/dist/conversion/withdrawal_ring.js

@@ -0,0 +1,87 @@
+import { DAO_CYCLE_EPOCHS, DAO_OUTPUT_LIMIT } from "../dao.js";
+import { ICKB_DEPOSIT_CAP } from "../udt.js";
+/**
+ * Splits pool deposits into power-of-two maturity ring segments, one segment per two
+ * deposit caps of pool iCKB.
+ */
+export function ringSegments(poolDeposits) {
+    // Value, not count: zero-value deposits, made without iCKB Logic running, must not add segments.
+    // Two caps per segment, not one: the room the bot's own fills need, see node/docs/policy.md.
+    const totalUdt = poolDeposits.reduce((sum, deposit) => sum + deposit.udtValue, 0n);
+    let segmentCount = 1;
+    while (BigInt(segmentCount) * 2n * ICKB_DEPOSIT_CAP < totalUdt) {
+        segmentCount *= 2;
+    }
+    const segments = Array.from({ length: segmentCount }, (_, index) => ({
+        index,
+        deposits: [],
+        udtValue: 0n,
+    }));
+    // The ring is one DAO cycle round, so a claim rolled a cycle lands in the same segment.
+    for (const deposit of poolDeposits) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- ringSegmentIndex returns 0 <= index < segmentCount.
+        const segment = segments[ringSegmentIndex(deposit.claimEpoch, segmentCount)];
+        segment.deposits.push(deposit);
+        segment.udtValue += deposit.udtValue;
+    }
+    return segments;
+}
+/** The segment index an epoch falls in, for a deposit's claim or the tip. */
+export function ringSegmentIndex(epoch, segmentCount) {
+    const { denominator } = epoch;
+    if (denominator <= 0n) {
+        throw new Error("Epoch denominator must be positive");
+    }
+    const scaled = epoch.integer * denominator + epoch.numerator;
+    const ring = DAO_CYCLE_EPOCHS * denominator;
+    const wrapped = ((scaled % ring) + ring) % ring;
+    return Number((wrapped * BigInt(segmentCount)) / ring);
+}
+/**
+ * Returns a filter that excludes the ring anchor deposits from surplus selection: each
+ * segment keeps its anchor, the largest deposit not in `ready`, else the largest one.
+ */
+export function ringSurplusDepositFilter(poolDeposits, ready) {
+    const isReady = new Set(ready.map((deposit) => deposit.cell.outPoint.toHex()));
+    const anchors = new Set(ringSegments(poolDeposits).flatMap((segment) => {
+        const anchor = segment.deposits.reduce((best, deposit) => best === undefined || isBetterRingAnchor(deposit, best, isReady)
+            ? deposit
+            : best, undefined);
+        return anchor === undefined ? [] : [anchor.cell.outPoint.toHex()];
+    }));
+    return (deposit) => !anchors.has(deposit.cell.outPoint.toHex());
+}
+function isBetterRingAnchor(candidate, current, isReady) {
+    const candidateReady = isReady.has(candidate.cell.outPoint.toHex());
+    if (candidateReady !== isReady.has(current.cell.outPoint.toHex())) {
+        return !candidateReady;
+    }
+    return candidate.udtValue > current.udtValue;
+}
+/**
+ * Walks the candidates in the given order and takes each one that still fits under
+ * `maxAmount`; the caller chooses the order, earliest claim first
+ * for a user (the wait they feel), surplus before anchors for the bot. The chain stops at
+ * the most requests one transaction can carry, a request and its owner marker per deposit;
+ * completion steps down from there when change and fees need more room.
+ */
+export function fitWithdrawalDeposits(candidates, maxAmount) {
+    const deposits = [];
+    let total = 0n;
+    for (const deposit of candidates) {
+        if (deposits.length === DAO_OUTPUT_LIMIT / 2) {
+            break;
+        }
+        if (total + deposit.udtValue > maxAmount) {
+            continue;
+        }
+        total += deposit.udtValue;
+        deposits.push(deposit);
+    }
+    return deposits;
+}
+/** Earliest claim first: the deposit that turns into CKB soonest. */
+export function sortByClaim(deposits) {
+    return deposits.toSorted((left, right) => left.claimEpoch.compare(right.claimEpoch));
+}
+//# sourceMappingURL=withdrawal_ring.js.map

package/dist/conversion/withdrawal_ring.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal_ring.js","sourceRoot":"","sources":["../../src/conversion/withdrawal_ring.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAgB7C;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,YAAwC;IACnE,iGAAiG;IACjG,6FAA6F;IAC7F,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACnF,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,gBAAgB,GAAG,QAAQ,EAAE,CAAC;QAC/D,YAAY,IAAI,CAAC,CAAC;IACpB,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAe,EAAE,CAAC,CAAC;QAChF,KAAK;QACL,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;KACb,CAAC,CAAC,CAAC;IAEJ,wFAAwF;IACxF,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;QACnC,2HAA2H;QAC3H,MAAM,OAAO,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAE,CAAC;QAC9E,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IACvC,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,gBAAgB,CAAC,KAAgB,EAAE,YAAoB;IACrE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAC9B,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,GAAG,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC;IAC7D,MAAM,IAAI,GAAG,gBAAgB,GAAG,WAAW,CAAC;IAC5C,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAChD,OAAO,MAAM,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,YAAwC,EACxC,KAAiC;IAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,IAAI,GAAG,CACrB,YAAY,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CACpC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAChB,IAAI,KAAK,SAAS,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;YAC9D,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,IAAI,EACV,SAAS,CACV,CAAC;QACF,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CACH,CAAC;IACF,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,kBAAkB,CACzB,SAA0B,EAC1B,OAAwB,EACxB,OAA4B;IAE5B,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IACpE,IAAI,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;QAClE,OAAO,CAAC,cAAc,CAAC;IACzB,CAAC;IACD,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,UAAsC,EACtC,SAAiB;IAEjB,MAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,GAAG,CAAC,EAAE,CAAC;YAC7C,MAAM;QACR,CAAC;QACD,IAAI,KAAK,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,EAAE,CAAC;YACzC,SAAS;QACX,CAAC;QACD,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC;QAC1B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,WAAW,CAAC,QAAoC;IAC9D,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACvF,CAAC"}

package/dist/dao.d.ts

@@ -0,0 +1,86 @@
+import { ccc } from "@ckb-ccc/core";
+/**
+ * Maximum outputs accepted by deployed dao.c, not a general CKB consensus cap.
+ * A node upgrade cannot lift a limit in that deployed script.
+ */
+export declare const DAO_OUTPUT_LIMIT = 64;
+/**
+ * Deposit-header indices the deployed DAO script can address in a phase-2 witness.
+ *
+ * @remarks The script reads one byte of the u64 field (RFC 0023 erratum,
+ * nervosnetwork/rfcs pull 456).
+ */
+export declare const DAO_HEADER_INDEX_LIMIT = 256;
+/** One DAO cycle, the lock-up a deposit renews by when it is not withdrawn. */
+export declare const DAO_CYCLE_EPOCHS = 180n;
+/**
+ * Error thrown when a transaction exceeds the deployed DAO script's output limit.
+ */
+export declare class DaoOutputLimitError extends Error {
+    /**
+     * Creates an output-limit error for a transaction with too many outputs.
+     */
+    constructor(outputCount: number, options?: ErrorOptions);
+}
+/**
+ * Error thrown when a phase-2 withdrawal would reference a deposit header the
+ * deployed DAO script cannot address.
+ */
+export declare class DaoHeaderIndexError extends Error {
+    /**
+     * Creates a header-index error for one unrepresentable index.
+     */
+    constructor(headerIndex: number, options?: ErrorOptions);
+}
+/**
+ * Throws when a transaction using the DAO script exceeds the Nervos DAO output limit. An
+ * oversized transaction with an unresolved input is refused too: whether it uses the DAO
+ * cannot be known, and the completion walk steps a plan down on this error either way.
+ */
+export declare function assertDaoOutputLimit(txLike: ccc.TransactionLike, daoScriptLike: ccc.ScriptLike): void;
+/** The canonical DAO deposit data payload. */
+export declare function depositData(): ccc.Hex;
+/** Whether the cell is a DAO deposit of the given DAO script. */
+export declare function isDaoDeposit(cell: ccc.CellAny, daoScript: ccc.Script): boolean;
+/**
+ * Whether the cell uses the DAO script and is not deposit-shaped. This structural check
+ * does not decode the withdrawal request's deposit block number payload.
+ */
+export declare function isDaoWithdrawalRequest(cell: ccc.CellAny, daoScript: ccc.Script): boolean;
+/**
+ * A caller's timing rules for withdrawal requests, in epochs (the chain's clock, so no
+ * wall-clock drift). Selection: a deposit may be requested when its claim epoch is past
+ * `tip + minLockUp` (closer, the request would commit after the claim and lock for another
+ * cycle, so the deposit is judged on its next cycle) and before `tip + maxLockUp`.
+ * Broadcast: the signed request is sent only while the tip is before the earliest selected
+ * claim less `broadcastReserve`, else it is refused before broadcast.
+ */
+export interface LockUpPolicy {
+    minLockUp: ccc.Epoch;
+    maxLockUp: ccc.Epoch;
+    broadcastReserve: ccc.Epoch;
+}
+/**
+ * The bot's rules on the nominal four-hour epoch: claims twenty minutes to an hour out,
+ * sent while fifteen minutes remain. The bot signs at once, so a short window suffices, and
+ * the estimate models the pool's supply on it (`sdk/docs/pool_maturity_estimates.md`).
+ */
+export declare const BOT_LOCK_UP: LockUpPolicy;
+/**
+ * A wallet's rules on the nominal four-hour epoch: claims two hours to three days out,
+ * sent while ninety minutes remain. A user may leave the request in a wallet popup.
+ */
+export declare const WALLET_LOCK_UP: LockUpPolicy;
+/** A deposit's maturity, rolled a cycle when its claim is too close, and whether it is ready. */
+export declare function depositMaturity(claim: ccc.Epoch, tip: ccc.ClientBlockHeader, { minLockUp, maxLockUp }: LockUpPolicy): {
+    maturity: ccc.Epoch;
+    isReady: boolean;
+};
+/**
+ * The epoch a transaction requesting these deposits must be broadcast before: the earliest
+ * claim less the reserve; undefined when it requests none.
+ */
+export declare function broadcastDeadline(claims: readonly ccc.Epoch[], { broadcastReserve }: LockUpPolicy): ccc.Epoch | undefined;
+/** Adds the header dep once. */
+export declare function pushHeaderDep(tx: ccc.Transaction, hash: ccc.Hex): void;
+//# sourceMappingURL=dao.d.ts.map

package/dist/dao.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dao.d.ts","sourceRoot":"","sources":["../src/dao.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,+EAA+E;AAC/E,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;IACH,YAAY,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAMtD;CACF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;IACH,YAAY,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAMtD;CACF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,aAAa,EAAE,GAAG,CAAC,UAAU,GAC5B,IAAI,CAeN;AAED,8CAA8C;AAC9C,wBAAgB,WAAW,IAAI,GAAG,CAAC,GAAG,CAErC;AAED,iEAAiE;AACjE,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAI9E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,GAAG,CAAC,OAAO,EACjB,SAAS,EAAE,GAAG,CAAC,MAAM,GACpB,OAAO,CAIT;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC;IACrB,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC;IACrB,gBAAgB,EAAE,GAAG,CAAC,KAAK,CAAC;CAC7B;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,YAIzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,YAI5B,CAAC;AAEF,iGAAiG;AACjG,wBAAgB,eAAe,CAC7B,KAAK,EAAE,GAAG,CAAC,KAAK,EAChB,GAAG,EAAE,GAAG,CAAC,iBAAiB,EAC1B,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,YAAY,GACrC;IAAE,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAM3C;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,GAAG,CAAC,KAAK,EAAE,EAC5B,EAAE,gBAAgB,EAAE,EAAE,YAAY,GACjC,GAAG,CAAC,KAAK,GAAG,SAAS,CAMvB;AAED,gCAAgC;AAChC,wBAAgB,aAAa,CAAC,EAAE,EAAE,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,CAItE"}

package/dist/dao.js

@@ -0,0 +1,113 @@
+import { ccc } from "@ckb-ccc/core";
+import { CheckedUint64LE } from "./utils/codec.js";
+/**
+ * Maximum outputs accepted by deployed dao.c, not a general CKB consensus cap.
+ * A node upgrade cannot lift a limit in that deployed script.
+ */
+export const DAO_OUTPUT_LIMIT = 64;
+/**
+ * Deposit-header indices the deployed DAO script can address in a phase-2 witness.
+ *
+ * @remarks The script reads one byte of the u64 field (RFC 0023 erratum,
+ * nervosnetwork/rfcs pull 456).
+ */
+export const DAO_HEADER_INDEX_LIMIT = 256;
+/** One DAO cycle, the lock-up a deposit renews by when it is not withdrawn. */
+export const DAO_CYCLE_EPOCHS = 180n;
+/**
+ * Error thrown when a transaction exceeds the deployed DAO script's output limit.
+ */
+export class DaoOutputLimitError extends Error {
+    /**
+     * Creates an output-limit error for a transaction with too many outputs.
+     */
+    constructor(outputCount, options) {
+        super(`NervosDAO transaction has ${String(outputCount)} output cells, exceeding the limit of ${String(DAO_OUTPUT_LIMIT)}`, options);
+        this.name = "DaoOutputLimitError";
+    }
+}
+/**
+ * Error thrown when a phase-2 withdrawal would reference a deposit header the
+ * deployed DAO script cannot address.
+ */
+export class DaoHeaderIndexError extends Error {
+    /**
+     * Creates a header-index error for one unrepresentable index.
+     */
+    constructor(headerIndex, options) {
+        super(`NervosDAO deposit header index ${String(headerIndex)} is not below ${String(DAO_HEADER_INDEX_LIMIT)}`, options);
+        this.name = "DaoHeaderIndexError";
+    }
+}
+/**
+ * Throws when a transaction using the DAO script exceeds the Nervos DAO output limit. An
+ * oversized transaction with an unresolved input is refused too: whether it uses the DAO
+ * cannot be known, and the completion walk steps a plan down on this error either way.
+ */
+export function assertDaoOutputLimit(txLike, daoScriptLike) {
+    const tx = ccc.Transaction.from(txLike);
+    if (tx.outputs.length <= DAO_OUTPUT_LIMIT) {
+        return;
+    }
+    const daoScript = ccc.Script.from(daoScriptLike);
+    if (tx.inputs.some((input) => input.cellOutput === undefined || input.cellOutput.type?.eq(daoScript) === true) ||
+        tx.outputs.some((output) => output.type?.eq(daoScript) === true)) {
+        throw new DaoOutputLimitError(tx.outputs.length);
+    }
+}
+/** The canonical DAO deposit data payload. */
+export function depositData() {
+    return ccc.hexFrom(CheckedUint64LE.encode(0n));
+}
+/** Whether the cell is a DAO deposit of the given DAO script. */
+export function isDaoDeposit(cell, daoScript) {
+    return (cell.outputData === depositData() && cell.cellOutput.type?.eq(daoScript) === true);
+}
+/**
+ * Whether the cell uses the DAO script and is not deposit-shaped. This structural check
+ * does not decode the withdrawal request's deposit block number payload.
+ */
+export function isDaoWithdrawalRequest(cell, daoScript) {
+    return (cell.outputData !== depositData() && cell.cellOutput.type?.eq(daoScript) === true);
+}
+/**
+ * The bot's rules on the nominal four-hour epoch: claims twenty minutes to an hour out,
+ * sent while fifteen minutes remain. The bot signs at once, so a short window suffices, and
+ * the estimate models the pool's supply on it (`sdk/docs/pool_maturity_estimates.md`).
+ */
+export const BOT_LOCK_UP = {
+    minLockUp: ccc.Epoch.from([0n, 1n, 12n]),
+    maxLockUp: ccc.Epoch.from([0n, 4n, 16n]),
+    broadcastReserve: ccc.Epoch.from([0n, 1n, 16n]),
+};
+/**
+ * A wallet's rules on the nominal four-hour epoch: claims two hours to three days out,
+ * sent while ninety minutes remain. A user may leave the request in a wallet popup.
+ */
+export const WALLET_LOCK_UP = {
+    minLockUp: ccc.Epoch.from([0n, 1n, 2n]),
+    maxLockUp: ccc.Epoch.from([18n, 0n, 1n]),
+    broadcastReserve: ccc.Epoch.from([0n, 3n, 8n]),
+};
+/** A deposit's maturity, rolled a cycle when its claim is too close, and whether it is ready. */
+export function depositMaturity(claim, tip, { minLockUp, maxLockUp }) {
+    const maturity = claim.compare(minLockUp.add(tip.epoch)) <= 0
+        ? claim.add([DAO_CYCLE_EPOCHS, 0n, 1n])
+        : claim;
+    return { maturity, isReady: maxLockUp.add(tip.epoch).compare(maturity) > 0 };
+}
+/**
+ * The epoch a transaction requesting these deposits must be broadcast before: the earliest
+ * claim less the reserve; undefined when it requests none.
+ */
+export function broadcastDeadline(claims, { broadcastReserve }) {
+    const earliest = claims.reduce((best, claim) => (best === undefined || claim.compare(best) < 0 ? claim : best), undefined);
+    return earliest?.sub(broadcastReserve);
+}
+/** Adds the header dep once. */
+export function pushHeaderDep(tx, hash) {
+    if (!tx.headerDeps.includes(hash)) {
+        tx.headerDeps.push(hash);
+    }
+}
+//# sourceMappingURL=dao.js.map

package/dist/dao.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dao.js","sourceRoot":"","sources":["../src/dao.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C,+EAA+E;AAC/E,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;IACH,YAAY,WAAmB,EAAE,OAAsB;QACrD,KAAK,CACH,6BAA6B,MAAM,CAAC,WAAW,CAAC,yCAAyC,MAAM,CAAC,gBAAgB,CAAC,EAAE,EACnH,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;IACH,YAAY,WAAmB,EAAE,OAAsB;QACrD,KAAK,CACH,kCAAkC,MAAM,CAAC,WAAW,CAAC,iBAAiB,MAAM,CAAC,sBAAsB,CAAC,EAAE,EACtG,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAA2B,EAC3B,aAA6B;IAE7B,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,gBAAgB,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACjD,IACE,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,CAClF;QACD,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,EAChE,CAAC;QACD,MAAM,IAAI,mBAAmB,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,WAAW;IACzB,OAAO,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,YAAY,CAAC,IAAiB,EAAE,SAAqB;IACnE,OAAO,CACL,IAAI,CAAC,UAAU,KAAK,WAAW,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,CAClF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAiB,EACjB,SAAqB;IAErB,OAAO,CACL,IAAI,CAAC,UAAU,KAAK,WAAW,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,CAClF,CAAC;AACJ,CAAC;AAgBD;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;IACxC,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;IACxC,gBAAgB,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;CAChD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAiB;IAC1C,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACvC,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACxC,gBAAgB,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC/C,CAAC;AAEF,iGAAiG;AACjG,MAAM,UAAU,eAAe,CAC7B,KAAgB,EAChB,GAA0B,EAC1B,EAAE,SAAS,EAAE,SAAS,EAAgB;IAEtC,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;QAC1C,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvC,CAAC,CAAC,KAAK,CAAC;IACZ,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA4B,EAC5B,EAAE,gBAAgB,EAAgB;IAElC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAC/E,SAAS,CACV,CAAC;IACF,OAAO,QAAQ,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACzC,CAAC;AAED,gCAAgC;AAChC,MAAM,UAAU,aAAa,CAAC,EAAmB,EAAE,IAAa;IAC9D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,52 @@
-export * from "./sdk.js";
-export * from "./codec.js";
-export * from "./constants.js";
+/**
+ * Public SDK for one iCKB conversion workflow: read the sampled state, quote, build and
+ * complete a conversion, sign, send, and wait.
+ *
+ * @packageDocumentation
+ */
+import type { ccc } from "@ckb-ccc/core";
+import type { AccountState, ConversionTransactionOptions, ConversionTransactionResult, SystemState } from "./conversion/types.js";
+import type { LockUpPolicy } from "./dao.js";
+import type { OrderGroup } from "./order/cells.js";
+import type { SupportedChain } from "./utils/chain.js";
+/** The SDK an integrator drives: the state read and the conversion builder. */
+export interface IckbSdk {
+    /** Builds and completes a conversion, or returns a typed planning failure. */
+    buildConversionTransaction: (txLike: ccc.TransactionLike, options: ConversionTransactionOptions) => Promise<ConversionTransactionResult>;
+    /** Reads system, user-order, and account state against one sampled tip, under one timing policy. */
+    getL1AccountState: (client: ccc.Client, locks: ccc.Script[], lockUp: LockUpPolicy) => Promise<{
+        system: SystemState;
+        user: {
+            orders: OrderGroup[];
+        };
+        account: AccountState;
+    }>;
+}
+/** Creates the SDK for one chain's deployment. */
+export declare const IckbSdk: {
+    fromChain: (chain: SupportedChain) => IckbSdk;
+};
+export { DEFAULT_ORDER_FEE, DEFAULT_ORDER_FEE_BASE } from "./conversion/estimate.js";
+export { projectConversionTransactionContext } from "./conversion/projection.js";
+export type { AccountAvailabilityProjection, AccountState, ConversionDirection, ConversionMetadata, ConversionNotice, ConversionTransactionContext, ConversionTransactionContextProjection, ConversionTransactionFailureReason, ConversionTransactionOptions, ConversionTransactionResult, SystemState, } from "./conversion/types.js";
+export { WALLET_LOCK_UP } from "./dao.js";
+export type { LockUpPolicy } from "./dao.js";
+export type { IckbDepositCell, ReceiptCell } from "./logic.js";
+export type { MasterCell, OrderCell, OrderGroup } from "./order/cells.js";
+export { OrderConversionRepresentabilityError, quoteConversion, } from "./order/conversion.js";
+export { isRefused, isStale } from "./order/fill.js";
+export type { Info, InfoLike } from "./order/info.js";
+export type { Master, MasterLike } from "./order/master.js";
+export type { OrderData, OrderDataLike } from "./order/order_data.js";
+export { Ratio } from "./order/ratio.js";
+export type { Relative, RelativeLike } from "./order/relative.js";
+export type { DaoWithdrawalRequestCell, OwnerCell, WithdrawalGroup, } from "./owned_owner.js";
+export { hasTransactionActivity, IckbError } from "./sdk.js";
+export type { IckbErrorCode } from "./sdk.js";
+export { signAndSendTransaction, signerAccountLocks, TransactionBroadcastError, TransactionExpiredError, } from "./send/sign_and_send_transaction.js";
+export { TransactionWaitError, waitTransaction } from "./send/wait_transaction.js";
+export type { WaitTransactionOptions } from "./send/wait_transaction.js";
+export { ickbExchangeRatio } from "./udt.js";
+export type { SupportedChain } from "./utils/chain.js";
+export type { ExchangeRatio, TransactionHeader, ValueComponents } from "./utils/utils.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"../src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EACV,YAAY,EACZ,4BAA4B,EAC5B,2BAA2B,EAC3B,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,+EAA+E;AAC/E,MAAM,WAAW,OAAO;IACtB,8EAA8E;IAC9E,0BAA0B,EAAE,CAC1B,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,OAAO,EAAE,4BAA4B,KAClC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC1C,oGAAoG;IACpG,iBAAiB,EAAE,CACjB,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,EACnB,MAAM,EAAE,YAAY,KACjB,OAAO,CAAC;QACX,MAAM,EAAE,WAAW,CAAC;QACpB,IAAI,EAAE;YAAE,MAAM,EAAE,UAAU,EAAE,CAAA;SAAE,CAAC;QAC/B,OAAO,EAAE,YAAY,CAAC;KACvB,CAAC,CAAC;CACJ;AAED,kDAAkD;AAElD,eAAO,MAAM,OAAO,EAAE;IAAE,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAA;CAAiB,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,mCAAmC,EAAE,MAAM,4BAA4B,CAAC;AACjF,YAAY,EACV,6BAA6B,EAC7B,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,4BAA4B,EAC5B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,2BAA2B,EAC3B,WAAW,GACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC/D,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACL,oCAAoC,EACpC,eAAe,GAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACtD,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC5D,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAClE,YAAY,EACV,wBAAwB,EACxB,SAAS,EACT,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC7D,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AACnF,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,21 @@
-export * from "./sdk.js";
-export * from "./codec.js";
-export * from "./constants.js";
+/**
+ * Public SDK for one iCKB conversion workflow: read the sampled state, quote, build and
+ * complete a conversion, sign, send, and wait.
+ *
+ * @packageDocumentation
+ */
+import { IckbSdk as IckbSdkClass } from "./sdk.js";
+/** Creates the SDK for one chain's deployment. */
+// eslint-disable-next-line @typescript-eslint/no-redeclare -- The public type and the constructor namespace intentionally share a name.
+export const IckbSdk = IckbSdkClass;
+export { DEFAULT_ORDER_FEE, DEFAULT_ORDER_FEE_BASE } from "./conversion/estimate.js";
+export { projectConversionTransactionContext } from "./conversion/projection.js";
+export { WALLET_LOCK_UP } from "./dao.js";
+export { OrderConversionRepresentabilityError, quoteConversion, } from "./order/conversion.js";
+export { isRefused, isStale } from "./order/fill.js";
+export { Ratio } from "./order/ratio.js";
+export { hasTransactionActivity, IckbError } from "./sdk.js";
+export { signAndSendTransaction, signerAccountLocks, TransactionBroadcastError, TransactionExpiredError, } from "./send/sign_and_send_transaction.js";
+export { TransactionWaitError, waitTransaction } from "./send/wait_transaction.js";
+export { ickbExchangeRatio } from "./udt.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,UAAU,CAAC;AAsBnD,kDAAkD;AAClD,wIAAwI;AACxI,MAAM,CAAC,MAAM,OAAO,GAAsD,YAAY,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,mCAAmC,EAAE,MAAM,4BAA4B,CAAC;AAcjF,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI1C,OAAO,EACL,oCAAoC,EACpC,eAAe,GAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAIrD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAOzC,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAEnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC"}

package/dist/logic.d.ts

@@ -0,0 +1,85 @@
+import { ccc } from "@ckb-ccc/core";
+import { type LockUpPolicy } from "./dao.js";
+import { type ScriptDeps, type TransactionHeader, type ValueComponents } from "./utils/utils.js";
+/**
+ * A live iCKB deposit: a DAO deposit cell locked by the iCKB Logic script, valued at its
+ * deposit header.
+ */
+export interface IckbDepositCell extends ValueComponents {
+    /** The DAO deposit cell. */
+    cell: ccc.Cell;
+    /** The deposit header and the tip the readiness was judged against. */
+    headers: [TransactionHeader, TransactionHeader];
+    /** The DAO interest accrued between the two headers. */
+    interests: ccc.Num;
+    /**
+     * The DAO claim epoch as sampled at the tip, not rolled: each reader judges it against
+     * its own {@link LockUpPolicy} with `depositMaturity`.
+     */
+    claimEpoch: ccc.Epoch;
+}
+/**
+ * Represents a receipt cell containing the receipt for iCKB Deposits.
+ */
+export interface ReceiptCell extends ValueComponents {
+    /** The cell associated with the receipt. */
+    cell: ccc.Cell;
+    /** The header of the transaction that made the deposits. */
+    header: TransactionHeader;
+}
+/**
+ * Manages logic related to deposits and receipts in the blockchain.
+ */
+export declare class LogicManager implements ScriptDeps {
+    /** The iCKB Logic script used as receipt type and DAO deposit lock. */
+    readonly script: ccc.Script;
+    /** Cell dependencies required to execute the iCKB Logic script. */
+    readonly cellDeps: ccc.CellDep[];
+    /** The Nervos DAO script the deposits carry, with its cell deps. */
+    readonly dao: ScriptDeps;
+    /** Creates the manager for one iCKB Logic deployment over one DAO deployment. */
+    constructor(script: ccc.Script, cellDeps: ccc.CellDep[], dao: ScriptDeps);
+    /** Whether the cell is an iCKB receipt: typed by the logic script with a decodable prefix. */
+    isReceipt(cell: ccc.Cell): boolean;
+    /** Whether the cell is a DAO deposit locked by the logic script. */
+    isDeposit(cell: ccc.Cell): boolean;
+    /**
+     * Adds `depositQuantity` DAO deposits of `depositCapacity` locked by the logic script,
+     * then the receipt that mints their iCKB in phase 2, locked by `lock`.
+     *
+     * @remarks Caller must ensure UDT cellDeps are added to the transaction
+     * (e.g., via ickbUdt.addCellDeps(tx)).
+     */
+    deposit(txLike: ccc.TransactionLike, depositQuantity: number, depositCapacity: ccc.FixedPoint, lock: ccc.Script): ccc.Transaction;
+    /**
+     * Adds receipt inputs and their deposit header deps for iCKB deposit completion.
+     *
+     * @remarks This prepares the phase-2 inputs; the iCKB they mint is completed by
+     * `IckbSdk.completeTransaction`.
+     */
+    completeDeposit(txLike: ccc.TransactionLike, receipts: ReceiptCell[]): ccc.Transaction;
+    /**
+     * The receipts among `cells`, valued at their deposit headers, each header read once.
+     */
+    receiptsFrom(client: ccc.Client, cells: readonly ccc.Cell[]): Promise<ReceiptCell[]>;
+    /**
+     * Every live iCKB deposit, valued at its deposit header, with its claim epoch at the tip;
+     * each deposit transaction's header is read once.
+     */
+    findDeposits(client: ccc.Client, tip: ccc.ClientBlockHeader): Promise<IckbDepositCell[]>;
+}
+/** Values a DAO deposit cell at its deposit header and samples its claim epoch at the tip. */
+export declare function ickbDepositCell(cell: ccc.Cell, depositHeader: TransactionHeader, tip: ccc.ClientBlockHeader): IckbDepositCell;
+/** The deposits a withdrawal request made now may claim at their sampled dates under the policy. */
+export declare function readyDeposits(deposits: readonly IckbDepositCell[], tip: ccc.ClientBlockHeader, policy: LockUpPolicy): IckbDepositCell[];
+/** Decodes a receipt cell and values it at its deposit header. */
+export declare function receiptCell(cell: ccc.Cell, header: TransactionHeader): ReceiptCell;
+/**
+ * Returns the CKB needed for the two phase-2 outputs created by one receipt.
+ *
+ * @remarks The value is sized with the actual user lock because lock args affect
+ * occupied capacity. It includes one plain output, one xUDT output, and the
+ * phase-2 fee reserve.
+ */
+export declare function receiptPhase2Capacity(lock: ccc.Script): ccc.FixedPoint;
+//# sourceMappingURL=logic.d.ts.map

package/dist/logic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logic.d.ts","sourceRoot":"","sources":["../src/logic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAOL,KAAK,YAAY,EAClB,MAAM,UAAU,CAAC;AAUlB,OAAO,EAEL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAO1B;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,4BAA4B;IAC5B,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,uEAAuE;IACvE,OAAO,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAChD,wDAAwD;IACxD,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;IACnB;;;OAGG;IACH,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,4CAA4C;IAC5C,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,4DAA4D;IAC5D,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,UAAU;IAC7C,uEAAuE;IACvE,SAAgB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IAEnC,mEAAmE;IACnE,SAAgB,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;IAExC,oEAAoE;IACpE,SAAgB,GAAG,EAAE,UAAU,CAAC;IAEhC,iFAAiF;IACjF,YAAY,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,EAIvE;IAED,8FAA8F;IACvF,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,OAAO,CAKxC;IAED,oEAAoE;IAC7D,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,OAAO,CAExC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,GAAG,CAAC,UAAU,EAC/B,IAAI,EAAE,GAAG,CAAC,MAAM,GACf,GAAG,CAAC,WAAW,CA0CjB;IAED;;;;;OAKG;IACI,eAAe,CACpB,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,QAAQ,EAAE,WAAW,EAAE,GACtB,GAAG,CAAC,WAAW,CAwBjB;IAED;;OAEG;IACU,YAAY,CACvB,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,KAAK,EAAE,SAAS,GAAG,CAAC,IAAI,EAAE,GACzB,OAAO,CAAC,WAAW,EAAE,CAAC,CAWxB;IAED;;;OAGG;IACU,YAAY,CACvB,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,GAAG,EAAE,GAAG,CAAC,iBAAiB,GACzB,OAAO,CAAC,eAAe,EAAE,CAAC,CAuB5B;CACF;AAED,8FAA8F;AAC9F,wBAAgB,eAAe,CAC7B,IAAI,EAAE,GAAG,CAAC,IAAI,EACd,aAAa,EAAE,iBAAiB,EAChC,GAAG,EAAE,GAAG,CAAC,iBAAiB,GACzB,eAAe,CAUjB;AAED,oGAAoG;AACpG,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,SAAS,eAAe,EAAE,EACpC,GAAG,EAAE,GAAG,CAAC,iBAAiB,EAC1B,MAAM,EAAE,YAAY,GACnB,eAAe,EAAE,CAInB;AAED,kEAAkE;AAClE,wBAAgB,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,GAAG,WAAW,CAgBlF;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,UAAU,CAKtE"}