Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 1.58 KB

README.md

File metadata and controls

28 lines (26 loc) · 1.58 KB
Raw

stateborn-sequencer

stateborn-sequencer is a backend service for stateborn.org. It is responsible for processing stateborn data such as daos, proposals and votes and storing it in a database and IPFS.

Architecutre

stateborn architecture

Installation

This is localhost setup guide based on Docker and docker-compose. The configuration is located in docker-compose-local.yaml. For production setup, please refer to docker-compose.yaml file and Dockerfile.

Preequisites

Currently stateborn supports 3 blockchain networks: Ethereum Mainnet, Polygon Mainnet and Arbitrum One. Archive node providers RPC urls are required for the proper functioning of the sequencer. Setup archive node RPC urls in docker-compose.yaml file:

  • ETHEREUM_NODE_RPC_URL for Ethereum
  • POLYGON_NODE_RPC_URL for Polygon
  • ARBITRUM_NODE_RPC_URL for Arbitrum One

If URLs are not set, these network won't be operated currently.

Local blockchain network configuration (optional)

It is possible to configure 4th blockchain network - local. Local blockchain network allows to connect to custom blockchain network. It is useful for development, testing or simply for connection to custom blockchain network. Configure connection parameters with these env vars:

  • IS_DEVELOPMENT_MODE=true - enable local network support
  • DEVELOPMENT_NETWORK_RPC - archive node RPC url
  • DEVELOPMENT_NETWORK_CHAIN_ID - blockchain network chain id
  • DEVELOPMENT_NETWORK_NAME - blockchain network name (up to you)

Start

docker-compose -f docker-compose-local.yaml up