blockchain-assignment

Description

Repository used for the Blockchain technical assignment.

Table of Contents

• Database setup and schema
• Installation
• Quick Start
• Dist build
• Deployment with GitHub Actions and Terraform
• API endpoints
• Linting + Pre-commit
• Technical Debt

---

Database setup and schema

Cf. db/startup_scripts.xml

• Optimized schema for the blockchain.transactions table
• Real-time analytics via materialized views
  • tx_analytics - Daily statistics
  • address_activity - Per-address metrics
• Configurable performance settings

Installation

• Create the .env based on the provided .env.example
• Tweak the src/config/*.json(src/config) files to decide which Typescript components will be running (import, realtime, APIs).
• If using the "import" mode, you have to put your source .tar.gz data in $DATA_DIR (Cf. .env)

Quick Start

Run the Docker Compose command:

docker compose up --build

Dist build

Use Docker to build the Typescript app and retrieve it locally:

docker build . --file=src/Dockerfile --tag bctk_app:latest --build-arg BUILD_ONLY="True"
CONTAINERID=$(docker run -d bctk_app:latest)
docker cp $CONTAINERID:/dist .
docker stop $CONTAINERID

Deployment with GitHub Actions and Terraform

For this step, there are many secrets created in GitHub Actions to support the CD workflow and the Terraform provisionning. Follow what is available in the .env and .github/workflows/cd.yml files to gather what is required.

The Terraform setup work:

• fetch the sample data from a Scaleway bucket
• install this repository and all the Node environment
• install a ClickHouse database
• install NGinx with the required configurations
• implement a Letsencrypt certificate with Certbot

API endpoints

When using Docker, you can access the APIs via the following queries:

• Transactions list:

curl -s "http://localhost:3000/transactions?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5" | jq '.'

• Transactions list, sorted by values:

curl -s "http://localhost:3000/transactions/by-value?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5" | jq '.'

• Transactions count:

curl -s "http://localhost:3000/transactions/count?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7

When fully deployed, you can access the APIs via the following URLs:

• List of transactions: https://bctk-demo.fullofstack.eu/transactions?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5
• List of transactions sorted by value: https://bctk-demo.fullofstack.eu/transactions/by-value?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7&page=2&limit=5
• Transactions count: https://bctk-demo.fullofstack.eu/transactions/count?address=0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7

Linting + Pre-commit

Run this command to set up pre-commit:

npx husky init
tee .husky/pre-commit << EOF
  #!/usr/bin/env sh
  npx lint-staged
EOF

Or run this to enforce linting manually:

npx eslint . --fix
npx prettier --write .

Technical Debt

• Implement complete authentication for ClicHouse in Compose setup (Terraform OK)
• Multithreading and improved error handling for the Realtime mode.
• Tests for the Typescript components
• Coverage