quantum-coin-js-sdk 1.0.18 → 1.0.20

package/README.md

@@ -108,8 +108,10 @@ Requires Node.js version v20.18.1 or higher
     * [~listAccountTransactions(address, pageNumber)](#module_quantum-coin-js-sdk..listAccountTransactions) ⇒ <code>Promise.&lt;ListAccountTransactionsResponse&gt;</code>
     * [~signSendCoinTransaction(wallet, toAddress, coins, nonce)](#module_quantum-coin-js-sdk..signSendCoinTransaction) ⇒ <code>SignResult</code>
     * [~sendCoins(wallet, toAddress, coins, nonce)](#module_quantum-coin-js-sdk..sendCoins) ⇒ <code>Promise.&lt;SendResult&gt;</code>
-    * [~publicKeyFromSignature(digest, signature)](#module_quantum-coin-js-sdk..publicKeyFromSignature) ⇒ <code>Array.&lt;number&gt;</code>
-    * [~publicKeyFromPrivateKey(privateKey)](#module_quantum-coin-js-sdk..publicKeyFromPrivateKey) ⇒ <code>Array.&lt;number&gt;</code>
+    * [~publicKeyFromSignature(digest, signature)](#module_quantum-coin-js-sdk..publicKeyFromSignature) ⇒ <code>string</code>
+    * [~publicKeyFromPrivateKey(privateKey)](#module_quantum-coin-js-sdk..publicKeyFromPrivateKey) ⇒ <code>string</code>
+    * [~addressFromPublicKey(publicKey)](#module_quantum-coin-js-sdk..addressFromPublicKey) ⇒ <code>string</code>
+    * [~combinePublicKeySignature(publicKey, signature)](#module_quantum-coin-js-sdk..combinePublicKeySignature) ⇒ <code>string</code>
 
 <a name="module_quantum-coin-js-sdk..Config"></a>
 
@@ -1003,11 +1005,11 @@ The sendCoins function posts a send-coin transaction to the blockchain.
 
 <a name="module_quantum-coin-js-sdk..publicKeyFromSignature"></a>
 
-### quantum-coin-js-sdk~publicKeyFromSignature(digest, signature) ⇒ <code>Array.&lt;number&gt;</code>
+### quantum-coin-js-sdk~publicKeyFromSignature(digest, signature) ⇒ <code>string</code>
 The publicKeyFromSignature extracts the public key from a signature.
 
 **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
-**Returns**: <code>Array.&lt;number&gt;</code> - - Returns a byte array containing the public key. Returns null if the operation failed.  
+**Returns**: <code>string</code> - - Returns the public key as a hex string. Returns null if the operation failed.  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -1016,13 +1018,38 @@ The publicKeyFromSignature extracts the public key from a signature.
 
 <a name="module_quantum-coin-js-sdk..publicKeyFromPrivateKey"></a>
 
-### quantum-coin-js-sdk~publicKeyFromPrivateKey(privateKey) ⇒ <code>Array.&lt;number&gt;</code>
+### quantum-coin-js-sdk~publicKeyFromPrivateKey(privateKey) ⇒ <code>string</code>
 The publicKeyFromPrivateKey extracts the public key from a private key.
 
 **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
-**Returns**: <code>Array.&lt;number&gt;</code> - - Returns a byte array containing the public key. Returns null if the operation failed.  
+**Returns**: <code>string</code> - - Returns the public key as a hex string. Returns null if the operation failed.  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | privateKey | <code>Array.&lt;number&gt;</code> | An array of bytes containing the privateKey. |
 
+<a name="module_quantum-coin-js-sdk..addressFromPublicKey"></a>
+
+### quantum-coin-js-sdk~addressFromPublicKey(publicKey) ⇒ <code>string</code>
+The addressFromPublicKey returns the address corresponding to the public key.
+
+**Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
+**Returns**: <code>string</code> - - Returns the address corresponding to the public key as a hex string. Returns null if the operation failed.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| publicKey | <code>Array.&lt;number&gt;</code> | An array of bytes containing the public key. |
+
+<a name="module_quantum-coin-js-sdk..combinePublicKeySignature"></a>
+
+### quantum-coin-js-sdk~combinePublicKeySignature(publicKey, signature) ⇒ <code>string</code>
+The combinePublicKeySignature combines the public key and signature.
+
+**Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
+**Returns**: <code>string</code> - - Returns a hex string corresponding to combined signature. Returns null if the operation failed.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| publicKey | <code>Array.&lt;number&gt;</code> | An array of bytes containing the public key. |
+| signature | <code>Array.&lt;number&gt;</code> | An array of bytes containing the signature. |
+

package/example/example-misc.js

@@ -1,5 +1,6 @@
 const qcsdk = require('quantum-coin-js-sdk');
 const ethers = require('ethers');
+const pqc = require("quantum-coin-pqc-js-sdk");
 
 var clientConfigVal = new qcsdk.Config("https://sdk.readrelay.quantumcoinapi.com", "https://sdk.writerelay.quantumcoinapi.com", 123123, "", ""); //Mainnet
 
@@ -39,12 +40,33 @@ qcsdk.initialize(clientConfigVal).then((initResult) => {
     console.log("walletExample.privateKey length " + walletExample.privateKey.length);
     let publicKey2 = qcsdk.publicKeyFromPrivateKey(walletExample.privateKey);
     console.log("publicKeyFromPrivateKey publicKey length: " + publicKey2.length);
-    if (publicKey2.length !== walletExample.publicKey.length) {
-        throw new Error("public key length compare failed");
+    let publicKey2Bytes = hexToBytes(publicKey2);
+    if (publicKey2Bytes.length !== walletExample.publicKey.length) {
+        throw new Error("public key length compare failed S");
     }
-    for (i = 0; i < publicKey2.length; i++) {
-        if (publicKey2[i] !== walletExample.publicKey[i]) {
-            throw new Error("public key compare failed");
+    for (let i = 0; i < publicKey2Bytes.length; i++) {
+        if (publicKey2Bytes[i] !== walletExample.publicKey[i]) {
+            throw new Error("public key compare failed A");
+        }
+    }
+
+    let utf8Encode = new TextEncoder();
+    let message = utf8Encode.encode("verifyverifyverifyverifyverifyok");
+
+    let quantumSig = pqc.cryptoSign(message, walletExample.privateKey);
+    let combinedSignatureHex =  qcsdk.combinePublicKeySignature(walletExample.publicKey, quantumSig);
+    if (combinedSignatureHex === null) {
+        throw new Error("combinePublicKeySignature combine failed");
+    }
+    let combinedSignatureBytes = hexToBytes(combinedSignatureHex);
+    let publicKeySigHex = qcsdk.publicKeyFromSignature(message, combinedSignatureBytes);
+    let publicKeySigBytes = hexToBytes(publicKeySigHex);
+    if (publicKeySigBytes.length !== walletExample.publicKey.length) {
+        throw new Error("public key length compare failed B");
+    }
+    for (let i = 0; i < publicKeySigBytes.length; i++) {
+        if (publicKeySigBytes[i] !== walletExample.publicKey[i]) {
+            throw new Error("public key compare failed B");
         }
     }
    
@@ -55,3 +77,21 @@ function base64ToBytes(base64) {
     return Uint8Array.from(binString, (m) => m.codePointAt(0));
 }
 
+// Convert a hex string to a byte array
+function hexToBytes(hex) {
+    let bytes = [];
+    for (let c = 0; c < hex.length; c += 2)
+        bytes.push(parseInt(hex.substr(c, 2), 16));
+    return bytes;
+}
+
+// Convert a byte array to a hex string
+function bytesToHex(bytes) {
+    let hex = [];
+    for (let i = 0; i < bytes.length; i++) {
+        let current = bytes[i] < 0 ? bytes[i] + 256 : bytes[i];
+        hex.push((current >>> 4).toString(16));
+        hex.push((current & 0xF).toString(16));
+    }
+    return hex.join("");
+}

package/example/example.js

@@ -172,6 +172,14 @@ qcsdk.initialize(clientConfigVal).then((initResult) => {
     console.log("isAddressValid (expected true)" + qcsdk.isAddressValid(wallet1.address)); //should print true
     console.log("isAddressValid (expected false)" + qcsdk.isAddressValid("asfasdfasdfs")); //should print false
 
+    //Retrieve address from public key
+    let addressTemp = qcsdk.addressFromPublicKey(wallet2.publicKey);
+    console.log("addressFromPublicKey: " + addressTemp);
+    if (addressTemp !== wallet2.address) {
+        throw new Error("addressFromPublicKey doesn't match: " + addressTemp + " " + wallet2.publicKey);
+    }
+    return;
+
     //Send coins
     //First get account details nonce
     console.log("sendCoins getAccountDetails " + address);

package/example/package-lock.json

@@ -10,7 +10,16 @@
       "license": "MIT",
       "dependencies": {
         "ethers": "^6.13.4",
-        "quantum-coin-js-sdk": "^1.0.17"
+        "quantum-coin-js-sdk": "file:..",
+        "quantum-coin-pqc-js-sdk": "^1.0.5"
+      }
+    },
+    "..": {
+      "version": "1.0.20",
+      "license": "MIT",
+      "dependencies": {
+        "quantum-coin-pqc-js-sdk": "^1.0.0",
+        "seed-words": "^1.0.1"
       }
     },
     "node_modules/@adraffy/ens-normalize": {
@@ -87,14 +96,8 @@
       }
     },
     "node_modules/quantum-coin-js-sdk": {
-      "version": "1.0.17",
-      "resolved": "https://registry.npmjs.org/quantum-coin-js-sdk/-/quantum-coin-js-sdk-1.0.17.tgz",
-      "integrity": "sha512-PhpNkNDXOmBHOyyakeUUsj8rBnJ/Tr3ZXmpgd6M8n7qvo1vsoiuBjSWEIJR2YvsIiPOpRCIJqq8E59sCJ9+1Zg==",
-      "license": "MIT",
-      "dependencies": {
-        "quantum-coin-pqc-js-sdk": "^1.0.0",
-        "seed-words": "^1.0.1"
-      }
+      "resolved": "..",
+      "link": true
     },
     "node_modules/quantum-coin-pqc-js-sdk": {
       "version": "1.0.5",
@@ -102,12 +105,6 @@
       "integrity": "sha512-9P1YDkca5CqrO7++TnGJZzPvYlBjYARopHgxYbDcEHgPicP7+tA8zD+DE1BooHp7sLEWF9ObklMj6AdaDUjDVw==",
       "license": "MIT"
     },
-    "node_modules/seed-words": {
-      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/seed-words/-/seed-words-1.0.2.tgz",
-      "integrity": "sha512-ia58deuPjcR8DpJ8uIgZ7gqDnIWD8vnjb4jX/sEsIDcuQaH/AJj9J8L3DXkUHfUGqAq9Y6pVMuG90t3XUJH90g==",
-      "license": "MIT"
-    },
     "node_modules/tslib": {
       "version": "2.7.0",
       "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",

package/example/package.json

@@ -10,6 +10,7 @@
   "license": "MIT",
   "dependencies": {
     "ethers": "^6.13.4",
-    "quantum-coin-js-sdk": "^1.0.17"
+    "quantum-coin-js-sdk": "file:..",
+    "quantum-coin-pqc-js-sdk": "^1.0.5"
   }
 }

package/index.d.ts

@@ -675,17 +675,34 @@ export function openWalletFromSeedWords(seedWordList: any[]): Wallet;
  * @function publicKeyFromSignature
  * @param {number[]} digest - An array of bytes containing the digestHash. Should be of length 32.
  * @param {number[]} signature - An array of bytes containing the signature.
- * @return {number[]} - Returns a byte array containing the public key. Returns null if the operation failed.
+ * @return {string} - Returns the public key as a hex string. Returns null if the operation failed.
  */
-export function publicKeyFromSignature(digest: number[], signature: number[]): number[];
+export function publicKeyFromSignature(digest: number[], signature: number[]): string;
 /**
  * The publicKeyFromPrivateKey extracts the public key from a private key.
  *
  * @function publicKeyFromPrivateKey
  * @param {number[]} privateKey - An array of bytes containing the privateKey.
- * @return {number[]} - Returns a byte array containing the public key. Returns null if the operation failed.
+ * @return {string} - Returns the public key as a hex string. Returns null if the operation failed.
  */
-export function publicKeyFromPrivateKey(privateKey: number[]): number[];
+export function publicKeyFromPrivateKey(privateKey: number[]): string;
+/**
+ * The addressFromPublicKey returns the address corresponding to the public key.
+ *
+ * @function addressFromPublicKey
+ * @param {number[]} publicKey - An array of bytes containing the public key.
+ * @return {string} - Returns the address corresponding to the public key as a hex string. Returns null if the operation failed.
+ */
+export function addressFromPublicKey(publicKey: number[]): string;
+/**
+ * The combinePublicKeySignature combines the public key and signature.
+ *
+ * @function combinePublicKeySignature
+ * @param {number[]} publicKey - An array of bytes containing the public key.
+ * @param {number[]} signature - An array of bytes containing the signature.
+ * @return {string} - Returns a hex string corresponding to combined signature. Returns null if the operation failed.
+ */
+export function combinePublicKeySignature(publicKey: number[], signature: number[]): string;
 /**
  * @class
  * @constructor