quantum-coin-js-sdk 1.0.6 → 1.0.8

package/README.md

@@ -5,7 +5,7 @@ Quantum Coin JS SDK provides functionality to interact with the Quantum Coin Blo
 
 **Example**  
 ```js
-Installation:
+Installation:
 
  
 ```
 
 * [quantum-coin-js-sdk](#module_quantum-coin-js-sdk)
@@ -77,8 +77,8 @@ Installation:
     * [~getLatestBlockDetails()](#module_quantum-coin-js-sdk..getLatestBlockDetails) ⇒ <code>Promise.&lt;BlockDetailsResult&gt;</code>
     * [~getAccountDetails(address)](#module_quantum-coin-js-sdk..getAccountDetails) ⇒ <code>Promise.&lt;AccountDetailsResult&gt;</code>
     * [~getTransactionDetails(txnHash)](#module_quantum-coin-js-sdk..getTransactionDetails) ⇒ <code>Promise.&lt;TransactionDetailsResult&gt;</code>
-    * [~signSendCoinTransaction(wallet, toAddress, coinsInWei, nonce)](#module_quantum-coin-js-sdk..signSendCoinTransaction) ⇒ <code>SignResult</code>
-    * [~sendCoins(wallet, toAddress, coinsInWei, nonce)](#module_quantum-coin-js-sdk..sendCoins) ⇒ <code>Promise.&lt;SendResult&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>
 
 <a name="module_quantum-coin-js-sdk..Config"></a>
 
@@ -647,7 +647,7 @@ The deserializeWallet function creates a Wallet object from a JSON string.
 The postTransaction function posts a signed transaction to the blockchain. 
 
 **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
-**Returns**: <code>Promise.&lt;SendResult&gt;</code> - Returns a promise of type SendResult.  
+**Returns**: <code>Promise.&lt;SendResult&gt;</code> - Returns a promise of type SendResult. txnHash will be null in SendResult.  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -686,7 +686,7 @@ The getTransactionDetails function returns details of a transaction posted to th
 
 <a name="module_quantum-coin-js-sdk..signSendCoinTransaction"></a>
 
-### quantum-coin-js-sdk~signSendCoinTransaction(wallet, toAddress, coinsInWei, nonce) ⇒ <code>SignResult</code>
+### quantum-coin-js-sdk~signSendCoinTransaction(wallet, toAddress, coins, nonce) ⇒ <code>SignResult</code>
 The signSendCoinTransaction function returns a signed transaction. 
 
 **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
@@ -696,12 +696,12 @@ The signSendCoinTransaction function returns a signed transaction.
 | --- | --- | --- |
 | wallet | <code>Wallet</code> | A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees. |
 | toAddress | <code>string</code> | The address to which the coins should be sent. |
-| coinsInWei | <code>string</code> | The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
+| coins | <code>string</code> | The string representing the number of coins (in ether) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
 | nonce | <code>number</code> | The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error. |
 
 <a name="module_quantum-coin-js-sdk..sendCoins"></a>
 
-### quantum-coin-js-sdk~sendCoins(wallet, toAddress, coinsInWei, nonce) ⇒ <code>Promise.&lt;SendResult&gt;</code>
+### quantum-coin-js-sdk~sendCoins(wallet, toAddress, coins, nonce) ⇒ <code>Promise.&lt;SendResult&gt;</code>
 The sendCoins function posts a send-coin transaction to the blockchain. 
 
 **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)  
@@ -711,6 +711,6 @@ The sendCoins function posts a send-coin transaction to the blockchain.
 | --- | --- | --- |
 | wallet | <code>Wallet</code> | A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees. |
 | toAddress | <code>string</code> | The address to which the coins should be sent. |
-| coinsInWei | <code>string</code> | The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
+| coins | <code>string</code> | The string representing the number of coins (in ether) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
 | nonce | <code>number</code> | The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error. |
 

package/example/README.md

@@ -1,3 +1,9 @@
 ## Quantum Coin SDK Example
 
 Example for using Quantum Coin SDK
+
+To run the project:
+
+npm install
+
+node example.js

package/example/example.js

@@ -1,4 +1,4 @@
-const qcsdk = require('qc-sdk');
+const qcsdk = require('quantum-coin-js-sdk');
 const ethers = require('ethers');
 
 //Initialize the client configuration
@@ -17,7 +17,6 @@ qcsdk.initialize(clientConfigVal).then((initResult) => {
     }
     console.log("Initialize succeeded");
 
-
     //Get the account details
     let address = "0x0000000000000000000000000000000000000000000000000000000000001000"; //Just an example address https://t4.scan.quantumcoin.org/account/0x0000000000000000000000000000000000000000000000000000000000001000
 
@@ -171,9 +170,10 @@ qcsdk.initialize(clientConfigVal).then((initResult) => {
 
         var toAddress = "0x8293cd9b6ac502d2fe077b0c157dad39f36a5e546525b053151dced633634612";
         var nonce = accountDetailsResult.accountDetails.nonce;
-        var coinsInWei = "1000";
+        var coins = "10"; //in ethers and not in wei
 
-        qcsdk.sendCoins(wallet2, toAddress, coinsInWei, nonce).then((sendResult) => {
+        console.log("Sending coins (wei) " + coins);
+        qcsdk.sendCoins(wallet2, toAddress, coins, nonce).then((sendResult) => { //carefully manage state of nonce when retrying on errors
             if (sendResult === null) {
                 console.error("     sendCoins failed : sendResult is null");
                 return;

package/example/package-lock.json

@@ -10,7 +10,7 @@
       "license": "MIT",
       "dependencies": {
         "ethers": "^6.13.4",
-        "qc-sdk": "^1.0.2"
+        "quantum-coin-js-sdk": "^1.0.6"
       }
     },
     "node_modules/@adraffy/ens-normalize": {
@@ -85,10 +85,10 @@
       "resolved": "https://registry.npmjs.org/pqc-js-sdk/-/pqc-js-sdk-1.0.0.tgz",
       "integrity": "sha512-7Q5YlFvaXoP+MK+yn4KH4MYvJDkyGoGUU/zKYsRxR1mVqddqGUsGvz2JTsfH5B/Gkk97gMMh3PQ7MmkM8iJA5Q=="
     },
-    "node_modules/qc-sdk": {
-      "version": "1.0.4",
-      "resolved": "https://registry.npmjs.org/qc-sdk/-/qc-sdk-1.0.4.tgz",
-      "integrity": "sha512-Nj3DAF4JkyJ2XPjToY5l/i5yBUOxY5Cs4boDeqmFOwvt3qXldCS5fTAOBBpDKQLFYJOnI/CmfRt5hnskIP0GIg==",
+    "node_modules/quantum-coin-js-sdk": {
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/quantum-coin-js-sdk/-/quantum-coin-js-sdk-1.0.7.tgz",
+      "integrity": "sha512-rHdSm7Xa3YGy5m/8YSin5EYJcE8ZnWtAFhcmsI3o56r+58c7ARwmcHaqJMMazmgenUC5AyxlUIrOjwzJFGAOuw==",
       "dependencies": {
         "pqc-js-sdk": "^1.0.0"
       }

package/example/package.json

@@ -10,6 +10,6 @@
   "license": "MIT",
   "dependencies": {
     "ethers": "^6.13.4",
-    "qc-sdk": "^1.0.2"
+    "quantum-coin-js-sdk": "^1.0.6"
   }
 }

package/index.js

@@ -9,10 +9,19 @@
  * Installation:
  * npm install quantum-coin-js-sdk --save
  * 
- * Adding reference:
+ * //Adding reference:
  * var qcsdk = require('quantum-coin-js-sdk');
  * 
+ * //Initialize the SDK first before invoking any other function
+ * var clientConfigVal = new qcsdk.Config("https://t4-relayread.quantumcoin.org", "https://t4-relaywrite.quantumcoin.org", 310324, "", ""); //Testnet T4 Block Explorer: https://t4.scan.quantumcoin.org
+ *  
+ * qcsdk.initialize(clientConfigVal).then((initResult) => {
+ *   
+ * }
+ * 
  * Example Project: https://github.com/quantumcoinproject/quantum-coin-js-sdk/tree/main/example
+ * 
+ * 
  */
 
 var fs = require('fs');
@@ -475,8 +484,14 @@ class TransactionDetailsResult {
 }
 
 function isLargeNumber(val) {
-    var rgx = /^([0-9]+([.][0-9]*)?|[.][0-9]+)$/;
-    return Boolean(val.match(rgx));
+    if (val === null) { 
+        return false;
+    }
+    if (typeof val === 'string' || val instanceof String) {
+        var rgx = /^([0-9]+([.][0-9]*)?|[.][0-9]+)$/;
+        return Boolean(val.match(rgx));
+    }
+    return false;
 }
 
 async function InitAccountsWebAssembly() {
@@ -720,7 +735,7 @@ function transactionGetData(fromaddress, nonce, toaddress, amount, gas, chainid,
  * @async
  * @function postTransaction
  * @param {string} txnData - A signed transaction string returned by the signSendCoinTransaction function.
- * @return {Promise<SendResult>}  Returns a promise of type SendResult. 
+ * @return {Promise<SendResult>}  Returns a promise of type SendResult. txnHash will be null in SendResult.
  */
 async function postTransaction(txnData) {    
     if (isInitialized === false) {
@@ -1008,16 +1023,16 @@ async function getTransactionDetails(txnHash) {
  * @function signSendCoinTransaction
  * @param {Wallet} wallet - A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees.
  * @param {string} toAddress - The address to which the coins should be sent. 
- * @param {string} coinsInWei - The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei
+ * @param {string} coins - The string representing the number of coins (in ether) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei
  * @param {number} nonce - The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error.
  * @return {SignResult}  Returns a promise of type SignResult. 
  */
-async function signSendCoinTransaction(wallet, toAddress, coinsInWei) {
+async function signSendCoinTransaction(wallet, toAddress, coins, nonce) {
     if (isInitialized === false) {
         return -1000;
     }
 
-    if (wallet == null || toAddress == null || coinsInWei == null || nonce == null) {
+    if (wallet == null || toAddress == null || coins == null || nonce == null) {
         return new SignResult(-500, null, null);
     }
 
@@ -1029,7 +1044,7 @@ async function signSendCoinTransaction(wallet, toAddress, coinsInWei) {
         return new SignResult(-502, null, null);
     }
 
-    if (isLargeNumber(coinsInWei) == false) {
+    if (isLargeNumber(coins) == false) {
         return new SignResult(-503, null, null);
     }
 
@@ -1044,7 +1059,7 @@ async function signSendCoinTransaction(wallet, toAddress, coinsInWei) {
 
     const contractData = null;
 
-    var txSigningHash = transactionGetSigningHash(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData)
+    var txSigningHash = transactionGetSigningHash(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData)
     if (txSigningHash == null) {
         return new SignResult(-506, null, null);
     }
@@ -1056,17 +1071,17 @@ async function signSendCoinTransaction(wallet, toAddress, coinsInWei) {
         return new SignResult(-507, null, null);
     }
 
-    var txHashHex = transactionGetTransactionHash(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
+    var txHashHex = transactionGetTransactionHash(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
     if (txHashHex == null) {
-        return new SendResult(-508, null, null);
+        return new SignResult(-508, null, null);
     }
 
-    var txnData = transactionGetData(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
+    var txnData = transactionGetData(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
     if (txnData == null) {
-        return new SendResult(-509, null, null);
+        return new SignResult(-509, null, null);
     }
 
-    return new SendResult(0, txHashHex, txnData);
+    return new SignResult(0, txHashHex, txnData);
 }
 
 /**
@@ -1078,16 +1093,16 @@ async function signSendCoinTransaction(wallet, toAddress, coinsInWei) {
  * @function sendCoins
  * @param {Wallet} wallet - A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees.
  * @param {string} toAddress - The address to which the coins should be sent. 
- * @param {string} coinsInWei - The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei
+ * @param {string} coins - The string representing the number of coins (in ether) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei
  * @param {number} nonce - The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error.
  * @return {Promise<SendResult>}  Returns a promise of type SendResult. 
  */
-async function sendCoins(wallet, toAddress, coinsInWei, nonce) {
+async function sendCoins(wallet, toAddress, coins, nonce) {
     if (isInitialized === false) {
         return -1000;
     }
 
-    if (wallet == null || toAddress == null || coinsInWei == null || nonce == null) {
+    if (wallet == null || toAddress == null || coins == null || nonce == null) {
         return new SendResult(-1, null, null);
     }
 
@@ -1099,7 +1114,7 @@ async function sendCoins(wallet, toAddress, coinsInWei, nonce) {
         return new SendResult(-3, null, null);
     }
 
-    if (isLargeNumber(coinsInWei) == false) {
+    if (isLargeNumber(coins) == false) {
         return new SendResult(-4, null, null);
     }
 
@@ -1123,7 +1138,7 @@ async function sendCoins(wallet, toAddress, coinsInWei, nonce) {
 
     const contractData = null;
 
-    var txSigningHash = transactionGetSigningHash(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData)
+    var txSigningHash = transactionGetSigningHash(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData)
     if (txSigningHash == null) {
         return new SendResult(-9, null, null);
     }
@@ -1135,12 +1150,12 @@ async function sendCoins(wallet, toAddress, coinsInWei, nonce) {
         return new SendResult(-10, null, null);
     }
 
-    var txHashHex = transactionGetTransactionHash(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
+    var txHashHex = transactionGetTransactionHash(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
     if (txHashHex == null) {
         return new SendResult(-11, null, null);
     }
 
-    var txnData = transactionGetData(wallet.address, nonce, toAddress, coinsInWei, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
+    var txnData = transactionGetData(wallet.address, nonce, toAddress, coins, DEFAULT_GAS, config.chainId, contractData, wallet.publicKey, quantumSig);
     if (txnData == null) {
         return new SendResult(-12, null, null);
     }
@@ -1175,4 +1190,3 @@ module.exports = {
     TransactionDetails, 
     TransactionDetailsResult,
 };
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quantum-coin-js-sdk",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Quantum Coin SDK in JavaScript",
   "main": "index.js",
   "scripts": {