Cleanup, rename setters to buildX

OffchainLabs · Sep 18, 2024 · a61fb2a · a61fb2a
1 parent 6fe99d3
commit a61fb2a
Show file tree

Hide file tree

Showing 16 changed files with 190 additions and 453 deletions.
diff --git a/src/actions/setConfirmPeriodBlocks.ts → src/actions/buildSetConfirmPeriodBlocks.ts b/src/actions/setConfirmPeriodBlocks.ts → src/actions/buildSetConfirmPeriodBlocks.ts
@@ -1,5 +1,5 @@
 import { Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
-import { rollupAdminLogic } from '../contracts';
+import { rollupABI } from '../contracts/Rollup';
 import {
   WithAccount,
   ActionParameters,
@@ -9,32 +9,32 @@ import {
 import { Prettify } from '../types/utils';
 import { getRollupAddress } from '../getRollupAddress';
 import { validateParentChainPublicClient } from '../types/ParentChain';
-import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
 
-export type SetConfirmPeriodBlocksParameters<Curried extends boolean = false> = Prettify<
+export type BuildSetConfirmPeriodBlocksParameters<Curried extends boolean = false> = Prettify<
   WithUpgradeExecutor<
     WithAccount<ActionParameters<{ newPeriod: bigint }, 'rollupAdminLogic', Curried>>
   >
 >;
 
-export type SetConfirmPeriodBlocksReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+export type BuildSetConfirmPeriodBlocksReturnType = PrepareTransactionRequestReturnTypeWithChainId;
 
-export async function setConfirmPeriodBlocks<TChain extends Chain | undefined>(
+export async function buildSetConfirmPeriodBlocks<TChain extends Chain>(
   client: PublicClient<Transport, TChain>,
-  params: SetConfirmPeriodBlocksParameters,
-): Promise<SetConfirmPeriodBlocksReturnType> {
+  { params, account, upgradeExecutor, ...args }: BuildSetConfirmPeriodBlocksParameters,
+): Promise<BuildSetConfirmPeriodBlocksReturnType> {
   const validatedPublicClient = validateParentChainPublicClient(client);
-  const rollupAdminLogicAddresss = await getRollupAddress(client, params);
-  const { account, upgradeExecutor, newPeriod } = params;
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
 
   const request = await client.prepareTransactionRequest({
-    chain: client.chain,
+    chain: client.chain as Chain | undefined,
     account,
-    ...withUpgradeExecutor({
-      to: rollupAdminLogicAddresss,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
       upgradeExecutor,
-      args: [newPeriod],
-      abi: rollupAdminLogic.abi,
+      args: [params.newPeriod],
+      abi: rollupABI,
       functionName: 'setConfirmPeriodBlocks',
     }),
   } satisfies PrepareTransactionRequestParameters);

diff --git a/src/actions/setExtraChallengeTimeBlocks.ts → ...tions/buildSetExtraChallengeTimeBlocks.ts b/src/actions/setExtraChallengeTimeBlocks.ts → ...tions/buildSetExtraChallengeTimeBlocks.ts
@@ -1,5 +1,5 @@
 import { Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
-import { rollupAdminLogic } from '../contracts';
+import { rollupABI } from '../contracts/Rollup';
 import {
   WithAccount,
   ActionParameters,
@@ -9,32 +9,33 @@ import {
 import { Prettify } from '../types/utils';
 import { getRollupAddress } from '../getRollupAddress';
 import { validateParentChainPublicClient } from '../types/ParentChain';
-import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
 
-export type SetExtraChallengeTimeBlocksParameters<Curried extends boolean = false> = Prettify<
+export type BuildSetExtraChallengeTimeBlocksParameters<Curried extends boolean = false> = Prettify<
   WithUpgradeExecutor<
     WithAccount<ActionParameters<{ newExtraTimeBlocks: bigint }, 'rollupAdminLogic', Curried>>
   >
 >;
 
-export type SetExtraChallengeTimeBlocksReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+export type BuildSetExtraChallengeTimeBlocksReturnType =
+  PrepareTransactionRequestReturnTypeWithChainId;
 
-export async function setExtraChallengeTimeBlocks<TChain extends Chain | undefined>(
+export async function buildSetExtraChallengeTimeBlocks<TChain extends Chain>(
   client: PublicClient<Transport, TChain>,
-  params: SetExtraChallengeTimeBlocksParameters,
-): Promise<SetExtraChallengeTimeBlocksReturnType> {
+  { params, account, upgradeExecutor, ...args }: BuildSetExtraChallengeTimeBlocksParameters,
+): Promise<BuildSetExtraChallengeTimeBlocksReturnType> {
   const validatedPublicClient = validateParentChainPublicClient(client);
-  const rollupAdminLogicAddresss = await getRollupAddress(client, params);
-  const { account, upgradeExecutor, newExtraTimeBlocks } = params;
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
 
   const request = await client.prepareTransactionRequest({
-    chain: client.chain,
+    chain: client.chain as Chain | undefined,
     account,
-    ...withUpgradeExecutor({
-      to: rollupAdminLogicAddresss,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
       upgradeExecutor,
-      args: [newExtraTimeBlocks],
-      abi: rollupAdminLogic.abi,
+      args: [params.newExtraTimeBlocks],
+      abi: rollupABI,
       functionName: 'setExtraChallengeTimeBlocks',
     }),
   } satisfies PrepareTransactionRequestParameters);

diff --git a/src/actions/setMinimumAssertionPeriod.ts → ...actions/buildSetMinimumAssertionPeriod.ts b/src/actions/setMinimumAssertionPeriod.ts → ...actions/buildSetMinimumAssertionPeriod.ts
@@ -1,5 +1,5 @@
 import { Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
-import { rollupAdminLogic } from '../contracts';
+import { rollupABI } from '../contracts/Rollup';
 import {
   WithAccount,
   ActionParameters,
@@ -9,32 +9,33 @@ import {
 import { Prettify } from '../types/utils';
 import { getRollupAddress } from '../getRollupAddress';
 import { validateParentChainPublicClient } from '../types/ParentChain';
-import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
 
-export type SetMinimumAssertionPeriodParameters<Curried extends boolean = false> = Prettify<
+export type BuildSetMinimumAssertionPeriodParameters<Curried extends boolean = false> = Prettify<
   WithUpgradeExecutor<
     WithAccount<ActionParameters<{ newPeriod: bigint }, 'rollupAdminLogic', Curried>>
   >
 >;
 
-export type SetMinimumAssertionPeriodReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+export type BuildSetMinimumAssertionPeriodReturnType =
+  PrepareTransactionRequestReturnTypeWithChainId;
 
-export async function setMinimumAssertionPeriod<TChain extends Chain | undefined>(
+export async function setMinimumAssertionPeriod<TChain extends Chain>(
   client: PublicClient<Transport, TChain>,
-  params: SetMinimumAssertionPeriodParameters,
-): Promise<SetMinimumAssertionPeriodReturnType> {
+  { params, account, upgradeExecutor, ...args }: BuildSetMinimumAssertionPeriodParameters,
+): Promise<BuildSetMinimumAssertionPeriodReturnType> {
   const validatedPublicClient = validateParentChainPublicClient(client);
-  const rollupAdminLogicAddresss = await getRollupAddress(client, params);
-  const { account, upgradeExecutor, newPeriod } = params;
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
 
   const request = await client.prepareTransactionRequest({
-    chain: client.chain,
+    chain: client.chain as Chain | undefined,
     account,
-    ...withUpgradeExecutor({
-      to: rollupAdminLogicAddresss,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
       upgradeExecutor,
-      args: [newPeriod],
-      abi: rollupAdminLogic.abi,
+      args: [params.newPeriod],
+      abi: rollupABI,
       functionName: 'setMinimumAssertionPeriod',
     }),
   } satisfies PrepareTransactionRequestParameters);

diff --git a/src/actions/setValidator.ts → src/actions/buildSetValidator.ts b/src/actions/setValidator.ts → src/actions/buildSetValidator.ts
@@ -1,5 +1,5 @@
 import { Address, Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
-import { rollupAdminLogic } from '../contracts';
+import { rollupABI } from '../contracts/Rollup';
 import {
   WithAccount,
   ActionParameters,
@@ -9,9 +9,9 @@ import {
 import { Prettify } from '../types/utils';
 import { getRollupAddress } from '../getRollupAddress';
 import { validateParentChainPublicClient } from '../types/ParentChain';
-import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
 
-export type SetIsValidatorParameters<Curried extends boolean = false> = Prettify<
+export type BuildSetIsValidatorParameters<Curried extends boolean = false> = Prettify<
   WithUpgradeExecutor<
     WithAccount<
       ActionParameters<
@@ -26,27 +26,28 @@ export type SetIsValidatorParameters<Curried extends boolean = false> = Prettify
   >
 >;
 
-export type SetIsValidatorReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+export type BuildSetIsValidatorReturnType = PrepareTransactionRequestReturnTypeWithChainId;
 
-export async function setValidators<TChain extends Chain | undefined>(
+export async function buildSetValidators<TChain extends Chain>(
   client: PublicClient<Transport, TChain>,
-  params: SetIsValidatorParameters,
-): Promise<SetIsValidatorReturnType> {
+  { account, upgradeExecutor, params, ...args }: BuildSetIsValidatorParameters,
+): Promise<BuildSetIsValidatorReturnType> {
   const validatedPublicClient = validateParentChainPublicClient(client);
-  const rollupAdminLogicAddresss = await getRollupAddress(client, params);
-  const { account, upgradeExecutor, add: addressesToAdd, remove: addressesToRemove } = params;
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+  const { add: addressesToAdd, remove: addressesToRemove } = params;
 
   const addState: boolean[] = new Array(addressesToAdd.length).fill(true);
   const removeState: boolean[] = new Array(addressesToRemove.length).fill(false);
 
   const request = await client.prepareTransactionRequest({
-    chain: client.chain,
+    chain: client.chain as Chain | undefined,
     account,
-    ...withUpgradeExecutor({
-      to: rollupAdminLogicAddresss,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
       upgradeExecutor,
       args: [addressesToAdd.concat(addressesToRemove), addState.concat(removeState)],
-      abi: rollupAdminLogic.abi,
+      abi: rollupABI,
       functionName: 'setValidator',
     }),
   } satisfies PrepareTransactionRequestParameters);

diff --git a/src/actions/buildSetValidatorWhitelistDisabled.ts b/src/actions/buildSetValidatorWhitelistDisabled.ts
@@ -0,0 +1,70 @@
+import { Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import {
+  WithAccount,
+  ActionParameters,
+  WithUpgradeExecutor,
+  PrepareTransactionRequestReturnTypeWithChainId,
+} from '../types/Actions';
+import { Prettify } from '../types/utils';
+import { getRollupAddress } from '../getRollupAddress';
+import { validateParentChainPublicClient } from '../types/ParentChain';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
+
+export type BuildSetValidatorWhitelistDisabledParameters<Curried extends boolean = false> =
+  Prettify<WithUpgradeExecutor<WithAccount<ActionParameters<{}, 'rollupAdminLogic', Curried>>>>;
+
+export type BuildSetValidatorWhitelistDisabledReturnType =
+  PrepareTransactionRequestReturnTypeWithChainId;
+
+export async function buildSetValidatorWhitelistDisabled<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  {
+    account,
+    upgradeExecutor,
+    params,
+    ...args
+  }: BuildSetValidatorWhitelistDisabledParameters & { params: { enable: boolean } },
+): Promise<BuildSetValidatorWhitelistDisabledReturnType> {
+  const validatedPublicClient = validateParentChainPublicClient(client);
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+
+  const request = await client.prepareTransactionRequest({
+    chain: client.chain as Chain | undefined,
+    account,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
+      upgradeExecutor,
+      args: [params.enable],
+      abi: rollupABI,
+      functionName: 'setValidatorWhitelistDisabled',
+    }),
+  } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: validatedPublicClient.chain.id };
+}
+
+export async function buildEnableValidatorWhitelist<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: BuildSetValidatorWhitelistDisabledParameters,
+): Promise<BuildSetValidatorWhitelistDisabledReturnType> {
+  return buildSetValidatorWhitelistDisabled(client, {
+    ...args,
+    params: {
+      enable: true,
+    },
+  });
+}
+
+export async function buildDisableValidatorWhitelist<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: BuildSetValidatorWhitelistDisabledParameters,
+): Promise<BuildSetValidatorWhitelistDisabledReturnType> {
+  return buildSetValidatorWhitelistDisabled(client, {
+    ...args,
+    params: {
+      enable: false,
+    },
+  });
+}
diff --git a/src/actions/buildSetWasmModuleRoot.ts b/src/actions/buildSetWasmModuleRoot.ts
@@ -0,0 +1,51 @@
+import { Chain, Hex, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import {
+  WithAccount,
+  ActionParameters,
+  WithUpgradeExecutor,
+  PrepareTransactionRequestReturnTypeWithChainId,
+} from '../types/Actions';
+import { Prettify } from '../types/utils';
+import { getRollupAddress } from '../getRollupAddress';
+import { validateParentChainPublicClient } from '../types/ParentChain';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
+
+export type BuildSetWasmModuleRootParameters<Curried extends boolean = false> = Prettify<
+  WithUpgradeExecutor<
+    WithAccount<
+      ActionParameters<
+        {
+          newWasmModuleRoot: Hex;
+        },
+        'rollupAdminLogic',
+        Curried
+      >
+    >
+  >
+>;
+
+export type BuildSetWasmModuleRootReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+
+export async function buildSetWasmModuleRoot<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  { account, upgradeExecutor, params, ...args }: BuildSetWasmModuleRootParameters,
+): Promise<BuildSetWasmModuleRootReturnType> {
+  const validatedPublicClient = validateParentChainPublicClient(client);
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+
+  const request = await client.prepareTransactionRequest({
+    chain: client.chain as Chain | undefined,
+    account,
+    ...prepareUpgradeExecutorCallParameters({
+      to: rollupAdminLogicAddress,
+      upgradeExecutor,
+      args: [params.newWasmModuleRoot],
+      abi: rollupABI,
+      functionName: 'setWasmModuleRoot',
+    }),
+  } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: validatedPublicClient.chain.id };
+}
diff --git a/src/actions/invalidateKeysetHash.ts b/src/actions/invalidateKeysetHash.ts