Document apiVersion 0.0.7, specVersion 0.0.5 and receipts in mappings (…

…#102) * Document apiVersion 0.0.7, specVersion 0.0.5 and receipts in mappings * Fix typo * Include `TransactionReceipt` and `Log` schemas
graphprotocol · May 3, 2022 · a8cfa34 · a8cfa34
1 parent 3bb3b69
commit a8cfa34
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/pages/en/developer/assemblyscript-api.mdx b/pages/en/developer/assemblyscript-api.mdx
@@ -45,6 +45,7 @@ The `apiVersion` in the subgraph manifest specifies the mapping API version whic
 
 | Version | Release notes |
 | :-: | --- |
+| 0.0.7 | Added `TransactionReceipt` and `Log` classes to the Ethereum types<br />Added `receipt` field to the Ethereum Event object|
 | 0.0.6 | Added `nonce` field to the Ethereum Transaction object<br />Added `baseFeePerGas` to the Ethereum Block object |
 | 0.0.5 | AssemblyScript upgraded to version 0.19.10 (this includes breaking changes, please see the [`Migration Guide`](/developer/assemblyscript-migration-guide))<br />`ethereum.transaction.gasUsed` renamed to `ethereum.transaction.gasLimit` |
 | 0.0.4 | Added `functionSignature` field to the Ethereum SmartContractCall object |
@@ -372,6 +373,7 @@ class Event {
   block: Block
   transaction: Transaction
   parameters: Array<EventParam>
+  receipt: TransactionReceipt | null
 }
 
 class Block {
@@ -403,6 +405,34 @@ class Transaction {
   input: Bytes
   nonce: BigInt
 }
+
+class TransactionReceipt {
+  transactionHash: Bytes
+  transactionIndex: BigInt
+  blockHash: Bytes
+  blockNumber: BigInt
+  cumulativeGasUsed: BigInt
+  gasUsed: BigInt
+  contractAddress: Address
+  logs: Array<Log>
+  status: BigInt
+  root: Bytes
+  logsBloom: Bytes
+ }
+
+class Log {
+  address: Address
+  topics: Array<Bytes>
+  data: Bytes
+  blockHash: Bytes
+  blockNumber: Bytes
+  transactionHash: Bytes
+  transactionIndex: BigInt
+  logIndex: BigInt
+  transactionLogIndex: BigInt
+  logType: string
+  removed: bool | null
+}
 ```
 
 #### Access to Smart Contract State

diff --git a/pages/en/developer/create-subgraph-hosted.mdx b/pages/en/developer/create-subgraph-hosted.mdx
@@ -814,6 +814,22 @@ eventHandlers:
 
 An event will only be triggered when both the signature and topic 0 match. By default, `topic0` is equal to the hash of the event signature.
 
+## Transaction Receipts in Event Handlers
+
+Starting from `specVersion` `0.0.5` and `apiVersion` `0.0.7`, event handlers can have access to the receipt for the transaction which emitted them.
+
+To do so, event handlers must be declared in the subgraph manifest with the new `receipt: true` key, which is optional and defaults to false.
+
+```yaml
+eventHandlers:
+  - event: NewGravatar(uint256,address,string,string)
+    handler: handleNewGravatar
+    receipt: true
+```
+
+Inside the handler function, the receipt can be accessed in the `Event.receipt` field. When the `receipt` key is set to `false` or omitted in the manifest, a `null` value will be returned instead.
+
+
 ## Experimental features
 
 Starting from `specVersion` `0.0.4`, subgraph features must be explicitly declared in the `features` section at the top level of the manifest file, using their `camelCase` name, as listed in the table below: