refactor: extract client instantiation to module (#36)

thephez · web-flow · commit b4fe179198a8 · 2024-04-09T16:31:31.000-04:00
* refactor: extract client init into module

Update identity register and retrieve to use

* refactor: single client

* style: fmt

* chore: fix comment

* refactor: change remaining identity and name scripts to use extracted client setup

* refactor: change contract and document scripts to use extracted client setup

* refactor: change name of client setup

* refactor: change misc scripts to use new client

* chore: run fmt

* docs: update readme to mention client option info
diff --git a/1-Identities-and-Names/identity-register.js b/1-Identities-and-Names/identity-register.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/register-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const createIdentity = async () => {
   return client.platform.identities.register();
diff --git a/1-Identities-and-Names/identity-retrieve-account-ids.js b/1-Identities-and-Names/identity-retrieve-account-ids.js
@@ -1,17 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/retrieve-an-accounts-identities.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-});
+const client = setupDashClient();
 
 const retrieveIdentityIds = async () => {
   const account = await client.getWalletAccount();
diff --git a/1-Identities-and-Names/identity-retrieve.js b/1-Identities-and-Names/identity-retrieve.js
@@ -1,9 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/retrieve-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const retrieveIdentity = async () => {
   return client.platform.identities.get(process.env.IDENTITY_ID); // Your identity ID
diff --git a/1-Identities-and-Names/identity-topup.js b/1-Identities-and-Names/identity-topup.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/topup-an-identity-balance.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const topupIdentity = async () => {
   const identityId = process.env.IDENTITY_ID; // Your identity ID
diff --git a/1-Identities-and-Names/identity-transfer-credits.js b/1-Identities-and-Names/identity-transfer-credits.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/transfer-credits-to-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // only sync from mid-2023
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const transferCredits = async () => {
   const identityId = process.env.IDENTITY_ID; // Your identity ID
diff --git a/1-Identities-and-Names/identity-update-add-key.js b/1-Identities-and-Names/identity-update-add-key.js
@@ -3,19 +3,9 @@ const Dash = require('dash');
 const {
   PlatformProtocol: { IdentityPublicKey, IdentityPublicKeyWithWitness },
 } = Dash;
-const dotenv = require('dotenv');
-dotenv.config();
-
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const setupDashClient = require('../setupDashClient');
+
+const client = setupDashClient();
 
 const updateIdentityAddKey = async () => {
   const identityId = process.env.IDENTITY_ID;
diff --git a/1-Identities-and-Names/identity-update-disable-key.js b/1-Identities-and-Names/identity-update-disable-key.js
@@ -1,22 +1,11 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/update-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const updateIdentityDisableKey = async () => {
   const identityId = process.env.IDENTITY_ID;
-  const keyId = 2; // One of the identity's public key IDs
+  const keyId = 3; // One of the identity's public key IDs
 
   // Retrieve the identity to be updated and the public key to disable
   const existingIdentity = await client.platform.identities.get(identityId);
diff --git a/1-Identities-and-Names/name-register-alias.js b/1-Identities-and-Names/name-register-alias.js
@@ -1,20 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/register-a-name-for-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const aliasToRegister = ''; // Enter alias to register
-
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const registerAlias = async () => {
   const platform = client.platform;
diff --git a/1-Identities-and-Names/name-register.js b/1-Identities-and-Names/name-register.js
@@ -1,20 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/register-a-name-for-an-identity.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const nameToRegister = ''; // Enter name to register
-
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const registerName = async () => {
   const { platform } = client;
diff --git a/1-Identities-and-Names/name-resolve-by-name.js b/1-Identities-and-Names/name-resolve-by-name.js
@@ -1,7 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/retrieve-a-name.html
-const Dash = require('dash');
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const nameToRetrieve = ''; // Enter name to retrieve
 
diff --git a/1-Identities-and-Names/name-resolve-by-record.js b/1-Identities-and-Names/name-resolve-by-record.js
@@ -1,9 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/retrieve-a-name.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const retrieveNameByRecord = async () => {
   // Retrieve by a name's identity ID
diff --git a/1-Identities-and-Names/name-search-by-name.js b/1-Identities-and-Names/name-search-by-name.js
@@ -1,11 +1,9 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/retrieve-a-name.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
 const searchPrefix = 'a'; // Enter prefix character(s) to search for
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const retrieveNameBySearch = async () => {
   // Search for names (e.g. `user*`)
diff --git a/2-Contracts-and-Documents/contract-register-history.js b/2-Contracts-and-Documents/contract-register-history.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/register-a-data-contract.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const registerContract = async () => {
   const { platform } = client;
diff --git a/2-Contracts-and-Documents/contract-register-minimal.js b/2-Contracts-and-Documents/contract-register-minimal.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/register-a-data-contract.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const registerContract = async () => {
   const { platform } = client;
diff --git a/2-Contracts-and-Documents/contract-retrieve-history.js b/2-Contracts-and-Documents/contract-retrieve-history.js
@@ -1,9 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/retrieve-data-contract-history.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const retrieveContractHistory = async () => {
   const contractId = process.env.CONTRACT_ID; // Your contract ID
diff --git a/2-Contracts-and-Documents/contract-retrieve.js b/2-Contracts-and-Documents/contract-retrieve.js
@@ -1,9 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/retrieve-a-data-contract.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const client = new Dash.Client({ network: process.env.NETWORK });
+const client = setupDashClient();
 
 const retrieveContract = async () => {
   const contractId = process.env.CONTRACT_ID; // Your contract ID
diff --git a/2-Contracts-and-Documents/contract-update-history.js b/2-Contracts-and-Documents/contract-update-history.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/update-documents.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
-
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const setupDashClient = require('../setupDashClient');
+
+const client = setupDashClient();
 
 const updateContract = async () => {
   const { platform } = client;
diff --git a/2-Contracts-and-Documents/contract-update-minimal.js b/2-Contracts-and-Documents/contract-update-minimal.js
@@ -1,18 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/update-documents.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const updateContract = async () => {
   const { platform } = client;
diff --git a/2-Contracts-and-Documents/document-delete.js b/2-Contracts-and-Documents/document-delete.js
@@ -1,23 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/delete-documents.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  wallet: {
-    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
-    unsafeOptions: {
-      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
-    },
-  },
-  apps: {
-    tutorialContract: {
-      contractId: process.env.CONTRACT_ID, // Your contract ID
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const deleteNoteDocument = async () => {
   const { platform } = client;
diff --git a/2-Contracts-and-Documents/document-retrieve.js b/2-Contracts-and-Documents/document-retrieve.js
@@ -1,17 +1,7 @@
 // See https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents/retrieve-documents.html
-const Dash = require('dash');
-const dotenv = require('dotenv');
-dotenv.config();
+const setupDashClient = require('../setupDashClient');
 
-const clientOpts = {
-  network: process.env.NETWORK,
-  apps: {
-    tutorialContract: {
-      contractId: process.env.CONTRACT_ID, // Your contract ID
-    },
-  },
-};
-const client = new Dash.Client(clientOpts);
+const client = setupDashClient();
 
 const getDocuments = async () => {
   return client.platform.documents.get('tutorialContract.note', {
diff --git a/2-Contracts-and-Documents/document-submit.js b/2-Contracts-and-Documents/document-submit.js
diff --git a/2-Contracts-and-Documents/document-update.js b/2-Contracts-and-Documents/document-update.js
diff --git a/README.md b/README.md
diff --git a/connect.js b/connect.js
diff --git a/send-funds.js b/send-funds.js
diff --git a/setupDashClient.js b/setupDashClient.js
diff --git a/use-dapi-client-methods.js b/use-dapi-client-methods.js
