@ckbfs/api 1.3.0 → 1.5.0

package/dist/utils/molecule.d.ts

@@ -1,4 +1,5 @@
 import { molecule, number } from "@ckb-lumos/codec";
+import { ProtocolVersionType } from "./constants";
 /**
  * Molecule definitions for CKBFS data structures.
  */
@@ -70,8 +71,8 @@ export type CKBFSDataType = {
     backLinks: BackLinkType[];
 };
 export declare const CKBFSData: {
-    pack: (data: CKBFSDataType, version?: string) => Uint8Array;
-    unpack: (buf: Uint8Array, version?: string) => CKBFSDataType;
+    pack: (data: CKBFSDataType, version?: ProtocolVersionType) => Uint8Array;
+    unpack: (buf: Uint8Array, version?: ProtocolVersionType) => CKBFSDataType;
 };
 export declare const CKBFS_HEADER: Uint8Array<ArrayBuffer>;
 export declare const CKBFS_HEADER_STRING = "CKBFS";

package/dist/utils/molecule.js

@@ -45,13 +45,13 @@ exports.CKBFSDataV2 = codec_1.molecule.table({
 function getIndexes(data) {
     if (data.indexes)
         return data.indexes;
-    if (typeof data.index === 'number')
+    if (typeof data.index === "number")
         return [data.index];
     return [];
 }
 // Helper function to get single index from data
 function getIndex(data) {
-    if (typeof data.index === 'number')
+    if (typeof data.index === "number")
         return data.index;
     if (data.indexes && data.indexes.length > 0)
         return data.indexes[0];
@@ -59,7 +59,7 @@ function getIndex(data) {
 }
 // Helper function to safely get either index or indexes from BackLinkType for V1
 function getBackLinkIndex(bl) {
-    if (typeof bl.index === 'number') {
+    if (typeof bl.index === "number") {
         return bl.index;
     }
     if (Array.isArray(bl.indexes) && bl.indexes.length > 0) {
@@ -72,7 +72,7 @@ function getBackLinkIndexes(bl) {
     if (Array.isArray(bl.indexes)) {
         return bl.indexes;
     }
-    if (typeof bl.index === 'number') {
+    if (typeof bl.index === "number") {
         return [bl.index];
     }
     return [0];
@@ -85,11 +85,11 @@ exports.CKBFSData = {
             return exports.CKBFSDataV1.pack({
                 index: getIndex(data),
                 checksum: data.checksum,
-                contentType: core_1.ccc.bytesFrom(data.contentType, 'utf8'),
-                filename: core_1.ccc.bytesFrom(data.filename, 'utf8'),
-                backLinks: data.backLinks.map(bl => {
+                contentType: core_1.ccc.bytesFrom(data.contentType, "utf8"),
+                filename: core_1.ccc.bytesFrom(data.filename, "utf8"),
+                backLinks: data.backLinks.map((bl) => {
                     // Ensure txHash is in proper format for molecule encoding
-                    const txHash = typeof bl.txHash === 'string'
+                    const txHash = typeof bl.txHash === "string"
                         ? core_1.ccc.bytesFrom(bl.txHash)
                         : bl.txHash;
                     return {
@@ -105,13 +105,11 @@ exports.CKBFSData = {
             return exports.CKBFSDataV2.pack({
                 indexes: getIndexes(data),
                 checksum: data.checksum,
-                contentType: core_1.ccc.bytesFrom(data.contentType, 'utf8'),
-                filename: core_1.ccc.bytesFrom(data.filename, 'utf8'),
-                backLinks: data.backLinks.map(bl => {
+                contentType: core_1.ccc.bytesFrom(data.contentType, "utf8"),
+                filename: core_1.ccc.bytesFrom(data.filename, "utf8"),
+                backLinks: data.backLinks.map((bl) => {
                     // Ensure txHash is in proper format for molecule encoding
-                    const txHash = typeof bl.txHash === 'string'
-                        ? bl.txHash
-                        : bl.txHash;
+                    const txHash = typeof bl.txHash === "string" ? bl.txHash : bl.txHash;
                     return {
                         indexes: getBackLinkIndexes(bl),
                         checksum: bl.checksum,
@@ -128,9 +126,9 @@ exports.CKBFSData = {
                 return {
                     index: unpacked.index,
                     checksum: unpacked.checksum,
-                    contentType: core_1.ccc.bytesTo(unpacked.contentType, 'utf8'),
-                    filename: core_1.ccc.bytesTo(unpacked.filename, 'utf8'),
-                    backLinks: unpacked.backLinks.map(bl => ({
+                    contentType: core_1.ccc.bytesTo(unpacked.contentType, "utf8"),
+                    filename: core_1.ccc.bytesTo(unpacked.filename, "utf8"),
+                    backLinks: unpacked.backLinks.map((bl) => ({
                         index: bl.index,
                         checksum: bl.checksum,
                         txHash: bl.txHash,
@@ -143,9 +141,9 @@ exports.CKBFSData = {
                 return {
                     indexes: unpacked.indexes,
                     checksum: unpacked.checksum,
-                    contentType: core_1.ccc.bytesTo(unpacked.contentType, 'utf8'),
-                    filename: core_1.ccc.bytesTo(unpacked.filename, 'utf8'),
-                    backLinks: unpacked.backLinks.map(bl => ({
+                    contentType: core_1.ccc.bytesTo(unpacked.contentType, "utf8"),
+                    filename: core_1.ccc.bytesTo(unpacked.filename, "utf8"),
+                    backLinks: unpacked.backLinks.map((bl) => ({
                         indexes: bl.indexes,
                         checksum: bl.checksum,
                         txHash: bl.txHash,
@@ -154,11 +152,11 @@ exports.CKBFSData = {
             }
         }
         catch (error) {
-            console.error('Error unpacking CKBFSData:', error);
-            throw new Error('Failed to unpack CKBFSData: ' + error);
+            console.error("Error unpacking CKBFSData:", error);
+            throw new Error("Failed to unpack CKBFSData: " + error);
         }
-    }
+    },
 };
 // Constants for CKBFS protocol
-exports.CKBFS_HEADER = new Uint8Array([0x43, 0x4B, 0x42, 0x46, 0x53]); // "CKBFS" in ASCII
+exports.CKBFS_HEADER = new Uint8Array([0x43, 0x4b, 0x42, 0x46, 0x53]); // "CKBFS" in ASCII
 exports.CKBFS_HEADER_STRING = "CKBFS";

package/dist/utils/transaction.d.ts

@@ -1,6 +1,6 @@
 import { ccc, Transaction, Script, Signer } from "@ckb-ccc/core";
-import { CKBFSDataType } from './molecule';
-import { NetworkType } from './constants';
+import { CKBFSDataType } from "./molecule";
+import { NetworkType, ProtocolVersionType } from "./constants";
 /**
  * Utility functions for CKB transaction creation and handling
  */
@@ -13,7 +13,7 @@ export interface CKBFSCellOptions {
     capacity?: bigint;
     lock: Script;
     network?: NetworkType;
-    version?: string;
+    version?: ProtocolVersionType;
     useTypeID?: boolean;
 }
 /**
@@ -22,6 +22,7 @@ export interface CKBFSCellOptions {
 export interface PublishOptions extends CKBFSCellOptions {
     contentChunks: Uint8Array[];
     feeRate?: number;
+    from?: Transaction;
 }
 /**
  * Options for appending content to a CKBFS file
@@ -40,7 +41,7 @@ export interface AppendOptions {
     contentChunks: Uint8Array[];
     feeRate?: number;
     network?: NetworkType;
-    version?: string;
+    version?: ProtocolVersionType;
 }
 /**
  * Ensures a string is prefixed with '0x'
@@ -58,6 +59,17 @@ export declare function createCKBFSCell(options: CKBFSCellOptions): {
     type: ccc.Script;
     capacity: bigint;
 };
+/**
+ * Prepares a transaction for publishing a file to CKBFS without fee and change handling
+ * You will need to manually set the typeID if you did not provide inputs, or just check is return value emptyTypeID is true
+ * @param options Options for publishing the file
+ * @returns Promise resolving to the prepared transaction and the output index of CKBFS Cell
+ */
+export declare function preparePublishTransaction(options: PublishOptions): Promise<{
+    tx: Transaction;
+    outputIndex: number;
+    emptyTypeID: boolean;
+}>;
 /**
  * Creates a transaction for publishing a file to CKBFS
  * @param signer The signer to use for the transaction
@@ -72,6 +84,13 @@ export declare function createPublishTransaction(signer: Signer, options: Publis
  * @returns Promise resolving to the created transaction
  */
 export declare function createAppendTransaction(signer: Signer, options: AppendOptions): Promise<Transaction>;
+/**
+ * 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
+ */
+export declare function createAppendTransactionDry(signer: Signer, options: AppendOptions): Promise<Transaction>;
 /**
  * Creates a complete transaction for publishing a file to CKBFS
  * @param signer The signer to use for the transaction