@sentio/sdk 1.8.2 → 1.10.0

package/src/builtin/internal/erc20bytes_processor.ts

@@ -1,7 +1,7 @@
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-import { CallOverrides } from "ethers";
+import { BigNumber, CallOverrides } from "ethers";
 import { Networkish } from "@ethersproject/providers";
 import {
   addContractByABI,
@@ -18,6 +18,7 @@ import {
   ContractView,
   DummyProvider,
   getContractName,
+  TypedCallTrace,
 } from "@sentio/sdk";
 import { PromiseOrValue } from "./common";
 import { ERC20Bytes, ERC20Bytes__factory } from "./index";
@@ -27,6 +28,70 @@ import {
   TransferEvent,
   TransferEventFilter,
 } from "./ERC20Bytes";
+
+export interface NameCallObject {}
+
+export type NameCallTrace = TypedCallTrace<[], NameCallObject>;
+
+export interface ApproveCallObject {
+  spender: string;
+  value: BigNumber;
+}
+
+export type ApproveCallTrace = TypedCallTrace<
+  [string, BigNumber],
+  ApproveCallObject
+>;
+
+export interface TotalSupplyCallObject {}
+
+export type TotalSupplyCallTrace = TypedCallTrace<[], TotalSupplyCallObject>;
+
+export interface TransferFromCallObject {
+  from: string;
+  to: string;
+  value: BigNumber;
+}
+
+export type TransferFromCallTrace = TypedCallTrace<
+  [string, string, BigNumber],
+  TransferFromCallObject
+>;
+
+export interface DecimalsCallObject {}
+
+export type DecimalsCallTrace = TypedCallTrace<[], DecimalsCallObject>;
+
+export interface BalanceOfCallObject {
+  who: string;
+}
+
+export type BalanceOfCallTrace = TypedCallTrace<[string], BalanceOfCallObject>;
+
+export interface SymbolCallObject {}
+
+export type SymbolCallTrace = TypedCallTrace<[], SymbolCallObject>;
+
+export interface TransferCallObject {
+  to: string;
+  value: BigNumber;
+}
+
+export type TransferCallTrace = TypedCallTrace<
+  [string, BigNumber],
+  TransferCallObject
+>;
+
+export interface AllowanceCallObject {
+  owner: string;
+  spender: string;
+}
+
+export type AllowanceCallTrace = TypedCallTrace<
+  [string, string],
+  AllowanceCallObject
+>;
+
 const templateContract = ERC20Bytes__factory.connect("", DummyProvider);
 
 export class ERC20BytesContractView extends ContractView<ERC20Bytes> {
@@ -251,7 +316,7 @@ export class ERC20BytesProcessorTemplate extends BaseProcessorTemplate<
     return processor;
   }
 
-  onApproval(
+  onEventApproval(
     handler: (event: ApprovalEvent, ctx: ERC20BytesContext) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[]
   ) {
@@ -265,7 +330,7 @@ export class ERC20BytesProcessorTemplate extends BaseProcessorTemplate<
     return super.onEvent(handler, filter);
   }
 
-  onTransfer(
+  onEventTransfer(
     handler: (event: TransferEvent, ctx: ERC20BytesContext) => void,
     filter?: TransferEventFilter | TransferEventFilter[]
   ) {
@@ -278,13 +343,65 @@ export class ERC20BytesProcessorTemplate extends BaseProcessorTemplate<
     }
     return super.onEvent(handler, filter);
   }
+
+  onCallName(handler: (call: NameCallTrace, ctx: ERC20BytesContext) => void) {
+    return super.onTrace("0x06fdde03", handler);
+  }
+
+  onCallApprove(
+    handler: (call: ApproveCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x095ea7b3", handler);
+  }
+
+  onCallTotalSupply(
+    handler: (call: TotalSupplyCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x18160ddd", handler);
+  }
+
+  onCallTransferFrom(
+    handler: (call: TransferFromCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x23b872dd", handler);
+  }
+
+  onCallDecimals(
+    handler: (call: DecimalsCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x313ce567", handler);
+  }
+
+  onCallBalanceOf(
+    handler: (call: BalanceOfCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x70a08231", handler);
+  }
+
+  onCallSymbol(
+    handler: (call: SymbolCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x95d89b41", handler);
+  }
+
+  onCallTransfer(
+    handler: (call: TransferCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0xa9059cbb", handler);
+  }
+
+  onCallAllowance(
+    handler: (call: AllowanceCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0xdd62ed3e", handler);
+  }
 }
 
 export class ERC20BytesProcessor extends BaseProcessor<
   ERC20Bytes,
   ERC20BytesBoundContractView
 > {
-  onApproval(
+  onEventApproval(
     handler: (event: ApprovalEvent, ctx: ERC20BytesContext) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[]
   ) {
@@ -298,7 +415,7 @@ export class ERC20BytesProcessor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
-  onTransfer(
+  onEventTransfer(
     handler: (event: TransferEvent, ctx: ERC20BytesContext) => void,
     filter?: TransferEventFilter | TransferEventFilter[]
   ) {
@@ -312,6 +429,58 @@ export class ERC20BytesProcessor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
+  onCallName(handler: (call: NameCallTrace, ctx: ERC20BytesContext) => void) {
+    return super.onTrace("0x06fdde03", handler);
+  }
+
+  onCallApprove(
+    handler: (call: ApproveCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x095ea7b3", handler);
+  }
+
+  onCallTotalSupply(
+    handler: (call: TotalSupplyCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x18160ddd", handler);
+  }
+
+  onCallTransferFrom(
+    handler: (call: TransferFromCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x23b872dd", handler);
+  }
+
+  onCallDecimals(
+    handler: (call: DecimalsCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x313ce567", handler);
+  }
+
+  onCallBalanceOf(
+    handler: (call: BalanceOfCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x70a08231", handler);
+  }
+
+  onCallSymbol(
+    handler: (call: SymbolCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0x95d89b41", handler);
+  }
+
+  onCallTransfer(
+    handler: (call: TransferCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0xa9059cbb", handler);
+  }
+
+  onCallAllowance(
+    handler: (call: AllowanceCallTrace, ctx: ERC20BytesContext) => void
+  ) {
+    return super.onTrace("0xdd62ed3e", handler);
+  }
+
   public static filters = templateContract.filters;
 
   protected CreateBoundContractView(): ERC20BytesBoundContractView {

package/src/builtin/internal/weth9_processor.ts

@@ -1,7 +1,7 @@
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-import { CallOverrides } from "ethers";
+import { BigNumber, CallOverrides } from "ethers";
 import { Networkish } from "@ethersproject/providers";
 import {
   addContractByABI,
@@ -18,6 +18,7 @@ import {
   ContractView,
   DummyProvider,
   getContractName,
+  TypedCallTrace,
 } from "@sentio/sdk";
 import { PromiseOrValue } from "./common";
 import { WETH9, WETH9__factory } from "./index";
@@ -31,6 +32,75 @@ import {
   WithdrawalEvent,
   WithdrawalEventFilter,
 } from "./WETH9";
+
+export interface NameCallObject {}
+
+export type NameCallTrace = TypedCallTrace<[], NameCallObject>;
+
+export interface ApproveCallObject {
+  guy: string;
+  wad: BigNumber;
+}
+
+export type ApproveCallTrace = TypedCallTrace<
+  [string, BigNumber],
+  ApproveCallObject
+>;
+
+export interface TotalSupplyCallObject {}
+
+export type TotalSupplyCallTrace = TypedCallTrace<[], TotalSupplyCallObject>;
+
+export interface TransferFromCallObject {
+  src: string;
+  dst: string;
+  wad: BigNumber;
+}
+
+export type TransferFromCallTrace = TypedCallTrace<
+  [string, string, BigNumber],
+  TransferFromCallObject
+>;
+
+export interface WithdrawCallObject {
+  wad: BigNumber;
+}
+
+export type WithdrawCallTrace = TypedCallTrace<[BigNumber], WithdrawCallObject>;
+
+export interface DecimalsCallObject {}
+
+export type DecimalsCallTrace = TypedCallTrace<[], DecimalsCallObject>;
+
+export interface BalanceOfCallObject {}
+
+export type BalanceOfCallTrace = TypedCallTrace<[string], BalanceOfCallObject>;
+
+export interface SymbolCallObject {}
+
+export type SymbolCallTrace = TypedCallTrace<[], SymbolCallObject>;
+
+export interface TransferCallObject {
+  dst: string;
+  wad: BigNumber;
+}
+
+export type TransferCallTrace = TypedCallTrace<
+  [string, BigNumber],
+  TransferCallObject
+>;
+
+export interface DepositCallObject {}
+
+export type DepositCallTrace = TypedCallTrace<[], DepositCallObject>;
+
+export interface AllowanceCallObject {}
+
+export type AllowanceCallTrace = TypedCallTrace<
+  [string, string],
+  AllowanceCallObject
+>;
+
 const templateContract = WETH9__factory.connect("", DummyProvider);
 
 export class WETH9ContractView extends ContractView<WETH9> {
@@ -252,7 +322,7 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
     return processor;
   }
 
-  onApproval(
+  onEventApproval(
     handler: (event: ApprovalEvent, ctx: WETH9Context) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[]
   ) {
@@ -266,7 +336,7 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
     return super.onEvent(handler, filter);
   }
 
-  onTransfer(
+  onEventTransfer(
     handler: (event: TransferEvent, ctx: WETH9Context) => void,
     filter?: TransferEventFilter | TransferEventFilter[]
   ) {
@@ -280,7 +350,7 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
     return super.onEvent(handler, filter);
   }
 
-  onDeposit(
+  onEventDeposit(
     handler: (event: DepositEvent, ctx: WETH9Context) => void,
     filter?: DepositEventFilter | DepositEventFilter[]
   ) {
@@ -290,7 +360,7 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
     return super.onEvent(handler, filter);
   }
 
-  onWithdrawal(
+  onEventWithdrawal(
     handler: (event: WithdrawalEvent, ctx: WETH9Context) => void,
     filter?: WithdrawalEventFilter | WithdrawalEventFilter[]
   ) {
@@ -302,13 +372,71 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
     }
     return super.onEvent(handler, filter);
   }
+
+  onCallName(handler: (call: NameCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x06fdde03", handler);
+  }
+
+  onCallApprove(handler: (call: ApproveCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x095ea7b3", handler);
+  }
+
+  onCallTotalSupply(
+    handler: (call: TotalSupplyCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x18160ddd", handler);
+  }
+
+  onCallTransferFrom(
+    handler: (call: TransferFromCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x23b872dd", handler);
+  }
+
+  onCallWithdraw(
+    handler: (call: WithdrawCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x2e1a7d4d", handler);
+  }
+
+  onCallDecimals(
+    handler: (call: DecimalsCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x313ce567", handler);
+  }
+
+  onCallBalanceOf(
+    handler: (call: BalanceOfCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x70a08231", handler);
+  }
+
+  onCallSymbol(handler: (call: SymbolCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x95d89b41", handler);
+  }
+
+  onCallTransfer(
+    handler: (call: TransferCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0xa9059cbb", handler);
+  }
+
+  onCallDeposit(handler: (call: DepositCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0xd0e30db0", handler);
+  }
+
+  onCallAllowance(
+    handler: (call: AllowanceCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0xdd62ed3e", handler);
+  }
 }
 
 export class WETH9Processor extends BaseProcessor<
   WETH9,
   WETH9BoundContractView
 > {
-  onApproval(
+  onEventApproval(
     handler: (event: ApprovalEvent, ctx: WETH9Context) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[]
   ) {
@@ -322,7 +450,7 @@ export class WETH9Processor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
-  onTransfer(
+  onEventTransfer(
     handler: (event: TransferEvent, ctx: WETH9Context) => void,
     filter?: TransferEventFilter | TransferEventFilter[]
   ) {
@@ -336,7 +464,7 @@ export class WETH9Processor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
-  onDeposit(
+  onEventDeposit(
     handler: (event: DepositEvent, ctx: WETH9Context) => void,
     filter?: DepositEventFilter | DepositEventFilter[]
   ) {
@@ -346,7 +474,7 @@ export class WETH9Processor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
-  onWithdrawal(
+  onEventWithdrawal(
     handler: (event: WithdrawalEvent, ctx: WETH9Context) => void,
     filter?: WithdrawalEventFilter | WithdrawalEventFilter[]
   ) {
@@ -359,6 +487,64 @@ export class WETH9Processor extends BaseProcessor<
     return super.onEvent(handler, filter);
   }
 
+  onCallName(handler: (call: NameCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x06fdde03", handler);
+  }
+
+  onCallApprove(handler: (call: ApproveCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x095ea7b3", handler);
+  }
+
+  onCallTotalSupply(
+    handler: (call: TotalSupplyCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x18160ddd", handler);
+  }
+
+  onCallTransferFrom(
+    handler: (call: TransferFromCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x23b872dd", handler);
+  }
+
+  onCallWithdraw(
+    handler: (call: WithdrawCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x2e1a7d4d", handler);
+  }
+
+  onCallDecimals(
+    handler: (call: DecimalsCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x313ce567", handler);
+  }
+
+  onCallBalanceOf(
+    handler: (call: BalanceOfCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0x70a08231", handler);
+  }
+
+  onCallSymbol(handler: (call: SymbolCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0x95d89b41", handler);
+  }
+
+  onCallTransfer(
+    handler: (call: TransferCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0xa9059cbb", handler);
+  }
+
+  onCallDeposit(handler: (call: DepositCallTrace, ctx: WETH9Context) => void) {
+    return super.onTrace("0xd0e30db0", handler);
+  }
+
+  onCallAllowance(
+    handler: (call: AllowanceCallTrace, ctx: WETH9Context) => void
+  ) {
+    return super.onTrace("0xdd62ed3e", handler);
+  }
+
   public static filters = templateContract.filters;
 
   protected CreateBoundContractView(): WETH9BoundContractView {

package/src/context.ts

@@ -28,6 +28,7 @@ export class EthContext extends BaseContext {
     this.chainId = chainId
     this.log = log
     this.block = block
+    this.trace = trace
     if (log) {
       this.blockNumber = Long.fromNumber(log.blockNumber)
     } else if (block) {

package/src/index.ts

@@ -12,6 +12,7 @@ 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'
 

package/src/target-ethers-sentio/codegen.ts

@@ -9,6 +9,7 @@ import {
 import { reservedKeywords } from '@typechain/ethers-v5/dist/codegen/reserved-keywords'
 import { generateInputTypes } from '@typechain/ethers-v5/dist/codegen/types'
 import { getFullSignatureForEvent } from 'typechain/dist/utils/signatures'
+import { codegenCallTraceTypes, codegenFunctions } from './functions'
 
 export function codeGenIndex(contract: Contract): string {
   return ` 
@@ -19,6 +20,8 @@ export function codeGenIndex(contract: Contract): string {
 
 export function codeGenSentioFile(contract: Contract): string {
   const source = `
+  ${Object.values(contract.functions).map(codegenCallTraceTypes).join('\n')}
+
   const templateContract = ${contract.name}__factory.connect("", DummyProvider)
 
   export class ${contract.name}ContractView extends ContractView<${contract.name}> {
@@ -70,6 +73,10 @@ export function codeGenSentioFile(contract: Contract): string {
         }
       })
       .join('\n')}
+    
+    ${Object.values(contract.functions)
+      .map((f) => codegenFunctions(f, contract.name))
+      .join('\n')}
     }
 
     export class ${contract.name}Processor extends BaseProcessor<${contract.name}, ${contract.name}BoundContractView> {
@@ -83,6 +90,10 @@ export function codeGenSentioFile(contract: Contract): string {
         })
         .join('\n')}
 
+      ${Object.values(contract.functions)
+        .map((f) => codegenFunctions(f, contract.name))
+        .join('\n')}
+
     public static filters = templateContract.filters
     
     protected CreateBoundContractView(): ${contract.name}BoundContractView {
@@ -134,6 +145,7 @@ export function codeGenSentioFile(contract: Contract): string {
         'ContractView',
         'DummyProvider',
         'getContractName',
+        'TypedCallTrace',
       ],
       './common': ['PromiseOrValue'],
       './index': [`${contract.name}`, `${contract.name}__factory`],
@@ -208,7 +220,7 @@ function generateOnEventFunction(event: EventDeclaration, contractName: string,
   const filterName = getFullSignatureForEvent(event)
 
   return `
-  on${eventName}(
+  onEvent${eventName}(
     handler: (event: ${eventName}Event, ctx: ${contractName}Context) => void,
     filter?: ${eventName}EventFilter | ${eventName}EventFilter[]
   ) {

package/src/target-ethers-sentio/functions.ts

@@ -0,0 +1,68 @@
+import {
+  generateOutputComplexTypeAsArray,
+  generateOutputComplexTypesAsObject,
+} from '@typechain/ethers-v5/dist/codegen/types'
+import { FunctionDeclaration, getSignatureForFn } from 'typechain'
+import { utils } from 'ethers'
+
+export function codegenFunctions(fns: FunctionDeclaration[], contractName: string): string {
+  if (fns.length === 1) {
+    return generateFunction(fns[0], contractName)
+  }
+
+  return fns.map((fn) => generateFunction(fn, contractName, getFullSignatureAsSymbolForFunction(fn))).join('\n')
+}
+
+export function codegenCallTraceTypes(fns: FunctionDeclaration[]): string {
+  if (fns.length === 1) {
+    return codegenCallTraceType(fns[0])
+  }
+
+  return fns.map((fn) => codegenCallTraceType(fn, getFullSignatureAsSymbolForFunction(fn))).join('\n')
+}
+
+function codegenCallTraceType(fn: FunctionDeclaration, overloadedName?: string): string {
+  const identifier = capitalizeFirstChar(overloadedName ?? fn.name)
+
+  const components = fn.inputs.map((input, i) => ({ name: input.name ?? `arg${i.toString()}`, type: input.type }))
+  const arrayOutput = generateOutputComplexTypeAsArray(components, { useStructs: true })
+  const objectOutput = generateOutputComplexTypesAsObject(components, { useStructs: true }) || '{}'
+
+  return `
+  export interface ${identifier}CallObject ${objectOutput}
+    
+  export type ${identifier}CallTrace = TypedCallTrace<${arrayOutput}, ${identifier}CallObject>
+  `
+}
+
+function generateFunction(fn: FunctionDeclaration, contractName: string, overloadedName?: string): string {
+  const signature = getSignatureForFn(fn)
+  const sighash = utils.keccak256(utils.toUtf8Bytes(signature)).substring(0, 10)
+
+  return `
+  onCall${capitalizeFirstChar(overloadedName ?? fn.name)}(
+    handler: (call: ${capitalizeFirstChar(overloadedName ?? fn.name)}CallTrace, ctx: ${contractName}Context) => void
+  ) {
+    return super.onTrace("${sighash}", handler);
+  }
+`
+}
+
+function getFullSignatureAsSymbolForFunction(fn: FunctionDeclaration): string {
+  return `${fn.name}_${fn.inputs
+    .map((e) => {
+      if (e.type.type === 'array') {
+        return e.type.itemType.originalType + '_array'
+      } else {
+        return e.type.originalType
+      }
+    })
+    .join('_')}`
+}
+
+function capitalizeFirstChar(input: string): string {
+  if (!input) {
+    return input
+  }
+  return input[0].toUpperCase() + (input.length > 1 ? input.substring(1) : '')
+}

package/src/test/erc20-template.ts

@@ -5,7 +5,7 @@ export const filter = ERC20Processor.filters.Transfer(
   '0xb329e39ebefd16f40d38f07643652ce17ca5bac1'
 )
 
-const processorTemplate = new ERC20ProcessorTemplate().onTransfer(async function (event, ctx) {
+const processorTemplate = new ERC20ProcessorTemplate().onEventTransfer(async function (event, ctx) {
   console.log('')
 })
 
@@ -14,7 +14,7 @@ ERC20Processor.bind({
   network: 1,
   name: 'x2y2',
   startBlock: 14201940,
-}).onTransfer(async function (event, ctx) {
+}).onEventTransfer(async function (event, ctx) {
   processorTemplate.bind({
     address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
     network: 3,