patch: check environment variable existence (#1427)

* patch: check evironment variable existence * patch: environment variable existence checks * remove empty line Co-authored-by: Thoralf-M <[email protected]> * patch: remove unnecessary checks * Update bindings/nodejs/examples/client/06-simple-block.ts * patch: fix lint errors --------- Co-authored-by: Thoralf-M <[email protected]>
iotaledger · Nov 21, 2023 · 14a86f3 · 14a86f3
1 parent 8fa1e3b
commit 14a86f3
Show file tree

Hide file tree

Showing 56 changed files with 342 additions and 174 deletions.
diff --git a/bindings/nodejs/examples/client/04-get-output.ts b/bindings/nodejs/examples/client/04-get-output.ts
@@ -10,13 +10,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will get output from a known outputId.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
     try {

diff --git a/bindings/nodejs/examples/client/05-get-address-balance.ts b/bindings/nodejs/examples/client/05-get-address-balance.ts
@@ -11,21 +11,20 @@ require('dotenv').config({ path: '.env' });
 // conditions and sum the amounts and native tokens.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'MNEMONIC']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
-        }
         const secretManager = new SecretManager({
-            mnemonic: process.env.MNEMONIC,
+            mnemonic: process.env.MNEMONIC as string,
         });
 
         // Generate the first address

diff --git a/bindings/nodejs/examples/client/06-simple-block.ts b/bindings/nodejs/examples/client/06-simple-block.ts
@@ -10,13 +10,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will send a block without a payload.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'EXPLORER_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
 

diff --git a/bindings/nodejs/examples/client/07-get-block-data.ts b/bindings/nodejs/examples/client/07-get-block-data.ts
@@ -10,13 +10,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will send a block and get the data and metadata for it.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {

diff --git a/bindings/nodejs/examples/client/08-data-block.ts b/bindings/nodejs/examples/client/08-data-block.ts
@@ -17,13 +17,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will send a block with a tagged data payload.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'EXPLORER_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     const options = {

diff --git a/bindings/nodejs/examples/client/09-transaction.ts b/bindings/nodejs/examples/client/09-transaction.ts
@@ -10,25 +10,23 @@ require('dotenv').config({ path: '.env' });
 // In this example we will send a transaction.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'MNEMONIC', 'EXPLORER_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
 
     try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
-        }
-
         // Configure your own mnemonic in ".env". Since the output amount cannot be zero, the mnemonic must contain non-zero
         // balance
         const secretManager = {
-            mnemonic: process.env.MNEMONIC,
+            mnemonic: process.env.MNEMONIC as string,
         };
 
         // We generate an address from our own mnemonic so that we send the funds to ourselves

diff --git a/bindings/nodejs/examples/client/10-mqtt.ts b/bindings/nodejs/examples/client/10-mqtt.ts
@@ -18,14 +18,16 @@ require('dotenv').config({ path: '.env' });
 // In this example we will listen to MQTT topics and print the block and milestone payloads.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     // Connecting to a MQTT broker using raw ip doesn't work with TCP. This is a limitation of rustls.
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     // Array of topics to subscribe to

diff --git a/bindings/nodejs/examples/client/11-build-output.ts b/bindings/nodejs/examples/client/11-build-output.ts
@@ -24,13 +24,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will build a basic output with various options.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {

diff --git a/bindings/nodejs/examples/client/12-get-raw-block.ts b/bindings/nodejs/examples/client/12-get-raw-block.ts
@@ -10,13 +10,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will get the raw bytes of a block.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {

diff --git a/bindings/nodejs/examples/client/13-build-alias-output.ts b/bindings/nodejs/examples/client/13-build-alias-output.ts
@@ -21,13 +21,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will build an alias output.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {

diff --git a/bindings/nodejs/examples/client/14-build-foundry-output.ts b/bindings/nodejs/examples/client/14-build-foundry-output.ts
@@ -16,20 +16,18 @@ require('dotenv').config({ path: '.env' });
 // In this example we will build a foundry output.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'MNEMONIC']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
-        }
-
         const aliasId =
             '0xff311f59790ccb85343a36fbac2f06d233734794404142b308c13f2c616935b5';
 

diff --git a/bindings/nodejs/examples/client/15-build-nft-output.ts b/bindings/nodejs/examples/client/15-build-nft-output.ts
@@ -22,13 +22,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will build an NFT output.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
     });
 
     try {

diff --git a/bindings/nodejs/examples/client/16-custom-plugin.ts b/bindings/nodejs/examples/client/16-custom-plugin.ts
@@ -10,13 +10,15 @@ require('dotenv').config({ path: '.env' });
 // In this example we will get output from a known nft by calling the node endpoint using a "custom plugin" call.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const client = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
 

diff --git a/bindings/nodejs/examples/client/offline_signing/00-address-generation.ts b/bindings/nodejs/examples/client/offline_signing/00-address-generation.ts
@@ -19,14 +19,15 @@ const ADDRESS_FILE_NAME = 'offline-signing-address.json';
 // In this example we will generate an address offline which will be used later to find inputs.
 async function run() {
     initLogger();
-
-    try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
+    for (const envVar of ['MNEMONIC']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
         }
+    }
 
+    try {
         const secretManager = new SecretManager({
-            mnemonic: process.env.MNEMONIC,
+            mnemonic: process.env.MNEMONIC as string,
         });
 
         // Generates an address offline.

diff --git a/bindings/nodejs/examples/client/offline_signing/01-transaction-preparation.ts b/bindings/nodejs/examples/client/offline_signing/01-transaction-preparation.ts
@@ -16,13 +16,15 @@ const PREPARED_TRANSACTION_FILE_NAME =
 // In this example we will get inputs and prepare a transaction
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
 
     const onlineClient = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
 

diff --git a/bindings/nodejs/examples/client/offline_signing/02-transaction-signing.ts b/bindings/nodejs/examples/client/offline_signing/02-transaction-signing.ts
@@ -16,16 +16,17 @@ const SIGNED_TRANSACTION_FILE_NAME = 'offline-signing-signed-transaction.json';
 // In this example we will sign the prepared transaction.
 async function run() {
     initLogger();
+    for (const envVar of ['MNEMONIC']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
+    }
 
     const offlineClient = new Client({});
 
     try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
-        }
-
         const secretManager = {
-            mnemonic: process.env.MNEMONIC,
+            mnemonic: process.env.MNEMONIC as string,
         };
 
         // Read in prepared transaction from example 2_transaction_preparation

diff --git a/bindings/nodejs/examples/client/offline_signing/03-send-block.ts b/bindings/nodejs/examples/client/offline_signing/03-send-block.ts
@@ -14,12 +14,14 @@ const SIGNED_TRANSACTION_FILE_NAME = 'offline-signing-signed-transaction.json';
 // In this example we will send the signed transaction in a block.
 async function run() {
     initLogger();
-    if (!process.env.NODE_URL) {
-        throw new Error('.env NODE_URL is undefined, see .env.example');
+    for (const envVar of ['NODE_URL', 'EXPLORER_URL']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
+        }
     }
     const onlineClient = new Client({
         // Insert your node URL in the .env.
-        nodes: [process.env.NODE_URL],
+        nodes: [process.env.NODE_URL as string],
         localPow: true,
     });
 

diff --git a/bindings/nodejs/examples/evm/send-evm-transaction.ts b/bindings/nodejs/examples/evm/send-evm-transaction.ts
@@ -37,12 +37,14 @@ const TX_OPTIONS = {
 
 async function run(): Promise<void> {
     const provider = new Web3(RPC_ENDPOINT);
-    try {
-        if (!process.env.MNEMONIC) {
-            throw new Error('.env MNEMONIC is undefined, see .env.example');
+    for (const envVar of ['MNEMONIC']) {
+        if (!(envVar in process.env)) {
+            throw new Error(`.env ${envVar} is undefined, see .env.example`);
         }
+    }
+    try {
         const mnemonicSecretManager = {
-            mnemonic: process.env.MNEMONIC,
+            mnemonic: process.env.MNEMONIC as string,
         };
 
         const secretManager = new SecretManager(mnemonicSecretManager);

diff --git a/bindings/nodejs/examples/exchange/3-check-balance.ts b/bindings/nodejs/examples/exchange/3-check-balance.ts
@@ -12,10 +12,12 @@ require('dotenv').config({ path: '.env' });
 
 async function run() {
     try {
-        if (!process.env.WALLET_DB_PATH) {
-            throw new Error(
-                '.env WALLET_DB_PATH is undefined, see .env.example',
-            );
+        for (const envVar of ['WALLET_DB_PATH']) {
+            if (!(envVar in process.env)) {
+                throw new Error(
+                    `.env ${envVar} is undefined, see .env.example`,
+                );
+            }
         }
 
         const wallet = new Wallet({