running-a-node.md

Running A Node

This documentation outlines the neccessary steps for running an AO Mainnet(HyperBEAM) node.

Running HyperBEAM as a Docker container

HyperBEAM can be deployed as a Docker container. See this branch for instructions. Indexing starts automatically unless explicitly disabled. Note the default port from the Dockerized variant is 8001.

Alternatively, see below for instructions on building from source.

Building from source

Prerequisites

1. Install Erlang/OTP 27

   Erlang is required to run the Hyperbeam node server.

   git clone https://github.com/erlang/otp.git -b maint-27
   cd otp
   ./configure
   make
   sudo make install

   Verify installation: erl -version

2. Install Rebar3

   Rebar3 is the build tool for Erlang projects.

   git clone https://github.com/erlang/rebar3.git
   cd rebar3
   ./bootstrap
   sudo mv rebar3 /usr/local/bin/

   Verify installation: rebar3 version

3. Install Rust

   Rust is required for compiling native dependencies.

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source $HOME/.cargo/env

   Verify installation: rustc --version && cargo --version

Clone the repository

git clone https://github.com/permaweb/hyperbeam.git

Run the HyperBEAM Server

HB_PARANOID=http_request rebar3 as genesis_wasm shell

Run HyperBEAM as an indexer

Set up a HyperBEAM node that indexes and serves Arweave data through your own Arweave node.

Documentation for running an Arweave node can be found here.

1. Add configuration

Create config.json in the HyperBEAM repository root

{
  "ao-types": "generate_index=atom,max_connections=integer,num_acceptors=integer",
  "port": 8001,
  "num_acceptors": 32,
  "max_connections": 512,
  "arweave_index_workers": 4,
  "arweave_index_blocks": true,
  "routes": [
    {
      "template": "/result/.*",
      "node": {
        "prefix": "http://localhost:6363"
      }
    },
    {
      "template": "/snapshot/.*",
      "node": {
        "prefix": "http://localhost:6363"
      }
    },
    {
      "template": "/dry-run.*",
      "node": {
        "prefix": "http://localhost:6363"
      }
    },
    {
      "template": "/state.*",
      "node": {
        "prefix": "http://localhost:6363"
      }
    },
    {
      "template": "/graphql",
      "nodes": [
        {
          "prefix": "https://ao-search-gateway.goldsky.com",
          "opts": {
            "ao-types": "http-client=atom,protocol=atom",
            "http-client": "gun",
            "protocol": "http2"
          }
        },
        {
          "prefix": "https://arweave-search.goldsky.com",
          "opts": {
            "ao-types": "http-client=atom,protocol=atom",
            "http-client": "gun",
            "protocol": "http2"
          }
        },
        {
          "prefix": "https://arweave.net",
          "opts": {
            "ao-types": "http-client=atom,protocol=atom",
            "http-client": "gun",
            "protocol": "http2"
          }
        }
      ]
    },
    {
      "template": "^/arweave",
      "node": {
        "match": "^/arweave",
        "with": "https://arweave.net"
      }
    }
  ],
  "store": [
    {
      "ao-types": "store-module=atom",
      "store-module": "hb_store_lmdb",
      "name": "cache-mainnet/lmdb",
      "access": ["read", "write"],
      "max-readers": 512,
      "capacity": 68719476736
    },
    {
      "ao-types": "store-module=atom,scope=atom",
      "store-module": "hb_store_arweave",
      "access": ["read"],
      "scope": "remote",
      "index-store": [
        {
          "ao-types": "store-module=atom,read-only=atom",
          "store-module": "hb_store_lmdb",
          "name": "cache-mainnet/lmdb",
          "access": ["read", "write"],
          "max-readers": 512,
          "capacity": 68719476736
        }
      ]
    },
    {
      "ao-types": "store-module=atom",
      "store-module": "hb_store_gateway",
      "access": ["read"],
      "subindex": [
        {
          "name": "Data-Protocol",
          "value": "ao"
        }
      ],
      "local-store": [
        {
          "ao-types": "store-module=atom",
          "store-module": "hb_store_lmdb",
          "name": "cache-mainnet/lmdb",
          "access": ["read", "write"],
          "max-readers": 512,
          "capacity": 68719476736
        }
      ]
    },
    {
      "ao-types": "store-module=atom",
      "store-module": "hb_store_gateway",
      "access": ["read"],
      "local-store": [
        {
          "ao-types": "store-module=atom",
          "store-module": "hb_store_lmdb",
          "name": "cache-mainnet/lmdb",
          "access": ["read", "write"],
          "max-readers": 512,
          "capacity": 68719476736
        }
      ]
    }
  ]
}

2. Run the server

Use the same run command specified in the Run the HyperBEAM Server section with the configuration specified.

HB_PARANOID=http_request HB_CONFIG=config.json rebar3 as genesis_wasm shell

3. Start indexing

curl -s "http://localhost:8734/~cron@1.0/every?interval=1-second&cron-path=~copycat@1.0/arweave&from=-1&to=-19"