chore: remove orbit from get contract version functions names

Author: alxdca

src/constants.ts

@@ -22,5 +22,5 @@ export const defaultSubmissionFeePercentIncrease = 300n;
 export const createTokenBridgeDefaultMaxGasForContracts = 20_000_000n;
 export const createTokenBridgeDefaultGasLimitForWethGateway = 100_000n;
 
-export const DEFAULT_ORBIT_ACTIONS_IMAGE =
+export const DEFAULT_CHAIN_ACTIONS_IMAGE =
   'offchainlabs/chain-actions@sha256:150d84f832ea4361bbe4876ecc89d4e5433f49b31b11d55229282b6568042c75';

src/getOrbitChainContractVersions.ts src/getChainContractVersions.tssrc/getOrbitChainContractVersions.ts renamed to src/getChainContractVersions.ts

@@ -2,10 +2,10 @@ import type { Address } from 'viem';
 
 import { runChainVersioner } from '@arbitrum/chain-actions';
 
-import { DEFAULT_ORBIT_ACTIONS_IMAGE } from './constants';
+import { DEFAULT_CHAIN_ACTIONS_IMAGE } from './constants';
 import { runDockerCommand } from './runDockerCommand';
 
-export type GetOrbitChainContractVersionsResult = {
+export type GetChainContractVersionsResult = {
   versions: Record<string, string | null>;
   upgradeRecommendation: unknown;
 };
@@ -30,9 +30,9 @@ function getDockerNetworkConfig(parentChainRpc: string): {
   };
 }
 
-function parseOrbitChainContractVersionsResult(
-  result: string | GetOrbitChainContractVersionsResult,
-): GetOrbitChainContractVersionsResult {
+function parseChainContractVersionsResult(
+  result: string | GetChainContractVersionsResult,
+): GetChainContractVersionsResult {
   const parsed =
     typeof result === 'string'
       ? (() => {
@@ -53,14 +53,14 @@ function parseOrbitChainContractVersionsResult(
     throw new Error('Failed to parse Orbit chain contract versions');
   }
 
-  return parsed as GetOrbitChainContractVersionsResult;
+  return parsed as GetChainContractVersionsResult;
 }
 
-async function getOrbitChainContractVersionsWithDocker(
+async function getChainContractVersionsWithDocker(
   inboxAddress: Address,
   parentChainRpc: string,
   image: string,
-): Promise<GetOrbitChainContractVersionsResult> {
+): Promise<GetChainContractVersionsResult> {
   const dockerConfig = getDockerNetworkConfig(parentChainRpc);
 
   const { stdout } = await runDockerCommand({
@@ -75,27 +75,27 @@ async function getOrbitChainContractVersionsWithDocker(
     },
   });
 
-  return parseOrbitChainContractVersionsResult(stdout);
+  return parseChainContractVersionsResult(stdout);
 }
 
-async function getOrbitChainContractVersionsWithNative(
+async function getChainContractVersionsWithNative(
   inboxAddress: Address,
   parentChainRpc: string,
-): Promise<GetOrbitChainContractVersionsResult> {
+): Promise<GetChainContractVersionsResult> {
   const result = await runChainVersioner(inboxAddress, parentChainRpc, true);
 
-  return parseOrbitChainContractVersionsResult(result);
+  return parseChainContractVersionsResult(result);
 }
 
-export async function getOrbitChainContractVersions(
+export async function getChainContractVersions(
   inboxAddress: Address,
   parentChainRpc: string,
   executionMode = 'native',
-  image = DEFAULT_ORBIT_ACTIONS_IMAGE,
-): Promise<GetOrbitChainContractVersionsResult> {
+  image = DEFAULT_CHAIN_ACTIONS_IMAGE,
+): Promise<GetChainContractVersionsResult> {
   if (executionMode.toLowerCase() === 'docker') {
-    return getOrbitChainContractVersionsWithDocker(inboxAddress, parentChainRpc, image);
+    return getChainContractVersionsWithDocker(inboxAddress, parentChainRpc, image);
   }
 
-  return getOrbitChainContractVersionsWithNative(inboxAddress, parentChainRpc);
+  return getChainContractVersionsWithNative(inboxAddress, parentChainRpc);
 }

…tOrbitChainContractVersions.unit.test.ts src/getChainContractVersions.unit.test.tssrc/getOrbitChainContractVersions.unit.test.ts renamed to src/getChainContractVersions.unit.test.ts src/getOrbitChainContractVersions.unit.test.ts renamed to src/getChainContractVersions.unit.test.ts

@@ -1,7 +1,7 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { DEFAULT_ORBIT_ACTIONS_IMAGE } from './constants';
-import { getOrbitChainContractVersions } from './getOrbitChainContractVersions';
+import { DEFAULT_CHAIN_ACTIONS_IMAGE } from './constants';
+import { getChainContractVersions } from './getChainContractVersions';
 import { runDockerCommand } from './runDockerCommand';
 import { runChainVersioner } from '@arbitrum/chain-actions';
 
@@ -31,10 +31,7 @@ describe('getOrbitChainContractVersions', () => {
     });
 
     await expect(
-      getOrbitChainContractVersions(
-        '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
-        'https://rpc.example',
-      ),
+      getChainContractVersions('0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9', 'https://rpc.example'),
     ).resolves.toEqual({
       versions: {
         Inbox: 'v1.1.1',
@@ -63,7 +60,7 @@ describe('getOrbitChainContractVersions', () => {
     });
 
     await expect(
-      getOrbitChainContractVersions(
+      getChainContractVersions(
         '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
         'https://arb-sepolia.example/rpc',
         'docker',
@@ -99,14 +96,14 @@ describe('getOrbitChainContractVersions', () => {
       exitCode: 0,
     });
 
-    await getOrbitChainContractVersions(
+    await getChainContractVersions(
       '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
       'http://127.0.0.1:8545',
       'docker',
     );
 
     expect(runDockerCommand).toHaveBeenCalledWith({
-      image: DEFAULT_ORBIT_ACTIONS_IMAGE,
+      image: DEFAULT_CHAIN_ACTIONS_IMAGE,
       entrypoint: 'yarn',
       dockerRunArgs: ['--add-host', 'host.docker.internal:host-gateway'],
       command: ['--silent', 'orbit:contracts:version'],
@@ -127,7 +124,7 @@ describe('getOrbitChainContractVersions', () => {
     });
 
     await expect(
-      getOrbitChainContractVersions(
+      getChainContractVersions(
         '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
         'https://rpc.example',
         'docker',
@@ -146,7 +143,7 @@ describe('getOrbitChainContractVersions', () => {
       });
 
       await expect(
-        getOrbitChainContractVersions(
+        getChainContractVersions(
           '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
           'https://rpc.example',
           'docker',
@@ -164,7 +161,7 @@ describe('getOrbitChainContractVersions', () => {
     });
 
     await expect(
-      getOrbitChainContractVersions(
+      getChainContractVersions(
         '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
         'https://rpc.example',
         'docker',
@@ -181,7 +178,7 @@ describe('getOrbitChainContractVersions', () => {
     });
 
     await expect(
-      getOrbitChainContractVersions(
+      getChainContractVersions(
         '0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9',
         'https://rpc.example',
         'docker',

src/index.ts

@@ -195,7 +195,7 @@ import {
   FetchDecimalsProps,
 } from './utils/erc20';
 import { prepareArbitrumNetwork } from './utils/registerNewNetwork';
-import { getOrbitChainContractVersions } from './getOrbitChainContractVersions';
+import { getChainContractVersions } from './getChainContractVersions';
 
 export {
   arbOwnerPublicActions,
@@ -364,7 +364,7 @@ export {
   //
   prepareArbitrumNetwork,
   //
-  getOrbitChainContractVersions,
+  getChainContractVersions,
 };
 
 export * from './scripting/scriptUtils';