quantumcoin 7.0.8 → 7.0.9

package/README-SDK.md

@@ -399,6 +399,7 @@ User-facing wallet class.
 - `getTransactionCount(blockTag?: string): Promise<number>`
 - `encryptSync(password: string | Uint8Array): string`
 - `connect(provider: AbstractProvider): Wallet`
+- `getSigningContext(fullSign?: boolean | null): number` — returns the recommended signing context for this wallet (based on public key type). Setting `fullSign` to `true` may incur additional gas cost.
 
 **Example(s):**
 - `examples/wallet-offline.js`

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "quantumcoin",
-      "version": "7.0.8",
+      "version": "7.0.9",
       "license": "MIT",
       "dependencies": {
         "quantum-coin-js-sdk": "1.0.32",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "quantumcoin",
-  "version": "7.0.8",
-  "description": "QuantumCoin SDK - a complete SDK for dapps",
+  "version": "7.0.9",
+  "description": "QuantumCoin.js - a post quantum cryptography SDK for QuantumCoin",
   "main": "index.js",
   "types": "src/index.d.ts",
   "typesVersions": {

package/src/wallet/wallet.d.ts

@@ -63,6 +63,13 @@ export class BaseWallet extends AbstractSigner {
  * Wallet - convenience methods around BaseWallet.
  */
 export class Wallet extends BaseWallet {
+    /**
+     * Returns the recommended signing context for this wallet.
+     * Setting fullSign to true may incur additional gas cost.
+     * @param {boolean|null=} fullSign  Defaults to false when null or omitted.
+     * @returns {number}
+     */
+    getSigningContext(fullSign?: boolean | null): number;
     /**
      * Creates a new random wallet.
      * @param {import("../providers/provider").AbstractProvider=} provider

package/src/wallet/wallet.js

@@ -311,6 +311,24 @@ class Wallet extends BaseWallet {
     return json;
   }
 
+  /**
+   * Returns the recommended signing context for this wallet.
+   * Setting fullSign to true may incur additional gas cost.
+   * @param {boolean|null=} fullSign  Defaults to false when null or omitted.
+   * @returns {number}
+   */
+  getSigningContext(fullSign) {
+    const fs = fullSign ?? false;
+    const pubLen = this.signingKey.publicKeyBytes.length;
+    if (pubLen === 1408) {
+      return fs ? 2 : 0;
+    }
+    if (pubLen === 2688) {
+      return 1;
+    }
+    throw makeError("unsupported public key size", "UNSUPPORTED_OPERATION", { publicKeyLength: pubLen });
+  }
+
   /**
    * Returns a new wallet connected to a provider.
    * @param {import("../providers/provider").AbstractProvider} provider

package/test/e2e/signing-context-and-fee.e2e.test.js

@@ -92,11 +92,11 @@ describe("SigningContext and fee E2E", () => {
 
     // --- Phase 2: Send back with signingContext (36: null, 1; 32: null, 0, 2) ---
     const cases = [
-      { wallet: wallet36, signingContext: null, label: "36_null" },
-      { wallet: wallet36, signingContext: 1, label: "36_1" },
-      { wallet: wallet32, signingContext: null, label: "32_null" },
-      { wallet: wallet32, signingContext: 0, label: "32_0" },
-      { wallet: wallet32, signingContext: 2, label: "32_2" },
+      { wallet: wallet36, signingContext: wallet36.getSigningContext(), label: "36_null" },
+      { wallet: wallet36, signingContext: wallet36.getSigningContext(true), label: "36_1" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(), label: "32_null" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(), label: "32_0" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(true), label: "32_2" },
     ];
 
     const expectedFees = {

package/test/e2e/signing-context-and-fee.e2e.test.ts

@@ -83,11 +83,11 @@ describe("SigningContext and fee E2E", () => {
     const sendBackValue = SEND_AMOUNT - qc.parseEther("10000");
 
     const cases = [
-      { wallet: wallet36, signingContext: null as number | null, label: "36_null" },
-      { wallet: wallet36, signingContext: 1, label: "36_1" },
-      { wallet: wallet32, signingContext: null as number | null, label: "32_null" },
-      { wallet: wallet32, signingContext: 0, label: "32_0" },
-      { wallet: wallet32, signingContext: 2, label: "32_2" },
+      { wallet: wallet36, signingContext: wallet36.getSigningContext(), label: "36_null" },
+      { wallet: wallet36, signingContext: wallet36.getSigningContext(true), label: "36_1" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(), label: "32_null" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(), label: "32_0" },
+      { wallet: wallet32, signingContext: wallet32.getSigningContext(true), label: "32_2" },
     ];
 
     const expectedFees: Record<string, bigint> = {

package/test/unit/address-wallet.test.js

@@ -560,5 +560,43 @@ describe("Address + Wallet (offline)", () => {
     assert.equal(w.address, addr5);
     assert.equal(qc.isAddress(w.address), true);
   });
+
+  // ---------------------------------------------------------------------------
+  // getSigningContext
+  // ---------------------------------------------------------------------------
+
+  it("getSigningContext: 32-word wallet (pubKey 1408) returns 0 by default, 2 with fullSign", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_32);
+    assert.strictEqual(w.getSigningContext(), 0);
+    assert.strictEqual(w.getSigningContext(null), 0);
+    assert.strictEqual(w.getSigningContext(false), 0);
+    assert.strictEqual(w.getSigningContext(true), 2);
+  });
+
+  it("getSigningContext: 48-word wallet (pubKey 1408) returns 0 by default, 2 with fullSign", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS);
+    assert.strictEqual(w.getSigningContext(), 0);
+    assert.strictEqual(w.getSigningContext(null), 0);
+    assert.strictEqual(w.getSigningContext(false), 0);
+    assert.strictEqual(w.getSigningContext(true), 2);
+  });
+
+  it("getSigningContext: 36-word wallet (pubKey 2688) returns 1 for all fullSign values", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_36);
+    assert.strictEqual(w.getSigningContext(), 1);
+    assert.strictEqual(w.getSigningContext(null), 1);
+    assert.strictEqual(w.getSigningContext(false), 1);
+    assert.strictEqual(w.getSigningContext(true), 1);
+  });
+
+  it("getSigningContext: throws for unsupported public key size", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_32);
+    w.signingKey.publicKeyBytes = new Uint8Array(100);
+    assert.throws(() => w.getSigningContext(), /unsupported public key size/);
+  });
 });
 

package/test/unit/address-wallet.test.ts

@@ -546,4 +546,42 @@ describe("Address + Wallet (offline)", () => {
     assert.equal(w.address, addr5);
     assert.equal(qc.isAddress(w.address), true);
   });
+
+  // ---------------------------------------------------------------------------
+  // getSigningContext
+  // ---------------------------------------------------------------------------
+
+  it("getSigningContext: 32-word wallet (pubKey 1408) returns 0 by default, 2 with fullSign", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_32);
+    assert.strictEqual(w.getSigningContext(), 0);
+    assert.strictEqual(w.getSigningContext(null), 0);
+    assert.strictEqual(w.getSigningContext(false), 0);
+    assert.strictEqual(w.getSigningContext(true), 2);
+  });
+
+  it("getSigningContext: 48-word wallet (pubKey 1408) returns 0 by default, 2 with fullSign", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS);
+    assert.strictEqual(w.getSigningContext(), 0);
+    assert.strictEqual(w.getSigningContext(null), 0);
+    assert.strictEqual(w.getSigningContext(false), 0);
+    assert.strictEqual(w.getSigningContext(true), 2);
+  });
+
+  it("getSigningContext: 36-word wallet (pubKey 2688) returns 1 for all fullSign values", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_36);
+    assert.strictEqual(w.getSigningContext(), 1);
+    assert.strictEqual(w.getSigningContext(null), 1);
+    assert.strictEqual(w.getSigningContext(false), 1);
+    assert.strictEqual(w.getSigningContext(true), 1);
+  });
+
+  it("getSigningContext: throws for unsupported public key size", async () => {
+    await Initialize(null);
+    const w = qc.Wallet.fromPhrase(TEST_SEED_WORDS_32);
+    (w.signingKey as any).publicKeyBytes = new Uint8Array(100);
+    assert.throws(() => w.getSigningContext(), /unsupported public key size/);
+  });
 });