https://github.com/pradel/stacks-graphql-api

A GraphQL API to query the Stacks blockchain.
https://github.com/pradel/stacks-graphql-api

stacks

Last synced: about 1 year ago
JSON representation

A GraphQL API to query the Stacks blockchain.

Host: GitHub
URL: https://github.com/pradel/stacks-graphql-api
Owner: pradel
License: mit
Created: 2021-12-02T20:37:21.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2022-03-09T23:31:23.000Z (over 4 years ago)
Last Synced: 2025-03-27T20:23:19.115Z (over 1 year ago)
Topics: stacks
Homepage:
Size: 9.77 KB
Stars: 12
Watchers: 4
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

stacks-graphql-api

A GraphQL API to query the Stacks blockchain.

> 🚧🚧🚧 Consider this repository as highly experimental 🚧🚧🚧

## Features

- Query the Stacks blockchain using a GraphQL API.
- Create complex queries including relations, pagination, sorting, and filtering.
- Realtime updates via GraphQL subscriptions.
- Blazing fast, using [Hasura](https://github.com/hasura/graphql-engine).

## Usage example

### Queries

Get the data of transaction `0x5cca607a5fa44855e2b56dd4fc41a53b871c1f75eecbf5e271c2d6439e32b745`:

```graphql
{
transactions_connection(
where: {
tx_id: {
_eq: "\\x5cca607a5fa44855e2b56dd4fc41a53b871c1f75eecbf5e271c2d6439e32b745"
}
}
) {
edges {
node {
id
sender_address
fee_rate
nonce
contract_call_contract_id
contract_call_function_name
contract_call_function_args
contract_call {
source_code
tx_id
}
block {
block_hash
block_height
burn_block_time
burn_block_hash
burn_block_height
}
ft_events {
asset_event_type_id
asset_identifier
sender
recipient
}
nft_events {
asset_event_type_id
asset_identifier
sender
recipient
}
}
}
}
}
```

### Subscriptions

Receive an event when a new block is mined:

```graphql
subscription {
blocks_connection(first: 1, order_by: {block_height: desc}) {
edges {
node {
block_height
block_hash
burn_block_time
burn_block_hash
burn_block_height
# Number of transactions included in the block
transactions_aggregate {
aggregate {
count
}
}
}
}
}
```

## Deploying with docker-compose

The `docker-compose.yml` file start a stacks-blockchain node, the stacks-blockchain-api which is seeding a Postgres database, and the Hasura GraphQL API.

On your server run:

```sh
docker-compose up -d
```

Then to apply the metadata to the deployed Hasura instance, run:

```sh
cd stacks-graphql-api
hasura metadata apply --endpoint https://my-endpoint --admin-secret "super-secret"
```

Finally to interact with the API, go to https://graphqlbin.com/v2/new (or any GraphiQL client) and use https://my-server-ip:8080/v1beta1/relay for the endpoint. On the right side, you will be able to browse the GraphQL schema docs.

## Contributing

Do you have an idea or want to contribute? Pull requests are very welcome!

## Known limitations

- No support for balances
- Some tables are not tracked and exposed yet
- No clean views to convert "bytea" to "hex" in the query response as well as the "where" arguments - Hasura does not support Materialized Views for relay yet https://github.com/hasura/graphql-engine/issues/5044

## License

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pradel/stacks-graphql-api

Awesome Lists containing this project

README

stacks-graphql-api