Merge remote-tracking branch 'origin/main' into HEAD

.github/workflows/docker-image.yml

@@ -1,26 +1,44 @@
-name: Docker Image CI
-
+name: Docker Image
 on:
   release:
     types: [ published ]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        arch: [ amd64, arm64 ]
+
+    runs-on: ${{ matrix.os }}
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Add SHORT_SHA env property with commit short sha
+        run: echo "SHORT_SHA=`echo ${GITHUB_SHA} | cut -c1-7`" >> $GITHUB_ENV
+      - name: Checkout code
+        uses: actions/checkout@v2
+
       - name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: lamer1
           password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
-      - name: Build and push
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          push: true
-          tags: supertypo/kaspa-rest-server:${{github.ref_name}}, supertypo/kaspa-rest-server:latest
-          file: ./docker/Dockerfile
-          build-args: |
-            version=${{github.ref_name}}
+
+      - name: Set up QEMU (for ARM64 emulation)
+        if: matrix.arch == 'arm64'
+        run: |
+          sudo apt-get install -y qemu-user-static
+
+      - name: Set up Docker Buildx (for multi-platform builds)
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push Docker image
+        run: |
+          docker buildx build \
+            --platform linux/amd64,linux/arm64 \
+            -t supertypo/kaspa-rest-server:${{github.ref_name}} \
+            -t supertypo/kaspa-rest-server:latest \
+            --build-arg version=${{github.ref_name}} \
+            --push .
+          
+          docker buildx imagetools inspect supertypo/kaspa-rest-server:latest

.github/workflows/docker-testimage.yml

@@ -1,25 +1,43 @@
-name: Docker Image TESTBUILD
-
+name: Docker Image
 on:
-  workflow_dispatch
+  push:
+    branches-ignore:
+      - main
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        arch: [amd64, arm64]
+
+    runs-on: ${{ matrix.os }}
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: lamer1
-          password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
-      - name: Build and push
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          push: true
-          tags: supertypo/kaspa-rest-server:test
-          file: ./docker/Dockerfile
-          build-args: |
-            version=${{github.ref_name}}
+    - name: Add SHORT_SHA env property with commit short sha
+      run: echo "SHORT_SHA=`echo ${GITHUB_SHA} | cut -c1-7`" >> $GITHUB_ENV
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Login to Docker Hub
+      uses: docker/login-action@v2
+      with:
+        username: lamer1
+        password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+
+    - name: Set up QEMU (for ARM64 emulation)
+      if: matrix.arch == 'arm64'
+      run: |
+        sudo apt-get install -y qemu-user-static
+
+    - name: Set up Docker Buildx (for multi-platform builds)
+      uses: docker/setup-buildx-action@v1
+
+    - name: Build and push Docker image
+      run: |
+        docker buildx build \
+          --platform linux/amd64,linux/arm64 \
+          -t supertypo/kaspa-rest-server:${SHORT_SHA} \
+          --push .
+        
+        docker buildx imagetools inspect supertypo/kaspa-rest-server:${SHORT_SHA}

Dockerfile

@@ -0,0 +1,24 @@
+FROM python:3.12.3-slim
+
+ARG REPO_DIR
+
+EXPOSE 8000
+
+ENV KASPAD_HOST_1=n.seeder1.kaspad.net:16110
+ARG version
+ENV VERSION=$version
+
+RUN apt update
+RUN apt install uvicorn gunicorn -y
+
+WORKDIR /app
+COPY . .
+
+RUN python -m pip install --upgrade pip
+RUN pip install poetry
+RUN poetry install --no-root --no-interaction
+
+# make pipenv commands still running
+RUN ln /usr/local/bin/poetry /usr/local/bin/pipenv
+
+CMD poetry run gunicorn -b 0.0.0.0:8000 -w 4 -k uvicorn.workers.UvicornWorker main:app --timeout 120

constants.py

@@ -0,0 +1,24 @@
+import os
+
+NETWORK_TYPE = os.getenv('NETWORK_TYPE', 'mainnet').lower()
+
+match NETWORK_TYPE:
+    case "mainnet":
+        address_prefix = "kaspa"
+        address_example = "kaspa:qqkqkzjvr7zwxxmjxjkmxxdwju9kjs6e9u82uh59z07vgaks6gg62v8707g73"
+    case "testnet":
+        address_prefix = "kaspatest"
+        address_example = "kaspatest:qpqz2vxj23kvh0m73ta2jjn2u4cv4tlufqns2eap8mxyyt0rvrxy6ejkful67"
+    case "simnet":
+        address_prefix = "kaspasim"
+        address_example = "kaspasim:qpqz2vxj23kvh0m73ta2jjn2u4cv4tlufqns2eap8mxyyt0rvrxy6ejkful67"
+    case "devnet":
+        address_prefix = "kaspadev"
+        address_example = "kaspadev:qpqz2vxj23kvh0m73ta2jjn2u4cv4tlufqns2eap8mxyyt0rvrxy6ejkful67"
+    case _:
+        raise ValueError(f'Network type {NETWORK_TYPE} not supported.')
+
+ADDRESS_PREFIX = address_prefix
+ADDRESS_EXAMPLE = address_example
+
+REGEX_KASPA_ADDRESS = "^" + ADDRESS_PREFIX + ":[a-z0-9]{61,63}$"

endpoints/__init__.py

@@ -1,8 +1,9 @@
 # encoding: utf-8
 import os
+from fastapi import HTTPException
 from functools import wraps
 
-from fastapi import HTTPException
+from constants import NETWORK_TYPE
 
 
 def filter_fields(response_dict, fields):
@@ -23,3 +24,15 @@ async def wrapper(*args, **kwargs):
         return await func(*args, **kwargs)
 
     return wrapper
+
+
+def mainnet_only(func):
+    @wraps(func)
+    async def wrapper(*args, **kwargs):
+        if NETWORK_TYPE != "mainnet":
+            raise HTTPException(status_code=503, detail="Endpoint not available. "
+                                                        "This endpoint is only available in mainnet.")
+        return await func(*args, **kwargs)
+
+    return wrapper
+

endpoints/get_address_transactions.py

@@ -10,6 +10,7 @@
 from sqlalchemy.future import select
 from starlette.responses import Response
 
+from constants import ADDRESS_EXAMPLE
 from dbsession import async_session
 from endpoints import sql_db_only
 from endpoints.get_transactions import search_for_transactions, TxSearch, TxModel
@@ -57,7 +58,7 @@ class PreviousOutpointLookupMode(str, Enum):
 async def get_transactions_for_address(
         kaspaAddress: str = Path(
             description="Kaspa address as string e.g. "
-                        "kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00",
+                        f"{ADDRESS_EXAMPLE}",
             regex=REGEX_KASPA_ADDRESS)):
     """
     Get all transactions for a given address from database
@@ -103,7 +104,7 @@ async def get_transactions_for_address(
 async def get_full_transactions_for_address(
         kaspaAddress: str = Path(
             description="Kaspa address as string e.g. "
-                        "kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00",
+                        f"{ADDRESS_EXAMPLE}",
             regex=REGEX_KASPA_ADDRESS),
         limit: int = Query(
             description="The number of records to get",
@@ -149,7 +150,7 @@ async def get_full_transactions_for_address_page(
         response: Response,
         kaspaAddress: str = Path(
             description="Kaspa address as string e.g. "
-                        "kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00",
+                        f"{ADDRESS_EXAMPLE}",
             regex=REGEX_KASPA_ADDRESS),
         limit: int = Query(
             description="The max number of records to get. "
@@ -211,7 +212,7 @@ async def get_full_transactions_for_address_page(
 async def get_transaction_count_for_address(
         kaspaAddress: str = Path(
             description="Kaspa address as string e.g. "
-                        "kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00",
+                        f"{ADDRESS_EXAMPLE}",
             regex=REGEX_KASPA_ADDRESS)
 ):
     """

endpoints/get_balance.py

@@ -3,19 +3,19 @@
 from fastapi import Path, HTTPException
 from pydantic import BaseModel
 
+from constants import ADDRESS_EXAMPLE, REGEX_KASPA_ADDRESS
 from server import app, kaspad_client
 
-REGEX_KASPA_ADDRESS = "^kaspa(test)?\:[a-z0-9]{61,63}$"
 
 class BalanceResponse(BaseModel):
-    address: str = "kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00"
+    address: str = ADDRESS_EXAMPLE
     balance: int = 38240000000
 
 
 @app.get("/addresses/{kaspaAddress}/balance", response_model=BalanceResponse, tags=["Kaspa addresses"])
 async def get_balance_from_kaspa_address(
         kaspaAddress: str = Path(
-            description="Kaspa address as string e.g. kaspa:pzhh76qc82wzduvsrd9xh4zde9qhp0xc8rl7qu2mvl2e42uvdqt75zrcgpm00",
+            description=f"Kaspa address as string e.g. {ADDRESS_EXAMPLE}",
             regex=REGEX_KASPA_ADDRESS)):
     """
     Get balance for a given kaspa address

endpoints/get_price.py

@@ -3,6 +3,7 @@
 from pydantic import BaseModel
 from starlette.responses import PlainTextResponse
 
+from endpoints import mainnet_only
 from helper import get_kas_price, get_kas_market_data
 from server import app
 
@@ -13,6 +14,7 @@ class PriceResponse(BaseModel):
 
 
 @app.get("/info/price", response_model=PriceResponse | str, tags=["Kaspa network info"])
+@mainnet_only
 async def get_price(stringOnly: bool = False):
     """
     Returns the current price for Kaspa in USD.
@@ -27,6 +29,7 @@ async def get_price(stringOnly: bool = False):
 @app.get("/info/market-data",
          tags=["Kaspa network info"],
          include_in_schema=False)
+@mainnet_only
 async def get_market_data():
     """
     Returns market data for kaspa.

endpoints/get_utxos.py

@@ -1,12 +1,12 @@
 # encoding: utf-8
-from typing import List
-
+import os
 from fastapi import Path, HTTPException
 from pydantic import BaseModel
+from typing import List
 
+from constants import REGEX_KASPA_ADDRESS, ADDRESS_EXAMPLE
 from server import app, kaspad_client
 
-REGEX_KASPA_ADDRESS = "^kaspa(test)?\:[a-z0-9]{61,63}$"
 
 class OutpointModel(BaseModel):
     transactionId: str = "ef62efbc2825d3ef9ec1cf9b80506876ac077b64b11a39c8ef5e028415444dc9"
@@ -25,14 +25,14 @@ class UtxoModel(BaseModel):
 
 
 class UtxoResponse(BaseModel):
-    address: str = "kaspa:qrzk988gtanp3nf76xkpexwud5cxfmfygqf42hz38pwea74s6qrj75jee85nj"
+    address: str = ADDRESS_EXAMPLE
     outpoint: OutpointModel
     utxoEntry: UtxoModel
 
 
 @app.get("/addresses/{kaspaAddress}/utxos", response_model=List[UtxoResponse], tags=["Kaspa addresses"])
 async def get_utxos_for_address(kaspaAddress: str = Path(
-    description="Kaspa address as string e.g. kaspa:qqkqkzjvr7zwxxmjxjkmxxdwju9kjs6e9u82uh59z07vgaks6gg62v8707g73",
+    description=f"Kaspa address as string e.g. {ADDRESS_EXAMPLE}",
     regex=REGEX_KASPA_ADDRESS)):
     """
     Lists all open utxo for a given kaspa address