@ckb-ccc/spore 0.1.0-alpha.2

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @ckb-ccc/spore
+
+## 0.1.0-alpha.2
+
+### Minor Changes
+
+- [#74](https://github.com/ckb-ecofund/ccc/pull/74) [`f21d7e4`](https://github.com/ckb-ecofund/ccc/commit/f21d7e4cf422edab4a836ef6d678b620594fef8d) Thanks [@Hanssen0](https://github.com/Hanssen0)! - add spore package and some known scripts
+
+### Patch Changes
+
+- Updated dependencies [[`f21d7e4`](https://github.com/ckb-ecofund/ccc/commit/f21d7e4cf422edab4a836ef6d678b620594fef8d)]:
+  - @ckb-ccc/core@0.1.0-alpha.4

package/README.md

@@ -0,0 +1,61 @@
+<p align="center">
+  <a href="https://app.ckbccc.com/">
+    <img alt="Logo" src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/logo.svg" width="20%" />
+  </a>
+</p>
+
+<h1 align="center" style="font-size: 48px;">
+  CCC's support for Spore protocol
+</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@ckb-ccc/spore"><img
+    alt="NPM Version" src="https://img.shields.io/npm/v/%40ckb-ccc%2Fspore"
+  /></a>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/ckb-ecofund/ccc" />
+  <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/ckb-ecofund/ccc/master" />
+  <img alt="GitHub branch check runs" src="https://img.shields.io/github/check-runs/ckb-ecofund/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 the next step of "Common Chains Connector".
+  <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>
+
+## Playground
+
+<p align="center">
+  <a href="https://live.ckbccc.com/">
+    <img src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/preview.png" width="90%" />
+  </a>
+</p>
+
+This project is still under active development, and we are looking forward to your feedback. You can [experiment instantly in the playground](https://live.ckbccc.com/). If you are new to the CKB, we recommend checking [Nervos CKB Docs](https://docs.nervos.org/) for basic knowledge.
+
+## App
+
+<p align="center">
+  <a href="https://app.ckbccc.com/">
+    <img src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/appPreview.png" width="50%" />
+  </a>
+</p>
+
+For non-developers, you can also [try CCC's app now here](https://app.ckbccc.com/). It showcases how to use CCC for some basic scenarios in CKB.
+
+<h3 align="center">
+  Read more about CCC on <a href="https://docs.ckbccc.com">our website</a> or <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.
+</h3>

package/dist/advanced.d.ts

@@ -0,0 +1,5 @@
+export * from "./cobuild/index.js";
+export * from "./codec/index.js";
+export * from "./predefined/advanced.js";
+export * from "./spore/advanced.js";
+//# sourceMappingURL=advanced.d.ts.map

package/dist/advanced.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../src/advanced.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC"}

package/dist/advanced.js

@@ -0,0 +1,4 @@
+export * from "./cobuild/index.js";
+export * from "./codec/index.js";
+export * from "./predefined/advanced.js";
+export * from "./spore/advanced.js";

package/dist/cluster/index.d.ts

@@ -0,0 +1,56 @@
+import { ccc } from "@ckb-ccc/core";
+import { ClusterData } from "../codec/index.js";
+import { SporeScriptInfo, SporeScriptInfoLike } from "../predefined/index.js";
+export declare function findCluster(client: ccc.Client, args: ccc.HexLike, scripts?: SporeScriptInfoLike[]): Promise<{
+    cell: ccc.Cell;
+    scriptInfo: SporeScriptInfo;
+} | undefined>;
+export declare function assertCluster(client: ccc.Client, args: ccc.HexLike, scripts?: SporeScriptInfoLike[]): Promise<{
+    cell: ccc.Cell;
+    scriptInfo: SporeScriptInfo;
+}>;
+/**
+ * Create a new Cluster cell
+ *
+ * @param signer who takes the responsibility to balance and sign the transaction
+ * @param data specific format of data required by Cluster protocol
+ * @param to the owner of the Cluster cell, which will be replaced with signer if not provided
+ * @param tx the transaction skeleton, if not provided, a new one will be created
+ * @param scriptInfo the script info of new cluster, default spore version if undefined
+ * @param scriptInfoHash the script info hash used in cobuild
+ * @returns
+ *  - **tx**: a new transaction that contains created Cluster cell
+ *  - **id**: the id of the created Cluster cell
+ */
+export declare function createSporeCluster(params: {
+    signer: ccc.Signer;
+    data: ClusterData;
+    to?: ccc.ScriptLike;
+    tx?: ccc.TransactionLike;
+    scriptInfo?: SporeScriptInfoLike;
+    scriptInfoHash?: ccc.HexLike;
+}): Promise<{
+    tx: ccc.Transaction;
+    id: ccc.Hex;
+}>;
+/**
+ * Transfer a Cluster cell
+ *
+ * @param signer who takes the responsibility to balance and sign the transaction
+ * @param id the id of the Cluster cell to be transferred
+ * @param to the new owner of the Cluster cell
+ * @param tx the transaction skeleton, if not provided, a new one will be created
+ * @param scriptInfoHash the script info hash used in cobuild
+ * @returns
+ *  - **tx**: a new transaction that contains transferred Cluster cell
+ */
+export declare function transferSporeCluster(params: {
+    signer: ccc.Signer;
+    id: ccc.HexLike;
+    to: ccc.ScriptLike;
+    tx?: ccc.TransactionLike;
+    scriptInfoHash?: ccc.HexLike;
+}): Promise<{
+    tx: ccc.Transaction;
+}>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cluster/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAMpC,OAAO,EAAE,WAAW,EAAsB,MAAM,mBAAmB,CAAC;AAKpE,OAAO,EACL,eAAe,EACf,mBAAmB,EAGpB,MAAM,wBAAwB,CAAC;AAEhC,wBAAsB,WAAW,CAC/B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,GAAG,CAAC,OAAO,EACjB,OAAO,CAAC,EAAE,mBAAmB,EAAE,GAC9B,OAAO,CACN;IACE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,UAAU,EAAE,eAAe,CAAC;CAC7B,GACD,SAAS,CACZ,CAMA;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,GAAG,CAAC,OAAO,EACjB,OAAO,CAAC,EAAE,mBAAmB,EAAE,GAC9B,OAAO,CAAC;IACT,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,UAAU,EAAE,eAAe,CAAC;CAC7B,CAAC,CAQD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE;IAC/C,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;IACpB,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,CAAC;IACzB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,cAAc,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC;IACpB,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC;CACb,CAAC,CA0CD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC;IAChB,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC;IACnB,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,CAAC;IACzB,cAAc,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC;CACrB,CAAC,CAwCD"}

package/dist/cluster/index.js

@@ -0,0 +1,96 @@
+import { ccc } from "@ckb-ccc/core";
+import { assembleCreateClusterAction, assembleTransferClusterAction, prepareSporeTransaction, } from "../advanced.js";
+import { packRawClusterData } from "../codec/index.js";
+import { findSingletonCellByArgs, injectOneCapacityCell, } from "../helper/index.js";
+import { getClusterScriptInfo, getClusterScriptInfos, } from "../predefined/index.js";
+export async function findCluster(client, args, scripts) {
+    return findSingletonCellByArgs(client, args, scripts ?? Object.values(getClusterScriptInfos(client)));
+}
+export async function assertCluster(client, args, scripts) {
+    const res = await findCluster(client, args, scripts);
+    if (!res) {
+        throw new Error(`Cluster ${ccc.hexFrom(args)} not found`);
+    }
+    return res;
+}
+/**
+ * Create a new Cluster cell
+ *
+ * @param signer who takes the responsibility to balance and sign the transaction
+ * @param data specific format of data required by Cluster protocol
+ * @param to the owner of the Cluster cell, which will be replaced with signer if not provided
+ * @param tx the transaction skeleton, if not provided, a new one will be created
+ * @param scriptInfo the script info of new cluster, default spore version if undefined
+ * @param scriptInfoHash the script info hash used in cobuild
+ * @returns
+ *  - **tx**: a new transaction that contains created Cluster cell
+ *  - **id**: the id of the created Cluster cell
+ */
+export async function createSporeCluster(params) {
+    const { signer, data, to, scriptInfoHash } = params;
+    const scriptInfo = params.scriptInfo ?? getClusterScriptInfo(signer.client);
+    // prepare transaction
+    const tx = ccc.Transaction.from(params.tx ?? {});
+    if (tx.inputs.length === 0) {
+        await injectOneCapacityCell(signer, tx);
+    }
+    // build cluster cell
+    const id = ccc.hashTypeId(tx.inputs[0], tx.outputs.length);
+    const packedClusterData = packRawClusterData(data);
+    tx.addOutput({
+        lock: to ?? (await signer.getRecommendedAddressObj()).script,
+        type: {
+            ...scriptInfo,
+            args: id,
+        },
+    }, packedClusterData);
+    // complete cellDeps
+    await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
+    // generate cobuild action
+    const actions = scriptInfo.cobuild
+        ? [
+            assembleCreateClusterAction(tx.outputs[tx.outputs.length - 1], packedClusterData, scriptInfoHash),
+        ]
+        : [];
+    return {
+        tx: await prepareSporeTransaction(signer, tx, actions),
+        id,
+    };
+}
+/**
+ * Transfer a Cluster cell
+ *
+ * @param signer who takes the responsibility to balance and sign the transaction
+ * @param id the id of the Cluster cell to be transferred
+ * @param to the new owner of the Cluster cell
+ * @param tx the transaction skeleton, if not provided, a new one will be created
+ * @param scriptInfoHash the script info hash used in cobuild
+ * @returns
+ *  - **tx**: a new transaction that contains transferred Cluster cell
+ */
+export async function transferSporeCluster(params) {
+    const { signer, id, to, scriptInfoHash } = params;
+    // prepare transaction
+    const tx = ccc.Transaction.from(params.tx ?? {});
+    // build cluster cell
+    const { cell: cluster, scriptInfo } = await assertCluster(signer.client, id);
+    tx.inputs.push(ccc.CellInput.from({
+        previousOutput: cluster.outPoint,
+        ...cluster,
+    }));
+    tx.addOutput({
+        lock: to,
+        type: cluster.cellOutput.type,
+    }, cluster.outputData);
+    // complete cellDeps
+    await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
+    // generate cobuild action
+    const actions = scriptInfo.cobuild
+        ? [
+            assembleTransferClusterAction(cluster.cellOutput, tx.outputs[tx.outputs.length - 1], scriptInfoHash),
+        ]
+        : [];
+    return {
+        tx: await prepareSporeTransaction(signer, tx, actions),
+    };
+}

package/dist/cobuild/index.d.ts

@@ -0,0 +1,13 @@
+import { ccc } from "@ckb-ccc/core";
+import { UnpackResult } from "@ckb-lumos/codec";
+import { Action, ActionVec, WitnessLayout } from "../codec/index.js";
+export declare function assembleCreateSporeAction(sporeOutput: ccc.CellOutputLike, sporeData: ccc.BytesLike, scriptInfoHash?: ccc.HexLike): UnpackResult<typeof Action>;
+export declare function assembleTransferSporeAction(sporeInput: ccc.CellOutputLike, sporeOutput: ccc.CellOutputLike, scriptInfoHash?: ccc.HexLike): UnpackResult<typeof Action>;
+export declare function assembleMeltSporeAction(sporeInput: ccc.CellOutputLike, scriptInfoHash?: ccc.HexLike): UnpackResult<typeof Action>;
+export declare function assembleCreateClusterAction(clusterOutput: ccc.CellOutputLike, clusterData: ccc.BytesLike, scriptInfoHash?: ccc.HexLike): UnpackResult<typeof Action>;
+export declare function assembleTransferClusterAction(clusterInput: ccc.CellOutputLike, clusterOutput: ccc.CellOutputLike, scriptInfoHash?: ccc.HexLike): UnpackResult<typeof Action>;
+export declare function prepareSporeTransaction(signer: ccc.Signer, txLike: ccc.TransactionLike, actions: UnpackResult<typeof ActionVec>): Promise<ccc.Transaction>;
+export declare function unpackCommonCobuildProof(data: ccc.HexLike): UnpackResult<typeof WitnessLayout> | undefined;
+export declare function extractCobuildActionsFromTx(tx: ccc.Transaction): UnpackResult<typeof ActionVec>;
+export declare function injectCobuild(tx: ccc.Transaction, actions: UnpackResult<typeof ActionVec>): void;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cobuild/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EACL,MAAM,EACN,SAAS,EAET,aAAa,EACd,MAAM,mBAAmB,CAAC;AAG3B,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,GAAG,CAAC,cAAc,EAC/B,SAAS,EAAE,GAAG,CAAC,SAAS,EACxB,cAAc,GAAE,GAAG,CAAC,OAAmC,GACtD,YAAY,CAAC,OAAO,MAAM,CAAC,CAsB7B;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,GAAG,CAAC,cAAc,EAC9B,WAAW,EAAE,GAAG,CAAC,cAAc,EAC/B,cAAc,GAAE,GAAG,CAAC,OAAmC,GACtD,YAAY,CAAC,OAAO,MAAM,CAAC,CA0B7B;AAED,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,GAAG,CAAC,cAAc,EAC9B,cAAc,GAAE,GAAG,CAAC,OAAmC,GACtD,YAAY,CAAC,OAAO,MAAM,CAAC,CAqB7B;AAED,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,GAAG,CAAC,cAAc,EACjC,WAAW,EAAE,GAAG,CAAC,SAAS,EAC1B,cAAc,GAAE,GAAG,CAAC,OAAmC,GACtD,YAAY,CAAC,OAAO,MAAM,CAAC,CAsB7B;AAED,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,GAAG,CAAC,cAAc,EAChC,aAAa,EAAE,GAAG,CAAC,cAAc,EACjC,cAAc,GAAE,GAAG,CAAC,OAAmC,GACtD,YAAY,CAAC,OAAO,MAAM,CAAC,CAyB7B;AAED,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,OAAO,EAAE,YAAY,CAAC,OAAO,SAAS,CAAC,GACtC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAW1B;AAED,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,GAAG,CAAC,OAAO,GAChB,YAAY,CAAC,OAAO,aAAa,CAAC,GAAG,SAAS,CAMhD;AAED,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,GAAG,CAAC,WAAW,GAClB,YAAY,CAAC,OAAO,SAAS,CAAC,CAiBhC;AAED,wBAAgB,aAAa,CAC3B,EAAE,EAAE,GAAG,CAAC,WAAW,EACnB,OAAO,EAAE,YAAY,CAAC,OAAO,SAAS,CAAC,GACtC,IAAI,CAaN"}

package/dist/cobuild/index.js

@@ -0,0 +1,168 @@
+import { ccc } from "@ckb-ccc/core";
+import { SporeAction, WitnessLayout, } from "../codec/index.js";
+import { DEFAULT_COBUILD_INFO_HASH } from "../predefined/index.js";
+export function assembleCreateSporeAction(sporeOutput, sporeData, scriptInfoHash = DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeOutput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = ccc.Script.from(sporeOutput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = SporeAction.pack({
+        type: "CreateSpore",
+        value: {
+            sporeId: sporeType.args,
+            dataHash: ccc.hashCkb(sporeData),
+            to: {
+                type: "Script",
+                value: ccc.Script.from(sporeOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: ccc.hexFrom(actionData),
+    };
+}
+export function assembleTransferSporeAction(sporeInput, sporeOutput, scriptInfoHash = DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeInput.type || !sporeOutput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = ccc.Script.from(sporeOutput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = SporeAction.pack({
+        type: "TransferSpore",
+        value: {
+            sporeId: sporeType.args,
+            from: {
+                type: "Script",
+                value: ccc.Script.from(sporeInput.lock),
+            },
+            to: {
+                type: "Script",
+                value: ccc.Script.from(sporeOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: ccc.hexFrom(actionData),
+    };
+}
+export function assembleMeltSporeAction(sporeInput, scriptInfoHash = DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeInput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = ccc.Script.from(sporeInput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = SporeAction.pack({
+        type: "MeltSpore",
+        value: {
+            sporeId: sporeType.args,
+            from: {
+                type: "Script",
+                value: ccc.Script.from(sporeInput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: ccc.hexFrom(actionData),
+    };
+}
+export function assembleCreateClusterAction(clusterOutput, clusterData, scriptInfoHash = DEFAULT_COBUILD_INFO_HASH) {
+    if (!clusterOutput.type) {
+        throw new Error("Cluster cell must have a type script");
+    }
+    const clusterType = ccc.Script.from(clusterOutput.type);
+    const clusterTypeHash = clusterType.hash();
+    const actionData = SporeAction.pack({
+        type: "CreateCluster",
+        value: {
+            clusterId: clusterType.args,
+            dataHash: ccc.hashCkb(clusterData),
+            to: {
+                type: "Script",
+                value: ccc.Script.from(clusterOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: ccc.hexFrom(scriptInfoHash),
+        scriptHash: clusterTypeHash,
+        data: ccc.hexFrom(actionData),
+    };
+}
+export function assembleTransferClusterAction(clusterInput, clusterOutput, scriptInfoHash = DEFAULT_COBUILD_INFO_HASH) {
+    if (!clusterInput.type || !clusterOutput.type) {
+        throw new Error("Cluster cell must have a type script");
+    }
+    const clusterType = ccc.Script.from(clusterOutput.type);
+    const clusterTypeHash = clusterType.hash();
+    const actionData = SporeAction.pack({
+        type: "TransferCluster",
+        value: {
+            clusterId: clusterType.args,
+            from: {
+                type: "Script",
+                value: ccc.Script.from(clusterInput.lock),
+            },
+            to: {
+                type: "Script",
+                value: ccc.Script.from(clusterOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: ccc.hexFrom(scriptInfoHash),
+        scriptHash: clusterTypeHash,
+        data: ccc.hexFrom(actionData),
+    };
+}
+export async function prepareSporeTransaction(signer, txLike, actions) {
+    let tx = ccc.Transaction.from(txLike);
+    if (actions.length === 0) {
+        return signer.prepareTransaction(tx);
+    }
+    const existedActions = extractCobuildActionsFromTx(tx);
+    tx = await signer.prepareTransaction(tx);
+    injectCobuild(tx, [...existedActions, ...actions]);
+    return tx;
+}
+export function unpackCommonCobuildProof(data) {
+    try {
+        return WitnessLayout.unpack(ccc.bytesFrom(data));
+    }
+    catch {
+        return;
+    }
+}
+export function extractCobuildActionsFromTx(tx) {
+    if (tx.witnesses.length === 0) {
+        return [];
+    }
+    const witnessLayout = unpackCommonCobuildProof(tx.witnesses[tx.witnesses.length - 1]);
+    if (!witnessLayout) {
+        return [];
+    }
+    if (witnessLayout.type !== "SighashAll") {
+        throw new Error("Invalid cobuild proof type: " + witnessLayout.type);
+    }
+    // Remove existed cobuild witness
+    tx.witnesses.pop();
+    return witnessLayout.value.message.actions;
+}
+export function injectCobuild(tx, actions) {
+    const witnessLayout = ccc.hexFrom(WitnessLayout.pack({
+        type: "SighashAll",
+        value: {
+            seal: "0x",
+            message: {
+                actions,
+            },
+        },
+    }));
+    tx.witnesses.push(ccc.hexFrom(witnessLayout));
+}

package/dist/codec/base.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The codec for packing/unpacking UTF-8 raw strings.
+ * Should be packed like so: String.pack('something')
+ */
+export declare const RawString: import("@ckb-lumos/codec/lib/base").BytesCodec<string, string>;
+//# sourceMappingURL=base.d.ts.map

package/dist/codec/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/codec/base.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,SAAS,gEAGpB,CAAC"}

package/dist/codec/base.js

@@ -0,0 +1,10 @@
+import { ccc } from "@ckb-ccc/core";
+import { molecule } from "@ckb-lumos/codec";
+/**
+ * The codec for packing/unpacking UTF-8 raw strings.
+ * Should be packed like so: String.pack('something')
+ */
+export const RawString = molecule.byteVecOf({
+    pack: (packable) => ccc.bytesFrom(packable, "utf8"),
+    unpack: (unpackable) => ccc.bytesTo(unpackable, "utf8"),
+});

package/dist/codec/cluster.d.ts

@@ -0,0 +1,41 @@
+import { ccc } from "@ckb-ccc/core";
+import { molecule } from "@ckb-lumos/codec";
+export declare const MolClusterDataV1: molecule.ObjectLayoutCodec<{
+    name: import("@ckb-lumos/codec/lib/base.js").BytesCodec<string, string>;
+    description: import("@ckb-lumos/codec/lib/base.js").BytesCodec<string, string>;
+}>;
+export declare const MolClusterDataV2: molecule.ObjectLayoutCodec<{
+    name: import("@ckb-lumos/codec/lib/base.js").BytesCodec<string, string>;
+    description: import("@ckb-lumos/codec/lib/base.js").BytesCodec<string, string>;
+    mutantId: molecule.OptionLayoutCodec<import("@ckb-lumos/codec/lib/base.js").BytesCodec<string, import("@ckb-lumos/codec").BytesLike>>;
+}>;
+export interface ClusterDataV1 {
+    name: string;
+    description: string;
+}
+export interface ClusterDataV2 {
+    name: string;
+    description: string;
+    mutantId?: ccc.HexLike;
+}
+export type ClusterData = ClusterDataV2;
+export type ClusterDataVersion = "v1" | "v2";
+/**
+ * Pack RawClusterData to Uint8Array.
+ * Pass an optional "version" field to select a specific packing version.
+ */
+export declare function packRawClusterData(packable: ClusterData): Uint8Array;
+export declare function packRawClusterData(packable: ClusterDataV1, version: "v1"): Uint8Array;
+export declare function packRawClusterData(packable: ClusterDataV2, version: "v2"): Uint8Array;
+export declare function packRawClusterDataV1(packable: ClusterDataV1): Uint8Array;
+export declare function packRawClusterDataV2(packable: ClusterDataV2): Uint8Array;
+/**
+ * Unpack Hex/Bytes to RawClusterData.
+ * Pass an optional "version" field to select a specific unpacking version.
+ */
+export declare function unpackToRawClusterData(unpackable: ccc.BytesLike): ClusterData;
+export declare function unpackToRawClusterData(unpackable: ccc.BytesLike, version: "v1"): ClusterDataV1;
+export declare function unpackToRawClusterData(unpackable: ccc.BytesLike, version: "v2"): ClusterDataV2;
+export declare function unpackToRawClusterDataV1(unpackable: ccc.BytesLike): ClusterDataV1;
+export declare function unpackToRawClusterDataV2(unpackable: ccc.BytesLike): ClusterDataV2;
+//# sourceMappingURL=cluster.d.ts.map

package/dist/codec/cluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cluster.d.ts","sourceRoot":"","sources":["../../src/codec/cluster.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,eAAO,MAAM,gBAAgB;;;EAM5B,CAAC;AACF,eAAO,MAAM,gBAAgB;;;;EAO5B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CACxB;AACD,MAAM,MAAM,WAAW,GAAG,aAAa,CAAC;AAExC,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,IAAI,CAAC;AAE7C;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,WAAW,GAAG,UAAU,CAAC;AACtE,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,IAAI,GACZ,UAAU,CAAC;AACd,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,IAAI,GACZ,UAAU,CAAC;AAgBd,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,GAAG,UAAU,CAKxE;AACD,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,GAAG,UAAU,CAMxE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,GAAG,CAAC,SAAS,GAAG,WAAW,CAAC;AAC/E,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,GAAG,CAAC,SAAS,EACzB,OAAO,EAAE,IAAI,GACZ,aAAa,CAAC;AACjB,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,GAAG,CAAC,SAAS,EACzB,OAAO,EAAE,IAAI,GACZ,aAAa,CAAC;AA0BjB,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,GAAG,CAAC,SAAS,GACxB,aAAa,CAMf;AACD,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,GAAG,CAAC,SAAS,GACxB,aAAa,CAOf"}

package/dist/codec/cluster.js

@@ -0,0 +1,73 @@
+import { ccc } from "@ckb-ccc/core";
+import { blockchain } from "@ckb-lumos/base";
+import { molecule } from "@ckb-lumos/codec";
+import { RawString } from "./base.js";
+export const MolClusterDataV1 = molecule.table({
+    name: RawString,
+    description: RawString,
+}, ["name", "description"]);
+export const MolClusterDataV2 = molecule.table({
+    name: RawString,
+    description: RawString,
+    mutantId: blockchain.BytesOpt,
+}, ["name", "description", "mutantId"]);
+export function packRawClusterData(packable, version) {
+    if (!version) {
+        return packRawClusterDataV2(packable);
+    }
+    switch (version) {
+        case "v1":
+            return packRawClusterDataV1(packable);
+        case "v2":
+            return packRawClusterDataV2(packable);
+    }
+}
+export function packRawClusterDataV1(packable) {
+    return MolClusterDataV1.pack({
+        name: packable.name,
+        description: packable.description,
+    });
+}
+export function packRawClusterDataV2(packable) {
+    return MolClusterDataV2.pack({
+        name: packable.name,
+        description: packable.description,
+        mutantId: packable.mutantId,
+    });
+}
+export function unpackToRawClusterData(unpackable, version) {
+    if (version) {
+        switch (version) {
+            case "v1":
+                return unpackToRawClusterDataV1(unpackable);
+            case "v2":
+                return unpackToRawClusterDataV2(unpackable);
+        }
+    }
+    try {
+        return unpackToRawClusterDataV2(unpackable);
+    }
+    catch {
+        try {
+            return unpackToRawClusterDataV1(unpackable);
+        }
+        catch {
+            throw new Error(`Cannot unpack ClusterData, no matching molecule: ${ccc.hexFrom(unpackable)}`);
+        }
+    }
+}
+export function unpackToRawClusterDataV1(unpackable) {
+    const decoded = MolClusterDataV1.unpack(unpackable);
+    return {
+        name: decoded.name,
+        description: decoded.description,
+    };
+}
+export function unpackToRawClusterDataV2(unpackable) {
+    const decoded = MolClusterDataV2.unpack(unpackable);
+    return {
+        name: decoded.name,
+        description: decoded.description,
+        mutantId: ccc.apply(ccc.hexFrom, decoded.mutantId),
+    };
+}