Skip to content

Hyperion Set Up

Set Up

We've developed a tool to automate the configuration of Hyperion. It basically initializes the connections with all the dependencies and creates the configuration for each chain you are running.

Run ./hyp-config --help for more details.

Initialize connections

First, let's initialize our configuration. Just run:

./hyp-config init connections

Note

This command will also check the connection to Elasticsearch, Rabbitmq and Redis. Make sure everything is up and running.

Add new chain

Now you can proceed and add a new chain to your configuration. Run the following command:

./hyp-config new chain eos --http "http://127.0.0.1:8888" --ship "ws://127.0.0.1:8080"

Check you configuration

Finally, check your configuration running:

/hyp-config list chains

Plugins Set Up

Attention

Under construction

Running Hyperion

We provide scripts to simplify the process of starting and stopping your Hyperion Indexer or API instance.

Starting

To start, just use the run.sh script. Here are some examples:

Examples

Starting indexer for EOS mainnet:

./run.sh eos-indexer
Starting API for test chain:
./run.sh test-api

Note

You need to pass the name of the chain you previously created followed by indexer or api to indicate the instance you want to start.

Stopping

Use the stop.sh script to stop an instance as follows:

Examples

Stop API for EOS mainnet:

./stop.sh eos-api
Stop indexer for WAX mainnet:
./stop.sh wax-indexer

Note

You need to pass the name of the chain you previously created followed by indexer or api to indicate the instance you want to stop.

Attention

The stop script won't stop Hyperion Indexer immediately, it will first flush the queues. Be aware that this operation could take some time.

Indexer

The Hyperion Indexer is configured to perform an abi scan ("abi_scan_mode": true) as default. So, on your first run, you'll probably see something like this:

indexer

This an example of an ABI SCAN on the WAX chain.

Where:

  • W (Workers): Number of workers.
  • R (Read): Blocks read from state history and pushing into the blocks queue.
  • C (Consumed): Blocks consumed from blocks queue.
  • A (Actions): Actions being read out of processed blocks.
  • D (Deserialized): Deserializations of the actions.
  • I (Indexed): Indexing of all of the docs.

API

After running the api, you should see a log like this:

api

Now, it's time to play around making some queries.