@sentio/sdk 2.36.1 → 2.37.0-rc.2

package/src/store/codegen.ts

@@ -0,0 +1,213 @@
+import {
+  DirectiveNode,
+  GraphQLEnumType,
+  GraphQLField,
+  GraphQLInterfaceType,
+  GraphQLList,
+  GraphQLNonNull,
+  GraphQLObjectType,
+  GraphQLOutputType,
+  GraphQLScalarType,
+  GraphQLSchema,
+  Kind,
+  isObjectType,
+  isInterfaceType,
+  isListType
+} from 'graphql'
+import * as fs from 'node:fs'
+import path from 'path'
+import mkdirp from 'mkdirp'
+import { schemaFromFile } from './schema.js'
+import chalk from 'chalk'
+
+export async function codegen(srcDir: string, outputDir: string) {
+  for (const file of fs.readdirSync(srcDir)) {
+    const f = path.join(srcDir, file)
+    const filePath = path.parse(f)
+    if (filePath.ext == '.graphql') {
+      const { schema, source } = schemaFromFile(f)
+      const target = path.join(outputDir, filePath.name + '.ts')
+      await codegenInternal(schema, source, target)
+      console.log(chalk.green(`Generated ${target}`))
+    }
+  }
+}
+
+async function codegenInternal(schema: GraphQLSchema, source: string, target: string) {
+  const results: string[] = [
+    '/* Autogenerated file. Do not edit manually. */\n',
+    '/* tslint:disable */',
+    '/* eslint-disable */',
+    "import {entity, derivedFrom, BigDecimal, DateTime, Json, Bytes, ID, Entity, Store} from '@sentio/sdk/store'",
+    `import { DatabaseSchema } from "@sentio/sdk"`
+  ]
+
+  for (const t of Object.values(schema.getTypeMap())) {
+    if (t.name.startsWith('__')) {
+      continue
+    }
+
+    if (t instanceof GraphQLObjectType) {
+      const entityContent = genEntity(t)
+      results.push(entityContent)
+    }
+    if (t instanceof GraphQLEnumType) {
+      results.push(genEnum(t))
+    }
+    if (t instanceof GraphQLInterfaceType) {
+      results.push(genInterface(t))
+    }
+  }
+
+  const contents =
+    results.join('\n') +
+    `\n
+const source = \`${source.replaceAll('`', '`')}\`
+DatabaseSchema.register(source)
+`
+  await mkdirp(path.dirname(target))
+
+  fs.writeFileSync(target, contents)
+}
+
+const JsTypes: Record<string, string> = {
+  ID: 'string',
+  String: 'string',
+  Int: 'number',
+  Float: 'number',
+  Boolean: 'boolean',
+  BigInt: 'bigint',
+  BigDecimal: 'BigDecimal',
+  DateTime: 'Date',
+  Json: 'any',
+  Bytes: 'Uint8Array'
+}
+const graphqlTypes = Object.entries(JsTypes).reduce(
+  (acc, [k, v]) => {
+    acc[v] = k
+    return acc
+  },
+  {} as Record<string, string>
+)
+
+function genType(type: GraphQLOutputType): string {
+  if (type instanceof GraphQLNonNull) {
+    return genType(type.ofType)
+  } else if (type instanceof GraphQLScalarType) {
+    return type.name
+  } else if (type instanceof GraphQLObjectType || type instanceof GraphQLInterfaceType) {
+    return type.name
+  } else if (type instanceof GraphQLList) {
+    return `Array<${genType(type.ofType)}>`
+  } else if (type instanceof GraphQLEnumType) {
+    return type.name
+  } else {
+    throw new Error('Unsupported type: ' + type)
+  }
+}
+
+function isObject(type: GraphQLOutputType) {
+  if (type instanceof GraphQLNonNull) {
+    return isObject(type.ofType)
+  } else if (type instanceof GraphQLList) {
+    return isObject(type.ofType)
+  }
+  return isObjectType(type) || isInterfaceType(type)
+}
+
+function isList(type: GraphQLOutputType) {
+  if (type instanceof GraphQLNonNull) {
+    return isListType(type.ofType)
+  } else {
+    return isListType(type)
+  }
+}
+
+function getElementType(type: GraphQLOutputType) {
+  if (type instanceof GraphQLNonNull) {
+    return getElementType(type.ofType)
+  } else if (type instanceof GraphQLList) {
+    return type.ofType
+  }
+  return type
+}
+
+function genField(field: GraphQLField<any, any>) {
+  const isNonNull = field.type instanceof GraphQLNonNull
+  const directives = field.astNode?.directives?.map((d) => '\t' + directive2decorator(d) + '\n') || []
+
+  const type = genType(field.type)
+  const returnType = isNonNull ? type : `${type} | undefined`
+
+  if (isObject(field.type)) {
+    const t = getElementType(field.type)
+    const typeAsArg = isInterfaceType(t) ? `"${t}"` : genType(t)
+
+    if (isList(field.type)) {
+      return `${directives.join()}\tget ${field.name}(): Promise<${genType(t)}[]> { return this.getFieldObjectArray(${typeAsArg}, "${field.name}") as Promise<${genType(t)}[]> }
+  set ${field.name}(value: Array<${type}> | ID[]) { this.set("${field.name}", value) }
+  get ${field.name}Ids(): ID[] { return this.get("${field.name}") }`
+    }
+
+    return `${directives.join()}\tget ${field.name}(): Promise<${genType(t)} | undefined> { return this.getFieldObject(${typeAsArg},"${field.name}") as Promise<${genType(t)} | undefined> }
+  set ${field.name}(value: ${type} | ID) { this.set("${field.name}", value) }
+  get ${field.name}Id(): ID | undefined { return this.get("${field.name}") }`
+  }
+
+  return `${directives.join()}\tget ${field.name}(): ${returnType} { return this.get("${field.name}") }
+  set ${field.name}(value: ${type}) { this.set("${field.name}", value) }`
+}
+
+function genEntity(t: GraphQLObjectType<any, any>) {
+  const decorators = t.astNode?.directives?.map(directive2decorator) || []
+
+  let impls = ''
+  if (t.getInterfaces().length > 0) {
+    impls +=
+      ' implements ' +
+      t
+        .getInterfaces()
+        .map((i) => i.name)
+        .join(', ')
+  }
+
+  return `
+${decorators.join('\n')}
+export class ${t.name} extends Entity${impls} {
+  constructor(data: Partial<${t.name}>) {
+    super(data)
+  }
+${Object.values(t.getFields()).map(genField).join('\n')}
+}`
+}
+
+function genInterface(t: GraphQLInterfaceType) {
+  return `
+export interface ${t.name} {
+${Object.values(t.getFields())
+  .map((f) => `\t${f.name}: ${genType(f.type)}`)
+  .join('\n')}
+}`
+}
+
+export function directive2decorator(directive: DirectiveNode) {
+  let s = `@${directive.name.value}`
+  if (directive.arguments?.length) {
+    s += `(${directive.arguments
+      ?.map((arg) => {
+        return arg.value.kind === Kind.STRING ? `"${arg.value.value}"` : `${arg.value}`
+      })
+      .join(', ')})`
+  }
+  return s
+}
+
+function genEnum(t: GraphQLEnumType) {
+  return `
+export enum ${t.name} {
+${t
+  .getValues()
+  .map((v) => `\t${v.name}`)
+  .join(', ')}
+}`
+}

package/src/store/context.ts

@@ -0,0 +1 @@
+export { StoreContext } from '@sentio/runtime'

package/src/store/decorators.ts

@@ -0,0 +1,9 @@
+type Constructor = { new (...args: any[]): any }
+
+export function entity<T extends Constructor>(constructor: T, context: any) {
+  return constructor
+}
+
+export function derivedFrom(field: string) {
+  return function (target: any, context: any) {}
+}

package/src/store/entity.ts

@@ -0,0 +1,61 @@
+import { Store } from './store.js'
+import { ID } from './types.js'
+
+export interface EntityClass<T extends Entity> {
+  new (data: any): T
+}
+
+export abstract class Entity {
+  get id(): ID {
+    return this.get('id')
+  }
+
+  private _store: Store | undefined
+  data: Record<string, any> = {}
+  protected constructor(data: Record<string, any>) {
+    Object.entries(data).forEach(([key, value]) => {
+      if (Array.isArray(value)) {
+        this.data[key] = value.map((v) => this.getIdFromEntity(v))
+      } else {
+        this.data[key] = this.getIdFromEntity(value)
+      }
+    })
+  }
+
+  private getIdFromEntity(entity: any): any {
+    if (entity instanceof Entity) {
+      return entity.id
+    } else if (typeof entity === 'object' && entity.id) {
+      return entity.id
+    }
+    return entity
+  }
+
+  set store(store: Store) {
+    this._store = store
+  }
+
+  get<T>(field: string): T {
+    return this.data[field]
+  }
+
+  set<T>(field: string, value: T | T[] | ID | ID[]): void {
+    if (Array.isArray(value) && value instanceof Entity) {
+      this.data[field] = value.map((v) => (v as Entity).id)
+    } else if (value instanceof Entity) {
+      this.data[field] = (value as Entity).id
+    }
+    this.data[field] = value
+  }
+
+  protected getFieldObject<T extends Entity>(entity: EntityClass<T> | string, field: string): Promise<T | undefined> {
+    const id = this.data[field]
+    return id ? (this._store?.get(entity, id) as Promise<T>) : Promise.resolve(undefined)
+  }
+
+  protected getFieldObjectArray<T extends Entity>(entity: EntityClass<T>, field: string): Promise<T[]> {
+    const ids = this.data[field]
+    const promises = ids.map((id: string) => this._store?.get(entity, id))
+    return Promise.all(promises) as Promise<T[]>
+  }
+}

package/src/store/index.ts

@@ -0,0 +1,5 @@
+export * from './decorators.js'
+export * from './types.js'
+export * from './entity.js'
+export * from './store.js'
+export * from './context.js'

package/src/store/run.ts

@@ -0,0 +1,10 @@
+import { codegen } from './codegen.js'
+
+if (process.argv.length > 3) {
+  const srcFile = process.argv[2]
+  const targetDir = process.argv[3]
+  await codegen(srcFile, targetDir)
+} else {
+  console.error('Not enough argument')
+  process.exit(1)
+}

package/src/store/schema.ts

@@ -0,0 +1,35 @@
+import { buildASTSchema, DocumentNode, extendSchema, GraphQLSchema, parse, validateSchema } from 'graphql/index.js'
+import * as fs from 'node:fs'
+
+const customScalars = ['BigInt', 'BigDecimal', 'DateTime', 'JSON', 'Bytes', 'ID']
+
+const baseSchema = buildASTSchema(
+  parse(`
+    directive @entity on OBJECT
+    directive @query on INTERFACE
+    directive @derivedFrom(field: String!) on FIELD_DEFINITION
+    directive @unique on FIELD_DEFINITION
+    directive @index(fields: [String!] unique: Boolean) repeatable on OBJECT | FIELD_DEFINITION
+    directive @fulltext(query: String!) on FIELD_DEFINITION
+    directive @cardinality(value: Int!) on OBJECT | FIELD_DEFINITION
+    directive @byteWeight(value: Float!) on FIELD_DEFINITION
+    directive @variant on OBJECT # legacy
+    directive @jsonField on OBJECT # legacy
+    ${customScalars.map((name) => 'scalar ' + name).join('\n')}
+`)
+)
+
+export function buildSchema(doc: DocumentNode): GraphQLSchema {
+  const schema = extendSchema(baseSchema, doc)
+  const errors = validateSchema(schema).filter((err) => !/query root/i.test(err.message))
+  if (errors.length > 0) {
+    throw errors[0]
+  }
+  return schema
+}
+
+export function schemaFromFile(filePath: string) {
+  const source = fs.readFileSync(filePath, 'utf-8')
+  const doc = parse(source)
+  return { schema: buildSchema(doc), source }
+}

package/src/store/store.ts

@@ -0,0 +1,68 @@
+import { Entity, EntityClass } from './entity.js'
+import { StoreContext } from './context.js'
+
+export class Store {
+  constructor(private readonly context: StoreContext) {}
+
+  async get<T extends Entity>(entity: EntityClass<T> | string, id: string): Promise<T | undefined> {
+    const promise = this.context.sendRequest({
+      get: {
+        entity: typeof entity == 'string' ? entity : entity.name,
+        id
+      }
+    })
+
+    const data = (await promise) as any
+    if (data?.['id'] != null) {
+      return this.newEntity(entity as EntityClass<T>, data)
+    }
+    return undefined
+  }
+
+  async delete(entity: EntityClass<any>, id: string | string[]): Promise<void> {
+    await this.context.sendRequest({
+      delete: {
+        entity: entity.name,
+        id: Array.isArray(id) ? id : [id]
+      }
+    })
+  }
+
+  async upsert<T extends Entity>(entity: T | T[]): Promise<T> {
+    const promise = this.context.sendRequest({
+      upsert: {
+        entity: entity.constructor.name,
+        data: Array.isArray(entity) ? entity.map((e) => e.data) : [entity.data]
+      }
+    })
+
+    if (Array.isArray(entity)) {
+      entity.forEach((e) => (e.store = this))
+    } else {
+      entity.store = this
+    }
+
+    return promise as Promise<T>
+  }
+
+  async list<T extends Entity>(entity: EntityClass<T>, limit?: number, offset?: number): Promise<T[]> {
+    const promise = this.context.sendRequest({
+      list: {
+        entity: entity.name,
+        limit,
+        offset
+      }
+    })
+
+    const list = (await promise) as any[]
+    return list.map((data) => {
+      return this.newEntity(entity, data)
+    })
+  }
+
+  private newEntity<T extends Entity>(entity: EntityClass<T>, data: any) {
+    const e = new (entity as EntityClass<T>)(data)
+    e.store = this
+    return e
+  }
+}

package/src/store/types.ts

@@ -0,0 +1,10 @@
+export type { BigDecimal } from '@sentio/bigdecimal'
+
+export type ID = string
+export type String = string
+export type Int = number
+export type Float = number
+export type Boolean = boolean
+export type DateTime = Date
+export type Json = any
+export type Bytes = Uint8Array

package/src/testing/test-processor-server.ts

@@ -2,12 +2,16 @@ import {
   AccountConfig,
   ContractConfig,
   DataBinding,
+  DeepPartial,
   Empty,
   ProcessBindingResponse,
   ProcessBindingsRequest,
   ProcessConfigRequest,
   ProcessConfigResponse,
   ProcessorServiceImplementation,
+  ProcessStreamRequest,
+  ProcessStreamResponse,
+  ServerStreamingMethodResult,
   StartRequest
 } from '@sentio/protos'
 import { CallContext } from 'nice-grpc-common'
@@ -80,7 +84,14 @@ export class TestProcessorServer implements ProcessorServiceImplementation {
     return this.service.processBindings({ bindings: [request] }, context)
   }
 
-  processBindingsStream(request: AsyncIterable<DataBinding>, context: CallContext) {
-    return this.service.processBindingsStream(request, context)
+  processBindingsStream(
+    requests: AsyncIterable<ProcessStreamRequest>,
+    context: CallContext
+  ): ServerStreamingMethodResult<DeepPartial<ProcessStreamResponse>> {
+    throw new Error('Method not implemented.')
   }
+
+  // processBindingsStream(request: AsyncIterable<ProcessStreamRequest>, context: CallContext) {
+  //   return this.service.processBindingsStream(request, context)
+  // }
 }