feat: add tax tracking for Horizon through GraphPayments

Author: juanmardefago

config/addresses.template.ts

@@ -21,6 +21,7 @@ export class Addresses {
   l2GraphTokenGateway: string
   ethereumDIDRegistry: string
   subgraphService: string
+  graphPayments: string
   isL1: boolean
 }
 
@@ -47,5 +48,6 @@ export let addresses: Addresses = {
   l2GraphTokenGateway: '{{l2GraphTokenGateway}}',
   ethereumDIDRegistry: '{{ethereumDIDRegistry}}',
   subgraphService: '{{subgraphService}}',
+  graphPayments: '{{graphPayments}}',
   isL1: {{isL1}},
 }

config/arbitrumSepoliaAddressScript.ts

@@ -30,6 +30,7 @@ export let addresses: Addresses = {
   l2GraphTokenGateway: '{{arbsep.L2GraphTokenGateway.address}}',
   ethereumDIDRegistry: '{{arbsep.EthereumDIDRegistry.address}}',
   subgraphService: '{{arbsep.SubgraphService.address}}',
+  graphPayments: '{{arbsep.GraphPayments.address}}',
   isL1: false,
 }
 
@@ -46,6 +47,13 @@ const main = (): void => {
     if(output.ethereumDIDRegistry == '') {
       output.ethereumDIDRegistry = '0x0000000000000000000000000000000000000000' // to avoid crashes due to bad config
     }
+    // remove once we have proper packages
+    if(output.subgraphService == '') {
+      output.subgraphService = '0x0000000000000000000000000000000000000000' // to avoid crashes due to bad config
+    }
+    if(output.graphPayments == '') {
+      output.graphPayments = '0x0000000000000000000000000000000000000000' // to avoid crashes due to bad config
+    }
     fs.writeFileSync(__dirname + '/generatedAddresses.json', JSON.stringify(output, null, 2))
   } catch (e) {
     console.log(`Error saving artifacts: ${e.message}`)

config/mainnetArbitrumAddressScript.ts

@@ -30,6 +30,7 @@ export let addresses: Addresses = {
   l2GraphTokenGateway: '{{arbitrum.L2GraphTokenGateway.address}}',
   ethereumDIDRegistry: '{{arbitrum.IEthereumDIDRegistry.address}}',
   subgraphService: '{{arbitrum.SubgraphService.address}}',
+  graphPayments: '{{arbitrum.GraphPayments.address}}',
   isL1: false,
 }
 
@@ -51,6 +52,9 @@ const main = (): void => {
     if(output.subgraphService == '') {
       output.subgraphService = '0x0000000000000000000000000000000000000000' // to avoid crashes due to bad config
     }
+    if(output.graphPayments == '') {
+      output.graphPayments = '0x0000000000000000000000000000000000000000' // to avoid crashes due to bad config
+    }
     fs.writeFileSync(__dirname + '/generatedAddresses.json', JSON.stringify(output, null, 2))
   } catch (e) {
     console.log(`Error saving artifacts: ${e.message}`)

config/testAddressesL1.ts

@@ -30,6 +30,7 @@ export let addresses: Addresses = {
   l2GraphTokenGateway: '',
   ethereumDIDRegistry: '0x0000000000000000000000000000000000000000',
   subgraphService: '0x0000000000000000000000000000000000000000',
+  graphPayments: '0x0000000000000000000000000000000000000000',
   isL1: true,
 }
 

config/testAddressesL2.ts

@@ -30,6 +30,7 @@ export let addresses: Addresses = {
   l2GraphTokenGateway: '0x0000000000000000000000000000000000000000',
   ethereumDIDRegistry: '0x0000000000000000000000000000000000000000',
   subgraphService: '0x0000000000000000000000000000000000000000',
+  graphPayments: '0x0000000000000000000000000000000000000000',
   isL1: false,
 }
 

src/mappings/graphPayments.ts

@@ -0,0 +1,25 @@
+import { addresses } from "../../config/addresses"
+import { GraphPaymentCollected } from "../types/GraphPayments/GraphPayments"
+import { createOrLoadEpoch, createOrLoadGraphNetwork, createOrLoadPaymentSource } from "./helpers/helpers"
+
+export function handleGraphPaymentCollected(event: GraphPaymentCollected): void {
+    let graphNetwork = createOrLoadGraphNetwork(event.block.number, event.address)
+
+    // Update epoch
+    let epoch = createOrLoadEpoch(
+        addresses.isL1 ? event.block.number : graphNetwork.currentL1BlockNumber!,
+    )
+    epoch.taxedQueryFees = epoch.taxedQueryFees.plus(event.params.tokensProtocol)
+    epoch.save()
+
+    // update graph network
+    graphNetwork.totalTaxedQueryFees = graphNetwork.totalTaxedQueryFees.plus(event.params.tokensProtocol)
+    graphNetwork.save()
+
+    // Replicate for payment source specific data
+    let paymentSource = createOrLoadPaymentSource(event.params.payer)
+    paymentSource.totalTaxedQueryFees = paymentSource.totalTaxedQueryFees.plus(event.params.tokensProtocol)
+    paymentSource.save()
+
+    // Might want to add data service tax tracking here
+}

subgraph.template.yaml

@@ -465,6 +465,30 @@ dataSources:
           handler: handleIndexingRewardsCollected
         - event: QueryFeesCollected(indexed address,indexed address,indexed address,bytes32,uint256,uint256)
           handler: handleQueryFeesCollected
+  - kind: ethereum/contract
+    name: GraphPayments
+    network: {{network}}
+    source:
+      address: "{{graphPayments}}"
+      abi: GraphPayments
+      startBlock: {{blockNumber}}
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.7
+      language: wasm/assemblyscript
+      file: ./src/mappings/graphPayments.ts
+      entities:
+        - GraphNetwork
+      abis:
+        - name: GraphPayments
+          file: ./abis/GraphPayments.json
+        - name: GraphToken
+          file: ./node_modules/@graphprotocol/contracts/dist/abis/GraphToken.json
+        - name: EpochManager
+          file: ./node_modules/@graphprotocol/contracts/dist/abis/EpochManager.json
+      eventHandlers:
+        - event: GraphPaymentCollected(indexed uint8,indexed address,address,indexed address,uint256,uint256,uint256,uint256,uint256)
+          handler: handleGraphPaymentCollected
   - kind: ethereum/contract
     name: Curation
     network: {{network}}