refactor: clean up validation and add factory getters (#32)

Co-authored-by: spsjvc <[email protected]>
OffchainLabs · Feb 29, 2024 · 5a341c1 · 5a341c1
1 parent 2f5a7cb
commit 5a341c1
Show file tree

Hide file tree

Showing 15 changed files with 77 additions and 94 deletions.
diff --git a/src/createRollupEnoughCustomFeeTokenAllowance.ts b/src/createRollupEnoughCustomFeeTokenAllowance.ts
@@ -1,8 +1,7 @@
 import { Address, PublicClient } from 'viem';
 
-import { rollupCreator } from './contracts';
-import { validParentChainId } from './types/ParentChain';
 import { fetchAllowance } from './utils/erc20';
+import { getRollupCreatorAddress } from './utils/getters';
 import { createRollupDefaultRetryablesFees } from './constants';
 
 import { Prettify } from './types/utils';
@@ -22,16 +21,10 @@ export async function createRollupEnoughCustomFeeTokenAllowance({
   publicClient,
   rollupCreatorAddressOverride,
 }: CreateRollupEnoughCustomFeeTokenAllowanceParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   const allowance = await fetchAllowance({
     address: nativeToken,
     owner: account,
-    spender: rollupCreatorAddressOverride ?? rollupCreator.address[chainId],
+    spender: rollupCreatorAddressOverride ?? getRollupCreatorAddress(publicClient),
     publicClient,
   });
 

diff --git a/src/createRollupFetchCoreContracts.ts b/src/createRollupFetchCoreContracts.ts
@@ -1,5 +1,5 @@
 import { Address, PublicClient } from 'viem';
-import { validParentChainId } from './types/ParentChain';
+
 import { CoreContracts } from './types/CoreContracts';
 import { createRollupFetchTransactionHash } from './createRollupFetchTransactionHash';
 import { createRollupPrepareTransactionReceipt } from './createRollupPrepareTransactionReceipt';
@@ -13,12 +13,6 @@ export async function createRollupFetchCoreContracts({
   rollup,
   publicClient,
 }: CreateRollupFetchCoreContractsParams): Promise<CoreContracts> {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   // getting core contract addresses
   const transactionHash = await createRollupFetchTransactionHash({
     rollup,

diff --git a/src/createRollupFetchTransactionHash.ts b/src/createRollupFetchTransactionHash.ts
@@ -1,7 +1,7 @@
 import { Address, PublicClient } from 'viem';
 import { AbiEvent } from 'abitype';
 
-import { ParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import {
   mainnet,
   arbitrumOne,
@@ -56,19 +56,21 @@ export async function createRollupFetchTransactionHash({
   rollup,
   publicClient,
 }: CreateRollupFetchTransactionHashParams) {
-  // Find the RollupInitialized event from that Rollup contract
-  const chainId = await publicClient.getChainId();
+  const chainId = validateParentChain(publicClient);
+
   const fromBlock =
     chainId in Object.keys(earliestRollupCreatorDeploymentBlockNumber)
-      ? earliestRollupCreatorDeploymentBlockNumber[chainId as ParentChainId]
+      ? earliestRollupCreatorDeploymentBlockNumber[chainId]
       : 'earliest';
 
+  // Find the RollupInitialized event from that Rollup contract
   const rollupInitializedEvents = await publicClient.getLogs({
     address: rollup,
     event: RollupInitializedEventAbi,
     fromBlock,
     toBlock: 'latest',
   });
+
   if (rollupInitializedEvents.length !== 1) {
     throw new Error(
       `Expected to find 1 RollupInitialized event for rollup address ${rollup} but found ${rollupInitializedEvents.length}`,
@@ -77,6 +79,7 @@ export async function createRollupFetchTransactionHash({
 
   // Get the transaction hash that emitted that event
   const transactionHash = rollupInitializedEvents[0].transactionHash;
+
   if (!transactionHash) {
     throw new Error(
       `No transactionHash found in RollupInitialized event for rollup address ${rollup}`,

diff --git a/src/createRollupPrepareCustomFeeTokenApprovalTransactionRequest.ts b/src/createRollupPrepareCustomFeeTokenApprovalTransactionRequest.ts
@@ -1,8 +1,8 @@
 import { Address, PublicClient } from 'viem';
 
 import { approvePrepareTransactionRequest } from './utils/erc20';
-import { validParentChainId } from './types/ParentChain';
-import { rollupCreator } from './contracts';
+import { validateParentChain } from './types/ParentChain';
+import { getRollupCreatorAddress } from './utils/getters';
 import { createRollupDefaultRetryablesFees } from './constants';
 
 import { Prettify } from './types/utils';
@@ -24,16 +24,12 @@ export async function createRollupPrepareCustomFeeTokenApprovalTransactionReques
   publicClient,
   rollupCreatorAddressOverride,
 }: CreateRollupPrepareCustomFeeTokenApprovalTransactionRequestParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
+  const chainId = validateParentChain(publicClient);
 
   const request = await approvePrepareTransactionRequest({
     address: nativeToken,
     owner: account,
-    spender: rollupCreatorAddressOverride ?? rollupCreator.address[chainId],
+    spender: rollupCreatorAddressOverride ?? getRollupCreatorAddress(publicClient),
     amount,
     publicClient,
   });

diff --git a/src/createRollupPrepareTransactionRequest.ts b/src/createRollupPrepareTransactionRequest.ts
@@ -4,10 +4,11 @@ import { defaults } from './createRollupDefaults';
 import { createRollupGetCallValue } from './createRollupGetCallValue';
 import { createRollupGetMaxDataSize } from './createRollupGetMaxDataSize';
 import { rollupCreator } from './contracts';
-import { validParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import { isCustomFeeTokenAddress } from './utils/isCustomFeeTokenAddress';
 import { ChainConfig } from './types/ChainConfig';
 import { isAnyTrustChainConfig } from './utils/isAnyTrustChainConfig';
+import { getRollupCreatorAddress } from './utils/getters';
 import { fetchDecimals } from './utils/erc20';
 import { TransactionRequestGasOverrides, applyPercentIncrease } from './utils/gasOverrides';
 
@@ -42,11 +43,7 @@ export async function createRollupPrepareTransactionRequest({
   gasOverrides,
   rollupCreatorAddressOverride,
 }: CreateRollupPrepareTransactionRequestParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error(`"publicClient.chain" can't be undefined.`);
-  }
+  const chainId = validateParentChain(publicClient);
 
   if (params.batchPoster === zeroAddress) {
     throw new Error(`"params.batchPoster" can't be set to the zero address.`);
@@ -79,7 +76,7 @@ export async function createRollupPrepareTransactionRequest({
 
   const request = await publicClient.prepareTransactionRequest({
     chain: publicClient.chain,
-    to: rollupCreatorAddressOverride ?? rollupCreator.address[chainId],
+    to: rollupCreatorAddressOverride ?? getRollupCreatorAddress(publicClient),
     data: createRollupEncodeFunctionData([paramsWithDefaults]),
     value: createRollupGetCallValue(paramsWithDefaults),
     account,

diff --git a/src/createTokenBridgeEnoughCustomFeeTokenAllowance.ts b/src/createTokenBridgeEnoughCustomFeeTokenAllowance.ts
@@ -1,12 +1,11 @@
 import { Address, PublicClient } from 'viem';
 
-import { tokenBridgeCreator } from './contracts';
-import { validParentChainId } from './types/ParentChain';
 import { fetchAllowance } from './utils/erc20';
 import { createTokenBridgeDefaultRetryablesFees } from './constants';
 
 import { Prettify } from './types/utils';
 import { WithTokenBridgeCreatorAddressOverride } from './types/createTokenBridgeTypes';
+import { getTokenBridgeCreatorAddress } from './utils/getters';
 
 export type CreateTokenBridgeEnoughCustomFeeTokenAllowanceParams = Prettify<
   WithTokenBridgeCreatorAddressOverride<{
@@ -22,16 +21,10 @@ export async function createTokenBridgeEnoughCustomFeeTokenAllowance({
   publicClient,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgeEnoughCustomFeeTokenAllowanceParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   const allowance = await fetchAllowance({
     address: nativeToken,
     owner,
-    spender: tokenBridgeCreatorAddressOverride ?? tokenBridgeCreator.address[chainId],
+    spender: tokenBridgeCreatorAddressOverride ?? getTokenBridgeCreatorAddress(publicClient),
     publicClient,
   });
 

diff --git a/src/createTokenBridgeFetchTokenBridgeContracts.ts b/src/createTokenBridgeFetchTokenBridgeContracts.ts
@@ -4,8 +4,8 @@ import { tokenBridgeCreator } from './contracts';
 
 import { Prettify } from './types/utils';
 import { WithTokenBridgeCreatorAddressOverride } from './types/createTokenBridgeTypes';
-import { validParentChainId } from './types/ParentChain';
 import { TokenBridgeContracts } from './types/TokenBridgeContracts';
+import { getTokenBridgeCreatorAddress } from './utils/getters';
 
 export type CreateTokenBridgeFetchTokenBridgeContractsParams = Prettify<
   WithTokenBridgeCreatorAddressOverride<{
@@ -19,14 +19,8 @@ export async function createTokenBridgeFetchTokenBridgeContracts({
   parentChainPublicClient,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgeFetchTokenBridgeContractsParams): Promise<TokenBridgeContracts> {
-  const chainId = parentChainPublicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   const tokenBridgeCreatorAddress =
-    tokenBridgeCreatorAddressOverride ?? tokenBridgeCreator.address[chainId];
+    tokenBridgeCreatorAddressOverride ?? getTokenBridgeCreatorAddress(parentChainPublicClient);
 
   // getting parent chain addresses
   const [

diff --git a/src/createTokenBridgePrepareCustomFeeTokenApprovalTransactionRequest.ts b/src/createTokenBridgePrepareCustomFeeTokenApprovalTransactionRequest.ts
@@ -1,11 +1,11 @@
 import { Address, PublicClient, maxInt256 } from 'viem';
 
 import { approvePrepareTransactionRequest } from './utils/erc20';
-import { validParentChainId } from './types/ParentChain';
-import { tokenBridgeCreator } from './contracts';
 
 import { Prettify } from './types/utils';
+import { validateParentChain } from './types/ParentChain';
 import { WithTokenBridgeCreatorAddressOverride } from './types/createTokenBridgeTypes';
+import { getTokenBridgeCreatorAddress } from './utils/getters';
 
 export type CreateTokenBridgePrepareCustomFeeTokenApprovalTransactionRequestParams = Prettify<
   WithTokenBridgeCreatorAddressOverride<{
@@ -23,16 +23,12 @@ export async function createTokenBridgePrepareCustomFeeTokenApprovalTransactionR
   publicClient,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareCustomFeeTokenApprovalTransactionRequestParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
+  const chainId = validateParentChain(publicClient);
 
   const request = await approvePrepareTransactionRequest({
     address: nativeToken,
     owner,
-    spender: tokenBridgeCreatorAddressOverride ?? tokenBridgeCreator.address[chainId],
+    spender: tokenBridgeCreatorAddressOverride ?? getTokenBridgeCreatorAddress(publicClient),
     amount,
     publicClient,
   });

diff --git a/src/createTokenBridgePrepareSetWethGatewayTransactionRequest.ts b/src/createTokenBridgePrepareSetWethGatewayTransactionRequest.ts
@@ -8,7 +8,7 @@ import { publicClientToProvider } from './ethers-compat/publicClientToProvider';
 import { getEstimateForSettingGateway } from './createTokenBridge-ethers';
 import { GasOverrideOptions, applyPercentIncrease } from './utils/gasOverrides';
 import { Prettify } from './types/utils';
-import { validParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import { WithTokenBridgeCreatorAddressOverride } from './types/createTokenBridgeTypes';
 
 export type TransactionRequestRetryableGasOverrides = {
@@ -96,11 +96,7 @@ export async function createTokenBridgePrepareSetWethGatewayTransactionRequest({
   retryableGasOverrides,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareRegisterWethGatewayTransactionRequestParams) {
-  const chainId = parentChainPublicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
+  const chainId = validateParentChain(parentChainPublicClient);
 
   // check for custom fee token chain
   if (

diff --git a/src/createTokenBridgePrepareTransactionRequest.ts b/src/createTokenBridgePrepareTransactionRequest.ts
@@ -1,7 +1,7 @@
 import { Address, PublicClient, encodeFunctionData } from 'viem';
 
 import { tokenBridgeCreator } from './contracts';
-import { validParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import { createTokenBridgeGetInputs } from './createTokenBridge-ethers';
 import { publicClientToProvider } from './ethers-compat/publicClientToProvider';
 import { isCustomFeeTokenChain } from './utils/isCustomFeeTokenChain';
@@ -13,6 +13,7 @@ import {
 
 import { Prettify } from './types/utils';
 import { WithTokenBridgeCreatorAddressOverride } from './types/createTokenBridgeTypes';
+import { getTokenBridgeCreatorAddress } from './utils/getters';
 
 export type TransactionRequestRetryableGasOverrides = {
   maxSubmissionCostForFactory?: GasOverrideOptions;
@@ -42,14 +43,10 @@ export async function createTokenBridgePrepareTransactionRequest({
   retryableGasOverrides,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareTransactionRequestParams) {
-  const chainId = parentChainPublicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
+  const chainId = validateParentChain(parentChainPublicClient);
 
   const tokenBridgeCreatorAddress =
-    tokenBridgeCreatorAddressOverride ?? tokenBridgeCreator.address[chainId];
+    tokenBridgeCreatorAddressOverride ?? getTokenBridgeCreatorAddress(parentChainPublicClient);
 
   const parentChainProvider = publicClientToProvider(parentChainPublicClient);
   const orbitChainProvider = publicClientToProvider(orbitChainPublicClient);

diff --git a/src/prepareNodeConfig.ts b/src/prepareNodeConfig.ts
@@ -5,7 +5,7 @@ import {
 } from './types/NodeConfig';
 import { ChainConfig } from './types/ChainConfig';
 import { CoreContracts } from './types/CoreContracts';
-import { ParentChainId, validParentChainId } from './types/ParentChain';
+import { ParentChainId, validateParentChain } from './types/ParentChain';
 import {
   mainnet,
   arbitrumOne,
@@ -66,17 +66,13 @@ export function prepareNodeConfig({
   parentChainId: number;
   parentChainRpcUrl: string;
 }): NodeConfig {
-  if (!validParentChainId(parentChainId)) {
-    throw new Error(`[prepareNodeConfig] invalid parent chain id: ${parentChainId}`);
-  }
-
   const config: NodeConfig = {
     'chain': {
       'info-json': stringifyInfoJson([
         {
           'chain-id': chainConfig.chainId,
           'parent-chain-id': parentChainId,
-          'parent-chain-is-arbitrum': parentChainIsArbitrum(parentChainId),
+          'parent-chain-is-arbitrum': parentChainIsArbitrum(validateParentChain(parentChainId)),
           'chain-name': chainName,
           'chain-config': chainConfig,
           'rollup': {

diff --git a/src/setValidKeyset.ts b/src/setValidKeyset.ts
@@ -1,7 +1,7 @@
 import { PublicClient, WalletClient } from 'viem';
 
 import { upgradeExecutor } from './contracts';
-import { validParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import { CoreContracts } from './types/CoreContracts';
 import { setValidKeysetEncodeFunctionData } from './setValidKeysetEncodeFunctionData';
 
@@ -18,13 +18,9 @@ export async function setValidKeyset({
   publicClient,
   walletClient,
 }: SetValidKeysetParams) {
-  const chainId = publicClient.chain?.id;
+  validateParentChain(publicClient);
   const account = walletClient.account?.address;
 
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   if (typeof account === 'undefined') {
     throw new Error('account is undefined');
   }

diff --git a/src/setValidKeysetPrepareTransactionRequest.ts b/src/setValidKeysetPrepareTransactionRequest.ts
@@ -1,6 +1,6 @@
 import { Address } from 'viem';
 
-import { validParentChainId } from './types/ParentChain';
+import { validateParentChain } from './types/ParentChain';
 import { SetValidKeysetParams } from './setValidKeyset';
 import { setValidKeysetEncodeFunctionData } from './setValidKeysetEncodeFunctionData';
 import { upgradeExecutorEncodeFunctionData } from './upgradeExecutor';
@@ -18,11 +18,7 @@ export async function setValidKeysetPrepareTransactionRequest({
   account,
   publicClient,
 }: SetValidKeysetPrepareTransactionRequestParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
+  const chainId = validateParentChain(publicClient);
 
   const request = await publicClient.prepareTransactionRequest({
     chain: publicClient.chain,