Add upgradeExecutor flag

src/actions/setIsbatchPoster.ts

@@ -1,49 +1,45 @@
-import {
-  Address,
-  Chain,
-  PrepareTransactionRequestParameters,
-  PrepareTransactionRequestReturnType,
-  PublicClient,
-  Transport,
-  encodeFunctionData,
-} from 'viem';
+import { Address, Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
 import { sequencerInbox } from '../contracts';
-import { ActionParameters, WithAccount } from '../types/Actions';
+import {
+  ActionParameters,
+  PrepareTransactionRequestReturnTypeWithChainId,
+  WithAccount,
+  WithUpgradeExecutor,
+} from '../types/Actions';
 import { Prettify } from '../types/utils';
+import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { validateParentChainPublicClient } from '../types/ParentChain';
 
 type Args = {
   batchPoster: Address;
 };
 
 export type SetIsBatchPosterParameters<Curried extends boolean = false> = Prettify<
-  WithAccount<ActionParameters<Args, 'sequencerInbox', Curried>>
+  WithUpgradeExecutor<WithAccount<ActionParameters<Args, 'sequencerInbox', Curried>>>
 >;
 
-export type SetIsBatchPosterReturnType = PrepareTransactionRequestReturnType;
-
-function sequencerInboxFunctionData({
-  batchPoster,
-  enable,
-}: SetIsBatchPosterParameters & { enable: boolean }) {
-  return encodeFunctionData({
-    abi: sequencerInbox.abi,
-    functionName: 'setIsBatchPoster',
-    args: [batchPoster, enable],
-  });
-}
+export type SetIsBatchPosterReturnType = PrepareTransactionRequestReturnTypeWithChainId;
 
 async function setIsBatchPoster<TChain extends Chain | undefined>(
   client: PublicClient<Transport, TChain>,
-  args: SetIsBatchPosterParameters & { enable: boolean },
+  params: SetIsBatchPosterParameters & { enable: boolean },
 ): Promise<SetIsBatchPosterReturnType> {
-  const data = sequencerInboxFunctionData(args);
-  return client.prepareTransactionRequest({
-    to: args.sequencerInbox,
-    value: BigInt(0),
+  const validatedPublicClient = validateParentChainPublicClient(client);
+  const { account, upgradeExecutor, sequencerInbox: sequencerInboxAddress, ...args } = params;
+
+  const request = await client.prepareTransactionRequest({
     chain: client.chain,
-    data,
-    account: args.account,
+    account,
+    ...withUpgradeExecutor({
+      to: sequencerInboxAddress,
+      upgradeExecutor,
+      args: [args.batchPoster, args.enable],
+      abi: sequencerInbox.abi,
+      functionName: 'setIsBatchPoster',
+    }),
   } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: validatedPublicClient.chain.id };
 }
 
 export async function enableBatchPoster<TChain extends Chain | undefined>(

src/actions/setKeyset.ts

@@ -1,49 +1,49 @@
-import {
-  Chain,
-  Hex,
-  PrepareTransactionRequestParameters,
-  PrepareTransactionRequestReturnType,
-  PublicClient,
-  Transport,
-  encodeFunctionData,
-} from 'viem';
+import { Chain, Hex, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
 import { sequencerInbox } from '../contracts';
-import { ActionParameters, WithAccount } from '../types/Actions';
+import {
+  ActionParameters,
+  PrepareTransactionRequestReturnTypeWithChainId,
+  WithAccount,
+  WithUpgradeExecutor,
+} from '../types/Actions';
 import { Prettify } from '../types/utils';
+import { validateParentChainPublicClient } from '../types/ParentChain';
+import { withUpgradeExecutor } from '../withUpgradeExecutor';
 
 export type SetKeysetParameters<Curried extends boolean = false> = Prettify<
-  WithAccount<
-    ActionParameters<
-      {
-        keyset: Hex;
-      },
-      'sequencerInbox',
-      Curried
+  WithUpgradeExecutor<
+    WithAccount<
+      ActionParameters<
+        {
+          keyset: Hex;
+        },
+        'sequencerInbox',
+        Curried
+      >
     >
   >
 >;
 
-export type SetKeysetReturnType = PrepareTransactionRequestReturnType;
-
-function sequencerInboxFunctionData({ keyset }: SetKeysetParameters) {
-  return encodeFunctionData({
-    abi: sequencerInbox.abi,
-    functionName: 'setValidKeyset',
-    args: [keyset],
-  });
-}
+export type SetKeysetReturnType = PrepareTransactionRequestReturnTypeWithChainId;
 
 export async function setKeyset<TChain extends Chain | undefined>(
   client: PublicClient<Transport, TChain>,
-  args: SetKeysetParameters,
+  params: SetKeysetParameters,
 ): Promise<SetKeysetReturnType> {
-  const data = sequencerInboxFunctionData(args);
+  const validatedPublicClient = validateParentChainPublicClient(client);
+  const { account, upgradeExecutor, sequencerInbox: sequencerInboxAddress, ...args } = params;
 
-  return client.prepareTransactionRequest({
-    to: args.sequencerInbox,
-    value: BigInt(0),
+  const request = await client.prepareTransactionRequest({
     chain: client.chain,
-    data,
-    account: args.account,
+    account,
+    ...withUpgradeExecutor({
+      to: sequencerInboxAddress,
+      upgradeExecutor,
+      args: [args.keyset],
+      abi: sequencerInbox.abi,
+      functionName: 'setValidKeyset',
+    }),
   } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: validatedPublicClient.chain.id };
 }

src/actions/setMaxTimeVariation.ts

@@ -1,14 +1,14 @@
-import {
-  Chain,
-  PrepareTransactionRequestParameters,
-  PrepareTransactionRequestReturnType,
-  PublicClient,
-  Transport,
-  encodeFunctionData,
-} from 'viem';
+import { Chain, PrepareTransactionRequestParameters, PublicClient, Transport } from 'viem';
 import { sequencerInbox } from '../contracts';
-import { ActionParameters, WithAccount } from '../types/Actions';
+import {
+  ActionParameters,
+  PrepareTransactionRequestReturnTypeWithChainId,
+  WithAccount,
+  WithUpgradeExecutor,
+} from '../types/Actions';
 import { Prettify } from '../types/utils';
+import { withUpgradeExecutor } from '../withUpgradeExecutor';
+import { validateParentChainPublicClient } from '../types/ParentChain';
 
 type Args = {
   delayBlocks: bigint;
@@ -17,30 +17,29 @@ type Args = {
   futureSeconds: bigint;
 };
 export type SetMaxTimeVariationParameters<Curried extends boolean = false> = Prettify<
-  WithAccount<ActionParameters<Args, 'sequencerInbox', Curried>>
+  WithUpgradeExecutor<WithAccount<ActionParameters<Args, 'sequencerInbox', Curried>>>
 >;
 
-export type SetMaxTimeVariationReturnType = PrepareTransactionRequestReturnType;
-
-function sequencerInboxFunctionData(args: SetMaxTimeVariationParameters) {
-  return encodeFunctionData({
-    abi: sequencerInbox.abi,
-    functionName: 'setMaxTimeVariation',
-    args: [args],
-  });
-}
+export type SetMaxTimeVariationReturnType = PrepareTransactionRequestReturnTypeWithChainId;
 
 export async function setMaxTimeVariation<TChain extends Chain | undefined>(
   client: PublicClient<Transport, TChain>,
-  args: SetMaxTimeVariationParameters,
+  params: SetMaxTimeVariationParameters,
 ): Promise<SetMaxTimeVariationReturnType> {
-  const data = sequencerInboxFunctionData(args);
+  const validatedPublicClient = validateParentChainPublicClient(client);
+  const { account, upgradeExecutor, sequencerInbox: sequencerInboxAddress, ...args } = params;
 
-  return client.prepareTransactionRequest({
-    to: args.sequencerInbox,
-    value: BigInt(0),
+  const request = await client.prepareTransactionRequest({
     chain: client.chain,
-    data,
-    account: args.account,
+    account,
+    ...withUpgradeExecutor({
+      to: sequencerInboxAddress,
+      upgradeExecutor,
+      args: [args],
+      abi: sequencerInbox.abi,
+      functionName: 'setMaxTimeVariation',
+    }),
   } satisfies PrepareTransactionRequestParameters);
+
+  return { ...request, chainId: validatedPublicClient.chain.id };
 }

src/types/Actions.ts

@@ -1,4 +1,4 @@
-import { Address } from 'viem';
+import { Address, PrepareTransactionRequestReturnType } from 'viem';
 import { Prettify } from './utils';
 
 /**
@@ -24,3 +24,11 @@ export type ActionParameters<Args, ContractName extends string, Curried extends
 export type WithAccount<Args> = Args & {
   account: Address;
 };
+
+export type WithUpgradeExecutor<Args> = Args & {
+  upgradeExecutor: Address | false;
+};
+
+export type PrepareTransactionRequestReturnTypeWithChainId = PrepareTransactionRequestReturnType & {
+  chainId: number;
+};