Hyperion 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.
./hyp-config --help for more details.
First, let's initialize our configuration. Just run:
./hyp-config init connections
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¶
We provide scripts to simplify the process of starting and stopping your Hyperion Indexer or API instance.
To start, just use the run.sh script. Here are some examples:
Starting indexer for EOS mainnet:
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.
Use the stop.sh script to stop an instance as follows:
Stop API for EOS mainnet:
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.
The stop script won't stop Hyperion Indexer immediately, it will first flush the queues. Be aware that this operation could take some time.
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:
This an example of an ABI SCAN on the WAX chain.
- 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.
After running the api, you should see a log like this:
Now, it's time to play around making some queries.