ethql is a server that exposes a GraphQL endpoint to the public Ethereum ledger. It works against the standard JSON-RPC APIs offered by all Ethereum clients. It is built in TypeScript, and thus leverages the vast ecosystem of GraphQL tooling while preserving compile-time type safety.
ethql regards blockchain data as a graph, and leverages the extensibility of GraphQL to introduce additional functionality, amongst which are:
- Decoding of standard transactions (e.g. ERC20, ENS, ERC223, etc.) out of the box.
- New query patterns enabled by indexing solutions (e.g. all transactions between any two accounts).
- Automatic batching and caching of requests.
- New filtering capabilities.
- Simple, inline unit conversions.
- Enhancing public data with information overlays imported from other sources.
NOTE: This project is under heavy development.
You need a running Node environment with at least:
- nodejs >= 8.0.0
- yarn
Clone the repo and run:
$ yarn install
$ npm run dev
JSON-RPC (web3): Using HTTP(S) provider with endpoint: https://mainnet.infura.io/
Running a GraphQL API server at http://0.0.0.0:4000/graphql (browse here: http://localhost:4000/graphql)
This ethql server uses Infura as a backend in anonymous mode. If you have an Infura ID (and if you don't, you should sign up for one!) you can set it like this:
$ INFURA_ID=myid npm run dev
Fetch all transactions from block 5000000 that have input data, and for those that can be decoded as token transfers, return the token symbol, sending and receiving addresses, as well as the token balance of the sending address.
{
block(number: 5000000) {
hash
transactions(filter: { withInput: true }) {
index
hash
from {
address
}
to {
address
}
decoded {
... on ERC20Transfer {
tokenContract {
symbol
}
from {
account {
address
}
tokenBalance
}
to {
account {
address
}
}
value
}
}
}
}
}
For all blocks between 5400000 and 5400005 inclusive (6 blocks), get the balance of all addresses that sent a transaction.
{
blocksRange(numberRange: [5400000, 5400005]) {
transactions {
hash
value
from {
address
balance
}
to {
address
}
}
}
}
PegaSys’ mission is to build blockchain solutions ready for production in business environments. We are committed to open source, and are creating a framework for collaborative innovation for the public-chain community and leading enterprises.
Our team is composed of engineers leading in the areas of big data processing, applied cryptography, open source computing, cloud services, and blockchain development.