Hedera
Search
K

Run Your Mirror Node with Amazon Web Services S3 (AWS)

Prerequisites

  • Basic understanding of Hedera Mirror Nodes.
  • Docker (>= v20.10.x) installed and opened on your machine. Run docker -v in your terminal to check the version you have installed.
  • Java (openjdk@17: Java version 17), Gradle (the latest version), and PostgreSQL (the latest version) are installed on your machine.

1. Create an IAM user

This step will teach you how to create a new IAM (Identity and Access Management) user and generate new access keys in your AWS account. The access key, secret and project ID will be used to access S3 from the Hedera Mirror Node.
Administrator Policy
Custom Policy
  • Refer to AWS documentation to create an IAM user with an administrator policy here
    • This sets up an IAM user with Administrator Access Policy
    • This user has full access and can delegate permissions to every service and resource in AWS.
  • Once that is complete, select Users from the left IAM navigation bar
  • Select the Administrator from the User name column
  • Select the Security credentials tab
  • Select Create access key
  • Copy or download your Access key ID and Secret access key
  • Enable access to billing data
    • Follow step 2 here
  • From the IAM left navigation bar select Polices
  • Click on Create policy
    • Service
      • Enter S3 as your service
    • Actions
      • Access level
      • Select List and Read
  • Resources
    • Select Specify bucket resource ARN for the GetBucketLocation
    • Add ARN
      • hedera-mainnet-streams
    • Add ARN
      • hedera-mainnet-streams/*
  • Click Next:Tags
  • Click Next: Review
    • Enter a name for the policy
  • Click Create policy
  • From the left navigation bar on the IAM console select User Groups
  • Click Create group
  • Enter a user group name
  • Select the policy that was created in the previous step
  • Click Create Group
  • Click Users from the IAM console left navigation bar
  • Click on Add user
  • Enter username
  • Select Programmatic access for Access type
  • Click Next: Permissions
  • Select the group that was created in the previous step
  • Click Next: Tags
  • Click Next: Review
  • Click Create user
  • Copy or download your Access key ID and Secret access key

2. Clone the Mirror Node Repository

  • Open your terminal and run the following commands to clone the mirror node repository, then cd into the hedera-mirror-node folder:
git clone https://github.com/hashgraph/hedera-mirror-node.git
cd hedera-mirror-node

3. Configure Mirror Node

The application.yml file is the main configuration file for the Hedera Mirror Node. In this step, we will update the configuration file with your specific settings, such as your AWS access key, secret, and the Hedera network you want to mirror.
  • Open the application.yml file in the root directory with a text editor of your choice.
  • cd into the hedera-mirror-node directory from your terminal or IDE.
  • Find the following fields and replace the placeholders with your actual AWS access key, secret key, project ID, and the network you want to mirror:
Item
Description
accessKey
AWS access key
cloudProvider
s3
secretKey
AWS secret key
network
Enter a network to run a mirror node for
application.yml
hedera:
mirror:
importer:
downloader:
accessKey: ENTER ACCESS KEY HERE
cloudProvider: "s3"
secretKey: ENTER SECRET KEY HERE
network: PREVIEWNET/TESTNET/MAINNET #Pick one network

4. Run Your Mirror Node

Start and run the Hedera Mirror Node using Docker. Docker packages development tools in a self-contained environment called a container that can include libraries, code, runtime, and more.
  • From the mirror node directory, run the following command:
docker compose up -d db && docker logs hedera-mirror-node-db-1 --follow

5. Access Your Mirror Node Data

After the mirror node is run successfully, it downloads data from the Hedera Network and stores it in a PostgreSQL database. To access the mirror node data, enter the database container and connect to it using Docker and the psql command-line tool.
  • Open a new terminal and run the following command to view the list of containers:
docker ps
  • Run the following command to enter the hedera-mirror-node-db-1 container:
docker exec -it hedera-mirror-node-db-1 bash
  • Enter the following command to access and query the database:
psql "dbname=mirror_node host=localhost user=mirror_node password=mirror_node_pass port=5432"
  • Enter the following command to view the complete list of all the database tables:
\dt
  • To exit the psql database console, run the quit command:
\q
  • Lastly, run the following command to stop Docker and remove the created containers:
docker compose down

Congratulations! You have successfully run and deployed a Hedera Mirror Node with Amazon Web Services S3 (AWS) 🚀