@sentio/sdk 2.59.0-rc.2 → 2.59.0-rc.20

package/src/store/codegen.ts

@@ -48,6 +48,8 @@ interface Class {
   annotations: string[]
   parent?: string
   interfaces: string[]
+  timeseries?: boolean
+  immutable?: boolean
 }
 
 interface Interface {
@@ -111,7 +113,7 @@ async function codegenInternal(schema: GraphQLSchema, source: string, target: st
     },
     {
       module: '@sentio/sdk/store',
-      types: ['Entity', 'Required', 'One', 'Many', 'Column', 'ListColumn', 'AbstractEntity']
+      types: ['Entity', 'Required', 'One', 'Many', 'Column', 'ListColumn', 'AbstractEntity', 'getStore', 'UpdateValues']
     },
     {
       module: '@sentio/bigdecimal',
@@ -154,6 +156,18 @@ async function codegenInternal(schema: GraphQLSchema, source: string, target: st
     }
 
     if (t instanceof GraphQLObjectType) {
+      if (isTimeseries(t)) {
+        // check id is int8
+        const idField = t.getFields()['id']
+        if (!idField || !isNonNullType(idField.type) || idField.type.toString() !== 'Int8!') {
+          throw new Error(`Timeseries entity ${t.name} must have an id field of type Int8!`)
+        }
+        // check if it has a timestamp field
+        const timestampField = t.getFields()['timestamp']
+        if (!timestampField || !isNonNullType(timestampField.type) || timestampField.type.toString() !== 'Timestamp!') {
+          throw new Error(`Timeseries entity ${t.name} must have a timestamp field of type Timestamp!`)
+        }
+      }
       if (isEntity(t)) {
         const fields: Field[] = []
         const methods: Method[] = []
@@ -177,7 +191,7 @@ async function codegenInternal(schema: GraphQLSchema, source: string, target: st
                 methods.push({
                   name: f.name,
                   returnType: `Promise<${type}>`,
-                  body: `return this.store.get(${elemType(f.type)}, [{field: '${derivedField}', op: '=', value: this.id}])?.[0]`,
+                  body: `return this.store.list(${elemType(f.type)}, [{field: '${derivedField}', op: '=', value: this.id}]).then((r) => r?.[0])`,
                   annotations: []
                 })
               }
@@ -228,6 +242,8 @@ async function codegenInternal(schema: GraphQLSchema, source: string, target: st
         }
         classes.push({
           name: t.name,
+          timeseries: isTimeseries(t),
+          immutable: isImmutable(t),
           fields,
           methods,
           annotations: [`@Entity("${t.name}")`],
@@ -282,6 +298,12 @@ interface ${c.name}ConstructorInput {
 ${c.fields
   .filter((f) => !f.type.startsWith('Promise<')) // Filter out Promise fields
   .map((f) => {
+    if (c.timeseries && f.name == 'timestamp') {
+      return `  timestamp?: Timestamp;`
+    }
+    if (c.timeseries && f.name == 'id') {
+      return `  id?: Int8;`
+    }
     const isRequired = f.annotations.some((a) => a.includes('@Required'))
     return `  ${f.private ? 'private ' : ''}${f.name}${isRequired ? '' : '?'}: ${f.type.replace(' | undefined', '')};`
   })
@@ -297,6 +319,14 @@ ${c.fields
   .join('\n')}
   ${isEntity ? `constructor(data: ${c.name}ConstructorInput) {super()}` : ''}
   ${(c.methods ?? []).map(genMethod).join('\n')}
+  
+  ${
+    isEntity && !c.immutable
+      ? `static update(values: UpdateValues<${c.name}ConstructorInput>): Promise<void> {
+    return getStore().update(${c.name}, values)
+  }`
+      : ``
+  }
 }`
   })
   .join('\n')}
@@ -367,6 +397,24 @@ function isEntity(t: GraphQLObjectType) {
   return t.astNode?.directives?.some((d) => d.name.value == 'entity')
 }
 
+function isTimeseries(t: GraphQLObjectType) {
+  return t.astNode?.directives?.some(
+    (d) =>
+      d.name.value == 'entity' &&
+      d.arguments?.some((a) => a.name.value == 'timeseries' && a.value.kind == 'BooleanValue' && a.value.value == true)
+  )
+}
+
+function isImmutable(t: GraphQLObjectType) {
+  return (
+    t.astNode?.directives?.some(
+      (d) =>
+        d.name.value == 'entity' &&
+        d.arguments?.some((a) => a.name.value == 'immutable' && a.value.kind == 'BooleanValue' && a.value.value == true)
+    ) || isTimeseries(t)
+  )
+}
+
 function isDerived(f: GraphQLField<any, any>) {
   return f.astNode?.directives?.some((d) => d.name.value == 'derivedFrom')
 }

package/src/store/schema.ts

@@ -6,7 +6,7 @@ const customScalars = ['BigInt', 'BigDecimal', 'Timestamp', 'JSON', 'Bytes', 'ID
 
 const baseSchema = buildASTSchema(
   parse(`
-    directive @entity(immutable: Boolean! = false, sparse: Boolean! = false) on OBJECT
+    directive @entity(immutable: Boolean! = false, sparse: Boolean! = false, timeseries: Boolean! = false) on OBJECT
     directive @query on INTERFACE
     directive @derivedFrom(field: String!) on FIELD_DEFINITION
     directive @unique on FIELD_DEFINITION
@@ -16,6 +16,8 @@ const baseSchema = buildASTSchema(
     directive @byteWeight(value: Float!) on FIELD_DEFINITION
     directive @variant on OBJECT # legacy
     directive @jsonField on OBJECT # legacy
+    directive @aggregation(intervals: [String!]! = ["hour"], source: String!) on OBJECT
+    directive @aggregate(fn: String!, arg: String, cumulative: Boolean = false) on FIELD_DEFINITION
     ${customScalars.map((name) => 'scalar ' + name).join('\n')}
 `)
 )

package/src/store/store.ts

@@ -1,7 +1,24 @@
 import { DatabaseSchema } from '../core/index.js'
 import { BigDecimal } from '@sentio/bigdecimal'
-import { AbstractEntity, AbstractEntity as Entity, Bytes, Float, ID, Int, Timestamp } from './types.js'
-import type { DBRequest, Entity as EntityStruct, RichValue } from '@sentio/protos'
+import {
+  AbstractEntity,
+  AbstractEntity as Entity,
+  Bytes,
+  Float,
+  ID,
+  Int,
+  Timestamp,
+  AddOp,
+  MultiplyOp,
+  UpdateValues
+} from './types.js'
+import {
+  DBRequest,
+  DBRequest_DBUpdate,
+  Entity as EntityStruct,
+  EntityUpdateData_Operator,
+  RichValue
+} from '@sentio/protos'
 import { DBRequest_DBOperator, DBResponse } from '@sentio/protos'
 import { IStoreContext, PluginManager } from '@sentio/runtime'
 import { Cursor } from './cursor.js'
@@ -102,6 +119,42 @@ export class Store {
     })
   }
 
+  async update<T extends Entity>(entity: EntityClass<T>, values: UpdateValues<any>): Promise<void> {
+    if (values.id) {
+      const update: DBRequest_DBUpdate = {
+        entity: [getEntityName(entity)],
+        id: [values.id.toString()],
+        entityData: [{ fields: {} }]
+      }
+      for (const [key, value] of Object.entries(values)) {
+        if (key !== 'id') {
+          const field = getEntityField(entity, key)
+          if (value instanceof AddOp) {
+            update.entityData[0].fields[field] = {
+              op: EntityUpdateData_Operator.ADD,
+              value: serializeRichValue(value.value)
+            }
+          } else if (value instanceof MultiplyOp) {
+            update.entityData[0].fields[field] = {
+              op: EntityUpdateData_Operator.MULTIPLY,
+              value: serializeRichValue(value.value)
+            }
+          } else if (value !== undefined) {
+            update.entityData[0].fields[field] = {
+              op: EntityUpdateData_Operator.SET,
+              value: serializeRichValue(value)
+            }
+          }
+        }
+      }
+      await this.context.sendRequest({
+        update
+      })
+    } else {
+      throw new Error('Update must have id field')
+    }
+  }
+
   async upsert<T extends Entity>(entity: T | T[]): Promise<void> {
     const entities = Array.isArray(entity) ? entity : [entity]
     const request = {
@@ -250,7 +303,7 @@ export type Operators<T> =
         : T extends Bytes
           ? '=' | '!=' | 'in' | 'not in'
           : T extends ID
-            ? '=' | '!=' | 'like' | 'not like' | 'in' | 'not in'
+            ? '=' | '!=' | 'like' | 'not like' | 'in' | 'not in' | '<' | '<=' | '>' | '>='
             : T extends string
               ? '=' | '!=' | 'like' | 'not like' | 'in' | 'not in'
               : T extends Timestamp
@@ -321,5 +374,5 @@ export function getStore() {
   if (dbContext) {
     return new Store(dbContext)
   }
-  return undefined
+  throw new Error('Store not found in context, please ensure you are calling this in a handler function')
 }

package/src/store/types.ts

@@ -2,8 +2,9 @@ import { RichStruct, RichValue } from '@sentio/protos'
 import { BigDecimalConverter, BigIntConverter } from './convert.js'
 import { getEntityName, Store } from './store.js'
 import { PluginManager } from '@sentio/runtime'
+import { BigDecimal } from '@sentio/bigdecimal'
 
-export type ID = string | Uint8Array
+export type ID = string | Uint8Array | Int8
 export type String = string
 export type Int = number
 export type Int8 = bigint
@@ -13,6 +14,34 @@ export type Timestamp = Date
 export type Bytes = Uint8Array
 export type BigInt = bigint
 
+export type ValueType = String | Int | Int8 | Float | Boolean | Timestamp | Bytes | BigInt | BigDecimal | null
+
+export abstract class UpdateOp<T> {}
+
+export class AddOp<T> extends UpdateOp<T> {
+  constructor(readonly value: T) {
+    super()
+  }
+}
+
+export class MultiplyOp<T> extends UpdateOp<T> {
+  constructor(readonly value: T) {
+    super()
+  }
+}
+
+export type UpdateValues<T> = {
+  [K in keyof T]?: T[K] | UpdateOp<T[K]>
+} & { id: ID }
+
+export function add<K extends ValueType>(value: K): UpdateOp<K> {
+  return new AddOp<K>(value)
+}
+
+export function multiply<K extends ValueType>(value: K): UpdateOp<K> {
+  return new MultiplyOp<K>(value)
+}
+
 export abstract class AbstractEntity {
   abstract id: ID
   private readonly _data: RichStruct

package/src/sui/abis/0x1.json

@@ -690,6 +690,14 @@
       }
     }
   },
+  "bool": {
+    "fileFormatVersion": 6,
+    "address": "0x1",
+    "name": "bool",
+    "friends": [],
+    "structs": {},
+    "exposedFunctions": {}
+  },
   "debug": {
     "fileFormatVersion": 6,
     "address": "0x1",