@kynesyslabs/demosdk 2.7.10 → 2.8.0

package/build/types/blockchain/CustomCharges.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Custom Charges Types
+ *
+ * Defines types for variable-cost operations that require user consent
+ * before execution. Used in the confirm/execute two-step transaction flow
+ * to provide cost transparency.
+ *
+ * @fileoverview Custom charges type definitions for cost estimation
+ */
+/**
+ * Cost breakdown for IPFS operations
+ *
+ * Provides detailed cost calculation components so users can understand
+ * what they're paying for.
+ */
+export interface IPFSCostBreakdown {
+    /** Base cost for the operation in DEM wei */
+    base_cost: string;
+    /** Cost based on file size in DEM wei */
+    size_cost: string;
+    /** Cost based on storage duration in DEM wei (optional for indefinite pins) */
+    duration_cost?: string;
+    /** Any additional costs (network fees, etc.) */
+    additional_costs?: Record<string, string>;
+}
+/**
+ * IPFS custom charges configuration
+ *
+ * Included in transaction content to specify maximum cost user agrees to pay.
+ * Node will validate that actual cost does not exceed max_cost_dem.
+ */
+export interface IPFSCustomCharges {
+    /** Maximum cost user is willing to pay (in DEM wei as string for BigInt safety) */
+    max_cost_dem: string;
+    /** File size in bytes - used for cost calculation validation */
+    file_size_bytes: number;
+    /** IPFS operation type */
+    operation: "IPFS_ADD" | "IPFS_PIN" | "IPFS_UNPIN";
+    /** Optional duration in blocks (for PIN operations) */
+    duration_blocks?: number;
+    /** Optional cost breakdown from ipfsQuote (for reference) */
+    estimated_breakdown?: IPFSCostBreakdown;
+}
+/**
+ * Custom charges container for transaction content
+ *
+ * Extensible structure to support various operation types that require
+ * cost estimation. Each field is optional and specific to operation type.
+ *
+ * @example
+ * // IPFS operation with custom charges
+ * const tx: TransactionContent = {
+ *     type: "ipfs",
+ *     // ... other fields
+ *     custom_charges: {
+ *         ipfs: {
+ *             max_cost_dem: "1000000000000000000",
+ *             file_size_bytes: 1024,
+ *             operation: "IPFS_ADD"
+ *         }
+ *     }
+ * }
+ */
+export interface CustomCharges {
+    /** IPFS operation cost configuration */
+    ipfs?: IPFSCustomCharges;
+}
+/**
+ * Custom charges response in ValidityData
+ *
+ * Returned by confirmTx to show actual costs vs maximum user agreed to pay.
+ * Allows user to review and abort if actual cost is higher than expected.
+ */
+export interface ValidityDataCustomCharges {
+    /** Charge type identifier */
+    type: "ipfs_storage" | "ipfs_bandwidth" | "compute" | string;
+    /** What user signed as maximum (from TX custom_charges) */
+    max_cost_dem: string;
+    /** What node will actually charge (must be <= max_cost_dem) */
+    actual_cost_dem: string;
+    /** Detailed breakdown of actual costs */
+    breakdown: IPFSCostBreakdown;
+}
+/**
+ * Check if custom charges include IPFS configuration
+ */
+export declare function hasIPFSCustomCharges(charges: CustomCharges | undefined): charges is CustomCharges & {
+    ipfs: IPFSCustomCharges;
+};
+/**
+ * Validate that actual cost does not exceed maximum
+ */
+export declare function isValidCharge(maxCostDem: string, actualCostDem: string): boolean;

package/build/types/blockchain/CustomCharges.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Custom Charges Types
+ *
+ * Defines types for variable-cost operations that require user consent
+ * before execution. Used in the confirm/execute two-step transaction flow
+ * to provide cost transparency.
+ *
+ * @fileoverview Custom charges type definitions for cost estimation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasIPFSCustomCharges = hasIPFSCustomCharges;
+exports.isValidCharge = isValidCharge;
+// ============================================================================
+// Type Guards
+// ============================================================================
+/**
+ * Check if custom charges include IPFS configuration
+ */
+function hasIPFSCustomCharges(charges) {
+    return charges?.ipfs !== undefined;
+}
+/**
+ * Validate that actual cost does not exceed maximum
+ */
+function isValidCharge(maxCostDem, actualCostDem) {
+    try {
+        const max = BigInt(maxCostDem);
+        const actual = BigInt(actualCostDem);
+        return actual <= max;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=CustomCharges.js.map

package/build/types/blockchain/CustomCharges.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomCharges.js","sourceRoot":"","sources":["../../../../src/types/blockchain/CustomCharges.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAkHH,oDAIC;AAKD,sCAWC;AA3BD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;GAEG;AACH,SAAgB,oBAAoB,CAChC,OAAkC;IAElC,OAAO,OAAO,EAAE,IAAI,KAAK,SAAS,CAAA;AACtC,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CACzB,UAAkB,EAClB,aAAqB;IAErB,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,CAAA;QACpC,OAAO,MAAM,IAAI,GAAG,CAAA;IACxB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC"}

package/build/types/blockchain/Transaction.d.ts

@@ -17,6 +17,7 @@ import { ContractCallPayload } from "./TransactionSubtypes/ContractCallTransacti
 import { D402PaymentPayload } from "./TransactionSubtypes/D402PaymentTransaction";
 import { EscrowPayload } from "./TransactionSubtypes/EscrowTransaction";
 import { IPFSPayload } from "./TransactionSubtypes/IPFSTransaction";
+import { CustomCharges } from "./CustomCharges";
 export type TransactionContentData = ["web2Request", IWeb2Payload] | ["crosschainOperation", XMScript] | ["native", INativePayload] | ["demoswork", DemoScript] | ["l2psEncryptedTx", L2PSEncryptedPayload] | ["identity", IdentityPayload] | ["instantMessaging", InstantMessagingPayload] | ["nativeBridge", NativeBridgeTxPayload] | ["storage", StoragePayload] | ["storageProgram", StorageProgramPayload] | ["l2ps_hash_update", L2PSHashPayload] | ["contractDeploy", ContractDeployPayload] | ["contractCall", ContractCallPayload] | ["d402_payment", D402PaymentPayload] | ["escrow", EscrowPayload] | ["ipfs", IPFSPayload];
 export interface TransactionContent {
     type: "web2Request" | "crosschainOperation" | "subnet" | "native" | "demoswork" | "genesis" | "NODE_ONLINE" | "identity" | "instantMessaging" | "nativeBridge" | "l2psEncryptedTx" | "storage" | "storageProgram" | "l2ps_hash_update" | "contractDeploy" | "contractCall" | "d402_payment" | "escrow" | "ipfs";
@@ -29,6 +30,7 @@ export interface TransactionContent {
     nonce: number;
     timestamp: number;
     transaction_fee: TxFee;
+    custom_charges?: CustomCharges;
 }
 export interface Transaction {
     content: TransactionContent;

package/build/types/blockchain/Transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../../src/types/blockchain/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAiGA,uCAAuC;AACvC,wDAAqC"}
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../../src/types/blockchain/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAqGA,uCAAuC;AACvC,wDAAqC"}

package/build/types/index.d.ts

@@ -3,6 +3,7 @@ export { Block, BlockContent, NativeTablesHashes, GenesisBlock } from "./blockch
 export { ISignature } from "./blockchain/ISignature";
 export { RawTransaction } from "./blockchain/rawTransaction";
 export { Transaction, TransactionContent, TransactionContentData, } from "./blockchain/Transaction";
+export { type CustomCharges, type IPFSCustomCharges, type IPFSCostBreakdown, type ValidityDataCustomCharges, hasIPFSCustomCharges, isValidCharge, } from "./blockchain/CustomCharges";
 export { L2PSTransaction, Web2Transaction, CrosschainTransaction, NativeTransaction, DemosworkTransaction, IdentityTransaction, InstantMessagingTransaction, NativeBridgeTransaction, SpecificTransaction, IPFSTransaction, type IPFSTransactionContent, type IPFSPayload, type IPFSAddPayload, type IPFSPinPayload, type IPFSUnpinPayload, type IPFSOperationType, isIPFSAddPayload, isIPFSPinPayload, isIPFSUnpinPayload, isIPFSPayload, } from "./blockchain/TransactionSubtypes";
 export { INativePayload } from "./native/INativePayload";
 export { InstantMessagingPayload } from "./instantMessaging";

package/build/types/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTransactionDataType = exports.isTransactionType = exports.SupportedTokens = exports.SupportedChains = exports.ChainProviders = exports.RPCResponseSkeleton = exports.stepKeysEnum = exports.XmStepResult = exports.DataTypes = exports.EnumWeb2Actions = exports.CValidityData = exports.isIPFSPayload = exports.isIPFSUnpinPayload = exports.isIPFSPinPayload = exports.isIPFSAddPayload = void 0;
+exports.isTransactionDataType = exports.isTransactionType = exports.SupportedTokens = exports.SupportedChains = exports.ChainProviders = exports.RPCResponseSkeleton = exports.stepKeysEnum = exports.XmStepResult = exports.DataTypes = exports.EnumWeb2Actions = exports.CValidityData = exports.isIPFSPayload = exports.isIPFSUnpinPayload = exports.isIPFSPinPayload = exports.isIPFSAddPayload = exports.isValidCharge = exports.hasIPFSCustomCharges = void 0;
+// REVIEW: Phase 9 - Custom charges for variable-cost operations
+var CustomCharges_1 = require("./blockchain/CustomCharges");
+Object.defineProperty(exports, "hasIPFSCustomCharges", { enumerable: true, get: function () { return CustomCharges_1.hasIPFSCustomCharges; } });
+Object.defineProperty(exports, "isValidCharge", { enumerable: true, get: function () { return CustomCharges_1.isValidCharge; } });
 // Export all specific transaction types
 var TransactionSubtypes_1 = require("./blockchain/TransactionSubtypes");
 Object.defineProperty(exports, "isIPFSAddPayload", { enumerable: true, get: function () { return TransactionSubtypes_1.isIPFSAddPayload; } });

package/build/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;AAmBA,wCAAwC;AACxC,wEAsByC;AAJrC,uHAAA,gBAAgB,OAAA;AAChB,uHAAA,gBAAgB,OAAA;AAChB,yHAAA,kBAAkB,OAAA;AAClB,oHAAA,aAAa,OAAA;AAUjB,0DAAuE;AAA9D,6GAAA,aAAa,OAAA;AA6CtB,OAAO;AACP,+BAce;AADX,uGAAA,eAAe,OAAA;AAgBnB,mDAA4D;AAAnD,sGAAA,SAAS,OAAA;AAOlB,2CAQ0B;AAHtB,qGAAA,YAAY,OAAA;AAEZ,qGAAA,YAAY,OAAA;AAGhB,2CAU4B;AADxB,0GAAA,aAAa,OAAuB;AAgBxC,gDAI2B;AAHvB,2GAAA,cAAc,OAAA;AACd,4GAAA,eAAe,OAAA;AACf,4GAAA,eAAe,OAAA;AAanB,+BAA+B;AAC/B,gEAG+C;AAF3C,0GAAA,iBAAiB,OAAA;AACjB,8GAAA,qBAAqB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;AAmBA,gEAAgE;AAChE,4DAOmC;AAF/B,qHAAA,oBAAoB,OAAA;AACpB,8GAAA,aAAa,OAAA;AAGjB,wCAAwC;AACxC,wEAsByC;AAJrC,uHAAA,gBAAgB,OAAA;AAChB,uHAAA,gBAAgB,OAAA;AAChB,yHAAA,kBAAkB,OAAA;AAClB,oHAAA,aAAa,OAAA;AAUjB,0DAAuE;AAA9D,6GAAA,aAAa,OAAA;AA6CtB,OAAO;AACP,+BAce;AADX,uGAAA,eAAe,OAAA;AAgBnB,mDAA4D;AAAnD,sGAAA,SAAS,OAAA;AAOlB,2CAQ0B;AAHtB,qGAAA,YAAY,OAAA;AAEZ,qGAAA,YAAY,OAAA;AAGhB,2CAU4B;AADxB,0GAAA,aAAa,OAAuB;AAgBxC,gDAI2B;AAHvB,2GAAA,cAAc,OAAA;AACd,4GAAA,eAAe,OAAA;AACf,4GAAA,eAAe,OAAA;AAanB,+BAA+B;AAC/B,gEAG+C;AAF3C,0GAAA,iBAAiB,OAAA;AACjB,8GAAA,qBAAqB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kynesyslabs/demosdk",
-    "version": "2.7.10",
+    "version": "2.8.0",
     "description": "Demosdk is a JavaScript/TypeScript SDK that provides a unified interface for interacting with Demos network",
     "main": "build/index.js",
     "types": "build/index.d.ts",