Releases: graphprotocol/graph-tooling
v0.15.1
v0.15.0
Fallible contract calls (#332)
Calls to contract functions can fail due to assertions in the contract. Until now there was no way to handle this in subgraphs gracefully. This release introduces new try_someContractFunction
call variants that return a result object with reverted
and value
fields. These can then be used in mappings to handle call failures.
An example can be found in the documentation.
Top-level templates (#319)
Data source templates have been moved to a top-level templates
field in the manifest. The data source templates documentation has been updated accordingly.
Top-level templates simplify creating new data sources at runtime: templates can now be referred to from all data sources and can create new data sources from other templates as well.
This also affects subgraph validation and code generation in a few ways. While Graph Node >= 0.15.0 still allows subgraphs with nested templates to run, Graph CLI now rejects such subgraphs. Code generation now puts all generated template classes into a single templates.ts
file.
Other Changes
- Only upload files to IPFS once if they are used in manifests multiple times (#337).
- Fix subgraph migrations to replace all
apiVersion
occurrences in manifests (#337). - Add support for arrays of Ethereum tuples / Solidity structs (#320).
- Update dependencies: graphql, ipfs-http-client, gluegun, eslint, jest, eslint-utils, mixin-deep, keytar, lodash.
v0.12.0
Changes
graph init
: Skip Etherscan if--abi
is provided (#263).graph init
: Improve error when an ABI is not found on Etherscan (#266, #267).graph codegen
: Fix ugly uncaught exception errors being printed (#262).graph codegen
: Add notes in generated files about files being auto-generated (#212, #268).graph codegen
: Do not generate code for calling contract functions with no return values (#270, contribution by @fubhy).- Fail subgraph validation if
callHandler
functions are not found in ABIs (#265). - Improve type suggestions for fields in the schema for integer/float types (#210, #269).
- Bump
node-keytar
dependency from 4.3.0 to 4.6.0 to be able to build on Node.js 12. - Add
log
calls to the example to test compiling subgraphs that use logging.
v0.11.2
v0.11.1
v0.11.0
Block, transaction and call handlers
Until now, the only triggers for indexing were events. This release adds support for triggering based on blocks and transactions/calls in the form of blockHandlers
and callHandlers
(in addition to the existing eventHandlers
).
From the documentation:
Call Handlers
While events provide an effective way to collect relevant changes to the state of a contract, many contracts avoid generating logs to optimize gas costs. In these cases, a subgraph can subscribe to calls made to the data source contract. This is achieved by defining call handlers referencing the function signature and the mapping handler that will process calls to this function. To process these calls, the mapping handler will receive an EthereumCall as an argument with the typed inputs to and outputs from the call. Calls made at any depth in a transaction's call chain will trigger the mapping, allowing activity with the data source contract through proxy contracts to be captured.
To define a call handler in your manifest simply add a
callHandlers
array under the data source you would like to subscribe to.callHandlers: - function: createGravatar(string,string) handler: handleCreateGravatar
For all applicable functions in contract ABIs, graph codegen
now generates dedicated classes, e.g. CreateGravatarCall
. These provide access to the address
of the contract that was called, the block
and transaction
that the call happened in as well as typed inputs
and outputs
for function parameters and return values.
On block handlers:
Block Handlers
In addition to subscribing to contract events or function calls, a subgraph may want to update its data as new blocks are appended to the chain. To achieve this a subgraph can run a function after every block or after blocks that match a predefined filter.
The absense of a filter for a block handler will ensure that the handler is called every block.
A data source can only contain one block handler for each filter type.
blockHandlers: - handler: handleBlock - handler: handleBlockWithCallToContract filter: kind: call
For more information about how to define and write call and block handlers, please refer to the documentation.
Note: This feature requires Parity archive nodes with the trace
API enabled.
Other changes
v0.10.0
Dynamic data sources
Also referred to as dynamic contract subscriptions, as this is currently the main use case.
This feature supports creating new data sources from templates while indexing the subgraph. The motivation behind this is to provide a natural way of indexing registry/factory contracts that reference many other (sub)contracts.
See Define a Subgraph: Dynamic Data Sources in the docs for more details.
On the Graph CLI side of things, validation of data source templates and code generation for data source templates were added.
Anonymous events
Anonymous Solidity events are used by projects like Maker. Supporting them requires filtering events not by their usual signature (e.g. Transfer(address,address)
) but by their topic 0 value.
This version adds support for that by allowing event handlers to specify the topic0
value to filter by. For more information see Define a Subgraph: Anonymous Events in the docs.
Other changes
- Make the
keytar
dependency optional. Thanks to @iameli from Livepeer for the contribution! - Add support for overloaded events and functions by generating code without duplicate types.
- Fix loading subgraphs in
--watch
mode. - Bump AssemblyScript to AssemblyScript/assemblyscript@36040d5b5312f19a025782b5e366.
- Add ESLint configuration.
v0.9.0
Ethereum tuples / Solidity structs
This release adds support for Ethereum tuples (or structs in Solidity). graph codegen
now generates classes with getter properties for the members of a struct/tuple.
E.g. for a Solidity struct like
struct ValuableItem {
address owner;
uint256 price;
}
it generates a class where owner
and price
can be accessed with
let owner = item.owner
let price = item.price
This also works if structs are used as event parameters. Nested structs are also supported.
v0.8.0
graph init
now has two modes:--from-example
creates a subgraph from the example subgraph.--from-contract
creates a subgraph from an existing contract, fetching the contract ABI from Etherscan if possible, and creating entities for all events emitted by the contract.- If not all arguments for one of these modes are provided,
graph init
will guide the user through an interactive form.
graph codegen
now handles indexed event parameters correctly.- There is a subgraph migration framework in place now to automatically update subgraphs to the latest APIs if possible. This can be skipped with
--skip-migrations
. graph codegen
now supportsBigDecimal
for large decimal numbers.- Other changes:
- Rewrite CLI commands using Gluegun.
- Add progress indicators.
- Make output formatting more consistent.
- Add tests for the new
graph init
. - Warn if manifests contain the example subgraph repository and description.
- Add Prettier.
v0.5.1
- Fix #169 (handling optional boolean, i32 and other primitive entity attributes incorrectly).
- To unset primitive fields,
entity.unset('fieldName')
is now the way to go. - To explicitly check whether any field is set on an en entity, use
entity.isSet('fieldName')
.
- To unset primitive fields,
- Fix graphprotocol/graph-node#600 (data from different entities being mixed up due to non-deterministic use of previously used memory).