@ckb-ccc/spore 0.1.0-alpha.2

package/dist.commonjs/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.commonjs/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.commonjs/cobuild/index.js

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assembleCreateSporeAction = assembleCreateSporeAction;
+exports.assembleTransferSporeAction = assembleTransferSporeAction;
+exports.assembleMeltSporeAction = assembleMeltSporeAction;
+exports.assembleCreateClusterAction = assembleCreateClusterAction;
+exports.assembleTransferClusterAction = assembleTransferClusterAction;
+exports.prepareSporeTransaction = prepareSporeTransaction;
+exports.unpackCommonCobuildProof = unpackCommonCobuildProof;
+exports.extractCobuildActionsFromTx = extractCobuildActionsFromTx;
+exports.injectCobuild = injectCobuild;
+const core_1 = require("@ckb-ccc/core");
+const index_js_1 = require("../codec/index.js");
+const index_js_2 = require("../predefined/index.js");
+function assembleCreateSporeAction(sporeOutput, sporeData, scriptInfoHash = index_js_2.DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeOutput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = core_1.ccc.Script.from(sporeOutput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = index_js_1.SporeAction.pack({
+        type: "CreateSpore",
+        value: {
+            sporeId: sporeType.args,
+            dataHash: core_1.ccc.hashCkb(sporeData),
+            to: {
+                type: "Script",
+                value: core_1.ccc.Script.from(sporeOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: core_1.ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: core_1.ccc.hexFrom(actionData),
+    };
+}
+function assembleTransferSporeAction(sporeInput, sporeOutput, scriptInfoHash = index_js_2.DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeInput.type || !sporeOutput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = core_1.ccc.Script.from(sporeOutput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = index_js_1.SporeAction.pack({
+        type: "TransferSpore",
+        value: {
+            sporeId: sporeType.args,
+            from: {
+                type: "Script",
+                value: core_1.ccc.Script.from(sporeInput.lock),
+            },
+            to: {
+                type: "Script",
+                value: core_1.ccc.Script.from(sporeOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: core_1.ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: core_1.ccc.hexFrom(actionData),
+    };
+}
+function assembleMeltSporeAction(sporeInput, scriptInfoHash = index_js_2.DEFAULT_COBUILD_INFO_HASH) {
+    if (!sporeInput.type) {
+        throw new Error("Spore cell must have a type script");
+    }
+    const sporeType = core_1.ccc.Script.from(sporeInput.type);
+    const sporeTypeHash = sporeType.hash();
+    const actionData = index_js_1.SporeAction.pack({
+        type: "MeltSpore",
+        value: {
+            sporeId: sporeType.args,
+            from: {
+                type: "Script",
+                value: core_1.ccc.Script.from(sporeInput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: core_1.ccc.hexFrom(scriptInfoHash),
+        scriptHash: sporeTypeHash,
+        data: core_1.ccc.hexFrom(actionData),
+    };
+}
+function assembleCreateClusterAction(clusterOutput, clusterData, scriptInfoHash = index_js_2.DEFAULT_COBUILD_INFO_HASH) {
+    if (!clusterOutput.type) {
+        throw new Error("Cluster cell must have a type script");
+    }
+    const clusterType = core_1.ccc.Script.from(clusterOutput.type);
+    const clusterTypeHash = clusterType.hash();
+    const actionData = index_js_1.SporeAction.pack({
+        type: "CreateCluster",
+        value: {
+            clusterId: clusterType.args,
+            dataHash: core_1.ccc.hashCkb(clusterData),
+            to: {
+                type: "Script",
+                value: core_1.ccc.Script.from(clusterOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: core_1.ccc.hexFrom(scriptInfoHash),
+        scriptHash: clusterTypeHash,
+        data: core_1.ccc.hexFrom(actionData),
+    };
+}
+function assembleTransferClusterAction(clusterInput, clusterOutput, scriptInfoHash = index_js_2.DEFAULT_COBUILD_INFO_HASH) {
+    if (!clusterInput.type || !clusterOutput.type) {
+        throw new Error("Cluster cell must have a type script");
+    }
+    const clusterType = core_1.ccc.Script.from(clusterOutput.type);
+    const clusterTypeHash = clusterType.hash();
+    const actionData = index_js_1.SporeAction.pack({
+        type: "TransferCluster",
+        value: {
+            clusterId: clusterType.args,
+            from: {
+                type: "Script",
+                value: core_1.ccc.Script.from(clusterInput.lock),
+            },
+            to: {
+                type: "Script",
+                value: core_1.ccc.Script.from(clusterOutput.lock),
+            },
+        },
+    });
+    return {
+        scriptInfoHash: core_1.ccc.hexFrom(scriptInfoHash),
+        scriptHash: clusterTypeHash,
+        data: core_1.ccc.hexFrom(actionData),
+    };
+}
+async function prepareSporeTransaction(signer, txLike, actions) {
+    let tx = core_1.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;
+}
+function unpackCommonCobuildProof(data) {
+    try {
+        return index_js_1.WitnessLayout.unpack(core_1.ccc.bytesFrom(data));
+    }
+    catch {
+        return;
+    }
+}
+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;
+}
+function injectCobuild(tx, actions) {
+    const witnessLayout = core_1.ccc.hexFrom(index_js_1.WitnessLayout.pack({
+        type: "SighashAll",
+        value: {
+            seal: "0x",
+            message: {
+                actions,
+            },
+        },
+    }));
+    tx.witnesses.push(core_1.ccc.hexFrom(witnessLayout));
+}

package/dist.commonjs/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.commonjs/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.commonjs/codec/base.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawString = void 0;
+const core_1 = require("@ckb-ccc/core");
+const codec_1 = require("@ckb-lumos/codec");
+/**
+ * The codec for packing/unpacking UTF-8 raw strings.
+ * Should be packed like so: String.pack('something')
+ */
+exports.RawString = codec_1.molecule.byteVecOf({
+    pack: (packable) => core_1.ccc.bytesFrom(packable, "utf8"),
+    unpack: (unpackable) => core_1.ccc.bytesTo(unpackable, "utf8"),
+});

package/dist.commonjs/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.commonjs/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.commonjs/codec/cluster.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MolClusterDataV2 = exports.MolClusterDataV1 = void 0;
+exports.packRawClusterData = packRawClusterData;
+exports.packRawClusterDataV1 = packRawClusterDataV1;
+exports.packRawClusterDataV2 = packRawClusterDataV2;
+exports.unpackToRawClusterData = unpackToRawClusterData;
+exports.unpackToRawClusterDataV1 = unpackToRawClusterDataV1;
+exports.unpackToRawClusterDataV2 = unpackToRawClusterDataV2;
+const core_1 = require("@ckb-ccc/core");
+const base_1 = require("@ckb-lumos/base");
+const codec_1 = require("@ckb-lumos/codec");
+const base_js_1 = require("./base.js");
+exports.MolClusterDataV1 = codec_1.molecule.table({
+    name: base_js_1.RawString,
+    description: base_js_1.RawString,
+}, ["name", "description"]);
+exports.MolClusterDataV2 = codec_1.molecule.table({
+    name: base_js_1.RawString,
+    description: base_js_1.RawString,
+    mutantId: base_1.blockchain.BytesOpt,
+}, ["name", "description", "mutantId"]);
+function packRawClusterData(packable, version) {
+    if (!version) {
+        return packRawClusterDataV2(packable);
+    }
+    switch (version) {
+        case "v1":
+            return packRawClusterDataV1(packable);
+        case "v2":
+            return packRawClusterDataV2(packable);
+    }
+}
+function packRawClusterDataV1(packable) {
+    return exports.MolClusterDataV1.pack({
+        name: packable.name,
+        description: packable.description,
+    });
+}
+function packRawClusterDataV2(packable) {
+    return exports.MolClusterDataV2.pack({
+        name: packable.name,
+        description: packable.description,
+        mutantId: packable.mutantId,
+    });
+}
+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: ${core_1.ccc.hexFrom(unpackable)}`);
+        }
+    }
+}
+function unpackToRawClusterDataV1(unpackable) {
+    const decoded = exports.MolClusterDataV1.unpack(unpackable);
+    return {
+        name: decoded.name,
+        description: decoded.description,
+    };
+}
+function unpackToRawClusterDataV2(unpackable) {
+    const decoded = exports.MolClusterDataV2.unpack(unpackable);
+    return {
+        name: decoded.name,
+        description: decoded.description,
+        mutantId: core_1.ccc.apply(core_1.ccc.hexFrom, decoded.mutantId),
+    };
+}