Add WithContractAddress type

src/actions/getConfirmPeriodBlocks.ts

@@ -1,9 +1,9 @@
 import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
 import { rollupAdminLogic } from '../contracts';
-import { ActionParameters } from '../types/Actions';
+import { WithContractAddress } from '../types/Actions';
 import { getRollupAddress } from '../getRollupAddress';
 
-export type GetConfirmPeriodBlocksParameters<Curried extends boolean = false> = ActionParameters<
+export type GetConfirmPeriodBlocksParameters<Curried extends boolean = false> = WithContractAddress<
   {},
   'rollupAdminLogic',
   Curried

src/actions/getExtraChallengeTimeBlocks.ts

@@ -1,10 +1,10 @@
 import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
 import { rollupAdminLogic } from '../contracts';
-import { ActionParameters } from '../types/Actions';
+import { WithContractAddress } from '../types/Actions';
 import { getRollupAddress } from '../getRollupAddress';
 
 export type GetExtraChallengeTimeBlocksParameters<Curried extends boolean = false> =
-  ActionParameters<{}, 'rollupAdminLogic', Curried>;
+  WithContractAddress<{}, 'rollupAdminLogic', Curried>;
 
 export type GetExtraChallengeTimeBlocksReturnType = ReadContractReturnType<
   typeof rollupAdminLogic.abi,

src/actions/getMinimumAssertionPeriod.ts

@@ -1,13 +1,10 @@
 import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
 import { rollupAdminLogic } from '../contracts';
-import { ActionParameters } from '../types/Actions';
+import { WithContractAddress } from '../types/Actions';
 import { getRollupAddress } from '../getRollupAddress';
 
-export type GetMinimumAssertionPeriodParameters<Curried extends boolean = false> = ActionParameters<
-  {},
-  'rollupAdminLogic',
-  Curried
->;
+export type GetMinimumAssertionPeriodParameters<Curried extends boolean = false> =
+  WithContractAddress<{}, 'rollupAdminLogic', Curried>;
 
 export type GetMinimumAssertionPeriodReturnType = ReadContractReturnType<
   typeof rollupAdminLogic.abi,

src/actions/getWasmModuleRoot.ts

@@ -1,9 +1,9 @@
 import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
 import { rollupAdminLogic } from '../contracts';
-import { ActionParameters } from '../types/Actions';
+import { WithContractAddress } from '../types/Actions';
 import { getRollupAddress } from '../getRollupAddress';
 
-export type GetWasmModuleRootParameters<Curried extends boolean = false> = ActionParameters<
+export type GetWasmModuleRootParameters<Curried extends boolean = false> = WithContractAddress<
   {},
   'rollupAdminLogic',
   Curried

src/types/Actions.ts

@@ -20,3 +20,35 @@ export type ActionParameters<Args, ContractName extends string, Curried extends
         [key in ContractName]?: Address;
       }
 >;
+
+/**
+ * Some actions require a different contract than sequencerInbox.
+ * We either accept sequencerInbox to fetch the contract address
+ * or an override
+ */
+export type WithContractAddress<
+  Args,
+  ContractName extends string,
+  Curried extends boolean,
+> = Curried extends true
+  ? /**
+     * If sequencerInbox was passed to the decorator. We accept the contract address,
+     * an sequencerInbox override, or no parameters
+     */
+    | (Args & {
+          sequencerInbox?: Address;
+        })
+      | (Args & {
+          [key in ContractName]?: Address;
+        })
+      | void
+  : /**
+     * If sequencerInbox wasn't passed to the decorator. We need one of the address to be passed
+     * We either accept the contract address or an sequencerInbox override
+     */
+    | (Args & {
+          sequencerInbox: Address;
+        })
+      | (Args & {
+          [key in ContractName]: Address;
+        });