quantum-coin-js-sdk 1.0.19 → 1.0.21

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-wallet.js

@@ -0,0 +1,43 @@
+const qcsdk = require('quantum-coin-js-sdk');
+
+var clientConfigVal = new qcsdk.Config("https://sdk.readrelay.quantumcoinapi.com", "https://sdk.writerelay.quantumcoinapi.com", 123123, "", ""); //Mainnet
+
+
+//Initialize the client configuration
+//var clientConfigVal = new qcsdk.Config("https://t4-relayread.quantumcoin.org", "https://t4-relaywrite.quantumcoin.org", 310324, "", ""); //Testnet T4
+//Testnet T4 Block Explorer: https://t4.scan.quantumcoin.org
+
+//For mainnet, use the following configuration
+//var clientConfigVal = new qcsdk.Config("https://sdk.readrelay.quantumcoinapi.com", "https://sdk.writerelay.quantumcoinapi.com", 123123, "", ""); //Mainnet
+//Mainnet Block Explorer: https://scan.quantumcoin.org
+
+//Local testing configuration
+//var clientConfigVal = new qcsdk.Config("http://127.0.0.1:9090", "http://127.0.0.1:9091", 123123, "", ""); //local testing
+//Mainnet Block Explorer: https://scan.quantumcoin.org
+
+
+//Initialize the SDK
+qcsdk.initialize(clientConfigVal).then((initResult) => {
+    if (initResult === false) {
+        console.error("Initialize failed");
+        return;
+    }
+
+    let examplePassphrase = "helloworld123";
+
+    //Save to an encrypted wallet that can then be restored into an external wallet application such as Desktop/Web/CLI/Mobile wallet
+    let walletObj2 = qcsdk.newWallet();
+    let walletEncryptedJson2 = qcsdk.serializeEncryptedWallet(walletObj2, examplePassphrase);
+    if (walletEncryptedJson2 === null) {
+        throw new Error("serializeEncryptedWallet failed");
+    }
+    let walletEncryptedJson3 = qcsdk.serializeEncryptedWallet(walletObj2, examplePassphrase);
+    if (walletEncryptedJson3 === null) {
+        throw new Error("serializeEncryptedWallet failed");
+    }
+    console.log("Serialized wallet A: " + walletEncryptedJson2); //just an example for demonstration, do not actually log to console
+    console.log("Serialized wallet B: " + walletEncryptedJson3); //just an example for demonstration, do not actually log to console
+
+
+});
+

package/example/package-lock.json

@@ -10,13 +10,15 @@
       "license": "MIT",
       "dependencies": {
         "ethers": "^6.13.4",
-        "quantum-coin-js-sdk": "file:.."
+        "quantum-coin-js-sdk": "file:..",
+        "quantum-coin-pqc-js-sdk": "^1.0.5"
       }
     },
     "..": {
-      "version": "1.0.19",
+      "version": "1.0.21",
       "license": "MIT",
       "dependencies": {
+        "jsdoc-to-markdown": "^9.1.2",
         "quantum-coin-pqc-js-sdk": "^1.0.0",
         "seed-words": "^1.0.1"
       }
@@ -98,6 +100,12 @@
       "resolved": "..",
       "link": true
     },
+    "node_modules/quantum-coin-pqc-js-sdk": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/quantum-coin-pqc-js-sdk/-/quantum-coin-pqc-js-sdk-1.0.5.tgz",
+      "integrity": "sha512-9P1YDkca5CqrO7++TnGJZzPvYlBjYARopHgxYbDcEHgPicP7+tA8zD+DE1BooHp7sLEWF9ObklMj6AdaDUjDVw==",
+      "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.19"
+    "quantum-coin-js-sdk": "file:..",
+    "quantum-coin-pqc-js-sdk": "^1.0.5"
   }
 }

package/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @async
  * @function initialize
- * @param {Config} clientConfig - A configuration represented by the Config class
+ * @param {Config} clientConfig - A configuration represented by the Config class. A default configuration is used, if not specified.
  * @return {Promise<boolean>} Returns a promise of type boolean; true if the initialization succeeded, else false.
  */
 export function initialize(clientConfig: Config): Promise<boolean>;
@@ -675,25 +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 a hex string corresponding to the public key. Returns null if the operation failed.
+ * @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