Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 2.9 KB

README.md

File metadata and controls

130 lines (95 loc) · 2.9 KB

BITCOIN STAMPS EXPLORER AND API

This is the official API and block explorer for Bitcoin Stamps. It provides a comprehensive interface for exploring Bitcoin Stamps transactions and metadata, working in conjunction with the Bitcoin Stamps Indexer.

Features

  • Full Bitcoin Stamps block explorer
  • API with OpenAPI/Swagger documentation
  • Support for SRC-20, SRC-721, and SRC-101 token standards

Prerequisites

  1. Install Deno

    ⚠️ Required Version: 2.1.5

    curl -fsSL https://deno.land/install.sh | sh

    Add Deno to your path:

    echo 'export DENO_INSTALL="$HOME/.deno"' >> ~/.bashrc
echo 'export PATH="$DENO_INSTALL/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

  2. Required Services

    • MySQL/MariaDB (with read-only user access)
    • Redis (for caching)
    • Bitcoin Stamps Indexer database

Installation

  1. Clone the repository:

    git clone https://github.com/stampchain-io/bitcoin-stamps-explorer.git
cd bitcoin-stamps-explorer

  2. Environment Setup

    cp .env.sample .env
# Edit .env with your configuration

    ⚠️ IMPORTANT: Ensure DB_USER has READ-ONLY permissions for security!

Development Commands

# Start development server with hot reload and debugging
deno task dev

# Code quality checks (formatting, linting, type checking)
deno task check

# Update Fresh framework
deno task update

# Decode SRC-20 transactions
deno task decode
deno task decode_olga

# Run schema validation
deno task validate:schema

Production Deployment

  1. Build the project:

    deno task build

  2. Start production server:

    deno task start

Docker deployment is also supported:

docker build -t btc-stamps-explorer:2.1.5 .
docker run -p 8000:8000 btc-stamps-explorer:2.1.5

The container uses:

  • Deno 2.1.5 Alpine base image
  • Production environment
  • Port 8000
  • Required permissions for network, file system, and environment variables

For development with Docker:

# Build with development tag
docker build -t btc-stamps-explorer:dev .

# Run with mounted volumes for development
docker run -p 8000:8000 \
    --env-file .env \
    -v $(pwd):/app \
    btc-stamps-explorer:dev deno task dev

API Documentation

  • OpenAPI/Swagger documentation available at /docs
  • Schema validation with deno task validate:schema

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Run deno task check to ensure code quality
  4. Add tests for new features
  5. Submit a pull request

Additional Resources

License

This project is licensed under the AGPL-3.0 License.