@sentio/sdk 1.7.14 → 1.7.17

package/package.json

@@ -1,7 +1,24 @@
 {
   "name": "@sentio/sdk",
   "license": "Apache-2.0",
-  "version": "1.7.14",
+  "version": "1.7.17",
+  "scripts": {
+    "compile_target": "yarn tsc -b src/target-ethers-sentio/tsconfig.json",
+    "compile": "tsc -p . && cp src/cli/webpack.config.js lib/cli",
+    "build": "yarn gen && yarn compile",
+    "start_ts": "ts-node --files src/processor-runner.ts ../examples/x2y2/src/processor.ts",
+    "start_ts_solana": "ts-node --files src/processor-runner.ts ../examples/mirrorworld/src/processor.ts",
+    "start": "ts-node --files src/processor-runner.ts ../examples/x2y2/dist/lib.js",
+    "start_js": "node lib/processor.js ../examples/x2y2/dist/lib.js",
+    "ts-start": "ts-node --files src/processor-runner.ts ./src/anyswap/src/processor.ts",
+    "cli": "yarn build && node lib/cli/cli.js",
+    "test": "jest",
+    "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"
+  },
   "dependencies": {
     "@ethersproject/providers": "~5.7.0",
     "@project-serum/anchor": "^0.25.0",
@@ -27,11 +44,35 @@
     "webpack": "^5.72.1",
     "webpack-cli": "^4.9.2"
   },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/command-line-args": "^5.2.0",
+    "@types/command-line-usage": "^5.0.2",
+    "@types/expect": "^24.3.0",
+    "@types/fs-extra": "^9.0.13",
+    "@types/google-protobuf": "^3.15.6",
+    "@types/jest": "^29.0.0",
+    "@types/js-yaml": "^4.0.5",
+    "@types/mkdirp": "^1.0.2",
+    "@types/node": "^18.0.4",
+    "chai": "^4.3.6",
+    "clean-publish": "^4.0.1",
+    "jest": "^28.0.1",
+    "semantic-release": "^19.0.5",
+    "ts-jest": "^28.0.8",
+    "ts-node": "^10.8.0",
+    "tsconfig-paths": "^4.0.0",
+    "typescript": "^4.8.0"
+  },
   "bin": {
-    "processor-runner": "./processor-runner.js",
-    "sentio": "./cli/cli.js"
+    "processor-runner": "./lib/processor-runner.js",
+    "sentio": "./lib/cli/cli.js"
   },
-  "main": "./index.js",
-  "types": "./index.d.js",
-  "module": "./index.js"
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "module": "./lib/index.js",
+  "files": [
+    "lib/**/*",
+    "src/**/*"
+  ]
 }

package/src/abis/erc20.json

@@ -0,0 +1,198 @@
+[
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      }
+    ],
+    "name": "allowance",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transfer",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]

package/src/abis/weth9.json

@@ -0,0 +1,153 @@
+[
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [{ "name": "", "type": "string" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "guy", "type": "address" },
+      { "name": "wad", "type": "uint256" }
+    ],
+    "name": "approve",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "src", "type": "address" },
+      { "name": "dst", "type": "address" },
+      { "name": "wad", "type": "uint256" }
+    ],
+    "name": "transferFrom",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [{ "name": "wad", "type": "uint256" }],
+    "name": "withdraw",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [{ "name": "", "type": "uint8" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [{ "name": "", "type": "address" }],
+    "name": "balanceOf",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [{ "name": "", "type": "string" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "dst", "type": "address" },
+      { "name": "wad", "type": "uint256" }
+    ],
+    "name": "transfer",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "deposit",
+    "outputs": [],
+    "payable": true,
+    "stateMutability": "payable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      { "name": "", "type": "address" },
+      { "name": "", "type": "address" }
+    ],
+    "name": "allowance",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  { "payable": true, "stateMutability": "payable", "type": "fallback" },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "src", "type": "address" },
+      { "indexed": true, "name": "guy", "type": "address" },
+      { "indexed": false, "name": "wad", "type": "uint256" }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "src", "type": "address" },
+      { "indexed": true, "name": "dst", "type": "address" },
+      { "indexed": false, "name": "wad", "type": "uint256" }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "dst", "type": "address" },
+      { "indexed": false, "name": "wad", "type": "uint256" }
+    ],
+    "name": "Deposit",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "src", "type": "address" },
+      { "indexed": false, "name": "wad", "type": "uint256" }
+    ],
+    "name": "Withdrawal",
+    "type": "event"
+  }
+]

package/src/base-processor-template.ts

@@ -0,0 +1,92 @@
+import { BoundContractView, Context, ContractView } from './context'
+import { Block } from '@ethersproject/abstract-provider'
+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 Long from 'long'
+import { getNetwork } from '@ethersproject/providers'
+import { PromiseOrVoid } from './promise-or-void'
+
+export abstract class BaseProcessorTemplate<
+  TContract extends BaseContract,
+  TBoundContractView extends BoundContractView<TContract, ContractView<TContract>>
+> {
+  id: number
+  binds = new Set<string>()
+  blockHandlers: ((block: Block, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid)[] = []
+  eventHandlers: {
+    handler: (event: Event, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid
+    filter: EventFilter | EventFilter[]
+  }[] = []
+
+  constructor() {
+    this.id = global.PROCESSOR_STATE.templates.length
+    global.PROCESSOR_STATE.templates.push(this)
+  }
+
+  public bind(options: BindOptions) {
+    const sig = getOptionsSignature(options)
+    if (this.binds.has(sig)) {
+      return
+    }
+    this.binds.add(sig)
+
+    const processor = this.bindInternal(options)
+
+    for (const eh of this.eventHandlers) {
+      processor.onEvent(eh.handler, eh.filter)
+    }
+    for (const bh of this.blockHandlers) {
+      processor.onBlock(bh)
+    }
+
+    const instance: TemplateInstance = {
+      templateId: this.id,
+      contract: {
+        address: options.address,
+        name: options.name || '',
+        chainId: options.network ? getNetwork(options.network).chainId.toString() : '1',
+        abi: '',
+      },
+      startBlock: Long.ZERO,
+      endBlock: Long.ZERO,
+    }
+    if (options.startBlock) {
+      if (typeof options.startBlock === 'number') {
+        instance.startBlock = Long.fromNumber(options.startBlock)
+      } else {
+        instance.startBlock = options.startBlock
+      }
+    }
+    if (options.endBlock) {
+      if (typeof options.endBlock === 'number') {
+        instance.endBlock = Long.fromNumber(options.endBlock)
+      } else {
+        instance.endBlock = options.endBlock
+      }
+    }
+    global.PROCESSOR_STATE.templatesInstances.push(instance)
+
+    return processor
+  }
+
+  public onEvent(
+    handler: (event: Event, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid,
+    filter: EventFilter | EventFilter[]
+  ) {
+    this.eventHandlers.push({
+      handler: handler,
+      filter: filter,
+    })
+    return this
+  }
+
+  public onBlock(handler: (block: Block, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid) {
+    this.blockHandlers.push(handler)
+    return this
+  }
+
+  protected abstract bindInternal(options: BindOptions): BaseProcessor<TContract, TBoundContractView>
+}

package/src/base-processor.ts

@@ -0,0 +1,128 @@
+import { Event } from '@ethersproject/contracts'
+import { BytesLike } from '@ethersproject/bytes'
+import { Block, Log, getNetwork } from '@ethersproject/providers'
+import { BaseContract, EventFilter } from '@ethersproject/contracts'
+import Long from 'long'
+
+import { BoundContractView, Context, ContractView } from './context'
+import { O11yResult } from './gen/processor/protos/processor'
+import { BindInternalOptions, BindOptions } from './bind-options'
+import { PromiseOrVoid } from './promise-or-void'
+
+export class EventsHandler {
+  filters: EventFilter[]
+  handler: (event: Log) => Promise<O11yResult>
+}
+
+export abstract class BaseProcessor<
+  TContract extends BaseContract,
+  TBoundContractView extends BoundContractView<TContract, ContractView<TContract>>
+> {
+  blockHandlers: ((block: Block) => Promise<O11yResult>)[] = []
+  eventHandlers: EventsHandler[] = []
+
+  name: string
+  config: BindInternalOptions
+
+  constructor(config: BindOptions) {
+    this.config = {
+      address: config.address,
+      name: config.name || '',
+      network: config.network ? config.network : 1,
+      startBlock: new Long(0),
+    }
+    if (config.startBlock) {
+      if (typeof config.startBlock === 'number') {
+        this.config.startBlock = Long.fromNumber(config.startBlock)
+      } else {
+        this.config.startBlock = config.startBlock
+      }
+    }
+    if (config.endBlock) {
+      if (typeof config.endBlock === 'number') {
+        this.config.endBlock = Long.fromNumber(config.endBlock)
+      } else {
+        this.config.endBlock = config.endBlock
+      }
+    }
+  }
+
+  protected abstract CreateBoundContractView(): TBoundContractView
+
+  public getChainId(): number {
+    return getNetwork(this.config.network).chainId
+  }
+
+  public onEvent(
+    handler: (event: Event, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid,
+    filter: EventFilter | EventFilter[]
+  ) {
+    const chainId = this.getChainId()
+
+    let _filters: EventFilter[] = []
+
+    if (Array.isArray(filter)) {
+      _filters = filter
+    } else {
+      _filters.push(filter)
+    }
+
+    const contractView = this.CreateBoundContractView()
+    this.eventHandlers.push({
+      filters: _filters,
+      handler: async function (log) {
+        const ctx = new Context<TContract, TBoundContractView>(contractView, chainId, undefined, log)
+        // let event: Event = <Event>deepCopy(log);
+        const event: Event = <Event>log
+        const parsed = contractView.rawContract.interface.parseLog(log)
+        if (parsed) {
+          event.args = parsed.args
+          event.decode = (data: BytesLike, topics?: Array<any>) => {
+            return contractView.rawContract.interface.decodeEventLog(parsed.eventFragment, data, topics)
+          }
+          event.event = parsed.name
+          event.eventSignature = parsed.signature
+
+          // TODO fix this bug
+          await handler(event, ctx)
+          return {
+            gauges: ctx.gauges,
+            counters: ctx.counters,
+          }
+        }
+        return {
+          gauges: [],
+          counters: [],
+        }
+      },
+    })
+    return this
+  }
+
+  public onBlock(handler: (block: Block, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid) {
+    const chainId = this.getChainId()
+    const contractView = this.CreateBoundContractView()
+
+    this.blockHandlers.push(async function (block: Block) {
+      const ctx = new Context<TContract, TBoundContractView>(contractView, chainId, block, undefined)
+      await handler(block, ctx)
+      return {
+        gauges: ctx.gauges,
+        counters: ctx.counters,
+      }
+    })
+    return this
+  }
+
+  public onAllEvents(handler: (event: Log, ctx: Context<TContract, TBoundContractView>) => PromiseOrVoid) {
+    const _filters: EventFilter[] = []
+    const tmpContract = this.CreateBoundContractView()
+
+    for (const key in tmpContract.filters) {
+      _filters.push(tmpContract.filters[key]())
+    }
+    return this.onEvent(function (log, ctx) {
+      return handler(log, ctx)
+    }, _filters)
+  }
+}

package/src/bind-options.ts

@@ -0,0 +1,41 @@
+import { Networkish } from '@ethersproject/networks'
+import Long from 'long'
+import { getNetwork } from '@ethersproject/providers'
+
+export class BindOptions {
+  address: string
+  network?: Networkish = 1
+  name?: string
+  startBlock?: Long | number
+  endBlock?: Long | number
+}
+
+export function getOptionsSignature(opts: BindOptions): string {
+  const sig = [opts.address]
+  if (opts.network) {
+    sig.push(getNetwork(opts.network).chainId.toString())
+  }
+  if (opts.name) {
+    sig.push(opts.name)
+  }
+  if (opts.startBlock) {
+    sig.push(opts.startBlock.toString())
+  }
+  if (opts.endBlock) {
+    sig.push(opts.endBlock.toString())
+  }
+  return sig.join('_')
+}
+
+export class BindInternalOptions {
+  address: string
+  network: Networkish
+  name: string
+  startBlock: Long
+  endBlock?: Long
+}
+
+export class SolanaBindOptions extends BindOptions {
+  declare network?: string
+  processInnerInstruction?: boolean
+}