feat: rename to chain sdk (#631)

spsjvc · web-flow · commit 36bb0b3da643 · 2025-11-13T14:09:33.000+01:00
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# Arbitrum Orbit SDK
+# Arbitrum Chain SDK
 
-TypeScript SDK for building [Arbitrum Orbit](https://arbitrum.io/orbit) chains.
+TypeScript SDK for [building Arbitrum chains](https://docs.arbitrum.io/launch-arbitrum-chain/a-gentle-introduction).
 
 ## Installation
 
 Make sure you are using Node.js v18 or greater.
 
 ```bash
-yarn add @arbitrum/orbit-sdk viem@^1.20.0
+yarn add @arbitrum/chain-sdk viem@^1.20.0
 ```
 
 ## Run integration tests
diff --git a/examples/create-rollup-custom-fee-token/README.md b/examples/create-rollup-custom-fee-token/README.md
@@ -1,4 +1,4 @@
-# Arbitrum Orbit SDK
+# Arbitrum Chain SDK
 
 ## Deploying a rollup using a custom token as gas token
 
diff --git a/examples/create-rollup-custom-fee-token/index.ts b/examples/create-rollup-custom-fee-token/index.ts
@@ -5,8 +5,8 @@ import {
   prepareChainConfig,
   createRollupPrepareDeploymentParamsConfig,
   createRollup,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, generateChainId } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, generateChainId } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/create-rollup-custom-fee-token/low_level.ts b/examples/create-rollup-custom-fee-token/low_level.ts
@@ -8,8 +8,8 @@ import {
   createRollupPrepareCustomFeeTokenApprovalTransactionRequest,
   createRollupPrepareTransactionRequest,
   createRollupPrepareTransactionReceipt,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, generateChainId } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, generateChainId } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/create-rollup-eth/README.md b/examples/create-rollup-eth/README.md
@@ -1,4 +1,4 @@
-# Arbitrum Orbit SDK
+# Arbitrum Chain SDK
 
 ## Deploying a rollup using ETH as gas token
 
diff --git a/examples/create-rollup-eth/index.ts b/examples/create-rollup-eth/index.ts
@@ -5,8 +5,8 @@ import {
   prepareChainConfig,
   createRollupPrepareDeploymentParamsConfig,
   createRollup,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, generateChainId } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, generateChainId } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/create-rollup-eth/low_level.ts b/examples/create-rollup-eth/low_level.ts
@@ -6,8 +6,8 @@ import {
   prepareChainConfig,
   createRollupPrepareTransactionRequest,
   createRollupPrepareTransactionReceipt,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, generateChainId } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, generateChainId } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/create-token-bridge-custom-fee-token/index.ts b/examples/create-token-bridge-custom-fee-token/index.ts
@@ -6,8 +6,8 @@ import {
   createTokenBridgePrepareCustomFeeTokenApprovalTransactionRequest,
   createTokenBridgePrepareTransactionRequest,
   createTokenBridgePrepareTransactionReceipt,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/create-token-bridge-eth/index.ts b/examples/create-token-bridge-eth/index.ts
@@ -6,8 +6,8 @@ import {
   createTokenBridgePrepareSetWethGatewayTransactionRequest,
   createTokenBridgePrepareTransactionReceipt,
   createTokenBridgePrepareTransactionRequest,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/generate-bridge-ui-config/index.ts b/examples/generate-bridge-ui-config/index.ts
@@ -1,7 +1,7 @@
 import { createPublicClient, http } from 'viem';
 import { arbitrumSepolia } from 'viem/chains';
 import { config } from 'dotenv';
-import { getBridgeUiConfig } from '@arbitrum/orbit-sdk';
+import { getBridgeUiConfig } from '@arbitrum/chain-sdk';
 import { writeFile } from 'fs/promises';
 config();
 
diff --git a/examples/prepare-node-config/index.ts b/examples/prepare-node-config/index.ts
@@ -7,8 +7,8 @@ import {
   createRollupPrepareTransaction,
   createRollupPrepareTransactionReceipt,
   prepareNodeConfig,
-} from '@arbitrum/orbit-sdk';
-import { getParentChainLayer } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { getParentChainLayer } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/set-new-validators/index.ts b/examples/set-new-validators/index.ts
@@ -7,8 +7,8 @@ import {
   rollupAdminLogicPublicActions,
   // Uncomment it when you want to use getValidators() to get validator status
   // getValidators,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/set-valid-keyset/index.ts b/examples/set-valid-keyset/index.ts
@@ -1,8 +1,8 @@
 import { Chain, createPublicClient, http } from 'viem';
 import { privateKeyToAccount } from 'viem/accounts';
 import { arbitrumSepolia } from 'viem/chains';
-import { setValidKeysetPrepareTransactionRequest } from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+import { setValidKeysetPrepareTransactionRequest } from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 
 function getBlockExplorerUrl(chain: Chain) {
   return chain.blockExplorers?.default.url;
diff --git a/examples/setup-aep-fee-router/README.md b/examples/setup-aep-fee-router/README.md
@@ -1,4 +1,4 @@
-# Arbitrum Orbit SDK
+# Arbitrum Chain SDK
 
 ## Setup fee routing for Orbit chains settling to non-Arbitrum chains (including Ethereum)
 
diff --git a/examples/setup-aep-fee-router/index.ts b/examples/setup-aep-fee-router/index.ts
@@ -16,8 +16,8 @@ import {
   arbGasInfoPublicActions,
   parentChainIsArbitrum,
   ParentChainId,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, getParentChainFromId } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, getParentChainFromId } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/setup-fast-withdrawal/index.ts b/examples/setup-fast-withdrawal/index.ts
@@ -7,9 +7,9 @@ import {
   createSafePrepareTransactionRequest,
   rollupAdminLogicPublicActions,
   setAnyTrustFastConfirmerPrepareTransactionRequest,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey, getParentChainFromId } from '@arbitrum/orbit-sdk/utils';
-import { base, baseSepolia } from '@arbitrum/orbit-sdk/chains';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey, getParentChainFromId } from '@arbitrum/chain-sdk/utils';
+import { base, baseSepolia } from '@arbitrum/chain-sdk/chains';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/setup-fee-distributor-contract/README.md b/examples/setup-fee-distributor-contract/README.md
@@ -1,4 +1,4 @@
-# Arbitrum Orbit SDK
+# Arbitrum Chain SDK
 
 ## Setup fee distributor contract
 
diff --git a/examples/setup-fee-distributor-contract/index.ts b/examples/setup-fee-distributor-contract/index.ts
@@ -12,8 +12,8 @@ import {
   createRollupFetchCoreContracts,
   createTokenBridgeFetchTokenBridgeContracts,
   arbOwnerPublicActions,
-} from '@arbitrum/orbit-sdk';
-import { getParentChainFromId, sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { getParentChainFromId, sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/examples/upgrade-executor-add-account/index.ts b/examples/upgrade-executor-add-account/index.ts
@@ -7,8 +7,8 @@ import {
   upgradeExecutorFetchPrivilegedAccounts,
   upgradeExecutorPrepareAddExecutorTransactionRequest,
   createTokenBridgeFetchTokenBridgeContracts,
-} from '@arbitrum/orbit-sdk';
-import { sanitizePrivateKey } from '@arbitrum/orbit-sdk/utils';
+} from '@arbitrum/chain-sdk';
+import { sanitizePrivateKey } from '@arbitrum/chain-sdk/utils';
 import { config } from 'dotenv';
 config();
 
diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@arbitrum/orbit-sdk",
-  "description": "TypeScript SDK for building Arbitrum Orbit chains",
+  "name": "@arbitrum/chain-sdk",
+  "description": "TypeScript SDK for building Arbitrum chains",
   "version": "0.24.2",
   "main": "./dist/index.js",
   "files": [
@@ -44,7 +44,7 @@
       ]
     }
   },
-  "repository": "git+https://github.com/OffchainLabs/arbitrum-orbit-sdk.git",
+  "repository": "git+https://github.com/OffchainLabs/arbitrum-chain-sdk.git",
   "author": "Offchain Labs, Inc.",
   "license": "Apache-2.0",
   "engines": {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Arbitrum Orbit SDK`
	`1`	`+# Arbitrum Chain SDK`
`2`	`2`
`3`	`3`	`## Deploying a rollup using a custom token as gas token`
`4`	`4`