rename some publicclient to orbitclient

examples/create-rollup-eth/index.ts

@@ -44,7 +44,7 @@ const validator = privateKeyToAccount(validatorPrivateKey).address;
 
 // set the parent chain and create a public client for it
 const parentChain = arbitrumSepolia;
-const parentChainPublicClient = createOrbitClient({
+const parentChainOrbitClient = createOrbitClient({
   chain: parentChain,
   transport: http(),
 });
@@ -77,17 +77,17 @@ async function main() {
       validators: [validator],
     },
     account: deployer.address,
-    publicClient: parentChainPublicClient,
+    publicClient: parentChainOrbitClient,
   });
 
   // sign and send the transaction
-  const txHash = await parentChainPublicClient.sendRawTransaction({
+  const txHash = await parentChainOrbitClient.sendRawTransaction({
     serializedTransaction: await deployer.signTransaction(request),
   });
 
   // get the transaction receipt after waiting for the transaction to complete
   const txReceipt = createRollupPrepareTransactionReceipt(
-    await parentChainPublicClient.waitForTransactionReceipt({ hash: txHash }),
+    await parentChainOrbitClient.waitForTransactionReceipt({ hash: txHash }),
   );
 
   console.log(`Deployed in ${getBlockExplorerUrl(parentChain)}/tx/${txReceipt.transactionHash}`);

examples/set-valid-keyset/index.ts

@@ -25,7 +25,7 @@ const keyset =
 
 // set the parent chain and create a public client for it
 const parentChain = arbitrumSepolia;
-const parentChainPublicClient = createOrbitClient({
+const parentChainOrbitClient = createOrbitClient({
   chain: parentChain,
   transport: http(),
 });
@@ -42,16 +42,16 @@ async function main() {
     },
     keyset,
     account: deployer.address,
-    publicClient: parentChainPublicClient,
+    publicClient: parentChainOrbitClient,
   });
 
   // sign and send the transaction
-  const txHash = await parentChainPublicClient.sendRawTransaction({
+  const txHash = await parentChainOrbitClient.sendRawTransaction({
     serializedTransaction: await deployer.signTransaction(txRequest),
   });
 
   // wait for the transaction receipt
-  const txReceipt = await parentChainPublicClient.waitForTransactionReceipt({
+  const txReceipt = await parentChainOrbitClient.waitForTransactionReceipt({
     hash: txHash,
   });
 

src/createRollup.integration.test.ts

@@ -17,7 +17,7 @@ const deployer = getTestPrivateKeyAccount();
 const batchPoster = deployer.address;
 const validators = [deployer.address];
 
-const publicClient = createOrbitClient({
+const orbitClient = createOrbitClient({
   chain: nitroTestnodeL2,
   transport: http(),
 });
@@ -46,16 +46,16 @@ it(`successfully deploys core contracts through rollup creator`, async () => {
       validators,
     },
     account: deployer.address,
-    publicClient,
+    orbitClient: orbitClient,
   });
 
   // sign and send the transaction
-  const txHash = await publicClient.sendRawTransaction({
+  const txHash = await orbitClient.sendRawTransaction({
     serializedTransaction: await deployer.signTransaction(request),
   });
 
   // get the transaction
-  const tx = createRollupPrepareTransaction(await publicClient.getTransaction({ hash: txHash }));
+  const tx = createRollupPrepareTransaction(await orbitClient.getTransaction({ hash: txHash }));
 
   const [arg] = tx.getInputs();
   // assert all inputs are correct
@@ -69,7 +69,7 @@ it(`successfully deploys core contracts through rollup creator`, async () => {
 
   // get the transaction receipt after waiting for the transaction to complete
   const txReceipt = createRollupPrepareTransactionReceipt(
-    await publicClient.waitForTransactionReceipt({ hash: txHash }),
+    await orbitClient.waitForTransactionReceipt({ hash: txHash }),
   );
 
   expect(txReceipt.status).toEqual('success');

src/createRollup.ts

@@ -1,7 +1,6 @@
-import { PublicClient, WalletClient, GetFunctionArgs } from 'viem';
+import { WalletClient, GetFunctionArgs } from 'viem';
 
 import { rollupCreator } from './contracts';
-import { validParentChainId } from './types/ParentChain';
 import { defaults } from './createRollupDefaults';
 import { createRollupGetCallValue } from './createRollupGetCallValue';
 import { createRollupGetMaxDataSize } from './createRollupGetMaxDataSize';
@@ -12,7 +11,7 @@ import {
 import { isCustomFeeTokenAddress } from './utils/isCustomFeeTokenAddress';
 import { ChainConfig } from './types/ChainConfig';
 import { isAnyTrustChainConfig } from './utils/isAnyTrustChainConfig';
-import { OrbitClient } from './orbitClient';
+import type { OrbitClient } from './orbitClient';
 
 export type CreateRollupFunctionInputs = GetFunctionArgs<
   typeof rollupCreator.abi,
@@ -26,14 +25,14 @@ export type CreateRollupParams = Pick<CreateRollupFunctionInputs[0], RequiredKey
 
 export async function createRollup({
   params,
-  publicClient,
+  orbitClient,
   walletClient,
 }: {
   params: CreateRollupParams;
-  publicClient: OrbitClient;
+  orbitClient: OrbitClient;
   walletClient: WalletClient;
 }): Promise<CreateRollupTransactionReceipt> {
-  const chainId = publicClient.getValidChainId();
+  const chainId = orbitClient.getValidChainId();
   const account = walletClient.account?.address;
 
   if (typeof account === 'undefined') {
@@ -51,8 +50,8 @@ export async function createRollup({
   const maxDataSize = createRollupGetMaxDataSize(chainId);
   const paramsWithDefaults = { ...defaults, ...params, maxDataSize };
 
-  const { request } = await publicClient.simulateContract({
-    address: publicClient.getRollupCreatorAddress(),
+  const { request } = await orbitClient.simulateContract({
+    address: orbitClient.getRollupCreatorAddress(),
     abi: rollupCreator.abi,
     functionName: 'createRollup',
     args: [paramsWithDefaults],
@@ -61,7 +60,7 @@ export async function createRollup({
   });
 
   const hash = await walletClient.writeContract(request);
-  const txReceipt = await publicClient.waitForTransactionReceipt({ hash });
+  const txReceipt = await orbitClient.waitForTransactionReceipt({ hash });
 
   return createRollupPrepareTransactionReceipt(txReceipt);
 }

src/createRollupEnoughCustomFeeTokenAllowance.ts

@@ -1,32 +1,25 @@
 import { Address } from 'viem';
 
-import { validParentChainId } from './types/ParentChain';
 import { fetchAllowance } from './utils/erc20';
 import { deterministicFactoriesDeploymentEstimatedFees } from './constants';
 import { OrbitClient } from './orbitClient';
 
 export type CreateRollupEnoughCustomFeeTokenAllowanceParams = {
   nativeToken: Address;
   account: Address;
-  publicClient: OrbitClient;
+  orbitClient: OrbitClient;
 };
 
 export async function createRollupEnoughCustomFeeTokenAllowance({
   nativeToken,
   account,
-  publicClient,
+  orbitClient,
 }: CreateRollupEnoughCustomFeeTokenAllowanceParams) {
-  const chainId = publicClient.chain?.id;
-
-  if (!validParentChainId(chainId)) {
-    throw new Error('chainId is undefined');
-  }
-
   const allowance = await fetchAllowance({
     address: nativeToken,
     owner: account,
-    spender: publicClient.getRollupCreatorAddress(),
-    publicClient,
+    spender: orbitClient.getRollupCreatorAddress(),
+    publicClient: orbitClient,
   });
 
   return allowance >= deterministicFactoriesDeploymentEstimatedFees;

src/createRollupPrepareCustomFeeTokenApprovalTransactionRequest.ts

@@ -7,24 +7,24 @@ export type CreateRollupPrepareCustomFeeTokenApprovalTransactionRequestParams =
   amount?: bigint;
   nativeToken: Address;
   account: Address;
-  publicClient: OrbitClient;
+  orbitClient: OrbitClient;
 };
 
 export async function createRollupPrepareCustomFeeTokenApprovalTransactionRequest({
   amount = maxInt256,
   nativeToken,
   account,
-  publicClient,
+  orbitClient,
 }: CreateRollupPrepareCustomFeeTokenApprovalTransactionRequestParams) {
-  const chainId = publicClient.getValidChainId();
-  const spender = publicClient.getRollupCreatorAddress();
+  const chainId = orbitClient.getValidChainId();
+  const spender = orbitClient.getRollupCreatorAddress();
 
   const request = await approvePrepareTransactionRequest({
     address: nativeToken,
     owner: account,
     spender,
     amount,
-    publicClient,
+    publicClient: orbitClient,
   });
 
   return { ...request, chainId };

src/createRollupPrepareTransactionRequest.ts

@@ -21,13 +21,13 @@ function createRollupEncodeFunctionData(args: CreateRollupFunctionInputs) {
 export async function createRollupPrepareTransactionRequest({
   params,
   account,
-  publicClient,
+  orbitClient,
 }: {
   params: CreateRollupParams;
   account: Address;
-  publicClient: OrbitClient;
+  orbitClient: OrbitClient;
 }) {
-  const chainId = publicClient.getValidChainId();
+  const chainId = orbitClient.getValidChainId();
 
   const chainConfig: ChainConfig = JSON.parse(params.config.chainConfig);
 
@@ -40,9 +40,9 @@ export async function createRollupPrepareTransactionRequest({
   const maxDataSize = createRollupGetMaxDataSize(chainId);
   const paramsWithDefaults = { ...defaults, ...params, maxDataSize };
 
-  const request = await publicClient.prepareTransactionRequest({
-    chain: publicClient.chain,
-    to: publicClient.getRollupCreatorAddress(),
+  const request = await orbitClient.prepareTransactionRequest({
+    chain: orbitClient.chain,
+    to: orbitClient.getRollupCreatorAddress(),
     data: createRollupEncodeFunctionData([paramsWithDefaults]),
     value: createRollupGetCallValue(paramsWithDefaults),
     account,