@graphprotocol/graph-cli 0.26.1 → 0.27.2

package/src/protocols/near/manifest.graphql

@@ -0,0 +1,57 @@
+# Each referenced type's in any of the types below must be listed
+# here either as `scalar` or `type` for the validation code to work
+# properly.
+#
+# That's why `String` is listed as a scalar even though it's built-in
+# GraphQL basic types.
+scalar String
+scalar File
+scalar BigInt
+
+type SubgraphManifest {
+  specVersion: String!
+  schema: Schema!
+  description: String
+  repository: String
+  graft: Graft
+  dataSources: [DataSource!]!
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: ContractSource!
+  mapping: ContractMapping!
+}
+
+type ContractSource {
+  account: String
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [BlockHandler!]
+  receiptHandlers: [ReceiptHandler!]
+}
+
+type BlockHandler {
+  handler: String!
+}
+
+type ReceiptHandler {
+  handler: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}

package/src/subgraph.js

@@ -27,7 +27,7 @@ const buildCombinedWarning = (filename, warnings) =>
     ? warnings.reduce(
         (msg, w) =>
           `${msg}
-  
+
     Path: ${w.get('path').size === 0 ? '/' : w.get('path').join(' > ')}
     ${w
       .get('message')
@@ -39,9 +39,21 @@ const buildCombinedWarning = (filename, warnings) =>
 
 module.exports = class Subgraph {
   static async validate(data, protocol, { resolveFile }) {
+    if (protocol.name == null) {
+      return immutable.fromJS([
+        {
+          path: [],
+          message: `Unable to determine for which protocol manifest file is built for. Ensure you have at least one 'dataSources' and/or 'templates' elements defined in your subgraph.`,
+        },
+      ])
+    }
+
     // Parse the default subgraph schema
     let schema = graphql.parse(
-      await fs.readFile(path.join(__dirname, '..', 'manifest-schema.graphql'), 'utf-8'),
+      await fs.readFile(
+        path.join(__dirname, 'protocols', protocol.name, `manifest.graphql`),
+        'utf-8',
+      ),
     )
 
     // Obtain the root `SubgraphManifest` type from the schema
@@ -146,10 +158,7 @@ At least one such handler must be defined.`,
   }
 
   static validateContractValues(manifest, protocol) {
-    return validation.validateContractValues(
-      manifest,
-      protocol,
-    )
+    return validation.validateContractValues(manifest, protocol)
   }
 
   // Validate that data source names are unique, so they don't overwrite each other.
@@ -200,17 +209,13 @@ More than one template named '${name}', template names must be unique.`,
     return yaml.stringify(manifest.toJS())
   }
 
-  static async load(
-    filename,
-    { protocol, skipValidation } = { skipValidation: false }
-  ) {
+  static async load(filename, { protocol, skipValidation } = { skipValidation: false }) {
     // Load and validate the manifest
     let data = null
 
-    if(filename.match(/.js$/)) {
+    if (filename.match(/.js$/)) {
       data = require(path.resolve(filename))
-    }
-    else {
+    } else {
       data = yaml.parse(await fs.readFile(filename, 'utf-8'))
     }
 

package/src/validation/manifest.js

@@ -52,8 +52,7 @@ const validators = immutable.fromJS({
     validators.get(ctx.getIn(['type', 'name', 'value']))(value, ctx),
 
   UnionTypeDefinition: (value, ctx) => {
-    const unionVariants = ctx
-      .getIn(['type', 'types'])
+    const unionVariants = ctx.getIn(['type', 'types'])
 
     let errors = List()
 
@@ -78,7 +77,10 @@ const validators = immutable.fromJS({
 
   NonNullType: (value, ctx) =>
     value !== null && value !== undefined
-      ? validateValue(value, ctx.update('type', type => type.get('type')))
+      ? validateValue(
+          value,
+          ctx.update('type', type => type.get('type')),
+        )
       : immutable.fromJS([
           {
             path: ctx.get('path'),
@@ -126,7 +128,7 @@ const validators = immutable.fromJS({
                     ),
                   )
                 : errors.push(
-                    key == 'templates'
+                    key == 'templates' && ctx.get('protocol').hasTemplates()
                       ? immutable.fromJS({
                           path: ctx.get('path'),
                           message:
@@ -211,7 +213,8 @@ const validateValue = (value, ctx) => {
 }
 
 const validateDataSourceForNetwork = (dataSources, protocol) =>
-  dataSources.filter(dataSource => protocol.isValidKindName(dataSource.kind))
+  dataSources
+    .filter(dataSource => protocol.isValidKindName(dataSource.kind))
     .reduce(
       (networks, dataSource) =>
         networks.update(dataSource.network, dataSources =>
@@ -235,11 +238,11 @@ const validateDataSourceNetworks = (value, protocol) => {
 ${networks
   .map(
     (dataSources, network) =>
-    `  ${
+      `  ${
         network === undefined
           ? 'Data sources and templates having no network set'
-        : `Data sources and templates using '${network}'`
-        }:\n${dataSources.map(ds => `    - ${ds}`).join('\n')}`,
+          : `Data sources and templates using '${network}'`
+      }:\n${dataSources.map(ds => `    - ${ds}`).join('\n')}`,
   )
   .join('\n')}
 Recommendation: Make all data sources and templates use the same network name.`,
@@ -262,6 +265,7 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
             path: [],
             errors: [],
             resolveFile,
+            protocol,
           }),
         )
       : immutable.fromJS([

package/tests/cli/init/ethereum/from-example/.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

package/tests/cli/init/ethereum/from-example/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 The Graph
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/tests/cli/init/ethereum/from-example/README.md

@@ -0,0 +1,3 @@
+# Example Subgraph
+
+An example to help you get started with The Graph. For more information see the docs on https://thegraph.com/docs/.

package/tests/cli/init/ethereum/from-example/abis/Gravity.json

@@ -0,0 +1 @@
+[{"constant":false,"inputs":[{"name":"_imageUrl","type":"string"}],"name":"updateGravatarImage","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[],"name":"setMythicalGravatar","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"owner","type":"address"}],"name":"getGravatar","outputs":[{"name":"","type":"string"},{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"","type":"uint256"}],"name":"gravatarToOwner","outputs":[{"name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"","type":"address"}],"name":"ownerToGravatar","outputs":[{"name":"","type":"uint256"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"name":"_displayName","type":"string"}],"name":"updateGravatarName","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"name":"_displayName","type":"string"},{"name":"_imageUrl","type":"string"}],"name":"createGravatar","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"","type":"uint256"}],"name":"gravatars","outputs":[{"name":"owner","type":"address"},{"name":"displayName","type":"string"},{"name":"imageUrl","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"anonymous":false,"inputs":[{"indexed":false,"name":"id","type":"uint256"},{"indexed":false,"name":"owner","type":"address"},{"indexed":false,"name":"displayName","type":"string"},{"indexed":false,"name":"imageUrl","type":"string"}],"name":"NewGravatar","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"name":"id","type":"uint256"},{"indexed":false,"name":"owner","type":"address"},{"indexed":false,"name":"displayName","type":"string"},{"indexed":false,"name":"imageUrl","type":"string"}],"name":"UpdatedGravatar","type":"event"}]

package/tests/cli/init/ethereum/from-example/bin/Counter.bin

@@ -0,0 +1 @@
+60806040526000808190555060f5806100196000396000f3fe6080604052600436106043576000357c0100000000000000000000000000000000000000000000000000000000900480633fa4f245146048578063d09de08a146070575b600080fd5b348015605357600080fd5b50605a6078565b6040518082815260200191505060405180910390f35b6076607e565b005b60005481565b600160008082825401925050819055507f20d8a6f5a693f9d1d627a598e8820f7a55ee74c183aa8f1a30e8d4e8dd9a8d846000546040518082815260200191505060405180910390a156fea165627a7a72305820fca3d11af59a6ac98027ec3bebdb10711f195860d6d9abd07921c88c8c50228f0029

package/tests/cli/init/ethereum/from-example/contracts/Gravity.sol

@@ -0,0 +1,63 @@
+pragma solidity ^0.4.0;
+
+contract GravatarRegistry {
+  event NewGravatar(uint id, address owner, string displayName, string imageUrl);
+  event UpdatedGravatar(uint id, address owner, string displayName, string imageUrl);
+
+  struct Gravatar {
+    address owner;
+    string displayName;
+    string imageUrl;
+  }
+
+  Gravatar[] public gravatars;
+
+  mapping (uint => address) public gravatarToOwner;
+  mapping (address => uint) public ownerToGravatar;
+
+  function createGravatar(string _displayName, string _imageUrl) public {
+    require(ownerToGravatar[msg.sender] == 0);
+    uint id = gravatars.push(Gravatar(msg.sender, _displayName, _imageUrl)) - 1;
+
+    gravatarToOwner[id] = msg.sender;
+    ownerToGravatar[msg.sender] = id;
+
+    emit NewGravatar(id, msg.sender, _displayName, _imageUrl);
+  }
+
+  function getGravatar(address owner) public view returns (string, string) {
+    uint id = ownerToGravatar[owner];
+    return (gravatars[id].displayName, gravatars[id].imageUrl);
+  }
+
+  function updateGravatarName(string _displayName) public {
+    require(ownerToGravatar[msg.sender] != 0);
+    require(msg.sender == gravatars[ownerToGravatar[msg.sender]].owner);
+
+    uint id = ownerToGravatar[msg.sender];
+
+    gravatars[id].displayName = _displayName;
+    emit UpdatedGravatar(id, msg.sender, _displayName, gravatars[id].imageUrl);
+  }
+
+  function updateGravatarImage(string _imageUrl) public {
+    require(ownerToGravatar[msg.sender] != 0);
+    require(msg.sender == gravatars[ownerToGravatar[msg.sender]].owner);
+
+    uint id = ownerToGravatar[msg.sender];
+
+    gravatars[id].imageUrl =  _imageUrl;
+    emit UpdatedGravatar(id, msg.sender, gravatars[id].displayName, _imageUrl);
+  }
+
+  // the gravatar at position 0 of gravatars[]
+  // is fake
+  // it's a mythical gravatar
+  // that doesn't really exist
+  // dani will invoke this function once when this contract is deployed
+  // but then no more
+  function setMythicalGravatar() public {
+    require(msg.sender == 0x8d3e809Fbd258083a5Ba004a527159Da535c8abA);
+    gravatars.push(Gravatar(0x0, " ", " "));
+  }
+}

package/tests/cli/init/ethereum/from-example/contracts/Migrations.sol

@@ -0,0 +1,23 @@
+pragma solidity ^0.4.0;
+
+contract Migrations {
+  address public owner;
+  uint public last_completed_migration;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+
+  modifier restricted() {
+    if (msg.sender == owner) _;
+  }
+
+  function setCompleted(uint completed) public restricted {
+    last_completed_migration = completed;
+  }
+
+  function upgrade(address new_address) public restricted {
+    Migrations upgraded = Migrations(new_address);
+    upgraded.setCompleted(last_completed_migration);
+  }
+}

package/tests/cli/init/ethereum/from-example/docker-compose.yml

@@ -0,0 +1,39 @@
+version: '3'
+services:
+  graph-node:
+    image: graphprotocol/graph-node:v0.22.0
+    ports:
+      - '8000:8000'
+      - '8001:8001'
+      - '8020:8020'
+      - '8030:8030'
+      - '8040:8040'
+    depends_on:
+      - ipfs
+      - postgres
+    environment:
+      postgres_host: postgres
+      postgres_user: graph-node
+      postgres_pass: let-me-in
+      postgres_db: graph-node
+      ipfs: 'ipfs:5001'
+      # Change next line if you want to connect to a different JSON-RPC endpoint
+      ethereum: 'mainnet:http://host.docker.internal:8545'
+      GRAPH_LOG: info
+  ipfs:
+    image: ipfs/go-ipfs:v0.4.23
+    ports:
+      - '5001:5001'
+    volumes:
+      - ./data/ipfs:/data/ipfs
+  postgres:
+    image: postgres
+    ports:
+      - '5432:5432'
+    command: ["postgres", "-cshared_preload_libraries=pg_stat_statements"]
+    environment:
+      POSTGRES_USER: graph-node
+      POSTGRES_PASSWORD: let-me-in
+      POSTGRES_DB: graph-node
+    volumes:
+      - ./data/postgres:/var/lib/postgresql/data

package/tests/cli/init/ethereum/from-example/migrations/1_initial_migration.js

@@ -0,0 +1,5 @@
+var Migrations = artifacts.require('./Migrations.sol')
+
+module.exports = function(deployer) {
+  deployer.deploy(Migrations)
+}

package/tests/cli/init/ethereum/from-example/migrations/2_deploy_contract.js

@@ -0,0 +1,5 @@
+const GravatarRegistry = artifacts.require('./GravatarRegistry.sol')
+
+module.exports = async function(deployer) {
+  await deployer.deploy(GravatarRegistry)
+}

package/tests/cli/init/ethereum/from-example/migrations/3_create_gravatars.js

@@ -0,0 +1,15 @@
+const GravatarRegistry = artifacts.require('./GravatarRegistry.sol')
+
+module.exports = async function(deployer) {
+  const registry = await GravatarRegistry.deployed()
+
+  console.log('Account address:', registry.address)
+
+  let accounts = await web3.eth.getAccounts()
+  await registry.createGravatar('Carl', 'https://thegraph.com/img/team/team_04.png', {
+    from: accounts[0],
+  })
+  await registry.createGravatar('Lucas', 'https://thegraph.com/img/team/bw_Lucas.jpg', {
+    from: accounts[1],
+  })
+}

package/tests/cli/init/ethereum/from-example/networks.json

@@ -0,0 +1,7 @@
+{
+  "mainnet": {
+    "Gravity": {
+      "address": "0x2E645469f354BB4F5c8a05B3b30A929361cf77eC"
+    }
+  }
+}

package/tests/cli/init/ethereum/from-example/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "example-subgraph",
+  "version": "0.1.0",
+  "scripts": {
+    "build-contract": "solc contracts/Gravity.sol --abi -o abis --overwrite && solc contracts/Gravity.sol --bin -o bin --overwrite",
+    "create": "graph create user/example-subgraph --node https://api.thegraph.com/deploy/",
+    "create-local": "graph create user/example-subgraph --node http://127.0.0.1:8020",
+    "codegen": "graph codegen",
+    "build": "graph build",
+    "deploy": "graph deploy user/example-subgraph --ipfs https://api.thegraph.com/ipfs/ --node https://api.thegraph.com/deploy/",
+    "deploy-local": "graph deploy user/example-subgraph --ipfs http://127.0.0.1:5001 --node http://127.0.0.1:8020"
+  },
+  "devDependencies": {
+    "@graphprotocol/graph-ts": "^0.26.0"
+  },
+  "dependencies": {
+    "babel-polyfill": "^6.26.0",
+    "babel-register": "^6.26.0",
+    "truffle": "^5.0.4",
+    "truffle-contract": "^4.0.5",
+    "truffle-hdwallet-provider": "^1.0.4"
+  }
+}

package/tests/cli/init/ethereum/from-example/schema.graphql

@@ -0,0 +1,6 @@
+type Gravatar @entity {
+  id: ID!
+  owner: Bytes!
+  displayName: String!
+  imageUrl: String!
+}

package/tests/cli/init/ethereum/from-example/src/mapping.ts

@@ -0,0 +1,22 @@
+import { NewGravatar, UpdatedGravatar } from '../generated/Gravity/Gravity'
+import { Gravatar } from '../generated/schema'
+
+export function handleNewGravatar(event: NewGravatar): void {
+  let gravatar = new Gravatar(event.params.id.toHex())
+  gravatar.owner = event.params.owner
+  gravatar.displayName = event.params.displayName
+  gravatar.imageUrl = event.params.imageUrl
+  gravatar.save()
+}
+
+export function handleUpdatedGravatar(event: UpdatedGravatar): void {
+  let id = event.params.id.toHex()
+  let gravatar = Gravatar.load(id)
+  if (gravatar == null) {
+    gravatar = new Gravatar(id)
+  }
+  gravatar.owner = event.params.owner
+  gravatar.displayName = event.params.displayName
+  gravatar.imageUrl = event.params.imageUrl
+  gravatar.save()
+}

package/tests/cli/init/ethereum/from-example/subgraph.yaml

@@ -0,0 +1,27 @@
+specVersion: 0.0.2
+description: Gravatar for Ethereum
+repository: https://github.com/graphprotocol/example-subgraph
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: Gravity
+    network: mainnet
+    source:
+      address: '0x2E645469f354BB4F5c8a05B3b30A929361cf77eC'
+      abi: Gravity
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Gravatar
+      abis:
+        - name: Gravity
+          file: ./abis/Gravity.json
+      eventHandlers:
+        - event: NewGravatar(uint256,address,string,string)
+          handler: handleNewGravatar
+        - event: UpdatedGravatar(uint256,address,string,string)
+          handler: handleUpdatedGravatar
+      file: ./src/mapping.ts

package/tests/cli/init/ethereum/from-example/truffle.js

@@ -0,0 +1,27 @@
+require('babel-register')
+require('babel-polyfill')
+const HDWalletProvider = require('truffle-hdwallet-provider')
+
+module.exports = {
+  networks: {
+    development: {
+      host: '127.0.0.1',
+      port: 8545,
+      network_id: '*',
+    },
+    ropsten: {
+      provider: function() {
+        return new HDWalletProvider(
+          process.env.MNEMONIC,
+          `https://ropsten.infura.io/v3/${process.env.ROPSTEN_INFURA_API_KEY}`
+        )
+      },
+      network_id: '3',
+    },
+  },
+  compilers: {
+    solc: {
+      version: '0.4.25'    // Fetch exact version from solc-bin (default: truffle's version)
+    }
+  }
+}