Bran18/backend-SafeTrust

SafeTrust is a decentralized platform designed to revolutionize P2P transactions, providing secure deposits and payments powered by blockchain and trustless technologies. 🌐✨ Experience transparency and reliability in every cryptocurrency transaction. 💸🔒

Windows users: Run bin/dc_prep and bin/dc_console inside WSL (Ubuntu) or Git Bash, as they are Bash scripts targeting a Linux container environment.

bin/dc_prep is the single entry point to bootstrap the entire backend. It starts all containers, deploys Hasura metadata for every tenant, applies database migrations, and seeds initial data — in the correct order.

cp .env.example .env   # fill in your values first
bin/dc_prep            # boots everything

Once it completes, open the Hasura console in a separate terminal:

bin/dc_console

By default, bin/dc_prep deploys all tenants (safetrust and hotel_industry). You can pass tenant names as arguments to limit the scope:

# Deploy all tenants (default)
bin/dc_prep

# Deploy a single tenant
bin/dc_prep safetrust

# Deploy multiple specific tenants
bin/dc_prep safetrust hotel_industry

Copy .env.example to .env and fill in the required values before running bin/dc_prep:

POSTGRES_PASSWORD=your_postgres_password

# Must be valid JSON with a minimum 32-character key for HS256
HASURA_GRAPHQL_JWT_SECRET={"type":"HS256","key":"replace-with-min-32-char-secret-here"}

HASURA_EVENT_SECRET=your_event_secret

⚠️ HASURA_GRAPHQL_JWT_SECRET must be valid JSON and the key must be at least 32 characters for HS256. The script will fail at startup if this is malformed.

The metadata/ folder contains the Hasura GraphQL Engine configuration per tenant.

backend/
└── metadata/
    ├── base/
    │   ├── actions.graphql
    │   ├── actions.yaml
    │   ├── allow_list.yaml
    │   ├── api_limits.yaml
    │   ├── backend_configs.yaml
    │   ├── cron_triggers.yaml
    │   ├── graphql_schema_introspection.yaml
    │   ├── inherited_roles.yaml
    │   ├── metrics_config.yaml
    │   ├── network.yaml
    │   ├── opentelemetry.yaml
    │   ├── query_collections.yaml
    │   ├── remote_schemas.yaml
    │   ├── rest_endpoints.yaml
    │   └── version.yaml
    ├── build/
    │   └── tenant_a/
    │   └── tenant_b/
    │   └── ...
    ├── tenants/
    │   ├── safetrust/
    │   │   ├── databases/
    │   │   ├── tables/
    │   │   ├── functions/
    │   │   └── databases.yaml
    │   └── hotel_industry/
    │       ├── databases/
    │       ├── tables/
    │       ├── functions/
    │       └── databases.yaml
    ├── build-metadata.sh
    ├── deploy-tenant.sh
    └── setup-tenant.sh

Folder guide:

• base/ — Hasura base configuration and GraphQL dependencies shared across all tenants
• build/ — Generated output: tenants merged with base dependencies, ready to deploy
• tenants/ — Tenant-specific database files, tables, functions, relations, and triggers
• build-metadata.sh — Prepares a tenant by merging it with base configurations
• deploy-tenant.sh — Deploys a built tenant to Hasura (tracks tables and relationships)
• setup-tenant.sh — Runs both steps above in one command ✅

Tip: bin/dc_prep handles all of the following automatically. Use these only when targeting a specific step or tenant in isolation.

cd metadata
./setup-tenant.sh <tenant_name> [--admin-secret SECRET] [--endpoint URL]

Example:

./setup-tenant.sh safetrust --endpoint http://localhost:8080

Default values: --admin-secret myadminsecretkey · --endpoint http://localhost:8080

Or step by step:

# Step 1 — Build
./build-metadata.sh <tenant_name> --admin-secret myadminsecretkey --endpoint http://localhost:8080

# Step 2 — Verify build/ folder contains the correct tenant data

# Step 3 — Deploy
./deploy-tenant.sh <tenant_name> --admin-secret myadminsecretkey --endpoint http://localhost:8080

From the project root:

hasura migrate apply \
  --database-name safetrust \
  --endpoint http://localhost:8080 \
  --admin-secret myadminsecretkey

To apply a single migration version:

hasura migrate apply \
  --database-name safetrust \
  --version <timestamp> \
  --type up \
  --endpoint http://localhost:8080 \
  --admin-secret myadminsecretkey

hasura seed apply \
  --database-name safetrust \
  --endpoint http://localhost:8080 \
  --admin-secret myadminsecretkey

This project uses the Karate framework for API testing. Tests run in a Docker environment.

⛩️ Karate Docs

docker compose -f docker-compose-test.yml run --rm --build karate

This command will:

1. Build the test container
2. Start PostgreSQL and Hasura containers
3. Run all Karate tests
4. Show test results in the console
5. Generate HTML reports in target/karate-reports/

After running the tests, find the HTML reports at:

• Summary: tests/results/karate-summary.html
• Detailed: tests/results/karate-tags.html

1. Create new .feature files in tests/karate/features/
2. Follow the Karate DSL syntax
3. Tests are automatically picked up when running the test command

• Main config: tests/karate/src/test/resources/karate-config.js
• Database config: docker-compose-test.yml
• Test environment: Dockerfile.test