@sentio/sdk 1.26.0 → 1.26.2

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

@@ -144,6 +144,7 @@ export interface ProcessConfigResponse {
   accountConfigs: AccountConfig[];
   metricConfigs: MetricConfig[];
   eventTrackingConfigs: EventTrackingConfig[];
+  exportConfigs: ExportConfig[];
 }
 
 export interface ContractConfig {
@@ -212,6 +213,43 @@ export interface EventTrackingConfig {
   retentionConfig: RetentionConfig | undefined;
 }
 
+export interface ExportConfig {
+  exportName: string;
+  exportType: ExportConfig_ExportType;
+  exportUrl: string;
+}
+
+export enum ExportConfig_ExportType {
+  WEBHOOK = 0,
+  UNRECOGNIZED = -1,
+}
+
+export function exportConfig_ExportTypeFromJSON(
+  object: any
+): ExportConfig_ExportType {
+  switch (object) {
+    case 0:
+    case "WEBHOOK":
+      return ExportConfig_ExportType.WEBHOOK;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return ExportConfig_ExportType.UNRECOGNIZED;
+  }
+}
+
+export function exportConfig_ExportTypeToJSON(
+  object: ExportConfig_ExportType
+): string {
+  switch (object) {
+    case ExportConfig_ExportType.WEBHOOK:
+      return "WEBHOOK";
+    case ExportConfig_ExportType.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
 export interface MetricConfig {
   name: string;
   description: string;
@@ -367,6 +405,7 @@ export interface ProcessResult {
   counters: CounterResult[];
   logs: LogResult[];
   events: EventTrackingResult[];
+  exports: ExportResult[];
 }
 
 export interface DataDescriptor {
@@ -438,6 +477,12 @@ export interface EventTrackingResult {
   runtimeInfo: RuntimeInfo | undefined;
 }
 
+export interface ExportResult {
+  metadata: RecordMetaData | undefined;
+  payload: string;
+  runtimeInfo: RuntimeInfo | undefined;
+}
+
 function createBaseProjectConfig(): ProjectConfig {
   return { name: "", version: "" };
 }
@@ -552,6 +597,7 @@ function createBaseProcessConfigResponse(): ProcessConfigResponse {
     accountConfigs: [],
     metricConfigs: [],
     eventTrackingConfigs: [],
+    exportConfigs: [],
   };
 }
 
@@ -578,6 +624,9 @@ export const ProcessConfigResponse = {
     for (const v of message.eventTrackingConfigs) {
       EventTrackingConfig.encode(v!, writer.uint32(50).fork()).ldelim();
     }
+    for (const v of message.exportConfigs) {
+      ExportConfig.encode(v!, writer.uint32(58).fork()).ldelim();
+    }
     return writer;
   },
 
@@ -619,6 +668,11 @@ export const ProcessConfigResponse = {
             EventTrackingConfig.decode(reader, reader.uint32())
           );
           break;
+        case 7:
+          message.exportConfigs.push(
+            ExportConfig.decode(reader, reader.uint32())
+          );
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -649,6 +703,9 @@ export const ProcessConfigResponse = {
             EventTrackingConfig.fromJSON(e)
           )
         : [],
+      exportConfigs: Array.isArray(object?.exportConfigs)
+        ? object.exportConfigs.map((e: any) => ExportConfig.fromJSON(e))
+        : [],
     };
   },
 
@@ -693,6 +750,13 @@ export const ProcessConfigResponse = {
     } else {
       obj.eventTrackingConfigs = [];
     }
+    if (message.exportConfigs) {
+      obj.exportConfigs = message.exportConfigs.map((e) =>
+        e ? ExportConfig.toJSON(e) : undefined
+      );
+    } else {
+      obj.exportConfigs = [];
+    }
     return obj;
   },
 
@@ -717,6 +781,8 @@ export const ProcessConfigResponse = {
       object.eventTrackingConfigs?.map((e) =>
         EventTrackingConfig.fromPartial(e)
       ) || [];
+    message.exportConfigs =
+      object.exportConfigs?.map((e) => ExportConfig.fromPartial(e)) || [];
     return message;
   },
 };
@@ -1229,6 +1295,79 @@ export const EventTrackingConfig = {
   },
 };
 
+function createBaseExportConfig(): ExportConfig {
+  return { exportName: "", exportType: 0, exportUrl: "" };
+}
+
+export const ExportConfig = {
+  encode(
+    message: ExportConfig,
+    writer: _m0.Writer = _m0.Writer.create()
+  ): _m0.Writer {
+    if (message.exportName !== "") {
+      writer.uint32(10).string(message.exportName);
+    }
+    if (message.exportType !== 0) {
+      writer.uint32(16).int32(message.exportType);
+    }
+    if (message.exportUrl !== "") {
+      writer.uint32(26).string(message.exportUrl);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ExportConfig {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseExportConfig();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.exportName = reader.string();
+          break;
+        case 2:
+          message.exportType = reader.int32() as any;
+          break;
+        case 3:
+          message.exportUrl = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ExportConfig {
+    return {
+      exportName: isSet(object.exportName) ? String(object.exportName) : "",
+      exportType: isSet(object.exportType)
+        ? exportConfig_ExportTypeFromJSON(object.exportType)
+        : 0,
+      exportUrl: isSet(object.exportUrl) ? String(object.exportUrl) : "",
+    };
+  },
+
+  toJSON(message: ExportConfig): unknown {
+    const obj: any = {};
+    message.exportName !== undefined && (obj.exportName = message.exportName);
+    message.exportType !== undefined &&
+      (obj.exportType = exportConfig_ExportTypeToJSON(message.exportType));
+    message.exportUrl !== undefined && (obj.exportUrl = message.exportUrl);
+    return obj;
+  },
+
+  fromPartial(object: DeepPartial<ExportConfig>): ExportConfig {
+    const message = createBaseExportConfig();
+    message.exportName = object.exportName ?? "";
+    message.exportType = object.exportType ?? 0;
+    message.exportUrl = object.exportUrl ?? "";
+    return message;
+  },
+};
+
 function createBaseMetricConfig(): MetricConfig {
   return {
     name: "",
@@ -3370,7 +3509,7 @@ export const RawBlock = {
 };
 
 function createBaseProcessResult(): ProcessResult {
-  return { gauges: [], counters: [], logs: [], events: [] };
+  return { gauges: [], counters: [], logs: [], events: [], exports: [] };
 }
 
 export const ProcessResult = {
@@ -3390,6 +3529,9 @@ export const ProcessResult = {
     for (const v of message.events) {
       EventTrackingResult.encode(v!, writer.uint32(34).fork()).ldelim();
     }
+    for (const v of message.exports) {
+      ExportResult.encode(v!, writer.uint32(42).fork()).ldelim();
+    }
     return writer;
   },
 
@@ -3414,6 +3556,9 @@ export const ProcessResult = {
             EventTrackingResult.decode(reader, reader.uint32())
           );
           break;
+        case 5:
+          message.exports.push(ExportResult.decode(reader, reader.uint32()));
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -3436,6 +3581,9 @@ export const ProcessResult = {
       events: Array.isArray(object?.events)
         ? object.events.map((e: any) => EventTrackingResult.fromJSON(e))
         : [],
+      exports: Array.isArray(object?.exports)
+        ? object.exports.map((e: any) => ExportResult.fromJSON(e))
+        : [],
     };
   },
 
@@ -3467,6 +3615,13 @@ export const ProcessResult = {
     } else {
       obj.events = [];
     }
+    if (message.exports) {
+      obj.exports = message.exports.map((e) =>
+        e ? ExportResult.toJSON(e) : undefined
+      );
+    } else {
+      obj.exports = [];
+    }
     return obj;
   },
 
@@ -3479,6 +3634,8 @@ export const ProcessResult = {
     message.logs = object.logs?.map((e) => LogResult.fromPartial(e)) || [];
     message.events =
       object.events?.map((e) => EventTrackingResult.fromPartial(e)) || [];
+    message.exports =
+      object.exports?.map((e) => ExportResult.fromPartial(e)) || [];
     return message;
   },
 };
@@ -4504,6 +4661,98 @@ export const EventTrackingResult = {
   },
 };
 
+function createBaseExportResult(): ExportResult {
+  return { metadata: undefined, payload: "", runtimeInfo: undefined };
+}
+
+export const ExportResult = {
+  encode(
+    message: ExportResult,
+    writer: _m0.Writer = _m0.Writer.create()
+  ): _m0.Writer {
+    if (message.metadata !== undefined) {
+      RecordMetaData.encode(
+        message.metadata,
+        writer.uint32(10).fork()
+      ).ldelim();
+    }
+    if (message.payload !== "") {
+      writer.uint32(18).string(message.payload);
+    }
+    if (message.runtimeInfo !== undefined) {
+      RuntimeInfo.encode(
+        message.runtimeInfo,
+        writer.uint32(26).fork()
+      ).ldelim();
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ExportResult {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseExportResult();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.metadata = RecordMetaData.decode(reader, reader.uint32());
+          break;
+        case 2:
+          message.payload = reader.string();
+          break;
+        case 3:
+          message.runtimeInfo = RuntimeInfo.decode(reader, reader.uint32());
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ExportResult {
+    return {
+      metadata: isSet(object.metadata)
+        ? RecordMetaData.fromJSON(object.metadata)
+        : undefined,
+      payload: isSet(object.payload) ? String(object.payload) : "",
+      runtimeInfo: isSet(object.runtimeInfo)
+        ? RuntimeInfo.fromJSON(object.runtimeInfo)
+        : undefined,
+    };
+  },
+
+  toJSON(message: ExportResult): unknown {
+    const obj: any = {};
+    message.metadata !== undefined &&
+      (obj.metadata = message.metadata
+        ? RecordMetaData.toJSON(message.metadata)
+        : undefined);
+    message.payload !== undefined && (obj.payload = message.payload);
+    message.runtimeInfo !== undefined &&
+      (obj.runtimeInfo = message.runtimeInfo
+        ? RuntimeInfo.toJSON(message.runtimeInfo)
+        : undefined);
+    return obj;
+  },
+
+  fromPartial(object: DeepPartial<ExportResult>): ExportResult {
+    const message = createBaseExportResult();
+    message.metadata =
+      object.metadata !== undefined && object.metadata !== null
+        ? RecordMetaData.fromPartial(object.metadata)
+        : undefined;
+    message.payload = object.payload ?? "";
+    message.runtimeInfo =
+      object.runtimeInfo !== undefined && object.runtimeInfo !== null
+        ? RuntimeInfo.fromPartial(object.runtimeInfo)
+        : undefined;
+    return message;
+  },
+};
+
 export type ProcessorDefinition = typeof ProcessorDefinition;
 export const ProcessorDefinition = {
   name: "Processor",

package/src/processor-state.ts

@@ -15,6 +15,7 @@ import { Provider } from '@ethersproject/providers'
 import { EventTracker } from './core'
 import { Metric } from './core/meter'
 import { AptosAccountProcessor } from './aptos/aptos-processor'
+import { Exporter } from './core/exporter'
 
 export class ProcessorState {
   // from abiName_address_chainId => contract wrapper
@@ -39,5 +40,7 @@ export class ProcessorState {
 
   eventTrackers: EventTracker[] = []
 
+  exporters: Exporter[] = []
+
   metrics: Metric[] = []
 }

package/src/service.ts

@@ -10,6 +10,7 @@ import {
   ContractConfig,
   DataBinding,
   EventTrackingConfig,
+  ExportConfig,
   HandlerType,
   LogFilter,
   LogHandlerConfig,
@@ -57,6 +58,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
   private templateInstances: TemplateInstance[]
   private metricConfigs: MetricConfig[]
   private eventTrackingConfigs: EventTrackingConfig[]
+  private exportConfigs: ExportConfig[]
   private readonly loader: () => void
 
   private readonly shutdownHandler?: () => void
@@ -74,10 +76,11 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       // TODO project setting
       config: undefined,
       contractConfigs: this.contractConfigs,
+      accountConfigs: this.accountConfigs,
       templateInstances: this.templateInstances,
       eventTrackingConfigs: this.eventTrackingConfigs,
       metricConfigs: this.metricConfigs,
-      accountConfigs: this.accountConfigs,
+      exportConfigs: this.exportConfigs,
     }
   }
 
@@ -91,6 +94,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
     this.templateInstances = [...global.PROCESSOR_STATE.templatesInstances]
     this.eventTrackingConfigs = []
     this.metricConfigs = []
+    this.exportConfigs = []
 
     // part 0, prepare metrics and event tracking configs
     for (const metric of global.PROCESSOR_STATE.metrics) {
@@ -110,6 +114,14 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       })
     }
 
+    for (const exporter of global.PROCESSOR_STATE.exporters) {
+      this.exportConfigs.push({
+        exportName: exporter.exportName,
+        exportType: exporter.options.exportType,
+        exportUrl: exporter.options.exportUrl,
+      })
+    }
+
     // Part 1, prepare EVM processors
     for (const processor of global.PROCESSOR_STATE.processors) {
       // If server favor incremental update this need to change
@@ -720,28 +732,19 @@ function mergeProcessResults(results: ProcessResult[]): ProcessResult {
     res.gauges = res.gauges.concat(r.gauges)
     res.logs = res.logs.concat(r.logs)
     res.events = res.events.concat(r.events)
+    res.exports = res.exports.concat(r.exports)
   }
   return res
 }
 
 function recordRuntimeInfo(results: ProcessResult, handlerType: HandlerType) {
-  results.gauges.forEach((e) => {
-    e.runtimeInfo = {
-      from: handlerType,
-    }
-  })
-
-  results.counters.forEach((e) => {
-    e.runtimeInfo = {
-      from: handlerType,
-    }
-  })
-
-  results.logs.forEach((e) => {
-    e.runtimeInfo = {
-      from: handlerType,
-    }
-  })
+  for (const list of [results.gauges, results.counters, results.logs, results.events, results.exports]) {
+    list.forEach((e) => {
+      e.runtimeInfo = {
+        from: handlerType,
+      }
+    })
+  }
 }
 
 function errorString(e: Error): string {

package/src/tests/erc20.ts

@@ -1,5 +1,7 @@
 import { ERC20Processor, ERC20ProcessorTemplate } from '../builtin/erc20'
 import { EventTracker } from '../core/event-tracker'
+import { Exporter } from '../core/exporter'
+import { ExportConfig_ExportType } from '@sentio/sdk'
 
 export const filter = ERC20Processor.filters.Transfer(
   '0x0000000000000000000000000000000000000000',
@@ -7,6 +9,10 @@ export const filter = ERC20Processor.filters.Transfer(
 )
 
 const tracker = EventTracker.register('sdf')
+const exporter = Exporter.register('transfer', {
+  exportType: ExportConfig_ExportType.WEBHOOK,
+  exportUrl: 'http://localhost',
+})
 
 const processorTemplate = new ERC20ProcessorTemplate().onEventTransfer(async function (event, ctx) {
   console.log('')
@@ -34,6 +40,7 @@ ERC20Processor.bind({ address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', net
   .onEventTransfer(async function (event, ctx) {
     ctx.meter.Counter('c2').add(2)
     tracker.trackEvent(ctx, { distinctId: event.args.from })
+    exporter.emit(ctx, event)
   }, filter)
   .onBlock(async function (block, ctx) {
     ctx.meter.Gauge('g2').record(20, { k: 'v' })

package/src/tests/types/aptos/souffle.ts

@@ -98,14 +98,20 @@ export class CandyMachine extends aptos.AptosBaseProcessor {
 
 export namespace CandyMachine {
   export class ACLBox<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::CandyMachine::ACLBox";
     box: acl.ACL;
   }
 
   export class Counter<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::CandyMachine::Counter";
     counter: bigint;
   }
 
   export class Property<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::CandyMachine::Property";
     payee: Address;
     collection: string;
     token_base_name: string;
@@ -127,6 +133,8 @@ export namespace CandyMachine {
   }
 
   export class ResourceAccountCap<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::CandyMachine::ResourceAccountCap";
     cap: account.SignerCapability;
   }
 
@@ -434,10 +442,14 @@ export class SouffleChefCampaign extends aptos.AptosBaseProcessor {
 
 export namespace SouffleChefCampaign {
   export class ACLBox<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::ACLBox";
     box: acl.ACL;
   }
 
   export class BurnEnjoyEvent {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::BurnEnjoyEvent";
     owner: Address;
   }
 
@@ -448,6 +460,8 @@ export namespace SouffleChefCampaign {
   }
 
   export class BurnRule {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::BurnRule";
     token_ids: SouffleChefCampaign.CollectionId[];
     burn_amount: table.Table<SouffleChefCampaign.CollectionId, bigint>;
     total_burn_amount: bigint;
@@ -456,19 +470,27 @@ export namespace SouffleChefCampaign {
   }
 
   export class CollectionId {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::CollectionId";
     creator: Address;
     collection_name: string;
   }
 
   export class Counter<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::Counter";
     counter: bigint;
   }
 
   export class OfferRecords {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::OfferRecords";
     records: table.Table<Address, token.TokenId[]>;
   }
 
   export class Property<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::Property";
     payee: Address;
     collection: string;
     token_base_name: string;
@@ -491,6 +513,8 @@ export namespace SouffleChefCampaign {
   }
 
   export class PropertyContainer<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::PropertyContainer";
     container: table.Table<
       SouffleChefCampaign.CollectionId,
       SouffleChefCampaign.Property<T0>
@@ -498,6 +522,8 @@ export namespace SouffleChefCampaign {
   }
 
   export class PullTokenEvent {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::PullTokenEvent";
     receiver: Address;
   }
 
@@ -508,6 +534,8 @@ export namespace SouffleChefCampaign {
   }
 
   export class ResourceAccountCap<T0> {
+    static TYPE_NAME =
+      "0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807::SouffleChefCampaign::ResourceAccountCap";
     cap: account.SignerCapability;
   }