@sentio/sdk 2.56.0 → 2.57.0-rc.2

package/src/aptos/builtin/0x4.ts

@@ -106,10 +106,10 @@ export namespace token {
     }
   }
 
-  export interface MutationInstance extends TypedEventInstance<Mutation> {
+  export type MutationInstance = TypedEventInstance<Mutation> & {
     data_decoded: Mutation;
     type_arguments: [];
-  }
+  };
 
   export interface MutationEvent {
     mutated_field_name: string;
@@ -127,11 +127,10 @@ export namespace token {
     }
   }
 
-  export interface MutationEventInstance
-    extends TypedEventInstance<MutationEvent> {
+  export type MutationEventInstance = TypedEventInstance<MutationEvent> & {
     data_decoded: MutationEvent;
     type_arguments: [];
-  }
+  };
 
   export interface ConcurrentTokenIdentifiers {
     index: _0x1.aggregator_v2.AggregatorSnapshot<bigint>;
@@ -570,10 +569,10 @@ export namespace collection {
     }
   }
 
-  export interface BurnInstance extends TypedEventInstance<Burn> {
+  export type BurnInstance = TypedEventInstance<Burn> & {
     data_decoded: Burn;
     type_arguments: [];
-  }
+  };
 
   export interface BurnEvent {
     index: bigint;
@@ -590,10 +589,10 @@ export namespace collection {
     }
   }
 
-  export interface BurnEventInstance extends TypedEventInstance<BurnEvent> {
+  export type BurnEventInstance = TypedEventInstance<BurnEvent> & {
     data_decoded: BurnEvent;
     type_arguments: [];
-  }
+  };
 
   export interface Collection {
     creator: MoveAddressType;
@@ -631,11 +630,11 @@ export namespace collection {
     }
   }
 
-  export interface ConcurrentBurnEventInstance
-    extends TypedEventInstance<ConcurrentBurnEvent> {
-    data_decoded: ConcurrentBurnEvent;
-    type_arguments: [];
-  }
+  export type ConcurrentBurnEventInstance =
+    TypedEventInstance<ConcurrentBurnEvent> & {
+      data_decoded: ConcurrentBurnEvent;
+      type_arguments: [];
+    };
 
   export interface ConcurrentMintEvent {
     collection_addr: MoveAddressType;
@@ -655,11 +654,11 @@ export namespace collection {
     }
   }
 
-  export interface ConcurrentMintEventInstance
-    extends TypedEventInstance<ConcurrentMintEvent> {
-    data_decoded: ConcurrentMintEvent;
-    type_arguments: [];
-  }
+  export type ConcurrentMintEventInstance =
+    TypedEventInstance<ConcurrentMintEvent> & {
+      data_decoded: ConcurrentMintEvent;
+      type_arguments: [];
+    };
 
   export interface FixedSupply {
     current_supply: bigint;
@@ -695,10 +694,10 @@ export namespace collection {
     }
   }
 
-  export interface MintInstance extends TypedEventInstance<Mint> {
+  export type MintInstance = TypedEventInstance<Mint> & {
     data_decoded: Mint;
     type_arguments: [];
-  }
+  };
 
   export interface MintEvent {
     index: bigint;
@@ -715,10 +714,10 @@ export namespace collection {
     }
   }
 
-  export interface MintEventInstance extends TypedEventInstance<MintEvent> {
+  export type MintEventInstance = TypedEventInstance<MintEvent> & {
     data_decoded: MintEvent;
     type_arguments: [];
-  }
+  };
 
   export interface Mutation {
     mutated_field_name: string;
@@ -737,10 +736,10 @@ export namespace collection {
     }
   }
 
-  export interface MutationInstance extends TypedEventInstance<Mutation> {
+  export type MutationInstance = TypedEventInstance<Mutation> & {
     data_decoded: Mutation;
     type_arguments: [];
-  }
+  };
 
   export interface MutationEvent {
     mutated_field_name: string;
@@ -756,11 +755,10 @@ export namespace collection {
     }
   }
 
-  export interface MutationEventInstance
-    extends TypedEventInstance<MutationEvent> {
+  export type MutationEventInstance = TypedEventInstance<MutationEvent> & {
     data_decoded: MutationEvent;
     type_arguments: [];
-  }
+  };
 
   export interface SetMaxSupply {
     collection: _0x1.object$.Object<collection.Collection>;
@@ -778,11 +776,10 @@ export namespace collection {
     }
   }
 
-  export interface SetMaxSupplyInstance
-    extends TypedEventInstance<SetMaxSupply> {
+  export type SetMaxSupplyInstance = TypedEventInstance<SetMaxSupply> & {
     data_decoded: SetMaxSupply;
     type_arguments: [];
-  }
+  };
 
   export interface UnlimitedSupply {
     current_supply: bigint;

package/src/fuel/asset-processor.ts

@@ -1,5 +1,5 @@
 import { CallHandler, FuelBaseProcessor, FuelProcessorState } from './types.js'
-import { Data_FuelTransaction, FuelAssetHandlerConfig_AssetFilter } from '@sentio/protos'
+import { Data_FuelReceipt, Data_FuelTransaction, FuelAssetHandlerConfig_AssetFilter } from '@sentio/protos'
 import { FuelNetwork, getProvider } from './network.js'
 import { FuelContext } from './context.js'
 import { decodeFuelTransaction } from './transaction.js'
@@ -8,7 +8,7 @@ import { getOptionsSignature } from './fuel-processor.js'
 import { getHandlerName, proxyProcessor } from '../utils/metrics.js'
 
 export class FuelAssetProcessor implements FuelBaseProcessor<FuelAssetProcessorConfig> {
-  txHandlers: CallHandler<Data_FuelTransaction>[] = []
+  txHandlers: CallHandler<Data_FuelTransaction | Data_FuelReceipt>[] = []
   blockHandlers = []
   private provider: Provider
 
@@ -112,8 +112,11 @@ export type FuelAssetProcessorConfig = {
 }
 
 export type TransferFilter = {
+  // The  account address that is sending the asset
   from?: string | string[]
+  // The account address that is receiving the asset
   to?: string | string[]
+  // The asset id of the asset being transferred
   assetId?: string | string[]
 }
 

package/src/fuel/fuel-plugin.ts

@@ -21,7 +21,7 @@ import { FuelGlobalProcessor } from './global-processor.js'
 interface Handlers {
   transactionHandlers: ((trace: Data_FuelTransaction) => Promise<ProcessResult>)[]
   blockHandlers: ((block: Data_FuelBlock) => Promise<ProcessResult>)[]
-  logHandlers: ((log: Data_FuelReceipt) => Promise<ProcessResult>)[]
+  receiptHandlers: ((log: Data_FuelReceipt) => Promise<ProcessResult>)[]
 }
 
 export class FuelPlugin extends Plugin {
@@ -29,27 +29,28 @@ export class FuelPlugin extends Plugin {
   handlers: Handlers = {
     transactionHandlers: [],
     blockHandlers: [],
-    logHandlers: []
+    receiptHandlers: []
   }
 
   async configure(config: ProcessConfigResponse) {
     const handlers: Handlers = {
       transactionHandlers: [],
       blockHandlers: [],
-      logHandlers: []
+      receiptHandlers: []
     }
 
     for (const processor of FuelProcessorState.INSTANCE.getValues()) {
+      const processorConfig = processor.config
       const contractConfig = ContractConfig.fromPartial({
         processorType: USER_PROCESSOR,
         contract: {
-          name: processor.config.name,
-          chainId: processor.config.chainId.toString(),
-          address: processor.config.address || '*',
+          name: processorConfig.name,
+          chainId: processorConfig.chainId.toString(),
+          address: processorConfig.address || '*',
           abi: ''
         },
-        startBlock: processor.config.startBlock,
-        endBlock: processor.config.endBlock
+        startBlock: processorConfig.startBlock,
+        endBlock: processorConfig.endBlock
       })
       for (const txHandler of processor.txHandlers) {
         const handlerId = handlers.transactionHandlers.push(txHandler.handler) - 1
@@ -79,12 +80,12 @@ export class FuelPlugin extends Plugin {
         }
       }
 
-      for (const logHandler of processor.logHandlers ?? []) {
-        const handlerId = handlers.logHandlers.push(logHandler.handler) - 1
-        const handlerName = logHandler.handlerName
+      for (const receiptHandler of processor.receiptHandlers ?? []) {
+        const handlerId = handlers.receiptHandlers.push(receiptHandler.handler) - 1
+        const handlerName = receiptHandler.handlerName
         if (processor instanceof FuelProcessor) {
-          contractConfig.fuelLogConfigs.push({
-            logIds: logHandler.logConfig?.logIds || [],
+          contractConfig.fuelReceiptConfigs.push({
+            ...receiptHandler.receiptConfig,
             handlerId,
             handlerName
           })
@@ -123,7 +124,7 @@ export class FuelPlugin extends Plugin {
       case HandlerType.FUEL_TRANSACTION:
         return this.processTransaction(request)
       case HandlerType.FUEL_RECEIPT:
-        return this.processLog(request)
+        return this.processReceipt(request)
       case HandlerType.FUEL_BLOCK:
         return this.processBlock(request)
       default:
@@ -145,19 +146,20 @@ export class FuelPlugin extends Plugin {
     return TemplateInstanceState.INSTANCE.getValues().length !== config.templateInstances.length
   }
 
-  async processLog(binding: DataBinding): Promise<ProcessResult> {
-    if (!binding.data?.fuelLog?.transaction) {
+  async processReceipt(binding: DataBinding): Promise<ProcessResult> {
+    const receipt = binding?.data?.fuelLog
+
+    if (!receipt?.transaction) {
       throw new ServerError(Status.INVALID_ARGUMENT, "transaction can't be null")
     }
-    const log = binding.data.fuelLog
 
     const promises: Promise<ProcessResult>[] = []
 
     for (const handlerId of binding.handlerIds) {
-      const promise = this.handlers.logHandlers[handlerId](log).catch((e) => {
+      const promise = this.handlers.receiptHandlers[handlerId](receipt).catch((e) => {
         throw new ServerError(
           Status.INTERNAL,
-          'error processing transaction: ' + JSON.stringify(log) + '\n' + errorString(e)
+          'error processing transaction: ' + JSON.stringify(receipt) + '\n' + errorString(e)
         )
       })
       if (GLOBAL_CONFIG.execution.sequential) {
@@ -167,6 +169,7 @@ export class FuelPlugin extends Plugin {
     }
     return mergeProcessResults(await Promise.all(promises))
   }
+
   async processTransaction(binding: DataBinding): Promise<ProcessResult> {
     if (!binding.data?.fuelTransaction?.transaction) {
       throw new ServerError(Status.INVALID_ARGUMENT, "transaction can't be null")

package/src/fuel/fuel-processor.ts

@@ -7,7 +7,7 @@ import {
   ProcessResult
 } from '@sentio/protos'
 import { FuelCall, FuelContext, FuelContractContext } from './context.js'
-import { bn, Contract, Interface, JsonAbi, Provider } from 'fuels'
+import { bn, Contract, Interface, JsonAbi, Provider, ReceiptTransfer, ReceiptTransferOut } from 'fuels'
 import { FuelNetwork, getProvider } from './network.js'
 import {
   decodeFuelTransaction,
@@ -19,12 +19,13 @@ import {
 import {
   BlockHandler,
   CallHandler,
+  ContractTransferFilter,
   FuelBaseProcessor,
   FuelBlock,
   FuelLog,
   FuelProcessorState,
   FuelTransaction,
-  LogHandler
+  ReceiptHandler
 } from './types.js'
 import { PromiseOrVoid } from '../core/index.js'
 import { ServerError, Status } from 'nice-grpc'
@@ -33,7 +34,7 @@ import { getHandlerName, proxyProcessor } from '../utils/metrics.js'
 export class FuelProcessor<TContract extends Contract> implements FuelBaseProcessor<FuelProcessorConfig> {
   txHandlers: CallHandler<Data_FuelTransaction>[] = []
   blockHandlers: BlockHandler[] = []
-  logHandlers: LogHandler<Data_FuelReceipt>[] = []
+  receiptHandlers: ReceiptHandler[] = []
 
   private provider: Provider
   private contract: TContract
@@ -214,11 +215,57 @@ export class FuelProcessor<TContract extends Contract> implements FuelBaseProces
 
         return ProcessResult.fromPartial({})
       },
-      logConfig: {
-        logIds: Array.from(logIds)
+      receiptConfig: {
+        log: {
+          logIds: Array.from(logIds)
+        }
       }
-    }
-    this.logHandlers.push(logHandler)
+    } as ReceiptHandler
+    this.receiptHandlers.push(logHandler)
+    return this
+  }
+
+  /*
+   * handle 'Transfer' and 'TransferOut' receipt for a specific contract id
+   */
+  public onTransfer(
+    filter: ContractTransferFilter,
+    handler: (transfer: ReceiptTransfer | ReceiptTransferOut, ctx: FuelContractContext<TContract>) => PromiseOrVoid
+  ) {
+    const { from, to, assetId } = filter
+    const h = {
+      handlerName: getHandlerName(),
+      handler: async ({ transaction, receiptIndex, timestamp }: Data_FuelReceipt) => {
+        try {
+          const tx = decodeFuelTransaction(transaction, this.provider)
+          const index = Number(receiptIndex)
+          const receipt = tx.receipts[index] as ReceiptTransfer | ReceiptTransferOut
+          const ctx = new FuelContractContext(
+            this.config.chainId,
+            this.contract,
+            this.config.address,
+            this.config.name ?? this.config.address,
+            timestamp || new Date(0),
+            tx,
+            null
+          )
+          ctx.setLogIndex(index)
+          await handler(receipt, ctx)
+        } catch (e) {
+          console.error(e)
+        }
+
+        return ProcessResult.fromPartial({})
+      },
+      receiptConfig: {
+        transfer: {
+          from,
+          to,
+          assetId
+        }
+      }
+    } as ReceiptHandler
+    this.receiptHandlers.push(h)
     return this
   }
 

package/src/fuel/types.ts

@@ -5,6 +5,7 @@ import {
   Data_FuelTransaction,
   FuelAssetHandlerConfig,
   FuelCallHandlerConfig,
+  FuelReceiptHandlerConfig,
   HandleInterval,
   OnIntervalConfig,
   ProcessResult
@@ -16,7 +17,7 @@ export interface FuelBaseProcessor<T> {
   config: T
   txHandlers: CallHandler<Data_FuelTransaction>[]
   blockHandlers: BlockHandler[]
-  logHandlers?: LogHandler<Data_FuelReceipt>[]
+  receiptHandlers?: ReceiptHandler[]
 }
 
 export class FuelProcessorState extends MapStateStorage<FuelBaseProcessor<any>> {
@@ -30,12 +31,10 @@ export type CallHandler<T> = {
   assetConfig?: Partial<FuelAssetHandlerConfig>
 }
 
-export type LogHandler<T> = {
+export type ReceiptHandler = {
   handlerName: string
-  handler: (call: T) => Promise<ProcessResult>
-  logConfig?: {
-    logIds: string[]
-  }
+  handler: (receipt: Data_FuelReceipt) => Promise<ProcessResult>
+  receiptConfig?: Partial<FuelReceiptHandlerConfig>
 }
 
 export type BlockHandler = {
@@ -59,3 +58,9 @@ export type FuelTransaction = TransactionSummary & {
 }
 
 export type FuelBlock = Omit<Block, 'transactionIds'>
+
+export type ContractTransferFilter = {
+  assetId?: string
+  from?: string
+  to?: string
+}

package/src/sui/builtin/0x1.ts

@@ -745,10 +745,10 @@ export namespace bit_vector {
     }
   }
 
-  export interface BitVectorInstance extends TypedEventInstance<BitVector> {
+  export type BitVectorInstance = TypedEventInstance<BitVector> & {
     data_decoded: BitVector;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function isIndexSet(
@@ -1082,11 +1082,10 @@ export namespace fixed_point32 {
     }
   }
 
-  export interface FixedPoint32Instance
-    extends TypedEventInstance<FixedPoint32> {
+  export type FixedPoint32Instance = TypedEventInstance<FixedPoint32> & {
     data_decoded: FixedPoint32;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function createFromRational(
@@ -2015,10 +2014,10 @@ export namespace string$ {
     }
   }
 
-  export interface StringInstance extends TypedEventInstance<String> {
+  export type StringInstance = TypedEventInstance<String> & {
     data_decoded: String;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function append(
@@ -2516,10 +2515,10 @@ export namespace type_name {
     }
   }
 
-  export interface TypeNameInstance extends TypedEventInstance<TypeName> {
+  export type TypeNameInstance = TypedEventInstance<TypeName> & {
     data_decoded: TypeName;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function borrowString(
@@ -4580,10 +4579,10 @@ export namespace uq32_32 {
     }
   }
 
-  export interface UQ32_32Instance extends TypedEventInstance<UQ32_32> {
+  export type UQ32_32Instance = TypedEventInstance<UQ32_32> & {
     data_decoded: UQ32_32;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function add(
@@ -5089,10 +5088,10 @@ export namespace uq64_64 {
     }
   }
 
-  export interface UQ64_64Instance extends TypedEventInstance<UQ64_64> {
+  export type UQ64_64Instance = TypedEventInstance<UQ64_64> & {
     data_decoded: UQ64_64;
     type_arguments: [];
-  }
+  };
 
   export namespace builder {
     export function add(