kaspanet/kaspa-rest-proxy repository overview

⁠kaspa-rest-proxy

REST to Kaspad wRPC Proxy, written in Python.

⁠About

The proxy aims to mirror all methods available in the rusty-kaspad⁠ wRPC api.

A live demo is available here: https://proxy.kaspa.ws⁠ (no uptime guarantees!).

Source is available here: https://github.com/supertypo/kaspa-rest-proxy⁠

⁠License

MIT, which means this software can be freely modified to any specific need and redistributed (under certain terms).
Please be so kind as to contribute back features you think could be beneficial to the general community.

⁠Contribute to development

kaspa:qrjtsnnpjyvlmkffdqyayrny3qyen9yjkpuw7xvhsz36n69wmrfdyf3nwv67t

⁠Getting started

⁠Run using precompiled Docker image

docker run --rm -it -p 15110:15110 kaspanet/kaspa-rest-proxy:main -s ws://<kaspad_host>:17110

Access the api doc at http://localhost:15110⁠

⁠Using docker compose

Paste the content below into docker-compose.yaml, and run docker compose up -d in the same folder.
The api doc will be available on http://localhost:15110⁠ soon afterward (expect a couple of hours for kaspad to fully sync though).

services:
  kaspa-rest-proxy:
    container_name: kaspa-rest-proxy
    image: kaspanet/kaspa-rest-proxy:latest
    restart: unless-stopped
    ports:
      - "15110:15110"
    command: -s ws://kaspad:17110

  kaspad:
    container_name: kaspad
    image: kaspanet/rusty-kaspad:latest
    restart: unless-stopped
    ports:
      - "127.0.0.1:17110:17110"
    volumes:
      - /var/kaspad:/app/data/
    command: kaspad --yes --nologfiles --disable-upnp --utxoindex --rpclisten-borsh=0.0.0.0:17110