Skip to main content

Manual for Building Verse

1,000,000 OAS is required to validate the Verse-Layer node. There's a 180 days lockup period on the first deployment for a builder wallet. But on the Testnet, it's free; You can try the Verse Testnet with Faucet(10OAS is sufficient to deploy contract) and build Verse-Layer node.

If you want to test deploying contracts and execute transactions on the Verse, please use SAND Verse.

Validator Build Steps​

verse build

For more detailed information about Verse Architecture, you can take a look at it before deploying a Verse.

Constructing Verse as a Permissioned Chain​

If safeguarding against scams or hacks is a paramount concern for your business, you can configure Verse as a permissioned chain using the Verse-Proxy.

Allowing unrestricted transactions on the Verse could expose you to unforeseen gas attacks. However, by using the proxy, such threats can be managed and limited. For a deeper understanding, please refer to the Verse-Proxy section.

1. Requirements​

Docker Engine v20.10.0 or later and docker compose v2.0 or later are required.Please Check Hardware_Requirements Prior to setup.

2. Clone verse-layer-optimism repository​

Clone the verse-layer-optimism repository provided by the Oasys Foundation.

$ git clone https://github.com/oasysgames/verse-layer-optimism.git /path/to/verse-layer-optimism

$ cd /path/to/verse-layer-optimism

3. Create .env file​

Create an environment variable configuration file for containers.

Sample for mainnet : 

$ cp .env.sample.mainnet .env

Sample for testnet :

$ cp .env.sample.testnet .env

The following settings should be changed.

# Your Verse-Layer chain ID
L2_CHAIN_ID=

# Created wallet address and key
SEQUENCER_ADDRESS=
SEQUENCER_KEY=

PROPOSER_ADDRESS=
PROPOSER_KEY=

MESSAGE_RELAYER_ADDRESS=
MESSAGE_RELAYER_KEY=
danger

Do not change BLOCK_SIGNER_ADDRESS and BLOCK_SIGNER_KEY. If you change them, the Oasys team will not be able to run replica nodes for the Verse-Layer. Furthermore, if the replica node does not exist, the verifier cannot verify the rollup from your Verse-Layer. As a result, the latency of token withdrawal from the Verse-Layer to Hub-Layer increases from about 2 minutes to 7 days, resulting in bad UX of the bridge.

4. Create Wallets​

Create Ethereum wallets (address and private key) to be used by Builder, Sequencer, and Proposer.

$ docker-compose run --rm wallet

The created wallets will be saved to ./data/wallet/keys.txt.

Notes:
1. These wallets require some tokens to run the Verse-Layer. For the testnet, you can get tokens from Faucet.
2. Be sure to back up this file!

- You can share your public address with anyone. Others need it to interact with you.
- You must NEVER share the secret key with anyone! The key controls access to your funds!
- You must BACKUP your key file! Without the key, it's impossible to access account funds!

---- builder ----
Address: 0x0123456789abcdef0123456789abcdef
key:     0x0123456789abcdef0123456789abcdef0123456789abcdef

---- sequencer ----
Address: 0x0123456789abcdef0123456789abcdef
key:     0x0123456789abcdef0123456789abcdef0123456789abcdef

---- proposer ----
Address: 0x0123456789abcdef0123456789abcdef
key:     0x0123456789abcdef0123456789abcdef0123456789abcdef

---- message-relayer ----
Address: 0x0123456789abcdef0123456789abcdef
key:     0x0123456789abcdef0123456789abcdef0123456789abcdef

5-1. Deploy contracts for Verse-Layer to Hub-Layer.​

If you've already built the Verse, skip this procedure. And you can check VerseInfo with build_transaction at check-verse-page.

For users wishing to build using Multisig like Nsuite, detailed instructions are provided at the end of this page.

Connect wallet​

Access tools-fe and switch to the oasys network.

Connect the wallet using metamask. Upon successful connection, the connected account address and the network will be displayed.

Connect wallet

Account connected to tools-fe have the following capabilities:

  • Deposit OAS for verse builder as a depositor
  • Build a verse as a verse builder.

Deposit OAS​

You can deposit OAS for verse builder as a depositor at Change Deposit Amount.

Deposit

For the mainnet, deposit 1000000 OAS, for the testnet, deposit 0.000000001 OAS. The amount of OAS is required for the depositor in advance. If you use the testnet, please reserve OAS in Faucet.

danger

Please don't set any values for the second verse builder address option and set amount(sOAS).

Check Your Deposit​

You can check deposited OAS for a specific verse builder at Check Deposit Amount.

Check-Deposit

Build verse​

It is recommended to secure the chainId with EVM-based Chains before building a Verse. (e.g. Register Oasys mainnet chainId)

Ensure that your chain ID is globally unique

Please remember that the chain ID acts as a unique identifier for a blockchain. Altering it is akin to launching an entirely new blockchain. Once a chain is launched with a specific chain ID, it cannot be replaced, regardless of reasons such as duplicate chain IDs.

You can build a Verse at Build Verse.

To build a Verse, set the following

  • chainId to be set in the Verse
  • address of the sequencer
  • address of the proposer

Build

If the Verse build is successful, the following will be displayed. You can get verse info with build_tx_hash at check-verse-page.

Verse build Success

Download address.json and genesis.json. When you build new verse node, please use latest version genesis.json. Build

Copy the generated configuration files to the assets directory of the verse-layer-optimism repository.

$ cp ./Downloads/addresses.json /path/to/verse-layer-optimism/assets/

$ cp ./Downloads/genesis.json /path/to/verse-layer-optimism/assets/

After completing this step, return to the verse-layer-optimism repository.

$ cd /path/to/verse-layer-optimism

5-2. Check verse information​

You can check verse information from verse-build_tx_hash or verse_chain_id or verse_builder_address at check-verse-page.

Check verse info

You can also download address.json and genesis.json as well as Build verse. If the verse has already been created and you want to check genesis.json version of the verse, you can check that with your verse rpc url at Check Genesis Version . Build Check Genesis Version

Copy the generated configuration files to the assets directory of the verse-layer-optimism repository and Build verse.

6. Run Containers​

Before running the containers, you need to check latest release version at oasys-optimism packages. If it need, please update container version at docker-compose.yml.

$ docker-compose up -d data-transport-layer
$ docker-compose up -d l2geth
$ docker-compose up -d batch-submitter
$ docker-compose up -d message-relayer
  • data-transport-layer : Data-transport between L1 and L2
  • l2geth : L2 geth. Core component on Verse.
  • message-relayer : Message relayer, sending message between L1 and L2
  • batch-submitter : submit L2 tx for sending L1. You must run only one container for Verse.

7. Set Instant Verifier​

Oasys L2 is a fork of Optimistic Rollup. A significant limitation is the extended delay in bridge transactions from L2 to L1, which often takes up to 7 days. To bypass this lengthy waiting period, we highly recommend using our Verse Submitter, which enables instant bridge transactions from L2 to L1.

For instructions on how to set up the Verse Submitter, please refer to the this section.

For users interested in our instant verification mechanism, please visit this page.

8. Confirming Building Success​

To verify whether your building process was successful, execute the troubleshooting script. If it passes, your build should be considered successful.

Construct Verse Through Direct Contract Function Calls​

Particularly for Multisig users, such as Nsuite, we've detailed the interfaces of the deposit and build functions within the contract.

Deposit​

The contract for depositing is named L1BuildDeposit, and it's deployed at 0x5200000000000000000000000000000000000007. You can deposit either OAS or sOAS. Here's how it's done for OAS:

  • builder: Address of the Verse builder
function deposit(address builder) external payable;

For sOAS, the process is as follows:

  • builder: Address of the Verse builder
  • token: sOAS address
  • amount: Amount to deposit
function depositERC20(
    address builder,
    address token,
    uint256 amount
) external;

After making your deposit, please verify the outcome in the Check Your Deposit section above.

Build​

The build contract is named L1BuildAgent, and its address is 0x5200000000000000000000000000000000000008.

  • chainId: Chain ID of the Verse
  • sequencer: Address of the sequencer
  • proposer: Address of the proposer
function build(
    uint256 chainId,
    address sequencer,
    address proposer
) external;

After completing the build, please verify the newly deployed contract addresses, such as the bridge, and download the JSON file. For additional details, refer to the Build Verse section above.