Snapshot2S3

This is a tool to generate a snapshot and upload snapshot and addrbook to S3 periodically.

Architecture

Features

• Upload snapshots to S3
  • Maintain only last 2 snapshots.
• Upload addrbook.json to S3
  • Maintain only last 1 addrbook.json.
• Efficiently generate snapshot
  • Only run a node during snapshot generating so that no need to run node continously.
• Provide a API
  • /snapshot: Redirect to latest snapshot URL.
  • /snapshot/status: Get snapshot status related with /snapshot link.

    {
      "redirect_url": "https://your-bucket.s3.your-region.amazonaws.com/snapshot_1234500.tar.lz4",
      "height": 1234500,
      "time": "2025-01-01T00:00:00.000000000Z"
    }

  • /addrbook: Redirect to latest addrbook.json URL.
  • /addrbook/status: Get addrbook.json status related with /addrbook link.

    {
      "redirect_url": "https://your-bucket.s3.your-region.amazonaws.com/addrbook.json",
      "height": 1234500,
      "time": "2025-01-01T00:00:00.000000000Z"
    }

Quick Guide

Prerequisites

• curl, jq, sed, tar, lz4 are required to be installed on the machine.
• This node will set up as systemd. (Just setup not need to run)
• AWS S3 bucket has to be configured public access.

Usage

1. Build

go build

2. Configure config.toml file

cp config.toml.example config.toml

3. Run

./snapshot2s3 -config config.toml