move to develop as main branch

.env

@@ -0,0 +1,2 @@
+# Test DB connection
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/be_api_test_db?schema=public

.github/workflows/deploy-docs.yml

@@ -0,0 +1,39 @@
+name: Deploy OpenAPI Docs
+
+on:
+  push:
+    branches:
+      - release/mainnet
+      - release/integrationnet 
+      - release/testnet
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    environment: ${{ (github.ref_name == 'release/testnet' && 'testnet') || (github.ref_name == 'release/integrationnet' && 'integrationnet') || (github.ref_name == 'release/mainnet' && 'mainnet') }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install Redocly CLI
+        run: npm install -g @redocly/cli@1.34.2
+
+      - name: Build OpenAPI Docs
+        run: redocly build-docs docs/openapi.yaml -o docs/index.html
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-west-1
+
+      - name: Sync to S3
+        run: |
+          aws s3 sync docs/ s3://${{ secrets.S3_BUCKET_NAME }}/ --delete

.github/workflows/deploy-postgres.yml

@@ -11,7 +11,7 @@ name: Deploy postgress app
 jobs:
   deploy:
     name: Deploy ${{ github.ref_name }} to ${{ inputs.environment }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     environment: ${{ inputs.environment }}
     steps:
       - name: Checkout code
@@ -37,7 +37,7 @@ jobs:
       - name: Serverless deploy
         uses: serverless/github-action@v3
         with:
-          args: deploy --stage ${{ inputs.environment }}20 --region us-west-1
+          args: deploy --stage ${{ inputs.environment }} --region us-west-1
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.github/workflows/pull_request.yml

@@ -9,12 +9,29 @@ jobs:
     strategy:
       matrix:
         node-version: [19.x]
+
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: be_api_test_db
+        ports:
+          - 5432:5432
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -25,4 +42,4 @@ jobs:
         run: npm run test:tsc
 
       - name: Test
-        run: npm test -- --coverage --ci
+        run: npm run test

CHANGELOG.md

@@ -1,51 +1,72 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
 ## [v3.1.0] 2023-06-15
+
 - Fix currency snapshot rewards
 
 ## [v3.0.6] 2023-06-15
+
 - Currency Framework support
 
 ## [v3.0.5] 2023-03-30
+
 - Revert "Fix false non-zero balances"
 
 ## [v3.0.4] 2023-02-24
+
 - Fix deploy workflow
 
 ## [v3.0.3] 2023-02-24
+
 - Fix false non-zero balances
 
 ## [v3.0.2] 2022-11-17
+
 - Fix 'next' reference for pagination
 
 ## [v3.0.1] 2022-10-05
+
 - Fix returned type of balances endpoint
 
 ## [v3.0.0] 2022-09-22
+
 Mainnet 2.0 - upgraded block explorer
 
 ## [v2.0.4] 2021-10-15
+
 ### Fixed
+
 - Fetch by address using keyword field
 
 ## [v2.0.3] 2021-06-25
+
 ### Changed
+
 - Fetch checkpoint block by soe hash by default and fallback to search by base hash
 
 ## [v2.0.2] 2020-10-19
+
 ### Changed
+
 - Query parameters search_after and limit can be provided independently
 
 ## [v2.0.1] 2020-10-16
+
 ### Added
+
 - Pagination support
+
 ### Changed
+
 - Get by hash triggers document API
 - Max size limit when no pagination used
 
 ## [v2.0.0] 2020-10-13
+
 ### Added
+
 - Changelog introduced

README.md

@@ -1,41 +1,99 @@
-Block Explorer
-===========
+# Block Explorer
 
 ![build](https://img.shields.io/github/actions/workflow/status/Constellation-Labs/block_explorer/release.yml?label=build)
 ![version](https://img.shields.io/github/v/release/Constellation-Labs/block_explorer?sort=semver)
 
-Block Explorer exposes API functions to retrieve on-chain data from a tessellation opensearch database cluster.
+The Block Explorer provides API functions to retrieve on-chain data from a Constellation Network indexer. The service uses PostgreSQL for data storage and retrieval and the Serverless framework for API deployment.
 
-## Build and Run
+## Table of Contents
 
-### Prerequisites
+- [Block Explorer](#block-explorer)
+  - [Table of Contents](#table-of-contents)
+  - [Prerequisites](#prerequisites)
+  - [Quick Start](#quick-start)
+  - [Development](#development)
+    - [Database Setup](#database-setup)
+    - [API Development](#api-development)
+  - [Testing](#testing)
+  - [API Documentation](#api-documentation)
 
-1. [TypeScript](https://www.typescriptlang.org/id/download)
-2. [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/)
-3. [Docker Desktop](https://www.docker.com/get-started/) with [Kubernetes](https://docs.docker.com/desktop/kubernetes/) enabled
+## Prerequisites
 
-### Setup local development cluster
-An [opensearch](https://aws.amazon.com/what-is/opensearch/) instance is used to store and query the on-chain data.
+- [Node.js](https://nodejs.org/) (v18 or higher recommended)
+- [TypeScript](https://www.typescriptlang.org/download)
+- [Docker](https://www.docker.com/get-started/)
+- [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/)
 
-Follow the instructions from the [snapshot streaming](https://github.com/Constellation-Labs/snapshot-streaming) repository which sets up your local tessellation development cluster along with an opensearch instance (hosted on port `4510`). 
+## Quick Start
 
-### Run
-Install the npm packages from the project directory:
-```
-npm install
-```
+1. Clone the repository
+   ```bash
+   git clone https://github.com/Constellation-Labs/block_explorer.git
+   cd block_explorer
+   ```
+
+2. Install dependencies
+   ```bash
+   npm install
+   ```
+
+3. Start the PostgreSQL database
+   ```bash
+   npm run db:start
+   ```
+
+4. Run the API locally
+   ```bash
+   serverless offline
+   ```
 
-Start the serverless offline host to test the APIs locally:
+## Development
+
+### Database Setup
+
+The project uses PostgreSQL for data storage. A Docker Compose configuration is provided for easy setup:
+
+```bash
+# Start the PostgreSQL container
+npm run db:start
+
+# To stop the container when finished
+npm run db:stop
 ```
+
+The database configuration is stored in `.env` and can be customized as needed.
+
+### API Development
+
+Start the serverless offline host to test API endpoints locally:
+
+```bash
 serverless offline
 ```
 
-The output of this command shows an overview of the function URL's that can be called locally.
+This will display a list of available endpoints that can be called locally.
 
-## Unit Tests
+## Testing
 
+Run tests with the following commands:
 
-Run the unit tests locally:
-```
+```bash
+# Start the database if not already running
+npm run db:start
+
+# Run tests (this will reset and seed the database automatically)
 npm run test
 ```
+
+The test suite uses Jest and automatically resets the database schema before each test run.
+
+## API Documentation
+
+API endpoints are defined in the `routes/` directory with their handlers in `src/handlers/`.
+
+Available endpoints include:
+- DAG operations
+- Metagraph information
+- Token locks
+- Actions
+- Allow spends

babel.config.js

@@ -1,13 +1,13 @@
 module.exports = {
-    presets: [
-        [
-            '@babel/preset-env',
-            {
-                targets: {
-                    node: 'current',
-                },
-            },
-        ],
-        '@babel/preset-typescript',
+  presets: [
+    [
+      "@babel/preset-env",
+      {
+        targets: {
+          node: "current",
+        },
+      },
     ],
-};
+    "@babel/preset-typescript",
+  ],
+};

docker-compose.yml

@@ -0,0 +1,22 @@
+version: '3.8'
+
+services:
+  postgres:
+    image: postgres:15
+    restart: unless-stopped
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: be_api_test_db
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD", "pg_isready", "-U", "postgres"]
+      interval: 2s
+      timeout: 5s
+      retries: 10
+
+volumes:
+  postgres_data: