Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 3.27 KB

setup.md

File metadata and controls

108 lines (80 loc) · 3.27 KB
Raw

Setup

Setting up Athena is pretty straightforward. It requires three things to be done:

  1. Install Athena.
  2. Initialize the configuration.
  3. Start the parser.

Installing Athena

In order to install Athena you are required to have Go 1.19+ installed on your machine. Once you have it, the first thing to do is to clone the GitHub repository. To do this you can run

$ git clone https://github.com/desmos-labs/athena.git

Then, you need to install the binary. To do this, run

$ make install

This will put the athena binary inside your $GOPATH/bin folder. You should now be able to run athena to make sure it's installed:

$ athena
A Cosmos chain data aggregator. It improves the chain's data accessibility
by providing an indexed database exposing aggregated resources and models such as blocks, validators, pre-commits, 
transactions, and various aspects of the governance module. 
Athena is meant to run with a GraphQL layer on top so that it even further eases the ability for developers and
downstream clients to answer queries such as "What is the average gas cost of a block?" while also allowing
them to compose more aggregate and complex queries.

Usage:
  athena [command]

Available Commands:
  help        Help about any command
  init        Initializes the configuration files
  parse       Start parsing the blockchain data
  version     Print the version information

Flags:
  -h, --help          help for Athena
      --home string   Set the home folder of the application, where all files will be stored (default "/home/user/.Athena")

Use "Athena [command] --help" for more information about a command.

Initializing the configuration

In order to correctly parse and store the data based on your requirements, Athena allows you to customize its behavior via a TOML file called config.toml. In order to create the first instance of the config.toml file you can run

$ athena init

This will create such file inside the ~/.athena folder.
Note that if you want to change the folder used by Athena you can do this using the --home flag:

$ athena init --home /path/to/my/folder

Once the file is created, you are required to edit it and change the different values. To do this you can run

$ nano ~/.athena/config.yaml

For a better understanding of what each section and field refers to, please read the config reference.

Running Athena

Once the configuration file has been setup, you can run Athena using the following command:

$ athena parse

If you are using a custom folder for the configuration file, please specify it using the --home flag:

$ athena parse --home /path/to/my/config/folder

We highly suggest you running Athena as a system service so that it can be restarted automatically in the case it stops. To do this you can run:

$ sudo tee /etc/systemd/system/athena.service > /dev/null <<EOF
[Unit]
Description=Athena parser
After=network-online.target

[Service]
User=$USER
ExecStart=$GOPATH/bin/athena parse
Restart=always
RestartSec=3
LimitNOFILE=4096

[Install]
WantedBy=multi-user.target
EOF

Then you need to enable and start the service:

$ sudo systemctl enable athena
$ sudo systemctl start athena