@graphprotocol/graph-cli 0.22.2 → 0.23.0

package/src/validation/index.js

@@ -1,4 +1,5 @@
 module.exports = {
   validateSchema: require('./schema').validateSchema,
   validateManifest: require('./manifest').validateManifest,
+  validateContractValues: require('./manifest').validateContractValues,
 }

package/src/validation/manifest.js

@@ -51,13 +51,24 @@ const validators = immutable.fromJS({
   ScalarTypeDefinition: (value, ctx) =>
     validators.get(ctx.getIn(['type', 'name', 'value']))(value, ctx),
 
-  UnionTypeDefinition: (value, ctx) =>
-    ctx
+  UnionTypeDefinition: (value, ctx) => {
+    const unionVariants = ctx
       .getIn(['type', 'types'])
-      .reduce(
-        (errors, type) => errors.concat(validateValue(value, ctx.set('type', type))),
-        List(),
-      ),
+
+    let errors = List()
+
+    for (const variantType of unionVariants) {
+      const variantErrors = validateValue(value, ctx.set('type', variantType))
+      // No errors found, union variant matched, early return
+      if (variantErrors.isEmpty()) {
+        return List()
+      }
+      errors = errors.push(variantErrors)
+    }
+
+    // Return errors from variant that matched the most
+    return List(errors.minBy(variantErrors => variantErrors.count()))
+  },
 
   NamedType: (value, ctx) =>
     validateValue(
@@ -199,9 +210,8 @@ const validateValue = (value, ctx) => {
   }
 }
 
-const validateDataSourceNetworks = value => {
-  let networks = [...value.dataSources, ...(value.templates || [])]
-    .filter(dataSource => dataSource.kind === 'ethereum/contract')
+const validateDataSourceForNetwork = (dataSources, protocol) =>
+  dataSources.filter(dataSource => protocol.isValidKindName(dataSource.kind))
     .reduce(
       (networks, dataSource) =>
         networks.update(dataSource.network, dataSources =>
@@ -210,28 +220,37 @@ const validateDataSourceNetworks = value => {
       immutable.OrderedMap(),
     )
 
-  return networks.size > 1
-    ? immutable.fromJS([
-        {
-          path: [],
-          message: `Conflicting networks used in data sources and templates:
+const validateDataSourceNetworks = (value, protocol) => {
+  const dataSources = [...value.dataSources, ...(value.templates || [])]
+
+  // Networks found valid for a protocol.
+  // By searching through all data sources and templates.
+  const networks = validateDataSourceForNetwork(dataSources, protocol)
+
+  if (networks.size > 1) {
+    return immutable.fromJS([
+      {
+        path: [],
+        message: `Conflicting networks used in data sources and templates:
 ${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.`,
-        },
-      ])
-    : List()
+      },
+    ])
+  }
+
+  return List()
 }
 
-const validateManifest = (value, type, schema, { resolveFile }) => {
+const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
   // Validate manifest using the GraphQL schema that defines its structure
   let errors =
     value !== null && value !== undefined
@@ -260,7 +279,38 @@ const validateManifest = (value, type, schema, { resolveFile }) => {
 
   // Validate that all data sources are for the same `network` (this includes
   // _no_ network at all)
-  return validateDataSourceNetworks(value)
+  return validateDataSourceNetworks(value, protocol)
 }
 
-module.exports = { validateManifest }
+const validateContractValues = (manifest, protocol, fieldName, validator, errorMessage) =>
+  manifest
+    .get('dataSources')
+    .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
+    .reduce((errors, dataSource, dataSourceIndex) => {
+      let path = ['dataSources', dataSourceIndex, 'source', fieldName]
+
+      // No need to validate if the source has no contract field
+      if (!dataSource.get('source').has(fieldName)) {
+        return errors
+      }
+
+      let contractValue = dataSource.getIn(['source', fieldName])
+
+      // Validate whether the contract is valid
+      if (validator(contractValue)) {
+        return errors
+      } else {
+        return errors.push(
+          immutable.fromJS({
+            path,
+            message: `\
+Contract ${fieldName} is invalid: ${contractValue}${errorMessage ? `\n${errorMessage}` : ''}`,
+          }),
+        )
+      }
+    }, immutable.List())
+
+module.exports = {
+  validateManifest,
+  validateContractValues,
+}

package/src/validation/schema.js

@@ -20,6 +20,12 @@ const BUILTIN_SCALAR_TYPES = [
 const TYPE_SUGGESTIONS = [
   ['Address', 'Bytes'],
   ['address', 'Bytes'],
+  ['Account', 'String'],
+  ['account', 'String'],
+  ['AccountId', 'String'],
+  ['AccountID', 'String'],
+  ['accountId', 'String'],
+  ['accountid', 'String'],
   ['bytes', 'Bytes'],
   ['string', 'String'],
   ['bool', 'Boolean'],

package/subgraph-ethereum.yaml

@@ -0,0 +1,134 @@
+specVersion: 0.0.2
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: NiftyInk
+    network: xdai
+    source:
+      address: "0x49dE55fbA08af88f55EB797a456fdf76B151c8b0"
+      abi: NiftyInk
+      startBlock: 11296636
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Ink
+        - Artist
+        - InkNumberLookUp
+      abis:
+        - name: NiftyInk
+          file: ./abis/NiftyInk.json
+      eventHandlers:
+        - event: newInk(uint256,indexed address,string,string,uint256)
+          handler: handlenewInk
+      callHandlers:
+        - function: setPrice(string,uint256)
+          handler: handleSetPrice
+        - function: setPriceFromSignature(string,uint256,bytes)
+          handler: handleSetPriceFromSignature
+      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: NiftyToken
+    network: xdai
+    source:
+      address: "0xCF964c89f509a8c0Ac36391c5460dF94B91daba5"
+      abi: NiftyToken
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Ink
+        - Token
+        - Sale
+        - Transfer
+      abis:
+        - name: NiftyToken
+          file: ./abis/NiftyToken.json
+        - name: NiftyInk
+          file: ./abis/NiftyInk.json
+      eventHandlers:
+        - event: Transfer(indexed address,indexed address,indexed uint256)
+          handler: handleTransfer
+        - event: boughtInk(uint256,string,address,uint256)
+          handler: handleBoughtInk
+        - event: mintedInk(uint256,string,address)
+          handler: handleMintedInk
+      callHandlers:
+        - function: setTokenPrice(uint256,uint256)
+          handler: handleSetTokenPrice
+      file: ./src/mapping.ts
+  #  - kind: ethereum/contract
+  #    name: NiftyMain
+  #    network: mainnet
+  #    source:
+  #      address: "0xc02697c417DdAcfbe5EdbF23eDad956BC883F4fb"
+  #      abi: NiftyMain
+  #      startBlock: 10609660
+  #    mapping:
+  #      kind: ethereum/events
+  #      apiVersion: 0.0.4
+  #      language: wasm/assemblyscript
+  #      entities:
+  #        - Token
+  #        - Transfer
+  #      abis:
+  #        - name: NiftyMain
+  #          file: ./abis/NiftyMain.json
+  #        - name: NiftyToken
+  #          file: ./abis/NiftyToken.json
+  #      eventHandlers:
+  #        - event: Transfer(indexed address,indexed address,indexed uint256)
+  #          handler: handleTransfer
+  #        - event: mintedInk(uint256,string,address)
+  #          handler: handleMintedOnMain
+  #      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: NiftyMediator
+    network: xdai
+    source:
+      address: "0x73cA9C4e72fF109259cf7374F038faf950949C51"
+      abi: NiftyMediator
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Token
+      abis:
+        - name: NiftyMediator
+          file: ./abis/NiftyMediator.json
+        - name: NiftyToken
+          file: ./abis/NiftyToken.json
+      eventHandlers:
+        - event: tokenSentViaBridge(uint256,bytes32)
+          handler: handleTokenSentViaBridge
+        - event: newPrice(uint256)
+          handler: handleNewRelayPrice
+      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: Liker
+    network: xdai
+    source:
+      address: "0xBD0621dcb64e1EEd503f709422b019B2fA197aF6"
+      abi: Liker
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - InkLookUp
+        - Like
+        - Ink
+      abis:
+        - name: Liker
+          file: ./abis/Liker.json
+      eventHandlers:
+        - event: liked(uint256,address,uint256,uint256,address)
+          handler: handleLikedInk
+      file: ./src/mapping.ts

package/subgraph-near.yaml

@@ -0,0 +1,134 @@
+specVersion: 0.0.2
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: NiftyInk
+    network: xdai
+    source:
+      address: "0x49dE55fbA08af88f55EB797a456fdf76B151c8b0"
+      abi: NiftyInk
+      startBlock: 11296636
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Ink
+        - Artist
+        - InkNumberLookUp
+      abis:
+        - name: NiftyInk
+          file: ./abis/NiftyInk.json
+      eventHandlers:
+        - event: newInk(uint256,indexed address,string,string,uint256)
+          handler: handlenewInk
+      callHandlers:
+        - function: setPrice(string,uint256)
+          handler: handleSetPrice
+        - function: setPriceFromSignature(string,uint256,bytes)
+          handler: handleSetPriceFromSignature
+      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: NiftyToken
+    network: xdai
+    source:
+      address: "0xCF964c89f509a8c0Ac36391c5460dF94B91daba5"
+      abi: NiftyToken
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Ink
+        - Token
+        - Sale
+        - Transfer
+      abis:
+        - name: NiftyToken
+          file: ./abis/NiftyToken.json
+        - name: NiftyInk
+          file: ./abis/NiftyInk.json
+      eventHandlers:
+        - event: Transfer(indexed address,indexed address,indexed uint256)
+          handler: handleTransfer
+        - event: boughtInk(uint256,string,address,uint256)
+          handler: handleBoughtInk
+        - event: mintedInk(uint256,string,address)
+          handler: handleMintedInk
+      callHandlers:
+        - function: setTokenPrice(uint256,uint256)
+          handler: handleSetTokenPrice
+      file: ./src/mapping.ts
+  #  - kind: ethereum/contract
+  #    name: NiftyMain
+  #    network: mainnet
+  #    source:
+  #      address: "0xc02697c417DdAcfbe5EdbF23eDad956BC883F4fb"
+  #      abi: NiftyMain
+  #      startBlock: 10609660
+  #    mapping:
+  #      kind: ethereum/events
+  #      apiVersion: 0.0.4
+  #      language: wasm/assemblyscript
+  #      entities:
+  #        - Token
+  #        - Transfer
+  #      abis:
+  #        - name: NiftyMain
+  #          file: ./abis/NiftyMain.json
+  #        - name: NiftyToken
+  #          file: ./abis/NiftyToken.json
+  #      eventHandlers:
+  #        - event: Transfer(indexed address,indexed address,indexed uint256)
+  #          handler: handleTransfer
+  #        - event: mintedInk(uint256,string,address)
+  #          handler: handleMintedOnMain
+  #      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: NiftyMediator
+    network: xdai
+    source:
+      address: "0x73cA9C4e72fF109259cf7374F038faf950949C51"
+      abi: NiftyMediator
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Token
+      abis:
+        - name: NiftyMediator
+          file: ./abis/NiftyMediator.json
+        - name: NiftyToken
+          file: ./abis/NiftyToken.json
+      eventHandlers:
+        - event: tokenSentViaBridge(uint256,bytes32)
+          handler: handleTokenSentViaBridge
+        - event: newPrice(uint256)
+          handler: handleNewRelayPrice
+      file: ./src/mapping.ts
+  - kind: ethereum/contract
+    name: Liker
+    network: xdai
+    source:
+      address: "0xBD0621dcb64e1EEd503f709422b019B2fA197aF6"
+      abi: Liker
+      startBlock: 11296637
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - InkLookUp
+        - Like
+        - Ink
+      abis:
+        - name: Liker
+          file: ./abis/Liker.json
+      eventHandlers:
+        - event: liked(uint256,address,uint256,uint256,address)
+          handler: handleLikedInk
+      file: ./src/mapping.ts

package/tests/cli/init/from-contract/abis/Contract.json

@@ -0,0 +1,69 @@
+[
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "proxyOwner",
+    "outputs": [{ "name": "", "type": "address" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "currentContract",
+    "outputs": [{ "name": "", "type": "address" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "owner",
+    "outputs": [{ "name": "", "type": "address" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "newContract", "type": "address" },
+      { "name": "data", "type": "bytes" }
+    ],
+    "name": "upgrade",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [{ "name": "_newOwner", "type": "address" }],
+    "name": "transferOwnership",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  { "payable": true, "stateMutability": "payable", "type": "fallback" },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "newContract", "type": "address" },
+      { "indexed": false, "name": "initializedWith", "type": "bytes" }
+    ],
+    "name": "Upgrade",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": false, "name": "_prevOwner", "type": "address" },
+      { "indexed": false, "name": "_newOwner", "type": "address" }
+    ],
+    "name": "OwnerUpdate",
+    "type": "event"
+  }
+]

package/tests/cli/init/from-contract/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "subgraph-from-contract",
+  "license": "UNLICENSED",
+  "scripts": {
+    "codegen": "graph codegen",
+    "build": "graph build",
+    "deploy": "graph deploy --node https://api.studio.thegraph.com/deploy/ user/subgraph-from-contract",
+    "create-local": "graph create --node http://localhost:8020/ user/subgraph-from-contract",
+    "remove-local": "graph remove --node http://localhost:8020/ user/subgraph-from-contract",
+    "deploy-local": "graph deploy --node http://localhost:8020/ --ipfs http://localhost:5001 user/subgraph-from-contract"
+  },
+  "dependencies": {
+    "@graphprotocol/graph-cli": "file:../../../../",
+    "@graphprotocol/graph-ts": "0.22.1"
+  }
+}

package/tests/cli/init/from-contract/schema.graphql

@@ -0,0 +1,6 @@
+type ExampleEntity @entity {
+  id: ID!
+  count: BigInt!
+  newContract: Bytes! # address
+  initializedWith: Bytes! # bytes
+}

package/tests/cli/init/from-contract/src/mapping.ts

@@ -0,0 +1,49 @@
+import { BigInt } from "@graphprotocol/graph-ts"
+import { Contract, Upgrade, OwnerUpdate } from "../generated/Contract/Contract"
+import { ExampleEntity } from "../generated/schema"
+
+export function handleUpgrade(event: Upgrade): void {
+  // Entities can be loaded from the store using a string ID; this ID
+  // needs to be unique across all entities of the same type
+  let entity = ExampleEntity.load(event.transaction.from.toHex())
+
+  // Entities only exist after they have been saved to the store;
+  // `null` checks allow to create entities on demand
+  if (!entity) {
+    entity = new ExampleEntity(event.transaction.from.toHex())
+
+    // Entity fields can be set using simple assignments
+    entity.count = BigInt.fromI32(0)
+  }
+
+  // BigInt and BigDecimal math are supported
+  entity.count = entity.count + BigInt.fromI32(1)
+
+  // Entity fields can be set based on event parameters
+  entity.newContract = event.params.newContract
+  entity.initializedWith = event.params.initializedWith
+
+  // Entities can be written to the store with `.save()`
+  entity.save()
+
+  // Note: If a handler doesn't require existing field values, it is faster
+  // _not_ to load the entity from the store. Instead, create it fresh with
+  // `new Entity(...)`, set the fields that should be updated and save the
+  // entity back to the store. Fields that were not set or unset remain
+  // unchanged, allowing for partial updates to be applied.
+
+  // It is also possible to access smart contracts from mappings. For
+  // example, the contract that has emitted the event can be connected to
+  // with:
+  //
+  // let contract = Contract.bind(event.address)
+  //
+  // The following functions can then be called on this contract to access
+  // state variables and other data:
+  //
+  // - contract.proxyOwner(...)
+  // - contract.currentContract(...)
+  // - contract.owner(...)
+}
+
+export function handleOwnerUpdate(event: OwnerUpdate): void {}

package/tests/cli/init/from-contract/subgraph.yaml

@@ -0,0 +1,26 @@
+specVersion: 0.0.1
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: Contract
+    network: mainnet
+    source:
+      address: "0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d"
+      abi: Contract
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Upgrade
+        - OwnerUpdate
+      abis:
+        - name: Contract
+          file: ./abis/Contract.json
+      eventHandlers:
+        - event: Upgrade(indexed address,bytes)
+          handler: handleUpgrade
+        - event: OwnerUpdate(address,address)
+          handler: handleOwnerUpdate
+      file: ./src/mapping.ts

package/tests/cli/validation/near-is-valid/schema.graphql

@@ -0,0 +1,8 @@
+type MyEntity @entity {
+  id: ID!
+  x: Account!
+}
+
+type Account @entity {
+  id: ID!
+}

package/tests/cli/validation/near-is-valid/subgraph.yaml

@@ -0,0 +1,21 @@
+specVersion: 0.0.1
+repository: https://github.com/graphprotocol/near-subgraph
+description: NEAR subgraph
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: near
+    name: NearSubgraph
+    source:
+      account: wnear.flux-dev
+      startBlock: 1
+    mapping:
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      file: ./mapping.ts
+      entities:
+        - ExampleEntity
+      blockHandlers:
+        - handler: handleNewBlock
+      receiptHandlers:
+        - handler: handleReceipt

package/tests/cli/validation.test.js

@@ -144,6 +144,14 @@ describe('Validation', () => {
       exitCode: 1,
     },
   )
+  cliTest(
+    'NEAR is a valid chain',
+    ['codegen', '--skip-migrations'],
+    'validation/near-is-valid',
+    {
+      exitCode: 0,
+    },
+  )
   cliTest(
     'Deprecated template format gives nice error',
     ['codegen', '--skip-migrations'],