fix: parse ENV variable values (#7809)

AztecProtocol · Aug 7, 2024 · faf2ab4 · faf2ab4
1 parent 048a085
commit faf2ab4
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 17 deletions.
diff --git a/yarn-project/aztec/src/cli/aztec_start_options.ts b/yarn-project/aztec/src/cli/aztec_start_options.ts
@@ -12,7 +12,7 @@ import { telemetryClientConfigMappings } from '@aztec/telemetry-client/start';
 export interface AztecStartOption {
   flag: string;
   description: string;
-  defaultValue: string | undefined;
+  defaultValue: any | undefined;
   printDefault?: (val: any) => string;
   envVar: string | undefined;
   parseVal?: (val: string) => any;
@@ -52,23 +52,23 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--sandbox.testAccounts',
       description: 'Deploy test accounts on sandbox start',
-      defaultValue: 'true',
+      defaultValue: true,
       envVar: 'TEST_ACCOUNTS',
-      parseVal: val => ['1', 'true'].includes(val),
+      parseVal: val => ['1', true].includes(val),
     },
     {
       flag: '--sandbox.enableGas',
       description: 'Enable gas on sandbox start',
-      defaultValue: 'false',
+      defaultValue: false,
       envVar: 'ENABLE_GAS',
-      parseVal: val => ['1', 'true'].includes(val),
+      parseVal: val => ['1', true].includes(val),
     },
   ],
   API: [
     {
       flag: '--port',
       description: 'Port to run the Aztec Services on on',
-      defaultValue: '8080',
+      defaultValue: 8080,
       envVar: 'AZTEC_PORT',
       parseVal: val => parseInt(val, 10),
     },
@@ -89,7 +89,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--l1-chain-id <value>',
       description: 'The L1 chain ID',
-      defaultValue: '1337',
+      defaultValue: 1337,
       envVar: 'L1_CHAIN_ID',
       parseVal: val => parseInt(val, 10),
     },
@@ -167,7 +167,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--node.deployAztecContracts',
       description: 'Deploys L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set',
-      defaultValue: 'false',
+      defaultValue: false,
       envVar: 'DEPLOY_AZTEC_CONTRACTS',
     },
     {
@@ -179,14 +179,14 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--node.l2QueueSize <value>',
       description: 'Size of queue of L2 blocks to store in world state',
-      defaultValue: '1000',
+      defaultValue: 1000,
       envVar: 'L2_QUEUE_SIZE',
       parseVal: val => parseInt(val, 10),
     },
     {
       flag: '--node.worldStateBlockCheckIntervalMS <value>',
       description: 'Frequency in which to check for blocks in ms',
-      defaultValue: '100',
+      defaultValue: 100,
       envVar: 'WS_BLOCK_CHECK_INTERVAL_MS',
       parseVal: val => parseInt(val, 10),
     },
@@ -195,7 +195,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--p2p-enabled',
       description: 'Enable P2P subsystem',
-      defaultValue: 'false',
+      defaultValue: false,
       envVar: 'P2P_ENABLED',
     },
     ...getOptions('p2p', p2pConfigMappings),
@@ -204,7 +204,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--telemetry',
       description: 'Enable telemetry',
-      defaultValue: 'false',
+      defaultValue: false,
       envVar: 'TELEMETRY',
     },
     ...getOptions('tel', telemetryClientConfigMappings),
@@ -293,7 +293,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     {
       flag: '--txe.port <value>',
       description: 'Port to run TXE on',
-      defaultValue: '8081',
+      defaultValue: 8081,
       envVar: 'TXE_PORT',
       parseVal: val => parseInt(val, 10),
     },

diff --git a/yarn-project/aztec/src/cli/cmds/start_node.ts b/yarn-project/aztec/src/cli/cmds/start_node.ts
@@ -108,7 +108,7 @@ export const startNode = async (
     telemetryClient = createAndStartTelemetryClient(telemetryConfig);
   }
   // Create and start Aztec Node.
-  const node = await createAztecNode(telemetryClient, nodeConfig);
+  const node = await createAztecNode(nodeConfig, telemetryClient);
   const nodeServer = createAztecNodeRpcServer(node);
 
   // Add node to services list

diff --git a/yarn-project/aztec/src/cli/util.ts b/yarn-project/aztec/src/cli/util.ts
@@ -105,14 +105,30 @@ export function formatHelpLine(
   return `${chalk.cyan(paddedOption)}${chalk.yellow(paddedDefault)}${chalk.green(envVar)}`;
 }
 
+const getDefaultOrEnvValue = (opt: AztecStartOption) => {
+  let val;
+  // if the option is set in the environment, use that & parse it
+  if (opt.envVar && process.env[opt.envVar]) {
+    val = process.env[opt.envVar];
+    if (val && opt.parseVal) {
+      return opt.parseVal(val);
+    }
+    // if no env variable, use the default value
+  } else if (opt.defaultValue) {
+    val = opt.defaultValue;
+  }
+
+  return val;
+};
+
 // Function to add options dynamically
 export const addOptions = (cmd: Command, options: AztecStartOption[]) => {
   options.forEach(opt => {
     cmd.option(
       opt.flag,
       `${opt.description} (default: ${opt.defaultValue}) ($${opt.envVar})`,
       opt.parseVal ? opt.parseVal : val => val,
-      process.env[opt.envVar || ''] || opt.defaultValue,
+      getDefaultOrEnvValue(opt),
     );
   });
 };

diff --git a/yarn-project/aztec/src/sandbox.ts b/yarn-project/aztec/src/sandbox.ts
@@ -160,7 +160,7 @@ export async function createSandbox(config: Partial<SandboxConfig> = {}) {
   }
 
   const client = createAndStartTelemetryClient(getTelemetryClientConfig());
-  const node = await createAztecNode(client, aztecNodeConfig);
+  const node = await createAztecNode(aztecNodeConfig, client);
   const pxe = await createAztecPXE(node);
 
   await deployCanonicalKeyRegistry(
@@ -189,7 +189,7 @@ export async function createSandbox(config: Partial<SandboxConfig> = {}) {
  * Create and start a new Aztec RPC HTTP Server
  * @param config - Optional Aztec node settings.
  */
-export async function createAztecNode(telemetryClient?: TelemetryClient, config: Partial<AztecNodeConfig> = {}) {
+export async function createAztecNode(config: Partial<AztecNodeConfig> = {}, telemetryClient?: TelemetryClient) {
   const aztecNodeConfig: AztecNodeConfig = { ...getConfigEnvVars(), ...config };
   const node = await AztecNodeService.createAndSync(aztecNodeConfig, telemetryClient);
   return node;

diff --git a/yarn-project/kv-store/src/utils.ts b/yarn-project/kv-store/src/utils.ts
@@ -30,6 +30,9 @@ export async function initStoreForRollup<T extends AztecKVStore>(
   rollupAddress: EthAddress,
   log?: Logger,
 ): Promise<T> {
+  if (!rollupAddress) {
+    throw new Error('Rollup address is required');
+  }
   const rollupAddressValue = store.openSingleton<ReturnType<EthAddress['toString']>>('rollupAddress');
   const rollupAddressString = rollupAddress.toString();
   const storedRollupAddressString = rollupAddressValue.get();