Skip to main content

Setup Guide

Deploy local Sovereign Chain​

note

This guide is a preliminary version and not the final documentation for sovereign chains. It serves as a starting point for setting up a sovereign chain on a local machine.

This guide will help you deploy contract on main chain, set up configuration files and deploy sovereign chain and all dependent services. Follow these steps carefully to ensure a successful deployment.

Step 1: Get the mx-chain-go Repository​

Before proceeding, ensure that a SSH key for GitHub is configured on your machine.

  1. Clone the GitHub repository:

    git clone git@github.com:multiversx/mx-chain-go.git

  2. Checkout the specific sovereign chain sdk branch and navigate to testnet directory:

    cd mx-chain-go && git fetch && git checkout feat/chain-go-sdk && cd scripts/testnet

  3. Run the prerequisites script:

    ./prerequisites.sh
note

The prerequisites script verifies and downloads the necessary packages to run the nodes and clones the required repositories:

  • mx-chain-deploy-go: Initializes the configuration for the chain and deployment parameters.
  • mx-chain-proxy-go: Repository for the proxy.
  • mx-chain-sovereign-bridge-go: Repository for the cross-chain service.

Step 2: Deploy Sovereign setup​

First navigate to the sovereignBridge folder:

cd sovereignBridge

  1. Install the software dependencies and download the cross-chain contracts by running the sovereign bridge prerequisites script:

    ./prerequisites.sh

  2. Create a new wallet:

    mxpy wallet new --format pem --outfile ~/wallet.pem
note

You can use any wallet of your choice, but for the purpose of this guide we are generating a new wallet.

  1. Get funds in the wallet on the chain you want the sovereign to be connected to.

  2. Update the configuration file config/configs.cfg with paths you want to use, wallet location and main chain constants. Example:

    # Sovereign Paths
    SOVEREIGN_DIRECTORY="~/sovereign"
    TXS_OUTFILE_DIRECTORY="${SOVEREIGN_DIRECTORY}/txsOutput"
    CONTRACTS_DIRECTORY="${SOVEREIGN_DIRECTORY}/contracts"

    # Owner Configuration
    WALLET="~/wallet.pem"

    # Main Chain Constants
    PROXY = https://testnet-gateway.multiversx.com
    CHAIN_ID = T
note
  • SOVEREIGN_DIRECTORY, TXS_OUTFILE_DIRECTORY, CONTRACTS_DIRECTORY - represent the paths to the location where the deploy scripts will generate the outputs.
  • WALLET - should represent the wallet generated at Step 1.
  • PROXY - in this case, for the purpose of the test, the used proxy is the testnet one. Of course that the proper proxy should be used when deploying your own set of contracts depending on the development phase of your project.
  • CHAIN_ID - should represent the chain ID of the chain where the contracts are to be deployed. The currently supported constants are:
    • "1" for Mainnet;
    • "D" for Devnet;
    • "T" for Testnet;

  1. Source the script:

    source script.sh

  2. Deploy all cross-chain contracts on main chain and deploy sovereign chain with all dependent services:

    deploySovereignWithCrossChainContracts

Stop and clean local Sovereign Chain​

  1. Navigate to /mx-chain-go/scripts/testnet/sovereignBridge.

    Source the script:

    source script.sh

  2. Stop and clean the chain with all dependent services:

    stopAndCleanSovereign

Upgrade and reset local Sovereign Chain​

  1. Navigate to /mx-chain-go/scripts/testnet/sovereignBridge.

    Source the script:

    source script.sh

  2. Upgrade and reset Sovereign chain and all dependent services:

    sovereignUpgradeAndReset

Restart local Sovereign Chain​

  1. Navigate to /mx-chain-go/scripts/testnet/sovereignBridge.

    Source the script:

    source script.sh

  2. Restart Sovereign chain and all dependent services:

    sovereignRestart
important

This version of the documentation focuses solely on the essential steps required to set up and deploy a sovereign chain on either a local or remote computer. It does not include instructions for configuring:

  • Round length
  • Gas token
  • Fee model
  • Consensus model
  • And other related settings