iCKB Stack

iCKB Stack is the monorepo for the current TypeScript iCKB libraries and apps built on top of CCC.

Transaction Completion Boundary

@ickb/sdk builders still return partial ccc.Transaction values. Callers explicitly choose when to finalize, and the shared completion path now also lives in @ickb/sdk.

Callers own the final completion pipeline:

1. Build the partial transaction through IckbSdk and the package managers.
2. Before send, call sdk.completeTransaction(...) or completeIckbTransaction(...) from @ickb/sdk.
3. Only then send the transaction.

Withdrawal requests built from public pool ready deposits may include requiredLiveDeposits. @ickb/sdk adds those cells as live cell_dep checks so a transaction fails if a protected pool anchor disappears before inclusion.

Scan Completeness Boundary

Stack cell scans that feed account state, pool state, order books, or maturity estimates request one sentinel entry beyond the configured logical limit and fail closed if the sentinel appears. Callers should treat these errors as incomplete state, not as zero balance or unavailable liquidity.

User Lock Assumption

Current stack flows assume user-owned cells are protected by locks whose signatures bind the whole transaction, such as standard sighash wallet flows. Passing a raw ccc.Script is only safe when that lock gives the same output and recipient binding. Delegated-signature or OTX-style locks are integration-specific and must account for the weak-lock boundary documented in the iCKB whitepaper and contracts audit.

Local CCC Workflow

The shared CCC baseline lives in forks/ccc/pin/ and materializes into forks/ccc/repo/.

Prerequisites: git and jq.

From a plain checkout:

git clone git@github.com:ickb/stack.git && cd stack
pnpm forks:bootstrap
pnpm install
pnpm forks:ccc
pnpm check

pnpm check is the validation gate. It always runs with CI=true.

pnpm forks:ccc computes the local CCC build surface from the stack's direct @ckb-ccc/* dependencies and their current CCC dependency closure, so it avoids rebuilding unrelated packages like ckb-ccc, @ckb-ccc/connector, @ckb-ccc/connector-react, and @ckb-ccc/lumos-patches.

To inspect that current CCC surface without building anything:

pnpm forks:ccc:plan

For machine-readable inspection, use pnpm -s forks:ccc --json.

For active CCC work, keep built output fresh with:

pnpm forks:ccc --watch

Watch mode keeps the ESM dist/ output fresh for the closure's tsc packages, including @ckb-ccc/spore, and prebuilds @ckb-ccc/did-ckb plus @ckb-ccc/type-id once so @ckb-ccc/shell and @ckb-ccc/ccc keep resolving against built output. If you change either tsdown package, rerun pnpm forks:ccc.

For quick consumer-context sanity checks after rebuilding CCC:

pnpm forks:ccc:smoke

That smoke path verifies the current direct Stack import surface through real consumers: @ckb-ccc/core from @ickb/utils, @ckb-ccc/udt from @ickb/core, and @ckb-ccc/ccc from apps/interface.

If you add a new direct @ckb-ccc/* dependency to any stack package, add the matching root override in pnpm-workspace.yaml. pnpm check:ccc-overrides enforces this.

If you need to update or save the shared CCC baseline, use forks/phroi_forker/repo/ directly. forks/ccc/pin/manifest is the source of truth for the shared upstream refs.

Licensing

This source code, crafted with care by Phroi, is freely available on GitHub and it is released under the MIT License.