Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SimulationInterface<T>

SimulationInterface allows the simulation of ethereum transactions using Tenderly's api. This allows us to know information before executing a transaction on mainnet. For example it can simulate how much slippage is likely to be experienced when withdrawing from a vault, or how many underlying tokens the user will receive upon withdrawing share tokens.

Type parameters

Hierarchy

  • ServiceInterface<T>
    • SimulationInterface

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

chainId

chainId: 1 | 10 | 250 | 1337 | 42161

ctx

ctx: Context

events

events: Emittery<Record<string, unknown>, Record<string, unknown> & OmnipresentEventData, never>

Private simulationExecutor

simulationExecutor: SimulationExecutor = ...

Protected yearn

yearn: Yearn<T>

Methods

_deposit

  • _deposit(vault: string, token: string, amount: string, account: string, options?: ZapOptions, overrides?: CallOverrides): Promise<TransactionOutcome>

_withdraw

  • _withdraw(vault: string, token: string, amount: string, account: string, options?: ZapOptions, overrides?: CallOverrides): Promise<TransactionOutcome>

Private approve

  • approve(__namedParameters: DepositArgs): Promise<string>

deposit

Private depositNeedsApproving

  • depositNeedsApproving(__namedParameters: { depositArgs: DepositArgs; signer: JsonRpcSigner }): Promise<boolean>

  • Parameters

    • __namedParameters: { depositArgs: DepositArgs; signer: JsonRpcSigner }
      • depositArgs: DepositArgs
      • signer: JsonRpcSigner

    Returns Promise<boolean>

Private directDeposit

Private directWithdraw

Private getActionableAddress

  • getActionableAddress(__namedParameters: { toVault: string }): Promise<string>

Private getApprovalData

  • getApprovalData(__namedParameters: { depositArgs: DepositArgs; signer: JsonRpcSigner }): Promise<ApprovalData>

  • Parameters

    • __namedParameters: { depositArgs: DepositArgs; signer: JsonRpcSigner }
      • depositArgs: DepositArgs
      • signer: JsonRpcSigner

    Returns Promise<ApprovalData>

Private getEncodedInputData

  • getEncodedInputData(__namedParameters: { amount: string; toVault: string; vaultContract: VaultContract }): Promise<undefined | string>

  • Parameters

    • __namedParameters: { amount: string; toVault: string; vaultContract: VaultContract }
      • amount: string
      • toVault: string
      • vaultContract: VaultContract

    Returns Promise<undefined | string>

Private getVaultContract

  • getVaultContract(__namedParameters: { signer: JsonRpcSigner; toVault: string }): VaultContractType

  • Parameters

    • __namedParameters: { signer: JsonRpcSigner; toVault: string }
      • signer: JsonRpcSigner
      • toVault: string

    Returns VaultContractType

Private getWithdrawApprovalData

  • getWithdrawApprovalData(__namedParameters: WithdrawArgs): Promise<{ forkId: undefined; needsApproving: boolean; root: undefined } | { forkId: string; needsApproving: boolean; root: string }>

  • Parameters

    • __namedParameters: WithdrawArgs

    Returns Promise<{ forkId: undefined; needsApproving: boolean; root: undefined } | { forkId: string; needsApproving: boolean; root: string }>

Private getZapInApprovalData

  • getZapInApprovalData(__namedParameters: DepositArgs): Promise<{ needsApproving: boolean } & ApprovalData>

Private getZapInSimulationArgs

  • getZapInSimulationArgs(__namedParameters: { depositArgs: DepositArgs; vault: ZappableVault }): Promise<{ forkId?: string; simulateFn: any }>

Private getZapOutSimulationArgs

  • getZapOutSimulationArgs(__namedParameters: { token: Token; withdrawArgs: WithdrawArgs }): Promise<{ forkId?: string; simulateFn: any }>

Private getZapProtocol

  • getZapProtocol(__namedParameters: { vaultAddress: string }): ZapProtocol

Private getZappableVault

  • getZappableVault(__namedParameters: { vaultAddress: string; vaultContract: VaultContractType }): Promise<ZappableVault>

Private handleDirectSimulationDeposit

  • handleDirectSimulationDeposit(__namedParameters: DirectDepositSimulationArgs): Promise<TransactionOutcome>

Private handleZapInSimulationDeposit

  • handleZapInSimulationDeposit(__namedParameters: ZapInSimulationDepositArgs): Promise<TransactionOutcome>

Private handleZapOutSimulation

  • handleZapOutSimulation(__namedParameters: ZapOutSimulationArgs): Promise<TransactionOutcome>

Private isUnderlyingToken

  • isUnderlyingToken(__namedParameters: { address: string; vault: string }): Promise<boolean>

Private parseDepositSimulationOutcome

  • parseDepositSimulationOutcome(vault: string, token: string, amount: string, account: string, simulationOutcome: SimulationResponse): Promise<TransactionOutcome>

Private parseSimulationTargetTokenAmount

  • parseSimulationTargetTokenAmount(targetToken: string, account: string, simulationOutcome: SimulationResponse): Promise<string>

Private parseWithdrawSimulationOutcome

  • parseWithdrawSimulationOutcome(vault: string, token: string, amount: string, account: string, simulationOutcome: SimulationResponse): Promise<TransactionOutcome>

Private shouldUsePartnerService

  • shouldUsePartnerService(vault: string): boolean

withdraw

Private zapIn

Private zapOut

Generated using TypeDoc