@ckbfs/api 1.5.1 → 2.0.0

package/dist/utils/molecule.d.ts

@@ -46,6 +46,12 @@ export declare const CKBFSDataV2: molecule.ObjectLayoutCodec<{
         txHash: import("@ckb-lumos/codec/lib/base").FixedBytesCodec<string, import("@ckb-lumos/codec").BytesLike>;
     }>>;
 }>;
+export declare const CKBFSDataV3: molecule.ObjectLayoutCodec<{
+    index: import("@ckb-lumos/codec/lib/base").FixedBytesCodec<number, number.BIish>;
+    checksum: import("@ckb-lumos/codec/lib/base").FixedBytesCodec<number, number.BIish>;
+    contentType: import("@ckb-lumos/codec/lib/base").BytesCodec<string, import("@ckb-lumos/codec").BytesLike>;
+    filename: import("@ckb-lumos/codec/lib/base").BytesCodec<string, import("@ckb-lumos/codec").BytesLike>;
+}>;
 export type BackLinkTypeV1 = {
     index: number;
     checksum: number;
@@ -62,13 +68,19 @@ export type BackLinkType = {
     checksum: number;
     txHash: string;
 };
+export type CKBFSDataTypeV3 = {
+    index: number;
+    checksum: number;
+    contentType: string;
+    filename: string;
+};
 export type CKBFSDataType = {
     index?: number;
     indexes?: number[];
     checksum: number;
     contentType: string;
     filename: string;
-    backLinks: BackLinkType[];
+    backLinks?: BackLinkType[];
 };
 export declare const CKBFSData: {
     pack: (data: CKBFSDataType, version?: ProtocolVersionType) => Uint8Array;

package/dist/utils/molecule.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CKBFS_HEADER_STRING = exports.CKBFS_HEADER = exports.CKBFSData = exports.CKBFSDataV2 = exports.CKBFSDataV1 = exports.BackLinksV2 = exports.BackLinksV1 = exports.BackLinkV2 = exports.BackLinkV1 = exports.Indexes = void 0;
+exports.CKBFS_HEADER_STRING = exports.CKBFS_HEADER = exports.CKBFSData = exports.CKBFSDataV3 = exports.CKBFSDataV2 = exports.CKBFSDataV1 = exports.BackLinksV2 = exports.BackLinksV1 = exports.BackLinkV2 = exports.BackLinkV1 = exports.Indexes = void 0;
 const codec_1 = require("@ckb-lumos/codec");
 const base_1 = require("@ckb-lumos/base");
 const constants_1 = require("./constants");
@@ -41,6 +41,13 @@ exports.CKBFSDataV2 = codec_1.molecule.table({
     filename: base_1.blockchain.Bytes,
     backLinks: exports.BackLinksV2,
 }, ["indexes", "checksum", "contentType", "filename", "backLinks"]);
+// V3: CKBFSData has no backLinks (moved to witnesses)
+exports.CKBFSDataV3 = codec_1.molecule.table({
+    index: codec_1.number.Uint32,
+    checksum: codec_1.number.Uint32,
+    contentType: base_1.blockchain.Bytes,
+    filename: base_1.blockchain.Bytes,
+}, ["index", "checksum", "contentType", "filename"]);
 // Helper function to get indexes array from data
 function getIndexes(data) {
     if (data.indexes)
@@ -80,14 +87,23 @@ function getBackLinkIndexes(bl) {
 // Helper function to get the right CKBFSData based on version
 exports.CKBFSData = {
     pack: (data, version = constants_1.ProtocolVersion.V2) => {
-        if (version === constants_1.ProtocolVersion.V1) {
+        if (version === constants_1.ProtocolVersion.V3) {
+            // V3 formatting - no backLinks, uses single index
+            return exports.CKBFSDataV3.pack({
+                index: getIndex(data),
+                checksum: data.checksum,
+                contentType: core_1.ccc.bytesFrom(data.contentType, "utf8"),
+                filename: core_1.ccc.bytesFrom(data.filename, "utf8"),
+            });
+        }
+        else if (version === constants_1.ProtocolVersion.V1) {
             // V1 formatting - uses single index
             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) => {
+                backLinks: (data.backLinks || []).map((bl) => {
                     // Ensure txHash is in proper format for molecule encoding
                     const txHash = typeof bl.txHash === "string"
                         ? core_1.ccc.bytesFrom(bl.txHash)
@@ -107,7 +123,7 @@ exports.CKBFSData = {
                 checksum: data.checksum,
                 contentType: core_1.ccc.bytesFrom(data.contentType, "utf8"),
                 filename: core_1.ccc.bytesFrom(data.filename, "utf8"),
-                backLinks: data.backLinks.map((bl) => {
+                backLinks: (data.backLinks || []).map((bl) => {
                     // Ensure txHash is in proper format for molecule encoding
                     const txHash = typeof bl.txHash === "string" ? bl.txHash : bl.txHash;
                     return {
@@ -121,7 +137,18 @@ exports.CKBFSData = {
     },
     unpack: (buf, version = constants_1.ProtocolVersion.V2) => {
         try {
-            if (version === constants_1.ProtocolVersion.V1) {
+            if (version === constants_1.ProtocolVersion.V3) {
+                // V3 format - no backLinks
+                const unpacked = exports.CKBFSDataV3.unpack(buf);
+                return {
+                    index: unpacked.index,
+                    checksum: unpacked.checksum,
+                    contentType: core_1.ccc.bytesTo(unpacked.contentType, "utf8"),
+                    filename: core_1.ccc.bytesTo(unpacked.filename, "utf8"),
+                    backLinks: [], // V3 has no backLinks in cell data
+                };
+            }
+            else if (version === constants_1.ProtocolVersion.V1) {
                 const unpacked = exports.CKBFSDataV1.unpack(buf);
                 return {
                     index: unpacked.index,

package/dist/utils/transaction-backup.d.ts

@@ -0,0 +1,117 @@
+import { ccc, Transaction, Script, Signer } from "@ckb-ccc/core";
+import { CKBFSDataType } from "./molecule";
+import { NetworkType, ProtocolVersionType } from "./constants";
+/**
+ * Utility functions for CKB transaction creation and handling
+ */
+/**
+ * Options for creating a CKBFS cell
+ */
+export interface CKBFSCellOptions {
+    contentType: string;
+    filename: string;
+    capacity?: bigint;
+    lock: Script;
+    network?: NetworkType;
+    version?: ProtocolVersionType;
+    useTypeID?: boolean;
+}
+/**
+ * Options for publishing a file to CKBFS
+ */
+export interface PublishOptions extends CKBFSCellOptions {
+    contentChunks: Uint8Array[];
+    feeRate?: number;
+    from?: Transaction;
+}
+/**
+ * Options for appending content to a CKBFS file
+ */
+export interface AppendOptions {
+    ckbfsCell: {
+        outPoint: {
+            txHash: string;
+            index: number;
+        };
+        data: CKBFSDataType;
+        type: Script;
+        lock: Script;
+        capacity: bigint;
+    };
+    contentChunks: Uint8Array[];
+    feeRate?: number;
+    network?: NetworkType;
+    version?: ProtocolVersionType;
+    from?: Transaction;
+}
+/**
+ * Ensures a string is prefixed with '0x'
+ * @param value The string to ensure is hex prefixed
+ * @returns A hex prefixed string
+ */
+export declare function ensureHexPrefix(value: string): `0x${string}`;
+/**
+ * Creates a CKBFS cell
+ * @param options Options for creating the CKBFS cell
+ * @returns The created cell output
+ */
+export declare function createCKBFSCell(options: CKBFSCellOptions): {
+    lock: ccc.Script;
+    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
+ * @param options Options for publishing the file
+ * @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
+ * @param options Options for appending content
+ * @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
+ * @param options Options for publishing the file
+ * @returns Promise resolving to the signed transaction
+ */
+export declare function publishCKBFS(signer: Signer, options: PublishOptions): Promise<Transaction>;
+/**
+ * Creates a complete 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 signed transaction
+ */
+export declare function appendCKBFS(signer: Signer, options: AppendOptions): Promise<Transaction>;