@graphprotocol/graph-cli 0.29.2 → 0.30.0

package/src/protocols/arweave/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 {
+  owner: String
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [BlockHandler!]
+  transactionHandlers: [TransactionHandler!]
+}
+
+type BlockHandler {
+  handler: String!
+}
+
+type TransactionHandler {
+  handler: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}

package/src/protocols/arweave/scaffold/manifest.js

@@ -0,0 +1,19 @@
+const source = ({ contract }) => `
+      owner: '${contract}'`
+
+const mapping = () => `
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - Block
+        - Transaction
+      blockHandlers:
+        - handler: handleBlock
+      transactionHandlers:
+        - handler: handleTx
+      file: ./src/mapping.ts`
+
+module.exports = {
+  source,
+  mapping,
+}

package/src/protocols/arweave/scaffold/mapping.js

@@ -0,0 +1,53 @@
+const generatePlaceholderHandlers = () =>
+  `
+  import { arweave, BigInt } from '@graphprotocol/graph-ts'
+  import { Block, Transaction } from '../generated/schema'
+
+  export function handleBlock(block: arweave.Block): void {
+    // Entities can be loaded from the store using a indepHash; this indepHash
+    // needs to be unique across all entities of the same type
+    let entity = Block.load(block.indepHash.toHexString())
+
+    // Entities only exist after they have been saved to the store;
+    // \`null\` checks allow to create entities on demand
+    if (!entity) {
+      entity = new Block(block.indepHash.toHexString());
+
+      // Entity fields can be set using simple assignments
+      entity.height = BigInt.fromU64(block.height)
+    }
+
+    // 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.
+  }
+
+  export function handleTx(tb: arweave.TransactionWithBlockPtr): void {
+    const tx = tb.tx;
+    const entity = new Transaction(tx.id.toHexString());
+
+    entity.block = tb.block.indepHash;
+    entity.tx_id = tx.id;
+    entity.last_tx = tx.lastTx;
+    entity.owner = tx.owner;
+    entity.tags = saveTags(tx.id.toHexString(), tx.tags);
+    entity.data = tx.data;
+    entity.data_root = tx.dataRoot;
+    entity.data_size = tx.dataSize;
+    entity.target = tx.target;
+    entity.quantity = tx.quantity;
+    entity.signature = tx.signature;
+    entity.reward = tx.reward;
+
+    entity.save();
+  }
+`
+
+module.exports = {
+  generatePlaceholderHandlers,
+}

package/src/protocols/arweave/subgraph.js

@@ -0,0 +1,20 @@
+const immutable = require('immutable')
+
+module.exports = class ArweaveSubgraph {
+  constructor(options = {}) {
+    this.manifest = options.manifest
+    this.resolveFile = options.resolveFile
+    this.protocol = options.protocol
+  }
+
+  validateManifest() {
+    return immutable.List()
+  }
+
+  handlerTypes() {
+    return immutable.List([
+      'blockHandlers',
+      'transactionHandlers',
+    ])
+  }
+}

package/src/protocols/{tendermint → cosmos}/manifest.graphql

@@ -10,6 +10,7 @@ scalar BigInt
 
 type SubgraphManifest {
   specVersion: String!
+  features: [String!]
   schema: Schema!
   description: String
   repository: String
@@ -40,6 +41,11 @@ type ContractMapping {
   entities: [String!]!
   blockHandlers: [BlockHandler!]
   eventHandlers: [EventHandler!]
+  transactionHandlers: [TransactionHandler!]
+}
+
+type TransactionHandler {
+  handler: String!
 }
 
 type BlockHandler {

package/src/protocols/cosmos/scaffold/manifest.js

@@ -0,0 +1,16 @@
+const source = () => `
+      startBlock: 0`
+
+const mapping = () => `
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - ExampleEntity
+      blockHandlers:
+        - handler: handleBlock
+      file: ./src/mapping.ts`
+
+module.exports = {
+  source,
+  mapping,
+}

package/src/protocols/cosmos/scaffold/mapping.js

@@ -0,0 +1,39 @@
+const generatePlaceholderHandlers = () =>
+  `
+  import { cosmos, BigInt } from '@graphprotocol/graph-ts'
+  import { ExampleEntity } from '../generated/schema'
+
+  export function handleBlock(block: cosmos.Block): 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(block.header.hash.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(block.header.hash.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 receipt information
+    entity.height = block.header.height
+
+    // 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.
+  }
+`
+
+module.exports = {
+  generatePlaceholderHandlers,
+}

package/src/protocols/{tendermint → cosmos}/subgraph.js

@@ -1,6 +1,6 @@
 const immutable = require('immutable')
 
-module.exports = class TendermintSubgraph {
+module.exports = class CosmosSubgraph {
   constructor(options = {}) {
     this.manifest = options.manifest
     this.resolveFile = options.resolveFile
@@ -15,6 +15,7 @@ module.exports = class TendermintSubgraph {
     return immutable.List([
       'blockHandlers',
       'eventHandlers',
+      'transactionHandlers',
     ])
   }
 }

package/src/protocols/ethereum/codegen/abi.js

@@ -502,6 +502,18 @@ module.exports = class AbiCodeGenerator {
             ),
           )
           .forEach(member => returnType.addMember(member))
+        
+        // Add getters to the type
+        outputs
+          .map((output, index) =>
+            !!output.get('name') && tsCodegen.method(
+              `get${output.get('name')[0].toUpperCase()}${output.get('name').slice(1)}`,
+              [],
+              this._getTupleParamType(output, index, tupleResultParentType),
+              `return this.value${index};`
+            )
+          )
+          .forEach(method => !!method && returnType.addMethod(method))
 
         // Create types for Tuple outputs
         outputs.forEach((output, index) => {

package/src/protocols/ethereum/manifest.graphql

@@ -7,6 +7,7 @@
 scalar String
 scalar File
 scalar BigInt
+scalar Boolean
 
 type SubgraphManifest {
   specVersion: String!
@@ -72,6 +73,7 @@ type ContractEventHandler {
   event: String!
   topic0: String
   handler: String!
+  receipt: Boolean
 }
 
 type Graft {

package/src/protocols/ethereum/scaffold/manifest.js

@@ -1,4 +1,5 @@
 const { abiEvents } = require('../../../scaffold/schema')
+const { strings } = require('gluegun')
 const ABI = require('../abi')
 
 const source = ({ contract, contractName }) => `
@@ -24,7 +25,7 @@ const mapping = ({ abi, contractName }) => `
           handler: handle${event.get('_alias')}`,
           )
           .join('')}
-      file: ./src/mapping.ts`
+      file: ./src/${strings.kebabCase(contractName)}.ts`
 
 module.exports = {
   source,

package/src/protocols/index.js

@@ -1,16 +1,20 @@
 const immutable = require('immutable')
+const ArweaveSubgraph = require('./arweave/subgraph')
 const EthereumTypeGenerator = require('./ethereum/type-generator')
 const EthereumTemplateCodeGen = require('./ethereum/codegen/template')
 const EthereumABI = require('./ethereum/abi')
 const EthereumSubgraph = require('./ethereum/subgraph')
 const NearSubgraph = require('./near/subgraph')
-const TendermintSubgraph = require('./tendermint/subgraph')
+const CosmosSubgraph = require('./cosmos/subgraph')
 const EthereumContract = require('./ethereum/contract')
 const NearContract = require('./near/contract')
 const EthereumManifestScaffold = require('./ethereum/scaffold/manifest')
 const NearManifestScaffold = require('./near/scaffold/manifest')
+const CosmosManifestScaffold = require('./cosmos/scaffold/manifest')
+const ArweaveMappingScaffold = require('./arweave/scaffold/mapping')
 const EthereumMappingScaffold = require('./ethereum/scaffold/mapping')
 const NearMappingScaffold = require('./near/scaffold/mapping')
+const CosmosMappingScaffold = require('./cosmos/scaffold/mapping')
 
 module.exports = class Protocol {
   static fromDataSources(dataSourcesAndTemplates) {
@@ -19,21 +23,23 @@ module.exports = class Protocol {
   }
 
   constructor(name) {
-    this.name = this.normalizeName(name)
+    this.name = Protocol.normalizeName(name)
   }
 
   static availableProtocols() {
     return immutable.fromJS({
       // `ethereum/contract` is kept for backwards compatibility.
       // New networks (or protocol perhaps) shouldn't have the `/contract` anymore (unless a new case makes use of it).
+      arweave: ['arweave'],
       ethereum: ['ethereum', 'ethereum/contract'],
       near: ['near'],
-      tendermint: ['tendermint']
+      cosmos: ['cosmos']
     })
   }
 
   static availableNetworks() {
     return immutable.fromJS({
+      arweave: ['arweave-mainnet'],
       ethereum: [
         'mainnet',
         'kovan',
@@ -63,11 +69,16 @@ module.exports = class Protocol {
         'aurora-testnet',
       ],
       near: ['near-mainnet', 'near-testnet'],
-      tendermint: ['cosmoshub-4']
+      cosmos: [
+        'cosmoshub-4',
+        'theta-testnet-001',
+        'osmosis-1',
+        'osmo-test-4'
+      ],
     })
   }
 
-  normalizeName(name) {
+  static normalizeName(name) {
     return Protocol.availableProtocols().findKey(possibleNames =>
       possibleNames.includes(name),
     )
@@ -75,12 +86,14 @@ module.exports = class Protocol {
 
   displayName() {
     switch (this.name) {
+      case 'arweave':
+        return 'Arweave'
       case 'ethereum':
         return 'Ethereum'
       case 'near':
         return 'NEAR'
-      case 'tendermint':
-        return 'Tendermint'
+      case 'cosmos':
+        return 'Cosmos'
     }
   }
 
@@ -94,55 +107,65 @@ module.exports = class Protocol {
 
   hasABIs() {
     switch (this.name) {
+      case 'arweave':
+        return false
       case 'ethereum':
         return true
       case 'near':
         return false
-      case 'tendermint':
+      case 'cosmos':
         return false
     }
   }
 
   hasContract() {
     switch (this.name) {
+      case 'arweave':
+        return false
       case 'ethereum':
         return true
       case 'near':
         return true
-      case 'tendermint':
+      case 'cosmos':
         return false
     }
   }
 
   hasEvents() {
     switch (this.name) {
+      case 'arweave':
+        return false
       case 'ethereum':
         return true
       case 'near':
         return false
-      case 'tendermint':
+      case 'cosmos':
         return false
     }
   }
 
   hasTemplates() {
     switch (this.name) {
+      case 'arweave':
+        return false
       case 'ethereum':
         return true
       case 'near':
         return false
-      case 'tendermint':
+      case 'cosmos':
         return false
     }
   }
 
   getTypeGenerator(options) {
     switch (this.name) {
+      case 'arweave':
+        return null
       case 'ethereum':
         return new EthereumTypeGenerator(options)
       case 'near':
         return null
-      case 'tendermint':
+      case 'cosmos':
         return null
     }
   }
@@ -164,11 +187,13 @@ module.exports = class Protocol {
 
   getABI() {
     switch (this.name) {
+      case 'arweave':
+        return null
       case 'ethereum':
         return EthereumABI
       case 'near':
         return null
-      case 'tendermint':
+      case 'cosmos':
         return null
     }
   }
@@ -177,12 +202,14 @@ module.exports = class Protocol {
     const optionsWithProtocol = { ...options, protocol: this }
 
     switch (this.name) {
+      case 'arweave':
+        return new ArweaveSubgraph(optionsWithProtocol)
       case 'ethereum':
         return new EthereumSubgraph(optionsWithProtocol)
       case 'near':
         return new NearSubgraph(optionsWithProtocol)
-      case 'tendermint':
-        return new TendermintSubgraph(optionsWithProtocol)
+      case 'cosmos':
+        return new CosmosSubgraph(optionsWithProtocol)
       default:
         throw new Error(`Data sources with kind '${this.name}' are not supported yet`)
     }
@@ -190,34 +217,40 @@ module.exports = class Protocol {
 
   getContract() {
     switch (this.name) {
+      case 'arweave':
+        return null
       case 'ethereum':
         return EthereumContract
       case 'near':
         return NearContract
-      case 'tendermint':
+      case 'cosmos':
         return null
     }
   }
 
   getManifestScaffold() {
     switch (this.name) {
+      case 'arweave':
+        return ArweaveMappingScaffold
       case 'ethereum':
         return EthereumManifestScaffold
       case 'near':
         return NearManifestScaffold
-      case 'tendermint':
-        return null
+      case 'cosmos':
+        return CosmosManifestScaffold
     }
   }
 
   getMappingScaffold() {
     switch (this.name) {
+      case 'arweave':
+        return ArweaveMappingScaffold
       case 'ethereum':
         return EthereumMappingScaffold
       case 'near':
         return NearMappingScaffold
-      case 'tendermint':
-        return null
+      case 'cosmos':
+        return CosmosMappingScaffold
     }
   }
 }

package/src/protocols/near/manifest.graphql

@@ -10,6 +10,7 @@ scalar BigInt
 
 type SubgraphManifest {
   specVersion: String!
+  features: [String!]
   schema: Schema!
   description: String
   repository: String

package/src/protocols/near/scaffold/manifest.js

@@ -1,14 +1,16 @@
+const { strings } = require('gluegun')
+
 const source = ({ contract }) => `
       account: '${contract}'`
 
-const mapping = () => `
+const mapping = ({ contractName }) => `
       apiVersion: 0.0.5
       language: wasm/assemblyscript
       entities:
         - ExampleEntity
       receiptHandlers:
         - handler: handleReceipt
-      file: ./src/mapping.ts`
+      file: ./src/${strings.kebabCase(contractName)}.ts`
 
 module.exports = {
   source,

package/src/scaffold/cosmos.test.js

@@ -0,0 +1,86 @@
+const immutable = require('immutable')
+const Scaffold = require('./')
+const Protocol = require('../protocols')
+
+const protocol = new Protocol('cosmos')
+
+const scaffoldOptions = {
+  protocol,
+  network: 'cosmoshub-4',
+  dataSourceName: 'CosmosHub'
+}
+
+const scaffold = new Scaffold(scaffoldOptions)
+
+describe('Cosmos subgraph scaffolding', () => {
+  test('Manifest', () => {
+    expect(
+      scaffold.generateManifest(),
+    ).toEqual(`\
+specVersion: 0.0.1
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: cosmos
+    name: CosmosHub
+    network: cosmoshub-4
+    source:
+      startBlock: 0
+    mapping:
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - ExampleEntity
+      blockHandlers:
+        - handler: handleBlock
+      file: ./src/mapping.ts
+`)
+  })
+
+  test('Schema (default)', () => {
+    expect(scaffold.generateSchema()).toEqual(`\
+type ExampleEntity @entity {
+  id: ID!
+  block: Bytes!
+  count: BigInt!
+}
+`)
+  })
+
+  test('Mapping (default)', () => {
+    expect(scaffold.generateMapping()).toEqual(`\
+import { cosmos, BigInt } from "@graphprotocol/graph-ts"
+import { ExampleEntity } from "../generated/schema"
+
+export function handleBlock(block: cosmos.Block): 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(block.header.hash.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(block.header.hash.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 receipt information
+  entity.height = block.header.height
+
+  // 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.
+}
+`)
+  })
+})

package/src/scaffold/ethereum.test.js

@@ -77,6 +77,7 @@ const scaffoldOptions = {
   contract: '0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d',
   network: 'kovan',
   contractName: 'Contract',
+  dataSourceName: 'Contract'
 }
 
 const scaffold = new Scaffold(scaffoldOptions)
@@ -116,7 +117,7 @@ dataSources:
           handler: handleExampleEvent
         - event: ExampleEvent(bytes32)
           handler: handleExampleEvent1
-      file: ./src/mapping.ts
+      file: ./src/contract.ts
 `)
   })