feat: extract sync option to env (#34)

thephez · web-flow · commit f42be3a5ed60 · 2024-03-28T16:34:08.000-04:00
* feat: extract sync option to env

Allows setting sync height option in a single location

* docs: add optional step to readme for sync height

* docs: align node version with the one on docs.dash.org/platform
diff --git a/.env.example b/.env.example
@@ -1,5 +1,11 @@
 MNEMONIC='jewel pattern cry forget gown better agent celery nothing glove silk ill'
 # Mnemonic's first address: ydinxECoSdvGkCMZFhrqY4fg3Jc3AbeS2z
+
+# Core block height to begin syncing from
+#  Allows syncing to complete faster than if syncing the entire chain from the first block
+#  Set to a height below where your first wallet transaction occurred
+#  See current height at: https://testnet-insight.dashevo.org/insight/
+SYNC_START_HEIGHT=875000
 # IDENTITY_ID comes from the "$id" found in the "identity-register.js" response
 IDENTITY_ID='6cSbshXPYDA2CmBtD31X4uo7YLwtef4mVDt15zRok8Xg'
 # CONTRACT_ID comes from the "$id" found in the "contract-register-minimal.js" response
diff --git a/1-Identities-and-Names/identity-register.js b/1-Identities-and-Names/identity-register.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/1-Identities-and-Names/identity-retrieve-account-ids.js b/1-Identities-and-Names/identity-retrieve-account-ids.js
@@ -8,7 +8,7 @@ const client = new Dash.Client({
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 });
diff --git a/1-Identities-and-Names/identity-topup.js b/1-Identities-and-Names/identity-topup.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/1-Identities-and-Names/identity-update-add-key.js b/1-Identities-and-Names/identity-update-add-key.js
@@ -11,7 +11,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/1-Identities-and-Names/identity-update-disable-key.js b/1-Identities-and-Names/identity-update-disable-key.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/1-Identities-and-Names/name-register-alias.js b/1-Identities-and-Names/name-register-alias.js
@@ -10,7 +10,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/1-Identities-and-Names/name-register.js b/1-Identities-and-Names/name-register.js
@@ -10,7 +10,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/2-Contracts-and-Documents/contract-register-history.js b/2-Contracts-and-Documents/contract-register-history.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/2-Contracts-and-Documents/contract-register-minimal.js b/2-Contracts-and-Documents/contract-register-minimal.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/2-Contracts-and-Documents/contract-update-history.js b/2-Contracts-and-Documents/contract-update-history.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/2-Contracts-and-Documents/contract-update-minimal.js b/2-Contracts-and-Documents/contract-update-minimal.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
diff --git a/2-Contracts-and-Documents/document-delete.js b/2-Contracts-and-Documents/document-delete.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
   apps: {
diff --git a/2-Contracts-and-Documents/document-submit.js b/2-Contracts-and-Documents/document-submit.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
   apps: {
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Code for the tutorials found on the
 
 ## Install
 
-Note: [NodeJS](https://nodejs.org/en/download/) (v18+) must be installed to run
+Note: [NodeJS](https://nodejs.org/en/download/) (v20+) must be installed to run
 the tutorial code.
 
 ### Clone this repository
@@ -34,6 +34,10 @@ npm ci
    the address reported in the previous step
 1. Open the `.env` file (See [`.env.example`](./.env.example) for an example
    `.env` file) and set `MNEMONIC` to the wallet mnemonic from step 3.
+1. (Optional) To minimize wallet sync time, open your `.env` file and set
+   `SYNC_START_HEIGHT` to a Core chain block height just below the height of
+   your wallet's first transaction. Otherwise you can skip this step and use the
+   default value from [`.env.example`](./.env.example).
 
 Proceed with the tutorials
 [Identities and Names tutorials](./1-Identities-and-Names/) first and the
diff --git a/send-funds.js b/send-funds.js
@@ -8,7 +8,7 @@ const clientOpts = {
   wallet: {
     mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
     unsafeOptions: {
-      skipSynchronizationBeforeHeight: 875000, // only sync from mid-2023
+      skipSynchronizationBeforeHeight: process.env.SYNC_START_HEIGHT, // sync starting at this Core block height
     },
   },
 };
