blitz_api/app/bitcoind/router.py

from fastapi import APIRouter, HTTPException, status
from fastapi.params import Depends, Query

from app.auth.auth_bearer import JWTBearer
from app.bitcoind.docs import estimate_fee_mode_desc
from app.bitcoind.models import (
    BlockchainInfo,
    BtcInfo,
    FeeEstimationMode,
    NetworkInfo,
    RawTransaction,
)
from app.bitcoind.service import (
    estimate_fee,
    get_blockchain_info,
    get_btc_info,
    get_network_info,
    get_raw_transaction,
)
from app.bitcoind.utils import bitcoin_rpc

_PREFIX = "bitcoin"

router = APIRouter(prefix=f"/{_PREFIX}", tags=["Bitcoin Core"])


@router.get(
    "/btc-info",
    name=f"{_PREFIX}.btc-info",
    description=(
        "Get general information about bitcoin core. Combines most important "
        "information from `getblockchaininfo` and `getnetworkinfo`"
    ),
    dependencies=[Depends(JWTBearer())],
    response_model=BtcInfo,
)
async def btc_info_path():
    return await get_btc_info()


@router.get(
    "/get-block-count",
    name=f"{_PREFIX}.get-block-count",
    summary="Get the current block count",
    description="See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/blockchain/getblockcount/)",
    response_description="""A JSON String with relevant information.\n
```json
{
  \"result\": 682621,
  \"error\": null,
  \"id\": 0
}
""",
    dependencies=[Depends(JWTBearer())],
)
def getblockcount():
    r = bitcoin_rpc("getblockcount")

    if r.status_code == status.HTTP_200_OK:
        return r.content
    else:
        raise HTTPException(r.status_code, detail=r.reason)


@router.get(
    "/get-blockchain-info",
    name=f"{_PREFIX}.get-blockchain-info",
    summary="Get the current blockchain status",
    description="See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/blockchain/getblockchaininfo/)",
    response_description="A JSON String with relevant information.",
    dependencies=[Depends(JWTBearer())],
    response_model=BlockchainInfo,
)
async def getblockchaininfo():
    info = await get_blockchain_info()
    return info


@router.get(
    "/estimate-fee",
    name=f"{_PREFIX}.estimate-fee",
    summary="Get current fee estimation from Bitcoin Core",
    description="""Estimates the fee for the given parameters.
    See documentation on [bitcoin.org](https://developer.bitcoin.org/reference/rpc/estimatesmartfee.html)
    """,
    response_description="The estimated fee in satoshis",
    dependencies=[Depends(JWTBearer())],
    response_model=int,
)
async def _estimate_fee(
    target_conf: int = Query(
        6,
        description="Confirmation target in blocks.",
    ),
    mode: FeeEstimationMode = Query(
        FeeEstimationMode.CONSERVATIVE, description=estimate_fee_mode_desc
    ),
):
    return await estimate_fee(target_conf, mode)


@router.get(
    "/get-network-info",
    name=f"{_PREFIX}.get-network-info",
    summary="Get information about the network",
    description="See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/network/getnetworkinfo/)",
    response_description="A JSON String with relevant information.",
    dependencies=[Depends(JWTBearer())],
    status_code=status.HTTP_200_OK,
    response_model=NetworkInfo,
)
async def getnetworkinfo():
    info = await get_network_info()
    return info


@router.get(
    "/get-raw-transaction",
    name=f"{_PREFIX}.get-raw-transaction",
    summary="Get information about a raw transaction",
    description="See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/22.0.0/rpc/rawtransactions/getrawtransaction/)",
    response_description="A JSON String with relevant information.",
    dependencies=[Depends(JWTBearer())],
    response_model=RawTransaction,
    responses={
        400: {"description": "Invalid transaction id or -txindex not enabled"},
        404: {"description": "No such mempool or blockchain transaction."},
    },
)
async def get_raw_transaction_path(
    txid: str = Query(
        ..., min_length=64, max_length=64, description="The transaction id"
    ),
):
    return await get_raw_transaction(txid)