@graphprotocol/graph-cli 0.24.1 → 0.25.3

package/src/codegen/schema.test.js

@@ -0,0 +1,368 @@
+const prettier = require('prettier')
+const graphql = require('graphql/language')
+const immutable = require('immutable')
+const SchemaCodeGenerator = require('./schema')
+const {
+  Class,
+  Method,
+  StaticMethod,
+  Param,
+  NamedType,
+  NullableType,
+  ArrayType,
+} = require('./typescript')
+
+const formatTS = code =>
+  prettier.format(
+    code,
+    { parser: 'typescript', semi: false }
+  )
+
+const createSchemaCodeGen = schema =>
+  new SchemaCodeGenerator({
+    ast: immutable.fromJS(graphql.parse(schema)),
+  })
+
+const testEntity = (generatedTypes, expectedEntity) => {
+  const entity = generatedTypes.find(type => type.name === expectedEntity.name)
+
+  expect(entity instanceof Class).toBe(true)
+  expect(entity.extends).toBe('Entity')
+  expect(entity.export).toBe(true)
+
+  const { members, methods } = entity
+
+  expect(members).toStrictEqual(expectedEntity.members)
+
+  for (const expectedMethod of expectedEntity.methods) {
+    const method = methods.find(method => method.name === expectedMethod.name)
+
+    expectedMethod.static
+      ? expect(method instanceof StaticMethod).toBe(true)
+      : expect(method instanceof Method).toBe(true)
+
+    expect(method.params).toStrictEqual(expectedMethod.params)
+    expect(method.returnType).toStrictEqual(expectedMethod.returnType)
+    expect(formatTS(method.body)).toBe(formatTS(expectedMethod.body))
+  }
+
+  expect(methods.length).toBe(expectedEntity.methods.length)
+}
+
+describe('Schema code generator', () => {
+  test('Should generate nothing for non entity types', () => {
+    const codegen = createSchemaCodeGen(`
+      type Foo {
+        foobar: Int
+      }
+
+      type Bar {
+        barfoo: Int
+      }
+    `)
+
+    expect(codegen.generateTypes().size).toBe(0)
+  })
+
+  describe('Should generate correct classes for each entity', () => {
+    const codegen = createSchemaCodeGen(`
+      # just to be sure nothing will be generated from non-entity types alongside regular ones
+      type Foo {
+        foobar: Int
+      }
+
+      type Account @entity {
+        id: ID!
+
+        # two non primitive types
+        description: String
+        name: String!
+
+        # two primitive types (i32)
+        age: Int
+        count: Int!
+
+        # derivedFrom
+        wallets: [Wallet!] @derivedFrom(field: "account")
+      }
+
+      type Wallet @entity {
+        id: ID!
+        amount: BigInt!
+        account: Account!
+      }
+    `)
+
+    const generatedTypes = codegen.generateTypes()
+
+    test('Foo is NOT an entity', () => {
+      const foo = generatedTypes.find(type => type.name === 'Foo')
+      expect(foo).toBe(undefined)
+      // Account and Wallet
+      expect(generatedTypes.size).toBe(2)
+    })
+
+    test('Account is an entity with the correct methods', () => {
+      testEntity(generatedTypes, {
+        name: 'Account',
+        members: [],
+        methods: [
+          {
+            name: 'constructor',
+            params: [new Param('id', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              super()
+              this.set('id', Value.fromString(id))
+
+              this.set('name', Value.fromString(''))
+              this.set('count', Value.fromI32(0))
+            `,
+          },
+          {
+            name: 'save',
+            params: [],
+            returnType: new NamedType('void'),
+            body: `
+              let id = this.get('id')
+              assert(id != null, 'Cannot save Account entity without an ID')
+              if (id) {
+                assert(
+                  id.kind == ValueKind.STRING,
+                  'Cannot save Account entity with non-string ID. ' +
+                  'Considering using .toHex() to convert the "id" to a string.'
+                )
+                store.set('Account', id.toString(), this)
+              }
+            `,
+          },
+          {
+            name: 'load',
+            static: true,
+            params: [new Param('id', new NamedType('string'))],
+            returnType: new NullableType(new NamedType('Account')),
+            body: `
+              return changetype<Account | null>(store.get('Account', id))
+            `,
+          },
+          {
+            name: 'get id',
+            params: [],
+            returnType: new NamedType('string'),
+            body: `
+              let value = this.get('id')
+              return value!.toString()
+            `,
+          },
+          {
+            name: 'set id',
+            params: [new Param('value', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              this.set('id', Value.fromString(value))
+            `,
+          },
+          {
+            name: 'get description',
+            params: [],
+            returnType: new NullableType(new NamedType('string')),
+            body: `
+              let value = this.get('description')
+              if (!value || value.kind == ValueKind.NULL) {
+                return null
+              } else {
+                return value.toString()
+              }
+            `,
+          },
+          {
+            name: 'set description',
+            params: [new Param('value', new NullableType(new NamedType('string')))],
+            returnType: undefined,
+            body: `
+              if (!value) {
+                this.unset('description')
+              } else {
+                this.set('description', Value.fromString(<string>value))
+              }
+            `,
+          },
+          {
+            name: 'get name',
+            params: [],
+            returnType: new NamedType('string'),
+            body: `
+              let value = this.get('name')
+              return value!.toString()
+            `,
+          },
+          {
+            name: 'set name',
+            params: [new Param('value', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              this.set('name', Value.fromString(value))
+            `,
+          },
+          {
+            name: 'get age',
+            params: [],
+            returnType: new NamedType('i32'),
+            body: `
+              let value = this.get('age')
+              return value!.toI32()
+            `,
+          },
+          {
+            name: 'set age',
+            params: [new Param('value', new NamedType('i32'))],
+            returnType: undefined,
+            body: `
+              this.set('age', Value.fromI32(value))
+            `,
+          },
+          {
+            name: 'get count',
+            params: [],
+            returnType: new NamedType('i32'),
+            body: `
+              let value = this.get('count')
+              return value!.toI32()
+            `,
+          },
+          {
+            name: 'set count',
+            params: [new Param('value', new NamedType('i32'))],
+            returnType: undefined,
+            body: `
+              this.set('count', Value.fromI32(value))
+            `,
+          },
+          {
+            name: 'get wallets',
+            params: [],
+            returnType: new NullableType(new ArrayType(new NamedType('string'))),
+            body: `
+              let value = this.get('wallets')
+              if (!value || value.kind == ValueKind.NULL) {
+                return null
+              } else {
+                return value.toStringArray()
+              }
+            `,
+          },
+          {
+            name: 'set wallets',
+            params: [new Param('value', new NullableType(new ArrayType(new NamedType('string'))))],
+            returnType: undefined,
+            body: `
+              if (!value) {
+                this.unset('wallets')
+              } else {
+                this.set('wallets', Value.fromStringArray(<Array<string>>value))
+              }
+            `,
+          },
+        ],
+      })
+    })
+
+    test('Wallet is an entity with the correct methods', () => {
+      testEntity(generatedTypes, {
+        name: 'Wallet',
+        members: [],
+        methods: [
+          {
+            name: 'constructor',
+            params: [new Param('id', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              super()
+              this.set('id', Value.fromString(id))
+    
+              this.set('amount', Value.fromBigInt(BigInt.zero()))
+              this.set('account', Value.fromString(''))
+            `,
+          },
+          {
+            name: 'save',
+            params: [],
+            returnType: new NamedType('void'),
+            body: `
+              let id = this.get('id')
+              assert(id != null, 'Cannot save Wallet entity without an ID')
+              if (id) {
+                assert(
+                  id.kind == ValueKind.STRING,
+                  'Cannot save Wallet entity with non-string ID. ' +
+                  'Considering using .toHex() to convert the "id" to a string.'
+                )
+                store.set('Wallet', id.toString(), this)
+              }
+            `,
+          },
+          {
+            name: 'load',
+            static: true,
+            params: [new Param('id', new NamedType('string'))],
+            returnType: new NullableType(new NamedType('Wallet')),
+            body: `
+              return changetype<Wallet | null>(store.get('Wallet', id))
+            `,
+          },
+          {
+            name: 'get id',
+            params: [],
+            returnType: new NamedType('string'),
+            body: `
+              let value = this.get('id')
+              return value!.toString()
+            `,
+          },
+          {
+            name: 'set id',
+            params: [new Param('value', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              this.set('id', Value.fromString(value))
+            `,
+          },
+          {
+            name: 'get amount',
+            params: [],
+            returnType: new NamedType('BigInt'),
+            body: `
+              let value = this.get('amount')
+              return value!.toBigInt()
+            `,
+          },
+          {
+            name: 'set amount',
+            params: [new Param('value', new NamedType('BigInt'))],
+            returnType: undefined,
+            body: `
+              this.set('amount', Value.fromBigInt(value))
+            `,
+          },
+          {
+            name: 'get account',
+            params: [],
+            returnType: new NamedType('string'),
+            body: `
+              let value = this.get('account')
+              return value!.toString()
+            `,
+          },
+          {
+            name: 'set account',
+            params: [new Param('value', new NamedType('string'))],
+            returnType: undefined,
+            body: `
+              this.set('account', Value.fromString(value))
+            `,
+          },
+        ],
+      })
+    })
+  })
+})

package/src/codegen/types/defaults.js

@@ -0,0 +1,34 @@
+const immutable = require('immutable')
+
+// TODO: kill me
+const EMPTY_ARRAY = 'new Array(0)'
+
+const ASC_DEFAULTS = [
+  // Scalar values
+
+  ['Address', 'Address.zero()'],
+  ['Bytes', 'Bytes.empty()'],
+  ['boolean', 'false'],
+  ['i32', '0'],
+  ['string', '""'],
+  ['BigInt', 'BigInt.zero()'],
+  ['BigDecimal', 'BigDecimal.zero()'],
+
+  // Arrays
+
+  ['Array<Address>', EMPTY_ARRAY],
+  ['Array<Bytes>', EMPTY_ARRAY],
+  ['Array<boolean>', EMPTY_ARRAY],
+  ['Array<i32>', EMPTY_ARRAY],
+  ['Array<string>', EMPTY_ARRAY],
+  ['Array<BigInt>', EMPTY_ARRAY],
+  ['Array<BigDecimal>', EMPTY_ARRAY],
+  ['Array<string | null>', EMPTY_ARRAY],
+]
+
+module.exports = immutable.fromJS({
+  AssemblyScript: ASC_DEFAULTS,
+})
+// TODO: use me:
+  // [/Array<.*>/, 'new Array(0)'],
+  // [/Array\<.*\>/, 'new Array(0)'],

package/src/codegen/types/index.js

@@ -89,8 +89,12 @@ const findInitializationForType = (fromTypeSystem, toTypeSystem, ascType) => {
 
 // High-level type system API
 
+const ascTypeForProtocol = (protocol, protocolType) =>
+  findConversionFromType(protocol, 'AssemblyScript', protocolType).getIn(['to', 'type'])
+
+// TODO: this can be removed/replaced by the function above
 const ascTypeForEthereum = ethereumType =>
-  findConversionFromType('ethereum', 'AssemblyScript', ethereumType).getIn(['to', 'type'])
+  ascTypeForProtocol('ethereum', ethereumType)
 
 const ethereumTypeForAsc = ascType =>
   findConversionFromType('AssemblyScript', 'ethereum', ascType).getIn(['to', 'type'])
@@ -120,6 +124,9 @@ const initializedValueFromAsc = ascType =>
   findInitializationForType('AssemblyScript', 'Value', ascType)
 
 module.exports = {
+  // protocol <-> AssemblyScript
+  ascTypeForProtocol,
+
   // ethereum <-> AssemblyScript
   ascTypeForEthereum,
   ethereumTypeForAsc,

package/src/codegen/typescript.js

@@ -12,17 +12,6 @@ class Param {
   }
 }
 
-class ReturnType {
-  constructor(name, type) {
-    this.name = name
-    this.type = type
-  }
-
-  toString() {
-    return `${this.type.toString()}`
-  }
-}
-
 class Method {
   constructor(name, params, returnType, body) {
     this.name = name
@@ -185,8 +174,15 @@ const GENERATED_FILE_NOTE = `
 
 module.exports = {
   // Types
+  Param,
+  Method,
+  StaticMethod,
+  Class,
+  ClassMember,
+  NamedType,
   NullableType,
   ArrayType,
+  ModuleImports,
 
   // Code generators
   namedType,

package/src/command-helpers/scaffold.js

@@ -0,0 +1,66 @@
+const fs = require('fs-extra')
+const path = require('path')
+
+const { step } = require('./spinner')
+const Scaffold = require('../scaffold')
+
+const generateScaffold = async (
+  {
+    protocolInstance,
+    abi,
+    contract,
+    network,
+    subgraphName,
+    indexEvents,
+    contractName = 'Contract',
+    node,
+  },
+  spinner,
+) => {
+  step(spinner, 'Generate subgraph')
+
+  const scaffold = new Scaffold({
+    protocol: protocolInstance,
+    abi,
+    indexEvents,
+    contract,
+    network,
+    contractName,
+    subgraphName,
+    node,
+  })
+
+  return scaffold.generate()
+}
+
+const writeScaffoldDirectory = async (scaffold, directory, spinner) => {
+  // Create directory itself
+  await fs.mkdirs(directory)
+
+  let promises = Object.keys(scaffold).map(async basename => {
+    let content = scaffold[basename]
+    let filename = path.join(directory, basename)
+
+    // Write file or recurse into subdirectory
+    if (typeof content === 'string') {
+      await fs.writeFile(filename, content, { encoding: 'utf-8' })
+    } else if (content == null) {
+      return // continue loop
+    } else {
+      writeScaffoldDirectory(content, path.join(directory, basename), spinner)
+    }
+  })
+
+  await Promise.all(promises)
+}
+
+const writeScaffold = async (scaffold, directory, spinner) => {
+  step(spinner, `Write subgraph to directory`)
+  await writeScaffoldDirectory(scaffold, directory, spinner)
+}
+
+module.exports = {
+  ...module.exports,
+  generateScaffold,
+  writeScaffold,
+}

package/src/command-helpers/version.js

@@ -57,7 +57,7 @@ const assertGraphTsVersion = async (sourceDir, minimumGraphTsVersion) => {
   if (graphTsVersion && semver.lt(semver.coerce(graphTsVersion), minimumGraphTsVersion)) {
     throw new Error(
       `To use this version of the graph-cli you must upgrade the graph-ts dependency to a version greater than or equal to ${minimumGraphTsVersion}
-Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://gist.github.com/otaviopace/8406cb39644d2e7678570d1e7f50dac4`
+Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://thegraph.com/docs/developer/assemblyscript-migration-guide`
     )
   }
 }

package/src/command-helpers/version.test.js

@@ -197,7 +197,7 @@ describe('Version Command Helpers', () => {
         .rejects
         .toThrow(new Error(
           `To use this version of the graph-cli you must upgrade the graph-ts dependency to a version greater than or equal to ${minimumGraphTsVersion}
-Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://gist.github.com/otaviopace/8406cb39644d2e7678570d1e7f50dac4`
+Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://thegraph.com/docs/developer/assemblyscript-migration-guide`
         ))
     })
     test('When the installed graph-ts version is a supported one', async () => {