graphman rewind
has changed, block-number and block-hash are now flags instead of argumentsgraphman rewind
now has an extra flag--start-block
which will rewind to the startBlock set in manifest or to the genesis block if no startBlock is setgraphman
now has two new commandspause
andresume
that can be used to pause and resume a deployment
- Fulltext searches can now be combined with
where
filtering, further narrowing down search results. #4442 - Tweaked how RPC provider limiting rules are interpreted from configurations. In particular, node IDs that don't match any rules of a provider won't have access to said provider instead of having access to it for an unlimited number of subgraphs. Read the docs for more information. #4353
- Introduced WASM host function
store.get_in_block
, which is a much faster variant ofstore.get
limited to entities created or updated in the current block. #4540 - The entity cache that
graph-node
keeps around is much more efficient, meaning more cache entries fit in the same amount of memory resulting in a performance increase under a wide range of workloads. #4485 - The
subgraph_deploy
JSON-RPC method now accepts ahistory_blocks
parameter, which indexers can use to set default amounts of history to keep. #4564 - IPFS requests for polling file data sources are not throttled anymore (also known as concurrency or burst limiting), only rate-limited. #4570
- Exponential requests backoff when retrying failed subgraphs is now "jittered", smoothing out request spikes. #4476
- RPC provider responses that decrease the chain head block number (non-monotonic) are now ignored, increasing resiliency against inconsistent provider data. #4354
- It's now possible to to have a Firehose-only chain with no RPC provider at all in the configuration. #4508, #4553
- The materialized views in the
info
schema (table_sizes
,subgraph_sizes
, andchain_sizes
) that provide information about the size of various database objects are now automatically refreshed every 6 hours. #4461 - Adapter selection now takes error rates into account, preferring adapters with lower error rates. #4468
- The substreams protocol has been updated to
sf.substreams.rpc.v2.Stream/Blocks
. #4556 - Removed support for
GRAPH_ETHEREUM_IS_FIREHOSE_PREFERRED
,REVERSIBLE_ORDER_BY_OFF
, andGRAPH_STORE_CONNECTION_TRY_ALWAYS
env. variables. #4375, #4436
- Fixed a bug that would cause subgraphs to fail with a
subgraph writer poisoned by previous error
message following certain database errors. #4533 - Fixed a bug that would cause subgraphs to fail with a
store error: no connection to the server
message when database connection e.g. gets killed. #4435 - The
subgraph_reassign
JSON-RPC method doesn't fail anymore when multiple deployment copies are found: only the active copy is reassigned, the others are ignored. #4395 - Fixed a bug that would cause
on_sync
handlers on copied deployments to fail with the messageSubgraph instance failed to run: deployment not found [...]
. #4396 - Fixed a bug that would cause the copying or grafting of a subgraph while pruning it to incorrectly set
earliest_block
in the destination deployment. #4502 - Handler timeouts would sometimes be reported as deterministic errors with the error message
Subgraph instance failed to run: Failed to call 'asc_type_id' with [...] wasm backtrace [...]
; this error is now nondeterministic and recoverable. #4475 - Fixed faulty exponential request backoff behavior after many minutes of failed requests, caused by an overflow. #4421
json.fromBytes
and allBigInt
operations now require more gas, protecting against malicious subgraphs. #4594, #4595- Fixed faulty
startBlock
selection logic in substreams. #4463
- The behavior for
graphman prune
has changed: running justgraphman prune
will mark the subgraph for ongoing pruning in addition to performing an initial pruning. To avoid ongoing pruning, usegraphman prune --once
(docs). #4429 - The env. var.
GRAPH_STORE_HISTORY_COPY_THRESHOLD
–which serves as a configuration setting forgraphman prune
– has been renamed toGRAPH_STORE_HISTORY_REBUILD_THRESHOLD
. #4505 - You can now list all existing deployments via
graphman info --all
. #4347 - The command
graphman chain call-cache remove
now requires--remove-entire-cache
as an explicit flag, protecting against accidental destructive command invocations. #4397 graphman copy create
accepts two new flags,--activate
and--replace
, which make moving of subgraphs across shards much easier. #4374- The log level for
graphman
is now set viaGRAPHMAN_LOG
or command line instead ofGRAPH_LOG
. #4462 graphman reassign
now emits a warning when it suspects a typo in node IDs. #4377
- Subgraph syncing time metric
deployment_sync_secs
now stops updating once the subgraph has synced. #4489 - New
endpoint_request
metric to track error rates of different providers. #4490, #4504, #4430 - New metrics
chain_head_cache_num_blocks
,chain_head_cache_oldest_block
,chain_head_cache_latest_block
,chain_head_cache_hits
, andchain_head_cache_misses
to monitor the effectiveness ofgraph-node
's in-memory chain head caches. #4440 - The subgraph error message
store error: Failed to remove entities
is now more detailed and contains more useful information. #4367 eth_call
logs now include the provider string. #4548- Tweaks and small changes to log messages when resolving data sources, mappings, and manifests. #4399
FirehoseBlockStream
andFirehoseBlockIngestor
now log adapter names. #4411- The
deployment_count
metric has been split intodeployment_running_count
anddeployment_count
. #4401, #4398
Full Changelog: https://github.com/graphprotocol/graph-node/compare/v0.30.0...aa6677a38
New graph-node
installations now mandate PostgreSQL to use C locale and UTF-8 encoding. The official docker-compose.yml
template has been updated accordingly. Pre-existing graph-node
installations are not concerned with this change, but local development scripts and CI pipelines may have to adjust database initialization parameters. This can be done with initdb -E UTF8 --locale=C
. #4163, #4151, #4201, #4340
- AND/OR filters. AND/OR logical operators in
where
filters have been one ofgraph-node
's most awaited features. They do exactly what you would expect them to do, and are very powerful. #579, #4080, #4171 - IPFS file data sources. IPFS file data sources allow subgraph developers to query offchain information from IPFS directly in mappings. This feature is the culmination of much community and development efforts (GIP here). A future iteration of this feature will also include a so-called "Availability Chain", allowing IPFS file data sources to contribute to Proofs of Indexing. At the moment, entity updates that originate from these data sources' handlers do not contribute to PoIs. #4147, #4162, and many others!
- Sorting by child entities (a.k.a. nested sorting). You can now
orderBy
properties of child entities. #4058, #3737, #3096 - Added support for a Firehose-based block ingestor. Indexers that use the new Firehose-based block ingestor cannot automatically switch back to RPC. In order to downgrade, indexers must manually delete all blocks accumulated by Firehose in the database. For this reason, we suggest caution when switching over from RPC to Firehose. #4059, #4204, #4216
- Fields of type
Bytes
can now use less than and greater than filters. #4285 - "userinfo" is now allowed in IPFS URLs (e.g.
https://foo:bar@example.com:5001/
). #4252 - The default for
GRAPH_IPFS_TIMEOUT
is now 60 seconds instead of 30. #4324 - Forking options can now be set via env. vars. (
GRAPH_START_BLOCK
,GRAPH_FORK_BASE
,GRAPH_DEBUG_FORK
). #4308 - Allow retrieving GraphQL query tracing over HTTP if the env. var.
GRAPH_GRAPHQL_TRACE_TOKEN
is set and the headerX-GraphTraceQuery
is included. The query traces' JSON is the same as returned bygraphman query
. #4243 - Lots of visual and filtering improvements to #4232
- More aggressive in-memory caching of blocks close the chain head, potentially alleviating database load. #4215
- New counter Prometheus metric
query_validation_error_counter
, labelled by deployment ID and error code. #4230 graph_elasticsearch_logs_sent - Turned "Flushing logs to Elasticsearch" log into a Prometheus metric (
graph_elasticsearch_logs_sent
) to reduce log noise. #4333 - New materialized view
info.chain_sizes
, which works the same way as the already existinginfo.subgraph_sizes
andinfo.table_sizes
. #4318 - New
graphman stats
subcommandsset-target
andtarget
to manage statistics targets for specific deployments (i.e. how much data PostgreSQL samples when analyzing a table). #4092
graph-node
now has PID=1 when running inside the official Docker image. #4217- More robust
ipfs.cat
logic during grafted subgraphs' manifest lookup. #4284 - Fixed a bug that caused some large multi-entity inserts to fail because of faulty chunk size calculation. #4250
- Subgraph pruning now automatically cancels ongoing autovacuum, to avoid getting stuck. #4167
ens.getNameByHash
now fails nondeterministically if ENS rainbow tables are not available locally. #4219- Some kinds of subgraph failures were previously wrongly treated as unattestable (value parsing,
enum
and scalar coercion), i.e. nondeterministic. These subgraph failure modes are now flagged as fully-deterministic. #4278
Full Changelog: https://github.com/graphprotocol/graph-node/compare/v0.29.0...e5dd53df05d0af9ae4e69db2b588f1107dd9f1d6
-
This release includes a determinism fix that affect a very small number of subgraphs on the network (we counted 2): if a subgraph manifest had one data source with no contract address, listening to the same events or calls of another data source that has a specified address, then the handlers for those would be called twice. After the fix, this will happen no more, and the handler will be called just once like it should.
Affected subgraph deployments:
Qmccst5mbV5a6vT6VvJMLPKMAA1VRgT6NGbxkLL8eDRsE7
Qmd9nZKCH8UZU1pBzk7G8ECJr3jX3a2vAf3vowuTwFvrQg
Here's an example manifest, taking a look at the data sources of name
ERC721
andCryptoKitties
, both listen to theTransfer(...)
event. Considering a block where there's only one occurence of this event,graph-node
would duplicate it and callhandleTransfer
twice. Now this is fixed and it will be called only once per event/call that happened on chain.In the case you're indexing one of the impacted subgraphs, you should first upgrade the
graph-node
version, then rewind the affected subgraphs to the smalleststartBlock
of their subgraph manifest. To achieve that thegraphman rewind
CLI command can be used.See #4055 for more information.
-
This release fixes another determinism bug that affects a handful of subgraphs. The bug affects all subgraphs which have an
apiVersion
older than 0.0.5 using call handlers. While call handlers prior to 0.0.5 should be triggered by both failed and successful transactions, in some cases failed transactions would not trigger the handlers. This resulted in nondeterministic behavior. With this version ofgraph-node
, call handlers with anapiVersion
older than 0.0.5 will always be triggered by both successful and failed transactions. Behavior forapiVersion
0.0.5 onward is not affected.The affected subgraphs are:
QmNY7gDNXHECV8SXoEY7hbfg4BX1aDMxTBDiFuG4huaSGA
QmYzsCjrVwwXtdsNm3PZVNziLGmb9o513GUzkq5wwhgXDT
QmccAwofKfT9t4XKieDqwZre1UUZxuHw5ynB35BHwHAJDT
QmYUcrn9S1cuSZQGomLRyn8GbNHmX8viqxMykP8kKpghz6
QmecPw1iYuu85rtdYL2J2W9qcr6p8ijich9P5GbEAmmbW5
Qmaz1R8vcv9v3gUfksqiS9JUz7K9G8S5By3JYn8kTiiP5K
In the case you're indexing one of the impacted subgraphs, you should first upgrade the
graph-node
version, then rewind the affected subgraphs to the smalleststartBlock
of their subgraph manifest. To achieve that thegraphman rewind
CLI command can be used.See #4149 for more information.
- Grafted subgraphs can now add their own data sources. #3989, #4027, #4030
- Add support for filtering by nested interfaces. #3677
- Add support for message handlers in Cosmos #3975
- Dynamic data sources for Firehose-backed subgraphs. #4075
- Various logging improvements. #4078, #4084, #4031, #4144, #3990
- Some DB queries now have GCP Cloud Insight -compliant tags that show where the query originated from. #4079
- New configuration variable
GRAPH_STATIC_FILTERS_THRESHOLD
to conditionally enable static filtering based on the number of dynamic data sources. #4008 - New configuration variable
GRAPH_STORE_BATCH_TARGET_DURATION
. #4133
- The official Docker image now runs on Debian 11 "Bullseye". #4081
- We now ship
envsubst
with the official Docker image, allowing you to easily run templating logic on your configuration files. #3974
We have a new documentation page for graphman
, check it out here!
- Subgraph pruning with
graphman
! #3898, #4125, #4153, #4152, #4156, #4041 - New command
graphman drop
to hastily delete a subgraph deployment. #4035 - New command
graphman chain call-cache
for clearing the call cache for a given chain. #4066 - Add
--delete-duplicates
flag tographman check-blocks
by @tilacog in graphprotocol#3988
- Restarting a node now takes much less time because
postgres_fdw
user mappings are only rebuilt upon schema changes. If necessary, you can also use the new commandsgraphman database migrate
andgraphman database remap
to respectively apply schema migrations or run remappings manually. #4009, #4076 - Database replicas now won't fall behind as much when copying subgraph data. #3966 #3986
- Block handlers optimization with Firehose >= 1.1.0. #3971
- Reduced the amount of data that a non-primary shard has to mirror from the primary shard. #4015
- We now use advisory locks to lock deployments' tables against concurrent writes. #4010
- Fixed a bug that would cause some failed subgraphs to never restart. #3959
- Fixed a bug that would cause bad POIs for Firehose-backed subgraphs when processing
CREATE
calls. #4085 - Fixed a bug which would cause failure to redeploy a subgraph immediately after deletion. #4044
- Firehose connections are now load-balanced. #4083
- Determinism fixes. See above. #4055, #4149
Dependency | updated to |
---|---|
anyhow |
1.0.66 |
base64 |
0.13.1 |
clap |
3.2.23 |
env_logger |
0.9.1 |
iana-time-zone |
0.1.47 |
itertools |
0.10.5 |
jsonrpsee |
0.15.1 |
num_cpus |
1.14.0 |
openssl |
0.10.42 |
pretty_assertions |
1.3.0 |
proc-macro2 |
1.0.47 |
prometheus |
0.13.3 |
protobuf-parse |
3.2.0 |
semver |
1.0.14 |
serde_plain |
1.0.1 |
sha2 |
0.10.6 |
structopt |
removed |
tokio-stream |
0.1.11 |
tokio-tungstenite |
0.17.2 |
tower-test |
d27ba65 |
url |
2.3.1 |
Full Changelog: https://github.com/graphprotocol/graph-node/compare/v0.28.2...v0.29.0
Indexers are advised to migrate to v0.28.2
and entirely bypass v0.28.0
and v0.28.1
.
Fixed a bug which would cause subgraphs to stop syncing under some graph-node
deployment configurations. #4046, #4051
Yanked. Please migrate to v0.28.2
.
- New DB table for dynamic data sources.
For new subgraph deployments, dynamic data sources will be recorded under the
sgd*.data_sources$
table, rather thansubgraphs.dynamic_ethereum_contract_data_source
. As a consequence new deployments will not work correctly on earlier graph node versions, so downgrading to an earlier graph node version is not supported. See issue #3405 for other details.
- The filepath which "too expensive qeueries" are sourced from is now configurable. You can use either the
GRAPH_NODE_EXPENSIVE_QUERIES_FILE
environment variable or theexpensive_queries_filename
option in the TOML configuration. #3710 - The output you'll get from
graphman query
is less cluttered and overall nicer. The new options--output
and--trace
are available for detailed query information. #3860 docker build
will now--target
the production build stage by default. When you want to get the debug build, you now need--target graph-node-debug
. #3814- Node IDs can now contain any character. The Docker start script still replaces hyphens with underscores for backwards compatibility reasons, but this behavior can be changed with the
GRAPH_NODE_ID_USE_LITERAL_VALUE
environment variable. With this new option, you can now seamlessly use the K8s-provided host names as node IDs, provided you reassign your deployments accordingly. #3688 - You can now use the
conn_pool_size
option in TOML configuration files to configure the connection pool size for Firehose providers. #3833 - Index nodes now have an endpoint to perform block number to canonical hash conversion, which will unblock further work towards multichain support. #3942
_meta.block.timestamp
is now available for subgraphs indexing EVM chains. #3738, #3902- The
deployment_eth_rpc_request_duration
metric now also observeseth_getTransactionReceipt
requests' duration. #3903 - New Prometheus metrics
query_parsing_time
andquery_validation_time
for monitoring query processing performance. #3760 - New command
graphman config provider
, which shows what providers are available for new deployments on a given network and node. #3816 E.g.$ graphman --node-id index_node_0 --config graph-node.toml config provider mainnet
- Experimental support for GraphQL API versioning has landed. #3185
- Progress towards experimental support for off-chain data sources. #3791
- Experimental integration for substreams. #3777, #3784, #3897, #3765, and others
graphman stats
now complains instead of failing silently when incorrectly settingaccount-like
optimizations. #3918- Fixed inconsistent logic in the provider selection when the
limit
TOML configuration option was set. #3816 - Fixed issues that would arise from dynamic data sources' names clashing against template names. #3851
- Dynamic data sources triggers are now processed by insertion order. #3851, #3854
- When starting, the Docker image now replaces the
bash
process with thegraph-node
process (with a PID of 1). #3803 - Refactor subgraph store tests by @evaporei in graphprotocol#3662
- The
ethereum_chain_head_number
metric doesn't get out of sync anymore on chains that use Firehose. #3771, #3732 - Fixed a crash caused by bad block data from the provider. #3944
- Fixed some minor Firehose connectivity issues via TCP keepalive, connection and request timeouts, and connection window size tweaks. #3822, #3855, #3877, #3810, #3818
- Copying private data sources' tables across shards now works as expected. #3836
- Firehose GRPC stream requests are now compressed with
gzip
, if the server supports it. #3893 - Memory efficiency improvements within the entity cache. #3594
- Identical queries now benefit from GraphQL validation caching, and responses are served faster. #3759
- Avoid leaking some sensitive information in logs. #3812
Dependency | PR(s) | Old version | Current version |
---|---|---|---|
serde_yaml |
#3746 | v0.8.24 |
v0.8.26 |
web3 |
#3806 | 2760dbd |
7f8eb6d |
clap |
#3794, #3848, #3931 | v3.2.8 |
3.2.21 |
cid |
#3824 | v0.8.5 |
v0.8.6 |
anyhow |
#3826, #3841, #3865, #3932 | v1.0.57 |
1.0.65 |
chrono |
#3827, #3849, #3868 | v0.4.19 |
v0.4.22 |
proc-macro2 |
#3845 | v1.0.40 |
1.0.43 |
ethabi |
#3847 | v17.1.0 |
v17.2.0 |
once_cell |
#3870 | v1.13.0 |
v1.13.1 |
either |
#3869 | v1.7.0 |
v1.8.0 |
sha2 |
#3904 | v0.10.2 |
v0.10.5 |
mockall |
#3776 | v0.9.1 |
removed |
croosbeam |
#3772 | v0.8.1 |
v0.8.2 |
async-recursion |
#3873 | none | v1.0.0 |
- Store writes are now carried out in parallel to the rest of the subgraph process, improving indexing performance for subgraphs with significant store interaction. Metrics & monitoring was updated for this new pipelined process;
- This adds support for apiVersion 0.0.7, which makes receipts accessible in Ethereum event handlers. Documentation link;
- This introduces some improvements to the subgraph GraphQL API, which now supports filtering on the basis of, and filtering for entities which changed from a certain block;
- Support was added for Arweave indexing. Tendermint was renamed to Cosmos in Graph Node. These integrations are still in "beta";
- Callhandler block filtering for contract calls now works as intended (this was a longstanding bug);
- Gas costing for mappings is still set at a very high default, as we continue to benchmark and refine this metric;
- A new
graphman fix block
command was added to easily refresh a block in the block cache, or clear the cache for a given network; - IPFS file fetching now uses
files/stat
, asobject
was deprecated; - Subgraphs indexing via a Firehose can now take advantage of Firehose-side filtering;
- NEAR subgraphs can now match accounts for receipt filtering via prefixes or suffixes.
- In the case of you having custom SQL, there's a new SQL migration;
- On the pipelining of the store writes, there's now a new environment variable
GRAPH_STORE_WRITE_QUEUE
(default value is5
), that if set to0
, the old synchronous behaviour will come in instead. The value stands for the amount of write/revert parallel operations #3177; - There's now support for TLS connections in the PostgreSQL
notification_listener
#3503; - GraphQL HTTP and WebSocket ports can now be set via environment variables #2832;
- The genesis block can be set via the
GRAPH_ETHEREUM_GENESIS_BLOCK_NUMBER
env var #3650; - There's a new experimental feature to limit the number of subgraphs for a specific web3 provider. Link for documentation;
- Two new GraphQL validation environment variables were included:
ENABLE_GRAPHQL_VALIDATIONS
andSILENT_GRAPHQL_VALIDATIONS
, which are documented here; - A bug fix for
graphman index
was landed, which fixed the behavior where if one deployment was used by multiple names would result in the command not working #3416; - Another fix landed for
graphman
, the bug would allow theunassign
/reassign
commands to make two or more nodes index the same subgraph by mistake #3478; - Error messages of eth RPC providers should be clearer during
graph-node
start up #3422; - Env var
GRAPH_STORE_CONNECTION_MIN_IDLE
will no longer panic, instead it will log a warning if it exceeds thepool_size
#3489; - Failed GraphQL queries now have proper timing information in the service metrics #3508;
- Non-primary shards now can be disabled through setting the
pool_size
to0
#3513; - Queries with large results now have a
query_id
#3514; - It's now possible to disable the LFU Cache by setting
GRAPH_QUERY_LFU_CACHE_SHARDS
to0
#3522; GRAPH_ACCOUNT_TABLES
env var is not supported anymore #3525;- New documentation landed on the metadata tables;
GRAPH_GRAPHQL_MAX_OPERATIONS_PER_CONNECTION
for GraphQL subscriptions now has a default of1000
#3735
- Gas metering #2414
- Adds support for Solidity Custom Errors #2577
- Debug fork tool #2995 #3292
- Automatically remove unused deployments #3023
- Fix fulltextsearch space handling #3048
- Allow placing new deployments onto one of several shards #3049
- Make NEAR subgraphs update their sync status #3108
- GraphQL validations #3164
- Add special treatment for immutable entities #3201
- Tendermint integration #3212
- Skip block updates when triggers are empty #3223 #3268
- Use new GraphiQL version #3252
- GraphQL prefetching #3256
- Allow using Bytes as well as String/ID for the id of entities #3271
- GraphQL route for dumping entity changes in subgraph and block #3275
- Firehose filters #3323
- NEAR filters #3372
- Improve our
CacheWeight
estimates #2935 - Refactor GraphQL execution #3005
- Setup databases in parallel #3019
- Block ingestor now fetches receipts in parallel #3030
- Prevent subscriptions from back-pressuring the notification queue #3053
- Avoid parsing X triggers if the filter is empty #3083
- Pipeline
BlockStream
#3085 - More robust
proofOfIndexing
GraphQL route #3348
- Add
run
command, for running a subgraph up to a block #3079 - Add
analyze
command, for analyzing a PostgreSQL table, which can improve performance #3170 - Add
index create
command, for adding an index to certain attributes #3175 - Add
index list
command, for listing indexes #3198 - Add
index drop
command, for dropping indexes #3198
These are the main ones:
- Updated protobuf to latest version for NEAR #2947
- Update
web3
crate #2916 #3120 #3338 - Update
graphql-parser
tov0.4.0
#3020 - Bump
itertools
from0.10.1
to0.10.3
#3037 - Bump
clap
from2.33.3
to2.34.0
#3039 - Bump
serde_yaml
from0.8.21
to0.8.23
#3065 - Bump
tokio
from1.14.0
to1.15.0
#3092 - Bump
indexmap
from1.7.0
to1.8.0
#3143 - Update
ethabi
to its latest version #3144 - Bump
structopt
from0.3.25
to0.3.26
#3180 - Bump
anyhow
from1.0.45
to1.0.53
#3182 - Bump
quote
from1.0.9
to1.0.16
#3112 #3183 #3384 - Bump
tokio
from1.15.0
to1.16.1
#3208 - Bump
semver
from1.0.4
to1.0.5
#3229 - Bump
async-stream
from0.3.2
to0.3.3
#3361 - Update
jsonrpc-server
#3313
- More context when logging RPC calls #3128
- Increase default reorg threshold to 250 for Ethereum #3308
- Improve traces error logs #3353
- Add warning and continue on parse input failures for Ethereum #3326
When upgrading to this version, we recommend taking a brief look into these changes:
- Gas metering #2414
- Now there's a gas limit for subgraph mappings, if the limit is reached the subgraph will fail with a non-deterministic error, you can make them recover via the environment variable
GRAPH_MAX_GAS_PER_HANDLER
- Now there's a gas limit for subgraph mappings, if the limit is reached the subgraph will fail with a non-deterministic error, you can make them recover via the environment variable
- Improve our
CacheWeight
estimates #2935- This is relevant because a couple of releases back we've added a limit for the memory size of a query result. That limit is based of the
CacheWeight
.
- This is relevant because a couple of releases back we've added a limit for the memory size of a query result. That limit is based of the
These are some of the features that will probably be helpful for indexers 😊
- Allow placing new deployments onto one of several shards #3049
- GraphQL route for dumping entity changes in subgraph and block #3275
- Unused deployments are automatically removed now #3023
- The interval can be set via
GRAPH_REMOVE_UNUSED_INTERVAL
- The interval can be set via
- Setup databases in parallel #3019
- Block ingestor now fetches receipts in parallel #3030
GRAPH_ETHEREUM_FETCH_TXN_RECEIPTS_IN_BATCHES
can be set totrue
for the old fetching behavior
- More robust
proofOfIndexing
GraphQL route #3348- A token can be set via
GRAPH_POI_ACCESS_TOKEN
to limit access to the POI route
- A token can be set via
- The new
graphman
commands 🙂
This release brings API Version 0.0.7 in mappings, which allows Ethereum event handlers to require transaction receipts to be present in the Event
object.
Refer to PR #3373 for instructions on how to enable that.
This release includes two changes:
- Bug fix of blocks being skipped from processing when: a deterministic error happens and the
index-node
gets restarted. Issue #3236, Pull Request: #3316. - Automatic retries for non-deterministic errors. Issue #2945, Pull Request: #2988.
This is the last patch on the 0.25
minor version, soon 0.26.0
will be released. While that we recommend updating to this version to avoid determinism issues that could be caused on graph-node
restarts.
This release only adds two fixes:
- The first is to address an issue with decoding the input of some calls #3194 where subgraphs that would try to index contracts related to those would fail. Now they can advance normally.
- The second one is to fix a non-determinism issue with the retry mechanism for errors. Whenever a non-deterministic error happened, we would keep retrying to process the block, however we should've clear the
EntityCache
on each run so that the error entity changes don't get transacted/saved in the database in the next run. This could make the POI generation non-deterministic for subgraphs that failed and retried for non-deterministic reasons, adding a new entry to the database for the POI.
We strongly recommend updating to this version as quickly as possible.
This release ships support for API version 0.0.6 in mappings:
- Added
nonce
field forTransaction
objects. - Added
baseFeePerGas
field forBlock
objects (EIP-1559).
All cached block data must be refetched to account for the new Block
and Trasaction
struct versions, so this release includes a graph-node
startup check that will:
- Truncate all block cache tables.
- Bump the
db_version
value from2
to3
.
(Table truncation is a fast operation and no downtime will occur because of that.)
- 'Out of gas' errors on contract calls are now considered deterministic errors,
so they can be handled by
try_
calls. The gas limit is 50 million.
- The
GRAPH_ETH_CALL_GAS
environment is removed to prevent misuse, its value is now hardcoded to 50 million.
- Initial support for NEAR subgraphs.
- Added
FirehoseBlockStream
implementation ofBlockStream
(#2716)
- Rust docker image is now based on Debian Buster.
- Optimizations to the PostgreSQL notification queue.
- Improve PostgreSQL robustness in multi-sharded setups. (#2815)
- Added 'networks' to the 'subgraphFeatures' endpoint. (#2826)
- Check and limit the size of GraphQL query results. (#2845)
- Allow
_in
and_not_in
GraphQL filters. (#2841) - Add PoI for failed subgraphs. (#2748)
- Make
graphman rewind
safer to use. (#2879) - Add
subgraphErrors
for all GraphQL schemas. (#2894) - Add
Graph-Attestable
response header. (#2946) - Add support for minimum block constraint in GraphQL queries (
number_gte
) (#2868). - Handle revert cases from Hardhat and Ganache (#2984)
- Fix bug on experimental prefetching optimization feature (#2899)
This release only adds a fix for an issue where certain GraphQL queries
could lead to graph-node
running out of memory even on very large
systems. This release adds code that checks the size of GraphQL responses
as they are assembled, and can warn about large responses in the logs
resp. abort query execution based on the values of the two new environment
variables GRAPH_GRAPHQL_WARN_RESULT_SIZE
and
GRAPH_GRAPHQL_ERROR_RESULT_SIZE
. It also adds Prometheus metrics
query_result_size
and query_result_max
to track the memory consumption
of successful GraphQL queries. The unit for the two environment variables
is bytes, based on an estimate of the memory used by the result; it is best
to set them after observing the Prometheus metrics for a while to establish
what constitutes a reasonable limit for them.
We strongly recommend updating to this version as quickly as possible.
This release supports the upcoming Spec Version 0.0.4 that enables subgraph features to be declared in the manifest and validated during subgraph deployment #2682 #2746.
Subgraphs using previous versions are still supported and won't be affected by this change.
It is now possible to query for the features a subgraph uses given its Qm-hash ID.
For instance, the following query...
{
subgraphFeatures(subgraphId: "QmW9ajg2oTyPfdWKyUkxc7cTJejwdyCbRrSivfryTfFe5D") {
features
errors
}
}
... would produce this result:
{
"data": {
"subgraphFeatures": {
"errors": [],
"features": [
"nonFatalErrors",
"ipfsOnEthereumContracts"
]
}
}
}
Subraphs with any Spec Version can be queried that way.
- Added better error message for null pointers in the runtime #2780.
- When
GETH_ETH_CALL_ERRORS_ENV
is unset, it doesn't makeeth_call
errors to be considered determinsistic anymore #2784
- Tolerate a non-primary shard being down during startup #2727.
- Check that at least one replica for each shard has a non-zero weight #2749.
- Reduce locking for the chain head listener #2763.
- Improve block ingestor error reporting for missing receipts #2743.
This release ships support for API version 0.0.5 in mappings. hIt contains a fix for call handlers and the long awaited AssemblyScript version upgrade!
- AssemblyScript upgrade: The mapping runtime is updated to support up-to-date versions of the AssemblyScript compiler. The graph-cli/-ts releases to support this are in alpha, soon they will be released along with a migration guide for subgraphs.
- Call handlers fix: Call handlers will never be triggered on transactions with a failed status, resolving issue #2409. Done in #2511.
- The log
"Skipping handler because the event parameters do not match the event signature."
was downgraded from info to trace level. - Some block ingestor error logs were upgrded from debug to info level #2666.
query_semaphore_wait_ms
is now by shard, and has thepool
andshard
labels.deployment_failed
metric added, it is1
if the subgraph has failed and0
otherwise.
- Upgrade to tokio 1.0 and futures 0.3 #2679, the first major contribution by StreamingFast!
- Support Celo block reward events #2670.
- Reduce the maximum WASM stack size and make it configurable #2719.
- For robustness, ensure periodic updates to the chain head listener #2725.
- Fix ipfs timeout detection #2584.
- Fix discrepancy between a database table and its Diesel model #2586.
The Graph Node internals are being heavily refactored to prepare it for the multichain future. In the meantime, here are the changes for this release:
- The
GRAPH_ETH_CALL_BY_NUMBER
environment variable has been removed. Graph Node requires an Ethereum client that supports EIP-1898, which all major clients support. - Added support for IPFS versions larger than 0.4. Several changes to make
graph-node
more tolerant of slow/flaky IPFS nodes. - Added Ethereum ABI encoding and decoding functionality #2348.
- Experimental support for configuration files, see the documentation here.
- Better PoI performance #2329.
- Improve grafting performance and robustness by copying in batches #2293.
- Subgraph metadata storage has been simplified and reorganized. External tools (e.g., Grafana dashboards) that access the database directly will need to be updated.
- Ordering in GraphQL queries is now truly reversible #2214
- The
GRAPH_SQL_STATEMENT_TIMEOUT
environment variable can be used to enforce a timeout for individual SQL queries that are run in the course of processing a GraphQL query #2285 - Using
ethereum.call
in mappings in globals is deprecated
Graphman is a CLI tool to manage your subgraphs. It is now included in the Docker container #2289. And new commands have been added:
graphman copy
can copy subgraphs across DB shards #2313.graphman rewind
to rewind a deployment to a given block #2373.graphman query
to log info about a GraphQL query #2206.graphman create
to create a subgraph name #2419.
- The
deployment_blocks_behind
metric has been removed, and adeployment_head
metric has been added. To see how far a deployment is behind, use the difference betweenethereum_chain_head_number
anddeployment_head
. - The
trigger_type
label was removed from the metricdeployment_trigger_processing_duration
.
This release makes it possible to shard the block and call cache for chain data across multiple independent Postgres databases. This feature is considered experimental. We encourage users to try this out in a test environment, but do not recommend it yet for production use. In particular, the details of how sharding is configured may change in backwards-incompatible ways in the future.
Non-fatal errors (see release 0.20 for details) is documented and can now be enabled on graph-cli. Various related bug fixes have been made #2121 #2136 #2149 #2160.
- Add bitwise operations and string constructor to BigInt #2151.
- docker: Allow custom ethereum poll interval #2139.
- Deterministic error work in preparation for gas #2112
- Fix not contains filter #2146.
- Resolve __typename in _meta field #2118
- Add CORS for all HTTP responses #2196
- Fix subgraphs failing with a
fatalError
when deployed while already running (#2104). - Fix missing
scalar Int
declaration in index node GraphQL API, causing indexer-service queries to fail (#2104).
This release makes it possible to shard subgraph storage and spread subgraph deployments, and the load coming from indexing and querying them across multiple independent Postgres databases.
This feature is considered experimenatal. We encourage users to try this out in a test environment, but do not recommend it yet for production use In particular, the details of how sharding is configured may change in backwards-incompatible ways in the future.
This changes the proofOfIndexing
GraphQL API from
type Query {
proofOfIndexing(subgraph: String!, blockHash: Bytes!, indexer: Bytes): Bytes
}
to
type Query {
proofOfIndexing(
subgraph: String!
blockNumber: Int!
blockHash: Bytes!
indexer: Bytes
): Bytes
}
This allows the indexer agent to provide a block number and hash to be able
to obtain a POI even if this block is not cached in the Ethereum blocks
cache. Prior to this, the POI would be null
if this wasn't the case, even
if the subgraph deployment in question was up to date, leading to the indexer
missing out on indexing rewards.
- Fix non-determinism caused by not (always) correctly reverting dynamic sources when handling reorgs.
- Integrate the query cache into subscriptions to improve their performance.
- Add
graphman
crate for managing Graph Node infrastructure. - Improve query cache logging.
- Expose indexing status port (
8030
) from Docker image. - Remove support for unnecessary data sources
templates
inside subgraph data sources. They are only supported at the top level. - Avoid sending empty store events through the database.
- Fix database connection deadlocks.
- Rework the codebase to use
anyhow
instead offailure
. - Log stack trace in case of database connection timeouts, to help with root-causing.
- Fix stack overflows in GraphQL parsing.
- Disable fulltext search by default (it is nondeterministic and therefore not currently supported in the network).
NOTE: JSONB storage is no longer supported. Do not upgrade to this release if you still have subgraphs that were deployed with a version before 0.16. They need to be redeployed before updating to this version.
You can check if you have JSONB subgraphs by running the query select count(*) from deployment_schemas where version='split'
in psql
. If that
query returns 0
, you do not have JSONB subgraphs and it is safe to upgrde
to this version.
Subgraphs sometimes fall behind, be it due to failing or the Graph Node may be having issues. The
_meta
field can now be added to any query so that it is possible to determine against which block
the query was effectively executed. Applications can use this to warn users if the data becomes
stale. It is as simple as adding this to your query:
_meta {
block {
number
hash
}
}
Indexing errors on already synced subgraphs no longer need to cause the entire subgraph to grind to a halt. Subgraphs can now be configured to continue syncing in the presence of errors, by simply skipping the problematic handler. This gives subgraph authors time to correct their subgraphs while the nodes can continue to serve up-to-date the data. This requires setting a flag on the subgraph manifest:
features:
- nonFatalErrors
And the query must also opt-in to querying data with potential inconsistencies:
foos(first: 100, subgraphError: allow) {
id
}
If the subgraph encounters and error the query will return both the data and a graphql error with
the message indexing_error
.
Note that some errors are still fatal, to be non-fatal the error must be known to be deterministic. The _meta
field can be used to check if the subgraph has skipped over errors:
_meta {
hasIndexingErrors
}
The features
section of the manifest requires depending on the graph-cli master branch until the next version (after 0.19.0
) is released.
- Support for
tuple[]
(#1973). - Support multiple Ethereum endpoints per network with different capabilities (#1810).
- Avoid cloning results assembled from partial results (#1907).
- Add
cargo-audit
to the build process, update dependencies (#1998).
- Add
GRAPH_ETH_CALL_BY_NUMBER
environment variable for disabling EIP-1898 (#1957). - Disable
ipfs.cat
by default, as it is non-deterministic (#1958).
- Detect reorgs during query execution (#1801).
- Annotate SQL queries with the GraphQL query ID that caused them (#1946).
- Fix potential deadlock caused by reentering the load manager semaphore (#1948).
- Fix fulltext query issue with optional and unset fields (#1937 via #1938).
- Fix build warnings with --release (#1949 via #1953).
- Dependency updates: async-trait, chrono, wasmparser.
- Skip
trace_filter
on empty blocks (#1923). - Ensure runtime hosts are unique to avoid double-counting, improve logging (#1904).
- Add administrative Postgres views (#1889).
- Limit the GraphQL
skip
argument in the same way as we limitfirst
(#1912). - Fix GraphQL fragment bugs (#1825).
- Don't crash node and show better error when multiple graph nodes are indexing the same subgraph (#1903).
- Add a query semaphore to allow to control the number of concurrent queries and subscription queries being executed (#1802).
- Call Ethereum contracts by block hash (#1905).
- Fix fetching the correct function ABI from the contract ABI (#1886).
- Add LFU cache for historical queries (#1878, #1879, #1891).
- Log GraphQL queries only once (#1873).
- Gracefully fail on a null block hash and encoding failures in the Ethereum adapter (#1872).
- Improve metrics by using labels more (#1868, ...)
- Log when decoding a contract call result fails to decode (#1842).
- Fix Ethereum node requirements parsing based on the manifest (#1834).
- Speed up queries that involve checking for inclusion in an array (#1820).
- Add better error message when blocking a query due to load management (#1822).
- Support multiple Ethereum nodes/endpoints per network, with different capabilities (#1810).
- Change how we index foreign keys (#1811).
- Add an experimental Ethereum node config file (#1819).
- Allow using GraphQL variables in block constraints (#1803).
- Add Solidity struct array / Ethereum tuple array support (#1815).
- Resolve subgraph names in a blocking task (#1797).
- Add environmen variable options for sensitive arguments (#1784).
- USe blocking task for store events (#1789).
- Refactor servers, log GraphQL panics (#1783).
- Remove excessive logging in the store (#1772).
- Add dynamic load management for GraphQL queries (#1762, #1773, #1774).
- Add ability to block certain queries (#1749, #1771).
- Log the complexity of each query executed (#1752).
- Add support for running against read-only Postgres replicas (#1746, #1748, #1753, #1750, #1754, #1860).
- Catch invalid opcode reverts on Geth (#1744).
- Optimize queries for single-object lookups (#1734).
- Increase the maximum number of blocking threads (#1742).
- Increase default JSON-RPC timeout (#1732).
- Ignore flaky network indexers tests (#1724).
- Change default max block range size to 1000 (#1727).
- Fixed aliased scalar fields (#1726).
- Fix issue inserting fulltext fields when all included field values are null (#1710).
- Remove frequent "GraphQL query served" log message (#1719).
- Fix
bigDecimal.devidedBy
(#1715). - Optimize GraphQL execution, remove non-prefetch code (#1712, #1730, #1733, #1743, #1775).
- Add a query cache (#1708, #1709, #1747, #1751, #1777).
- Support the new Geth revert format (#1713).
- Switch WASM runtime from wasmi to wasmtime and cranelift (#1700).
- Avoid adding
order by
clauses for single-object lookups (#1703). - Refactor chain head and store event listeners (#1693).
- Properly escape single quotes in strings for SQL queries (#1695).
- Revamp how Graph Node Docker image is built (#1644).
- Add BRIN indexes to speed up revert handling (#1683).
- Don't store chain head block in
SubgraphDeployment
entity (#1673). - Allow varying block constraints across different GraphQL query fields (#1685).
- Handle database tables that have
text
columns where they should have enums (#1681). - Make contract call cache collision-free (#1680).
- Fix a SQL query in
cleanup_cached_blocks
(#1672). - Exit process when panicking in the notification listener (#1671).
- Rebase ethabi and web3 forks on top of upstream (#1662).
- Remove parity-wasm dependency (#1663).
- Normalize
BigDecimal
values, limitBigDecimal
exponent (#1640). - Strip nulls from strings (#1656).
- Fetch genesis block by number
0
instead of"earliest"
(#1658). - Speed up GraphQL query execution (#1648).
- Fetch event logs in parallel (#1646).
- Cheaper block polling (#1646).
- Improve indexing status API (#1609, #1655, #1659, #1718).
- Log Postgres contention again (#1643).
- Allow
User-Agent
in CORS headers (#1635). - Docker: Increase startup wait timeouts (Postgres, IPFS) to 120s (#1634).
- Allow using
Bytes
forid
fields (#1607). - Increase Postgres connection pool size (#1620).
- Fix entities updated after being removed in the same block (#1632).
- Pass
log_index
to mappings in place oftransaction_log_index
(required for Geth). - Don't return
__typename
to mappings (#1629). - Log warnings after 10 successive failed
eth_call
requests. This makes it more visible when graph-node is not operating against an Ethereum archive node (#1606). - Improve use of async/await across the codebase.
- Add Proof Of Indexing (POI).
- Add first implementation of subgraph grafting.
- Add integration test for handling Ganache reverts (#1590).
- Log all GraphQL and SQL queries performed by a node, controlled through
the
GRAPH_LOG_QUERY_TIMING
environment variable (#1595). - Fix loading more than 200 dynamic data sources (#1596).
- Fix fulltext schema validation (
includes
fields). - Dependency updates: anyhow, async-trait, bs58, blake3, bytes, chrono, clap, crossbeam-channel derive_more, diesel-derive-enum, duct, ethabi, git-testament, hex-literal, hyper, indexmap, jsonrpc-core, mockall, once_cell, petgraph, reqwest, semver, serde, serde_json, slog-term, tokio, wasmparser.
NOTE: JSONB storage is deprecated and will be removed in the next release. This only affects subgraphs that were deployed with a graph-node version before 0.16. Starting with this version, graph-node will print a warning for any subgraph that uses JSONB storage when that subgraph starts syncing. Please check your logs for this warning. You can remove the warning by redeploying the subgraph.
A frequently requested feature has been support for more advanced text-based
search, e.g. to power search fields in dApps. This release introduces a
@fulltext
directive on a new, reserved _Schema_
type to define fulltext
search APIs that can then be used in queries. The example below shows how
such an API can be defined in the subgraph schema:
type _Schema_
@fulltext(
name: "artistSearch"
language: en
algorithm: rank
include: [
{
entity: "Artist"
fields: [
{ name: "name" }
{ name: "bio" }
{ name: "genre" }
{ name: "promoCopy" }
]
}
]
)
This will add a special database column for Artist
entities that can be
used for fulltext search queries across all included entity fields, based on
the tsvector
and tsquery
features provided by Postgres.
The @fulltext
directive will also add an artistSearch
field on the root
query object to the generated subgraph GraphQL API, which can be used as
follows:
{
artistSearch(text: "breaks & electro & detroit") {
id
name
bio
}
}
For more information about the supported operators (like the &
in the above
query), please refer to the Postgres
documentation.
3Box has become a popular solution for integrating user profiles into dApps. Starting with this release, it is possible to fetch profile data for Ethereum addresses and DIDs. Example usage:
import { box } from '@graphprotocol/graph-ts'
let profile = box.profile("0xc8d807011058fcc0FB717dcd549b9ced09b53404")
if (profile !== null) {
let name = profile.get("name")
...
}
let profileFromDid = box.profile(
"id:3:bafyreia7db37k7epoc4qaifound6hk7swpwfkhudvdug4bgccjw6dh77ue"
)
...
This release enables accessing Arweave transaction data using Arweave transaction IDs:
import { arweave, json } from '@graphprotocol/graph-ts'
let data = arweave.transactionData(
"W2czhcswOAe4TgL4Q8kHHqoZ1jbFBntUCrtamYX_rOU"
)
if (data !== null) {
let data = json.fromBytes(data)
...
}
Data source contexts allow passing extra configuration when creating a data
source from a template. As an example, let's say a subgraph tracks exchanges
that are associated with a particular trading pair, which is included in the
NewExchange
event. That information can be passed into the dynamically
created data source, like so:
import { DataSourceContext } from "@graphprotocol/graph-ts";
import { Exchange } from "../generated/templates";
export function handleNewExchange(event: NewExchange): void {
let context = new DataSourceContext();
context.setString("tradingPair", event.params.tradingPair);
Exchange.createWithContext(event.params.exchange, context);
}
Inside a mapping of the Exchange template, the context can then be accessed as follows:
import { dataSource } from '@graphprotocol/graph-ts'
...
let context = dataSource.context()
let tradingPair = context.getString('tradingPair')
There are setters and getters like setString
and getString
for all value
types to make working with data source contexts convenient.
With contracts anchoring JSON data on IPFS on chain, there is no guarantee
that this data is actually valid JSON. Until now, failure to parse JSON in
subgraph mappings would fail the subgraph. This release adds a new
json.try_fromBytes
host export that allows subgraph to gracefully handle
JSON parsing errors.
import { json } from '@graphprotocol/graph-ts'
export function handleSomeEvent(event: SomeEvent): void {
// JSON data as bytes, e.g. retrieved from IPFS
let data = ...
// This returns a `Result<JSONValue, boolean>`, meaning that the error type is
// just a boolean (true if there was an error, false if parsing succeeded).
// The actual error message is logged automatically.
let result = json.try_fromBytes(data)
if (result.isOk) { // or !result.isError
// Do something with the JSON value
let value = result.value
...
} else {
// Handle the error
let error = result.error
...
}
}
- Add support for calling overloaded contract functions (#48 via #1440).
- Add integration test for calling overloaded contract functions (#1441).
- Avoid
eth_getLogs
requests with block ranges too large for Ethereum nodes to handle (#1536). - Simplify
eth_getLogs
fetching logic to reduce the risk of being rate limited by Ethereum nodes and the risk of overloading them (#1540). - Retry JSON-RPC responses with a
-32000
error (Alchemy uses this for timeouts) (#1539). - Reduce block range size for
trace_filter
requests to prevent request timeouts out (#1547). - Fix loading dynamically created data sources with
topic0
event handlers from the database (#1580). - Fix handling contract call reverts in newer versions of Ganache (#1591).
- Add support for checking multiple IPFS nodes when fetching files (#1498).
- Use correct network when resolving block numbers in time travel queries (#1508).
- Fix enum field validation in subgraph schemas (#1495).
- Prevent WebSocket connections from hogging the blocking thread pool and freezing the node (#1522).
- Switch subgraph metadata from JSONB to relational storage (#1394 via #1454, #1457, #1459).
- Clean up large notifications less frequently (#1505).
- Add metric for Postgres connection errors (#1484).
- Log SQL queries executed as part of the GraphQL API (#1465, #1466, #1468).
- Log entities returned by SQL queries (#1503).
- Fix several GraphQL prefetch / SQL query execution issues (#1523, #1524, #1526).
- Print deprecation warnings for JSONB subgraphs (#1527).
- Make sure reorg handling does not affect metadata of other subgraphs (#1538).
- Maintain an in-memory entity cache across blocks to speed up
store.get
(#1381 via #1416). - Speed up revert handling by making use of cached blocks (#1449).
- Speed up simple queries by delaying building JSON objects for results (#1476).
- Resolve block numbers to hashes using cached blocks when possible (#1477).
- Improve GraphQL prefetching performance by using lateral joins (#1450 via #1483).
- Vastly reduce memory consumption when indexing data sources created from templates (#1494).
- Default to IPFS 0.4.23 in the Docker Compose setup (#1592).
- Support Elasticsearch endpoints without HTTP basic auth (#1576).
- Fix
--version
not reporting the current version (#967 via #1567). - Convert more code to async/await and simplify async logic (#1558, #1560, #1571).
- Use lossy, more tolerant UTF-8 conversion when converting strings to bytes (#1541).
- Detect when a node is unresponsive and kill it (#1507).
- Dump core when exiting because of a fatal error (#1512).
- Update to futures 0.3 and tokio 0.2, enabling
async
/await
(#1448). - Log block and full transaction hash when handlers fail (#1496).
- Speed up network indexer tests (#1453).
- Fix Travis to always install Node.js 11.x. (#1588).
- Dependency updates: bytes, chrono, crossbeam-channel, ethabi, failure, futures, hex, hyper, indexmap, jsonrpc-http-server, num-bigint, priority-queue, reqwest, rust-web3, serde, serde_json, slog-async, slog-term, tokio, tokio-tungstenite, walkdir, url.