Feat: Add v1 SequencerInbox getters

Closes FS-535

src/actions/getMaxTimeVariation.ts

@@ -0,0 +1,33 @@
+import { Chain, PublicClient, Transport } from 'viem';
+import { sequencerInbox } from '../contracts';
+import { ActionParameters } from '../types/Actions';
+
+export type GetMaxTimeVariationParameters<Curried extends boolean = false> = ActionParameters<
+  {},
+  'sequencerInbox',
+  Curried
+>;
+
+export type GetMaxTimeVariationReturnType = {
+  delayBlocks: bigint;
+  futureBlocks: bigint;
+  delaySeconds: bigint;
+  futureSeconds: bigint;
+};
+
+export async function getMaxTimeVariation<TChain extends Chain | undefined>(
+  client: PublicClient<Transport, TChain>,
+  args: GetMaxTimeVariationParameters<false>,
+): Promise<GetMaxTimeVariationReturnType> {
+  const [delayBlocks, futureBlocks, delaySeconds, futureSeconds] = await client.readContract({
+    abi: sequencerInbox.abi,
+    functionName: 'maxTimeVariation',
+    address: args.sequencerInbox,
+  });
+  return {
+    delayBlocks,
+    futureBlocks,
+    delaySeconds,
+    futureSeconds,
+  };
+}

src/actions/isBatchPoster.ts

@@ -0,0 +1,27 @@
+import { Address, Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { sequencerInbox } from '../contracts';
+import { ActionParameters } from '../types/Actions';
+
+type Args = {
+  batchPoster: Address;
+};
+type SequencerInboxABI = typeof sequencerInbox.abi;
+export type IsBatchPosterParameters<Curried extends boolean = false> = ActionParameters<
+  Args,
+  'sequencerInbox',
+  Curried
+>;
+
+export type IsBatchPosterReturnType = ReadContractReturnType<SequencerInboxABI, 'isBatchPoster'>;
+
+export async function isBatchPoster<TChain extends Chain | undefined>(
+  client: PublicClient<Transport, TChain>,
+  args: IsBatchPosterParameters,
+): Promise<IsBatchPosterReturnType> {
+  return client.readContract({
+    abi: sequencerInbox.abi,
+    functionName: 'isBatchPoster',
+    address: args.sequencerInbox,
+    args: [args.batchPoster],
+  });
+}

src/actions/isValidKeysetHash.ts

@@ -0,0 +1,31 @@
+import { Chain, Hex, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { sequencerInbox } from '../contracts';
+import { ActionParameters } from '../types/Actions';
+
+type Args = {
+  keysetHash: Hex;
+};
+type SequencerInboxABI = typeof sequencerInbox.abi;
+
+export type IsValidKeysetHashParameters<Curried extends boolean = false> = ActionParameters<
+  Args,
+  'sequencerInbox',
+  Curried
+>;
+
+export type IsValidKeysetHashReturnType = ReadContractReturnType<
+  SequencerInboxABI,
+  'isValidKeysetHash'
+>;
+
+export async function isValidKeysetHash<TChain extends Chain | undefined>(
+  client: PublicClient<Transport, TChain>,
+  args: IsValidKeysetHashParameters,
+): Promise<IsValidKeysetHashReturnType> {
+  return client.readContract({
+    abi: sequencerInbox.abi,
+    functionName: 'isValidKeysetHash',
+    address: args.sequencerInbox,
+    args: [args.keysetHash],
+  });
+}

src/types/Actions.ts

@@ -0,0 +1,45 @@
+import { Address } from 'viem';
+import { Prettify } from './utils';
+
+type RemoveUndefinedArgs<T> = T extends { args?: undefined } ? Omit<T, 'args'> : T;
+
+/**
+ * If the function has no args, `GetFunctionArgs` returns `{ args?: undefined }`
+ * we remove args from the returned type
+ *
+ * Contract address is required if no contract address was passed to the actions, otherwise it's optional
+ */
+export type WithContractAddress<
+  Args,
+  ContractName extends string,
+  Curried extends boolean = false,
+> = Prettify<
+  RemoveUndefinedArgs<
+    Args &
+      (Curried extends true
+        ? {
+            [key in ContractName]?: Address;
+          }
+        : { [key in ContractName]: Address })
+  >
+>;
+
+/**
+ * Actions require contract address, but as part of decorators, the address might have been passed already to the decorator.
+ *
+ * If the address was passed to the decorator, it's now optional (we still allow overrides of the address per action).
+ * If the action doesn't have any other parameters beside the contract address, then parameters can either be { contract: address } or void
+ */
+export type ActionParameters<Args, ContractName extends string, Curried extends boolean> = Prettify<
+  Curried extends false
+    ? RemoveUndefinedArgs<Args & { [key in ContractName]: Address }>
+    : Args extends { args?: undefined }
+    ?
+        | {
+            [key in ContractName]: Address;
+          }
+        | void
+    : Args & {
+        [key in ContractName]?: Address;
+      }
+>;