shadouts/bitcoin-gql repository overview

The git repository can be found at https://github.com/Shadouts/bitcoin-gql⁠

⁠BitcoinGQL

A GraphQL API for the Bitcoin JSON RPC.

⁠Setup

It is expected that you are running a fully indexed Bitcoin Core node (txindex=1) of version 0.18.1 or later with the RPC server enabled. Environment variables are required for RPC authentication, and currently, cookie authentication is not supported by BitcoinGQL.

⁠Required Environment Variables

RPC_USER=<rpcauth or rpcuser username>
RPC_PASS=<rpcauth or rpcpass password>

⁠Optional Environment Variables

If the Docker container will be using the Bitcoin JSON-RPC server on the localhost (default), the container must be started with network mode "host" so that localhost is available. When using a remote Bitcoin JSON-RPC server, the server will require a special configuration to accept remote or Docker bridge connections and these variables will need to be set. Please see Bitcoin's RPC server documentation.

RPC_HOST=<remote ip>
RPC_PORT=<port number>

To make the GraphiQL IDE available, set the following:

GRAPHIQL=1

Other environment variables:

RESTRICT_HEAVY_QUERIES=0 # Set to 1 to lock out gettxoutsetinfo
VERIFY_CHAIN_LIMIT=1000 # Limits how many blocks deep verifychain is allowed to check

The GraphQL API will be served from container port 3000. The GraphiQL IDE and API documentation can be viewed by browsing to /btc-gql with the GRAPHIQL variable set to 1.