@ickb/sdk 1000.0.82 → 9001.0.0

package/dist/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEvC;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,IAAI,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACpD,CAAC;AAQD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAkB,EAClB,OAAuC;IAEvC,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACnE,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,IAAI,KAAyB,CAAC;IAC9B,SAAS,CAAC;QACR,sLAAsL;QACtL,MAAM,IAAI,GAAG,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE;YACjD,GAAG;YACH,KAAK;YACL,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YACjC,KAAK;SACN,CAAC,CAAiB,CAAC;QACpB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;oBAClB,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;oBAC/D,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;oBAChE,UAAU,EAAE,MAAM,CAAC,WAAW,IAAI,IAAI;iBACvC,CAAC;gBACF,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;aAC9C,CAAC,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,mBAAmB,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QACD,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,uFAAuF;AACvF,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAkB,EAClB,YAA+B;IAE/B,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAC3E,CAAC;IACF,OAAO,IAAI,GAAG,CACZ,QAAQ,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,qCAAqC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAsDD;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAc;IAChD,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAkB;IACjD,MAAM,SAAS,GAAG,WAAW,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,IAAI,CAAC,CAAC,SAAS,YAAY,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,OAAO,CAAC,SAAiB,EAAE,WAAmB;IAC5D,OAAO,CAAC,SAAS,GAAG,WAAW,GAAG,EAAE,CAAC,GAAG,WAAW,CAAC;AACtD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,KAAa;IACvD,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;QACjB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IAED,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;QACjB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,SAAS,CAAC,CAAC,MAAM,CAAuB,KAAkB;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACb,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/utils/verified_client.d.ts

@@ -0,0 +1,19 @@
+import { ccc } from "@ckb-ccc/core";
+/**
+ * Wraps `inner` into a client that checks the reads the SDK makes: every header it hands
+ * out against the header's own hash, a header read by number against the number asked
+ * for, a transaction read by hash against the hash of its body, and a cell against the
+ * body of its creating transaction. Other reads pass through unchecked; the cell
+ * beside `getCellWithHeader`'s header is one, since the SDK reads only its header.
+ *
+ * @remarks It wraps the client, not the SDK's readers, because CCC's own DAO valuation
+ * (`Cell.getNervosDaoInfo`, in the send) reads headers through the client it is given.
+ * Why each check exists: SDK README, Account state.
+ */
+export declare function verifiedClient(inner: ccc.Client): ccc.Client;
+/**
+ * The hash of a header as the chain computes it: blake2b over the header struct, each
+ * number little-endian, in declaration order, the nonce last.
+ */
+export declare function headerHash(header: ccc.ClientBlockHeader): ccc.Hex;
+//# sourceMappingURL=verified_client.d.ts.map

package/dist/utils/verified_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verified_client.d.ts","sourceRoot":"","sources":["../../src/utils/verified_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAE5D;AAqGD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,GAAG,CAAC,GAAG,CAejE"}

package/dist/utils/verified_client.js

@@ -0,0 +1,92 @@
+import { ccc } from "@ckb-ccc/core";
+/**
+ * Wraps `inner` into a client that checks the reads the SDK makes: every header it hands
+ * out against the header's own hash, a header read by number against the number asked
+ * for, a transaction read by hash against the hash of its body, and a cell against the
+ * body of its creating transaction. Other reads pass through unchecked; the cell
+ * beside `getCellWithHeader`'s header is one, since the SDK reads only its header.
+ *
+ * @remarks It wraps the client, not the SDK's readers, because CCC's own DAO valuation
+ * (`Cell.getNervosDaoInfo`, in the send) reads headers through the client it is given.
+ * Why each check exists: SDK README, Account state.
+ */
+export function verifiedClient(inner) {
+    return new VerifiedClient(inner);
+}
+// @ts-expect-error TS2655: the abstract members are forwarded by the proxy at runtime, as in CCC's own connector.
+class VerifiedClient extends ccc.Proxy.Base(ccc.Client) {
+    static [ccc.Proxy.localKeys] = ["bodies"];
+    /** Creating transactions `getCell` read, so concurrent reads of one share a request. */
+    bodies = new Map();
+    async getTipHeader() {
+        return verified(await this[ccc.Proxy.inner].getTipHeader());
+    }
+    async getHeaderByNumber(...args) {
+        const header = ccc.apply(verified, await this[ccc.Proxy.inner].getHeaderByNumber(...args));
+        const number = ccc.numFrom(args[0]);
+        if (header !== undefined && header.number !== number) {
+            throw new Error(`Header ${header.hash} answers for block ${number.toString()}`);
+        }
+        return header;
+    }
+    async getTransaction(...args) {
+        return verifiedBody(await this[ccc.Proxy.inner].getTransaction(...args), args[0]);
+    }
+    /**
+     * The output of the verified creating transaction, cache first: CCC keys cached
+     * transactions by their body's hash, and its own `getCell` would build the cell from a
+     * read this wrapper never sees, then cache it.
+     */
+    async getCell(...args) {
+        const outPoint = ccc.OutPoint.from(args[0]);
+        const { txHash } = outPoint;
+        let body = this.bodies.get(txHash);
+        if (body === undefined) {
+            body = this.readBody(txHash);
+            this.bodies.set(txHash, body);
+        }
+        const output = (await body)?.transaction.getOutput(outPoint.index);
+        return output === undefined
+            ? undefined
+            : ccc.Cell.from({
+                outPoint,
+                cellOutput: output.cellOutput,
+                outputData: output.outputData,
+            });
+    }
+    async readBody(txHash) {
+        // CCC's own cache keys bodies by their hash, but a consumer's cache need not.
+        return (verifiedBody(await this.cache.getTransactionResponse(txHash), txHash) ??
+            (await this.getTransaction(txHash)));
+    }
+    async getCellWithHeader(...args) {
+        const result = await this[ccc.Proxy.inner].getCellWithHeader(...args);
+        ccc.apply(verified, result?.header);
+        return result;
+    }
+}
+/** The response when its body hashes to the hash asked for, else throws. */
+function verifiedBody(response, txHash) {
+    const asked = ccc.hexFrom(txHash);
+    if (response !== undefined && response.transaction.hash() !== asked) {
+        throw new Error(`Transaction ${asked} was answered with a body of another hash`);
+    }
+    return response;
+}
+/** The header when its fields hash to the hash it carries, else throws. */
+function verified(header) {
+    const computed = headerHash(header);
+    if (computed !== header.hash) {
+        throw new Error(`Header ${header.hash} carries the fields of ${computed}`);
+    }
+    return header;
+}
+/**
+ * The hash of a header as the chain computes it: blake2b over the header struct, each
+ * number little-endian, in declaration order, the nonce last.
+ */
+export function headerHash(header) {
+    const { dao } = header;
+    return ccc.hashCkb(ccc.numLeToBytes(header.version, 4), ccc.numLeToBytes(header.compactTarget, 4), ccc.numLeToBytes(header.timestamp, 8), ccc.numLeToBytes(header.number, 8), ccc.numLeToBytes(header.epoch.toNum(), 8), header.parentHash, header.transactionsRoot, header.proposalsHash, header.extraHash, ...[dao.c, dao.ar, dao.s, dao.u].map((field) => ccc.numLeToBytes(field, 8)), ccc.numLeToBytes(header.nonce, 16));
+}
+//# sourceMappingURL=verified_client.js.map

package/dist/utils/verified_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verified_client.js","sourceRoot":"","sources":["../../src/utils/verified_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,KAAiB;IAC9C,OAAO,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC;AAED,kHAAkH;AAClH,MAAM,cAAe,SAAQ,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IAC9C,MAAM,CAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE1D,wFAAwF;IACvE,MAAM,GAAG,IAAI,GAAG,EAG9B,CAAC;IAEY,KAAK,CAAC,YAAY;QAChC,OAAO,QAAQ,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC;IAC9D,CAAC;IAEe,KAAK,CAAC,iBAAiB,CACrC,GAAG,IAAiD;QAEpD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CACtB,QAAQ,EACR,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CACvD,CAAC;QACF,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,CAAC,IAAI,sBAAsB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEe,KAAK,CAAC,cAAc,CAClC,GAAG,IAA8C;QAEjD,OAAO,YAAY,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACa,KAAK,CAAC,OAAO,CAC3B,GAAG,IAAuC;QAE1C,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;QAC5B,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnE,OAAO,MAAM,KAAK,SAAS;YACzB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;gBACZ,QAAQ;gBACR,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B,CAAC,CAAC;IACT,CAAC;IAEO,KAAK,CAAC,QAAQ,CACpB,MAAe;QAEf,8EAA8E;QAC9E,OAAO,CACL,YAAY,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;YACrE,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CACpC,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,iBAAiB,CACrC,GAAG,IAAiD;QAEpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC;QACtE,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,4EAA4E;AAC5E,SAAS,YAAY,CACnB,QAAmD,EACnD,MAAmB;IAEnB,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,eAAe,KAAK,2CAA2C,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,2EAA2E;AAC3E,SAAS,QAAQ,CAAC,MAA6B;IAC7C,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,CAAC,IAAI,0BAA0B,QAAQ,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,MAA6B;IACtD,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;IACvB,OAAO,GAAG,CAAC,OAAO,CAChB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,EACnC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,EACzC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EACrC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAClC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EACzC,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,gBAAgB,EACvB,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,SAAS,EAChB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAC3E,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CACnC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ickb/sdk",
-  "version": "1000.0.82",
+  "version": "9001.0.0",
   "description": "iCKB SDK built on top of CCC",
   "keywords": [
     "ickb",
@@ -10,52 +10,45 @@
   ],
   "author": "phroi",
   "license": "MIT",
-  "homepage": "https://github.com/ickb/sdk",
+  "homepage": "https://ickb.org",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ickb/sdk"
+    "url": "git+https://github.com/ickb/stack.git"
   },
   "bugs": {
-    "url": "https://github.com/ickb/sdk/issues"
+    "url": "https://github.com/ickb/stack/issues"
   },
   "sideEffects": false,
   "type": "module",
+  "engines": {
+    "node": ">=26"
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
   },
-  "engines": {
-    "node": ">=18"
-  },
   "files": [
     "dist",
     "src"
   ],
   "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.29.0",
-    "eslint": "^9.29.0",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.34.0"
+    "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "canary",
-    "@ickb/core": "^1000.0.82",
-    "@ickb/dao": "^1000.0.82",
-    "@ickb/order": "^1000.0.82",
-    "@ickb/utils": "^1000.0.82"
+    "@ckb-ccc/core": "^1.23.0"
+  },
+  "devDependencies": {
+    "@ickb/testkit": "9001.0.0",
+    "@typescript/native-preview": "7.0.0-dev.20260707.2"
   },
   "scripts": {
-    "lint": "eslint ./src",
-    "clean": "rm -fr pnpm-lock.yaml dist/*",
-    "revamp": "pnpm clean; pnpm up && node dist/index.js && pnpm lint"
+    "test": "vitest",
+    "build": "rm -fr dist && tsgo -p tsconfig.build.json && node ../scripts/tooling/build/rewrite-dts-imports.ts dist",
+    "lint:api": "api-extractor run",
+    "lint:publish": "publint --strict --pack pnpm"
   }
 }

package/src/constants.ts

@@ -1,205 +1,89 @@
 import { ccc } from "@ckb-ccc/core";
-import { IckbUdtManager, LogicManager, OwnedOwnerManager } from "@ickb/core";
-import { DaoManager } from "@ickb/dao";
-import { OrderManager } from "@ickb/order";
-import { CapacityManager, unique, type ScriptDeps } from "@ickb/utils";
+import type { SdkManagers } from "./conversion/types.ts";
+import { LogicManager } from "./logic.ts";
+import { OrderManager } from "./order/order.ts";
+import { OwnedOwnerManager } from "./owned_owner.ts";
+import { IckbUdt } from "./udt.ts";
+import type { SupportedChain } from "./utils/chain.ts";
 
-/**
- * Retrieves the configuration for the given deployment environment.
- *
- * Accepts either a string identifier ("mainnet" or "testnet") or a custom configuration
- * object containing script dependencies for a devnet.
- *
- * It sets up various managers (UDT, Logic, OwnedOwner, Order, Dao, Capacity) and also
- * aggregates a unique list of known bot scripts.
- *
- * @param d - Either a network identifier ("mainnet"/"testnet") or an object containing
- *   explicit script dependencies for devnet.
- * @param bots - An optional array of bot script-like objects to augment the list of known bots.
- * @returns An object containing the instantiated managers and bots.
- */
-export function getConfig(
-  d:
-    | "mainnet"
-    | "testnet"
-    | {
-        // For devnet configuration provide explicit script dependencies.
-        udt: ScriptDeps;
-        logic: ScriptDeps;
-        ownedOwner: ScriptDeps;
-        order: ScriptDeps;
-        dao: ScriptDeps;
-      },
-  bots: ccc.ScriptLike[] = [],
-): {
-  managers: {
-    capacity: CapacityManager;
-    dao: DaoManager;
-    ickbUdt: IckbUdtManager;
-    logic: LogicManager;
-    ownedOwner: OwnedOwnerManager;
-    order: OrderManager;
-  };
-  bots: ccc.Script[];
-} {
-  // If deps is provided as a network string, use the pre-defined constants.
-  if (d === "mainnet" || d === "testnet") {
-    bots = bots.concat(
-      d === "mainnet" ? MAINNET_KNOWN_BOTS : TESTNET_KNOWN_BOTS,
-    );
-    const depGroup = d === "mainnet" ? MAINNET_DEP_GROUP : TESTNET_DEP_GROUP;
-    d = {
-      udt: from(UDT, depGroup),
-      logic: from(ICKB_LOGIC, depGroup),
-      ownedOwner: from(OWNED_OWNER, depGroup),
-      order: from(ORDER, depGroup),
-      dao: from(DAO, depGroup),
-    };
-  }
-
-  const capacity = CapacityManager.withAnyData();
-  const dao = new DaoManager(d.dao.script, d.dao.cellDeps);
-  const ickbUdt = new IckbUdtManager(
-    d.udt.script,
-    d.udt.cellDeps,
-    d.logic.script,
-    dao,
-  );
-  const logic = new LogicManager(
-    d.logic.script,
-    d.logic.cellDeps,
-    dao,
-    ickbUdt,
-  );
-  const ownedOwner = new OwnedOwnerManager(
-    d.ownedOwner.script,
-    d.ownedOwner.cellDeps,
-    dao,
-    ickbUdt,
-  );
-  const order = new OrderManager(d.order.script, d.order.cellDeps, ickbUdt);
-
-  return {
-    managers: {
-      capacity,
-      dao,
-      ickbUdt,
-      logic,
-      ownedOwner,
-      order,
-    },
-    bots: [...unique(bots.map((b) => ccc.Script.from(b)))],
-  };
-}
-
-/**
- * Wraps a script-like object into a ScriptDeps structure.
- *
- * @param script - The script or script-like object.
- * @param cellDeps - Additional cell dependencies that the script may require.
- * @returns An object containing the script and its associated cell dependencies.
- */
-function from(script: ccc.ScriptLike, ...cellDeps: ccc.CellDep[]): ScriptDeps {
-  return {
-    script: ccc.Script.from(script),
-    cellDeps,
-  };
-}
-
-/**
- * DAO (Decentralized Autonomous Organization) lock script information.
- */
-const DAO = {
-  codeHash:
-    "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e",
+/** Nervos DAO type script. */
+const DAO = ccc.Script.from({
+  codeHash: "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e",
   hashType: "type",
   args: "0x",
-};
+});
 
-/**
- * UDT (User Defined Token) lock script information used for onchain validation.
- */
-const UDT = {
-  codeHash:
-    "0x50bd8d6680b8b9cf98b73f3c08faf8b2a21914311954118ad6609be6e78a1b95",
+/** Raw xUDT type script; the iCKB args are computed by `IckbUdt.typeScriptFrom`. */
+const UDT = ccc.Script.from({
+  codeHash: "0x50bd8d6680b8b9cf98b73f3c08faf8b2a21914311954118ad6609be6e78a1b95",
   hashType: "data1",
-  args: "0xb73b6ab39d79390c6de90a09c96b290c331baf1798ed6f97aed02590929734e800000080",
-};
+  args: "0x",
+});
 
-/**
- * Logic script information for the iCKB logic contract.
- */
-const ICKB_LOGIC = {
-  codeHash:
-    "0x2a8100ab5990fa055ab1b50891702e1e895c7bd1df6322cd725c1a6115873bd3",
+/** iCKB Logic script. */
+const ICKB_LOGIC = ccc.Script.from({
+  codeHash: "0x2a8100ab5990fa055ab1b50891702e1e895c7bd1df6322cd725c1a6115873bd3",
   hashType: "data1",
   args: "0x",
-};
+});
 
-/**
- * OwnedOwner lock script information.
- */
-const OWNED_OWNER = {
-  codeHash:
-    "0xacc79e07d107831feef4c70c9e683dac5644d5993b9cb106dca6e74baa381bd0",
+/** Owned Owner lock script. */
+const OWNED_OWNER = ccc.Script.from({
+  codeHash: "0xacc79e07d107831feef4c70c9e683dac5644d5993b9cb106dca6e74baa381bd0",
   hashType: "data1",
   args: "0x",
-};
+});
 
-/**
- * Order lock script information.
- */
-const ORDER = {
-  codeHash:
-    "0x49dfb6afee5cc8ac4225aeea8cb8928b150caf3cd92fea33750683c74b13254a",
+/** Order lock script. */
+const ORDER = ccc.Script.from({
+  codeHash: "0x49dfb6afee5cc8ac4225aeea8cb8928b150caf3cd92fea33750683c74b13254a",
   hashType: "data1",
   args: "0x",
-};
-
-/**
- * Mainnet dependency group cell dep.
- */
-const MAINNET_DEP_GROUP = ccc.CellDep.from({
-  outPoint: {
-    txHash:
-      "0x621a6f38de3b9f453016780edac3b26bfcbfa3e2ecb47c2da275471a5d3ed165",
-    index: "0x0",
-  },
-  depType: "depGroup",
 });
 
 /**
- * Testnet dependency group cell dep.
+ * Each network's iCKB dep group: it carries every iCKB script's code cell, xUDT's and
+ * iCKB Logic's included, so one group dep resolves them all.
  */
-const TESTNET_DEP_GROUP = ccc.CellDep.from({
-  outPoint: {
-    txHash:
-      "0xf7ece4fb33d8378344cab11fcd6a4c6f382fd4207ac921cf5821f30712dcd311",
-    index: "0x0",
+const DEPLOYMENTS = {
+  mainnet: {
+    depGroup: {
+      txHash: "0x621a6f38de3b9f453016780edac3b26bfcbfa3e2ecb47c2da275471a5d3ed165",
+      index: 0,
+    },
   },
-  depType: "depGroup",
-});
-
-/**
- * Array of known bot scripts on the mainnet.
- */
-const MAINNET_KNOWN_BOTS = [
-  {
-    codeHash:
-      "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
-    hashType: "type",
-    args: "0xd096cb29e2f68a85a46bd6bf6cbee6327959ba64",
+  testnet: {
+    depGroup: {
+      txHash: "0xf7ece4fb33d8378344cab11fcd6a4c6f382fd4207ac921cf5821f30712dcd311",
+      index: 0,
+    },
   },
-];
+} as const;
 
 /**
- * Array of known bot scripts on the testnet.
+ * The managers of one network's iCKB deployment.
+ *
+ * @remarks Builders still return partial transactions. `IckbSdk` owns the shared iCKB
+ * completion path as `sdk.completeTransaction(...)`, which callers invoke before send.
  */
-const TESTNET_KNOWN_BOTS = [
-  {
-    codeHash:
-      "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
-    hashType: "type",
-    args: "0xb4380110f7679ac31cefe4925485645d82bf619f",
-  },
-];
+export function getConfig(chain: SupportedChain): SdkManagers {
+  // The runtime check stands for callers outside TypeScript.
+  if (!Object.hasOwn(DEPLOYMENTS, chain)) {
+    throw new TypeError("unsupported iCKB network");
+  }
+  const { depGroup } = DEPLOYMENTS[chain];
+  const cellDeps = [ccc.CellDep.from({ outPoint: depGroup, depType: "depGroup" })];
+  const dao = { script: DAO, cellDeps };
+  const ickbUdt = new IckbUdt({
+    script: IckbUdt.typeScriptFrom(UDT, ICKB_LOGIC),
+    cellDeps,
+    logicScript: ICKB_LOGIC,
+    daoScript: DAO,
+  });
+  return {
+    ickbUdt,
+    ownedOwner: new OwnedOwnerManager(OWNED_OWNER, cellDeps, dao),
+    ickbLogic: new LogicManager(ICKB_LOGIC, cellDeps, dao),
+    order: new OrderManager(ORDER, cellDeps, ickbUdt.script),
+  };
+}

package/src/conversion/estimate.ts

@@ -0,0 +1,155 @@
+import type { IckbDepositCell } from "../logic.ts";
+import {
+  OrderConversionRepresentabilityError,
+  quoteConversion,
+} from "../order/conversion.ts";
+import { ceilDiv, type ValueComponents } from "../utils/utils.ts";
+import { maturity } from "./maturity.ts";
+import type { ConversionOrderEstimate, SystemState } from "./types.ts";
+
+/**
+ * Default order fee: 0.01%. At roughly 2% annual DAO yield this buys about two days of
+ * price headroom for a buy, versus hours at 0.001%; actual fillability also depends on
+ * mining fees. It leaves time to notice a stalled bot without charging the much larger 0.1%.
+ */
+export const DEFAULT_ORDER_FEE = 10n;
+
+/** Default order-fee denominator used by Stack conversion quotes and plans. */
+export const DEFAULT_ORDER_FEE_BASE = 100000n;
+
+/** The quote and its maturity estimate, or `undefined` when no order ratio represents it. */
+export function estimateConversionOrder(
+  isCkb2Udt: boolean,
+  amounts: ValueComponents,
+  system: SystemState,
+  { fee, feeBase }: { fee: bigint; feeBase: bigint },
+  takenDeposits: readonly IckbDepositCell[] = [],
+): ConversionOrderEstimate | undefined {
+  let quote: ReturnType<typeof quoteConversion>;
+  try {
+    quote = quoteConversion(isCkb2Udt, system.exchangeRatio, amounts, { fee, feeBase });
+  } catch (error) {
+    if (error instanceof OrderConversionRepresentabilityError) {
+      return undefined;
+    }
+    throw error;
+  }
+  const estimatedMaturity =
+    quote.ckbFee >= estimateMaturityFeeThreshold(system)
+      ? maturity({ info: quote.info, amounts }, system, takenDeposits)
+      : undefined;
+  return { ...quote, maturity: estimatedMaturity };
+}
+
+/**
+ * Returns the CKB fee threshold above which order maturity is worth estimating.
+ * This conservative proxy stays separate from partialOrderFee: the quote has no built
+ * order whose serialized size could supply that fee yet.
+ */
+function estimateMaturityFeeThreshold(system: Pick<SystemState, "feeRate">): bigint {
+  return 10n * system.feeRate;
+}
+
+/**
+ * The smallest request one direction accepts as an order at the current fee rate. A
+ * CKB-to-iCKB remainder pays the default order fee, which must cover the maturity threshold
+ * of ten mining fees; an iCKB-to-CKB remainder can give its whole CKB value as the dust
+ * fee, so its value must exceed the threshold. The extra unit covers the quote's rounding,
+ * as the dust search's boundary shows; callers round up further for display.
+ */
+export function minimumOrderAmount(isCkb2Udt: boolean, system: SystemState): bigint {
+  const threshold = estimateMaturityFeeThreshold(system) + 1n;
+  if (isCkb2Udt) {
+    return ceilDiv(threshold * DEFAULT_ORDER_FEE_BASE, DEFAULT_ORDER_FEE);
+  }
+  const { ckbScale, udtScale } = system.exchangeRatio;
+  return ceilDiv(threshold * ckbScale, udtScale);
+}
+
+/**
+ * The order leg of an iCKB-to-CKB conversion: at the default fee when that fee clears the
+ * maturity threshold, else the smallest fee that does (a dust order, noticed). Either way
+ * it is dated: a sell order at par is always covered by the pool (see `maturity`).
+ */
+export function estimateIckbToCkbOrder(
+  amounts: ValueComponents,
+  system: SystemState,
+  takenDeposits: readonly IckbDepositCell[],
+): (ConversionOrderEstimate & { maturity: bigint }) | undefined {
+  const base = estimateConversionOrder(
+    false,
+    amounts,
+    system,
+    { fee: DEFAULT_ORDER_FEE, feeBase: DEFAULT_ORDER_FEE_BASE },
+    takenDeposits,
+  );
+  if (base?.maturity !== undefined) {
+    return { ...base, maturity: base.maturity };
+  }
+
+  const dust = estimateDustIckbToCkbOrder(amounts, system);
+  if (dust === undefined) {
+    return undefined;
+  }
+  return {
+    ...dust,
+    maturity: maturity({ info: dust.info, amounts }, system, takenDeposits),
+    notice: {
+      inputIckb: amounts.udtValue,
+      outputCkb: dust.convertedAmount,
+      incentiveCkb: positiveFee(dust.ckbFee),
+    },
+  };
+}
+
+function estimateDustIckbToCkbOrder(
+  amounts: ValueComponents,
+  system: SystemState,
+): ConversionOrderEstimate | undefined {
+  const baseEstimate = estimateConversionOrder(false, amounts, system, {
+    fee: 0n,
+    feeBase: DEFAULT_ORDER_FEE_BASE,
+  });
+  if (baseEstimate === undefined) {
+    return undefined;
+  }
+  const targetFee = estimateMaturityFeeThreshold(system);
+  const feeBase = baseEstimate.convertedAmount + 1n;
+  if (targetFee <= 0n || feeBase <= 1n) {
+    return baseEstimate;
+  }
+  const estimateWithFee = (fee: bigint): ConversionOrderEstimate | undefined =>
+    estimateConversionOrder(false, amounts, system, { fee, feeBase });
+  return lowestFeeEstimateAtThreshold(estimateWithFee, feeBase - 1n, targetFee);
+}
+
+function lowestFeeEstimateAtThreshold(
+  estimateWithFee: (fee: bigint) => ConversionOrderEstimate | undefined,
+  highestFee: bigint,
+  targetFee: bigint,
+): ConversionOrderEstimate | undefined {
+  const highestDiscount = estimateWithFee(highestFee);
+  if (highestDiscount === undefined || highestDiscount.ckbFee < targetFee) {
+    return undefined;
+  }
+
+  let low = 0n;
+  let high = highestFee;
+  while (low < high) {
+    const mid = (low + high) / 2n;
+    const estimateAtMid = estimateWithFee(mid);
+    if (estimateAtMid === undefined) {
+      return undefined;
+    }
+    if (estimateAtMid.ckbFee >= targetFee) {
+      high = mid;
+    } else {
+      low = mid + 1n;
+    }
+  }
+  return estimateWithFee(low);
+}
+
+function positiveFee(fee: bigint): bigint {
+  return fee > 0n ? fee : 0n;
+}