@ckbfs/api 1.5.0 → 1.5.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Script, Signer, Transaction } from "@ckb-ccc/core";
 import { calculateChecksum, verifyChecksum, updateChecksum, verifyWitnessChecksum } from "./utils/checksum";
-import { createCKBFSCell, createPublishTransaction as utilCreatePublishTransaction, createAppendTransaction as utilCreateAppendTransaction, publishCKBFS as utilPublishCKBFS, appendCKBFS as utilAppendCKBFS, CKBFSCellOptions, PublishOptions, AppendOptions } from "./utils/transaction";
+import { createCKBFSCell, createPublishTransaction as utilCreatePublishTransaction, preparePublishTransaction, createAppendTransaction as utilCreateAppendTransaction, prepareAppendTransaction, createAppendTransactionDry, publishCKBFS as utilPublishCKBFS, appendCKBFS as utilAppendCKBFS, CKBFSCellOptions, PublishOptions, AppendOptions } from "./utils/transaction";
 import { readFile, readFileAsText, readFileAsUint8Array, writeFile, getContentType, splitFileIntoChunks, combineChunksToFile, getFileContentFromChain, saveFileFromChain, getFileContentFromChainByTypeId, saveFileFromChainByTypeId, decodeFileFromChainByTypeId, getFileContentFromChainByIdentifier, saveFileFromChainByIdentifier, decodeFileFromChainByIdentifier, parseIdentifier, IdentifierType, decodeWitnessContent, decodeMultipleWitnessContents, extractFileFromWitnesses, decodeFileFromWitnessData, saveFileFromWitnessData } from "./utils/file";
 import { createCKBFSWitness, createTextCKBFSWitness, extractCKBFSWitnessContent, isCKBFSWitness, createChunkedCKBFSWitnesses } from "./utils/witness";
 import { CKBFSData, BackLinkV1, BackLinkV2, CKBFSDataType, BackLinkType, CKBFS_HEADER, CKBFS_HEADER_STRING } from "./utils/molecule";
@@ -132,4 +132,4 @@ export declare class CKBFS {
      */
     createAppendContentTransaction(content: string | Uint8Array, ckbfsCell: AppendOptions["ckbfsCell"], options?: AppendContentOptions): Promise<Transaction>;
 }
-export { calculateChecksum, verifyChecksum, updateChecksum, verifyWitnessChecksum, createCKBFSCell, utilCreatePublishTransaction as createPublishTransaction, utilCreateAppendTransaction as createAppendTransaction, utilPublishCKBFS as publishCKBFS, utilAppendCKBFS as appendCKBFS, readFile, readFileAsText, readFileAsUint8Array, writeFile, getContentType, splitFileIntoChunks, combineChunksToFile, getFileContentFromChain, saveFileFromChain, getFileContentFromChainByTypeId, saveFileFromChainByTypeId, decodeFileFromChainByTypeId, getFileContentFromChainByIdentifier, saveFileFromChainByIdentifier, decodeFileFromChainByIdentifier, parseIdentifier, IdentifierType, decodeWitnessContent, decodeMultipleWitnessContents, extractFileFromWitnesses, decodeFileFromWitnessData, saveFileFromWitnessData, createCKBFSWitness, createTextCKBFSWitness, extractCKBFSWitnessContent, isCKBFSWitness, createChunkedCKBFSWitnesses, CKBFSData, BackLinkV1, BackLinkV2, CKBFSDataType, BackLinkType, CKBFSCellOptions, PublishOptions, AppendOptions, CKBFS_HEADER, CKBFS_HEADER_STRING, NetworkType, ProtocolVersion, ProtocolVersionType, DEFAULT_NETWORK, DEFAULT_VERSION, CKBFS_CODE_HASH, CKBFS_TYPE_ID, ADLER32_CODE_HASH, ADLER32_TYPE_ID, DEP_GROUP_TX_HASH, DEPLOY_TX_HASH, getCKBFSScriptConfig, CKBFSScriptConfig, };
+export { calculateChecksum, verifyChecksum, updateChecksum, verifyWitnessChecksum, createCKBFSCell, utilCreatePublishTransaction as createPublishTransaction, preparePublishTransaction, utilCreateAppendTransaction as createAppendTransaction, prepareAppendTransaction, utilPublishCKBFS as publishCKBFS, utilAppendCKBFS as appendCKBFS, createAppendTransactionDry, readFile, readFileAsText, readFileAsUint8Array, writeFile, getContentType, splitFileIntoChunks, combineChunksToFile, getFileContentFromChain, saveFileFromChain, getFileContentFromChainByTypeId, saveFileFromChainByTypeId, decodeFileFromChainByTypeId, getFileContentFromChainByIdentifier, saveFileFromChainByIdentifier, decodeFileFromChainByIdentifier, parseIdentifier, IdentifierType, decodeWitnessContent, decodeMultipleWitnessContents, extractFileFromWitnesses, decodeFileFromWitnessData, saveFileFromWitnessData, createCKBFSWitness, createTextCKBFSWitness, extractCKBFSWitnessContent, isCKBFSWitness, createChunkedCKBFSWitnesses, CKBFSData, BackLinkV1, BackLinkV2, CKBFSDataType, BackLinkType, CKBFSCellOptions, PublishOptions, AppendOptions, CKBFS_HEADER, CKBFS_HEADER_STRING, NetworkType, ProtocolVersion, ProtocolVersionType, DEFAULT_NETWORK, DEFAULT_VERSION, CKBFS_CODE_HASH, CKBFS_TYPE_ID, ADLER32_CODE_HASH, ADLER32_TYPE_ID, DEP_GROUP_TX_HASH, DEPLOY_TX_HASH, getCKBFSScriptConfig, CKBFSScriptConfig, };

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADLER32_TYPE_ID = exports.ADLER32_CODE_HASH = exports.CKBFS_TYPE_ID = exports.CKBFS_CODE_HASH = exports.DEFAULT_VERSION = exports.DEFAULT_NETWORK = exports.ProtocolVersion = exports.NetworkType = exports.CKBFS_HEADER_STRING = exports.CKBFS_HEADER = exports.BackLinkV2 = exports.BackLinkV1 = exports.CKBFSData = exports.createChunkedCKBFSWitnesses = exports.isCKBFSWitness = exports.extractCKBFSWitnessContent = exports.createTextCKBFSWitness = exports.createCKBFSWitness = exports.saveFileFromWitnessData = exports.decodeFileFromWitnessData = exports.extractFileFromWitnesses = exports.decodeMultipleWitnessContents = exports.decodeWitnessContent = exports.IdentifierType = exports.parseIdentifier = exports.decodeFileFromChainByIdentifier = exports.saveFileFromChainByIdentifier = exports.getFileContentFromChainByIdentifier = exports.decodeFileFromChainByTypeId = exports.saveFileFromChainByTypeId = exports.getFileContentFromChainByTypeId = exports.saveFileFromChain = exports.getFileContentFromChain = exports.combineChunksToFile = exports.splitFileIntoChunks = exports.getContentType = exports.writeFile = exports.readFileAsUint8Array = exports.readFileAsText = exports.readFile = exports.appendCKBFS = exports.publishCKBFS = exports.createAppendTransaction = exports.createPublishTransaction = exports.createCKBFSCell = exports.verifyWitnessChecksum = exports.updateChecksum = exports.verifyChecksum = exports.calculateChecksum = exports.CKBFS = void 0;
-exports.getCKBFSScriptConfig = exports.DEPLOY_TX_HASH = exports.DEP_GROUP_TX_HASH = void 0;
+exports.CKBFS_CODE_HASH = exports.DEFAULT_VERSION = exports.DEFAULT_NETWORK = exports.ProtocolVersion = exports.NetworkType = exports.CKBFS_HEADER_STRING = exports.CKBFS_HEADER = exports.BackLinkV2 = exports.BackLinkV1 = exports.CKBFSData = exports.createChunkedCKBFSWitnesses = exports.isCKBFSWitness = exports.extractCKBFSWitnessContent = exports.createTextCKBFSWitness = exports.createCKBFSWitness = exports.saveFileFromWitnessData = exports.decodeFileFromWitnessData = exports.extractFileFromWitnesses = exports.decodeMultipleWitnessContents = exports.decodeWitnessContent = exports.IdentifierType = exports.parseIdentifier = exports.decodeFileFromChainByIdentifier = exports.saveFileFromChainByIdentifier = exports.getFileContentFromChainByIdentifier = exports.decodeFileFromChainByTypeId = exports.saveFileFromChainByTypeId = exports.getFileContentFromChainByTypeId = exports.saveFileFromChain = exports.getFileContentFromChain = exports.combineChunksToFile = exports.splitFileIntoChunks = exports.getContentType = exports.writeFile = exports.readFileAsUint8Array = exports.readFileAsText = exports.readFile = exports.createAppendTransactionDry = exports.appendCKBFS = exports.publishCKBFS = exports.prepareAppendTransaction = exports.createAppendTransaction = exports.preparePublishTransaction = exports.createPublishTransaction = exports.createCKBFSCell = exports.verifyWitnessChecksum = exports.updateChecksum = exports.verifyChecksum = exports.calculateChecksum = exports.CKBFS = void 0;
+exports.getCKBFSScriptConfig = exports.DEPLOY_TX_HASH = exports.DEP_GROUP_TX_HASH = exports.ADLER32_TYPE_ID = exports.ADLER32_CODE_HASH = exports.CKBFS_TYPE_ID = void 0;
 const core_1 = require("@ckb-ccc/core");
 const checksum_1 = require("./utils/checksum");
 Object.defineProperty(exports, "calculateChecksum", { enumerable: true, get: function () { return checksum_1.calculateChecksum; } });
@@ -11,7 +11,10 @@ Object.defineProperty(exports, "verifyWitnessChecksum", { enumerable: true, get:
 const transaction_1 = require("./utils/transaction");
 Object.defineProperty(exports, "createCKBFSCell", { enumerable: true, get: function () { return transaction_1.createCKBFSCell; } });
 Object.defineProperty(exports, "createPublishTransaction", { enumerable: true, get: function () { return transaction_1.createPublishTransaction; } });
+Object.defineProperty(exports, "preparePublishTransaction", { enumerable: true, get: function () { return transaction_1.preparePublishTransaction; } });
 Object.defineProperty(exports, "createAppendTransaction", { enumerable: true, get: function () { return transaction_1.createAppendTransaction; } });
+Object.defineProperty(exports, "prepareAppendTransaction", { enumerable: true, get: function () { return transaction_1.prepareAppendTransaction; } });
+Object.defineProperty(exports, "createAppendTransactionDry", { enumerable: true, get: function () { return transaction_1.createAppendTransactionDry; } });
 Object.defineProperty(exports, "publishCKBFS", { enumerable: true, get: function () { return transaction_1.publishCKBFS; } });
 Object.defineProperty(exports, "appendCKBFS", { enumerable: true, get: function () { return transaction_1.appendCKBFS; } });
 const file_1 = require("./utils/file");

package/dist/utils/transaction.d.ts

@@ -42,6 +42,7 @@ export interface AppendOptions {
     feeRate?: number;
     network?: NetworkType;
     version?: ProtocolVersionType;
+    from?: Transaction;
 }
 /**
  * Ensures a string is prefixed with '0x'
@@ -77,6 +78,15 @@ export declare function preparePublishTransaction(options: PublishOptions): Prom
  * @returns Promise resolving to the created transaction
  */
 export declare function createPublishTransaction(signer: Signer, options: PublishOptions): Promise<Transaction>;
+/**
+ * Prepares a transaction for appending content to a CKBFS file without fee and change handling
+ * @param options Options for appending content
+ * @returns Promise resolving to the prepared transaction and the output index of CKBFS Cell
+ */
+export declare function prepareAppendTransaction(options: AppendOptions): Promise<{
+    tx: Transaction;
+    outputIndex: number;
+}>;
 /**
  * Creates a transaction for appending content to a CKBFS file
  * @param signer The signer to use for the transaction

package/dist/utils/transaction.js

@@ -4,6 +4,7 @@ exports.ensureHexPrefix = ensureHexPrefix;
 exports.createCKBFSCell = createCKBFSCell;
 exports.preparePublishTransaction = preparePublishTransaction;
 exports.createPublishTransaction = createPublishTransaction;
+exports.prepareAppendTransaction = prepareAppendTransaction;
 exports.createAppendTransaction = createAppendTransaction;
 exports.createAppendTransactionDry = createAppendTransactionDry;
 exports.publishCKBFS = publishCKBFS;
@@ -224,20 +225,13 @@ async function createPublishTransaction(signer, options) {
             witnesses: preTx.witnesses,
             outputsData: preTx.outputsData,
             inputs: preTx.inputs,
-            outputs: outputIndex === 0
-                ? [{
-                        lock,
-                        type: ckbfsTypeScript,
-                        capacity: preTx.outputs[outputIndex].capacity,
-                    }]
-                : [
-                    ...preTx.outputs.slice(0, outputIndex), // Include outputs before CKBFS cell
-                    {
-                        lock,
-                        type: ckbfsTypeScript,
-                        capacity: preTx.outputs[outputIndex].capacity,
-                    }
-                ],
+            outputs: preTx.outputs.map((output, index) => index === outputIndex
+                ? {
+                    lock,
+                    type: ckbfsTypeScript,
+                    capacity: output.capacity,
+                }
+                : output),
         });
         return tx;
     }
@@ -254,13 +248,12 @@ async function createPublishTransaction(signer, options) {
     }
 }
 /**
- * Creates a transaction for appending content to a CKBFS file
- * @param signer The signer to use for the transaction
+ * Prepares a transaction for appending content to a CKBFS file without fee and change handling
  * @param options Options for appending content
- * @returns Promise resolving to the created transaction
+ * @returns Promise resolving to the prepared transaction and the output index of CKBFS Cell
  */
-async function createAppendTransaction(signer, options) {
-    const { ckbfsCell, contentChunks, feeRate, network = constants_1.DEFAULT_NETWORK, version = constants_1.DEFAULT_VERSION, } = options;
+async function prepareAppendTransaction(options) {
+    const { from, ckbfsCell, contentChunks, network = constants_1.DEFAULT_NETWORK, version = constants_1.DEFAULT_VERSION, } = options;
     const { outPoint, data, type, lock, capacity } = ckbfsCell;
     // Get CKBFS script config early to use version info
     const config = (0, constants_1.getCKBFSScriptConfig)(network, version);
@@ -273,13 +266,8 @@ async function createAppendTransaction(signer, options) {
     // Update the existing checksum with the new content - this matches Adler32's
     // cumulative nature as required by Rule 11 in the RFC
     const contentChecksum = await (0, checksum_1.updateChecksum)(data.checksum, combinedContent);
-    console.log(`Updated checksum from ${data.checksum} to ${contentChecksum} for appended content`);
-    // Get the recommended address to ensure lock script cell deps are included
-    const address = await signer.getRecommendedAddressObj();
     // Calculate the actual witness indices where our content is placed
-    // CKBFS data starts at index 1 if signer's lock script is the same as ckbfs's lock script
-    // else CKBFS data starts at index 0
-    const contentStartIndex = address.script.hash() === lock.hash() ? 1 : 0;
+    const contentStartIndex = from?.witnesses.length || 1;
     const witnessIndices = Array.from({ length: contentChunks.length }, (_, i) => contentStartIndex + i);
     // Create backlink for the current state based on version
     let newBackLink;
@@ -329,11 +317,6 @@ async function createAppendTransaction(signer, options) {
             backLinks,
         }, constants_1.ProtocolVersion.V2); // Explicitly use V2 for packing
     }
-    // Pack the original data to get its size - use the appropriate version
-    const originalData = molecule_1.CKBFSData.pack(data, version);
-    const originalDataSize = originalData.length;
-    // Get sizes and calculate capacity requirements
-    const newDataSize = outputData.length;
     // Calculate the required capacity for the output cell
     // This accounts for:
     // 1. The output data size
@@ -342,61 +325,140 @@ async function createAppendTransaction(signer, options) {
     // 4. A constant of 8 bytes (for header overhead)
     const ckbfsCellSize = BigInt(outputData.length + type.occupiedSize + lock.occupiedSize + 8) *
         100000000n;
-    console.log(`Original capacity: ${capacity}, Calculated size: ${ckbfsCellSize}, Data size: ${outputData.length}`);
     // Use the maximum value between calculated size and original capacity
     // to ensure we have enough capacity but don't decrease capacity unnecessarily
     const outputCapacity = ckbfsCellSize > capacity ? ckbfsCellSize : capacity;
     // Create initial transaction with the CKBFS cell input
-    const tx = core_1.Transaction.from({
-        inputs: [
-            {
-                previousOutput: {
-                    txHash: outPoint.txHash,
-                    index: outPoint.index,
+    let preTx;
+    if (from) {
+        // If from is not empty, inject/merge the fields
+        preTx = core_1.Transaction.from({
+            ...from,
+            inputs: from.inputs.length === 0
+                ? [
+                    {
+                        previousOutput: {
+                            txHash: outPoint.txHash,
+                            index: outPoint.index,
+                        },
+                        since: "0x0",
+                    },
+                ]
+                : [
+                    ...from.inputs,
+                    {
+                        previousOutput: {
+                            txHash: outPoint.txHash,
+                            index: outPoint.index,
+                        },
+                        since: "0x0",
+                    },
+                ],
+            outputs: from.outputs.length === 0
+                ? [
+                    {
+                        lock,
+                        type,
+                        capacity: outputCapacity,
+                    },
+                ]
+                : [
+                    ...from.outputs,
+                    {
+                        lock,
+                        type,
+                        capacity: outputCapacity,
+                    },
+                ],
+            outputsData: from.outputsData.length === 0
+                ? [outputData]
+                : [
+                    ...from.outputsData,
+                    outputData,
+                ],
+            witnesses: from.witnesses.length === 0
+                ? [
+                    [], // Empty secp witness for signing if not provided
+                    ...ckbfsWitnesses.map((w) => `0x${Buffer.from(w).toString("hex")}`),
+                ]
+                : [
+                    ...from.witnesses,
+                    ...ckbfsWitnesses.map((w) => `0x${Buffer.from(w).toString("hex")}`),
+                ],
+        });
+    }
+    else {
+        preTx = core_1.Transaction.from({
+            inputs: [
+                {
+                    previousOutput: {
+                        txHash: outPoint.txHash,
+                        index: outPoint.index,
+                    },
+                    since: "0x0",
                 },
-                since: "0x0",
-            },
-        ],
-        outputs: [
-            {
-                lock,
-                type,
-                capacity: outputCapacity,
-            },
-        ],
-        outputsData: [outputData],
-    });
+            ],
+            outputs: [
+                {
+                    lock,
+                    type,
+                    capacity: outputCapacity,
+                },
+            ],
+            outputsData: [outputData],
+            witnesses: [
+                [], // Empty secp witness for signing
+                ...ckbfsWitnesses.map((w) => `0x${Buffer.from(w).toString("hex")}`),
+            ],
+        });
+    }
     // Add the CKBFS dep group cell dependency
-    tx.addCellDeps({
+    preTx.addCellDeps({
         outPoint: {
             txHash: ensureHexPrefix(config.depTxHash),
             index: config.depIndex || 0,
         },
         depType: "depGroup",
     });
-    const inputsBefore = tx.inputs.length;
+    const outputIndex = from ? from.outputs.length : 0;
+    return { tx: preTx, outputIndex };
+}
+/**
+ * Creates a transaction for appending content to a CKBFS file
+ * @param signer The signer to use for the transaction
+ * @param options Options for appending content
+ * @returns Promise resolving to the created transaction
+ */
+async function createAppendTransaction(signer, options) {
+    const { ckbfsCell, feeRate, } = options;
+    const { lock } = ckbfsCell;
+    // Use prepareAppendTransaction to create the base transaction
+    const { tx: preTx, outputIndex } = await prepareAppendTransaction(options);
+    // Get the recommended address to ensure lock script cell deps are included
+    const address = await signer.getRecommendedAddressObj();
+    const inputsBefore = preTx.inputs.length;
     // If we need more capacity than the original cell had, add additional inputs
-    if (outputCapacity > capacity) {
-        console.log(`Need additional capacity: ${outputCapacity - capacity} shannons`);
+    if (preTx.outputs[outputIndex].capacity > ckbfsCell.capacity) {
+        console.log(`Need additional capacity: ${preTx.outputs[outputIndex].capacity - ckbfsCell.capacity} shannons`);
         // Add more inputs to cover the increased capacity
-        await tx.completeInputsByCapacity(signer);
+        await preTx.completeInputsByCapacity(signer);
     }
     const witnesses = [];
     // add empty witness for signer if ckbfs's lock is the same as signer's lock
     if (address.script.hash() === lock.hash()) {
         witnesses.push("0x");
     }
-    // add ckbfs witnesses
-    witnesses.push(...ckbfsWitnesses.map((w) => `0x${Buffer.from(w).toString("hex")}`));
-    // Add empty witnesses for signer's input
+    // add ckbfs witnesses (skip the first witness which is for signing)
+    witnesses.push(...preTx.witnesses.slice(1));
+    // Add empty witnesses for additional signer inputs
     // This is to ensure that the transaction is valid and can be signed
-    for (let i = inputsBefore; i < tx.inputs.length; i++) {
+    for (let i = inputsBefore; i < preTx.inputs.length; i++) {
         witnesses.push("0x");
     }
-    tx.witnesses = witnesses;
+    preTx.witnesses = witnesses;
     // Complete fee
-    await tx.completeFeeChangeToLock(signer, address.script, feeRate || 2000);
-    return tx;
+    await preTx.completeFeeChangeToLock(signer, address.script, feeRate || 2000);
+    return preTx;
 }
 /**
  * Creates a transaction for appending content to a CKBFS file
@@ -474,11 +536,6 @@ async function createAppendTransactionDry(signer, options) {
             backLinks,
         }, constants_1.ProtocolVersion.V2); // Explicitly use V2 for packing
     }
-    // Pack the original data to get its size - use the appropriate version
-    const originalData = molecule_1.CKBFSData.pack(data, version);
-    const originalDataSize = originalData.length;
-    // Get sizes and calculate capacity requirements
-    const newDataSize = outputData.length;
     // Calculate the required capacity for the output cell
     // This accounts for:
     // 1. The output data size

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckbfs/api",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "SDK for CKBFS protocol on CKB",
   "license": "MIT",
   "author": "Code Monad<code@lab-11.org>",