Merge pull request #73 from quantnetwork/develop

Update DLT libraries
quantnetwork · Mar 30, 2023 · 6fbe598 · 6fbe598
2 parents 4796882 + 97b0759
commit 6fbe598
Show file tree

Hide file tree

Showing 41 changed files with 4,761 additions and 4,989 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -22,6 +22,7 @@
         "comma-dangle": "off",
         "comma-spacing": "off",
         "consistent-return": "off",
+        "eqeqeq": "warn",
         "global-require": "off",
         "import/extensions": "off",
         "import/newline-after-import": "off",
@@ -42,6 +43,7 @@
         "no-undef": "off",
         "no-unused-vars": "off",
         "no-useless-constructor": "off",
+        "no-var": "warn",
         "object-curly-newline": "off",
         "object-curly-spacing": "off",
         "object-property-newline": "off",
@@ -50,8 +52,12 @@
         "padded-blocks": "off",
         "prefer-const": "off",
         "prefer-destructuring": "off",
+        "prefer-template": "off",
+        "quote-props": "off",
         "quotes": "off",
+        "radix": "off",
         "space-before-blocks": "off",
+        "space-before-function-paren": "off",
         "space-infix-ops": "off",
         "spaced-comment": "off"
     }

diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -20,7 +20,7 @@ jobs:
       CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
     strategy:
       matrix:
-        node-version: [14.18.0, 16.10.0]
+        node-version: [14.18.0, 16.13.0]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ The Overledger SDK is a collection of node packages written in Typescript. Curre
 
 ## Prerequisites
 
-- nodejs v14 >= 14.18.0, or v16 >= 16.10.0
+- nodejs v14 >= 14.18.0, or v16 >= 16.13.0
 - yarn
 - lerna
 
@@ -60,7 +60,7 @@ If updating the SDK, please follow this short development guide. Note that when
 The Overledger JavaScript SDK manages multiple packages through [Lerna](https://lerna.js.org/). To build the SDK, first we need to globally install the lerna dependency:
 
 ```
-npm install -g lerna@4.0.0
+npm install -g lerna@6.6.1
 ```
 
 To build the project, first download the yarn package manager:

diff --git a/api_reference.md b/api_reference.md
@@ -237,11 +237,22 @@ Development package for Ripple (XRP Ledger).
 <a name="module_overledger-oauth-provider"></a>
 
 ## overledger-oauth-provider
+
+* [overledger-oauth-provider](#module_overledger-oauth-provider)
+
+    * [.default](#module_overledger-oauth-provider.default)
+
+    * [.log](#module_overledger-oauth-provider.log)
+
+
 <a name="module_overledger-oauth-provider.default"></a>
 
 ### *overledger-oauth-provider*.default
 Oauth provider package.
 
+<a name="module_overledger-oauth-provider.log"></a>
+
+### *overledger-oauth-provider*.log
 <a name="module_overledger-provider"></a>
 
 ## overledger-provider
@@ -256,8 +267,6 @@ Oauth provider package.
 
     * [.log](#module_overledger-provider.log)
 
-    * [.log](#module_overledger-provider.log)
-
 
 <a name="module_overledger-provider.TESTNET"></a>
 
@@ -276,9 +285,6 @@ Network provider package.
 
 <a name="module_overledger-provider.log"></a>
 
-### *overledger-provider*.log
-<a name="module_overledger-provider.log"></a>
-
 ### *overledger-provider*.log
 <a name="module_overledger-types"></a>
 

diff --git a/build.properties b/build.properties
diff --git a/examples/create-account/create-account.js b/examples/create-account/create-account.js
@@ -8,7 +8,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },

diff --git a/examples/oauth2/get-tokens-using-client-id-and-secret.js b/examples/oauth2/get-tokens-using-client-id-and-secret.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -20,11 +20,15 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
             envFilePassword: 'password',
         });
 
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken)
-            console.log('expiresIn:\n', refreshTokensResponse.expiresIn);
-            console.log('tokenType:\n', refreshTokensResponse.tokenType);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('expiresIn:\n', refreshTokensResponse.expiresIn);
+        console.log('tokenType:\n', refreshTokensResponse.tokenType);
     } catch (e) {
         console.error('error', e);
     }

diff --git a/examples/overledger-requests/address-search/balance-search/autoexecute-example.js b/examples/overledger-requests/address-search/balance-search/autoexecute-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "Ethereum",
                 "network": "Ropsten Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/overledger-requests/address-search/balance-search/preparation-execution-example.js b/examples/overledger-requests/address-search/balance-search/preparation-execution-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "XRP Ledger",
                 "network": "Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/overledger-requests/address-search/sequence-search/autoexecute-example.js b/examples/overledger-requests/address-search/sequence-search/autoexecute-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "Ethereum",
                 "network": "Ropsten Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/overledger-requests/address-search/sequence-search/preparation-execution-example.js b/examples/overledger-requests/address-search/sequence-search/preparation-execution-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "Ethereum",
                 "network": "Ropsten Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/overledger-requests/block-search/autoexecute-example.js b/examples/overledger-requests/block-search/autoexecute-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "Bitcoin",
                 "network": "Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/overledger-requests/block-search/preparation-execution-example.js b/examples/overledger-requests/block-search/preparation-execution-example.js
@@ -9,7 +9,7 @@
 const OverledgerSDK = require('@quantnetwork/overledger-bundle').default;
 const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
 
-; (async () => {
+(async () => {
     try {
         const overledger = new OverledgerSDK({
             dlts: [{ dlt: DltNameOptions.BITCOIN },
@@ -21,19 +21,23 @@ const DltNameOptions = require('@quantnetwork/overledger-types').DltNameOptions;
         });
 
         //get required token
-        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(process.env.USER_NAME, process.env.PASSWORD,
-            process.env.CLIENT_ID, process.env.CLIENT_SECRET);
-            console.log('accessToken:\n', refreshTokensResponse.accessToken);
-            console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
-            console.log('idToken:\n', refreshTokensResponse.idToken);
+        const refreshTokensResponse = await overledger.getTokensUsingClientIdAndSecret(
+            process.env.USER_NAME,
+            process.env.PASSWORD,
+            process.env.CLIENT_ID,
+            process.env.CLIENT_SECRET,
+        );
+        console.log('accessToken:\n', refreshTokensResponse.accessToken);
+        console.log('refreshToken:\n', refreshTokensResponse.refreshToken);
+        console.log('idToken:\n', refreshTokensResponse.idToken);
 
         //setup overledger preparation request
         const overledgerRequest = {
             "location": {
                 "technology": "XRP Ledger",
                 "network": "Testnet"
             }
-        }
+        };
         const overledgerInstance = overledger.provider.createRequest(refreshTokensResponse.accessToken.toString());
 
         //send overledger preparation request

diff --git a/examples/signing/bitcoin-signing.js b/examples/signing/bitcoin-signing.js
@@ -18,19 +18,19 @@ const overledger = new OverledgerSDK({
 // Setting our private key from the encrypted .env file
 overledger.dlts[DltNameOptions.BITCOIN].setAccount({secret: process.env.PARTY_A_BITCOIN_SECRET});
 // Wraping the main function in an async block to be able to call the sign function
-; (async () => {
+(async () => {
     try {
         // Signing the prepared transaction
         let signedTransaction = (await overledger.sign(DltNameOptions.BITCOIN, preparedTransaction)).signedTransaction;
         // Building the Overledger Execution API request
         let executeTransactionRequest = {
             requestId: preparedTransaction.requestId,
             signed: signedTransaction
-        }
+        };
 
         console.log('Overledger Transaction Execution Request: \n' + JSON.stringify(executeTransactionRequest, null, 2));
 
     } catch (e) {
         console.error('error', e);
     }
-})();
+})();