Subgraph: enable cache for new scheme

If you created a custom scheme or used any of the new arc scheme that are not yet tracked by subgraph, then you will have to make changes to DAOstack caching layer.

NOTE: You can skip this step if you do not wish to take advantage of caching layer for faster access and would rather read data directly from blockchain. But would recommend not to.

Pre Work

  1. Make sure you have cloned DAOstack subgraph repo, if you have not already

  2. Create a new directory with your scheme-name in mappings

    1
2
    cd subgraph
mkdir src/mappings/BuyInWithRageQuitOpt

  3. Add contract abi to abis/'version' folder e.g. abis/0.0.1-rc.27/BuyInWithRageQuitOpt.json

    If you have jq tool installed you can use this command to extract abi, make sure to use right version folder

    1
    cat ../build/contracts/BuyInWithRageQuitOpt.json | jq .abi > abis/0.0.1-rc.27/BuyInWithRageQuitOpt.json

    If you ran above command you should be able to see an Abi file for the non-universal scheme as follows

      1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
    [
  {
    "constant": true,
    "inputs": [],
    "name": "avatar",
    "outputs": [
      {
        "internalType": "contract Avatar",
        "name": "",
        "type": "address"
      }
    ],
    "payable": false,
    "stateMutability": "view",
    "type": "function"
  },
  {
    "constant": true,
    "inputs": [],
    "name": "reputation",
    "outputs": [
      {
        "internalType": "contract Reputation",
        "name": "",
        "type": "address"
      }
    ],
    "payable": false,
    "stateMutability": "view",
    "type": "function"
  },
  {
    "anonymous": false,
    "inputs": [
      {
        "indexed": true,
        "internalType": "address",
        "name": "_member",
        "type": "address"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "_amount",
        "type": "uint256"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "_rep",
        "type": "uint256"
      }
    ],
    "name": "buyIn",
    "type": "event"
  },
  {
    "anonymous": false,
    "inputs": [
      {
        "indexed": true,
        "internalType": "address",
        "name": "_member",
        "type": "address"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "_amount",
        "type": "uint256"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "_rep",
        "type": "uint256"
      }
    ],
    "name": "rageQuit",
    "type": "event"
  },
  {
    "constant": false,
    "inputs": [
      {
        "internalType": "contract Avatar",
        "name": "_avatar",
        "type": "address"
      }
    ],
    "name": "initialize",
    "outputs": [],
    "payable": false,
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "constant": false,
    "inputs": [],
    "name": "deposit",
    "outputs": [],
    "payable": true,
    "stateMutability": "payable",
    "type": "function"
  },
  {
    "constant": false,
    "inputs": [],
    "name": "quit",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "payable": false,
    "stateMutability": "nonpayable",
    "type": "function"
  }
]

Add contract mappings

In order to cache the events from blockchain, we will create following files in src/mappings/BuyInWithRageQuitOpt:

datasource.yaml

File containing the subgraph manifest src/mappings/BuyInWithRageQuitOpt/datasource.yaml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
abis:
  - BuyInWithRageQuitOpt
entities:
  - Deposit
  - Quit
eventHandlers:
  - event: buyIn(indexed address,uint256,uint256)
    handler: handleBuyIn
  - event: rageQuit(indexed address,uint256,uint256)
    handler: handleRageQuit

schema.graphql

Describe what data is stored for your subgraph and how to query it via GraphQL in src/mappings/BuyInWithRageQuitOpt/schema.graphql

NOTE: These will be used for the generating types in src/types/ during build step and will need to be imported while writing handlers in mapping.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
type Deposit @entity {
  id: ID!
  memberAddress: Bytes!
  amount: BigInt!
  rep: BigInt!
}

type Quit @entity {
  id: ID!
  memberAddress: Bytes!
  amount: BigInt!
  rep: BigInt!
}

mapping.ts

Describe how blockchain events are processed and stored in entities defined in your schema src/mappings/BuyInWithRageQuitOpt/mapping.ts

NOTE: src/types/BuyInWithRageQuitOpt/BuyInWithRageQuitOpt will be generated during the build step based on the entities described in schema.graphQL.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import 'allocator/arena';

import {
  store,
} from '@graphprotocol/graph-ts';

import * as domain from '../../domain';

import {
  Deposit,
  Quit
} from '../../types/schema';

import { concat, equalsBytes, eventId } from '../../utils';

import {
  buyIn,
  rageQuit,
} from '../../types/BuyInWithRageQuitOpt/BuyInWithRageQuitOpt';

export function handleBuyIn(event: buyIn): void {
  let ent = new Deposit(eventId(event));
  ent.memberAddress = event.params._member;
  ent.amount = event.params._amount;
  ent.rep = event.params._rep;

  store.set('Deposit', ent.id, ent);
}

export function handleRageQuit(event: rageQuit): void {
  let ent = new Quit(eventId(event));
  ent.memberAddress = event.params._member;
  ent.amount = event.params._amount;
  ent.rep = event.params._rep;

  store.set('Quit', ent.id, ent);
}

Integration test (optional)

Add integration test for the subgraph test/integration/MyContractName.spec.ts

Update Ops

Add tracker for your contract in ops/mappings.json.

In the JSON object for the network your contract is located at, under the "mappings" JSON array, add the following.

  • arcVersion: contract arc version

  • dao: section label where contract is defined in migration.json file (base/ dao/ test/ organs) or address,

  • mapping: contract name as in mappings,

  • name: contract name as appears in abis/arcVersion folder,

  • contractName: contract name as appears in migration.json file,

    If your contract information is in the migration.json file specified (default is the file under @daostack/migration folder, as defined in the ops/settings.js file)

    1
2
3
4
5
6
7
    {
  "name": "BuyInWithRageQuitOpt",
  "contractName": "BuyInWithRageQuitOpt",
  "dao": "dao",
  "mapping": "BuyInWithRageQuitOpt",
  "arcVersion": "0.0.1-rc.27"
},

OR

  • address: the contract address on network

    If your contract does not appear in the migration file add following info:

    1
2
3
4
5
6
7
    {
  "name": "BuyInWithRageQuitOpt",
  "address": "0x4a35d1434D34Ac7842381362924E6399ca63Da5A"
  "dao": "address",
  "mapping": "BuyInWithRageQuitOpt",
  "arcVersion": "0.0.1-rc.27",
},