@ckbfs/api 1.5.0 → 2.0.0

package/src/utils/transactions/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Transaction utilities for all CKBFS protocol versions
+ */
+
+// Shared utilities and interfaces
+export * from "./shared";
+
+// V1 and V2 transaction utilities
+export * from "./v1v2";
+
+// V3 transaction utilities
+export * from "./v3";
+
+// Re-export for backward compatibility
+export { createCKBFSCell } from "./v1v2";
+export { createCKBFSV3Cell } from "./v3";

package/src/utils/transactions/shared.ts

@@ -0,0 +1,64 @@
+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 function ensureHexPrefix(value: string): `0x${string}` {
+  if (value.startsWith("0x")) {
+    return value as `0x${string}`;
+  }
+  return `0x${value}` as `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 {}