@ckbfs/api 1.2.3 → 1.2.5

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { Script, Signer, Transaction } from "@ckb-ccc/core";
-import { calculateChecksum, verifyChecksum, updateChecksum, verifyWitnessChecksum } from './utils/checksum';
-import { createCKBFSCell, createPublishTransaction, createAppendTransaction, publishCKBFS, appendCKBFS, CKBFSCellOptions, PublishOptions, AppendOptions } from './utils/transaction';
-import { readFile, readFileAsText, readFileAsUint8Array, writeFile, getContentType, splitFileIntoChunks, combineChunksToFile, getFileContentFromChain, saveFileFromChain } 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';
-import { NetworkType, ProtocolVersion, 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 } from './utils/constants';
+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 { 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";
+import { 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 } from "./utils/constants";
 /**
  * Custom options for file publishing and appending
  */
@@ -14,15 +14,27 @@ export interface FileOptions {
     capacity?: bigint;
     feeRate?: number;
     network?: NetworkType;
-    version?: string;
+    version?: ProtocolVersionType;
     useTypeID?: boolean;
 }
+/**
+ * Options required when publishing content directly (string or Uint8Array)
+ */
+export type PublishContentOptions = Omit<FileOptions, "capacity" | "contentType" | "filename"> & Required<Pick<FileOptions, "contentType" | "filename">> & {
+    capacity?: bigint;
+};
+/**
+ * Options required when appending content directly (string or Uint8Array)
+ */
+export type AppendContentOptions = Omit<FileOptions, "contentType" | "filename" | "capacity"> & {
+    capacity?: bigint;
+};
 /**
  * Configuration options for the CKBFS SDK
  */
 export interface CKBFSOptions {
     chunkSize?: number;
-    version?: string;
+    version?: ProtocolVersionType;
     useTypeID?: boolean;
     network?: NetworkType;
 }
@@ -65,13 +77,28 @@ export declare class CKBFS {
      */
     publishFile(filePath: string, options?: FileOptions): Promise<string>;
     /**
-     * Appends content to an existing CKBFS file
+     * Publishes content (string or Uint8Array) directly to CKBFS
+     * @param content The content string or byte array to publish
+     * @param options Options for publishing the content (contentType and filename are required)
+     * @returns Promise resolving to the transaction hash
+     */
+    publishContent(content: string | Uint8Array, options: PublishContentOptions): Promise<string>;
+    /**
+     * Appends content from a file to an existing CKBFS file
      * @param filePath The path to the file containing the content to append
      * @param ckbfsCell The CKBFS cell to append to
      * @param options Additional options for the append operation
      * @returns Promise resolving to the transaction hash
      */
-    appendFile(filePath: string, ckbfsCell: AppendOptions['ckbfsCell'], options?: Omit<FileOptions, 'contentType' | 'filename'>): Promise<string>;
+    appendFile(filePath: string, ckbfsCell: AppendOptions["ckbfsCell"], options?: Omit<FileOptions, "contentType" | "filename">): Promise<string>;
+    /**
+     * Appends content (string or Uint8Array) directly to an existing CKBFS file
+     * @param content The content string or byte array to append
+     * @param ckbfsCell The CKBFS cell to append to
+     * @param options Additional options for the append operation
+     * @returns Promise resolving to the transaction hash
+     */
+    appendContent(content: string | Uint8Array, ckbfsCell: AppendOptions["ckbfsCell"], options?: AppendContentOptions): Promise<string>;
     /**
      * Creates a new transaction for publishing a file but doesn't sign or send it
      * @param filePath The path to the file to publish
@@ -80,12 +107,27 @@ export declare class CKBFS {
      */
     createPublishTransaction(filePath: string, options?: FileOptions): Promise<Transaction>;
     /**
-     * Creates a new transaction for appending content but doesn't sign or send it
+     * Creates a new transaction for publishing content (string or Uint8Array) directly, but doesn't sign or send it
+     * @param content The content string or byte array to publish
+     * @param options Options for publishing the content (contentType and filename are required)
+     * @returns Promise resolving to the unsigned transaction
+     */
+    createPublishContentTransaction(content: string | Uint8Array, options: PublishContentOptions): Promise<Transaction>;
+    /**
+     * Creates a new transaction for appending content from a file but doesn't sign or send it
      * @param filePath The path to the file containing the content to append
      * @param ckbfsCell The CKBFS cell to append to
      * @param options Additional options for the append operation
      * @returns Promise resolving to the unsigned transaction
      */
-    createAppendTransaction(filePath: string, ckbfsCell: AppendOptions['ckbfsCell'], options?: Omit<FileOptions, 'contentType' | 'filename'>): Promise<Transaction>;
+    createAppendTransaction(filePath: string, ckbfsCell: AppendOptions["ckbfsCell"], options?: Omit<FileOptions, "contentType" | "filename">): Promise<Transaction>;
+    /**
+     * Creates a new transaction for appending content (string or Uint8Array) directly, but doesn't sign or send it
+     * @param content The content string or byte array to append
+     * @param ckbfsCell The CKBFS cell to append to
+     * @param options Additional options for the append operation
+     * @returns Promise resolving to the unsigned transaction
+     */
+    createAppendContentTransaction(content: string | Uint8Array, ckbfsCell: AppendOptions["ckbfsCell"], options?: AppendContentOptions): Promise<Transaction>;
 }
-export { calculateChecksum, verifyChecksum, updateChecksum, verifyWitnessChecksum, createCKBFSCell, createPublishTransaction, createAppendTransaction, publishCKBFS, appendCKBFS, readFile, readFileAsText, readFileAsUint8Array, writeFile, getContentType, splitFileIntoChunks, combineChunksToFile, getFileContentFromChain, saveFileFromChain, createCKBFSWitness, createTextCKBFSWitness, extractCKBFSWitnessContent, isCKBFSWitness, createChunkedCKBFSWitnesses, CKBFSData, BackLinkV1, BackLinkV2, CKBFSDataType, BackLinkType, CKBFSCellOptions, PublishOptions, AppendOptions, CKBFS_HEADER, CKBFS_HEADER_STRING, NetworkType, ProtocolVersion, 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, 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, };

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCKBFSScriptConfig = exports.DEPLOY_TX_HASH = exports.DEP_GROUP_TX_HASH = 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.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.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;
 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; } });
@@ -23,6 +24,19 @@ Object.defineProperty(exports, "splitFileIntoChunks", { enumerable: true, get: f
 Object.defineProperty(exports, "combineChunksToFile", { enumerable: true, get: function () { return file_1.combineChunksToFile; } });
 Object.defineProperty(exports, "getFileContentFromChain", { enumerable: true, get: function () { return file_1.getFileContentFromChain; } });
 Object.defineProperty(exports, "saveFileFromChain", { enumerable: true, get: function () { return file_1.saveFileFromChain; } });
+Object.defineProperty(exports, "getFileContentFromChainByTypeId", { enumerable: true, get: function () { return file_1.getFileContentFromChainByTypeId; } });
+Object.defineProperty(exports, "saveFileFromChainByTypeId", { enumerable: true, get: function () { return file_1.saveFileFromChainByTypeId; } });
+Object.defineProperty(exports, "decodeFileFromChainByTypeId", { enumerable: true, get: function () { return file_1.decodeFileFromChainByTypeId; } });
+Object.defineProperty(exports, "getFileContentFromChainByIdentifier", { enumerable: true, get: function () { return file_1.getFileContentFromChainByIdentifier; } });
+Object.defineProperty(exports, "saveFileFromChainByIdentifier", { enumerable: true, get: function () { return file_1.saveFileFromChainByIdentifier; } });
+Object.defineProperty(exports, "decodeFileFromChainByIdentifier", { enumerable: true, get: function () { return file_1.decodeFileFromChainByIdentifier; } });
+Object.defineProperty(exports, "parseIdentifier", { enumerable: true, get: function () { return file_1.parseIdentifier; } });
+Object.defineProperty(exports, "IdentifierType", { enumerable: true, get: function () { return file_1.IdentifierType; } });
+Object.defineProperty(exports, "decodeWitnessContent", { enumerable: true, get: function () { return file_1.decodeWitnessContent; } });
+Object.defineProperty(exports, "decodeMultipleWitnessContents", { enumerable: true, get: function () { return file_1.decodeMultipleWitnessContents; } });
+Object.defineProperty(exports, "extractFileFromWitnesses", { enumerable: true, get: function () { return file_1.extractFileFromWitnesses; } });
+Object.defineProperty(exports, "decodeFileFromWitnessData", { enumerable: true, get: function () { return file_1.decodeFileFromWitnessData; } });
+Object.defineProperty(exports, "saveFileFromWitnessData", { enumerable: true, get: function () { return file_1.saveFileFromWitnessData; } });
 const witness_1 = require("./utils/witness");
 Object.defineProperty(exports, "createCKBFSWitness", { enumerable: true, get: function () { return witness_1.createCKBFSWitness; } });
 Object.defineProperty(exports, "createTextCKBFSWitness", { enumerable: true, get: function () { return witness_1.createTextCKBFSWitness; } });
@@ -47,6 +61,9 @@ Object.defineProperty(exports, "ADLER32_TYPE_ID", { enumerable: true, get: funct
 Object.defineProperty(exports, "DEP_GROUP_TX_HASH", { enumerable: true, get: function () { return constants_1.DEP_GROUP_TX_HASH; } });
 Object.defineProperty(exports, "DEPLOY_TX_HASH", { enumerable: true, get: function () { return constants_1.DEPLOY_TX_HASH; } });
 Object.defineProperty(exports, "getCKBFSScriptConfig", { enumerable: true, get: function () { return constants_1.getCKBFSScriptConfig; } });
+const transaction_2 = require("./utils/transaction");
+// Helper to encode string to Uint8Array
+const textEncoder = new TextEncoder();
 /**
  * Main CKBFS SDK class
  */
@@ -59,11 +76,14 @@ class CKBFS {
      */
     constructor(signerOrPrivateKey, networkOrOptions = constants_1.DEFAULT_NETWORK, options) {
         // Determine if first parameter is a Signer or privateKey
-        if (typeof signerOrPrivateKey === 'string') {
+        if (typeof signerOrPrivateKey === "string") {
             // Initialize with private key
             const privateKey = signerOrPrivateKey;
-            const network = typeof networkOrOptions === 'string' ? networkOrOptions : constants_1.DEFAULT_NETWORK;
-            const opts = options || (typeof networkOrOptions === 'object' ? networkOrOptions : {});
+            const network = typeof networkOrOptions === "string"
+                ? networkOrOptions
+                : constants_1.DEFAULT_NETWORK;
+            const opts = options ||
+                (typeof networkOrOptions === "object" ? networkOrOptions : {});
             const client = new core_1.ClientPublicTestnet();
             this.signer = new core_1.SignerCkbPrivateKey(client, privateKey);
             this.network = network;
@@ -74,7 +94,7 @@ class CKBFS {
         else {
             // Initialize with signer
             this.signer = signerOrPrivateKey;
-            const opts = typeof networkOrOptions === 'object' ? networkOrOptions : {};
+            const opts = typeof networkOrOptions === "object" ? networkOrOptions : {};
             this.network = opts.network || constants_1.DEFAULT_NETWORK;
             this.chunkSize = opts.chunkSize || 30 * 1024;
             this.version = opts.version || constants_1.DEFAULT_VERSION;
@@ -123,7 +143,7 @@ class CKBFS {
         // Use the filename from the path if not provided
         const pathParts = filePath.split(/[\\\/]/);
         const filename = options.filename || pathParts[pathParts.length - 1];
-        // Create and sign the transaction
+        // Create and sign the transaction using the utility function
         const tx = await (0, transaction_1.publishCKBFS)(this.signer, {
             contentChunks,
             contentType,
@@ -133,15 +153,45 @@ class CKBFS {
             feeRate: options.feeRate,
             network: options.network || this.network,
             version: options.version || this.version,
-            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID
+            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID,
         });
-        console.log('tx', tx.stringify());
+        console.log("Publish file tx:", tx.stringify());
         // Send the transaction
         const txHash = await this.signer.sendTransaction(tx);
-        return txHash;
+        return (0, transaction_2.ensureHexPrefix)(txHash);
     }
     /**
-     * Appends content to an existing CKBFS file
+     * Publishes content (string or Uint8Array) directly to CKBFS
+     * @param content The content string or byte array to publish
+     * @param options Options for publishing the content (contentType and filename are required)
+     * @returns Promise resolving to the transaction hash
+     */
+    async publishContent(content, options) {
+        const contentBytes = typeof content === "string" ? textEncoder.encode(content) : content;
+        const contentChunks = [];
+        for (let i = 0; i < contentBytes.length; i += this.chunkSize) {
+            contentChunks.push(contentBytes.slice(i, i + this.chunkSize));
+        }
+        const lock = await this.getLock();
+        // Use provided contentType and filename (required)
+        const { contentType, filename } = options;
+        const tx = await (0, transaction_1.publishCKBFS)(this.signer, {
+            contentChunks,
+            contentType,
+            filename,
+            lock,
+            capacity: options.capacity,
+            feeRate: options.feeRate,
+            network: options.network || this.network,
+            version: options.version || this.version,
+            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID,
+        });
+        console.log("Publish content tx:", tx.stringify());
+        const txHash = await this.signer.sendTransaction(tx);
+        return (0, transaction_2.ensureHexPrefix)(txHash);
+    }
+    /**
+     * Appends content from a file to an existing CKBFS file
      * @param filePath The path to the file containing the content to append
      * @param ckbfsCell The CKBFS cell to append to
      * @param options Additional options for the append operation
@@ -154,17 +204,43 @@ class CKBFS {
         for (let i = 0; i < fileContent.length; i += this.chunkSize) {
             contentChunks.push(fileContent.slice(i, i + this.chunkSize));
         }
-        // Create and sign the transaction
+        // Create and sign the transaction using the utility function
         const tx = await (0, transaction_1.appendCKBFS)(this.signer, {
             ckbfsCell,
             contentChunks,
             feeRate: options.feeRate,
             network: options.network || this.network,
-            version: options.version || this.version
+            version: options.version || this.version,
         });
+        console.log("Append file tx:", tx.stringify());
         // Send the transaction
         const txHash = await this.signer.sendTransaction(tx);
-        return txHash;
+        return (0, transaction_2.ensureHexPrefix)(txHash);
+    }
+    /**
+     * Appends content (string or Uint8Array) directly to an existing CKBFS file
+     * @param content The content string or byte array to append
+     * @param ckbfsCell The CKBFS cell to append to
+     * @param options Additional options for the append operation
+     * @returns Promise resolving to the transaction hash
+     */
+    async appendContent(content, ckbfsCell, options = {}) {
+        const contentBytes = typeof content === "string" ? textEncoder.encode(content) : content;
+        const contentChunks = [];
+        for (let i = 0; i < contentBytes.length; i += this.chunkSize) {
+            contentChunks.push(contentBytes.slice(i, i + this.chunkSize));
+        }
+        const tx = await (0, transaction_1.appendCKBFS)(this.signer, {
+            ckbfsCell,
+            contentChunks,
+            feeRate: options.feeRate,
+            network: options.network || this.network,
+            version: options.version || this.version,
+            // No useTypeID option for append
+        });
+        console.log("Append content tx:", tx.stringify());
+        const txHash = await this.signer.sendTransaction(tx);
+        return (0, transaction_2.ensureHexPrefix)(txHash);
     }
     /**
      * Creates a new transaction for publishing a file but doesn't sign or send it
@@ -186,7 +262,34 @@ class CKBFS {
         // Use the filename from the path if not provided
         const pathParts = filePath.split(/[\\\/]/);
         const filename = options.filename || pathParts[pathParts.length - 1];
-        // Create the transaction
+        // Create the transaction using the utility function
+        return (0, transaction_1.createPublishTransaction)(this.signer, {
+            contentChunks,
+            contentType,
+            filename,
+            lock,
+            capacity: options.capacity,
+            feeRate: options.feeRate,
+            network: options.network || this.network,
+            version: options.version || this.version,
+            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID,
+        });
+    }
+    /**
+     * Creates a new transaction for publishing content (string or Uint8Array) directly, but doesn't sign or send it
+     * @param content The content string or byte array to publish
+     * @param options Options for publishing the content (contentType and filename are required)
+     * @returns Promise resolving to the unsigned transaction
+     */
+    async createPublishContentTransaction(content, options) {
+        const contentBytes = typeof content === "string" ? textEncoder.encode(content) : content;
+        const contentChunks = [];
+        for (let i = 0; i < contentBytes.length; i += this.chunkSize) {
+            contentChunks.push(contentBytes.slice(i, i + this.chunkSize));
+        }
+        const lock = await this.getLock();
+        // Use provided contentType and filename (required)
+        const { contentType, filename } = options;
         return (0, transaction_1.createPublishTransaction)(this.signer, {
             contentChunks,
             contentType,
@@ -196,11 +299,11 @@ class CKBFS {
             feeRate: options.feeRate,
             network: options.network || this.network,
             version: options.version || this.version,
-            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID
+            useTypeID: options.useTypeID !== undefined ? options.useTypeID : this.useTypeID,
         });
     }
     /**
-     * Creates a new transaction for appending content but doesn't sign or send it
+     * Creates a new transaction for appending content from a file but doesn't sign or send it
      * @param filePath The path to the file containing the content to append
      * @param ckbfsCell The CKBFS cell to append to
      * @param options Additional options for the append operation
@@ -213,13 +316,35 @@ class CKBFS {
         for (let i = 0; i < fileContent.length; i += this.chunkSize) {
             contentChunks.push(fileContent.slice(i, i + this.chunkSize));
         }
-        // Create the transaction
+        // Create the transaction using the utility function
         return (0, transaction_1.createAppendTransaction)(this.signer, {
             ckbfsCell,
             contentChunks,
             feeRate: options.feeRate,
             network: options.network || this.network,
-            version: options.version || this.version
+            version: options.version || this.version,
+        });
+    }
+    /**
+     * Creates a new transaction for appending content (string or Uint8Array) directly, but doesn't sign or send it
+     * @param content The content string or byte array to append
+     * @param ckbfsCell The CKBFS cell to append to
+     * @param options Additional options for the append operation
+     * @returns Promise resolving to the unsigned transaction
+     */
+    async createAppendContentTransaction(content, ckbfsCell, options = {}) {
+        const contentBytes = typeof content === "string" ? textEncoder.encode(content) : content;
+        const contentChunks = [];
+        for (let i = 0; i < contentBytes.length; i += this.chunkSize) {
+            contentChunks.push(contentBytes.slice(i, i + this.chunkSize));
+        }
+        return (0, transaction_1.createAppendTransaction)(this.signer, {
+            ckbfsCell,
+            contentChunks,
+            feeRate: options.feeRate,
+            network: options.network || this.network,
+            version: options.version || this.version,
+            // No useTypeID option for append
         });
     }
 }

package/dist/utils/constants.d.ts

@@ -9,7 +9,7 @@ export declare const ProtocolVersion: {
     readonly V1: "20240906.ce6724722cf6";
     readonly V2: "20241025.db973a8e8032";
 };
-export type ProtocolVersionType = typeof ProtocolVersion[keyof typeof ProtocolVersion];
+export type ProtocolVersionType = (typeof ProtocolVersion)[keyof typeof ProtocolVersion] | string;
 export declare const CKBFS_CODE_HASH: Record<NetworkType, Record<string, string>>;
 export declare const CKBFS_TYPE_ID: Record<NetworkType, Record<string, string>>;
 export declare const ADLER32_CODE_HASH: Record<NetworkType, Record<string, string>>;
@@ -23,7 +23,7 @@ export declare const DEFAULT_VERSION: "20241025.db973a8e8032";
 export declare const DEFAULT_NETWORK = NetworkType.Testnet;
 export interface CKBFSScriptConfig {
     codeHash: string;
-    hashType: 'data1' | 'type';
+    hashType: "data1" | "type";
     depTxHash: string;
     depIndex?: number;
 }
@@ -34,4 +34,8 @@ export interface CKBFSScriptConfig {
  * @param useTypeID Whether to use type ID instead of code hash (default: false)
  * @returns CKBFS script configuration
  */
-export declare function getCKBFSScriptConfig(network?: NetworkType, version?: string, useTypeID?: boolean): CKBFSScriptConfig;
+export declare function getCKBFSScriptConfig(network?: NetworkType, version?: ProtocolVersionType, useTypeID?: boolean): CKBFSScriptConfig;
+import { Hex, HashType, CellDepInfo, ScriptInfo } from "@ckb-ccc/core";
+export declare class CKBFSScriptInfo extends ScriptInfo {
+    constructor(codeHash: Hex, hashType: HashType, cellDeps: CellDepInfo[]);
+}

package/dist/utils/constants.js

@@ -3,7 +3,7 @@
  * CKBFS protocol deployment constants
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_NETWORK = exports.DEFAULT_VERSION = exports.DEPLOY_TX_HASH = exports.DEP_GROUP_TX_HASH = exports.ADLER32_TYPE_ID = exports.ADLER32_CODE_HASH = exports.CKBFS_TYPE_ID = exports.CKBFS_CODE_HASH = exports.ProtocolVersion = exports.NetworkType = void 0;
+exports.CKBFSScriptInfo = exports.DEFAULT_NETWORK = exports.DEFAULT_VERSION = exports.DEPLOY_TX_HASH = exports.DEP_GROUP_TX_HASH = exports.ADLER32_TYPE_ID = exports.ADLER32_CODE_HASH = exports.CKBFS_TYPE_ID = exports.CKBFS_CODE_HASH = exports.ProtocolVersion = exports.NetworkType = void 0;
 exports.getCKBFSScriptConfig = getCKBFSScriptConfig;
 var NetworkType;
 (function (NetworkType) {
@@ -12,75 +12,75 @@ var NetworkType;
 })(NetworkType || (exports.NetworkType = NetworkType = {}));
 // Use string literals for version values to avoid TypeScript indexing issues
 exports.ProtocolVersion = {
-    V1: '20240906.ce6724722cf6', // Original version, compact and simple, suitable for small files
-    V2: '20241025.db973a8e8032' // New version, more features and can do complex operations
+    V1: "20240906.ce6724722cf6", // Original version, compact and simple, suitable for small files
+    V2: "20241025.db973a8e8032", // New version, more features and can do complex operations
 };
 // CKBFS Type Script Constants
 exports.CKBFS_CODE_HASH = {
     [NetworkType.Mainnet]: {
-        [exports.ProtocolVersion.V2]: '0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a'
+        [exports.ProtocolVersion.V2]: "0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a",
     },
     [NetworkType.Testnet]: {
-        [exports.ProtocolVersion.V1]: '0xe8905ad29a02cf8befa9c258f4f941773839a618d75a64afc22059de9413f712',
-        [exports.ProtocolVersion.V2]: '0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a'
-    }
+        [exports.ProtocolVersion.V1]: "0xe8905ad29a02cf8befa9c258f4f941773839a618d75a64afc22059de9413f712",
+        [exports.ProtocolVersion.V2]: "0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a",
+    },
 };
 exports.CKBFS_TYPE_ID = {
     [NetworkType.Mainnet]: {
-        [exports.ProtocolVersion.V2]: '0xfd2058c9a0c0183354cf637e25d2707ffa9bb6fa2ba9b29f4ebc6be3e54ad7eb'
+        [exports.ProtocolVersion.V2]: "0xfd2058c9a0c0183354cf637e25d2707ffa9bb6fa2ba9b29f4ebc6be3e54ad7eb",
     },
     [NetworkType.Testnet]: {
-        [exports.ProtocolVersion.V1]: '0x88ef4d436af35684a27edda0d44dd8771318330285f90f02d13606e095aea86f',
-        [exports.ProtocolVersion.V2]: '0x7c6dcab8268201f064dc8676b5eafa60ca2569e5c6209dcbab0eb64a9cb3aaa3'
-    }
+        [exports.ProtocolVersion.V1]: "0x88ef4d436af35684a27edda0d44dd8771318330285f90f02d13606e095aea86f",
+        [exports.ProtocolVersion.V2]: "0x7c6dcab8268201f064dc8676b5eafa60ca2569e5c6209dcbab0eb64a9cb3aaa3",
+    },
 };
 // Adler32 Hasher Constants
 exports.ADLER32_CODE_HASH = {
     [NetworkType.Mainnet]: {
-        [exports.ProtocolVersion.V2]: '0x2138683f76944437c0c643664120d620bdb5858dd6c9d1d156805e279c2c536f'
+        [exports.ProtocolVersion.V2]: "0x2138683f76944437c0c643664120d620bdb5858dd6c9d1d156805e279c2c536f",
     },
     [NetworkType.Testnet]: {
-        [exports.ProtocolVersion.V1]: '0x8af42cd329cf1bcffb4c73b48252e99cb32346fdbc1cdaa5ae1d000232d47e84',
-        [exports.ProtocolVersion.V2]: '0x2138683f76944437c0c643664120d620bdb5858dd6c9d1d156805e279c2c536f'
-    }
+        [exports.ProtocolVersion.V1]: "0x8af42cd329cf1bcffb4c73b48252e99cb32346fdbc1cdaa5ae1d000232d47e84",
+        [exports.ProtocolVersion.V2]: "0x2138683f76944437c0c643664120d620bdb5858dd6c9d1d156805e279c2c536f",
+    },
 };
 exports.ADLER32_TYPE_ID = {
     [NetworkType.Mainnet]: {
-        [exports.ProtocolVersion.V2]: '0x641c01d590833a3f5471bd441651d9f2a8a200141949cdfeef2d68d8094c5876'
+        [exports.ProtocolVersion.V2]: "0x641c01d590833a3f5471bd441651d9f2a8a200141949cdfeef2d68d8094c5876",
     },
     [NetworkType.Testnet]: {
-        [exports.ProtocolVersion.V1]: '0xccf29a0d8e860044a3d2f6a6e709f6572f77e4fe245fadd212fc342337048d60',
-        [exports.ProtocolVersion.V2]: '0x5f73f128be76e397f5a3b56c94ca16883a8ee91b498bc0ee80473818318c05ac'
-    }
+        [exports.ProtocolVersion.V1]: "0xccf29a0d8e860044a3d2f6a6e709f6572f77e4fe245fadd212fc342337048d60",
+        [exports.ProtocolVersion.V2]: "0x5f73f128be76e397f5a3b56c94ca16883a8ee91b498bc0ee80473818318c05ac",
+    },
 };
 // Dep Group Transaction Constants
 exports.DEP_GROUP_TX_HASH = {
     [NetworkType.Mainnet]: {
-        [exports.ProtocolVersion.V2]: '0xfab07962ed7178ed88d450774e2a6ecd50bae856bdb9b692980be8c5147d1bfa'
+        [exports.ProtocolVersion.V2]: "0xfab07962ed7178ed88d450774e2a6ecd50bae856bdb9b692980be8c5147d1bfa",
     },
     [NetworkType.Testnet]: {
-        [exports.ProtocolVersion.V1]: '0xc8fd44aba36f0c4b37536b6c7ea3b88df65fa97e02f77cd33b9bf20bf241a09b',
-        [exports.ProtocolVersion.V2]: '0x469af0d961dcaaedd872968a9388b546717a6ccfa47b3165b3f9c981e9d66aaa'
-    }
+        [exports.ProtocolVersion.V1]: "0xc8fd44aba36f0c4b37536b6c7ea3b88df65fa97e02f77cd33b9bf20bf241a09b",
+        [exports.ProtocolVersion.V2]: "0x469af0d961dcaaedd872968a9388b546717a6ccfa47b3165b3f9c981e9d66aaa",
+    },
 };
 // Deploy Transaction Constants
 exports.DEPLOY_TX_HASH = {
     [NetworkType.Mainnet]: {
         [exports.ProtocolVersion.V2]: {
-            ckbfs: '0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc',
-            adler32: '0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc'
-        }
+            ckbfs: "0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc",
+            adler32: "0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc",
+        },
     },
     [NetworkType.Testnet]: {
         [exports.ProtocolVersion.V1]: {
-            ckbfs: '0xde8eb09151fbcdcba398423159ce348cc89a38a736de3fd0960b18b084465382',
-            adler32: '0x042f264d7397a181437b51ff9981cf536f252ab5740b61ce52ce31ada04ed54b'
+            ckbfs: "0xde8eb09151fbcdcba398423159ce348cc89a38a736de3fd0960b18b084465382",
+            adler32: "0x042f264d7397a181437b51ff9981cf536f252ab5740b61ce52ce31ada04ed54b",
         },
         [exports.ProtocolVersion.V2]: {
-            ckbfs: '0x2c8c9ad3134743368b5a79977648f96c5bd0aba187021a72fb624301064d3616',
-            adler32: '0x2c8c9ad3134743368b5a79977648f96c5bd0aba187021a72fb624301064d3616'
-        }
-    }
+            ckbfs: "0x2c8c9ad3134743368b5a79977648f96c5bd0aba187021a72fb624301064d3616",
+            adler32: "0x2c8c9ad3134743368b5a79977648f96c5bd0aba187021a72fb624301064d3616",
+        },
+    },
 };
 // Default values - V2 is now the default
 exports.DEFAULT_VERSION = exports.ProtocolVersion.V2;
@@ -97,8 +97,15 @@ function getCKBFSScriptConfig(network = exports.DEFAULT_NETWORK, version = expor
         codeHash: useTypeID
             ? exports.CKBFS_TYPE_ID[network][version]
             : exports.CKBFS_CODE_HASH[network][version],
-        hashType: useTypeID ? 'type' : 'data1',
+        hashType: useTypeID ? "type" : "data1",
         depTxHash: exports.DEP_GROUP_TX_HASH[network][version],
-        depIndex: 0
+        depIndex: 0,
     };
 }
+const core_1 = require("@ckb-ccc/core");
+class CKBFSScriptInfo extends core_1.ScriptInfo {
+    constructor(codeHash, hashType, cellDeps) {
+        super(codeHash, hashType, cellDeps);
+    }
+}
+exports.CKBFSScriptInfo = CKBFSScriptInfo;