How to Deploy an Orbit chain using the Orbit SDK
This document explains how to use the Orbit SDK to deploy a Orbit chain.
This document is under construction and may change significantly as we incorporate style guidance and feedback from readers. Feel free to request specific clarifications by clicking the Request an update button at the top of this document.
See the "create-rollup-eth" example in the Orbit SDK repository for additional guidance.
The Arbitrum Orbit SDK lets you programmatically create and manage your own Orbit chain(s). Its capabilities include:
- Configuration and deployment of your Orbit chain's core contracts
- Initialization of your chain and management of its configuration post-deployment
Select a chain type
There are three types of Orbit chains. Review the following table to determine which type best fits your needs:
| Chain Type | Description | Use Case |
|---|---|---|
| Rollup | Offers Ethereum-grade security by batching, compressing, and posting data to the parent chain, similarly to Arbitrum One. | Ideal for applications that require high security guarantees. |
| AnyTrust | Implements the AnyTrust protocol, relying on an external Data Availability Committee (DAC) to store data and provide it on-demand instead of using their parent chain as the Data Availability (DA) layer. | Suitable for applications that require lower transaction fees. |
| Custom gas token | An AnyTrust Orbit chain with the ability to specify a custom ERC-20 gas token. | Ideal for applications that require custom gas fee tokens and lower transaction fees. |
Select the chain you are interested in deploying:
- Rollup chain
- AnyTrust chain
- Custom token chain
Getting the Orbit chain information after deployment
Once you've successfully deployed your Orbit chain, the next step is to retrieve detailed information about the deployment, which you can do with the createRollupPrepareTransactionReceipt API.
After sending the signed transaction and receiving the transaction receipt, you can use the createRollupPrepareTransactionReceipt API to parse this receipt and extract the relevant data. This process will provide comprehensive details about the deployed chain, such as contract addresses, configuration settings, and other information.
Here's an example of how to use the Orbit SDK to get data from a deployed Orbit chain:
import { createRollupPrepareTransactionReceipt } from '@arbitrum/orbit-sdk';
const data = createRollupPrepareTransactionReceipt(txReceipt);
In this example, txReceipt refers to the transaction receipt you received after deploying the chain. By passing this receipt to the createRollupPrepareTransactionReceipt function, you can access your Orbit chain's information. This feature of the Orbit SDK simplifies the post-deployment process, allowing you to quickly and efficiently gather all necessary details about your chain for further use or reference.