{"id":19460119,"url":"https://github.com/offchainlabs/orbit-actions","last_synced_at":"2025-10-08T05:09:09.086Z","repository":{"id":226404287,"uuid":"764150681","full_name":"OffchainLabs/orbit-actions","owner":"OffchainLabs","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-18T14:58:18.000Z","size":326,"stargazers_count":3,"open_issues_count":4,"forks_count":15,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-08-23T09:12:52.560Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OffchainLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":"audit-ci.jsonc","citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-27T15:12:38.000Z","updated_at":"2025-07-18T14:58:20.000Z","dependencies_parsed_at":"2024-03-18T13:38:39.249Z","dependency_job_id":"6aabfd74-73c4-4f8f-a197-78a42de5f19a","html_url":"https://github.com/OffchainLabs/orbit-actions","commit_stats":null,"previous_names":["offchainlabs/orbit-actions"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OffchainLabs/orbit-actions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Forbit-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Forbit-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Forbit-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Forbit-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OffchainLabs","download_url":"https://codeload.github.com/OffchainLabs/orbit-actions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Forbit-actions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272466648,"owners_count":24939446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-28T02:00:10.768Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T17:35:39.116Z","updated_at":"2025-10-08T05:09:04.047Z","avatar_url":"https://github.com/OffchainLabs.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Orbit Action Contracts\n\nA set of contracts that are similar to Arbitrum [gov-action-contracts](https://github.com/ArbitrumFoundation/governance/tree/main/src/gov-action-contracts), but are designed to be used with the Orbit chains.\n\n## Requirments\n\n[yarn](https://classic.yarnpkg.com/lang/en/docs/install/) and [foundry](https://book.getfoundry.sh/getting-started/installation) are required to run the scripts\n\nMost of the action contracts only support the following ownership setup:\n\n- Rollup Contract on Parent Chain owned by a `ParentUpgradeExecutor`\n- Rollup ProxyAdmin on Parent Chain owned by a `ParentUpgradeExecutor`\n- Arb Owner on the Child Orbit Chain is granted to alias of `ParentUpgradeExecutor`\n- Arb Owner on the Child Orbit Chain is granted to `ChildUpgradeExecutor`\n\nFor token bridge related operations, these are the additional requirements:\n\n- Token Bridge ProxyAdmin on Parent Chain owned by `ParentUpgradeExecutor`\n- Token Bridge ProxyAdmin on Child Orbit Chain owned by `ChildUpgradeExecutor`\n- Parent Chain Gateway Router and Custom Gateway owned by `ParentUpgradeExecutor`\n\n## Setup\n\n```\nyarn install\n```\n\n## Check Version and Upgrade Path\n\nRun the follow command to check the version of Nitro contracts deployed on the parent chain of your Orbit chain.\n\n```\n$ INBOX_ADDRESS=0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9 yarn orbit:contracts:version --network arb1\nGet the version of Orbit chain's nitro contracts (inbox 0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9), hosted on chain 42161\nVersion of deployed Inbox: v1.1.1\nVersion of deployed Outbox: v1.1.1\nVersion of deployed SequencerInbox: v1.1.1\nVersion of deployed Bridge: v1.1.1\nVersion of deployed RollupProxy: v1.1.1\nVersion of deployed RollupAdminLogic: v1.1.1\nVersion of deployed RollupUserLogic: v1.1.1\nThis deployment can be upgraded to v1.2.1 using NitroContracts1Point2Point1UpgradeAction\n```\n\nFor other networks, replace `arb1` with the network name and configure INFURA_KEY or the rpc in hardhat.config.ts\n\n## Nitro Contracts Upgrades\n\n_This section is also referenced in the documentation on [\"How to upgrade ArbOS on your Orbit chain\"](https://docs.arbitrum.io/launch-orbit-chain/how-tos/arbos-upgrade)_ as Step 2 and Step 3.\n\nFor ArbOS upgrades, a common pre-requisite is to deploy new Nitro contracts to the parent chain of your Orbit chain before scheduling the ArbOS upgrade. These contracts include the rollup logic, fraud proof contracts, and interfaces for interacting with Nitro precompiles. The scripts and instructions in this repository are meant for Orbit chain owners to upgrade the aforementioned contracts, set the new WASM module root, and then schedule the ArbOS upgrade.\n\n### Nitro contracts 3.1.0 (for [BoLD](https://docs.arbitrum.io/how-arbitrum-works/bold/gentle-introduction))\n\nThe [`nitro-contracts 3.1.0` upgrade guide](scripts/foundry/contract-upgrades/3.1.0) will use the [BOLDUpgradeAction](https://github.com/OffchainLabs/nitro-contracts/blob/main/src/rollup/BOLDUpgradeAction.sol) from the [nitro-contract](https://github.com/OffchainLabs/nitro-contracts) repo. There are no associated ArbOS upgrade for BoLD. \n\n### Nitro contracts 2.1.3\n\nThe [`nitro-contracts 2.1.3` upgrade guide](scripts/foundry/contract-upgrades/2.1.3) will patch the `Inbox` and `SequencerInbox` to properly handle EIP7702 callers. This upgrade is required before the parent chain upgrades to include EIP7702.\n\n### Nitro contracts 2.1.2\n\nThe [`nitro-contracts 2.1.2` upgrade guide](scripts/foundry/contract-upgrades/2.1.2) will patch the `ERC20Bridge` with a storage layout fix.\n\nThis upgrade is only required if:\n\n1. The chain has a custom native token; AND\n1. The chain was originally deployed before `v2.0.0`; AND\n1. The chain wishes to upgrade to `v3.1.0` or `v2.1.3`\n\nDo not perform this upgrade if the above requirements aren't met.\n\n### Nitro contracts 2.1.0 (for [ArbOS 32 Bianca](https://docs.arbitrum.io/run-arbitrum-node/arbos-releases/arbos32))\n\nThe [`nitro-contracts 2.1.0` upgrade action](scripts/foundry/contract-upgrades/2.1.0) will deploy `nitro-contracts v2.1.0` contracts to your Orbit's parent chain. Note that this action will only work for chains with `nitro-contracts v1.2.1` or `nitro-contracts v1.3.0`.\n\nNote: nitro contracts upgrade brings support for AnyTrust fast confirmations and Stylus. However, Stylus will be enabled only when `ArbOS 32 Bianca` upgrade takes place, once it will be officially supported for Orbit chains.\n\n### Nitro contracts 1.2.1 (for [ArbOS 20 Atlas](https://docs.arbitrum.io/run-arbitrum-node/arbos-releases/arbos20))\n\nThe [`nitro-contracts 1.2.1` upgrade action](scripts/foundry/contract-upgrades/1.2.1) will deploy `nitro-contracts v1.2.1` contracts to your Orbit's parent chain. Note that this action will only work for chains with `nitro-contracts v1.1.0` or `nitro-contracts v.1.1.1`. ArbOS 20 Atlas, shipped via [Nitro v2.3.0](https://github.com/OffchainLabs/nitro/releases/tag/v2.3.0), requires [**`nitro-contracts v1.2.1`**](https://github.com/OffchainLabs/nitro-contracts/releases/tag/v1.2.1) or higher.\n\n## Scheduling the ArbOS upgrade\n\n_This section is also referenced in the documentation on [\"How to upgrade ArbOS on your Orbit chain\"](https://docs.arbitrum.io/launch-orbit-chain/how-tos/arbos-upgrade)_\n\nNext, you will need to schedule the actual upgrade using the [ArbOS upgrade at timestamp action](scripts/foundry/arbos-upgrades/at-timestamp).\n\nThis action schedule an upgrade of the ArbOS to a specific version at a specific timestamp.\n\n## Common upgrade paths\n\nHere is a list of common upgrade paths that can be used to upgrade the Orbit chains. These instructions are duplicated from the docs on [How to upgrade ArbOS on your Orbit chain](https://docs.arbitrum.io/launch-orbit-chain/how-tos/arbos-upgrade), specifically Steps 1 through 3. Step 4 is mentioned below under \"Other Actions\".\n\n### [ArbOS 32 Bianca](https://docs.arbitrum.io/run-arbitrum-node/arbos-releases/arbos32)\n\n1. Upgrade your Nitro node(s) to [Nitro v3.3.1](https://github.com/OffchainLabs/nitro/releases/tag/v3.3.1)\n1. Upgrade `nitro-contracts` to `2.1.0` using [nitro-contract 2.1.0 upgrade action](scripts/foundry/contract-upgrades/2.1.0)\n1. Schedule the ArbOS 32 Bianca upgrade using [ArbOS upgrade at timestamp action](scripts/foundry/arbos-upgrades/at-timestamp)\n\n### [ArbOS 20 Atlas](https://docs.arbitrum.io/run-arbitrum-node/arbos-releases/arbos20)\n\n1. Upgrade your Nitro node(s) to [Nitro v2.3.1](https://github.com/OffchainLabs/nitro/releases/tag/v2.3.1)\n1. Upgrade `nitro-contracts` to `v1.2.1` using [nitro-contract 1.2.1 upgrade action](scripts/foundry/contract-upgrades/1.2.1)\n1. Schedule the ArbOS 20 Atlas upgrade using [ArbOS upgrade at timestamp action](scripts/foundry/arbos-upgrades/at-timestamp)\n\n# Other Actions\n\nBelow are additional on-chain actions that Orbit chain owners and maintainers can take as part of [Step 4: Enable ArbOS specific configurations or feature flags](https://docs.arbitrum.io/launch-orbit-chain/how-tos/arbos-upgrade#step-4-enable-arbos-specific-configurations-or-feature-flags-not-always-required).\n\n## Enable Fast Confirmation\n\nSee [EnableFastConfirmAction](scripts/foundry/fast-confirm).\n\n## Enable Stylus Cache Manager\n\nSee [setCacheManager](scripts/foundry/stylus/setCacheManager).\n\n## Enable BoLD\n\nCurrently limited to L2s; L3 support is expected in a future update.\n\nSee [Nitro contracts 3.1.0 upgrade](https://github.com/OffchainLabs/orbit-actions/tree/main/scripts/foundry/contract-upgrades/3.1.0). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffchainlabs%2Forbit-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffchainlabs%2Forbit-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffchainlabs%2Forbit-actions/lists"}