@sentio/sdk 1.17.2 → 1.18.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sentio/sdk",
   "license": "Apache-2.0",
-  "version": "1.17.2",
+  "version": "1.18.1",
   "scripts": {
     "compile_target": "yarn tsc -b src/target-ethers-sentio/tsconfig.json",
     "compile": "tsc -p . && cp src/cli/webpack.config.js lib/cli && cp src/utils/*.csv lib/utils",
@@ -15,8 +15,9 @@
     "gen": "yarn compile_target && yarn gen_bultin_evm && yarn gen_test_abi",
     "gen_test_abi": "yarn gen_solana_abi",
     "gen_bultin_evm": "typechain --target lib/target-ethers-sentio --out-dir src/builtin/internal 'src/abis/*.json'",
-    "gen_solana_abi": "ts-node src/cli/solana-code-gen.ts src/test types",
-    "postbuild": "echo || clear-package-json package.json -o ./lib/package.json && cp release.config.js ./lib"
+    "gen_solana_abi": "ts-node src/cli/solana-code-gen.ts src/tests types",
+    "postbuild": "echo || clear-package-json package.json -o ./lib/package.json && cp release.config.js ./lib",
+    "docs": "typedoc --options typedoc.json"
   },
   "dependencies": {
     "@ethersproject/providers": "~5.7.0",
@@ -63,6 +64,7 @@
     "ts-jest": "^29.0.0",
     "ts-node": "^10.8.0",
     "tsconfig-paths": "^4.0.0",
+    "typedoc": "^0.23.15",
     "typescript": "^4.8.0"
   },
   "bin": {

package/src/binds.ts

@@ -1,8 +1,7 @@
-import { BindOptions, getOptionsSignature } from './bind-options'
-import { BaseProcessor } from './base-processor'
+import { BindOptions, getOptionsSignature } from './core/bind-options'
+import { BaseProcessor, ContractView } from './core'
 import { Networkish } from '@ethersproject/networks'
 import { getNetwork } from '@ethersproject/providers'
-import { ContractView } from './context'
 import { BaseContract } from 'ethers'
 import { ContractNamer } from './contract-namer'
 

package/src/builtin/eacaggregatorproxy/test-utils.ts

@@ -27,7 +27,7 @@ export function mockAnswerUpdatedLog(
   const contract = getEACAggregatorProxyContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("AnswerUpdated"),
-    Object.values(event)
+    [event.current, event.roundId, event.updatedAt]
   );
   return {
     ...mockField,
@@ -44,7 +44,7 @@ export function mockNewRoundLog(
   const contract = getEACAggregatorProxyContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("NewRound"),
-    Object.values(event)
+    [event.roundId, event.startedBy, event.startedAt]
   );
   return {
     ...mockField,
@@ -61,7 +61,7 @@ export function mockOwnershipTransferRequestedLog(
   const contract = getEACAggregatorProxyContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("OwnershipTransferRequested"),
-    Object.values(event)
+    [event.from, event.to]
   );
   return {
     ...mockField,
@@ -78,7 +78,7 @@ export function mockOwnershipTransferredLog(
   const contract = getEACAggregatorProxyContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("OwnershipTransferred"),
-    Object.values(event)
+    [event.from, event.to]
   );
   return {
     ...mockField,

package/src/builtin/erc20/test-utils.ts

@@ -26,7 +26,7 @@ export function mockApprovalLog(
   const contract = getERC20Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Approval"),
-    Object.values(event)
+    [event.owner, event.spender, event.value]
   );
   return {
     ...mockField,
@@ -43,7 +43,7 @@ export function mockOwnershipTransferredLog(
   const contract = getERC20Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("OwnershipTransferred"),
-    Object.values(event)
+    [event.previousOwner, event.newOwner]
   );
   return {
     ...mockField,
@@ -60,7 +60,7 @@ export function mockTransferLog(
   const contract = getERC20Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Transfer"),
-    Object.values(event)
+    [event.from, event.to, event.value]
   );
   return {
     ...mockField,

package/src/builtin/erc20bytes/test-utils.ts

@@ -25,7 +25,7 @@ export function mockApprovalLog(
   const contract = getERC20BytesContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Approval"),
-    Object.values(event)
+    [event.owner, event.spender, event.value]
   );
   return {
     ...mockField,
@@ -42,7 +42,7 @@ export function mockTransferLog(
   const contract = getERC20BytesContract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Transfer"),
-    Object.values(event)
+    [event.from, event.to, event.value]
   );
   return {
     ...mockField,

package/src/builtin/index.ts

@@ -0,0 +1,5 @@
+export * as eacaggregatorproxy from './eacaggregatorproxy'
+export * as erc20 from './erc20'
+export * as erc20bytes from './erc20bytes'
+export * as weth9 from './weth9'
+export * as solana from './solana'

package/src/{solana/builtin → builtin/solana}/spl-token-processor.ts

@@ -1,8 +1,6 @@
-import { SolanaBaseProcessor } from '../../solana-processor'
-import { SolanaContext } from '../../context'
+import { SolanaBaseProcessor, SolanaContext, SolanaBindOptions } from '@sentio/sdk'
 import { Instruction } from '@project-serum/anchor'
 import { AmountToUiAmount, Approve, ApproveChecked, Burn, BurnChecked, CloseAccount, CreateNativeMint, DefaultAccountStateExtension, FreezeAccount, GetAccountDataSize, InitializeAccount, InitializeAccount2, InitializeAccount3, InitializeImmutableOwner, InitializeMint, InitializeMintCloseAuthority, InitializeMultisig, MemoTransferExtension, MintTo, MintToChecked, Reallocate, Revoke, SyncNative, ThawAccount, Transfer, TransferChecked, TransferFeeExtension, UiAmountToAmount } from './types';
-import { SolanaBindOptions } from '../../bind-options';
 
 export class SPLTokenProcessor extends SolanaBaseProcessor {
   static bind(options: SolanaBindOptions): SPLTokenProcessor {

package/src/{solana/builtin → builtin/solana}/wormhole-processor.ts

@@ -1,6 +1,4 @@
-import { SolanaBaseProcessor } from '../../solana-processor'
-import { SolanaContext } from '../../context'
-import { SolanaBindOptions } from '../../bind-options'
+import { SolanaBaseProcessor, SolanaContext, SolanaBindOptions } from '@sentio/sdk'
 import { Instruction } from '@project-serum/anchor'
 import * as borsh from '@project-serum/borsh'
 import bs58 from 'bs58'

package/src/builtin/weth9/test-utils.ts

@@ -27,7 +27,7 @@ export function mockApprovalLog(
   const contract = getWETH9Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Approval"),
-    Object.values(event)
+    [event.src, event.guy, event.wad]
   );
   return {
     ...mockField,
@@ -44,7 +44,7 @@ export function mockTransferLog(
   const contract = getWETH9Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Transfer"),
-    Object.values(event)
+    [event.src, event.dst, event.wad]
   );
   return {
     ...mockField,
@@ -61,7 +61,7 @@ export function mockDepositLog(
   const contract = getWETH9Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Deposit"),
-    Object.values(event)
+    [event.dst, event.wad]
   );
   return {
     ...mockField,
@@ -78,7 +78,7 @@ export function mockWithdrawalLog(
   const contract = getWETH9Contract(contractAddress);
   const encodedLog = contract.rawContract.interface.encodeEventLog(
     contract.rawContract.interface.getEvent("Withdrawal"),
-    Object.values(event)
+    [event.src, event.wad]
   );
   return {
     ...mockField,

package/src/cli/webpack.config.js

@@ -36,7 +36,7 @@ module.exports = {
       if (/^@(ethersproject|solana|project-serum).*$/.test(request)) {
         return callback(null, 'commonjs ' + request)
       }
-      if (request.startsWith("@sentio/sdk")) {
+      if (request.startsWith("@sentio")) {
         return callback(null, 'commonjs2 ' + request)
       }
       callback()

package/src/{aptos-processor.ts → core/aptos-processor.ts}

@@ -1,6 +1,6 @@
 import { AptosBindOptions } from './bind-options'
 import { AptosContext } from './context'
-import { ProcessResult } from './index'
+import { ProcessResult } from '..'
 import Long from 'long'
 
 type IndexConfigure = {
@@ -11,6 +11,7 @@ type IndexConfigure = {
 export class AptosBaseProcessor {
   public transactionHanlder: (transaction: any, ctx: AptosContext) => void
   address: string
+  name: string
   config: IndexConfigure = { startSeqNumber: new Long(0) }
 
   constructor(options: AptosBindOptions) {
@@ -22,6 +23,7 @@ export class AptosBaseProcessor {
 
   bind(options: AptosBindOptions) {
     this.address = options.address
+    this.name = options.name || this.address
     if (options.startBlock) {
       this.startSlot(options.startBlock)
     }
@@ -40,8 +42,8 @@ export class AptosBaseProcessor {
     return this
   }
 
-  public handleTransaction(txn: any): ProcessResult | null {
-    const ctx = new AptosContext(this.address)
+  public handleTransaction(txn: any, slot: Long): ProcessResult | null {
+    const ctx = new AptosContext(this.address, slot)
 
     if (txn) {
       this.transactionHanlder(txn, ctx)

package/src/{base-processor-template.ts → core/base-processor-template.ts}

@@ -4,10 +4,10 @@ import { BaseContract, EventFilter } from 'ethers'
 import { Event } from '@ethersproject/contracts'
 import { BaseProcessor } from './base-processor'
 import { BindOptions, getOptionsSignature } from './bind-options'
-import { TemplateInstance } from './gen/processor/protos/processor'
+import { TemplateInstance } from '../gen/processor/protos/processor'
 import Long from 'long'
 import { getNetwork } from '@ethersproject/providers'
-import { PromiseOrVoid } from './promise-or-void'
+import { PromiseOrVoid } from '../promise-or-void'
 import { Trace } from './trace'
 
 export abstract class BaseProcessorTemplate<

package/src/{base-processor.ts → core/base-processor.ts}

@@ -5,9 +5,9 @@ import { BaseContract, EventFilter } from '@ethersproject/contracts'
 import Long from 'long'
 
 import { BoundContractView, Context, ContractView } from './context'
-import { ProcessResult } from './gen/processor/protos/processor'
+import { ProcessResult } from '../gen/processor/protos/processor'
 import { BindInternalOptions, BindOptions } from './bind-options'
-import { PromiseOrVoid } from './promise-or-void'
+import { PromiseOrVoid } from '../promise-or-void'
 import { Trace } from './trace'
 
 export class EventsHandler {

package/src/{context.ts → core/context.ts}

@@ -1,4 +1,4 @@
-import { CounterResult, GaugeResult, LogResult } from './gen/processor/protos/processor'
+import { CounterResult, GaugeResult, LogResult } from '../gen/processor/protos/processor'
 import { BaseContract, EventFilter } from 'ethers'
 import { Block, Log } from '@ethersproject/abstract-provider'
 import { Meter } from './meter'
@@ -31,13 +31,13 @@ export class EthContext extends BaseContext {
     this.block = block
     this.trace = trace
     if (log) {
-      this.blockNumber = Long.fromNumber(log.blockNumber)
+      this.blockNumber = Long.fromNumber(log.blockNumber, true)
       this.transactionHash = log.transactionHash
     } else if (block) {
-      this.blockNumber = Long.fromNumber(block.number)
+      this.blockNumber = Long.fromNumber(block.number, true)
     }
     if (trace) {
-      this.blockNumber = Long.fromNumber(trace.blockNumber)
+      this.blockNumber = Long.fromNumber(trace.blockNumber, true)
       this.transactionHash = trace.transactionHash
     }
   }
@@ -100,27 +100,33 @@ export class BoundContractView<TContract extends BaseContract, TContractView ext
 
 export class SolanaContext extends BaseContext {
   address: string
+  blockNumber: Long
 
-  constructor(address: string) {
+  constructor(address: string, slot: Long) {
     super()
     this.address = address
+    this.blockNumber = slot
   }
 }
 
 export class SuiContext extends BaseContext {
   address: string
+  blockNumber: Long
 
-  constructor(address: string) {
+  constructor(address: string, slot: Long) {
     super()
     this.address = address
+    this.blockNumber = slot
   }
 }
 
 export class AptosContext extends BaseContext {
   address: string
+  blockNumber: Long
 
-  constructor(address: string) {
+  constructor(address: string, slot: Long) {
     super()
     this.address = address
+    this.blockNumber = slot
   }
 }

package/src/{test → core}/generic-processor.test.ts

@@ -4,9 +4,8 @@ import { expect } from 'chai'
 
 import { HandlerType } from '..'
 
-import { GenericProcessor } from '../generic-processor'
-import { TestProcessorServer } from './test-processor-server'
-import { firstCounterValue } from './metric-utils'
+import { GenericProcessor } from './generic-processor'
+import { TestProcessorServer, firstCounterValue } from '../testing'
 
 describe('Test Generic Processor', () => {
   const service = new TestProcessorServer(() => {

package/src/{generic-processor.ts → core/generic-processor.ts}

@@ -2,8 +2,8 @@ import { BaseContract } from '@ethersproject/contracts'
 import { BoundContractView, ContractView } from './context'
 import { BindOptions } from './bind-options'
 import { BaseProcessor } from './base-processor'
-import { getProvider } from './provider'
-import { addProcessor, getContractName } from './binds'
+import { getProvider } from '../provider'
+import { addProcessor, getContractName } from '../binds'
 
 export class GenericProcessor extends BaseProcessor<
   BaseContract,

package/src/core/index.ts

@@ -0,0 +1,15 @@
+export { BigNumber as BigDecimal } from 'bignumber.js'
+export { Context, ContractView, BoundContractView, SolanaContext } from './context'
+export { CounterBinding, Meter, GaugeBinding, Counter, Gauge, MetricDescriptorOption } from './meter'
+export { type Numberish, toBigInteger, toMetricValue } from './numberish'
+
+export { BindOptions, SolanaBindOptions, SuiBindOptions, AptosBindOptions } from './bind-options'
+
+export { BaseProcessor } from './base-processor'
+export { GenericProcessor } from './generic-processor'
+export { BaseProcessorTemplate } from './base-processor-template'
+export { SolanaBaseProcessor } from './solana-processor'
+export { SuiBaseProcessor } from './sui-processor'
+export { AptosBaseProcessor } from './aptos-processor'
+
+export type { TypedCallTrace, Trace } from './trace'

package/src/{meter.ts → core/meter.ts}

@@ -1,7 +1,7 @@
-import { MetricDescriptor, RecordMetaData } from './gen/processor/protos/processor'
+import { MetricDescriptor, RecordMetaData } from '../gen/processor/protos/processor'
 import { AptosContext, BaseContext, Context, SolanaContext, SuiContext } from './context'
 import { toMetricValue, Numberish } from './numberish'
-import Long from 'long'
+import { APTOS_TESTNET_ID, SOL_MAINMET_ID, SUI_DEVNET_ID } from '../utils/chain'
 
 export function normalizeName(name: string): string {
   const regex = new RegExp('![_.a-zA-Z0-9]')
@@ -40,7 +40,7 @@ function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): Re
     if (ctx.log) {
       return {
         contractAddress: ctx.contract.rawContract.address,
-        blockNumber: Long.fromNumber(ctx.log.blockNumber, true), // TODO need number type to be long
+        blockNumber: ctx.blockNumber,
         transactionIndex: ctx.log.transactionIndex,
         transactionHash: ctx.transactionHash || '',
         logIndex: ctx.log.logIndex,
@@ -52,7 +52,7 @@ function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): Re
     if (ctx.block) {
       return {
         contractAddress: ctx.contract.rawContract.address,
-        blockNumber: Long.fromNumber(ctx.block.number, true),
+        blockNumber: ctx.blockNumber,
         transactionIndex: -1,
         transactionHash: '',
         logIndex: -1,
@@ -64,7 +64,7 @@ function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): Re
     if (ctx.trace) {
       return {
         contractAddress: ctx.contract.rawContract.address,
-        blockNumber: Long.fromNumber(ctx.trace.blockNumber, true),
+        blockNumber: ctx.blockNumber,
         transactionIndex: ctx.trace.transactionPosition,
         transactionHash: ctx.transactionHash || '',
         logIndex: -1,
@@ -76,33 +76,33 @@ function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): Re
   } else if (ctx instanceof SolanaContext) {
     return {
       contractAddress: ctx.address,
-      blockNumber: Long.ZERO, // TODO need number type to be long
+      blockNumber: ctx.blockNumber,
       transactionIndex: 0,
       transactionHash: '', // TODO add
       logIndex: 0,
-      chainId: 'SOL_mainnet', // TODO set in context
+      chainId: SOL_MAINMET_ID, // TODO set in context
       descriptor: descriptor,
       labels: normalizeLabels(labels),
     }
   } else if (ctx instanceof SuiContext) {
     return {
       contractAddress: ctx.address,
-      blockNumber: Long.ZERO, // TODO need number type to be long
+      blockNumber: ctx.blockNumber,
       transactionIndex: 0,
       transactionHash: '', // TODO
       logIndex: 0,
-      chainId: 'SUI_devnet', // TODO set in context
+      chainId: SUI_DEVNET_ID, // TODO set in context
       descriptor: descriptor,
       labels: normalizeLabels(labels),
     }
   } else if (ctx instanceof AptosContext) {
     return {
       contractAddress: ctx.address,
-      blockNumber: Long.ZERO, // TODO need number type to be long
+      blockNumber: ctx.blockNumber,
       transactionIndex: 0,
       transactionHash: '', // TODO
       logIndex: 0,
-      chainId: 'aptos_devnet', // TODO set in context
+      chainId: APTOS_TESTNET_ID, // TODO set in context
       descriptor: descriptor,
       labels: normalizeLabels(labels),
     }

package/src/{numberish.test.ts → core/numberish.test.ts}

@@ -3,8 +3,8 @@ import { toBigInteger, toMetricValue } from './numberish'
 import { webcrypto } from 'crypto'
 import { BigNumber } from 'ethers'
 import { performance } from 'perf_hooks'
-import { BigInteger } from './gen/processor/protos/processor'
-import { BigDecimal } from './index'
+import { BigInteger } from '../gen/processor/protos/processor'
+import { BigDecimal } from '.'
 
 // TODO add test for type conversion
 describe('Numberish tests', () => {

package/src/{numberish.ts → core/numberish.ts}

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers'
-import { BigInteger, MetricValue } from './gen/processor/protos/processor'
+import { BigInteger, MetricValue } from '../gen/processor/protos/processor'
 import { BigDecimal } from '.'
 import { BN } from '@project-serum/anchor'
 

package/src/{solana-processor.ts → core/solana-processor.ts}

@@ -1,4 +1,4 @@
-import { ProcessResult } from './gen/processor/protos/processor'
+import { ProcessResult } from '../gen/processor/protos/processor'
 import { SolanaContext } from './context'
 import Long from 'long'
 import { Instruction } from '@project-serum/anchor'
@@ -54,8 +54,8 @@ export class SolanaBaseProcessor {
     return this
   }
 
-  public handleInstruction(ins: string | { type: string; info: any }): ProcessResult | null {
-    const ctx = new SolanaContext(this.address)
+  public handleInstruction(ins: string | { type: string; info: any }, slot: Long): ProcessResult | null {
+    const ctx = new SolanaContext(this.address, slot)
     let parsedInstruction: Instruction | null = null
 
     if (ins) {

package/src/{sui-processor.ts → core/sui-processor.ts}

@@ -1,6 +1,6 @@
 import { SuiBindOptions } from './bind-options'
 import { SuiContext } from './context'
-import { ProcessResult } from './index'
+import { ProcessResult } from '..'
 import Long from 'long'
 
 type IndexConfigure = {
@@ -40,8 +40,8 @@ export class SuiBaseProcessor {
     return this
   }
 
-  public handleTransaction(txn: any): ProcessResult | null {
-    const ctx = new SuiContext(this.address)
+  public handleTransaction(txn: any, slot: Long): ProcessResult | null {
+    const ctx = new SuiContext(this.address, slot)
 
     if (txn) {
       this.transactionHanlder(txn, ctx)

package/src/error.ts

@@ -1,5 +1,5 @@
 // Transform error in more readable format
-import { Context } from './context'
+import { Context } from './core/context'
 import { errors } from 'ethers'
 
 export class EthersError extends Error {

package/src/index.ts

@@ -1,23 +1,11 @@
-export { BaseProcessor } from './base-processor'
-export { GenericProcessor } from './generic-processor'
-export { BaseProcessorTemplate } from './base-processor-template'
-export { Context, ContractView, BoundContractView, SolanaContext } from './context'
 export { ProcessorServiceImpl } from './service'
-export { CounterBinding, Meter, GaugeBinding, Counter, Gauge, MetricDescriptorOption } from './meter'
 export { getProvider, setProvider, DummyProvider } from './provider'
-export { SolanaBaseProcessor } from './solana-processor'
-export { SuiBaseProcessor } from './sui-processor'
-export { AptosBaseProcessor } from './aptos-processor'
 export { ContractNamer } from './contract-namer'
-export { BindOptions, SolanaBindOptions, SuiBindOptions, AptosBindOptions } from './bind-options'
 export { transformEtherError } from './error'
 export { ProcessorState } from './processor-state'
-export { BigNumber as BigDecimal } from 'bignumber.js'
 export { EthersError } from './error'
-export type { TypedCallTrace } from './trace'
 
 export { getProcessor, addProcessor, getContractByABI, addContractByABI, getContractName } from './binds'
 
 export * from './gen/processor/protos/processor'
-
-export { SPLTokenProcessor } from './solana/builtin'
+export * from './core'

package/src/processor-state.ts

@@ -1,12 +1,15 @@
-import { BaseProcessor } from './base-processor'
+import {
+  BaseProcessor,
+  BoundContractView,
+  ContractView,
+  BaseProcessorTemplate,
+  SolanaBaseProcessor,
+  SuiBaseProcessor,
+  AptosBaseProcessor,
+} from './core'
 import { BaseContract } from 'ethers'
-import { BoundContractView, ContractView } from './context'
-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'
-import { AptosBaseProcessor } from './aptos-processor'
 
 export class ProcessorState {
   // from abiName_address_chainId => contract wrapper