@sentio/sdk 1.11.0 → 1.12.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sentio/sdk",
   "license": "Apache-2.0",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "scripts": {
     "compile_target": "yarn tsc -b src/target-ethers-sentio/tsconfig.json",
     "compile": "tsc -p . && cp src/cli/webpack.config.js lib/cli",

package/src/bind-options.ts

@@ -39,3 +39,5 @@ export class SolanaBindOptions extends BindOptions {
   declare network?: string
   processInnerInstruction?: boolean
 }
+
+export class SuiBindOptions extends BindOptions {}

package/src/cli/cli.ts

@@ -112,7 +112,7 @@ if (mainOptions.command === 'login') {
       const usage = commandLineUsage([
         {
           header: 'Sentio upload',
-          content: 'Upload your project files to Sentio.',
+          content: 'sentio upload',
         },
         {
           header: 'Options',

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

@@ -16,6 +16,7 @@ export function runCreate(argv: string[]) {
     {
       name: 'name',
       alias: 'n',
+      defaultOption: true,
       type: String,
       description: '(Optional) Project name, If not provided they "Default" name will be used',
     },
@@ -25,8 +26,8 @@ export function runCreate(argv: string[]) {
   if (options.help) {
     const usage = commandLineUsage([
       {
-        header: 'Sentio Create',
-        content: 'Create a template project',
+        header: 'Create a template project',
+        content: 'sentio create [$name]',
       },
       {
         header: 'Options',
@@ -77,5 +78,6 @@ export function runCreate(argv: string[]) {
 
       fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson))
     }
+    console.log(chalk.green("successfully create project '" + projectName + "'"))
   }
 }

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

@@ -30,8 +30,8 @@ export function runLogin(argv: string[]) {
   if (options.help || !options['api-key']) {
     const usage = commandLineUsage([
       {
-        header: 'Sentio Login',
-        content: 'Try login to Sentio with your apikey.',
+        header: 'Login to Sentio',
+        content: 'sentio login --api-key=$key',
       },
       {
         header: 'Options',

package/src/context.ts

@@ -101,3 +101,5 @@ export class SolanaContext extends BaseContext {
     this.address = address
   }
 }
+
+export class SuiContext extends SolanaContext {}

package/src/gen/processor/protos/processor.ts

@@ -194,7 +194,7 @@ export interface ProcessTracesResponse {
 }
 
 export interface ProcessTransactionsRequest {
-  transaction: RawTransaction | undefined;
+  transactions: RawTransaction[];
 }
 
 export interface ProcessInstructionsRequest {
@@ -1620,7 +1620,7 @@ export const ProcessTracesResponse = {
 };
 
 function createBaseProcessTransactionsRequest(): ProcessTransactionsRequest {
-  return { transaction: undefined };
+  return { transactions: [] };
 }
 
 export const ProcessTransactionsRequest = {
@@ -1628,11 +1628,8 @@ export const ProcessTransactionsRequest = {
     message: ProcessTransactionsRequest,
     writer: _m0.Writer = _m0.Writer.create()
   ): _m0.Writer {
-    if (message.transaction !== undefined) {
-      RawTransaction.encode(
-        message.transaction,
-        writer.uint32(10).fork()
-      ).ldelim();
+    for (const v of message.transactions) {
+      RawTransaction.encode(v!, writer.uint32(10).fork()).ldelim();
     }
     return writer;
   },
@@ -1648,7 +1645,9 @@ export const ProcessTransactionsRequest = {
       const tag = reader.uint32();
       switch (tag >>> 3) {
         case 1:
-          message.transaction = RawTransaction.decode(reader, reader.uint32());
+          message.transactions.push(
+            RawTransaction.decode(reader, reader.uint32())
+          );
           break;
         default:
           reader.skipType(tag & 7);
@@ -1660,18 +1659,21 @@ export const ProcessTransactionsRequest = {
 
   fromJSON(object: any): ProcessTransactionsRequest {
     return {
-      transaction: isSet(object.transaction)
-        ? RawTransaction.fromJSON(object.transaction)
-        : undefined,
+      transactions: Array.isArray(object?.transactions)
+        ? object.transactions.map((e: any) => RawTransaction.fromJSON(e))
+        : [],
     };
   },
 
   toJSON(message: ProcessTransactionsRequest): unknown {
     const obj: any = {};
-    message.transaction !== undefined &&
-      (obj.transaction = message.transaction
-        ? RawTransaction.toJSON(message.transaction)
-        : undefined);
+    if (message.transactions) {
+      obj.transactions = message.transactions.map((e) =>
+        e ? RawTransaction.toJSON(e) : undefined
+      );
+    } else {
+      obj.transactions = [];
+    }
     return obj;
   },
 
@@ -1679,10 +1681,8 @@ export const ProcessTransactionsRequest = {
     object: DeepPartial<ProcessTransactionsRequest>
   ): ProcessTransactionsRequest {
     const message = createBaseProcessTransactionsRequest();
-    message.transaction =
-      object.transaction !== undefined && object.transaction !== null
-        ? RawTransaction.fromPartial(object.transaction)
-        : undefined;
+    message.transactions =
+      object.transactions?.map((e) => RawTransaction.fromPartial(e)) || [];
     return message;
   },
 };

package/src/index.ts

@@ -6,8 +6,9 @@ export { ProcessorServiceImpl } from './service'
 export { Counter, Meter, Gauge } from './meter'
 export { getProvider, setProvider, DummyProvider } from './provider'
 export { SolanaBaseProcessor } from './solana-processor'
+export { SuiBaseProcessor } from './sui-processor'
 export { ContractNamer } from './contract-namer'
-export { BindOptions, SolanaBindOptions } from './bind-options'
+export { BindOptions, SolanaBindOptions, SuiBindOptions } from './bind-options'
 export { transformEtherError } from './error'
 export { ProcessorState } from './processor-state'
 export { BigNumber as BigDecimal } from 'bignumber.js'

package/src/processor-state.ts

@@ -5,6 +5,7 @@ import { BaseProcessorTemplate } from './base-processor-template'
 import { TemplateInstance } from './gen/processor/protos/processor'
 import { Provider } from '@ethersproject/providers'
 import { SolanaBaseProcessor } from './solana-processor'
+import { SuiBaseProcessor } from './sui-processor'
 
 export class ProcessorState {
   // from abiName_address_chainId => contract wrapper
@@ -21,4 +22,6 @@ export class ProcessorState {
   templatesInstances: TemplateInstance[] = []
 
   solanaProcessors: SolanaBaseProcessor[] = []
+
+  suiProcessors: SuiBaseProcessor[] = []
 }

package/src/service.ts

@@ -175,6 +175,26 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       }
       this.contractConfigs.push(contractConfig)
     }
+
+    // Part 3, prepare sui constractors
+    for (const suiProcessor of global.PROCESSOR_STATE.suiProcessors) {
+      const contractConfig: ContractConfig = {
+        processorType: 'user_processor',
+        contract: {
+          name: 'sui processor',
+          chainId: 'SUI_devnet',
+          address: suiProcessor.address,
+          abi: '',
+        },
+        blockConfigs: [],
+        logConfigs: [],
+        traceConfigs: [],
+        startBlock: suiProcessor.config.startSeqNumber,
+        endBlock: DEFAULT_MAX_BLOCK,
+        instructionConfig: undefined,
+      }
+      this.contractConfigs.push(contractConfig)
+    }
   }
 
   async start(request: StartRequest, context: CallContext): Promise<Empty> {
@@ -276,7 +296,39 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       throw new ServerError(Status.UNAVAILABLE, 'Service not started.')
     }
 
-    throw new ServerError(Status.UNIMPLEMENTED, 'Processing transaction is not suppored.')
+    const result: ProcessResult = {
+      gauges: [],
+      counters: [],
+      logs: [],
+    }
+
+    if (global.PROCESSOR_STATE.suiProcessors) {
+      const processorPromises: Promise<void>[] = []
+      for (const txn of request.transactions) {
+        processorPromises.push(
+          new Promise((resolve, _) => {
+            for (const processor of global.PROCESSOR_STATE.suiProcessors) {
+              const res = processor.handleTransaction(JSON.parse(new TextDecoder().decode(txn.raw)))
+              if (res) {
+                res.gauges.forEach((g) => {
+                  result.gauges.push(g)
+                })
+                res.counters.forEach((c) => {
+                  result.counters.push(c)
+                })
+              }
+            }
+            resolve()
+          })
+        )
+      }
+      await Promise.all(processorPromises)
+    }
+
+    recordRuntimeInfo(result, HandlerType.TRANSACTION)
+    return {
+      result,
+    }
   }
 
   async processInstructions(

package/src/sui-processor.ts

@@ -0,0 +1,75 @@
+import { SuiBindOptions } from './bind-options'
+import { SuiContext } from './context'
+import { ProcessResult } from './index'
+import Long from 'long'
+
+type IndexConfigure = {
+  startSeqNumber: Long
+  endSeqNumber?: Long
+}
+
+export class SuiBaseProcessor {
+  public transactionHanlder: (transaction: any, ctx: SuiContext) => void
+  address: string
+  config: IndexConfigure = { startSeqNumber: new Long(0) }
+
+  constructor(options: SuiBindOptions) {
+    if (options) {
+      this.bind(options)
+    }
+    global.PROCESSOR_STATE.suiProcessors.push(this)
+  }
+
+  bind(options: SuiBindOptions) {
+    this.address = options.address
+    if (options.startBlock) {
+      this.startSlot(options.startBlock)
+    }
+    if (options.endBlock) {
+      this.endBlock(options.endBlock)
+    }
+  }
+
+  public onTransaction(handler: (transaction: any, ctx: SuiContext) => void) {
+    if (!this.isBind()) {
+      throw new Error("Processor doesn't bind to an address")
+    }
+
+    this.transactionHanlder = handler
+
+    return this
+  }
+
+  public handleTransaction(txn: any): ProcessResult | null {
+    const ctx = new SuiContext(this.address)
+
+    if (txn) {
+      this.transactionHanlder(txn, ctx)
+    }
+    return {
+      gauges: ctx.gauges,
+      counters: ctx.counters,
+      logs: [],
+    }
+  }
+
+  public isBind() {
+    return this.address !== null
+  }
+
+  public startSlot(startSlot: Long | number) {
+    if (typeof startSlot === 'number') {
+      startSlot = Long.fromNumber(startSlot)
+    }
+    this.config.startSeqNumber = startSlot
+    return this
+  }
+
+  public endBlock(endBlock: Long | number) {
+    if (typeof endBlock === 'number') {
+      endBlock = Long.fromNumber(endBlock)
+    }
+    this.config.endSeqNumber = endBlock
+    return this
+  }
+}

package/src/test/sui.test.ts

@@ -0,0 +1,167 @@
+import { expect } from 'chai'
+import { TextEncoder } from 'util'
+import { ProcessTransactionsRequest } from '..'
+
+import { TestProcessorServer } from './test-processor-server'
+
+describe('Test Sui Example', () => {
+  const service = new TestProcessorServer(() => {
+    require('./tic-tac-toe')
+  })
+
+  beforeAll(async () => {
+    await service.start({ templateInstances: [] })
+  })
+
+  test('check configuration ', async () => {
+    const config = await service.getConfig({})
+    expect(config.contractConfigs).length(1)
+  })
+
+  test('Check tictactoe transaction dispatch', async () => {
+    const request: ProcessTransactionsRequest = {
+      transactions: [
+        {
+          txHash: 'z3HjnnFFKAaszOi0pMSImtGMpRd2r7ljLjAjUoqs3Kw=',
+          raw: new TextEncoder().encode(JSON.stringify(testData)),
+          programAccountId: '0xb8252513f0b9efaa3e260842c4b84d8ff933522d',
+        },
+      ],
+    }
+    const res = await service.processTransactions(request)
+    expect(res.result?.counters).length(1)
+    expect(res.result?.gauges).length(0)
+  })
+})
+
+const testData = {
+  certificate: {
+    transactionDigest: 'z3HjnnFFKAaszOi0pMSImtGMpRd2r7ljLjAjUoqs3Kw=',
+    data: {
+      transactions: [
+        {
+          Call: {
+            package: {
+              objectId: '0xb8252513f0b9efaa3e260842c4b84d8ff933522d',
+              version: 1,
+              digest: 'UyeEXDb5jCLGuk/PVcqdLtbKSI3mSANB2/DxiyzXRC8=',
+            },
+            module: 'shared_tic_tac_toe',
+            function: 'place_mark',
+            arguments: ['0x8ed24078d64aa1a2a7593cba7ab64eb2016fa3d4', 2, ''],
+          },
+        },
+      ],
+      sender: '0x1c270459011d19dc342751aff75b4188334438fa',
+      gasPayment: {
+        objectId: '0x018b73e6652bab0f6419fa998263b568fa0688bb',
+        version: 8,
+        digest: 'suj5fniFCh3oqu+3BQWASz5zyUl4jUWVmJFf76AwVoE=',
+      },
+      gasBudget: 1000,
+    },
+    txSignature:
+      'ACIBv8kDff83DOjZsrUe4RqC1BLBGZtLAwFf/3tHUWJe1F+fxtg16Kqdm85TY9IWeYhVTtQkmchROxX8g0pi/Ak48WB/fgCTwX6K9CIMWgmr+j4k7x4dPYBNizpjHvBgCQ==',
+    authSignInfo: {
+      epoch: 0,
+      signature: [
+        'o4tOmjc4jJ27NoKGEHlNDZav0rBJLDqzzsL1kGJOviPKgpLlxyFCeBHrgjAwoc4Y5M75wYgccCuiv67l1w05DQ==',
+        'B2tClnK9GYCDFg6HbO/IW7hlJkhfIXi6NoDn7s4Pyw94BjMB/v0S0ZufbLwDO/WhBwU83q+wRTanG4HRhvUuBw==',
+        '5s49bESgHvDH7/oqjuxjy9YW4xWCG4e8g6hGlZC0bTXskPdf+q6bSGglkkMpOr1B3uIlMeif1NAlRQCKsfNcCg==',
+      ],
+      signers_map: [58, 48, 0, 0, 1, 0, 0, 0, 0, 0, 2, 0, 16, 0, 0, 0, 1, 0, 2, 0, 3, 0],
+    },
+  },
+  effects: {
+    status: {
+      status: 'success',
+    },
+    gasUsed: {
+      computationCost: 716,
+      storageCost: 48,
+      storageRebate: 35,
+    },
+    sharedObjects: [
+      {
+        objectId: '0x8ed24078d64aa1a2a7593cba7ab64eb2016fa3d4',
+        version: 6,
+        digest: 'kY/I9fcr6rL2EbDO88MxrEmEaxAEtRxgd+lcfQnE4ww=',
+      },
+    ],
+    transactionDigest: 'z3HjnnFFKAaszOi0pMSImtGMpRd2r7ljLjAjUoqs3Kw=',
+    created: [
+      {
+        owner: {
+          AddressOwner: '0x1c270459011d19dc342751aff75b4188334438fa',
+        },
+        reference: {
+          objectId: '0x2e37e03297a9d138687ffd921f8a830a6f498ec6',
+          version: 1,
+          digest: '1zZhoVoTLPRM1YpGX9EcrwPJulKcXyLrF+40rTIQ06g=',
+        },
+      },
+    ],
+    mutated: [
+      {
+        owner: {
+          AddressOwner: '0x1c270459011d19dc342751aff75b4188334438fa',
+        },
+        reference: {
+          objectId: '0x018b73e6652bab0f6419fa998263b568fa0688bb',
+          version: 9,
+          digest: 'naHwWYK8vl7UBnhp40o7h7JI+cxvFF8rTIOQ4RJ4vus=',
+        },
+      },
+      {
+        owner: 'Shared',
+        reference: {
+          objectId: '0x8ed24078d64aa1a2a7593cba7ab64eb2016fa3d4',
+          version: 7,
+          digest: 's3R+lWAMGde7eqZzllafAJkoR7Em55An8gHgz7oCImw=',
+        },
+      },
+    ],
+    gasObject: {
+      owner: {
+        AddressOwner: '0x1c270459011d19dc342751aff75b4188334438fa',
+      },
+      reference: {
+        objectId: '0x018b73e6652bab0f6419fa998263b568fa0688bb',
+        version: 9,
+        digest: 'naHwWYK8vl7UBnhp40o7h7JI+cxvFF8rTIOQ4RJ4vus=',
+      },
+    },
+    events: [
+      {
+        moveEvent: {
+          packageId: '0xb8252513f0b9efaa3e260842c4b84d8ff933522d',
+          transactionModule: 'shared_tic_tac_toe',
+          sender: '0x1c270459011d19dc342751aff75b4188334438fa',
+          type: '0xb8252513f0b9efaa3e260842c4b84d8ff933522d::shared_tic_tac_toe::GameEndEvent',
+          fields: {
+            game_id: '0x8ed24078d64aa1a2a7593cba7ab64eb2016fa3d4',
+          },
+          bcs: 'jtJAeNZKoaKnWTy6erZOsgFvo9Q=',
+        },
+      },
+      {
+        newObject: {
+          packageId: '0xb8252513f0b9efaa3e260842c4b84d8ff933522d',
+          transactionModule: 'shared_tic_tac_toe',
+          sender: '0x1c270459011d19dc342751aff75b4188334438fa',
+          recipient: {
+            AddressOwner: '0x1c270459011d19dc342751aff75b4188334438fa',
+          },
+          objectId: '0x2e37e03297a9d138687ffd921f8a830a6f498ec6',
+        },
+      },
+    ],
+    dependencies: [
+      'UgLnWz4u9GTgAJYwR+rz+YO5TDJiZHuFjzyh9blJO2o=',
+      'lw2dyQ9J3fPeH5Lx5aiHfjxDHJENTH4910r2/Y/PQX4=',
+      'phojYeMd7C6mRxGXQFDPF10NFYMEUfBND+f8wJGKkbg=',
+    ],
+  },
+  timestamp_ms: 1662996912461,
+  parsed_data: null,
+}

package/src/test/tic-tac-toe.ts

@@ -0,0 +1,31 @@
+import { SuiBindOptions } from '../bind-options'
+import { SuiBaseProcessor } from '../sui-processor'
+
+class TicTacToeProcessor extends SuiBaseProcessor {
+  static bind(options: SuiBindOptions): TicTacToeProcessor {
+    if (options && !options.name) {
+      options.name = 'TicTacToe'
+    }
+    return new TicTacToeProcessor(options)
+  }
+}
+
+TicTacToeProcessor.bind({
+  startBlock: 0,
+  address: '',
+}).onTransaction((txn, ctx) => {
+  if (txn.certificate.data.transactions && txn.certificate.data.transactions.length > 0) {
+    if (txn.certificate.data.transactions[0].Call.package.objectId === '0xb8252513f0b9efaa3e260842c4b84d8ff933522d') {
+      if (txn.effects.events) {
+        txn.effects.events.forEach((event: { newObject: { recipient: { AddressOwner: any } } }) => {
+          if (event.newObject) {
+            const owner = event.newObject.recipient.AddressOwner
+            if ((owner.toString() as string).includes('0x1c27')) {
+              ctx.meter.Counter('win_count').add(1)
+            }
+          }
+        })
+      }
+    }
+  }
+})