From a68acd38c566d60ad8a3cf06cdec3ae386d1eff1 Mon Sep 17 00:00:00 2001
From: Christophe <contact@christophedeveaux.com>
Date: Thu, 27 Jun 2024 20:12:43 +0000
Subject: [PATCH] Feat: Add v1 RollupAdminLogic getters

Closes FS-620
---
 src/actions/getConfirmPeriodBlocks.ts      | 29 ++++++++++++++++++++
 src/actions/getExtraChallengeTimeBlocks.ts | 25 +++++++++++++++++
 src/actions/getMinimumAssertionPeriod.ts   | 25 +++++++++++++++++
 src/actions/getWasmModuleRoot.ts           | 28 +++++++++++++++++++
 src/getRollupAddress.ts                    | 22 +++++++++++++++
 src/types/Actions.ts                       | 32 ++++++++++++++++++++++
 6 files changed, 161 insertions(+)
 create mode 100644 src/actions/getConfirmPeriodBlocks.ts
 create mode 100644 src/actions/getExtraChallengeTimeBlocks.ts
 create mode 100644 src/actions/getMinimumAssertionPeriod.ts
 create mode 100644 src/actions/getWasmModuleRoot.ts
 create mode 100644 src/getRollupAddress.ts

diff --git a/src/actions/getConfirmPeriodBlocks.ts b/src/actions/getConfirmPeriodBlocks.ts
new file mode 100644
index 00000000..82c5981f
--- /dev/null
+++ b/src/actions/getConfirmPeriodBlocks.ts
@@ -0,0 +1,29 @@
+import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import { WithContractAddress } from '../types/Actions';
+import { getRollupAddress } from '../getRollupAddress';
+
+export type GetConfirmPeriodBlocksParameters<Curried extends boolean = false> = WithContractAddress<
+  {},
+  'rollupAdminLogic',
+  Curried
+>;
+
+export type GetConfirmPeriodBlocksReturnType = ReadContractReturnType<
+  typeof rollupABI,
+  'confirmPeriodBlocks'
+>;
+
+export async function getConfirmPeriodBlocks<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: GetConfirmPeriodBlocksParameters,
+): Promise<GetConfirmPeriodBlocksReturnType> {
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+
+  return client.readContract({
+    abi: rollupABI,
+    functionName: 'confirmPeriodBlocks',
+    address: rollupAdminLogicAddress,
+  });
+}
diff --git a/src/actions/getExtraChallengeTimeBlocks.ts b/src/actions/getExtraChallengeTimeBlocks.ts
new file mode 100644
index 00000000..0a9cd4ac
--- /dev/null
+++ b/src/actions/getExtraChallengeTimeBlocks.ts
@@ -0,0 +1,25 @@
+import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import { WithContractAddress } from '../types/Actions';
+import { getRollupAddress } from '../getRollupAddress';
+
+export type GetExtraChallengeTimeBlocksParameters<Curried extends boolean = false> =
+  WithContractAddress<{}, 'rollupAdminLogic', Curried>;
+
+export type GetExtraChallengeTimeBlocksReturnType = ReadContractReturnType<
+  typeof rollupABI,
+  'extraChallengeTimeBlocks'
+>;
+
+export async function getExtraChallengeTimeBlocks<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: GetExtraChallengeTimeBlocksParameters,
+): Promise<GetExtraChallengeTimeBlocksReturnType> {
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+  return client.readContract({
+    abi: rollupABI,
+    functionName: 'extraChallengeTimeBlocks',
+    address: rollupAdminLogicAddress,
+  });
+}
diff --git a/src/actions/getMinimumAssertionPeriod.ts b/src/actions/getMinimumAssertionPeriod.ts
new file mode 100644
index 00000000..b9612711
--- /dev/null
+++ b/src/actions/getMinimumAssertionPeriod.ts
@@ -0,0 +1,25 @@
+import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import { WithContractAddress } from '../types/Actions';
+import { getRollupAddress } from '../getRollupAddress';
+
+export type GetMinimumAssertionPeriodParameters<Curried extends boolean = false> =
+  WithContractAddress<{}, 'rollupAdminLogic', Curried>;
+
+export type GetMinimumAssertionPeriodReturnType = ReadContractReturnType<
+  typeof rollupABI,
+  'minimumAssertionPeriod'
+>;
+
+export async function getMinimumAssertionPeriod<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: GetMinimumAssertionPeriodParameters,
+): Promise<GetMinimumAssertionPeriodReturnType> {
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+  return client.readContract({
+    abi: rollupABI,
+    functionName: 'minimumAssertionPeriod',
+    address: rollupAdminLogicAddress,
+  });
+}
diff --git a/src/actions/getWasmModuleRoot.ts b/src/actions/getWasmModuleRoot.ts
new file mode 100644
index 00000000..4d5f2ea8
--- /dev/null
+++ b/src/actions/getWasmModuleRoot.ts
@@ -0,0 +1,28 @@
+import { Chain, PublicClient, ReadContractReturnType, Transport } from 'viem';
+import { rollupABI } from '../contracts/Rollup';
+import { WithContractAddress } from '../types/Actions';
+import { getRollupAddress } from '../getRollupAddress';
+
+export type GetWasmModuleRootParameters<Curried extends boolean = false> = WithContractAddress<
+  {},
+  'rollupAdminLogic',
+  Curried
+>;
+
+export type GetWasmModuleRootReturnType = ReadContractReturnType<
+  typeof rollupABI,
+  'wasmModuleRoot'
+>;
+
+export async function getWasmModuleRoot<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  args: GetWasmModuleRootParameters,
+): Promise<GetWasmModuleRootReturnType> {
+  const rollupAdminLogicAddress =
+    'sequencerInbox' in args ? await getRollupAddress(client, args) : args.rollupAdminLogic;
+  return client.readContract({
+    abi: rollupABI,
+    functionName: 'wasmModuleRoot',
+    address: rollupAdminLogicAddress,
+  });
+}
diff --git a/src/getRollupAddress.ts b/src/getRollupAddress.ts
new file mode 100644
index 00000000..59a7428b
--- /dev/null
+++ b/src/getRollupAddress.ts
@@ -0,0 +1,22 @@
+import { Address, Chain, PublicClient, Transport } from 'viem';
+import { sequencerInboxABI } from './contracts/SequencerInbox';
+
+const cache: Record<string, Address> = {};
+export async function getRollupAddress<TChain extends Chain>(
+  publicClient: PublicClient<Transport, TChain>,
+  params: { sequencerInbox: Address },
+): Promise<Address> {
+  const addressFromCache = cache[`${publicClient.chain.id}_${params.sequencerInbox}`];
+  if (addressFromCache) {
+    return addressFromCache;
+  }
+
+  // Otherwise, fetch the rollup address from sequencerInbox contract
+  const rollupAddress = await publicClient.readContract({
+    functionName: 'rollup',
+    address: params.sequencerInbox,
+    abi: sequencerInboxABI,
+  });
+  cache[`${publicClient.chain.id}_${params.sequencerInbox}`] = rollupAddress;
+  return rollupAddress;
+}
diff --git a/src/types/Actions.ts b/src/types/Actions.ts
index 71093865..9a89614f 100644
--- a/src/types/Actions.ts
+++ b/src/types/Actions.ts
@@ -30,3 +30,35 @@ export type WithUpgradeExecutor<Args> = Args & {
 export type PrepareTransactionRequestReturnTypeWithChainId = PrepareTransactionRequestReturnType & {
   chainId: number;
 };
+
+/**
+ * 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;
+        });