Skip to content

register

Register your Micro-Rollup with Stackr

The register command is used to add your Micro-Rollup to the Stackr on-chain registry.

It performs the following 3 operations:

  1. Reads the stackr.config.ts file for your project's configuration such as the operator account, registry contract address, L1 and Vulcan RPC URLs
  2. Sends a transaction signed with the operator private key to Stackr's registry contract on the L1
  3. The Stackr registry contract assigns a new app ID and deploys a new AppInbox contract for your micro-rollup. The operator address is also set as the owner of this contract.

Usage

» stackr register --help
USAGE
  $ stackr register [--envFile <value>] [--privateKey <value>]
 
FLAGS
  --envFile=<value>     [default: .env] Path to the .env file
  --privateKey=<value>  Private key of the account to be used to register the contract
 
EXAMPLES
  $ stackr register
 
  $ stackr register --privateKey <privateKey> --envFile <path>

Example

npx @stackr/cli@latest register

Deployment cost

In addition to gas fees, the deployment cost for the AppInbox contract is 0.001 ETH. Make sure you have enough balance in your account to deploy the contract. This ETH is sent to the Vulcan operator.

We have kept this fees in this initial phase to prevent spamming and to ensure that the operator has enough funds to run the network.

Output

terminal
 📝 Registered application on registry
 🧰 Updated deployment.json

Once the registration is successful, a new deployment.json file is created in the root of your project directory. This file looks like this:

deployment.json
{
  "appId": 18,
  "appInbox": "0x808c6cc1299A76ec3D1f6D37d1786801fF8d8f86",
  "chainId": 11155111
}