@sentio/sdk 2.41.4-rc.1 → 2.41.4-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentio/sdk",
-  "version": "2.41.4-rc.1",
+  "version": "2.41.4-rc.3",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
@@ -84,8 +84,8 @@
     "typechain": "^8.3.2",
     "utility-types": "^3.11.0",
     "yaml": "^2.3.4",
-    "@sentio/protos": "2.41.4-rc.1",
-    "@sentio/runtime": "^2.41.4-rc.1"
+    "@sentio/runtime": "^2.41.4-rc.3",
+    "@sentio/protos": "2.41.4-rc.3"
   },
   "peerDependencies": {
     "tsup": "npm:@sentio/tsup@^6.7.2"
@@ -123,6 +123,7 @@
     "gen:sui": "cp ../../node_modules/@typemove/sui/src/abis/*.json src/sui/abis && tsx src/sui/codegen/run.ts src/sui/abis src/sui/builtin && pnpm gen:sui_test",
     "gen:sui_test": "tsx src/sui/codegen/run.ts src/sui/tests/abis src/sui/tests/types",
     "test": "glob -c 'tsx --test' '**/*.test.ts'",
+    "test:btc": "tsx --test src/btc/tests/processor.test.ts",
     "test:starknet": "tsx --test src/stark/tests/event.test.ts"
   }
 }

package/src/btc/btc-plugin.ts

@@ -1,17 +1,22 @@
 import { errorString, GLOBAL_CONFIG, mergeProcessResults, Plugin, PluginManager, USER_PROCESSOR } from '@sentio/runtime'
 import {
+  BTCTransactionFilter_FieldFilters,
   ContractConfig,
   Data_BTCTransaction,
   DataBinding,
   HandlerType,
   ProcessConfigResponse,
   ProcessResult,
+  RichValue,
   StartRequest
 } from '@sentio/protos'
 
 import { ServerError, Status } from 'nice-grpc'
 import { TemplateInstanceState } from '../core/template.js'
 import { BTCProcessorState } from './btc-processor.js'
+import { TransactionFilter, TransactionFilters } from './types.js'
+import { serializeRichValue } from '../store/util.js'
+import { isArray } from 'radash'
 
 interface Handlers {
   txHandlers: ((trace: Data_BTCTransaction) => Promise<ProcessResult>)[]
@@ -43,14 +48,25 @@ export class BTCPlugin extends Plugin {
       for (const callHandler of processor.callHandlers) {
         const handlerId = handlers.txHandlers.push(callHandler.handler) - 1
 
-        contractConfig.btcTransactionConfigs.push({
-          filters: [
-            {
-              address: contractConfig.contract?.address || '*'
-            }
-          ],
-          handlerId
-        })
+        if (callHandler.filter) {
+          contractConfig.btcTransactionConfigs.push({
+            filters: [
+              {
+                fieldFilters: toFilters(callHandler.filter)
+              }
+            ],
+            handlerId
+          })
+        } else {
+          contractConfig.btcTransactionConfigs.push({
+            filters: [
+              {
+                address: contractConfig.contract?.address || '*'
+              }
+            ],
+            handlerId
+          })
+        }
       }
 
       // Finish up a contract
@@ -103,3 +119,28 @@ export class BTCPlugin extends Plugin {
 }
 
 PluginManager.INSTANCE.register(new BTCPlugin())
+
+function toFilters(filters: TransactionFilters): BTCTransactionFilter_FieldFilters {
+  const arr = !isArray(filters) ? [filters] : filters
+  return {
+    filters: arr.map((f: TransactionFilter) => {
+      const { field, ...rest } = f
+      return {
+        field: field,
+        ...toValues(rest)
+      }
+    })
+  }
+}
+
+function toValues(rest: Omit<TransactionFilter, 'field'>): Record<keyof Omit<TransactionFilter, 'field'>, RichValue> {
+  return Object.entries(rest).reduce(
+    (acc, [key, value]) => {
+      if (value !== undefined) {
+        acc[key] = serializeRichValue(value)
+      }
+      return acc
+    },
+    {} as Record<string, RichValue>
+  )
+}

package/src/btc/btc-processor.ts

@@ -1,5 +1,5 @@
 import { ListStateStorage } from '@sentio/runtime'
-import { BTCContext, Transaction } from './types.js'
+import { BTCContext, Transaction, TransactionFilters } from './types.js'
 import { Data_BTCTransaction, ProcessResult } from '@sentio/protos'
 
 export class BTCProcessorState extends ListStateStorage<BTCProcessor> {
@@ -17,7 +17,10 @@ export class BTCProcessor {
     return processor
   }
 
-  public onTransaction(handler: (transaction: Transaction, ctx: BTCContext) => void | Promise<void>) {
+  public onTransaction(
+    handler: (transaction: Transaction, ctx: BTCContext) => void | Promise<void>,
+    filter?: TransactionFilters
+  ) {
     const callHandler = {
       handler: async (call: Data_BTCTransaction) => {
         const tx = call.transaction as Transaction
@@ -26,11 +29,12 @@ export class BTCProcessor {
           this.config.chainId,
           this.config.name ?? this.config.address ?? '',
           tx,
-          this.config.address
+          this.config.address ?? tx.vout[0].scriptpubkey_address
         )
         await handler(tx, ctx)
         return ctx.stopAndGetResult()
-      }
+      },
+      filter
     }
     this.callHandlers.push(callHandler)
     return this
@@ -40,11 +44,12 @@ export class BTCProcessor {
 interface BTCProcessorConfig {
   chainId: string
   name?: string
-  address: string
+  address?: string
   startBlock?: bigint
   endBlock?: bigint
 }
 
 export type CallHandler<T> = {
   handler: (call: T) => Promise<ProcessResult>
+  filter?: TransactionFilters
 }

package/src/btc/types.ts

@@ -1,6 +1,7 @@
 import { BaseContext, Labels, normalizeLabels } from '../core/index.js'
 import { RecordMetaData } from '@sentio/protos'
 import { ChainId } from '@sentio/chain'
+import { BigDecimal } from '@sentio/bigdecimal'
 
 type Vin = {
   txid: string
@@ -91,3 +92,33 @@ export class BTCContext extends BaseContext {
     return this.chainId as ChainId
   }
 }
+
+export type TransactionFilter = {
+  field:
+    | 'vin.txid'
+    | 'vin.vout'
+    | 'vin.is_coinbase'
+    | 'vin.scriptsig'
+    | 'vin.scriptsig_asm'
+    | 'vout.scriptpubkey'
+    | 'vout.scriptpubkey_asm'
+    | 'vout.scriptpubkey_type'
+    | 'vout.scriptpubkey_address'
+    | 'vout.value'
+    | 'status.block_height'
+    | 'status.block_hash'
+    | 'status.block_time'
+  prefix?: string
+  equals?: Comparable
+  gt?: Comparable
+  gte?: Comparable
+  lt?: Comparable
+  lte?: Comparable
+  ne?: Comparable
+  contains?: string
+  not_contains?: string
+}
+
+type Comparable = number | BigDecimal | bigint | Date
+
+export type TransactionFilters = TransactionFilter | TransactionFilter[]