Requirements

  1. Latest version of docker (>= 20.10.21) and docker-compose (>= v2.13.0)
  2. At least 4 core CPU, 8GB RAM and 50GB SSD - make sure to choose the correct spec when deploying to Github Codespaces.
  3. IPFS node
    • While we have included a node in our autobuild docker setup, IPFS daemon can hog a lot of resources - it is not recommended to run this on a personal computer unless you have a strong internet connection and dedicated CPU+RAM.
    • 3rd party IPFS services that provide default IFPS interface like Infura are now supported.
  4. RPC URL for Ethereum mainnet. We recommend running a full geth node to save costs and to stick to ethos of decentralization.

Our default (lite mode) setup is designed to work well with a free plan on any of the RPC providers like Alchemy, Infura, Quicknode, etc. It even works with Ankr’s public endpoint but we recommend signing up to track usage. For those interested in exploring the the full setup, we can also arrange for a special pan through our partners such as BlockVigil.

For snapshotters

  1. Clone the repository against the testnet branch.
git clone https://github.com/PowerLoom/deploy.git --single-branch powerloom_testnet_5_pairs --branch testnet_5_pairs && cd powerloom_testnet_5_pairs

  1. Copy env.example to .env.

    • Ensure the following required variables are filled:
      • SOURCE_RPC_URL : The URL for the source RPC (Remote Procedure Call) service.
      • SIGNER_ACCOUNT_ADDRESS : The address of the signer account.
      • SIGNER_ACCOUNT_PRIVATE_KEY : The private key corresponding to the signer account address.
      • Optionally, you may also set the following variables:
      • PROST_RPC_URL : The URL for the PROST RPC service.
      • IPFS_URL: The URL for the IPFS (InterPlanetary File System) service in HTTP(s) (e.g. https://ipfs.infura.io:5001) multiaddr format (e.g. /dns4/ipfs.infura.io/tcp/5001/https)
      • IPFS_API_KEY : The API key for the IPFS service (if required).
      • IPFS_API_SECRET : The API secret for the IPFS service (if required).
      • PROTOCOL_STATE_CONTRACT : The contract address for the protocol state.
      • RELAYER_HOST : The host address for the relayer.
      • SLACK_REPORTING_URL : The URL for reporting to Slack.
      • POWERLOOM_REPORTING_URL : The URL for reporting to PowerLoom.
      • WEB3_STORAGE_TOKEN : The token for Web3.Storage. You can generate or retrieve this token from your API tokens page after signing up for a free plan at web3.storage.

  2. Run the following command (ideally in a screen) and follow instructions

    ./build.sh

  1. Once all the services are up and running, the front-end can be accessed via Pooler Frontend to see a UNISWAPV2 summary data dashboard similar to PowerLoom UNISWAPV2 Prod.

    • A sample screenshot of the dashboard is given here

    • This will also give an idea in case your snapshotting has fallen behind as you can notice from the time of last snapshot shown in the screenshot.

    • Note that the data shown in your own dashboard will not be same as production UI on PowerLoom.io as the “lite mode” is only set to snapshot 7 pair contracts. Refer to contributors section below to enable all pairs.

  2. We have setup a bare-bones consensus dashboard at: consensus.powerloom.io

  3. To shutdown services, just press Ctrl+C (and again to force).

    If you don’t keep services running for extended periods of time, this will affect consensus and we may be forced to de-activate your snapshotter account.

  4. If you see issues with data, you can do a clean reset by running the following command before restarting step 3:

    docker-compose --profile ipfs down --volumes