Graph Node indexes data from blockchains such as Ethereum and serves it over GraphQL
The Graph is a protocol for building decentralized applications (dApps) quickly on Ethereum and IPFS using GraphQL.
Graph Node is an open source Rust implementation that event sources the Ethereum blockchain to deterministically update a data store that can be queried via the GraphQL endpoint.
For detailed instructions and more context, check out the Getting Started Guide.
To build and run this project you need to have the following installed on your system:
rustfmt, which is part of the default Rust installation, is a build-time requirement.
For Ethereum network data, you can either run your own Ethereum node or use an Ethereum node provider of your choice.
This is a quick example to show a working Graph Node. It is a subgraph for Gravatars.
ipfs initfollowed by
initdb -D .postgresfollowed by
pg_ctl -D .postgres -l logfile startand
sudo apt-get install -y clang libpq-dev libssl-dev pkg-config
yarn yarn codegen
Once you have all the dependencies set up, you can run the following:
cargo run -p graph-node --release -- \ --postgres-url postgresql://USERNAME[:PASSWORD]@localhost:5432/graph-node \ --ethereum-rpc NETWORK_NAME:[CAPABILITIES]:URL \ --ipfs 127.0.0.1:5001
Try your OS username as
PASSWORD. For details on setting the connection string, check the Postgres documentation.
graph-nodeuses a few Postgres extensions. If the Postgres user with which you run
graph-nodeis a superuser,
graph-nodewill enable these extensions when it initalizes the database. If the Postgres user is not a superuser, you will need to create the extensions manually since only superusers are allowed to do that. To create them you need to connect as a superuser, which in many installations is the
psql -q -X -U graph-node <; EOF
This will also spin up a GraphiQL interface at
Then you can deploy the subgraph:
This will build and deploy the subgraph to the Graph Node. It should start indexing the subgraph immediately.
USAGE: graph-node [FLAGS] [OPTIONS] --ethereum-ipc --ethereum-rpc --ethereum-ws --ipfs --postgres-url
FLAGS: --debug Enable debug logging -h, --help Prints help information -V, --version Prints version information
OPTIONS: --admin-port Port for the JSON-RPC admin server [default: 8020] --elasticsearch-password Password to use for Elasticsearch logging [env: ELASTICSEARCH_PASSWORD]
--elasticsearch-url <url> Elasticsearch service to write subgraph logs to [env: ELASTICSEARCH_URL=] --elasticsearch-user <user> User to use for Elasticsearch logging [env: ELASTICSEARCH_USER=] --ethereum-ipc <network_name:> Ethereum network name (e.g. 'mainnet'), optional comma-seperated capabilities (eg full,archive), and an Ethereum IPC pipe, separated by a ':' --ethereum-polling-interval <milliseconds> How often to poll the Ethereum node for new blocks [env: ETHEREUM_POLLING_INTERVAL=] [default: 500] --ethereum-rpc <network_name:> Ethereum network name (e.g. 'mainnet'), optional comma-seperated capabilities (eg 'full,archive'), and an Ethereum RPC URL, separated by a ':' --ethereum-ws <network_name:> Ethereum network name (e.g. 'mainnet'), optional comma-seperated capabilities (eg `full,archive), and an Ethereum WebSocket URL, separated by a ':' --http-port <port> Port for the GraphQL HTTP server [default: 8000] --ipfs <port> HTTP address of an IPFS node --node-id <node_id> a unique identifier for this node [default: default] --postgres-url <url> Location of the Postgres database used for storing entities --subgraph name and IPFS hash of the subgraph manifest --ws-port <port> Port for the GraphQL WebSocket server [default: 8001]
The command line arguments generally are all that is needed to run a
graph-nodeinstance. For advanced uses, various aspects of
graph-nodecan further be configured through environment variables. Very large
graph-nodeinstances can also split the work of querying and indexing across multiple databases.
node— A local Graph Node.
graph— A library providing traits for system components and types for common data.
core— A library providing implementations for core components, used by all nodes.
chain/ethereum— A library with components for obtaining data from Ethereum.
graphql— A GraphQL implementation with API schema generation, introspection, and more.
mock— A library providing mock implementations for all system components.
runtime/wasm— A library for running WASM data-extraction scripts.
server/http— A library providing a GraphQL server over HTTP.
store/postgres— A Postgres store with a GraphQL-friendly interface and audit logs.
🔨 = In Progress
🛠 = Feature complete. Additional testing required.
✅ = Feature complete
| Feature | Status | | ------- | :------: | | Ethereum | | | Indexing smart contract events | ✅ | | Handle chain reorganizations | ✅ | | Mappings | | | WASM-based mappings| ✅ | | TypeScript-to-WASM toolchain | ✅ | | Autogenerated TypeScript types | ✅ | | GraphQL | | | Query entities by ID | ✅ | | Query entity collections | ✅ | | Pagination | ✅ | | Filtering | ✅ | | Entity relationships | ✅ | | Subscriptions | ✅ |
Copyright © 2018-2019 Graph Protocol, Inc. and contributors.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for the specific language governing permissions and limitations under the License.