refactor: return object from parent chain validator (#207)

OffchainLabs · Oct 8, 2024 · f225ca0 · f225ca0
1 parent ad7ed7f
commit f225ca0
Show file tree

Hide file tree

Showing 21 changed files with 24 additions and 22 deletions.
diff --git a/src/actions/buildInvalidateKeysetHash.ts b/src/actions/buildInvalidateKeysetHash.ts
@@ -35,7 +35,7 @@ export async function buildInvalidateKeysetHash<TChain extends Chain | undefined
     params,
   }: BuildInvalidateKeysetHashParameters,
 ): Promise<BuildInvalidateKeysetHashReturnType> {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   const request = await client.prepareTransactionRequest({
     chain: client.chain,

diff --git a/src/actions/buildSetIsBatchPoster.ts b/src/actions/buildSetIsBatchPoster.ts
@@ -29,7 +29,7 @@ export async function buildSetIsBatchPoster<TChain extends Chain | undefined>(
     params,
   }: BuildSetIsBatchPosterParameters & { params: { enable: boolean } },
 ): Promise<BuildSetIsBatchPosterReturnType> {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   const request = await client.prepareTransactionRequest({
     chain: client.chain,

diff --git a/src/actions/buildSetMaxTimeVariation.ts b/src/actions/buildSetMaxTimeVariation.ts
@@ -31,7 +31,7 @@ export async function buildSetMaxTimeVariation<TChain extends Chain | undefined>
     params,
   }: BuildSetMaxTimeVariationParameters,
 ): Promise<BuildSetMaxTimeVariationReturnType> {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   const request = await client.prepareTransactionRequest({
     chain: client.chain,

diff --git a/src/actions/buildSetValidKeyset.ts b/src/actions/buildSetValidKeyset.ts
@@ -35,7 +35,7 @@ export async function buildSetValidKeyset<TChain extends Chain | undefined>(
     params,
   }: BuildSetValidKeysetParameters,
 ): Promise<BuildSetValidKeysetReturnType> {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   const request = await client.prepareTransactionRequest({
     chain: client.chain,

diff --git a/src/createRollupFetchTransactionHash.ts b/src/createRollupFetchTransactionHash.ts
@@ -62,7 +62,7 @@ export async function createRollupFetchTransactionHash<TChain extends Chain | un
   rollup,
   publicClient,
 }: CreateRollupFetchTransactionHashParams<TChain>) {
-  const chainId = validateParentChain(publicClient);
+  const { chainId } = validateParentChain(publicClient);
 
   const fromBlock =
     chainId in earliestRollupCreatorDeploymentBlockNumber

diff --git a/src/createRollupPrepareCustomFeeTokenApprovalTransactionRequest.ts b/src/createRollupPrepareCustomFeeTokenApprovalTransactionRequest.ts
@@ -31,7 +31,7 @@ export async function createRollupPrepareCustomFeeTokenApprovalTransactionReques
   publicClient,
   rollupCreatorAddressOverride,
 }: CreateRollupPrepareCustomFeeTokenApprovalTransactionRequestParams<TChain>) {
-  const chainId = validateParentChain(publicClient);
+  const { chainId } = validateParentChain(publicClient);
 
   const fees = await createRollupGetRetryablesFeesWithDefaults(publicClient, {
     account,

diff --git a/src/createRollupPrepareDeploymentParamsConfig.ts b/src/createRollupPrepareDeploymentParamsConfig.ts
@@ -67,7 +67,7 @@ export function createRollupPrepareDeploymentParamsConfig<TChain extends Chain |
   client: Client<Transport, TChain>,
   { chainConfig, ...params }: CreateRollupPrepareDeploymentParamsConfigParams,
 ): CreateRollupPrepareDeploymentParamsConfigResult {
-  const parentChainId = validateParentChain(client);
+  const { chainId: parentChainId } = validateParentChain(client);
 
   const defaultsBasedOnParentChain = {
     confirmPeriodBlocks: getDefaultConfirmPeriodBlocks(parentChainId),

diff --git a/src/createRollupPrepareTransactionRequest.ts b/src/createRollupPrepareTransactionRequest.ts
@@ -47,7 +47,7 @@ export async function createRollupPrepareTransactionRequest<TChain extends Chain
   gasOverrides,
   rollupCreatorAddressOverride,
 }: CreateRollupPrepareTransactionRequestParams<TChain>) {
-  const chainId = validateParentChain(publicClient);
+  const { chainId } = validateParentChain(publicClient);
 
   if (params.batchPosters.length === 0 || params.batchPosters.includes(zeroAddress)) {
     throw new Error(`"params.batchPosters" can't be empty or contain the zero address.`);

diff --git a/src/createTokenBridgePrepareCustomFeeTokenApprovalTransactionRequest.ts b/src/createTokenBridgePrepareCustomFeeTokenApprovalTransactionRequest.ts
@@ -28,7 +28,7 @@ export async function createTokenBridgePrepareCustomFeeTokenApprovalTransactionR
   publicClient,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareCustomFeeTokenApprovalTransactionRequestParams<TChain>) {
-  const chainId = validateParentChain(publicClient);
+  const { chainId } = validateParentChain(publicClient);
 
   const request = await approvePrepareTransactionRequest({
     address: nativeToken,

diff --git a/src/createTokenBridgePrepareSetWethGatewayTransactionRequest.ts b/src/createTokenBridgePrepareSetWethGatewayTransactionRequest.ts
@@ -103,7 +103,7 @@ export async function createTokenBridgePrepareSetWethGatewayTransactionRequest<
   retryableGasOverrides,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareRegisterWethGatewayTransactionRequestParams<TParentChain, TOrbitChain>) {
-  const chainId = validateParentChain(parentChainPublicClient);
+  const { chainId } = validateParentChain(parentChainPublicClient);
 
   // Ensure that networks are registered
   await registerNewNetwork(

diff --git a/src/createTokenBridgePrepareTransactionRequest.ts b/src/createTokenBridgePrepareTransactionRequest.ts
@@ -49,7 +49,7 @@ export async function createTokenBridgePrepareTransactionRequest<
   retryableGasOverrides,
   tokenBridgeCreatorAddressOverride,
 }: CreateTokenBridgePrepareTransactionRequestParams<TParentChain, TOrbitChain>) {
-  const chainId = validateParentChain(parentChainPublicClient);
+  const { chainId } = validateParentChain(parentChainPublicClient);
 
   const isTokenBridgeAlreadyDeployed = await isTokenBridgeDeployed({
     parentChainPublicClient,

diff --git a/src/getDefaultConfirmPeriodBlocks.ts b/src/getDefaultConfirmPeriodBlocks.ts
@@ -7,7 +7,7 @@ import { base, baseSepolia } from './chains';
 export function getDefaultConfirmPeriodBlocks<TChain extends Chain | undefined>(
   parentChainIdOrClient: ParentChainId | Client<Transport, TChain>,
 ): bigint {
-  const parentChainId = validateParentChain(parentChainIdOrClient);
+  const { chainId: parentChainId } = validateParentChain(parentChainIdOrClient);
 
   const isMainnet = parentChainIsMainnet(parentChainId);
   const confirmPeriodBlocks = isMainnet ? 45_818n : 150n;

diff --git a/src/getDefaultSequencerInboxMaxTimeVariation.ts b/src/getDefaultSequencerInboxMaxTimeVariation.ts
@@ -13,7 +13,7 @@ export type SequencerInboxMaxTimeVariation = {
 export function getDefaultSequencerInboxMaxTimeVariation<TChain extends Chain | undefined>(
   parentChainIdOrClient: ParentChainId | Client<Transport, TChain>,
 ): SequencerInboxMaxTimeVariation {
-  const parentChainId = validateParentChain(parentChainIdOrClient);
+  const { chainId: parentChainId } = validateParentChain(parentChainIdOrClient);
 
   const delaySeconds = 60 * 60 * 24 * 4; // 4 days;
   const futureSeconds = 60 * 60; // 1 hour;

diff --git a/src/prepareNodeConfig.ts b/src/prepareNodeConfig.ts
@@ -60,13 +60,15 @@ export function prepareNodeConfig({
     throw new Error(`"parentChainBeaconRpcUrl" is required for L2 Orbit chains.`);
   }
 
+  const { chainId: parentChainIdValidated } = validateParentChain(parentChainId);
+
   const config: NodeConfig = {
     'chain': {
       'info-json': stringifyInfoJson([
         {
           'chain-id': chainConfig.chainId,
           'parent-chain-id': parentChainId,
-          'parent-chain-is-arbitrum': parentChainIsArbitrum(validateParentChain(parentChainId)),
+          'parent-chain-is-arbitrum': parentChainIsArbitrum(parentChainIdValidated),
           'chain-name': chainName,
           'chain-config': chainConfig,
           'rollup': {

diff --git a/src/rollupAdminLogicPrepareTransactionRequest.ts b/src/rollupAdminLogicPrepareTransactionRequest.ts
@@ -83,7 +83,7 @@ export async function rollupAdminLogicPrepareTransactionRequest<
   client: PublicClient<TTransport, TChain>,
   params: RollupAdminLogicPrepareTransactionRequestParameters<TFunctionName>,
 ) {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   // params is extending RollupAdminLogicPrepareFunctionDataParameters, it's safe to cast
   const { to, data, value } = rollupAdminLogicPrepareFunctionData({

diff --git a/src/sequencerInboxPrepareTransactionRequest.ts b/src/sequencerInboxPrepareTransactionRequest.ts
@@ -80,7 +80,7 @@ export async function sequencerInboxPrepareTransactionRequest<
   client: PublicClient<TTransport, TChain>,
   params: SequencerInboxPrepareTransactionRequestParameters<TFunctionName>,
 ) {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   // params is extending SequencerInboxPrepareFunctionDataParameters, it's safe to cast
   const { to, data, value } = sequencerInboxPrepareFunctionData({

diff --git a/src/setValidKeysetPrepareTransactionRequest.ts b/src/setValidKeysetPrepareTransactionRequest.ts
@@ -18,7 +18,7 @@ export async function setValidKeysetPrepareTransactionRequest<TChain extends Cha
   account,
   publicClient,
 }: SetValidKeysetPrepareTransactionRequestParams<TChain>) {
-  const chainId = validateParentChain(publicClient);
+  const { chainId } = validateParentChain(publicClient);
 
   // @ts-ignore (todo: fix viem type issue)
   const request = await publicClient.prepareTransactionRequest({

diff --git a/src/types/ParentChain.ts b/src/types/ParentChain.ts
@@ -16,12 +16,12 @@ function isValidParentChainId(parentChainId: number | undefined): parentChainId
 
 export function validateParentChain<TChain extends Chain | undefined>(
   chainIdOrClient: number | Client<Transport, TChain>,
-): ParentChainId {
+): { chainId: ParentChainId } {
   const chainId = typeof chainIdOrClient === 'number' ? chainIdOrClient : chainIdOrClient.chain?.id;
 
   if (!isValidParentChainId(chainId)) {
     throw new Error(`Parent chain not supported: ${chainId}`);
   }
 
-  return chainId;
+  return { chainId };
 }
diff --git a/src/utils/getParentChainFromId.ts b/src/utils/getParentChainFromId.ts
@@ -4,7 +4,7 @@ import { chains } from '../chains';
 import { ParentChain, validateParentChain } from '../types/ParentChain';
 
 export function getParentChainFromId(chainId: number): ParentChain {
-  const parentChainId = validateParentChain(chainId);
+  const { chainId: parentChainId } = validateParentChain(chainId);
 
   return extractChain({
     chains,

diff --git a/src/utils/getRollupCreatorAddress.ts b/src/utils/getRollupCreatorAddress.ts
@@ -6,7 +6,7 @@ import { validateParentChain } from '../types/ParentChain';
 export function getRollupCreatorAddress<TChain extends Chain | undefined>(
   client: Client<Transport, TChain>,
 ) {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   if (!rollupCreatorAddress[chainId]) {
     throw new Error(`Parent chain not supported: ${chainId}`);

diff --git a/src/utils/getTokenBridgeCreatorAddress.ts b/src/utils/getTokenBridgeCreatorAddress.ts
@@ -6,7 +6,7 @@ import { validateParentChain } from '../types/ParentChain';
 export function getTokenBridgeCreatorAddress<TChain extends Chain | undefined>(
   client: Client<Transport, TChain>,
 ) {
-  const chainId = validateParentChain(client);
+  const { chainId } = validateParentChain(client);
 
   if (!tokenBridgeCreatorAddress[chainId]) {
     throw new Error(`Parent chain not supported: ${chainId}`);