@ckbfs/api 1.5.1 → 2.0.0

package/dist/utils/transactions/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Transaction utilities for all CKBFS protocol versions
+ */
+export * from "./shared";
+export * from "./v1v2";
+export * from "./v3";
+export { createCKBFSCell } from "./v1v2";
+export { createCKBFSV3Cell } from "./v3";

package/dist/utils/transactions/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * Transaction utilities for all CKBFS protocol versions
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCKBFSV3Cell = exports.createCKBFSCell = void 0;
+// Shared utilities and interfaces
+__exportStar(require("./shared"), exports);
+// V1 and V2 transaction utilities
+__exportStar(require("./v1v2"), exports);
+// V3 transaction utilities
+__exportStar(require("./v3"), exports);
+// Re-export for backward compatibility
+var v1v2_1 = require("./v1v2");
+Object.defineProperty(exports, "createCKBFSCell", { enumerable: true, get: function () { return v1v2_1.createCKBFSCell; } });
+var v3_1 = require("./v3");
+Object.defineProperty(exports, "createCKBFSV3Cell", { enumerable: true, get: function () { return v3_1.createCKBFSV3Cell; } });

package/dist/utils/transactions/shared.d.ts

@@ -0,0 +1,57 @@
+import { Script, Transaction } from "@ckb-ccc/core";
+import { CKBFSDataType } from "../molecule";
+import { NetworkType, ProtocolVersionType } from "../constants";
+/**
+ * Shared interfaces and utilities for transaction handling across all versions
+ */
+/**
+ * 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}`;
+/**
+ * Base options for creating a CKBFS cell
+ */
+export interface BaseCKBFSCellOptions {
+    contentType: string;
+    filename: string;
+    capacity?: bigint;
+    lock: Script;
+    network?: NetworkType;
+    version?: ProtocolVersionType;
+    useTypeID?: boolean;
+}
+/**
+ * Base options for publishing a file to CKBFS
+ */
+export interface BasePublishOptions extends BaseCKBFSCellOptions {
+    contentChunks: Uint8Array[];
+    feeRate?: number;
+    from?: Transaction;
+}
+/**
+ * Base options for appending content to a CKBFS file
+ */
+export interface BaseAppendOptions {
+    ckbfsCell: {
+        outPoint: {
+            txHash: string;
+            index: number;
+        };
+        data: CKBFSDataType;
+        type: Script;
+        lock: Script;
+        capacity: bigint;
+    };
+    contentChunks: Uint8Array[];
+    feeRate?: number;
+    network?: NetworkType;
+    version?: ProtocolVersionType;
+    from?: Transaction;
+}
+/**
+ * Common CKBFS cell creation options
+ */
+export interface CKBFSCellOptions extends BaseCKBFSCellOptions {
+}

package/dist/utils/transactions/shared.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureHexPrefix = ensureHexPrefix;
+/**
+ * Shared interfaces and utilities for transaction handling across all versions
+ */
+/**
+ * Ensures a string is prefixed with '0x'
+ * @param value The string to ensure is hex prefixed
+ * @returns A hex prefixed string
+ */
+function ensureHexPrefix(value) {
+    if (value.startsWith("0x")) {
+        return value;
+    }
+    return `0x${value}`;
+}

package/dist/utils/transactions/v1v2.d.ts

@@ -0,0 +1,80 @@
+import { ccc, Transaction, Signer } from "@ckb-ccc/core";
+import { BasePublishOptions, BaseAppendOptions, CKBFSCellOptions } from "./shared";
+/**
+ * V1 and V2 CKBFS transaction utilities
+ */
+/**
+ * Options for publishing a file to CKBFS (V1/V2)
+ */
+export interface PublishOptions extends BasePublishOptions {
+}
+/**
+ * Options for appending content to a CKBFS file (V1/V2)
+ */
+export interface AppendOptions extends BaseAppendOptions {
+}
+/**
+ * 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 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 transaction for appending content to a CKBFS file (dry run without fee completion)
+ * @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 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>;