@ckb-ccc/ssri 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @ckb-ccc/ssri
+
+## 0.1.0
+
+### Minor Changes
+
+- [#130](https://github.com/ckb-devrel/ccc/pull/130) [`8c97c85`](https://github.com/ckb-devrel/ccc/commit/8c97c851db4a2d940c7e59116ca7620cfd0afae1) Thanks [@Hanssen0](https://github.com/Hanssen0)! - feat: SSRI & UDT SDK
+
+### Patch Changes
+
+- Updated dependencies [[`4dbf4fd`](https://github.com/ckb-devrel/ccc/commit/4dbf4fd8021cf14d05282706a7667ea7d108fb09), [`4c76f9e`](https://github.com/ckb-devrel/ccc/commit/4c76f9e2a93a226fcfc4c32a5378bb531bfff08f), [`c2c4c26`](https://github.com/ckb-devrel/ccc/commit/c2c4c264e04461948e4b913b2f22054e6032ddc8), [`b6a73fa`](https://github.com/ckb-devrel/ccc/commit/b6a73fa9628ebdff51cb8f246309654cd53e36f2), [`8c97c85`](https://github.com/ckb-devrel/ccc/commit/8c97c851db4a2d940c7e59116ca7620cfd0afae1)]:
+  - @ckb-ccc/core@1.3.0

package/README.md

@@ -0,0 +1,54 @@
+<p align="center">
+  <a href="https://app.ckbccc.com/">
+    <img alt="Logo" src="https://raw.githubusercontent.com/ckb-devrel/ccc/master/assets/logoAndText.svg" style="height: 8rem; max-width: 90%; padding: 0.5rem 0;" />
+  </a>
+</p>
+
+<h1 align="center" style="font-size: 48px;">
+  CCC's Support for SSRI
+</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@ckb-ccc/ssri"><img
+    alt="NPM Version" src="https://img.shields.io/npm/v/%40ckb-ccc%2Fssri"
+  /></a>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/ckb-devrel/ccc" />
+  <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/ckb-devrel/ccc/master" />
+  <img alt="GitHub branch check runs" src="https://img.shields.io/github/check-runs/ckb-devrel/ccc/master" />
+  <a href="https://live.ckbccc.com/"><img
+    alt="Playground" src="https://img.shields.io/website?url=https%3A%2F%2Flive.ckbccc.com%2F&label=Playground"
+  /></a>
+  <a href="https://app.ckbccc.com/"><img
+    alt="App" src="https://img.shields.io/website?url=https%3A%2F%2Fapp.ckbccc.com%2F&label=App"
+  /></a>
+  <a href="https://docs.ckbccc.com/"><img
+    alt="Docs" src="https://img.shields.io/website?url=https%3A%2F%2Fdocs.ckbccc.com%2F&label=Docs"
+  /></a>
+</p>
+
+<p align="center">
+  CCC - CKBers' Codebase is a one-stop solution for your CKB JS/TS ecosystem development.
+  <br />
+  Empower yourself with CCC to discover the unlimited potential of CKB.
+  <br />
+  Interoperate with wallets from different chain ecosystems.
+  <br />
+  Fully enabling CKB's Turing completeness and cryptographic freedom power.
+</p>
+
+### Script-Sourced Rich Information
+
+Read more about SSRI on [[EN/CN] Script-Sourced Rich Information - 来源于 Script 的富信息](https://talk.nervos.org/t/en-cn-script-sourced-rich-information-script/8256).
+
+NOTE: This is the base package for interaction with SSRI-Compliant scripts.
+
+If you are looking for UDT support, please refer directly to [@ckb-ccc/udt](https://www.npmjs.com/package/@ckb-ccc/udt) which supports both SSRI-compliant UDT and falling back to xUDT.
+
+### Related Projects
+
+- [`ssri-server`](https://github.com/ckb-devrel/ssri-server): Server for calling SSRI methods.
+- [`ckb_ssri_sdk`](https://github.com/ckb-devrel/ckb_ssri_sdk): A toolkit to help developers build SSRI-Compliant scripts on CKB with production level example script `pausable-udt` for reference.
+
+<h3 align="center">
+  Read more about CCC on <a href="https://docs.ckbccc.com">our website</a> or <a href="https://github.com/ckb-devrel/ccc">GitHub Repo</a>.
+</h3>

package/dist/barrel.d.ts

@@ -0,0 +1,4 @@
+export * from "./executor.js";
+export * from "./trait.js";
+export * from "./utils.js";
+//# sourceMappingURL=barrel.d.ts.map

package/dist/barrel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"barrel.d.ts","sourceRoot":"","sources":["../src/barrel.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/barrel.js

@@ -0,0 +1,3 @@
+export * from "./executor.js";
+export * from "./trait.js";
+export * from "./utils.js";

package/dist/executor.d.ts

@@ -0,0 +1,51 @@
+import { ccc } from "@ckb-ccc/core";
+export type ContextTransaction = {
+    script?: ccc.ScriptLike | null;
+    cell?: Omit<ccc.CellLike, "outPoint"> | null;
+    tx: ccc.TransactionLike;
+};
+export type ContextCell = {
+    script?: ccc.ScriptLike | null;
+    cell: Omit<ccc.CellLike, "outPoint">;
+    tx?: undefined | null;
+};
+export type ContextScript = {
+    script: ccc.ScriptLike;
+    cell?: undefined | null;
+    tx?: undefined | null;
+};
+export type ContextCode = undefined | {
+    script?: undefined | null;
+    cell?: undefined | null;
+    tx?: undefined | null;
+};
+export declare class ExecutorResponse<T> {
+    readonly res: T;
+    readonly cellDeps: ccc.OutPoint[];
+    constructor(res: T, cellDeps: ccc.OutPoint[]);
+    static new<T>(res: T, cellDeps?: ccc.OutPointLike[] | null): ExecutorResponse<T>;
+    map<U>(fn: (res: T) => U): ExecutorResponse<U>;
+}
+export declare class ExecutorErrorExecutionFailed extends Error {
+    constructor(msg?: string);
+}
+/**
+ * Represents an SSRI executor.
+ */
+export declare abstract class Executor {
+    abstract runScript(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex>>;
+    runScriptTry(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex> | undefined>;
+}
+export declare class ExecutorJsonRpc extends Executor {
+    readonly requestor: ccc.RequestorJsonRpc;
+    /**
+     * Creates an instance of SSRI executor through Json RPC.
+     * @param {string} [url] - The external server URL.
+     */
+    constructor(url: string, config?: ccc.RequestorJsonRpcConfig & {
+        requestor?: ccc.RequestorJsonRpc;
+    });
+    get url(): string;
+    runScript(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex>>;
+}
+//# sourceMappingURL=executor.d.ts.map

package/dist/executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../src/executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;IAC7C,EAAE,EAAE,GAAG,CAAC,eAAe,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrC,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,SAAS,GACT;IACE,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC1B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEN,qBAAa,gBAAgB,CAAC,CAAC;aAEX,GAAG,EAAE,CAAC;aACN,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE;gBADxB,GAAG,EAAE,CAAC,EACN,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE;IAG1C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,YAAY,EAAE,GAAG,IAAI;IAI1D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;CAG/C;AAED,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,GAAG,CAAC,EAAE,MAAM;CAGzB;AAED;;GAEG;AACH,8BAAsB,QAAQ;IAC5B,QAAQ,CAAC,SAAS,CAChB,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE/B,YAAY,CAChB,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;CAUlD;AAED,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,SAAgB,SAAS,EAAE,GAAG,CAAC,gBAAgB,CAAC;IAEhD;;;OAGG;gBAED,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,GAAG,CAAC,sBAAsB,GAAG;QAAE,SAAS,CAAC,EAAE,GAAG,CAAC,gBAAgB,CAAA;KAAE;IA2B5E,IAAI,GAAG,WAEN;IAYK,SAAS,CACb,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAiDtC"}

package/dist/executor.js

@@ -0,0 +1,117 @@
+import { ccc } from "@ckb-ccc/core";
+import { cccA } from "@ckb-ccc/core/advanced";
+import { getMethodPath } from "./utils.js";
+export class ExecutorResponse {
+    constructor(res, cellDeps) {
+        this.res = res;
+        this.cellDeps = cellDeps;
+    }
+    static new(res, cellDeps) {
+        return new ExecutorResponse(res, cellDeps?.map(ccc.OutPoint.from) ?? []);
+    }
+    map(fn) {
+        return new ExecutorResponse(fn(this.res), this.cellDeps);
+    }
+}
+export class ExecutorErrorExecutionFailed extends Error {
+    constructor(msg) {
+        super(msg);
+    }
+}
+/**
+ * Represents an SSRI executor.
+ */
+export class Executor {
+    async runScriptTry(codeOutPoint, method, args, context) {
+        try {
+            return await this.runScript(codeOutPoint, method, args, context);
+        }
+        catch (err) {
+            if (err instanceof ExecutorErrorExecutionFailed) {
+                return undefined;
+            }
+            throw err;
+        }
+    }
+}
+export class ExecutorJsonRpc extends Executor {
+    /**
+     * Creates an instance of SSRI executor through Json RPC.
+     * @param {string} [url] - The external server URL.
+     */
+    constructor(url, config) {
+        super();
+        this.requestor =
+            config?.requestor ??
+                new ccc.RequestorJsonRpc(url, config, (errAny) => {
+                    if (typeof errAny !== "object" ||
+                        errAny === null ||
+                        !("code" in errAny) ||
+                        typeof errAny.code !== "number") {
+                        throw errAny;
+                    }
+                    if (errAny.code === 1003 || errAny.code === 1004) {
+                        if ("message" in errAny && typeof errAny.message === "string") {
+                            throw new ExecutorErrorExecutionFailed(errAny.message);
+                        }
+                        throw new ExecutorErrorExecutionFailed();
+                    }
+                    throw errAny;
+                });
+    }
+    get url() {
+        return this.requestor.url;
+    }
+    /* Calls a method on the SSRI executor through SSRI Server.
+     * @param codeOutPoint - The code OutPoint.
+     * @param method - The SSRI method.
+     * @param args - The arguments for the method.
+     * @param context - The SSRI context for the method.
+     * @param context.script - The script level parameters.
+     * @param context.cell - The cell level parameters. Take precedence over script.
+     * @param context.transaction - The transaction level parameters. Take precedence over cell.
+     * @returns The result of the call.
+     */
+    async runScript(codeOutPoint, method, args, context) {
+        const code = ccc.OutPoint.from(codeOutPoint);
+        const [rpcMethod, rpcContext] = (() => {
+            if (context?.tx) {
+                const tx = ccc.Transaction.from(context.tx);
+                return [
+                    "run_script_level_transaction",
+                    [
+                        {
+                            inner: cccA.JsonRpcTransformers.transactionFrom(tx),
+                            hash: tx.hash(),
+                        },
+                    ],
+                ];
+            }
+            if (context?.cell) {
+                return [
+                    "run_script_level_cell",
+                    [
+                        {
+                            cell_output: cccA.JsonRpcTransformers.cellOutputFrom(ccc.CellOutput.from(context.cell.cellOutput)),
+                            hex_data: ccc.hexFrom(context.cell.outputData),
+                        },
+                    ],
+                ];
+            }
+            if (context?.script) {
+                return [
+                    "run_script_level_script",
+                    [cccA.JsonRpcTransformers.scriptFrom(context.script)],
+                ];
+            }
+            return ["run_script_level_code", []];
+        })();
+        const { content, cell_deps } = (await this.requestor.request(rpcMethod, [
+            code.txHash,
+            Number(code.index),
+            [getMethodPath(method), ...args.map(ccc.hexFrom)],
+            ...rpcContext,
+        ]));
+        return ExecutorResponse.new(content, cell_deps.map(cccA.JsonRpcTransformers.outPointTo));
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * as ssri from "./barrel.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export * as ssri from "./barrel.js";

package/dist/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/trait.d.ts

@@ -0,0 +1,35 @@
+import { ccc } from "@ckb-ccc/core";
+import { Executor, ExecutorResponse } from "./executor.js";
+/**
+ * Abstract class representing an SSRI trait. Should be used as the base of all SSRI traits.
+ */
+export declare abstract class Trait {
+    readonly code: ccc.OutPoint;
+    readonly executor?: Executor;
+    /**
+     * Creates an instance of SSRI trait.
+     * @param code - The cell dependency.
+     * @param executor - The SSRI executor instance.
+     */
+    constructor(code: ccc.OutPointLike, executor?: Executor | null);
+    assertExecutor(): Executor;
+    /**
+     * Retrieves a list of methods.
+     * @param offset - The offset for the methods.
+     * @param limit - The limit for the methods.
+     * @returns {Promise<Bytes[]>} A promise that resolves to a list of methods.
+     */
+    getMethods(offset?: ccc.NumLike, limit?: ccc.NumLike): Promise<ExecutorResponse<ccc.Hex[]>>;
+    /**
+     * Checks if the specified methods exist.
+     * @param methodNames - The methods to check.
+     * @returns A promise that resolves to an array of booleans indicating if methods exist.
+     */
+    hasMethods(methodNames: string[], extraMethodPaths?: ccc.HexLike[]): Promise<ExecutorResponse<boolean[]>>;
+    /**
+     * Retrieves the version of the trait.
+     * @returns A promise that resolves to the version number.
+     */
+    version(): Promise<ExecutorResponse<ccc.Num>>;
+}
+//# sourceMappingURL=trait.d.ts.map

package/dist/trait.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAG3D;;GAEG;AACH,8BAAsB,KAAK;IACzB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAK9D,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAQpD"}

package/dist/trait.js

@@ -0,0 +1,52 @@
+import { ccc } from "@ckb-ccc/core";
+import { getMethodPath } from "./utils.js";
+/**
+ * Abstract class representing an SSRI trait. Should be used as the base of all SSRI traits.
+ */
+export class Trait {
+    /**
+     * Creates an instance of SSRI trait.
+     * @param code - The cell dependency.
+     * @param executor - The SSRI executor instance.
+     */
+    constructor(code, executor) {
+        this.code = ccc.OutPoint.from(code);
+        this.executor = executor ?? undefined;
+    }
+    assertExecutor() {
+        if (!this.executor) {
+            throw new Error("SSRI executor is not set");
+        }
+        return this.executor;
+    }
+    /**
+     * Retrieves a list of methods.
+     * @param offset - The offset for the methods.
+     * @param limit - The limit for the methods.
+     * @returns {Promise<Bytes[]>} A promise that resolves to a list of methods.
+     */
+    async getMethods(offset = 0, limit = 0) {
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.get_methods", [ccc.numToBytes(offset ?? 0, 8), ccc.numToBytes(limit ?? 0, 8)]);
+        return res.map((res) => ccc.mol.Byte8Vec.decode(res));
+    }
+    /**
+     * Checks if the specified methods exist.
+     * @param methodNames - The methods to check.
+     * @returns A promise that resolves to an array of booleans indicating if methods exist.
+     */
+    async hasMethods(methodNames, extraMethodPaths) {
+        const methodPaths = ccc.mol.Byte8Vec.encode(methodNames
+            .map(getMethodPath)
+            .concat(extraMethodPaths?.map(ccc.hexFrom) ?? []));
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.has_methods", [methodPaths]);
+        return res.map((res) => ccc.mol.BoolVec.decode(res));
+    }
+    /**
+     * Retrieves the version of the trait.
+     * @returns A promise that resolves to the version number.
+     */
+    async version() {
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.version", []);
+        return res.map((res) => ccc.numFrom(res));
+    }
+}

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { ccc } from "@ckb-ccc/core";
+export declare function getMethodPath(method: string): ccc.Hex;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,GAAG,CAErD"}

package/dist/utils.js

@@ -0,0 +1,4 @@
+import { ccc } from "@ckb-ccc/core";
+export function getMethodPath(method) {
+    return ccc.hashCkb(ccc.bytesFrom(method, "utf8")).slice(0, 18);
+}

package/dist.commonjs/barrel.d.ts

@@ -0,0 +1,4 @@
+export * from "./executor.js";
+export * from "./trait.js";
+export * from "./utils.js";
+//# sourceMappingURL=barrel.d.ts.map

package/dist.commonjs/barrel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"barrel.d.ts","sourceRoot":"","sources":["../src/barrel.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist.commonjs/barrel.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./executor.js"), exports);
+__exportStar(require("./trait.js"), exports);
+__exportStar(require("./utils.js"), exports);

package/dist.commonjs/executor.d.ts

@@ -0,0 +1,51 @@
+import { ccc } from "@ckb-ccc/core";
+export type ContextTransaction = {
+    script?: ccc.ScriptLike | null;
+    cell?: Omit<ccc.CellLike, "outPoint"> | null;
+    tx: ccc.TransactionLike;
+};
+export type ContextCell = {
+    script?: ccc.ScriptLike | null;
+    cell: Omit<ccc.CellLike, "outPoint">;
+    tx?: undefined | null;
+};
+export type ContextScript = {
+    script: ccc.ScriptLike;
+    cell?: undefined | null;
+    tx?: undefined | null;
+};
+export type ContextCode = undefined | {
+    script?: undefined | null;
+    cell?: undefined | null;
+    tx?: undefined | null;
+};
+export declare class ExecutorResponse<T> {
+    readonly res: T;
+    readonly cellDeps: ccc.OutPoint[];
+    constructor(res: T, cellDeps: ccc.OutPoint[]);
+    static new<T>(res: T, cellDeps?: ccc.OutPointLike[] | null): ExecutorResponse<T>;
+    map<U>(fn: (res: T) => U): ExecutorResponse<U>;
+}
+export declare class ExecutorErrorExecutionFailed extends Error {
+    constructor(msg?: string);
+}
+/**
+ * Represents an SSRI executor.
+ */
+export declare abstract class Executor {
+    abstract runScript(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex>>;
+    runScriptTry(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex> | undefined>;
+}
+export declare class ExecutorJsonRpc extends Executor {
+    readonly requestor: ccc.RequestorJsonRpc;
+    /**
+     * Creates an instance of SSRI executor through Json RPC.
+     * @param {string} [url] - The external server URL.
+     */
+    constructor(url: string, config?: ccc.RequestorJsonRpcConfig & {
+        requestor?: ccc.RequestorJsonRpc;
+    });
+    get url(): string;
+    runScript(codeOutPoint: ccc.OutPointLike, method: string, args: ccc.HexLike[], context?: ContextCode | ContextScript | ContextCell | ContextTransaction): Promise<ExecutorResponse<ccc.Hex>>;
+}
+//# sourceMappingURL=executor.d.ts.map

package/dist.commonjs/executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../src/executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;IAC7C,EAAE,EAAE,GAAG,CAAC,eAAe,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrC,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,SAAS,GACT;IACE,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC1B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,EAAE,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACvB,CAAC;AAEN,qBAAa,gBAAgB,CAAC,CAAC;aAEX,GAAG,EAAE,CAAC;aACN,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE;gBADxB,GAAG,EAAE,CAAC,EACN,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE;IAG1C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,YAAY,EAAE,GAAG,IAAI;IAI1D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;CAG/C;AAED,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,GAAG,CAAC,EAAE,MAAM;CAGzB;AAED;;GAEG;AACH,8BAAsB,QAAQ;IAC5B,QAAQ,CAAC,SAAS,CAChB,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE/B,YAAY,CAChB,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;CAUlD;AAED,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,SAAgB,SAAS,EAAE,GAAG,CAAC,gBAAgB,CAAC;IAEhD;;;OAGG;gBAED,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,GAAG,CAAC,sBAAsB,GAAG;QAAE,SAAS,CAAC,EAAE,GAAG,CAAC,gBAAgB,CAAA;KAAE;IA2B5E,IAAI,GAAG,WAEN;IAYK,SAAS,CACb,YAAY,EAAE,GAAG,CAAC,YAAY,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,GACvE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAiDtC"}

package/dist.commonjs/executor.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutorJsonRpc = exports.Executor = exports.ExecutorErrorExecutionFailed = exports.ExecutorResponse = void 0;
+const core_1 = require("@ckb-ccc/core");
+const advanced_1 = require("@ckb-ccc/core/advanced");
+const utils_js_1 = require("./utils.js");
+class ExecutorResponse {
+    constructor(res, cellDeps) {
+        this.res = res;
+        this.cellDeps = cellDeps;
+    }
+    static new(res, cellDeps) {
+        return new ExecutorResponse(res, cellDeps?.map(core_1.ccc.OutPoint.from) ?? []);
+    }
+    map(fn) {
+        return new ExecutorResponse(fn(this.res), this.cellDeps);
+    }
+}
+exports.ExecutorResponse = ExecutorResponse;
+class ExecutorErrorExecutionFailed extends Error {
+    constructor(msg) {
+        super(msg);
+    }
+}
+exports.ExecutorErrorExecutionFailed = ExecutorErrorExecutionFailed;
+/**
+ * Represents an SSRI executor.
+ */
+class Executor {
+    async runScriptTry(codeOutPoint, method, args, context) {
+        try {
+            return await this.runScript(codeOutPoint, method, args, context);
+        }
+        catch (err) {
+            if (err instanceof ExecutorErrorExecutionFailed) {
+                return undefined;
+            }
+            throw err;
+        }
+    }
+}
+exports.Executor = Executor;
+class ExecutorJsonRpc extends Executor {
+    /**
+     * Creates an instance of SSRI executor through Json RPC.
+     * @param {string} [url] - The external server URL.
+     */
+    constructor(url, config) {
+        super();
+        this.requestor =
+            config?.requestor ??
+                new core_1.ccc.RequestorJsonRpc(url, config, (errAny) => {
+                    if (typeof errAny !== "object" ||
+                        errAny === null ||
+                        !("code" in errAny) ||
+                        typeof errAny.code !== "number") {
+                        throw errAny;
+                    }
+                    if (errAny.code === 1003 || errAny.code === 1004) {
+                        if ("message" in errAny && typeof errAny.message === "string") {
+                            throw new ExecutorErrorExecutionFailed(errAny.message);
+                        }
+                        throw new ExecutorErrorExecutionFailed();
+                    }
+                    throw errAny;
+                });
+    }
+    get url() {
+        return this.requestor.url;
+    }
+    /* Calls a method on the SSRI executor through SSRI Server.
+     * @param codeOutPoint - The code OutPoint.
+     * @param method - The SSRI method.
+     * @param args - The arguments for the method.
+     * @param context - The SSRI context for the method.
+     * @param context.script - The script level parameters.
+     * @param context.cell - The cell level parameters. Take precedence over script.
+     * @param context.transaction - The transaction level parameters. Take precedence over cell.
+     * @returns The result of the call.
+     */
+    async runScript(codeOutPoint, method, args, context) {
+        const code = core_1.ccc.OutPoint.from(codeOutPoint);
+        const [rpcMethod, rpcContext] = (() => {
+            if (context?.tx) {
+                const tx = core_1.ccc.Transaction.from(context.tx);
+                return [
+                    "run_script_level_transaction",
+                    [
+                        {
+                            inner: advanced_1.cccA.JsonRpcTransformers.transactionFrom(tx),
+                            hash: tx.hash(),
+                        },
+                    ],
+                ];
+            }
+            if (context?.cell) {
+                return [
+                    "run_script_level_cell",
+                    [
+                        {
+                            cell_output: advanced_1.cccA.JsonRpcTransformers.cellOutputFrom(core_1.ccc.CellOutput.from(context.cell.cellOutput)),
+                            hex_data: core_1.ccc.hexFrom(context.cell.outputData),
+                        },
+                    ],
+                ];
+            }
+            if (context?.script) {
+                return [
+                    "run_script_level_script",
+                    [advanced_1.cccA.JsonRpcTransformers.scriptFrom(context.script)],
+                ];
+            }
+            return ["run_script_level_code", []];
+        })();
+        const { content, cell_deps } = (await this.requestor.request(rpcMethod, [
+            code.txHash,
+            Number(code.index),
+            [(0, utils_js_1.getMethodPath)(method), ...args.map(core_1.ccc.hexFrom)],
+            ...rpcContext,
+        ]));
+        return ExecutorResponse.new(content, cell_deps.map(advanced_1.cccA.JsonRpcTransformers.outPointTo));
+    }
+}
+exports.ExecutorJsonRpc = ExecutorJsonRpc;

package/dist.commonjs/index.d.ts

@@ -0,0 +1,2 @@
+export * as ssri from "./barrel.js";
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC"}

package/dist.commonjs/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ssri = void 0;
+exports.ssri = __importStar(require("./barrel.js"));

package/dist.commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist.commonjs/trait.d.ts

@@ -0,0 +1,35 @@
+import { ccc } from "@ckb-ccc/core";
+import { Executor, ExecutorResponse } from "./executor.js";
+/**
+ * Abstract class representing an SSRI trait. Should be used as the base of all SSRI traits.
+ */
+export declare abstract class Trait {
+    readonly code: ccc.OutPoint;
+    readonly executor?: Executor;
+    /**
+     * Creates an instance of SSRI trait.
+     * @param code - The cell dependency.
+     * @param executor - The SSRI executor instance.
+     */
+    constructor(code: ccc.OutPointLike, executor?: Executor | null);
+    assertExecutor(): Executor;
+    /**
+     * Retrieves a list of methods.
+     * @param offset - The offset for the methods.
+     * @param limit - The limit for the methods.
+     * @returns {Promise<Bytes[]>} A promise that resolves to a list of methods.
+     */
+    getMethods(offset?: ccc.NumLike, limit?: ccc.NumLike): Promise<ExecutorResponse<ccc.Hex[]>>;
+    /**
+     * Checks if the specified methods exist.
+     * @param methodNames - The methods to check.
+     * @returns A promise that resolves to an array of booleans indicating if methods exist.
+     */
+    hasMethods(methodNames: string[], extraMethodPaths?: ccc.HexLike[]): Promise<ExecutorResponse<boolean[]>>;
+    /**
+     * Retrieves the version of the trait.
+     * @returns A promise that resolves to the version number.
+     */
+    version(): Promise<ExecutorResponse<ccc.Num>>;
+}
+//# sourceMappingURL=trait.d.ts.map

package/dist.commonjs/trait.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAG3D;;GAEG;AACH,8BAAsB,KAAK;IACzB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAK9D,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAQpD"}

package/dist.commonjs/trait.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Trait = void 0;
+const core_1 = require("@ckb-ccc/core");
+const utils_js_1 = require("./utils.js");
+/**
+ * Abstract class representing an SSRI trait. Should be used as the base of all SSRI traits.
+ */
+class Trait {
+    /**
+     * Creates an instance of SSRI trait.
+     * @param code - The cell dependency.
+     * @param executor - The SSRI executor instance.
+     */
+    constructor(code, executor) {
+        this.code = core_1.ccc.OutPoint.from(code);
+        this.executor = executor ?? undefined;
+    }
+    assertExecutor() {
+        if (!this.executor) {
+            throw new Error("SSRI executor is not set");
+        }
+        return this.executor;
+    }
+    /**
+     * Retrieves a list of methods.
+     * @param offset - The offset for the methods.
+     * @param limit - The limit for the methods.
+     * @returns {Promise<Bytes[]>} A promise that resolves to a list of methods.
+     */
+    async getMethods(offset = 0, limit = 0) {
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.get_methods", [core_1.ccc.numToBytes(offset ?? 0, 8), core_1.ccc.numToBytes(limit ?? 0, 8)]);
+        return res.map((res) => core_1.ccc.mol.Byte8Vec.decode(res));
+    }
+    /**
+     * Checks if the specified methods exist.
+     * @param methodNames - The methods to check.
+     * @returns A promise that resolves to an array of booleans indicating if methods exist.
+     */
+    async hasMethods(methodNames, extraMethodPaths) {
+        const methodPaths = core_1.ccc.mol.Byte8Vec.encode(methodNames
+            .map(utils_js_1.getMethodPath)
+            .concat(extraMethodPaths?.map(core_1.ccc.hexFrom) ?? []));
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.has_methods", [methodPaths]);
+        return res.map((res) => core_1.ccc.mol.BoolVec.decode(res));
+    }
+    /**
+     * Retrieves the version of the trait.
+     * @returns A promise that resolves to the version number.
+     */
+    async version() {
+        const res = await this.assertExecutor().runScript(this.code, "SSRI.version", []);
+        return res.map((res) => core_1.ccc.numFrom(res));
+    }
+}
+exports.Trait = Trait;

package/dist.commonjs/utils.d.ts

@@ -0,0 +1,3 @@
+import { ccc } from "@ckb-ccc/core";
+export declare function getMethodPath(method: string): ccc.Hex;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,GAAG,CAErD"}

package/dist.commonjs/utils.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMethodPath = getMethodPath;
+const core_1 = require("@ckb-ccc/core");
+function getMethodPath(method) {
+    return core_1.ccc.hashCkb(core_1.ccc.bytesFrom(method, "utf8")).slice(0, 18);
+}

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@ckb-ccc/ssri",
+  "version": "0.1.0",
+  "description": "SSRI",
+  "author": "Alive24 <xct24@live.com>",
+  "license": "MIT",
+  "private": false,
+  "homepage": "https://github.com/ckb-devrel/ccc",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/ckb-devrel/ccc.git"
+  },
+  "main": "./dist.commonjs/index.js",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "default": "./dist.commonjs/index.js"
+    },
+    "./barrel": {
+      "import": "./dist/barrel.js",
+      "default": "./dist.commonjs/barrel.js"
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.1.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.10.2",
+    "copyfiles": "^2.4.1",
+    "eslint": "^9.1.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.4",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ckb-ccc/core": "1.3.0"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
+    "lint": "eslint ./src",
+    "format": "prettier --write . && eslint --fix ./src"
+  }
+}

package/src/barrel.ts

@@ -0,0 +1,3 @@
+export * from "./executor.js";
+export * from "./trait.js";
+export * from "./utils.js";

package/src/executor.ts

@@ -0,0 +1,184 @@
+import { ccc } from "@ckb-ccc/core";
+import { cccA } from "@ckb-ccc/core/advanced";
+import { getMethodPath } from "./utils.js";
+
+export type ContextTransaction = {
+  script?: ccc.ScriptLike | null;
+  cell?: Omit<ccc.CellLike, "outPoint"> | null;
+  tx: ccc.TransactionLike;
+};
+
+export type ContextCell = {
+  script?: ccc.ScriptLike | null;
+  cell: Omit<ccc.CellLike, "outPoint">;
+  tx?: undefined | null;
+};
+
+export type ContextScript = {
+  script: ccc.ScriptLike;
+  cell?: undefined | null;
+  tx?: undefined | null;
+};
+
+export type ContextCode =
+  | undefined
+  | {
+      script?: undefined | null;
+      cell?: undefined | null;
+      tx?: undefined | null;
+    };
+
+export class ExecutorResponse<T> {
+  constructor(
+    public readonly res: T,
+    public readonly cellDeps: ccc.OutPoint[],
+  ) {}
+
+  static new<T>(res: T, cellDeps?: ccc.OutPointLike[] | null) {
+    return new ExecutorResponse(res, cellDeps?.map(ccc.OutPoint.from) ?? []);
+  }
+
+  map<U>(fn: (res: T) => U): ExecutorResponse<U> {
+    return new ExecutorResponse(fn(this.res), this.cellDeps);
+  }
+}
+
+export class ExecutorErrorExecutionFailed extends Error {
+  constructor(msg?: string) {
+    super(msg);
+  }
+}
+
+/**
+ * Represents an SSRI executor.
+ */
+export abstract class Executor {
+  abstract runScript(
+    codeOutPoint: ccc.OutPointLike,
+    method: string,
+    args: ccc.HexLike[],
+    context?: ContextCode | ContextScript | ContextCell | ContextTransaction,
+  ): Promise<ExecutorResponse<ccc.Hex>>;
+
+  async runScriptTry(
+    codeOutPoint: ccc.OutPointLike,
+    method: string,
+    args: ccc.HexLike[],
+    context?: ContextCode | ContextScript | ContextCell | ContextTransaction,
+  ): Promise<ExecutorResponse<ccc.Hex> | undefined> {
+    try {
+      return await this.runScript(codeOutPoint, method, args, context);
+    } catch (err) {
+      if (err instanceof ExecutorErrorExecutionFailed) {
+        return undefined;
+      }
+      throw err;
+    }
+  }
+}
+
+export class ExecutorJsonRpc extends Executor {
+  public readonly requestor: ccc.RequestorJsonRpc;
+
+  /**
+   * Creates an instance of SSRI executor through Json RPC.
+   * @param {string} [url] - The external server URL.
+   */
+  constructor(
+    url: string,
+    config?: ccc.RequestorJsonRpcConfig & { requestor?: ccc.RequestorJsonRpc },
+  ) {
+    super();
+
+    this.requestor =
+      config?.requestor ??
+      new ccc.RequestorJsonRpc(url, config, (errAny) => {
+        if (
+          typeof errAny !== "object" ||
+          errAny === null ||
+          !("code" in errAny) ||
+          typeof errAny.code !== "number"
+        ) {
+          throw errAny;
+        }
+
+        if (errAny.code === 1003 || errAny.code === 1004) {
+          if ("message" in errAny && typeof errAny.message === "string") {
+            throw new ExecutorErrorExecutionFailed(errAny.message);
+          }
+          throw new ExecutorErrorExecutionFailed();
+        }
+
+        throw errAny;
+      });
+  }
+
+  get url() {
+    return this.requestor.url;
+  }
+
+  /* Calls a method on the SSRI executor through SSRI Server.
+   * @param codeOutPoint - The code OutPoint.
+   * @param method - The SSRI method.
+   * @param args - The arguments for the method.
+   * @param context - The SSRI context for the method.
+   * @param context.script - The script level parameters.
+   * @param context.cell - The cell level parameters. Take precedence over script.
+   * @param context.transaction - The transaction level parameters. Take precedence over cell.
+   * @returns The result of the call.
+   */
+  async runScript(
+    codeOutPoint: ccc.OutPointLike,
+    method: string,
+    args: ccc.HexLike[],
+    context?: ContextCode | ContextScript | ContextCell | ContextTransaction,
+  ): Promise<ExecutorResponse<ccc.Hex>> {
+    const code = ccc.OutPoint.from(codeOutPoint);
+    const [rpcMethod, rpcContext] = (() => {
+      if (context?.tx) {
+        const tx = ccc.Transaction.from(context.tx);
+        return [
+          "run_script_level_transaction",
+          [
+            {
+              inner: cccA.JsonRpcTransformers.transactionFrom(tx),
+              hash: tx.hash(),
+            },
+          ],
+        ];
+      }
+      if (context?.cell) {
+        return [
+          "run_script_level_cell",
+          [
+            {
+              cell_output: cccA.JsonRpcTransformers.cellOutputFrom(
+                ccc.CellOutput.from(context.cell.cellOutput),
+              ),
+              hex_data: ccc.hexFrom(context.cell.outputData),
+            },
+          ],
+        ];
+      }
+      if (context?.script) {
+        return [
+          "run_script_level_script",
+          [cccA.JsonRpcTransformers.scriptFrom(context.script)],
+        ];
+      }
+      return ["run_script_level_code", []];
+    })();
+
+    const { content, cell_deps } = (await this.requestor.request(rpcMethod, [
+      code.txHash,
+      Number(code.index),
+      [getMethodPath(method), ...args.map(ccc.hexFrom)],
+      ...rpcContext,
+    ])) as { content: ccc.Hex; cell_deps: cccA.JsonRpcOutPoint[] };
+
+    return ExecutorResponse.new(
+      content,
+      cell_deps.map(cccA.JsonRpcTransformers.outPointTo),
+    );
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * as ssri from "./barrel.js";

package/src/trait.ts

@@ -0,0 +1,83 @@
+import { ccc } from "@ckb-ccc/core";
+import { Executor, ExecutorResponse } from "./executor.js";
+import { getMethodPath } from "./utils.js";
+
+/**
+ * Abstract class representing an SSRI trait. Should be used as the base of all SSRI traits.
+ */
+export abstract class Trait {
+  public readonly code: ccc.OutPoint;
+  public readonly executor?: Executor;
+
+  /**
+   * Creates an instance of SSRI trait.
+   * @param code - The cell dependency.
+   * @param executor - The SSRI executor instance.
+   */
+  constructor(code: ccc.OutPointLike, executor?: Executor | null) {
+    this.code = ccc.OutPoint.from(code);
+    this.executor = executor ?? undefined;
+  }
+
+  assertExecutor() {
+    if (!this.executor) {
+      throw new Error("SSRI executor is not set");
+    }
+
+    return this.executor;
+  }
+
+  /**
+   * Retrieves a list of methods.
+   * @param offset - The offset for the methods.
+   * @param limit - The limit for the methods.
+   * @returns {Promise<Bytes[]>} A promise that resolves to a list of methods.
+   */
+  async getMethods(
+    offset: ccc.NumLike = 0,
+    limit: ccc.NumLike = 0,
+  ): Promise<ExecutorResponse<ccc.Hex[]>> {
+    const res = await this.assertExecutor().runScript(
+      this.code,
+      "SSRI.get_methods",
+      [ccc.numToBytes(offset ?? 0, 8), ccc.numToBytes(limit ?? 0, 8)],
+    );
+
+    return res.map((res) => ccc.mol.Byte8Vec.decode(res));
+  }
+
+  /**
+   * Checks if the specified methods exist.
+   * @param methodNames - The methods to check.
+   * @returns A promise that resolves to an array of booleans indicating if methods exist.
+   */
+  async hasMethods(
+    methodNames: string[],
+    extraMethodPaths?: ccc.HexLike[],
+  ): Promise<ExecutorResponse<boolean[]>> {
+    const methodPaths = ccc.mol.Byte8Vec.encode(
+      methodNames
+        .map(getMethodPath)
+        .concat(extraMethodPaths?.map(ccc.hexFrom) ?? []),
+    );
+    const res = await this.assertExecutor().runScript(
+      this.code,
+      "SSRI.has_methods",
+      [methodPaths],
+    );
+    return res.map((res) => ccc.mol.BoolVec.decode(res));
+  }
+
+  /**
+   * Retrieves the version of the trait.
+   * @returns A promise that resolves to the version number.
+   */
+  async version(): Promise<ExecutorResponse<ccc.Num>> {
+    const res = await this.assertExecutor().runScript(
+      this.code,
+      "SSRI.version",
+      [],
+    );
+    return res.map((res) => ccc.numFrom(res));
+  }
+}

package/src/utils.ts

@@ -0,0 +1,5 @@
+import { ccc } from "@ckb-ccc/core";
+
+export function getMethodPath(method: string): ccc.Hex {
+  return ccc.hashCkb(ccc.bytesFrom(method, "utf8")).slice(0, 18) as ccc.Hex;
+}

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "extends": ["../../typedoc.base.json"],
+  "name": "@ckb-ccc ssri"
+}