@kynesyslabs/demosdk 2.12.2 → 4.0.0

package/build/denomination/roundTripHash.test.js

@@ -0,0 +1,231 @@
+import { describe, test, expect } from "@jest/globals";
+import { serializeTransactionContent } from "./serializerGate.js";
+import { demToOs, parseOsString, toOsString } from "./conversion.js";
+// REVIEW: P4 commit 4 — load-bearing round-trip hash equality. The
+// test inlines the node's `serializeTransactionContent` algorithm
+// (verbatim port of `node/src/forks/serializerGate.ts`) so the SDK's
+// implementation is asserted against the canonical node bytes
+// without a cross-repo runtime dependency.
+//
+// If this test breaks, the SDK has produced bytes the node will
+// reject with an InvalidSignature — STOP and triage before shipping.
+/**
+ * Verbatim port of the node's `toOsBigint` from
+ * `node/src/forks/serializerGate.ts:41`. Kept inline so this test
+ * fails the day the node's coercion semantics drift, instead of
+ * silently passing against a stale fixture.
+ */
+function nodeToOsBigint(value) {
+    if (typeof value === "bigint") {
+        return value;
+    }
+    if (typeof value === "string") {
+        return parseOsString(value);
+    }
+    return demToOs(value);
+}
+/**
+ * Verbatim port of the node's `transformToOsTransactionContent` from
+ * `node/src/forks/serializerGate.ts:73`. Note the deliberate scope:
+ * the node only transforms top-level `amount` and `transaction_fee.*`.
+ * It does **not** walk `gcr_edits[]`. The SDK's serializer is the
+ * source of truth for that array — fixtures here therefore arrive
+ * with gcr_edits already in OS-string shape.
+ */
+function nodeTransformToOsTransactionContent(content) {
+    const transformed = { ...content };
+    if (typeof content.amount !== "undefined" && content.amount !== null) {
+        const osAmount = nodeToOsBigint(content.amount);
+        transformed.amount = toOsString(osAmount);
+    }
+    if (content.transaction_fee) {
+        const fee = content.transaction_fee;
+        transformed.transaction_fee = {
+            network_fee: toOsString(nodeToOsBigint(fee.network_fee)),
+            rpc_fee: toOsString(nodeToOsBigint(fee.rpc_fee)),
+            additional_fee: toOsString(nodeToOsBigint(fee.additional_fee)),
+            rpc_address: fee.rpc_address ?? null,
+        };
+    }
+    return transformed;
+}
+/**
+ * Verbatim port of the node's `serializeTransactionContent` from
+ * `node/src/forks/serializerGate.ts:124`. The block-height /
+ * `isForkActive` check is collapsed into a boolean parameter for the
+ * test — the SDK doesn't see blocks, the node does, but at the
+ * post-fork branch both produce the same bytes.
+ */
+function nodeSerializeTransactionContent(content, isPostFork) {
+    if (isPostFork) {
+        return JSON.stringify(nodeTransformToOsTransactionContent(content));
+    }
+    return JSON.stringify(content);
+}
+/**
+ * Build a transaction-content fixture in canonical key order with
+ * gcr_edits already populated as the SDK would emit them post-fork
+ * (`amount` is OS string for `balance` and `escrow.data.amount`; the
+ * `nonce` edit's `amount` stays a counter number). This matches what
+ * `GCRGeneration.generate` produces against a post-fork node.
+ */
+function buildPostForkShapedFixture() {
+    const gcr_edits = [
+        {
+            type: "balance",
+            isRollback: false,
+            operation: "remove",
+            account: "0xsender",
+            amount: "100000000001", // sub-DEM-precision OS string
+            txhash: "",
+        },
+        {
+            type: "nonce",
+            isRollback: false,
+            operation: "add",
+            account: "0xsender",
+            amount: 1,
+            txhash: "",
+        },
+        {
+            type: "balance",
+            isRollback: false,
+            operation: "add",
+            account: "0xreceiver",
+            amount: "100000000001",
+            txhash: "",
+        },
+        {
+            type: "escrow",
+            operation: "deposit",
+            account: "0xescrow",
+            data: {
+                sender: "0xsender",
+                platform: "twitter",
+                username: "@bob",
+                amount: "100000000001",
+                expiryDays: 30,
+            },
+            txhash: "",
+            isRollback: false,
+        },
+    ];
+    return {
+        type: "native",
+        from: "0xsender",
+        to: "0xreceiver",
+        amount: "100000000001", // sub-DEM-precision OS string
+        data: [
+            "native",
+            {
+                nativeOperation: "send",
+                args: ["0xreceiver", "100000000001"],
+            },
+        ],
+        nonce: 1,
+        timestamp: 1700000000000,
+        transaction_fee: {
+            network_fee: "1000000000",
+            rpc_fee: "0",
+            additional_fee: "0",
+            rpc_address: null,
+        },
+        from_ed25519_address: "0xsender",
+        gcr_edits,
+    };
+}
+describe("round-trip hash equality — SDK post-fork == node post-fork", () => {
+    test("OS-string fixture: SDK and node produce identical bytes", () => {
+        const content = buildPostForkShapedFixture();
+        const sdkBytes = serializeTransactionContent(content, true);
+        const nodeBytes = nodeSerializeTransactionContent(content, true);
+        expect(sdkBytes).toBe(nodeBytes);
+    });
+    test("legacy DEM-number fixture: post-fork SDK matches node post-fork output", () => {
+        // Build a fixture where the user has populated content with
+        // legacy DEM numbers (the v2 callers' pattern). Both SDK and
+        // node will normalise the top-level `amount` and
+        // `transaction_fee.*` to OS strings; the SDK additionally
+        // walks gcr_edits — but the node serializer leaves gcr_edits
+        // alone, so to get byte equality the fixture must already
+        // carry the post-fork-shaped edits. (This is exactly the SDK
+        // contract: gcr_edits are the SDK's responsibility.)
+        const content = buildPostForkShapedFixture();
+        // Override the wire-sensitive fields with legacy DEM numbers.
+        content.amount = 100;
+        content.transaction_fee = {
+            network_fee: 1,
+            rpc_fee: 0,
+            additional_fee: 0,
+            rpc_address: null,
+        };
+        const sdkBytes = serializeTransactionContent(content, true);
+        const nodeBytes = nodeSerializeTransactionContent(content, true);
+        expect(sdkBytes).toBe(nodeBytes);
+    });
+    test("bigint amount: SDK normalises before stringify; node sees the SDK output", () => {
+        // The node never sees a raw bigint on the wire (JSON has no
+        // bigint). But the SDK's internal carrier is bigint, and the
+        // serializer must coerce to OS string before JSON.stringify.
+        // Verify both produce the same canonical output for an
+        // OS-string fixture that started from a bigint input.
+        const sourceBigintOs = 100000000001n;
+        const content = buildPostForkShapedFixture();
+        content.amount = toOsString(sourceBigintOs);
+        const sdkBytes = serializeTransactionContent(content, true);
+        const nodeBytes = nodeSerializeTransactionContent(content, true);
+        expect(sdkBytes).toBe(nodeBytes);
+        const parsed = JSON.parse(sdkBytes);
+        expect(parsed.amount).toBe("100000000001");
+    });
+    test("non-canonical OS-string normalises identically on both sides", () => {
+        const content = buildPostForkShapedFixture();
+        content.amount = "00100";
+        const sdkBytes = serializeTransactionContent(content, true);
+        const nodeBytes = nodeSerializeTransactionContent(content, true);
+        expect(sdkBytes).toBe(nodeBytes);
+        const parsed = JSON.parse(sdkBytes);
+        expect(parsed.amount).toBe("100");
+    });
+    test("pre-fork branch: SDK and node both stringify content as-is", () => {
+        // For pre-fork content with no internal bigints / OS strings,
+        // both branches produce `JSON.stringify(content)` verbatim.
+        const content = {
+            type: "native",
+            from: "0xsender",
+            to: "0xreceiver",
+            amount: 100,
+            data: [
+                "native",
+                {
+                    nativeOperation: "send",
+                    args: ["0xreceiver", 100],
+                },
+            ],
+            nonce: 1,
+            timestamp: 1700000000000,
+            transaction_fee: {
+                network_fee: 1,
+                rpc_fee: 0,
+                additional_fee: 0,
+                rpc_address: null,
+            },
+            from_ed25519_address: "0xsender",
+            gcr_edits: [
+                {
+                    type: "balance",
+                    isRollback: false,
+                    operation: "remove",
+                    account: "0xsender",
+                    amount: 100,
+                    txhash: "",
+                },
+            ],
+        };
+        const sdkBytes = serializeTransactionContent(content, false);
+        const nodeBytes = nodeSerializeTransactionContent(content, false);
+        expect(sdkBytes).toBe(nodeBytes);
+        expect(sdkBytes).toBe(JSON.stringify(content));
+    });
+});
+//# sourceMappingURL=roundTripHash.test.js.map

package/build/denomination/roundTripHash.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roundTripHash.test.js","sourceRoot":"","sources":["../../../src/denomination/roundTripHash.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtD,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAIjE,mEAAmE;AACnE,kEAAkE;AAClE,qEAAqE;AACrE,8DAA8D;AAC9D,2CAA2C;AAC3C,EAAE;AACF,gEAAgE;AAChE,qEAAqE;AAErE;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAA+B;IACnD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,aAAa,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mCAAmC,CACxC,OAA2B;IAE3B,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,EAAwB,CAAA;IAExD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACnE,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,MAAkC,CAAC,CAAA;QAC3E,WAAW,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAsB,CAAA;IAClE,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAA;QACnC,WAAW,CAAC,eAAe,GAAG;YAC1B,WAAW,EAAE,UAAU,CACnB,cAAc,CAAC,GAAG,CAAC,WAAuC,CAAC,CACzC;YACtB,OAAO,EAAE,UAAU,CACf,cAAc,CAAC,GAAG,CAAC,OAAmC,CAAC,CACrC;YACtB,cAAc,EAAE,UAAU,CACtB,cAAc,CAAC,GAAG,CAAC,cAA0C,CAAC,CAC5C;YACtB,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI;SACvC,CAAA;IACL,CAAC;IAED,OAAO,WAAW,CAAA;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,+BAA+B,CACpC,OAA2B,EAC3B,UAAmB;IAEnB,IAAI,UAAU,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,mCAAmC,CAAC,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,0BAA0B;IAC/B,MAAM,SAAS,GAAc;QACzB;YACI,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,cAAc,EAAE,8BAA8B;YACtD,MAAM,EAAE,EAAE;SACb;QACD;YACI,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,EAAE;SACb;QACD;YACI,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,YAAY;YACrB,MAAM,EAAE,cAAc;YACtB,MAAM,EAAE,EAAE;SACb;QACD;YACI,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE;gBACF,MAAM,EAAE,UAAU;gBAClB,QAAQ,EAAE,SAAS;gBACnB,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE,cAAc;gBACtB,UAAU,EAAE,EAAE;aACjB;YACD,MAAM,EAAE,EAAE;YACV,UAAU,EAAE,KAAK;SACpB;KACJ,CAAA;IAED,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,UAAU;QAChB,EAAE,EAAE,YAAY;QAChB,MAAM,EAAE,cAAc,EAAE,8BAA8B;QACtD,IAAI,EAAE;YACF,QAAQ;YACR;gBACI,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC;aACvC;SAC0B;QAC/B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,aAAiB;QAC5B,eAAe,EAAE;YACb,WAAW,EAAE,YAAY;YACzB,OAAO,EAAE,GAAG;YACZ,cAAc,EAAE,GAAG;YACnB,WAAW,EAAE,IAAI;SACpB;QACD,oBAAoB,EAAE,UAAU;QAChC,SAAS;KACZ,CAAA;AACL,CAAC;AAED,QAAQ,CAAC,4DAA4D,EAAE,GAAG,EAAE;IACxE,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,QAAQ,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAC3D,MAAM,SAAS,GAAG,+BAA+B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChE,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,4DAA4D;QAC5D,6DAA6D;QAC7D,iDAAiD;QACjD,0DAA0D;QAC1D,6DAA6D;QAC7D,0DAA0D;QAC1D,6DAA6D;QAC7D,qDAAqD;QACrD,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,8DAA8D;QAC9D,OAAO,CAAC,MAAM,GAAG,GAAwB,CAAA;QACzC,OAAO,CAAC,eAAe,GAAG;YACtB,WAAW,EAAE,CAAC;YACd,OAAO,EAAE,CAAC;YACV,cAAc,EAAE,CAAC;YACjB,WAAW,EAAE,IAAI;SACpB,CAAA;QACD,MAAM,QAAQ,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAC3D,MAAM,SAAS,GAAG,+BAA+B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChE,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAClF,4DAA4D;QAC5D,6DAA6D;QAC7D,6DAA6D;QAC7D,uDAAuD;QACvD,sDAAsD;QACtD,MAAM,cAAc,GAAG,aAAgB,CAAA;QACvC,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAsB,CAAA;QAEhE,MAAM,QAAQ,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAC3D,MAAM,SAAS,GAAG,+BAA+B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChE,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAEhC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,OAAO,CAAC,MAAM,GAAG,OAA4B,CAAA;QAC7C,MAAM,QAAQ,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAC3D,MAAM,SAAS,GAAG,+BAA+B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChE,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,8DAA8D;QAC9D,4DAA4D;QAC5D,MAAM,OAAO,GAAuB;YAChC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,UAAU;YAChB,EAAE,EAAE,YAAY;YAChB,MAAM,EAAE,GAAG;YACX,IAAI,EAAE;gBACF,QAAQ;gBACR;oBACI,eAAe,EAAE,MAAM;oBACvB,IAAI,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC;iBAC5B;aAC0B;YAC/B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,aAAiB;YAC5B,eAAe,EAAE;gBACb,WAAW,EAAE,CAAC;gBACd,OAAO,EAAE,CAAC;gBACV,cAAc,EAAE,CAAC;gBACjB,WAAW,EAAE,IAAI;aACpB;YACD,oBAAoB,EAAE,UAAU;YAChC,SAAS,EAAE;gBACP;oBACI,IAAI,EAAE,SAAS;oBACf,UAAU,EAAE,KAAK;oBACjB,SAAS,EAAE,QAAQ;oBACnB,OAAO,EAAE,UAAU;oBACnB,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,EAAE;iBACb;aACJ;SACJ,CAAA;QACD,MAAM,QAAQ,GAAG,2BAA2B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC5D,MAAM,SAAS,GAAG,+BAA+B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACjE,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}

package/build/denomination/serializerGate.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Dual-format transaction-content serializer.
+ *
+ * This is the SDK-side mirror of the node's `forks/serializerGate.ts`. It
+ * stringifies a `TransactionContent` for hashing/signing and chooses
+ * between two wire shapes based on the connected node's fork status:
+ *
+ *  - **Pre-fork**: legacy DEM-`number` JSON. Any internal `bigint` OS
+ *    amounts are coerced back to JS `number` in DEM via integer division
+ *    by `OS_PER_DEM`, and the rest of the content is passed through
+ *    `JSON.stringify` verbatim.
+ *  - **Post-fork**: OS-decimal-string JSON. The top-level `amount`,
+ *    every `transaction_fee.*` field, and the per-entry `amount` field
+ *    on every `gcr_edits[]` entry that carries one (`balance` and
+ *    `escrow.data.amount`) are converted to canonical OS strings. All
+ *    other fields are passed through verbatim.
+ *
+ * Property order is consensus-critical: the node hashes the result of
+ * `JSON.stringify`, which serializes keys in insertion order. The
+ * implementation uses object spread (`{ ...content, amount, ... }`) which
+ * preserves the source's insertion order and overwrites the
+ * wire-sensitive fields in place without reordering them.
+ *
+ * The branching is by node fork status (a boolean), not by block height
+ * — the SDK doesn't see blocks. Detection of that boolean lives in
+ * `Demos.getNetworkInfo()` (see P4 commit 3) and is cached per-instance.
+ *
+ * @module denomination/serializerGate
+ */
+import type { TransactionContent } from "../types/blockchain/Transaction";
+/**
+ * Serialize transaction content for hashing/signing.
+ *
+ * This is the load-bearing wire boundary: the bytes returned here are
+ * fed into `sha256` and the resulting hash is what the keypair signs.
+ * The receiving node hashes its in-memory `TransactionContent` through
+ * its own `serializerGate.serializeTransactionContent`; if our bytes
+ * differ from the node's bytes the signature will not validate.
+ *
+ * @param content - The transaction content to serialize.
+ * @param isPostFork - `true` when the connected node has activated the
+ *   `osDenomination` fork. When `false` (pre-fork or unknown), the
+ *   legacy DEM-number wire shape is emitted.
+ * @returns Canonical JSON string for hashing.
+ */
+export declare function serializeTransactionContent(content: TransactionContent, isPostFork: boolean): string;

package/build/denomination/serializerGate.js

@@ -0,0 +1,283 @@
+/**
+ * Dual-format transaction-content serializer.
+ *
+ * This is the SDK-side mirror of the node's `forks/serializerGate.ts`. It
+ * stringifies a `TransactionContent` for hashing/signing and chooses
+ * between two wire shapes based on the connected node's fork status:
+ *
+ *  - **Pre-fork**: legacy DEM-`number` JSON. Any internal `bigint` OS
+ *    amounts are coerced back to JS `number` in DEM via integer division
+ *    by `OS_PER_DEM`, and the rest of the content is passed through
+ *    `JSON.stringify` verbatim.
+ *  - **Post-fork**: OS-decimal-string JSON. The top-level `amount`,
+ *    every `transaction_fee.*` field, and the per-entry `amount` field
+ *    on every `gcr_edits[]` entry that carries one (`balance` and
+ *    `escrow.data.amount`) are converted to canonical OS strings. All
+ *    other fields are passed through verbatim.
+ *
+ * Property order is consensus-critical: the node hashes the result of
+ * `JSON.stringify`, which serializes keys in insertion order. The
+ * implementation uses object spread (`{ ...content, amount, ... }`) which
+ * preserves the source's insertion order and overwrites the
+ * wire-sensitive fields in place without reordering them.
+ *
+ * The branching is by node fork status (a boolean), not by block height
+ * — the SDK doesn't see blocks. Detection of that boolean lives in
+ * `Demos.getNetworkInfo()` (see P4 commit 3) and is cached per-instance.
+ *
+ * @module denomination/serializerGate
+ */
+import { OS_PER_DEM } from "./constants.js";
+import { demToOs, parseOsString, toOsString } from "./conversion.js";
+// REVIEW: P4 commit 2 — load-bearing wire boundary. Mirrors the node's
+// `serializeTransactionContent` (forks/serializerGate.ts) byte for byte
+// for post-fork output; pre-fork output is identical to the legacy
+// `JSON.stringify(content)` path the SDK has used since v1.
+/**
+ * Coerce a wire-format amount/fee value to an OS `bigint`.
+ *
+ * Accepts:
+ * - `bigint`: returned as-is.
+ * - `string`: parsed as a canonical OS decimal integer string (post-fork
+ *   wire shape).
+ * - `number`: treated as DEM (pre-fork wire shape) and converted to OS.
+ *
+ * Throws on un-coercible inputs (non-numeric strings, fractional numbers
+ * smaller than 1 OS, negative results — all surfaced by the underlying
+ * `denomination` helpers).
+ *
+ * @internal
+ */
+function toOsBigint(value) {
+    if (typeof value === "bigint") {
+        return value;
+    }
+    if (typeof value === "string") {
+        return parseOsString(value);
+    }
+    return demToOs(value);
+}
+/**
+ * Coerce an OS-bigint back to a DEM JS `number` for legacy wire shape.
+ *
+ * Used by the pre-fork branch when an internal bigint amount needs to go
+ * onto the wire as the legacy DEM-number. Performs an integer division
+ * by `OS_PER_DEM`; the caller is responsible for ensuring the input has
+ * no sub-DEM precision (the public-API guard in P4 commit 3 enforces
+ * this before we get here).
+ *
+ * @internal
+ */
+function osToDemNumber(os) {
+    return Number(os / OS_PER_DEM);
+}
+/**
+ * Normalise an `amount`/fee field for the **pre-fork** wire shape.
+ *
+ * - `bigint` (internal OS) → `number` (DEM, legacy wire).
+ * - `string` (post-fork OS) → `number` (DEM). This path is entered when
+ *   a v3 caller has already produced post-fork-shaped content but the
+ *   connected node turned out to be pre-fork. The serializer is the
+ *   last chance to coerce.
+ * - `number` (legacy DEM) → returned unchanged.
+ *
+ * @internal
+ */
+function toPreForkWireNumber(value) {
+    if (typeof value === "number")
+        return value;
+    return osToDemNumber(toOsBigint(value));
+}
+/**
+ * Normalise an `amount`/fee field for the **post-fork** wire shape.
+ *
+ * - `bigint` (internal OS) → canonical OS decimal string.
+ * - `number` (legacy DEM) → DEM-to-OS conversion → canonical OS string.
+ * - `string` → re-parsed and re-emitted as a canonical OS string. This
+ *   normalises non-canonical shapes (`"00100"`, `" 100 "`) to `"100"`
+ *   so the hash matches the node's `transformToOsTransactionContent`
+ *   output.
+ *
+ * @internal
+ */
+function toPostForkWireString(value) {
+    return toOsString(toOsBigint(value));
+}
+/**
+ * Walk a single `GCREdit` entry and rewrite its embedded amount fields
+ * for the post-fork wire shape. The two carriers we touch (per SPEC_P4
+ * §2.2) are:
+ *
+ *   - `GCREditBalance.amount`  — top-level numeric balance edit.
+ *   - `GCREditEscrow.data.amount` — nested escrow deposit amount.
+ *
+ * Other variants (`nonce`, `assign`, `identity`, `smartContract`,
+ * `storageProgram`, `tlsnotary`, `validatorStake`,
+ * `networkUpgrade`, `networkUpgradeVote`) are passed through unchanged.
+ * `validatorStake.amount` is already a bigint-as-string by construction
+ * (see GCREdit.ts:258); we still re-parse and re-emit through
+ * `toPostForkWireString` so non-canonical inputs are normalised.
+ *
+ * Object spread preserves key order; the targeted overwrites do not
+ * change the position of any existing key.
+ *
+ * @internal
+ */
+function transformEditPostFork(edit) {
+    if (edit.type === "balance") {
+        return {
+            ...edit,
+            amount: toPostForkWireString(edit.amount),
+        };
+    }
+    if (edit.type === "escrow") {
+        const data = edit.data ?? {};
+        if (typeof data.amount === "undefined" || data.amount === null) {
+            return edit;
+        }
+        return {
+            ...edit,
+            data: {
+                ...data,
+                amount: toPostForkWireString(data.amount),
+            },
+        };
+    }
+    if (edit.type === "validatorStake") {
+        // Already string-typed in the static type, but normalise anyway.
+        return {
+            ...edit,
+            amount: toPostForkWireString(edit.amount),
+        };
+    }
+    return edit;
+}
+/**
+ * Rewrite a single `GCREdit` for the **pre-fork** wire shape.
+ *
+ * Symmetric to {@link transformEditPostFork} but emits legacy DEM
+ * numbers. Used when SDK v3 callers have already populated edits with
+ * OS-strings/bigints (commit 1's widened types) but the connected node
+ * is pre-fork.
+ *
+ * @internal
+ */
+function transformEditPreFork(edit) {
+    if (edit.type === "balance") {
+        return {
+            ...edit,
+            amount: toPreForkWireNumber(edit.amount),
+        };
+    }
+    if (edit.type === "escrow") {
+        const data = edit.data ?? {};
+        if (typeof data.amount === "undefined" || data.amount === null) {
+            return edit;
+        }
+        return {
+            ...edit,
+            data: {
+                ...data,
+                // Pre-fork escrow.data.amount was a JS number historically.
+                amount: toPreForkWireNumber(data.amount),
+            },
+        };
+    }
+    return edit;
+}
+/**
+ * Re-emit a `TransactionContent` with `amount`, `transaction_fee.*`, and
+ * each `gcr_edits[]` entry's amount fields encoded as canonical OS
+ * decimal strings.
+ *
+ * Property order is preserved by spreading the source content first and
+ * then overwriting the wire-sensitive fields in place. This is the
+ * post-fork branch's analogue to the node's
+ * `transformToOsTransactionContent`. The SDK additionally walks
+ * `gcr_edits[]` here because, unlike the node's serializer, the SDK is
+ * the source of truth for those entries — the node's serializer
+ * intentionally does not transform them.
+ *
+ * @internal
+ */
+function transformToPostFork(content) {
+    const transformed = { ...content };
+    if (typeof content.amount !== "undefined" && content.amount !== null) {
+        transformed.amount = toPostForkWireString(content.amount);
+    }
+    if (content.transaction_fee) {
+        const fee = content.transaction_fee;
+        // PR-86 myc#19: spread the source fee object first so source
+        // insertion order is preserved (consensus-critical) and any
+        // extra fields the SDK doesn't know about pass through. Then
+        // overwrite the three known carriers in place — `{...fee, ...}`
+        // does not change the position of pre-existing keys.
+        transformed.transaction_fee = {
+            ...fee,
+            network_fee: toPostForkWireString(fee.network_fee),
+            rpc_fee: toPostForkWireString(fee.rpc_fee),
+            additional_fee: toPostForkWireString(fee.additional_fee),
+        };
+    }
+    if (Array.isArray(content.gcr_edits)) {
+        transformed.gcr_edits = content.gcr_edits.map(transformEditPostFork);
+    }
+    return transformed;
+}
+/**
+ * Re-emit a `TransactionContent` for the **pre-fork** wire shape.
+ *
+ * Coerces any `bigint` (internal) or `string` (post-fork-shaped)
+ * amount/fee fields back to JS `number` in DEM, walks `gcr_edits[]` to
+ * do the same, and otherwise passes the content through verbatim.
+ *
+ * Why this exists: SDK v3's internal arithmetic uses `bigint` OS even
+ * when talking to a pre-fork node. Without this normaliser the legacy
+ * wire would carry stringified bigints and break hash equality on the
+ * receiving side.
+ *
+ * @internal
+ */
+function transformToPreFork(content) {
+    const transformed = { ...content };
+    if (typeof content.amount !== "undefined" && content.amount !== null) {
+        transformed.amount = toPreForkWireNumber(content.amount);
+    }
+    if (content.transaction_fee) {
+        const fee = content.transaction_fee;
+        // PR-86 myc#19: spread to preserve source key order; see the
+        // matching block in `transformToPostFork` for the rationale.
+        transformed.transaction_fee = {
+            ...fee,
+            network_fee: toPreForkWireNumber(fee.network_fee),
+            rpc_fee: toPreForkWireNumber(fee.rpc_fee),
+            additional_fee: toPreForkWireNumber(fee.additional_fee),
+        };
+    }
+    if (Array.isArray(content.gcr_edits)) {
+        transformed.gcr_edits = content.gcr_edits.map(transformEditPreFork);
+    }
+    return transformed;
+}
+/**
+ * Serialize transaction content for hashing/signing.
+ *
+ * This is the load-bearing wire boundary: the bytes returned here are
+ * fed into `sha256` and the resulting hash is what the keypair signs.
+ * The receiving node hashes its in-memory `TransactionContent` through
+ * its own `serializerGate.serializeTransactionContent`; if our bytes
+ * differ from the node's bytes the signature will not validate.
+ *
+ * @param content - The transaction content to serialize.
+ * @param isPostFork - `true` when the connected node has activated the
+ *   `osDenomination` fork. When `false` (pre-fork or unknown), the
+ *   legacy DEM-number wire shape is emitted.
+ * @returns Canonical JSON string for hashing.
+ */
+export function serializeTransactionContent(content, isPostFork) {
+    if (isPostFork) {
+        return JSON.stringify(transformToPostFork(content));
+    }
+    return JSON.stringify(transformToPreFork(content));
+}
+//# sourceMappingURL=serializerGate.js.map

package/build/denomination/serializerGate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializerGate.js","sourceRoot":"","sources":["../../../src/denomination/serializerGate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAQH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEjE,uEAAuE;AACvE,wEAAwE;AACxE,mEAAmE;AACnE,4DAA4D;AAE5D;;;;;;;;;;;;;;GAcG;AACH,SAAS,UAAU,CAAC,KAA+B;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,aAAa,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,aAAa,CAAC,EAAU;IAC7B,OAAO,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,mBAAmB,CAAC,KAA+B;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,OAAO,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,oBAAoB,CAAC,KAA+B;IACzD,OAAO,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAS,qBAAqB,CAAC,IAAa;IACxC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO;YACH,GAAG,IAAI;YACP,MAAM,EAAE,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC;SAC5C,CAAA;IACL,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;QAC5B,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAA;QACf,CAAC;QACD,OAAO;YACH,GAAG,IAAI;YACP,IAAI,EAAE;gBACF,GAAG,IAAI;gBACP,MAAM,EAAE,oBAAoB,CACxB,IAAI,CAAC,MAAkC,CAC1C;aACJ;SACJ,CAAA;IACL,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACjC,iEAAiE;QACjE,OAAO;YACH,GAAG,IAAI;YACP,MAAM,EAAE,oBAAoB,CACxB,IAAI,CAAC,MAA6C,CACrD;SACJ,CAAA;IACL,CAAC;IACD,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CAAC,IAAa;IACvC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO;YACH,GAAG,IAAI;YACP,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3C,CAAA;IACL,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;QAC5B,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAA;QACf,CAAC;QACD,OAAO;YACH,GAAG,IAAI;YACP,IAAI,EAAE;gBACF,GAAG,IAAI;gBACP,4DAA4D;gBAC5D,MAAM,EAAE,mBAAmB,CACvB,IAAI,CAAC,MAAkC,CAC1C;aACJ;SACJ,CAAA;IACL,CAAC;IACD,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,mBAAmB,CAAC,OAA2B;IACpD,MAAM,WAAW,GAAuB,EAAE,GAAG,OAAO,EAAE,CAAA;IAEtD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACnE,WAAW,CAAC,MAAM,GAAG,oBAAoB,CACrC,OAAO,CAAC,MAAkC,CAC7C,CAAA;IACL,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAA;QACnC,6DAA6D;QAC7D,4DAA4D;QAC5D,6DAA6D;QAC7D,gEAAgE;QAChE,qDAAqD;QACrD,WAAW,CAAC,eAAe,GAAG;YAC1B,GAAG,GAAG;YACN,WAAW,EAAE,oBAAoB,CAC7B,GAAG,CAAC,WAAuC,CAC9C;YACD,OAAO,EAAE,oBAAoB,CACzB,GAAG,CAAC,OAAmC,CAC1C;YACD,cAAc,EAAE,oBAAoB,CAChC,GAAG,CAAC,cAA0C,CACjD;SACK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,WAAW,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;IACxE,CAAC;IAED,OAAO,WAAW,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,kBAAkB,CAAC,OAA2B;IACnD,MAAM,WAAW,GAAuB,EAAE,GAAG,OAAO,EAAE,CAAA;IAEtD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,WAAW,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACnE,WAAW,CAAC,MAAM,GAAG,mBAAmB,CACpC,OAAO,CAAC,MAAkC,CAC7C,CAAA;IACL,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAA;QACnC,6DAA6D;QAC7D,6DAA6D;QAC7D,WAAW,CAAC,eAAe,GAAG;YAC1B,GAAG,GAAG;YACN,WAAW,EAAE,mBAAmB,CAC5B,GAAG,CAAC,WAAuC,CAC9C;YACD,OAAO,EAAE,mBAAmB,CACxB,GAAG,CAAC,OAAmC,CAC1C;YACD,cAAc,EAAE,mBAAmB,CAC/B,GAAG,CAAC,cAA0C,CACjD;SACK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,WAAW,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACvE,CAAC;IAED,OAAO,WAAW,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,2BAA2B,CACvC,OAA2B,EAC3B,UAAmB;IAEnB,IAAI,UAAU,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAA;IACvD,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC"}

package/build/denomination/serializerGate.test.d.ts

@@ -0,0 +1 @@
+export {};