@sentio/sdk 1.23.1 → 1.25.0

package/src/aptos/types.ts

@@ -4,6 +4,7 @@ import {
   MoveModule,
   MoveStruct,
   TransactionPayload_EntryFunctionPayload,
+  MoveResource,
 } from 'aptos-sdk/src/generated'
 import { moduleQname, SPLITTER, VECTOR_STR } from './utils'
 import { parseMoveType } from '../aptos-codegen/typegen'
@@ -26,6 +27,21 @@ export type TypedEntryFunctionPayload<T extends Array<any>> = TransactionPayload
   arguments_typed: T
 }
 
+export type TypedMoveResource<T> = MoveResource & {
+  data_typed: T
+  type_arguments: string[]
+}
+
+interface StructWithTag {
+  type: string
+  data: any
+}
+
+interface StructWithType<T> extends StructWithTag {
+  data_typed: T
+  type_arguments: string[]
+}
+
 export class TypeDescriptor {
   // type: string
 
@@ -206,7 +222,73 @@ export class TypeRegistry {
     return typedData
   }
 
-  // private decodeInternal(data: any, type: TypeDescriptor, typeArgs: )
+  decodeEvent<T>(event: Event): TypedEventInstance<T> | undefined {
+    return this.decodedInternal<T>(event) as TypedEventInstance<T>
+  }
+  filterAndDecodeEvents<T>(typePrefix: string, resources: Event[]): TypedEventInstance<T>[] {
+    return this.filterAndDecodeInternal(typePrefix, resources) as TypedEventInstance<T>[]
+  }
+  decodeResource<T>(res: MoveResource): TypedMoveResource<T> | undefined {
+    return this.decodedInternal<T>(res)
+  }
+  filterAndDecodeResources<T>(typePrefix: string, resources: MoveResource[]): TypedMoveResource<T>[] {
+    return this.filterAndDecodeInternal(typePrefix, resources)
+  }
+
+  private filterAndDecodeInternal<T>(typePrefix: string, structs: StructWithTag[]): StructWithType<T>[] {
+    if (!structs) {
+      return []
+    }
+    const results: StructWithType<T>[] = []
+    for (const resource of structs) {
+      if (!resource.type.startsWith(typePrefix)) {
+        continue
+      }
+      const result = this.decodedInternal(resource)
+      if (result) {
+        results.push(result as StructWithType<T>)
+      }
+    }
+    return results
+  }
+
+  private decodedInternal<T>(typeStruct: StructWithTag): StructWithType<T> | undefined {
+    const registry = TYPE_REGISTRY
+    // this.loadTypes(registry)
+    // TODO check if module is not loaded
+
+    const typeDescriptor = parseMoveType(typeStruct.type)
+    const typeArguments = typeDescriptor.typeArgs.map((t) => t.getSignature())
+
+    let dataTyped = undefined
+    try {
+      dataTyped = registry.decode(typeStruct.data, typeDescriptor)
+    } catch (e) {
+      console.error('Decoding error for ', JSON.stringify(typeStruct))
+      return undefined
+    }
+    return { ...typeStruct, data_typed: dataTyped, type_arguments: typeArguments } as StructWithType<T>
+  }
+
+  decodeFunctionPayload(payload: TransactionPayload_EntryFunctionPayload): TransactionPayload_EntryFunctionPayload {
+    const registry = TYPE_REGISTRY
+    // this.loadTypes(registry)
+    const argumentsTyped: any[] = []
+
+    try {
+      const func = registry.getMoveFunction(payload.function)
+      for (const [idx, arg] of payload.arguments.entries()) {
+        // TODO consider apply payload.type_arguments, but this might be hard since we don't code gen for them
+        const argType = parseMoveType(func.params[idx + 1])
+        argumentsTyped.push(registry.decode(arg, argType))
+      }
+    } catch (e) {
+      console.error('Decoding error for ', JSON.stringify(payload))
+      return payload
+    }
+
+    return { ...payload, arguments_typed: argumentsTyped } as TypedEntryFunctionPayload<any>
+  }
 }
 
-export const GLOBAL_TYPE_REGISTRY = new TypeRegistry()
+export const TYPE_REGISTRY = new TypeRegistry()

package/src/aptos-codegen/codegen.ts

@@ -5,8 +5,7 @@ import { MoveFunction, MoveModule, MoveModuleBytecode, MoveStruct } from 'aptos-
 import { AccountModulesImportInfo, AccountRegister, generateType } from './typegen'
 import { isFrameworkAccount } from '../aptos/utils'
 import chalk from 'chalk'
-import { AptosNetwork, getChainName, getChainRpcEndpoint } from '../aptos/network'
-import { AptosClient } from 'aptos-sdk'
+import { AptosNetwork, getChainName, getRpcClient } from '../aptos/network'
 
 export async function generate(srcDir: string, outputDir: string) {
   await generateForNetwork(srcDir, outputDir, AptosNetwork.MAIN_NET)
@@ -32,7 +31,7 @@ export async function generateForNetwork(srcDir: string, outputDir: string, netw
   loader.accountImports.set('0x1', new AccountModulesImportInfo('0x1', '0x1'))
   loader.accountImports.set('0x2', new AccountModulesImportInfo('0x2', '0x2'))
   loader.accountImports.set('0x3', new AccountModulesImportInfo('0x3', '0x3'))
-  const client = new AptosClient(getChainRpcEndpoint(network))
+  const client = getRpcClient(network)
 
   for (const file of files) {
     if (!file.endsWith('.json')) {

package/src/cli/cli.ts

@@ -35,7 +35,7 @@ if (mainOptions.command === 'login') {
   // TODO move them to their own modules
 
   // Process configs
-  let processorConfig: SentioProjectConfig = { host: '', project: '', source: '', build: true }
+  let processorConfig: SentioProjectConfig = { host: '', project: '', build: true }
   // Fist step, read from project yaml file
   try {
     console.log(chalk.blue('Loading Process config'))
@@ -65,9 +65,9 @@ if (mainOptions.command === 'login') {
       processorConfig.host = 'prod'
     }
 
-    if (!processorConfig.source) {
-      processorConfig.source = 'src/processor.ts'
-    }
+    // if (!processorConfig.source) {
+    //   processorConfig.source = 'src/processor.ts'
+    // }
     // if (!processorConfig.targets) {
     //   console.warn('targets is not defined, use EVM as the default target')
     //   processorConfig.targets = []
@@ -158,7 +158,7 @@ function usage() {
     {
       header: 'Usage',
       content: [
-        'sentio $command --help\t\tshow detail usage of specific command',
+        'sentio <command> --help\t\tshow detail usage of specific command',
         'sentio login --api-key=xx\t\tsave credential to local',
         'sentio create\t\t\t\tcreate a template project',
         'sentio upload\t\t\t\tbuild and upload processor to sentio',

package/src/cli/commands/run-create.ts

@@ -26,23 +26,45 @@ export function runCreate(argv: string[]) {
       description: '(Optional) The root direct new project will be created, default current working dir',
       type: String,
     },
+    {
+      name: 'chain-type',
+      alias: 'c',
+      description:
+        'The type of project you want to create, can be evm, aptos, raw (if you want to start from scratch and support multiple types of chains)',
+      type: String,
+      defaultValue: 'evm',
+    },
   ]
 
   const options = commandLineArgs(optionDefinitions, { argv })
+  const usage = commandLineUsage([
+    {
+      header: 'Create a template project',
+      content: 'sentio create <name>',
+    },
+    {
+      header: 'Options',
+      optionList: optionDefinitions,
+    },
+  ])
+
   if (options.help || !options.name) {
-    const usage = commandLineUsage([
-      {
-        header: 'Create a template project',
-        content: 'sentio create $NAME',
-      },
-      {
-        header: 'Options',
-        optionList: optionDefinitions,
-      },
-    ])
     console.log(usage)
   } else {
-    const templateFolder = path.resolve(__dirname, '../../../template')
+    const chainType: string = options['chain-type'].toLowerCase()
+    switch (chainType) {
+      case 'evm':
+        break
+      case 'aptos':
+        break
+      case 'raw':
+        break
+      default:
+        console.error(chalk.red('non supported chain-type for template creation, use --help for more information.'))
+        console.log(usage)
+        process.exit(1)
+    }
+    const templateFolder = path.resolve(__dirname, '../../../templates', chainType)
     const projectName = options.name || 'default'
 
     const rootDir = options.directory || process.cwd()

package/src/cli/commands/run-login.ts

@@ -31,7 +31,7 @@ export function runLogin(argv: string[]) {
     const usage = commandLineUsage([
       {
         header: 'Login to Sentio',
-        content: 'sentio login --api-key=$key',
+        content: 'sentio login --api-key=<key>',
       },
       {
         header: 'Options',

package/src/cli/config.ts

@@ -1,7 +1,7 @@
 export interface SentioProjectConfig {
   project: string
   host: string
-  source: string
+  // source: string
   build: boolean
   // targets: Target[]
 }

package/src/core/base-processor.ts

@@ -98,17 +98,9 @@ export abstract class BaseProcessor<
 
           // TODO fix this bug
           await handler(event, ctx)
-          return {
-            gauges: ctx.gauges,
-            counters: ctx.counters,
-            logs: ctx.logs,
-          }
-        }
-        return {
-          gauges: [],
-          counters: [],
-          logs: [],
+          return ctx.getProcessResult()
         }
+        return ProcessResult.fromPartial({})
       },
     })
     return this
@@ -128,11 +120,7 @@ export abstract class BaseProcessor<
         undefined
       )
       await handler(block, ctx)
-      return {
-        gauges: ctx.gauges,
-        counters: ctx.counters,
-        logs: ctx.logs,
-      }
+      return ctx.getProcessResult()
     })
     return this
   }
@@ -163,11 +151,7 @@ export abstract class BaseProcessor<
         const contractInterface = contractView.rawContract.interface
         const fragment = contractInterface.getFunction(signature)
         if (!trace.action.input) {
-          return {
-            gauges: [],
-            counters: [],
-            logs: [],
-          }
+          return ProcessResult.fromPartial({})
         }
         const traceData = '0x' + trace.action.input.slice(10)
         trace.args = contractInterface._abiCoder.decode(fragment.inputs, traceData)
@@ -181,11 +165,7 @@ export abstract class BaseProcessor<
           trace
         )
         await handler(trace, ctx)
-        return {
-          gauges: ctx.gauges,
-          counters: ctx.counters,
-          logs: ctx.logs,
-        }
+        return ctx.getProcessResult()
       },
     })
     return this

package/src/core/context.ts

@@ -1,4 +1,12 @@
-import { CounterResult, GaugeResult, LogResult, DataDescriptor, RecordMetaData } from '../gen'
+import {
+  CounterResult,
+  GaugeResult,
+  LogResult,
+  DataDescriptor,
+  RecordMetaData,
+  EventTrackingResult,
+  ProcessResult,
+} from '../gen'
 import { BaseContract, EventFilter } from 'ethers'
 import { Block, Log } from '@ethersproject/abstract-provider'
 import { Meter, normalizeLabels } from './meter'
@@ -12,6 +20,7 @@ export abstract class BaseContext {
   gauges: GaugeResult[] = []
   counters: CounterResult[] = []
   logs: LogResult[] = []
+  events: EventTrackingResult[] = []
   meter: Meter
   logger: Logger
 
@@ -20,7 +29,17 @@ export abstract class BaseContext {
     this.logger = new Logger(this)
   }
 
-  abstract getMetaData(descriptor: DataDescriptor | undefined, labels: Labels): RecordMetaData
+  getProcessResult(): ProcessResult {
+    const res: ProcessResult = {
+      gauges: this.gauges,
+      counters: this.counters,
+      logs: this.logs,
+      events: this.events,
+    }
+    return res
+  }
+
+  abstract getMetaData(descriptor: DataDescriptor, labels: Labels): RecordMetaData
 }
 
 export abstract class EthContext extends BaseContext {
@@ -72,7 +91,7 @@ export class ContractContext<
     this.contract = view
   }
 
-  getMetaData(descriptor: DataDescriptor | undefined, labels: Labels): RecordMetaData {
+  getMetaData(descriptor: DataDescriptor, labels: Labels): RecordMetaData {
     if (this.log) {
       return {
         address: this.contract.rawContract.address,
@@ -83,6 +102,7 @@ export class ContractContext<
         logIndex: this.log.logIndex,
         chainId: this.chainId.toString(),
         dataDescriptor: descriptor,
+        name: descriptor.name,
         labels: normalizeLabels(labels),
       }
     }
@@ -96,6 +116,7 @@ export class ContractContext<
         logIndex: -1,
         chainId: this.chainId.toString(),
         dataDescriptor: descriptor,
+        name: descriptor.name,
         labels: normalizeLabels(labels),
       }
     }
@@ -109,6 +130,7 @@ export class ContractContext<
         logIndex: -1,
         chainId: this.chainId.toString(),
         dataDescriptor: descriptor,
+        name: descriptor.name,
         labels: normalizeLabels(labels),
       }
     }
@@ -168,7 +190,7 @@ export class SolanaContext extends BaseContext {
     this.blockNumber = slot
   }
 
-  getMetaData(descriptor: DataDescriptor | undefined, labels: Labels): RecordMetaData {
+  getMetaData(descriptor: DataDescriptor, labels: Labels): RecordMetaData {
     return {
       address: this.address,
       contractName: this.programName,
@@ -178,6 +200,7 @@ export class SolanaContext extends BaseContext {
       logIndex: 0,
       chainId: SOL_MAINMET_ID, // TODO set in context
       dataDescriptor: descriptor,
+      name: descriptor.name,
       labels: normalizeLabels(labels),
     }
   }
@@ -194,7 +217,7 @@ export class SuiContext extends BaseContext {
     this.blockNumber = slot
   }
 
-  getMetaData(descriptor: DataDescriptor | undefined, labels: Labels): RecordMetaData {
+  getMetaData(descriptor: DataDescriptor, labels: Labels): RecordMetaData {
     return {
       address: this.address,
       contractName: this.moduleName,
@@ -204,6 +227,7 @@ export class SuiContext extends BaseContext {
       logIndex: 0,
       chainId: SUI_DEVNET_ID, // TODO set in context
       dataDescriptor: descriptor,
+      name: descriptor.name,
       labels: normalizeLabels(labels),
     }
   }

package/src/core/event-tracker.ts

@@ -0,0 +1,66 @@
+import { BaseContext } from './context'
+import { DataDescriptor, EventTrackingResult } from '@sentio/sdk'
+
+export interface Event {
+  // The unique identifier of main identity associate with an event
+  // .e.g user id / toekn address / account address / contract address id
+  //
+  distinctId: string
+  payload?: Record<string, string>
+}
+
+export interface TrackerOptions {
+  totalByDay?: boolean
+  unique?: boolean
+  distinctByDays?: number[]
+}
+
+// Track Event with an identity associate with it
+export class EventTracker {
+  static DEFAULT_OPTIONS: TrackerOptions = {
+    totalByDay: true,
+    unique: true,
+  }
+
+  static register(eventName: string, options?: TrackerOptions) {
+    const tracker = new EventTracker(eventName, { ...EventTracker.DEFAULT_OPTIONS, ...options })
+    global.PROCESSOR_STATE.eventTrackers.push(tracker)
+    return tracker
+  }
+
+  eventName: string
+  options: TrackerOptions
+  protected constructor(eventName: string, options: TrackerOptions) {
+    this.eventName = eventName
+    this.options = options
+  }
+
+  trackEvent(ctx: BaseContext, event: Event) {
+    const res: EventTrackingResult = {
+      metadata: ctx.getMetaData(DataDescriptor.fromPartial({ name: this.eventName }), {}),
+      distinctEntityId: event.distinctId,
+      attributes: JSON.stringify({}),
+      runtimeInfo: undefined,
+    }
+    ctx.events.push(res)
+  }
+}
+
+export class AccountEventTracker extends EventTracker {
+  static DEFAULT_OPTIONS: TrackerOptions = {
+    totalByDay: true,
+    unique: true,
+    distinctByDays: [1, 7, 30],
+  }
+
+  static register(eventName?: string, options?: TrackerOptions) {
+    if (eventName) {
+      ;['user', eventName].join('.')
+    } else {
+      eventName = 'user'
+    }
+    const tracker = new AccountEventTracker(eventName, { ...AccountEventTracker.DEFAULT_OPTIONS, ...options })
+    global.PROCESSOR_STATE.eventTrackers.push(tracker)
+    return tracker
+  }
+}

package/src/core/index.ts

@@ -1,6 +1,7 @@
 export { BigDecimal } from './big-decimal'
 export { ContractContext, ContractView, BoundContractView, SolanaContext } from './context'
 export { CounterBinding, Meter, GaugeBinding, Counter, Gauge, MetricDescriptorOptions } from './meter'
+export { EventTracker, AccountEventTracker } from './event-tracker'
 export { type Numberish, toBigInteger, toMetricValue } from './numberish'
 
 export { BindOptions, SolanaBindOptions } from './bind-options'

package/src/core/solana-processor.ts

@@ -80,11 +80,7 @@ export class SolanaBaseProcessor {
   ): ProcessResult {
     const ctx = new SolanaContext(this.contractName, this.address, slot)
     handler(parsedInstruction, ctx, accounts)
-    return {
-      gauges: ctx.gauges,
-      counters: ctx.counters,
-      logs: ctx.logs,
-    }
+    return ctx.getProcessResult()
   }
 
   public isBind() {

package/src/core/sui-processor.ts

@@ -39,11 +39,7 @@ export class SuiBaseProcessor {
     if (txn) {
       this.transactionHanlder(txn, ctx)
     }
-    return {
-      gauges: ctx.gauges,
-      counters: ctx.counters,
-      logs: ctx.logs,
-    }
+    return ctx.getProcessResult()
   }
 
   public startSlot(startSlot: Long | number) {