quantum-coin-js-sdk 1.0.20 → 1.0.21

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

@@ -15,9 +15,10 @@
       }
     },
     "..": {
-      "version": "1.0.20",
+      "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"
       }

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>;

package/index.js

@@ -694,15 +694,19 @@ async function InitAccountsWebAssembly() {
  *
  * @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.
  */
 async function initialize(clientConfig) {
     if (isInitialized === true) {
         return false;
     }
-    if (clientConfig === null || clientConfig.readUrl === null || clientConfig.writeUrl === null || clientConfig.chainId === null) {
-        return false;
+    if (clientConfig === null || clientConfig === undefined) {
+        clientConfig = Config("https://sdk.readrelay.quantumcoinapi.com", "https://sdk.writerelay.quantumcoinapi.com", 123123, "", ""); //default
+    } else {
+        if (clientConfig.readUrl === null || clientConfig.writeUrl === null || clientConfig.chainId === null) {
+            return false;
+        }
     }
     await InitAccountsWebAssembly();    
     config = clientConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quantum-coin-js-sdk",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "description": "Quantum Coin - Q SDK in JavaScript",
   "main": "index.js",
   "scripts": {
@@ -29,6 +29,7 @@
   },
   "homepage": "https://github.com/quantumcoinproject/quantum-coin-js-sdk#readme",
   "dependencies": {
+    "jsdoc-to-markdown": "^9.1.2",
     "quantum-coin-pqc-js-sdk": "^1.0.0",
     "seed-words": "^1.0.1"
   }