feat: add node_env to batch submitter (#678)

* add node_env to batch submitter

* rename log to logger for service consistency

* address review comments

* make ETH_NETWORK_NAME to disambiguate

* move tx data to debug

packages/batch-submitter/.env.example

+# Environment
+NODE_ENV=development
+# Leave blank during local development
+ETH_NETWORK_NAME=
 # Logging & monitoring
 DEBUG=info*,error*,warn*,debug*
 # Leave the SENTRY_DSN variable unset during local development
 SENTRY_DSN=
+SENTRY_TRACE_RATE=
 
 L1_NODE_WEB3_URL=http://localhost:9545
 L2_NODE_WEB3_URL=http://localhost:8545

packages/batch-submitter/src/batch-submitter/batch-submitter.ts

@@ -40,7 +40,7 @@ export abstract class BatchSubmitter {
     readonly maxGasPriceInGwei: number,
     readonly gasRetryIncrement: number,
     readonly gasThresholdInGwei: number,
-    readonly log: Logger,
+    readonly logger: Logger,
     readonly metrics: Metrics
   ) {}
 
@@ -58,13 +58,13 @@ export abstract class BatchSubmitter {
     }
     await this._updateChainInfo()
     await this._checkBalance()
-    this.log.info('Readying to submit next batch...', {
+    this.logger.info('Readying to submit next batch...', {
       l2ChainId: this.l2ChainId,
       batchSubmitterAddress: await this.signer.getAddress(),
     })
 
     if (this.syncing === true) {
-      this.log.info(
+      this.logger.info(
         'Syncing mode enabled! Skipping batch submission and clearing queue...'
       )
       return this._onSync()
@@ -83,13 +83,13 @@ export abstract class BatchSubmitter {
     const ether = utils.formatEther(balance)
     const num = parseFloat(ether)
 
-    this.log.info('Checked balance', {
+    this.logger.info('Checked balance', {
       address,
       ether,
     })
 
     if (num < this.minBalanceEther) {
-      this.log.fatal('Current balance lower than min safe balance', {
+      this.logger.fatal('Current balance lower than min safe balance', {
         current: num,
         safeBalance: this.minBalanceEther,
       })
@@ -130,7 +130,7 @@ export abstract class BatchSubmitter {
       currentTimestamp
     if (batchSizeInBytes < this.minTxSize) {
       if (!isTimeoutReached) {
-        this.log.info(
+        this.logger.info(
           'Skipping batch submission. Batch too small & max submission timeout not reached.',
           {
             batchSizeInBytes,
@@ -141,25 +141,28 @@ export abstract class BatchSubmitter {
         )
         return false
       }
-      this.log.info('Timeout reached, proceeding with batch submission.', {
+      this.logger.info('Timeout reached, proceeding with batch submission.', {
         batchSizeInBytes,
         lastBatchSubmissionTimestamp: this.lastBatchSubmissionTimestamp,
         currentTimestamp,
       })
       return true
     }
-    this.log.info('Sufficient batch size, proceeding with batch submission.', {
-      batchSizeInBytes,
-      lastBatchSubmissionTimestamp: this.lastBatchSubmissionTimestamp,
-      currentTimestamp,
-    })
+    this.logger.info(
+      'Sufficient batch size, proceeding with batch submission.',
+      {
+        batchSizeInBytes,
+        lastBatchSubmissionTimestamp: this.lastBatchSubmissionTimestamp,
+        currentTimestamp,
+      }
+    )
     return true
   }
 
   public static async getReceiptWithResubmission(
     txFunc: (gasPrice) => Promise<TransactionReceipt>,
     resubmissionConfig: ResubmissionConfig,
-    log: Logger
+    logger: Logger
   ): Promise<TransactionReceipt> {
     const {
       resubmissionTimeout,
@@ -176,7 +179,7 @@ export abstract class BatchSubmitter {
       delay: resubmissionTimeout,
     })
 
-    log.debug('Resubmission tx receipt', { receipt })
+    logger.debug('Resubmission tx receipt', { receipt })
 
     return receipt
   }
@@ -190,7 +193,7 @@ export abstract class BatchSubmitter {
       10
     )
     if (minGasPriceInGwei > this.maxGasPriceInGwei) {
-      this.log.warn(
+      this.logger.warn(
         'Minimum gas price is higher than max! Ethereum must be congested...'
       )
       minGasPriceInGwei = this.maxGasPriceInGwei
@@ -203,7 +206,7 @@ export abstract class BatchSubmitter {
     successMessage: string
   ): Promise<TransactionReceipt> {
     this.lastBatchSubmissionTimestamp = Date.now()
-    this.log.debug('Waiting for receipt...')
+    this.logger.debug('Waiting for receipt...')
 
     const resubmissionConfig: ResubmissionConfig = {
       resubmissionTimeout: this.resubmissionTimeout,
@@ -215,11 +218,11 @@ export abstract class BatchSubmitter {
     const receipt = await BatchSubmitter.getReceiptWithResubmission(
       txFunc,
       resubmissionConfig,
-      this.log
+      this.logger
     )
 
-    this.log.info('Received transaction receipt', { receipt })
-    this.log.info(successMessage)
+    this.logger.info('Received transaction receipt', { receipt })
+    this.logger.info(successMessage)
     return receipt
   }
 }

packages/batch-submitter/src/batch-submitter/state-batch-submitter.ts

@@ -40,7 +40,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
     maxGasPriceInGwei: number,
     gasRetryIncrement: number,
     gasThresholdInGwei: number,
-    log: Logger,
+    logger: Logger,
     metrics: Metrics,
     fraudSubmissionAddress: string
   ) {
@@ -60,7 +60,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
       maxGasPriceInGwei,
       gasRetryIncrement,
       gasThresholdInGwei,
-      log,
+      logger,
       metrics
     )
     this.fraudSubmissionAddress = fraudSubmissionAddress
@@ -73,7 +73,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
   public async _updateChainInfo(): Promise<void> {
     const info: RollupInfo = await this._getRollupInfo()
     if (info.mode === 'verifier') {
-      this.log.error(
+      this.logger.error(
         'Verifier mode enabled! Batch submitter only compatible with sequencer mode'
       )
       process.exit(1)
@@ -88,7 +88,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
       sccAddress === this.chainContract.address &&
       ctcAddress === this.ctcContract.address
     ) {
-      this.log.debug('Chain contract already initialized', {
+      this.logger.debug('Chain contract already initialized', {
         sccAddress,
         ctcAddress,
       })
@@ -102,7 +102,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
       await getContractFactory('OVM_CanonicalTransactionChain', this.signer)
     ).attach(ctcAddress)
 
-    this.log.info('Connected Optimism contracts', {
+    this.logger.info('Connected Optimism contracts', {
       stateCommitmentChain: this.chainContract.address,
       canonicalTransactionChain: this.ctcContract.address,
     })
@@ -110,23 +110,23 @@ export class StateBatchSubmitter extends BatchSubmitter {
   }
 
   public async _onSync(): Promise<TransactionReceipt> {
-    this.log.info('Syncing mode enabled! Skipping state batch submission...')
+    this.logger.info('Syncing mode enabled! Skipping state batch submission...')
     return
   }
 
   public async _getBatchStartAndEnd(): Promise<Range> {
-    this.log.info('Getting batch start and end for state batch submitter...')
+    this.logger.info('Getting batch start and end for state batch submitter...')
     // TODO: Remove BLOCK_OFFSET by adding a tx to Geth's genesis
     const startBlock: number =
       (await this.chainContract.getTotalElements()).toNumber() + BLOCK_OFFSET
-    this.log.info('Retrieved start block number from SCC', {
+    this.logger.info('Retrieved start block number from SCC', {
       startBlock,
     })
 
     // We will submit state roots for txs which have been in the tx chain for a while.
     const totalElements: number =
       (await this.ctcContract.getTotalElements()).toNumber() + BLOCK_OFFSET
-    this.log.info('Retrieved total elements from CTC', {
+    this.logger.info('Retrieved total elements from CTC', {
       totalElements,
     })
 
@@ -137,11 +137,11 @@ export class StateBatchSubmitter extends BatchSubmitter {
 
     if (startBlock >= endBlock) {
       if (startBlock > endBlock) {
-        this.log.error(
+        this.logger.error(
           'State commitment chain is larger than transaction chain. This should never happen!'
         )
       }
-      this.log.info(
+      this.logger.info(
         'No state commitments to submit. Skipping batch submission...'
       )
       return
@@ -162,7 +162,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
       [batch, startBlock]
     )
     const batchSizeInBytes = remove0x(tx).length / 2
-    this.log.debug('State batch generated', {
+    this.logger.debug('State batch generated', {
       batchSizeInBytes,
       tx,
     })
@@ -172,7 +172,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
     }
 
     const offsetStartsAtIndex = startBlock - BLOCK_OFFSET // TODO: Remove BLOCK_OFFSET by adding a tx to Geth's genesis
-    this.log.debug('Submitting batch.', { tx })
+    this.logger.debug('Submitting batch.', { tx })
 
     const nonce = await this.signer.getTransactionCount()
     const contractFunction = async (gasPrice): Promise<TransactionReceipt> => {
@@ -181,11 +181,13 @@ export class StateBatchSubmitter extends BatchSubmitter {
         offsetStartsAtIndex,
         { nonce, gasPrice }
       )
-      this.log.info('Submitted appendStateBatch transaction', {
+      this.logger.info('Submitted appendStateBatch transaction', {
         nonce,
         txHash: contractTx.hash,
         contractAddr: this.chainContract.address,
         from: contractTx.from,
+      })
+      this.logger.debug('appendStateBatch transaction data', {
         data: contractTx.data,
       })
       return this.signer.provider.waitForTransaction(
@@ -208,13 +210,15 @@ export class StateBatchSubmitter extends BatchSubmitter {
     const batch: Bytes32[] = await bPromise.map(
       [...Array(blockRange).keys()],
       async (i: number) => {
-        this.log.debug('Fetching L2BatchElement', { blockNo: startBlock + i })
+        this.logger.debug('Fetching L2BatchElement', {
+          blockNo: startBlock + i,
+        })
         const block = (await this.l2Provider.getBlockWithTransactions(
           startBlock + i
         )) as L2Block
         const blockTx = block.transactions[0]
         if (blockTx.from === this.fraudSubmissionAddress) {
-          this.log.warn('Found transaction from fraud submission address', {
+          this.logger.warn('Found transaction from fraud submission address', {
             txHash: blockTx.hash,
             fraudSubmissionAddress: this.fraudSubmissionAddress,
           })
@@ -232,7 +236,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
     )
     while (remove0x(tx).length / 2 > this.maxTxSize) {
       batch.splice(Math.ceil((batch.length * 2) / 3)) // Delete 1/3rd of all of the batch elements
-      this.log.debug('Splicing batch...', {
+      this.logger.debug('Splicing batch...', {
         batchSizeInBytes: tx.length / 2,
       })
       tx = this.chainContract.interface.encodeFunctionData('appendStateBatch', [
@@ -241,7 +245,7 @@ export class StateBatchSubmitter extends BatchSubmitter {
       ])
     }
 
-    this.log.info('Generated state commitment batch', {
+    this.logger.info('Generated state commitment batch', {
       batch, // list of stateRoots
     })
     return batch

packages/batch-submitter/src/exec/run-batch-submitter.ts

@@ -16,19 +16,34 @@ import {
   TX_BATCH_SUBMITTER_LOG_TAG,
 } from '..'
 
+const environment = process.env.NODE_ENV
+const network = process.env.ETH_NETWORK_NAME
+const release = `batch-submitter@${process.env.npm_package_version}`
+
 /* Logger */
 const name = 'oe:batch_submitter:init'
-const log = new Logger({
-  name,
-  sentryOptions: {
-    release: `batch-submitter@${process.env.npm_package_version}`,
-    dsn: process.env.SENTRY_DSN,
-    tracesSampleRate: 0.05,
-  },
-})
+let logger
+
+if (network) {
+  // Initialize Sentry for Batch Submitter deployed to a network
+  logger = new Logger({
+    name,
+    sentryOptions: {
+      release,
+      dsn: process.env.SENTRY_DSN,
+      tracesSampleRate: parseInt(process.env.SENTRY_TRACE_RATE, 10) || 0.05,
+      environment: network, // separate our Sentry errors by network instead of node environment
+    },
+  })
+} else {
+  // Skip initializing Sentry
+  logger = new Logger({ name })
+}
+
 /* Metrics */
 const metrics = new Metrics({
   prefix: name,
+  labels: { environment, release, network },
 })
 
 interface RequiredEnvVars {
@@ -115,11 +130,11 @@ const autoFixBatchOptions: AutoFixBatchOptions = {
 }
 
 export const run = async () => {
-  log.info('Starting batch submitter...')
+  logger.info('Starting batch submitter...')
 
   for (const [i, val] of Object.entries(requiredEnvVars)) {
     if (!process.env[val]) {
-      log.warn('Missing environment variable', {
+      logger.warn('Missing environment variable', {
         varName: val,
       })
       exit(1)
@@ -144,7 +159,7 @@ export const run = async () => {
   }
 
   const address = await sequencerSigner.getAddress()
-  log.info('Configured batch submitter addresses', {
+  logger.info('Configured batch submitter addresses', {
     batchSubmitterAddress: address,
     addressManagerAddress: requiredEnvVars.ADDRESS_MANAGER_ADDRESS,
   })
@@ -164,8 +179,11 @@ export const run = async () => {
     MAX_GAS_PRICE_IN_GWEI,
     GAS_RETRY_INCREMENT,
     GAS_THRESHOLD_IN_GWEI,
-    log.child({ name: TX_BATCH_SUBMITTER_LOG_TAG }),
-    new Metrics({ prefix: TX_BATCH_SUBMITTER_LOG_TAG }),
+    logger.child({ name: TX_BATCH_SUBMITTER_LOG_TAG }),
+    new Metrics({
+      prefix: TX_BATCH_SUBMITTER_LOG_TAG,
+      labels: { environment, release, network },
+    }),
     DISABLE_QUEUE_BATCH_APPEND,
     autoFixBatchOptions
   )
@@ -186,8 +204,11 @@ export const run = async () => {
     MAX_GAS_PRICE_IN_GWEI,
     GAS_RETRY_INCREMENT,
     GAS_THRESHOLD_IN_GWEI,
-    log.child({ name: STATE_BATCH_SUBMITTER_LOG_TAG }),
-    new Metrics({ prefix: STATE_BATCH_SUBMITTER_LOG_TAG }),
+    logger.child({ name: STATE_BATCH_SUBMITTER_LOG_TAG }),
+    new Metrics({
+      prefix: STATE_BATCH_SUBMITTER_LOG_TAG,
+      labels: { environment, release, network },
+    }),
     FRAUD_SUBMISSION_ADDRESS
   )
 
@@ -201,18 +222,22 @@ export const run = async () => {
         const pendingTxs = await sequencerSigner.getTransactionCount('pending')
         const latestTxs = await sequencerSigner.getTransactionCount('latest')
         if (pendingTxs > latestTxs) {
-          log.info('Detected pending transactions. Clearing all transactions!')
+          logger.info(
+            'Detected pending transactions. Clearing all transactions!'
+          )
           for (let i = latestTxs; i < pendingTxs; i++) {
             const response = await sequencerSigner.sendTransaction({
               to: await sequencerSigner.getAddress(),
               value: 0,
               nonce: i,
             })
-            log.info('Submitted empty transaction', {
+            logger.info('Submitted empty transaction', {
               nonce: i,
               txHash: response.hash,
               to: response.to,
               from: response.from,
+            })
+            logger.debug('empty transaction data', {
               data: response.data,
             })
             await sequencerSigner.provider.waitForTransaction(
@@ -222,7 +247,7 @@ export const run = async () => {
           }
         }
       } catch (err) {
-        log.error('Cannot clear transactions', { err })
+        logger.error('Cannot clear transactions', { err })
         process.exit(1)
       }
     }
@@ -231,8 +256,8 @@ export const run = async () => {
       try {
         await func()
       } catch (err) {
-        log.error('Error submitting batch', { err })
-        log.info('Retrying...')
+        logger.error('Error submitting batch', { err })
+        logger.info('Retrying...')
       }
       // Sleep
       await new Promise((r) =>