@ckb-ccc/spore 1.5.17 → 1.6.0

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

@@ -1,129 +0,0 @@
-import { ccc } from "@ckb-ccc/core";
-import { SporeDataView } from "../codec/index.js";
-import { SporeScriptInfo, SporeScriptInfoLike } from "../predefined/index.js";
-export declare function findSpore(client: ccc.Client, id: ccc.HexLike, scripts?: SporeScriptInfoLike[]): Promise<{
-    cell: ccc.Cell;
-    spore: ccc.Cell;
-    sporeData: SporeDataView;
-    scriptInfo: SporeScriptInfo;
-} | undefined>;
-export declare function assertSpore(client: ccc.Client, args: ccc.HexLike, scripts?: SporeScriptInfoLike[]): Promise<{
-    cell: ccc.Cell;
-    scriptInfo: SporeScriptInfo;
-}>;
-/**
- * Create one Spore cell with the specified Spore data.
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.data specific format of data required by Spore protocol
- * @param params.to owner of new spore cell, signer if no provided
- * @param params.clusterMode how to process cluster cell **(if clusterId is not provided in SporeData, this parameter will be ignored)**
- *   - undefined: error if the spore has a cluster but the clusterMode is not set
- *   - lockProxy: put a cell that uses the same lock from Cluster cell in both Inputs and Outputs
- *   - clusterCell: directly put Cluster cell in Inputs and Outputs
- *   - skip: don't handle the cluster logic
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfo the script info of Spore cell, if not provided, the default script info will be used
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains created Spore cells
- *  - **id**: the sporeId of created Spore cell
- */
-export declare function createSpore(params: {
-    signer: ccc.Signer;
-    data: SporeDataView;
-    to?: ccc.ScriptLike;
-    clusterMode?: "lockProxy" | "clusterCell" | "skip";
-    tx?: ccc.TransactionLike;
-    scriptInfo?: SporeScriptInfoLike;
-    scriptInfoHash?: ccc.HexLike;
-}): Promise<{
-    tx: ccc.Transaction;
-    id: ccc.Hex;
-}>;
-/**
- * Transfer one Spore cell
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.id sporeId
- * @param params.to Spore's new owner
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains transferred Spore cells
- */
-export declare function transferSpore(params: {
-    signer: ccc.Signer;
-    id: ccc.HexLike;
-    to: ccc.ScriptLike;
-    tx?: ccc.TransactionLike;
-    scripts?: SporeScriptInfoLike[];
-    scriptInfoHash?: ccc.HexLike;
-}): Promise<{
-    tx: ccc.Transaction;
-}>;
-/**
- * Melt one Spore cell
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.id sporeId to be melted
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains melted Spore cell
- */
-export declare function meltSpore(params: {
-    signer: ccc.Signer;
-    id: ccc.HexLike;
-    tx?: ccc.TransactionLike;
-    scripts?: SporeScriptInfoLike[];
-    scriptInfoHash?: ccc.HexLike;
-}): Promise<{
-    tx: ccc.Transaction;
-}>;
-/**
- * Search on-chain spores under the signer's control, if cluster provided, filter spores belonging to this cluster
- *
- * @param params.signer the owner of spores
- * @param params.order the order in creation time of spores
- * @param params.clusterId the cluster that spores belong to. "" to find public spores
- * @param params.scriptInfos the deployed script infos of spores
- * @returns specified spore cells
- */
-export declare function findSporesBySigner(params: {
-    signer: ccc.Signer;
-    order?: "asc" | "desc";
-    limit?: number;
-    clusterId?: ccc.HexLike;
-    scriptInfos?: SporeScriptInfoLike[];
-}): AsyncGenerator<{
-    cell: ccc.Cell;
-    spore: ccc.Cell;
-    sporeData: SporeDataView;
-    scriptInfo: SporeScriptInfo;
-}>;
-/**
- * Search on-chain spores under the specified lock or not, if cluster provided, filter spores belonging to this cluster
- *
- * @param params.client the client to search spores
- * @param params.lock the lock of spores
- * @param params.clusterId the cluster that spores belong to. "" to find public spores
- * @param params.scriptInfos the deployed script infos of spores
- * @param params.limit the limit of spores to search
- * @param params.order the order in creation time of spores
- * @returns specified spore cells
- */
-export declare function findSpores(params: {
-    client: ccc.Client;
-    lock?: ccc.ScriptLike;
-    clusterId?: ccc.HexLike;
-    scriptInfos?: SporeScriptInfoLike[];
-    limit?: number;
-    order?: "asc" | "desc";
-}): AsyncGenerator<{
-    cell: ccc.Cell;
-    spore: ccc.Cell;
-    sporeData: SporeDataView;
-    scriptInfo: SporeScriptInfo;
-}>;
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/spore/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC,OAAO,EACL,aAAa,EAGd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,eAAe,EACf,mBAAmB,EAGpB,MAAM,wBAAwB,CAAC;AAGhC,wBAAsB,SAAS,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,EAAE,EAAE,GAAG,CAAC,OAAO,EACf,OAAO,CAAC,EAAE,mBAAmB,EAAE,GAC9B,OAAO,CACN;IACE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,UAAU,EAAE,eAAe,CAAC;CAC7B,GACD,SAAS,CACZ,CAgBA;AAED,wBAAsB,WAAW,CAC/B,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;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE;IACxC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,MAAM,CAAC;IACnD,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,CAmDD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE;IAC1C,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,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC;CACrB,CAAC,CAkCD;AAED;;;;;;;;;GASG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE;IACtC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC;IAChB,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC;CACrB,CAAC,CAsBD;AAED;;;;;;;;GAQG;AACH,wBAAuB,kBAAkB,CAAC,MAAM,EAAE;IAChD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACrC,GAAG,cAAc,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,UAAU,EAAE,eAAe,CAAC;CAC7B,CAAC,CAiCD;AAED;;;;;;;;;;GAUG;AACH,wBAAuB,UAAU,CAAC,MAAM,EAAE;IACxC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;IACtB,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB,GAAG,cAAc,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;IACf,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,UAAU,EAAE,eAAe,CAAC;CAC7B,CAAC,CAwCD"}

package/dist.commonjs/spore/index.js

@@ -1,227 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findSpore = findSpore;
-exports.assertSpore = assertSpore;
-exports.createSpore = createSpore;
-exports.transferSpore = transferSpore;
-exports.meltSpore = meltSpore;
-exports.findSporesBySigner = findSporesBySigner;
-exports.findSpores = findSpores;
-const core_1 = require("@ckb-ccc/core");
-const advanced_js_1 = require("../advanced.js");
-const index_js_1 = require("../codec/index.js");
-const index_js_2 = require("../helper/index.js");
-const index_js_3 = require("../predefined/index.js");
-const advanced_js_2 = require("./advanced.js");
-async function findSpore(client, id, scripts) {
-    const found = await (0, index_js_2.findSingletonCellByArgs)(client, id, scripts ?? Object.values((0, index_js_3.getSporeScriptInfos)(client)));
-    if (!found) {
-        return undefined;
-    }
-    return {
-        cell: found.cell,
-        spore: found.cell,
-        sporeData: (0, index_js_1.unpackToRawSporeData)(found.cell.outputData),
-        scriptInfo: found.scriptInfo,
-    };
-}
-async function assertSpore(client, args, scripts) {
-    const res = await findSpore(client, args, scripts);
-    if (!res) {
-        throw new Error(`Spore ${core_1.ccc.hexFrom(args)} not found`);
-    }
-    return res;
-}
-/**
- * Create one Spore cell with the specified Spore data.
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.data specific format of data required by Spore protocol
- * @param params.to owner of new spore cell, signer if no provided
- * @param params.clusterMode how to process cluster cell **(if clusterId is not provided in SporeData, this parameter will be ignored)**
- *   - undefined: error if the spore has a cluster but the clusterMode is not set
- *   - lockProxy: put a cell that uses the same lock from Cluster cell in both Inputs and Outputs
- *   - clusterCell: directly put Cluster cell in Inputs and Outputs
- *   - skip: don't handle the cluster logic
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfo the script info of Spore cell, if not provided, the default script info will be used
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains created Spore cells
- *  - **id**: the sporeId of created Spore cell
- */
-async function createSpore(params) {
-    const { signer, data, to, clusterMode, scriptInfoHash } = params;
-    const scriptInfo = params.scriptInfo ?? (0, index_js_3.getSporeScriptInfo)(signer.client);
-    // prepare transaction
-    const actions = [];
-    const ids = [];
-    const tx = core_1.ccc.Transaction.from(params.tx ?? {});
-    await tx.completeInputsAtLeastOne(signer);
-    const { script: lock } = await signer.getRecommendedAddressObj();
-    // build spore cell
-    const id = core_1.ccc.hashTypeId(tx.inputs[0], tx.outputs.length);
-    ids.push(id);
-    const packedData = (0, index_js_1.packRawSporeData)(data);
-    tx.addOutput({
-        lock: to ?? lock,
-        type: {
-            ...scriptInfo,
-            args: id,
-        },
-    }, packedData);
-    // create spore action
-    if (scriptInfo.cobuild) {
-        const output = tx.outputs[tx.outputs.length - 1];
-        const createAction = (0, advanced_js_1.assembleCreateSporeAction)(output, packedData, scriptInfoHash);
-        actions.push(createAction);
-    }
-    // complete cellDeps
-    await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
-    const action = await (0, advanced_js_2.prepareCluster)(signer, tx, data, clusterMode);
-    if (action) {
-        actions.push(action);
-    }
-    return {
-        tx: await (0, advanced_js_1.prepareSporeTransaction)(signer, tx, actions),
-        id,
-    };
-}
-/**
- * Transfer one Spore cell
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.id sporeId
- * @param params.to Spore's new owner
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains transferred Spore cells
- */
-async function transferSpore(params) {
-    const { signer, id, to, scripts, scriptInfoHash } = params;
-    // prepare transaction
-    const tx = core_1.ccc.Transaction.from(params.tx ?? {});
-    const { cell: sporeCell, scriptInfo: sporeScriptInfo } = await assertSpore(signer.client, id, scripts);
-    await tx.addCellDepInfos(signer.client, sporeScriptInfo.cellDeps);
-    tx.addInput(sporeCell);
-    tx.addOutput({
-        lock: to,
-        type: sporeCell.cellOutput.type,
-    }, sporeCell.outputData);
-    const actions = sporeScriptInfo.cobuild
-        ? [
-            (0, advanced_js_1.assembleTransferSporeAction)(sporeCell.cellOutput, tx.outputs[tx.outputs.length - 1], scriptInfoHash),
-        ]
-        : [];
-    return {
-        tx: await (0, advanced_js_1.prepareSporeTransaction)(signer, tx, actions),
-    };
-}
-/**
- * Melt one Spore cell
- *
- * @param params.signer who takes the responsibility to balance and sign the transaction
- * @param params.id sporeId to be melted
- * @param params.tx the transaction skeleton, if not provided, a new one will be created
- * @param params.scriptInfoHash the script info hash used in cobuild
- * @returns
- *  - **tx**: a new transaction that contains melted Spore cell
- */
-async function meltSpore(params) {
-    const { signer, id, scripts, scriptInfoHash } = params;
-    // prepare transaction
-    const tx = core_1.ccc.Transaction.from(params.tx ?? {});
-    // build spore cell
-    const { cell: sporeCell, scriptInfo: sporeScriptInfo } = await assertSpore(signer.client, id, scripts);
-    await tx.addCellDepInfos(signer.client, sporeScriptInfo.cellDeps);
-    tx.addInput(sporeCell);
-    const actions = sporeScriptInfo.cobuild
-        ? [(0, advanced_js_1.assembleMeltSporeAction)(sporeCell.cellOutput, scriptInfoHash)]
-        : [];
-    return {
-        tx: await (0, advanced_js_1.prepareSporeTransaction)(signer, tx, actions),
-    };
-}
-/**
- * Search on-chain spores under the signer's control, if cluster provided, filter spores belonging to this cluster
- *
- * @param params.signer the owner of spores
- * @param params.order the order in creation time of spores
- * @param params.clusterId the cluster that spores belong to. "" to find public spores
- * @param params.scriptInfos the deployed script infos of spores
- * @returns specified spore cells
- */
-async function* findSporesBySigner(params) {
-    const { signer, clusterId, scriptInfos, limit, order } = params;
-    for (const scriptInfo of scriptInfos ??
-        Object.values((0, index_js_3.getSporeScriptInfos)(signer.client))) {
-        if (!scriptInfo) {
-            continue;
-        }
-        for await (const spore of signer.findCells({
-            script: {
-                ...scriptInfo,
-                args: [],
-            },
-        }, true, order, limit)) {
-            const sporeData = (0, index_js_1.unpackToRawSporeData)(spore.outputData);
-            if (!clusterId ||
-                (clusterId === "" && !sporeData.clusterId) ||
-                sporeData.clusterId === core_1.ccc.hexFrom(clusterId)) {
-                yield {
-                    cell: spore,
-                    spore,
-                    sporeData,
-                    scriptInfo: index_js_3.SporeScriptInfo.from(scriptInfo),
-                };
-            }
-        }
-    }
-}
-/**
- * Search on-chain spores under the specified lock or not, if cluster provided, filter spores belonging to this cluster
- *
- * @param params.client the client to search spores
- * @param params.lock the lock of spores
- * @param params.clusterId the cluster that spores belong to. "" to find public spores
- * @param params.scriptInfos the deployed script infos of spores
- * @param params.limit the limit of spores to search
- * @param params.order the order in creation time of spores
- * @returns specified spore cells
- */
-async function* findSpores(params) {
-    const { client, lock, clusterId, scriptInfos, limit, order } = params;
-    for (const scriptInfo of scriptInfos ??
-        Object.values((0, index_js_3.getSporeScriptInfos)(client))) {
-        if (!scriptInfo) {
-            continue;
-        }
-        for await (const spore of client.findCells({
-            script: {
-                ...scriptInfo,
-                args: [],
-            },
-            scriptType: "type",
-            scriptSearchMode: "prefix",
-            withData: true,
-            filter: lock
-                ? {
-                    script: lock,
-                }
-                : undefined,
-        }, order, limit)) {
-            const sporeData = (0, index_js_1.unpackToRawSporeData)(spore.outputData);
-            if (!clusterId ||
-                (clusterId === "" && !sporeData.clusterId) ||
-                sporeData.clusterId === core_1.ccc.hexFrom(clusterId)) {
-                yield {
-                    cell: spore,
-                    spore,
-                    sporeData,
-                    scriptInfo: index_js_3.SporeScriptInfo.from(scriptInfo),
-                };
-            }
-        }
-    }
-}