Feat: Add v1 upgradeExecutor setters

Author: chrstph-dvx

src/actions/buildAddExecutor.ts

@@ -0,0 +1,43 @@
+import { Address, Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
+import { upgradeExecutorABI } from '../contracts/UpgradeExecutor';
+import {
+  ActionParameters,
+  PrepareTransactionRequestReturnTypeWithChainId,
+  WithAccount,
+} from '../types/Actions';
+import { Prettify } from '../types/utils';
+import { UPGRADE_EXECUTOR_ROLE_EXECUTOR } from '../upgradeExecutorEncodeFunctionData';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
+
+export type BuildAddExecutorParameters<Curried extends boolean = false> = Prettify<
+  WithAccount<
+    ActionParameters<
+      {
+        address: Address;
+      },
+      'upgradeExecutor',
+      Curried
+    >
+  >
+>;
+
+export type BuildAddExecutorReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+
+export async function buildAddExecutor<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  { account, upgradeExecutor: upgradeExecutorAddress, params }: BuildAddExecutorParameters,
+): Promise<BuildAddExecutorReturnType> {
+  const request = await client.prepareTransactionRequest({
+    chain: client.chain as Chain | undefined,
+    account,
+    ...prepareUpgradeExecutorCallParameters({
+      to: upgradeExecutorAddress,
+      upgradeExecutor: upgradeExecutorAddress,
+      args: [UPGRADE_EXECUTOR_ROLE_EXECUTOR, params.address],
+      abi: upgradeExecutorABI,
+      functionName: 'grantRole',
+    }),
+  } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: client.chain.id };
+}

src/actions/buildRemoveExecutor.ts

@@ -0,0 +1,43 @@
+import { Address, Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
+import { upgradeExecutorABI } from '../contracts/UpgradeExecutor';
+import {
+  ActionParameters,
+  PrepareTransactionRequestReturnTypeWithChainId,
+  WithAccount,
+} from '../types/Actions';
+import { Prettify } from '../types/utils';
+import { UPGRADE_EXECUTOR_ROLE_EXECUTOR } from '../upgradeExecutorEncodeFunctionData';
+import { prepareUpgradeExecutorCallParameters } from '../prepareUpgradeExecutorCallParameters';
+
+export type BuildRemoveExecutorParameters<Curried extends boolean = false> = Prettify<
+  WithAccount<
+    ActionParameters<
+      {
+        address: Address;
+      },
+      'upgradeExecutor',
+      Curried
+    >
+  >
+>;
+
+export type BuildRemoveExecutorReturnType = PrepareTransactionRequestReturnTypeWithChainId;
+
+export async function buildRemoveExecutor<TChain extends Chain>(
+  client: PublicClient<Transport, TChain>,
+  { account, upgradeExecutor: upgradeExecutorAddress, params }: BuildRemoveExecutorParameters,
+): Promise<BuildRemoveExecutorReturnType> {
+  const request = await client.prepareTransactionRequest({
+    chain: client.chain as Chain | undefined,
+    account,
+    ...prepareUpgradeExecutorCallParameters({
+      to: upgradeExecutorAddress,
+      upgradeExecutor: upgradeExecutorAddress,
+      args: [UPGRADE_EXECUTOR_ROLE_EXECUTOR, params.address],
+      abi: upgradeExecutorABI,
+      functionName: 'revokeRole',
+    }),
+  } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: client.chain.id };
+}

src/prepareUpgradeExecutorCallParameters.ts

@@ -10,8 +10,9 @@ import {
   upgradeExecutorEncodeFunctionData,
   UpgradeExecutorFunctionName,
 } from './upgradeExecutorEncodeFunctionData';
+import { upgradeExecutorABI } from './contracts/UpgradeExecutor';
 
-type ABIs = typeof sequencerInboxABI | typeof arbOwnerABI;
+type ABIs = typeof sequencerInboxABI | typeof arbOwnerABI | typeof upgradeExecutorABI;
 type FunctionName<TAbi extends ABIs> = GetFunctionName<TAbi>;
 
 type EncodeFunctionDataParameters<