@ckb-ccc/spore 1.2.4 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/spore",
-  "version": "1.2.4",
+  "version": "1.3.0",
   "description": "CCC - CKBer's Codebase. Common Chains Connector's support for Spore protocol",
   "author": "ashuralyk <ashuralyk@live.com>",
   "license": "MIT",
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "axios": "^1.7.7",
-    "@ckb-ccc/core": "1.5.3"
+    "@ckb-ccc/core": "1.6.0"
   },
   "scripts": {
     "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",

package/src/cluster/index.ts

@@ -67,12 +67,12 @@ export async function assertCluster(
 /**
  * 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
+ * @param params.signer who takes the responsibility to balance and sign the transaction
+ * @param params.data specific format of data required by Cluster protocol
+ * @param params.to the owner of the Cluster cell, which will be replaced with signer if not provided
+ * @param params.tx the transaction skeleton, if not provided, a new one will be created
+ * @param params.scriptInfo the script info of new cluster, default spore version if undefined
+ * @param params.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
@@ -132,11 +132,11 @@ export async function createSporeCluster(params: {
 /**
  * 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
+ * @param params.signer who takes the responsibility to balance and sign the transaction
+ * @param params.id the id of the Cluster cell to be transferred
+ * @param params.to the new owner of the Cluster cell
+ * @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 Cluster cell
  */
@@ -145,24 +145,24 @@ export async function transferSporeCluster(params: {
   id: ccc.HexLike;
   to: ccc.ScriptLike;
   tx?: ccc.TransactionLike;
+  scripts?: SporeScriptInfoLike[];
   scriptInfoHash?: ccc.HexLike;
 }): Promise<{
   tx: ccc.Transaction;
 }> {
-  const { signer, id, to, scriptInfoHash } = params;
+  const { signer, id, to, scripts, 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,
-    }),
+  const { cell: cluster, scriptInfo: clusterScriptInfo } = await assertCluster(
+    signer.client,
+    id,
+    scripts,
   );
+
+  tx.addInput(cluster);
   tx.addOutput(
     {
       lock: to,
@@ -172,10 +172,10 @@ export async function transferSporeCluster(params: {
   );
 
   // complete cellDeps
-  await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
+  await tx.addCellDepInfos(signer.client, clusterScriptInfo.cellDeps);
 
   // generate cobuild action
-  const actions = scriptInfo.cobuild
+  const actions = clusterScriptInfo.cobuild
     ? [
         assembleTransferClusterAction(
           cluster.cellOutput,
@@ -193,16 +193,11 @@ export async function transferSporeCluster(params: {
 /**
  * Search on-chain clusters under the signer's control
  *
- * @param signer the owner of clusters
- * @param order the order in creation time of clusters
- * @param scriptInfos the deployed script infos of clusters
+ * @param params.signer the owner of clusters
+ * @param params.order the order in creation time of clusters
+ * @param params.scriptInfos the deployed script infos of clusters
  */
-export async function* findSporeClustersBySigner({
-  signer,
-  order,
-  limit,
-  scriptInfos,
-}: {
+export async function* findSporeClustersBySigner(params: {
   signer: ccc.Signer;
   order?: "asc" | "desc";
   limit?: number;
@@ -213,6 +208,7 @@ export async function* findSporeClustersBySigner({
   clusterData: ClusterDataView;
   scriptInfo: SporeScriptInfo;
 }> {
+  const { signer, order, limit, scriptInfos } = params;
   for (const scriptInfo of scriptInfos ??
     Object.values(getClusterScriptInfos(signer.client))) {
     if (!scriptInfo) {
@@ -239,3 +235,56 @@ export async function* findSporeClustersBySigner({
     }
   }
 }
+
+/**
+ * Search on-chain clusters under the specified lock or not
+ *
+ * @param params.client the client to search clusters
+ * @param params.lock the lock of clusters
+ */
+export async function* findSporeClusters(params: {
+  client: ccc.Client;
+  lock?: ccc.ScriptLike;
+  order?: "asc" | "desc";
+  limit?: number;
+  scriptInfos?: SporeScriptInfoLike[];
+}): AsyncGenerator<{
+  cell: ccc.Cell;
+  cluster: ccc.Cell;
+  clusterData: ClusterDataView;
+  scriptInfo: SporeScriptInfo;
+}> {
+  const { client, lock, order, limit, scriptInfos } = params;
+  for (const scriptInfo of scriptInfos ??
+    Object.values(getClusterScriptInfos(client))) {
+    if (!scriptInfo) {
+      continue;
+    }
+
+    for await (const cluster of client.findCells(
+      {
+        script: {
+          ...scriptInfo,
+          args: "",
+        },
+        scriptType: "type",
+        scriptSearchMode: "prefix",
+        withData: true,
+        filter: lock
+          ? {
+              script: lock,
+            }
+          : undefined,
+      },
+      order,
+      limit,
+    )) {
+      yield {
+        cell: cluster,
+        cluster,
+        clusterData: unpackToRawClusterData(cluster.outputData),
+        scriptInfo: SporeScriptInfo.from(scriptInfo),
+      };
+    }
+  }
+}

package/src/cobuild/index.ts

@@ -204,7 +204,8 @@ export function injectCobuild(
   tx: ccc.Transaction,
   actions: mol.EncodableType<typeof ActionVec>,
 ): void {
-  const witnessLayout = ccc.hexFrom(
+  tx.setWitnessAt(
+    Math.max(tx.witnesses.length, tx.inputs.length),
     WitnessLayout.encode({
       type: "SighashAll",
       value: {
@@ -215,5 +216,4 @@ export function injectCobuild(
       },
     }),
   );
-  tx.witnesses.push(ccc.hexFrom(witnessLayout));
 }

package/src/spore/advanced.ts

@@ -50,12 +50,7 @@ export async function prepareCluster(
         return;
       }
 
-      tx.inputs.push(
-        ccc.CellInput.from({
-          previousOutput: cluster.outPoint,
-          ...cluster,
-        }),
-      );
+      tx.addInput(cluster);
       tx.addOutput(cluster.cellOutput, cluster.outputData);
       await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
       // note: add cluster as cellDep, which will be used in Spore contract

package/src/spore/index.ts

@@ -69,17 +69,17 @@ export async function assertSpore(
 /**
  * Create one Spore cell with the specified Spore data.
  *
- * @param signer who takes the responsibility to balance and sign the transaction
- * @param data specific format of data required by Spore protocol
- * @param to owner of new spore cell, signer if no provided
- * @param clusterMode how to process cluster cell **(if clusterId is not provided in SporeData, this parameter will be ignored)**
+ * @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 tx the transaction skeleton, if not provided, a new one will be created
- * @param scriptInfo the script info of Spore cell, if not provided, the default script info will be used
- * @param scriptInfoHash the script info hash used in cobuild
+ * @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
@@ -151,11 +151,11 @@ export async function createSpore(params: {
 /**
  * Transfer one Spore cell
  *
- * @param signer who takes the responsibility to balance and sign the transaction
- * @param id sporeId
- * @param to Spore's new owner
- * @param tx the transaction skeleton, if not provided, a new one will be created
- * @param scriptInfoHash the script info hash used in cobuild
+ * @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
  */
@@ -164,23 +164,23 @@ export async function transferSpore(params: {
   id: ccc.HexLike;
   to: ccc.ScriptLike;
   tx?: ccc.TransactionLike;
+  scripts?: SporeScriptInfoLike[];
   scriptInfoHash?: ccc.HexLike;
 }): Promise<{
   tx: ccc.Transaction;
 }> {
-  const { signer, id, to, scriptInfoHash } = params;
+  const { signer, id, to, scripts, scriptInfoHash } = params;
 
   // prepare transaction
   const tx = ccc.Transaction.from(params.tx ?? {});
 
-  const { cell: sporeCell, scriptInfo } = await assertSpore(signer.client, id);
-  await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
-  tx.inputs.push(
-    ccc.CellInput.from({
-      previousOutput: sporeCell.outPoint,
-      ...sporeCell,
-    }),
+  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,
@@ -189,7 +189,7 @@ export async function transferSpore(params: {
     sporeCell.outputData,
   );
 
-  const actions = scriptInfo.cobuild
+  const actions = sporeScriptInfo.cobuild
     ? [
         assembleTransferSporeAction(
           sporeCell.cellOutput,
@@ -207,10 +207,10 @@ export async function transferSpore(params: {
 /**
  * Melt one Spore cell
  *
- * @param signer who takes the responsibility to balance and sign the transaction
- * @param id sporeId to be melted
- * @param tx the transaction skeleton, if not provided, a new one will be created
- * @param scriptInfoHash the script info hash used in cobuild
+ * @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
  */
@@ -218,26 +218,26 @@ export async function meltSpore(params: {
   signer: ccc.Signer;
   id: ccc.HexLike;
   tx?: ccc.TransactionLike;
+  scripts?: SporeScriptInfoLike[];
   scriptInfoHash?: ccc.HexLike;
 }): Promise<{
   tx: ccc.Transaction;
 }> {
-  const { signer, id, scriptInfoHash } = params;
+  const { signer, id, scripts, scriptInfoHash } = params;
 
   // prepare transaction
   const tx = ccc.Transaction.from(params.tx ?? {});
 
   // build spore cell
-  const { cell: sporeCell, scriptInfo } = await assertSpore(signer.client, id);
-  await tx.addCellDepInfos(signer.client, scriptInfo.cellDeps);
-  tx.inputs.push(
-    ccc.CellInput.from({
-      previousOutput: sporeCell.outPoint,
-      ...sporeCell,
-    }),
+  const { cell: sporeCell, scriptInfo: sporeScriptInfo } = await assertSpore(
+    signer.client,
+    id,
+    scripts,
   );
+  await tx.addCellDepInfos(signer.client, sporeScriptInfo.cellDeps);
+  tx.addInput(sporeCell);
 
-  const actions = scriptInfo.cobuild
+  const actions = sporeScriptInfo.cobuild
     ? [assembleMeltSporeAction(sporeCell.cellOutput, scriptInfoHash)]
     : [];
 
@@ -249,19 +249,13 @@ export async function meltSpore(params: {
 /**
  * Search on-chain spores under the signer's control, if cluster provided, filter spores belonging to this cluster
  *
- * @param signer the owner of spores
- * @param order the order in creation time of spores
- * @param clusterId the cluster that spores belong to. "" to find public spores
- * @param scriptInfos the deployed script infos of spores
+ * @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 async function* findSporesBySigner({
-  signer,
-  clusterId,
-  scriptInfos,
-  limit,
-  order,
-}: {
+export async function* findSporesBySigner(params: {
   signer: ccc.Signer;
   order?: "asc" | "desc";
   limit?: number;
@@ -273,6 +267,7 @@ export async function* findSporesBySigner({
   sporeData: SporeDataView;
   scriptInfo: SporeScriptInfo;
 }> {
+  const { signer, clusterId, scriptInfos, limit, order } = params;
   for (const scriptInfo of scriptInfos ??
     Object.values(getSporeScriptInfos(signer.client))) {
     if (!scriptInfo) {
@@ -305,3 +300,68 @@ export async function* findSporesBySigner({
     }
   }
 }
+
+/**
+ * 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 async 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;
+}> {
+  const { client, lock, clusterId, scriptInfos, limit, order } = params;
+  for (const scriptInfo of scriptInfos ??
+    Object.values(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 = unpackToRawSporeData(spore.outputData);
+      if (
+        !clusterId ||
+        (clusterId === "" && !sporeData.clusterId) ||
+        sporeData.clusterId === ccc.hexFrom(clusterId)
+      ) {
+        yield {
+          cell: spore,
+          spore,
+          sporeData,
+          scriptInfo: SporeScriptInfo.from(scriptInfo),
+        };
+      }
+    }
+  }
+}