Skip to content

ConstellationCrypto/orbit-actions

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orbit Action Contracts for Celestia DA

A set of contracts that are similar to Arbitrum gov-action-contracts, but are designed to be used with Orbit chains looking to migrate to Celestia DA

Requirments

yarn and foundry are required to run the scripts

Most of the action contracts only support the following ownership setup:

  • Rollup Contract on Parent Chain owned by a ParentUpgradeExecutor
  • Rollup ProxyAdmin on Parent Chain owned by a ParentUpgradeExecutor
  • Arb Owner on the Child Orbit Chain is granted to alias of ParentUpgradeExecutor
  • Arb Owner on the Child Orbit Chain is granted to ChildUpgradeExecutor

For token bridge related operations, these are the additional requirements:

  • Token Bridge ProxyAdmin on Parent Chain owned by ParentUpgradeExecutor
  • Token Bridge ProxyAdmin on Child Orbit Chain owned by ChildUpgradeExecutor
  • Parent Chain Gateway Router and Custom Gateway owned by ParentUpgradeExecutor

Setup

yarn install

Check Version and Upgrade Path

Run the follow command to check the version of Nitro contracts deployed on the parent chain of your Orbit chain.

$ INBOX_ADDRESS=0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9 yarn orbit:contracts:version --network arb1
Get the version of Orbit chain's nitro contracts (inbox 0xaE21fDA3de92dE2FDAF606233b2863782Ba046F9), hosted on chain 42161
Version of deployed Inbox: v1.1.1
Version of deployed Outbox: v1.1.1
Version of deployed SequencerInbox: v1.1.1
Version of deployed Bridge: v1.1.1
Version of deployed RollupProxy: v1.1.1
Version of deployed RollupAdminLogic: v1.1.1
Version of deployed RollupUserLogic: v1.1.1
This deployment can be upgraded to v1.2.1 using NitroContracts1Point2Point1UpgradeAction

For other networks, replace arb1 with the network name and configure INFURA_KEY or the rpc in hardhat.config.ts

Nitro Contracts Upgrades

This section is also referenced in the documentation on "How to upgrade ArbOS on your Orbit chain" as Step 2 and Step 3.

For 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.

Nitro contracts 3.1.0 (for BoLD)

The nitro-contracts 3.1.0 upgrade guide will use the BOLDUpgradeAction from the nitro-contract repo. There are no associated ArbOS upgrade for BoLD.

Nitro contracts 2.1.3

The nitro-contracts 2.1.3 upgrade guide will patch the Inbox and SequencerInbox to properly handle EIP7702 callers. This upgrade is required before the parent chain upgrades to include EIP7702.

Nitro contracts 2.1.2

The nitro-contracts 2.1.2 upgrade guide will patch the ERC20Bridge with a storage layout fix.

This upgrade is only required if:

  1. The chain has a custom native token; AND
  2. The chain was originally deployed before v2.0.0; AND
  3. The chain wishes to upgrade to v3.1.0 or v2.1.3

Do not perform this upgrade if the above requirements aren't met.

Nitro contracts 2.1.0 (for ArbOS 32 Bianca)

The nitro-contracts 2.1.0 upgrade action 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.

Note: 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.

Nitro contracts 1.2.1 (for ArbOS 20 Atlas)

The nitro-contracts 1.2.1 upgrade action 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, requires nitro-contracts v1.2.1 or higher.

Scheduling the ArbOS upgrade

This section is also referenced in the documentation on "How to upgrade ArbOS on your Orbit chain"

Next, you will need to schedule the actual upgrade using the ArbOS upgrade at timestamp action.

This action schedule an upgrade of the ArbOS to a specific version at a specific timestamp.

Common upgrade paths

Here is a list of common upgrade paths that can be used to upgrade the Orbit chains to Celestia DA.

ArbOS 32 Bianca Migration to Celestia DA

  1. Upgrade your Nitro node(s) to Celestia Nitro v3.2.1
  2. Upgrade nitro-contracts to celestia-2.1.0 using nitro-contract celestia-2.1.0 upgrade action

Nitro Contracts 2.1.3

There are two paths for 2.1.3 with Celestia DA:

  • Migrating a chain to use Celestia DA from upstream 2.1.0 or 2.1.2 and 2.1.3 orbit-actions
  • Upgrading a chain already on Celestia DA (from 2.1.0 and 2.1.2)

For migrations, please refer to CelestiaNitroContracts2Point1Point3UpgradeAction.s.sol deployment.

For upgrading a chain already on Celestia DA, refer to this deployment script, which can then be executed with the upstream 2.1.3 execute script.

Note that for either path, you can upgrade to 2.1.2 using the canonical upgrade action, followed by the corresponding celestia action.

Enable Fast Confirmation

See EnableFastConfirmAction.

Enable Stylus Cache Manager

See setCacheManager.

Enable BoLD

Currently limited to L2s; L3 support is expected in a future update.

See Nitro contracts 3.1.0 upgrade.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Solidity 73.7%
  • TypeScript 12.8%
  • Shell 11.8%
  • JavaScript 1.7%