Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IFutureVault

Hierarchy

  • Contract
    • IFutureVault

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IFutureVault(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): IFutureVault

  • Parameters

    • addressOrName: string
    • contractInterface: ContractInterface
    • Optional signerOrProvider: Signer | Provider

    Returns IFutureVault

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

  • [eventTag: string]: (...args: any[]) => void
      • (...args: any[]): void

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: { PERIOD_DURATION: any; PERIOD_DURATION(): any; PLATFORM_NAME: any; PLATFORM_NAME(): any; addRewardsToken: any; addRewardsToken(address): any; claimFYT: any; claimFYT(address,uint256): any; convertIBTToUnderlying: any; convertIBTToUnderlying(uint256): any; convertUnderlyingtoIBT: any; convertUnderlyingtoIBT(uint256): any; createFYTDelegationTo: any; createFYTDelegationTo(address,address,uint256): any; deposit: any; deposit(address,uint256): any; exitTerminatedFuture: any; exitTerminatedFuture(address): any; getClaimableFYTForPeriod: any; getClaimableFYTForPeriod(address,uint256): any; getClaimablePT: any; getClaimablePT(address): any; getControllerAddress: any; getControllerAddress(): any; getCurrentPeriodIndex: any; getCurrentPeriodIndex(): any; getFYTofPeriod: any; getFYTofPeriod(uint256): any; getFutureWalletAddress: any; getFutureWalletAddress(): any; getIBTAddress: any; getIBTAddress(): any; getNextPeriodIndex: any; getNextPeriodIndex(): any; getPTAddress: any; getPTAddress(): any; getPTPerAmountDeposited: any; getPTPerAmountDeposited(uint256): any; getPerformanceFeeFactor: any; getPerformanceFeeFactor(): any; getPremiumPerUnderlyingDeposited: any; getPremiumPerUnderlyingDeposited(uint256): any; getRewardTokenAt: any; getRewardTokenAt(uint256): any; getRewardTokensCount: any; getRewardTokensCount(): any; getRewardsRecipient: any; getRewardsRecipient(): any; getTotalDelegated: any; getTotalDelegated(address): any; getTotalUnderlyingDeposited: any; getTotalUnderlyingDeposited(): any; getUnlockableFunds: any; getUnlockableFunds(address): any; getUnrealisedYieldPerPT: any; getUnrealisedYieldPerPT(): any; getUserEarlyUnlockablePremium: any; getUserEarlyUnlockablePremium(address): any; getYieldOfPeriod: any; getYieldOfPeriod(uint256): any; harvestRewards: any; harvestRewards(): any; isRewardToken: any; isRewardToken(address): any; isTerminated: any; isTerminated(): any; pauseLiquidityTransfers: any; pauseLiquidityTransfers(): any; redeemAllVaultRewards: any; redeemAllVaultRewards(): any; redeemVaultRewards: any; redeemVaultRewards(address): any; resumeLiquidityTransfers: any; resumeLiquidityTransfers(): any; setFutureWallet: any; setFutureWallet(address): any; setRegistry: any; setRegistry(address): any; setRewardRecipient: any; setRewardRecipient(address): any; startNewPeriod: any; startNewPeriod(): any; updateUserState: any; updateUserState(address): any; withdraw: any; withdraw(address,uint256): any; withdrawFYTDelegationFrom: any; withdrawFYTDelegationFrom(address,address,uint256): any }

Type declaration

  • PERIOD_DURATION:function
    • PERIOD_DURATION(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • PERIOD_DURATION():function
    • PERIOD_DURATION()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • PLATFORM_NAME:function
    • PLATFORM_NAME(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • PLATFORM_NAME():function
    • PLATFORM_NAME()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • addRewardsToken:function
    • addRewardsToken(_token: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • addRewardsToken(address):function
    • addRewardsToken(address)(_token: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimFYT:function
    • claimFYT(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimFYT(address,uint256):function
    • claimFYT(address,uint256)(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • convertIBTToUnderlying:function
    • convertIBTToUnderlying(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertIBTToUnderlying(uint256):function
    • convertIBTToUnderlying(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertUnderlyingtoIBT:function
    • convertUnderlyingtoIBT(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertUnderlyingtoIBT(uint256):function
    • convertUnderlyingtoIBT(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • createFYTDelegationTo:function
    • createFYTDelegationTo(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • createFYTDelegationTo(address,address,uint256):function
    • createFYTDelegationTo(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • deposit:function
    • deposit(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • deposit(address,uint256):function
    • deposit(address,uint256)(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • exitTerminatedFuture:function
    • exitTerminatedFuture(_user: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • exitTerminatedFuture(address):function
    • exitTerminatedFuture(address)(_user: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • getClaimableFYTForPeriod:function
    • getClaimableFYTForPeriod(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimableFYTForPeriod(address,uint256):function
    • getClaimableFYTForPeriod(address,uint256)(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimablePT:function
    • getClaimablePT(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimablePT(address):function
    • getClaimablePT(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getControllerAddress:function
    • getControllerAddress(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getControllerAddress():function
    • getControllerAddress()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getCurrentPeriodIndex:function
    • getCurrentPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getCurrentPeriodIndex():function
    • getCurrentPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFYTofPeriod:function
    • getFYTofPeriod(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getFYTofPeriod(uint256):function
    • getFYTofPeriod(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getFutureWalletAddress:function
    • getFutureWalletAddress(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getFutureWalletAddress():function
    • getFutureWalletAddress()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getIBTAddress:function
    • getIBTAddress(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getIBTAddress():function
    • getIBTAddress()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getNextPeriodIndex:function
    • getNextPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getNextPeriodIndex():function
    • getNextPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTAddress:function
    • getPTAddress(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getPTAddress():function
    • getPTAddress()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getPTPerAmountDeposited:function
    • getPTPerAmountDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTPerAmountDeposited(uint256):function
    • getPTPerAmountDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPerformanceFeeFactor:function
    • getPerformanceFeeFactor(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPerformanceFeeFactor():function
    • getPerformanceFeeFactor()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPremiumPerUnderlyingDeposited:function
    • getPremiumPerUnderlyingDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPremiumPerUnderlyingDeposited(uint256):function
    • getPremiumPerUnderlyingDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokenAt:function
    • getRewardTokenAt(_index: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRewardTokenAt(uint256):function
    • getRewardTokenAt(uint256)(_index: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRewardTokensCount:function
    • getRewardTokensCount(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokensCount():function
    • getRewardTokensCount()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardsRecipient:function
    • getRewardsRecipient(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRewardsRecipient():function
    • getRewardsRecipient()(overrides?: CallOverrides): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getTotalDelegated:function
    • getTotalDelegated(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDelegated(address):function
    • getTotalDelegated(address)(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnderlyingDeposited:function
    • getTotalUnderlyingDeposited(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnderlyingDeposited():function
    • getTotalUnderlyingDeposited()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnlockableFunds:function
    • getUnlockableFunds(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnlockableFunds(address):function
    • getUnlockableFunds(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnrealisedYieldPerPT:function
    • getUnrealisedYieldPerPT(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnrealisedYieldPerPT():function
    • getUnrealisedYieldPerPT()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUserEarlyUnlockablePremium:function
    • getUserEarlyUnlockablePremium(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • getUserEarlyUnlockablePremium(address):function
    • getUserEarlyUnlockablePremium(address)(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • getYieldOfPeriod:function
    • getYieldOfPeriod(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getYieldOfPeriod(uint256):function
    • getYieldOfPeriod(uint256)(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • harvestRewards:function
    • harvestRewards(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • harvestRewards():function
    • harvestRewards()(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • isRewardToken:function
    • isRewardToken(_token: string, overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isRewardToken(address):function
    • isRewardToken(address)(_token: string, overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isTerminated:function
    • isTerminated(overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isTerminated():function
    • isTerminated()(overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • pauseLiquidityTransfers:function
    • pauseLiquidityTransfers(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • pauseLiquidityTransfers():function
    • pauseLiquidityTransfers()(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemAllVaultRewards:function
    • redeemAllVaultRewards(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemAllVaultRewards():function
    • redeemAllVaultRewards()(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemVaultRewards:function
    • redeemVaultRewards(_rewardToken: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _rewardToken: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemVaultRewards(address):function
    • redeemVaultRewards(address)(_rewardToken: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _rewardToken: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • resumeLiquidityTransfers:function
    • resumeLiquidityTransfers(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • resumeLiquidityTransfers():function
    • resumeLiquidityTransfers()(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setFutureWallet:function
    • setFutureWallet(_futureWallet: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _futureWallet: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setFutureWallet(address):function
    • setFutureWallet(address)(_futureWallet: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _futureWallet: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setRegistry:function
    • setRegistry(_registry: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _registry: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setRegistry(address):function
    • setRegistry(address)(_registry: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _registry: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setRewardRecipient:function
    • setRewardRecipient(_recipient: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _recipient: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • setRewardRecipient(address):function
    • setRewardRecipient(address)(_recipient: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _recipient: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • startNewPeriod:function
    • startNewPeriod(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • startNewPeriod():function
    • startNewPeriod()(overrides?: CallOverrides): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateUserState:function
    • updateUserState(_user: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateUserState(address):function
    • updateUserState(address)(_user: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdraw:function
    • withdraw(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdraw(address,uint256):function
    • withdraw(address,uint256)(_user: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawFYTDelegationFrom:function
    • withdrawFYTDelegationFrom(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawFYTDelegationFrom(address,address,uint256):function
    • withdrawFYTDelegationFrom(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { PERIOD_DURATION: any; PERIOD_DURATION(): any; PLATFORM_NAME: any; PLATFORM_NAME(): any; addRewardsToken: any; addRewardsToken(address): any; claimFYT: any; claimFYT(address,uint256): any; convertIBTToUnderlying: any; convertIBTToUnderlying(uint256): any; convertUnderlyingtoIBT: any; convertUnderlyingtoIBT(uint256): any; createFYTDelegationTo: any; createFYTDelegationTo(address,address,uint256): any; deposit: any; deposit(address,uint256): any; exitTerminatedFuture: any; exitTerminatedFuture(address): any; getClaimableFYTForPeriod: any; getClaimableFYTForPeriod(address,uint256): any; getClaimablePT: any; getClaimablePT(address): any; getControllerAddress: any; getControllerAddress(): any; getCurrentPeriodIndex: any; getCurrentPeriodIndex(): any; getFYTofPeriod: any; getFYTofPeriod(uint256): any; getFutureWalletAddress: any; getFutureWalletAddress(): any; getIBTAddress: any; getIBTAddress(): any; getNextPeriodIndex: any; getNextPeriodIndex(): any; getPTAddress: any; getPTAddress(): any; getPTPerAmountDeposited: any; getPTPerAmountDeposited(uint256): any; getPerformanceFeeFactor: any; getPerformanceFeeFactor(): any; getPremiumPerUnderlyingDeposited: any; getPremiumPerUnderlyingDeposited(uint256): any; getRewardTokenAt: any; getRewardTokenAt(uint256): any; getRewardTokensCount: any; getRewardTokensCount(): any; getRewardsRecipient: any; getRewardsRecipient(): any; getTotalDelegated: any; getTotalDelegated(address): any; getTotalUnderlyingDeposited: any; getTotalUnderlyingDeposited(): any; getUnlockableFunds: any; getUnlockableFunds(address): any; getUnrealisedYieldPerPT: any; getUnrealisedYieldPerPT(): any; getUserEarlyUnlockablePremium: any; getUserEarlyUnlockablePremium(address): any; getYieldOfPeriod: any; getYieldOfPeriod(uint256): any; harvestRewards: any; harvestRewards(): any; isRewardToken: any; isRewardToken(address): any; isTerminated: any; isTerminated(): any; pauseLiquidityTransfers: any; pauseLiquidityTransfers(): any; redeemAllVaultRewards: any; redeemAllVaultRewards(): any; redeemVaultRewards: any; redeemVaultRewards(address): any; resumeLiquidityTransfers: any; resumeLiquidityTransfers(): any; setFutureWallet: any; setFutureWallet(address): any; setRegistry: any; setRegistry(address): any; setRewardRecipient: any; setRewardRecipient(address): any; startNewPeriod: any; startNewPeriod(): any; updateUserState: any; updateUserState(address): any; withdraw: any; withdraw(address,uint256): any; withdrawFYTDelegationFrom: any; withdrawFYTDelegationFrom(address,address,uint256): any }

Type declaration

  • PERIOD_DURATION:function
    • PERIOD_DURATION(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • PERIOD_DURATION():function
    • PERIOD_DURATION()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • PLATFORM_NAME:function
    • PLATFORM_NAME(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • PLATFORM_NAME():function
    • PLATFORM_NAME()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • addRewardsToken:function
    • addRewardsToken(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • addRewardsToken(address):function
    • addRewardsToken(address)(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • claimFYT:function
    • claimFYT(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • claimFYT(address,uint256):function
    • claimFYT(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • convertIBTToUnderlying:function
    • convertIBTToUnderlying(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertIBTToUnderlying(uint256):function
    • convertIBTToUnderlying(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertUnderlyingtoIBT:function
    • convertUnderlyingtoIBT(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • convertUnderlyingtoIBT(uint256):function
    • convertUnderlyingtoIBT(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • createFYTDelegationTo:function
    • createFYTDelegationTo(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • createFYTDelegationTo(address,address,uint256):function
    • createFYTDelegationTo(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • deposit:function
    • deposit(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • deposit(address,uint256):function
    • deposit(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • exitTerminatedFuture:function
    • exitTerminatedFuture(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • exitTerminatedFuture(address):function
    • exitTerminatedFuture(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • getClaimableFYTForPeriod:function
    • getClaimableFYTForPeriod(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimableFYTForPeriod(address,uint256):function
    • getClaimableFYTForPeriod(address,uint256)(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimablePT:function
    • getClaimablePT(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimablePT(address):function
    • getClaimablePT(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getControllerAddress:function
    • getControllerAddress(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getControllerAddress():function
    • getControllerAddress()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getCurrentPeriodIndex:function
    • getCurrentPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getCurrentPeriodIndex():function
    • getCurrentPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFYTofPeriod:function
    • getFYTofPeriod(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFYTofPeriod(uint256):function
    • getFYTofPeriod(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFutureWalletAddress:function
    • getFutureWalletAddress(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFutureWalletAddress():function
    • getFutureWalletAddress()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getIBTAddress:function
    • getIBTAddress(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getIBTAddress():function
    • getIBTAddress()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getNextPeriodIndex:function
    • getNextPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getNextPeriodIndex():function
    • getNextPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTAddress:function
    • getPTAddress(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTAddress():function
    • getPTAddress()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTPerAmountDeposited:function
    • getPTPerAmountDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPTPerAmountDeposited(uint256):function
    • getPTPerAmountDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPerformanceFeeFactor:function
    • getPerformanceFeeFactor(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPerformanceFeeFactor():function
    • getPerformanceFeeFactor()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPremiumPerUnderlyingDeposited:function
    • getPremiumPerUnderlyingDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getPremiumPerUnderlyingDeposited(uint256):function
    • getPremiumPerUnderlyingDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokenAt:function
    • getRewardTokenAt(_index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokenAt(uint256):function
    • getRewardTokenAt(uint256)(_index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokensCount:function
    • getRewardTokensCount(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardTokensCount():function
    • getRewardTokensCount()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardsRecipient:function
    • getRewardsRecipient(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRewardsRecipient():function
    • getRewardsRecipient()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDelegated:function
    • getTotalDelegated(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDelegated(address):function
    • getTotalDelegated(address)(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnderlyingDeposited:function
    • getTotalUnderlyingDeposited(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnderlyingDeposited():function
    • getTotalUnderlyingDeposited()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnlockableFunds:function
    • getUnlockableFunds(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnlockableFunds(address):function
    • getUnlockableFunds(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnrealisedYieldPerPT:function
    • getUnrealisedYieldPerPT(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnrealisedYieldPerPT():function
    • getUnrealisedYieldPerPT()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUserEarlyUnlockablePremium:function
    • getUserEarlyUnlockablePremium(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUserEarlyUnlockablePremium(address):function
    • getUserEarlyUnlockablePremium(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getYieldOfPeriod:function
    • getYieldOfPeriod(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getYieldOfPeriod(uint256):function
    • getYieldOfPeriod(uint256)(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • harvestRewards:function
    • harvestRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • harvestRewards():function
    • harvestRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • isRewardToken:function
    • isRewardToken(_token: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isRewardToken(address):function
    • isRewardToken(address)(_token: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isTerminated:function
    • isTerminated(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isTerminated():function
    • isTerminated()(overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • pauseLiquidityTransfers:function
    • pauseLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • pauseLiquidityTransfers():function
    • pauseLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • redeemAllVaultRewards:function
    • redeemAllVaultRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • redeemAllVaultRewards():function
    • redeemAllVaultRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • redeemVaultRewards:function
    • redeemVaultRewards(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • redeemVaultRewards(address):function
    • redeemVaultRewards(address)(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • resumeLiquidityTransfers:function
    • resumeLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • resumeLiquidityTransfers():function
    • resumeLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setFutureWallet:function
    • setFutureWallet(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setFutureWallet(address):function
    • setFutureWallet(address)(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setRegistry:function
    • setRegistry(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setRegistry(address):function
    • setRegistry(address)(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setRewardRecipient:function
    • setRewardRecipient(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • setRewardRecipient(address):function
    • setRewardRecipient(address)(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • startNewPeriod:function
    • startNewPeriod(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • startNewPeriod():function
    • startNewPeriod()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • updateUserState:function
    • updateUserState(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • updateUserState(address):function
    • updateUserState(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • withdraw:function
    • withdraw(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • withdraw(address,uint256):function
    • withdraw(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • withdrawFYTDelegationFrom:function
    • withdrawFYTDelegationFrom(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • withdrawFYTDelegationFrom(address,address,uint256):function
    • withdrawFYTDelegationFrom(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

filters

filters: { DelegationCreated: any; DelegationRemoved: any; FundsDeposited: any; FundsWithdrawn: any; FutureWalletSet: any; LiquidityTransfersPaused: any; LiquidityTransfersResumed: any; NewPeriodStarted: any; PTSet: any; RegistrySet: any }

Type declaration

  • DelegationCreated:function
    • DelegationCreated(_delegator: null, _receiver: null, _amount: null): TypedEventFilter<[string, string, BigNumber], { _amount: BigNumber; _delegator: string; _receiver: string }>

    • Parameters

      • _delegator: null
      • _receiver: null
      • _amount: null

      Returns TypedEventFilter<[string, string, BigNumber], { _amount: BigNumber; _delegator: string; _receiver: string }>

  • DelegationRemoved:function
    • DelegationRemoved(_delegator: null, _receiver: null, _amount: null): TypedEventFilter<[string, string, BigNumber], { _amount: BigNumber; _delegator: string; _receiver: string }>

    • Parameters

      • _delegator: null
      • _receiver: null
      • _amount: null

      Returns TypedEventFilter<[string, string, BigNumber], { _amount: BigNumber; _delegator: string; _receiver: string }>

  • FundsDeposited:function
    • FundsDeposited(_user: null, _amount: null): TypedEventFilter<[string, BigNumber], { _amount: BigNumber; _user: string }>

    • Parameters

      • _user: null
      • _amount: null

      Returns TypedEventFilter<[string, BigNumber], { _amount: BigNumber; _user: string }>

  • FundsWithdrawn:function
    • FundsWithdrawn(_user: null, _amount: null): TypedEventFilter<[string, BigNumber], { _amount: BigNumber; _user: string }>

    • Parameters

      • _user: null
      • _amount: null

      Returns TypedEventFilter<[string, BigNumber], { _amount: BigNumber; _user: string }>

  • FutureWalletSet:function
    • FutureWalletSet(_futureWallet: null): TypedEventFilter<[string], { _futureWallet: string }>

    • Parameters

      • _futureWallet: null

      Returns TypedEventFilter<[string], { _futureWallet: string }>

  • LiquidityTransfersPaused:function
    • LiquidityTransfersPaused(): TypedEventFilter<[], {}>

    • Returns TypedEventFilter<[], {}>

  • LiquidityTransfersResumed:function
    • LiquidityTransfersResumed(): TypedEventFilter<[], {}>

    • Returns TypedEventFilter<[], {}>

  • NewPeriodStarted:function
    • NewPeriodStarted(_newPeriodIndex: null): TypedEventFilter<[BigNumber], { _newPeriodIndex: BigNumber }>

    • Parameters

      • _newPeriodIndex: null

      Returns TypedEventFilter<[BigNumber], { _newPeriodIndex: BigNumber }>

  • PTSet:function
    • PTSet(_pt: null): TypedEventFilter<[string], { _pt: string }>

    • Parameters

      • _pt: null

      Returns TypedEventFilter<[string], { _pt: string }>

  • RegistrySet:function
    • RegistrySet(_registry: null): TypedEventFilter<[string], { _registry: string }>

    • Parameters

      • _registry: null

      Returns TypedEventFilter<[string], { _registry: string }>

functions

functions: { PERIOD_DURATION: any; PERIOD_DURATION(): any; PLATFORM_NAME: any; PLATFORM_NAME(): any; addRewardsToken: any; addRewardsToken(address): any; claimFYT: any; claimFYT(address,uint256): any; convertIBTToUnderlying: any; convertIBTToUnderlying(uint256): any; convertUnderlyingtoIBT: any; convertUnderlyingtoIBT(uint256): any; createFYTDelegationTo: any; createFYTDelegationTo(address,address,uint256): any; deposit: any; deposit(address,uint256): any; exitTerminatedFuture: any; exitTerminatedFuture(address): any; getClaimableFYTForPeriod: any; getClaimableFYTForPeriod(address,uint256): any; getClaimablePT: any; getClaimablePT(address): any; getControllerAddress: any; getControllerAddress(): any; getCurrentPeriodIndex: any; getCurrentPeriodIndex(): any; getFYTofPeriod: any; getFYTofPeriod(uint256): any; getFutureWalletAddress: any; getFutureWalletAddress(): any; getIBTAddress: any; getIBTAddress(): any; getNextPeriodIndex: any; getNextPeriodIndex(): any; getPTAddress: any; getPTAddress(): any; getPTPerAmountDeposited: any; getPTPerAmountDeposited(uint256): any; getPerformanceFeeFactor: any; getPerformanceFeeFactor(): any; getPremiumPerUnderlyingDeposited: any; getPremiumPerUnderlyingDeposited(uint256): any; getRewardTokenAt: any; getRewardTokenAt(uint256): any; getRewardTokensCount: any; getRewardTokensCount(): any; getRewardsRecipient: any; getRewardsRecipient(): any; getTotalDelegated: any; getTotalDelegated(address): any; getTotalUnderlyingDeposited: any; getTotalUnderlyingDeposited(): any; getUnlockableFunds: any; getUnlockableFunds(address): any; getUnrealisedYieldPerPT: any; getUnrealisedYieldPerPT(): any; getUserEarlyUnlockablePremium: any; getUserEarlyUnlockablePremium(address): any; getYieldOfPeriod: any; getYieldOfPeriod(uint256): any; harvestRewards: any; harvestRewards(): any; isRewardToken: any; isRewardToken(address): any; isTerminated: any; isTerminated(): any; pauseLiquidityTransfers: any; pauseLiquidityTransfers(): any; redeemAllVaultRewards: any; redeemAllVaultRewards(): any; redeemVaultRewards: any; redeemVaultRewards(address): any; resumeLiquidityTransfers: any; resumeLiquidityTransfers(): any; setFutureWallet: any; setFutureWallet(address): any; setRegistry: any; setRegistry(address): any; setRewardRecipient: any; setRewardRecipient(address): any; startNewPeriod: any; startNewPeriod(): any; updateUserState: any; updateUserState(address): any; withdraw: any; withdraw(address,uint256): any; withdrawFYTDelegationFrom: any; withdrawFYTDelegationFrom(address,address,uint256): any }

Type declaration

  • PERIOD_DURATION:function
    • PERIOD_DURATION(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • PERIOD_DURATION():function
    • PERIOD_DURATION()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • PLATFORM_NAME:function
    • PLATFORM_NAME(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • PLATFORM_NAME():function
    • PLATFORM_NAME()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • addRewardsToken:function
    • addRewardsToken(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • addRewardsToken(address):function
    • addRewardsToken(address)(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • claimFYT:function
    • claimFYT(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • claimFYT(address,uint256):function
    • claimFYT(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • convertIBTToUnderlying:function
    • convertIBTToUnderlying(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • convertIBTToUnderlying(uint256):function
    • convertIBTToUnderlying(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • convertUnderlyingtoIBT:function
    • convertUnderlyingtoIBT(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • convertUnderlyingtoIBT(uint256):function
    • convertUnderlyingtoIBT(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • createFYTDelegationTo:function
    • createFYTDelegationTo(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • createFYTDelegationTo(address,address,uint256):function
    • createFYTDelegationTo(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • deposit:function
    • deposit(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • deposit(address,uint256):function
    • deposit(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • exitTerminatedFuture:function
    • exitTerminatedFuture(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • exitTerminatedFuture(address):function
    • exitTerminatedFuture(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • getClaimableFYTForPeriod:function
    • getClaimableFYTForPeriod(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getClaimableFYTForPeriod(address,uint256):function
    • getClaimableFYTForPeriod(address,uint256)(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getClaimablePT:function
    • getClaimablePT(_user: string, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getClaimablePT(address):function
    • getClaimablePT(address)(_user: string, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getControllerAddress:function
    • getControllerAddress(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getControllerAddress():function
    • getControllerAddress()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getCurrentPeriodIndex:function
    • getCurrentPeriodIndex(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getCurrentPeriodIndex():function
    • getCurrentPeriodIndex()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getFYTofPeriod:function
    • getFYTofPeriod(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getFYTofPeriod(uint256):function
    • getFYTofPeriod(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getFutureWalletAddress:function
    • getFutureWalletAddress(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getFutureWalletAddress():function
    • getFutureWalletAddress()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getIBTAddress:function
    • getIBTAddress(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getIBTAddress():function
    • getIBTAddress()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getNextPeriodIndex:function
    • getNextPeriodIndex(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getNextPeriodIndex():function
    • getNextPeriodIndex()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPTAddress:function
    • getPTAddress(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getPTAddress():function
    • getPTAddress()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getPTPerAmountDeposited:function
    • getPTPerAmountDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPTPerAmountDeposited(uint256):function
    • getPTPerAmountDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPerformanceFeeFactor:function
    • getPerformanceFeeFactor(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPerformanceFeeFactor():function
    • getPerformanceFeeFactor()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPremiumPerUnderlyingDeposited:function
    • getPremiumPerUnderlyingDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getPremiumPerUnderlyingDeposited(uint256):function
    • getPremiumPerUnderlyingDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getRewardTokenAt:function
    • getRewardTokenAt(_index: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRewardTokenAt(uint256):function
    • getRewardTokenAt(uint256)(_index: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRewardTokensCount:function
    • getRewardTokensCount(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getRewardTokensCount():function
    • getRewardTokensCount()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getRewardsRecipient:function
    • getRewardsRecipient(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRewardsRecipient():function
    • getRewardsRecipient()(overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getTotalDelegated:function
    • getTotalDelegated(_delegator: string, overrides?: CallOverrides): Promise<[BigNumber] & { totalDelegated: BigNumber }>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & { totalDelegated: BigNumber }>

  • getTotalDelegated(address):function
    • getTotalDelegated(address)(_delegator: string, overrides?: CallOverrides): Promise<[BigNumber] & { totalDelegated: BigNumber }>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & { totalDelegated: BigNumber }>

  • getTotalUnderlyingDeposited:function
    • getTotalUnderlyingDeposited(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalUnderlyingDeposited():function
    • getTotalUnderlyingDeposited()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUnlockableFunds:function
    • getUnlockableFunds(_user: string, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUnlockableFunds(address):function
    • getUnlockableFunds(address)(_user: string, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUnrealisedYieldPerPT:function
    • getUnrealisedYieldPerPT(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUnrealisedYieldPerPT():function
    • getUnrealisedYieldPerPT()(overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUserEarlyUnlockablePremium:function
    • getUserEarlyUnlockablePremium(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • getUserEarlyUnlockablePremium(address):function
    • getUserEarlyUnlockablePremium(address)(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • getYieldOfPeriod:function
    • getYieldOfPeriod(_periodID: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getYieldOfPeriod(uint256):function
    • getYieldOfPeriod(uint256)(_periodID: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • harvestRewards:function
    • harvestRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • harvestRewards():function
    • harvestRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • isRewardToken:function
    • isRewardToken(_token: string, overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isRewardToken(address):function
    • isRewardToken(address)(_token: string, overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isTerminated:function
    • isTerminated(overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isTerminated():function
    • isTerminated()(overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • pauseLiquidityTransfers:function
    • pauseLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • pauseLiquidityTransfers():function
    • pauseLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • redeemAllVaultRewards:function
    • redeemAllVaultRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • redeemAllVaultRewards():function
    • redeemAllVaultRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • redeemVaultRewards:function
    • redeemVaultRewards(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • redeemVaultRewards(address):function
    • redeemVaultRewards(address)(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • resumeLiquidityTransfers:function
    • resumeLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • resumeLiquidityTransfers():function
    • resumeLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setFutureWallet:function
    • setFutureWallet(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setFutureWallet(address):function
    • setFutureWallet(address)(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setRegistry:function
    • setRegistry(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setRegistry(address):function
    • setRegistry(address)(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setRewardRecipient:function
    • setRewardRecipient(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • setRewardRecipient(address):function
    • setRewardRecipient(address)(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • startNewPeriod:function
    • startNewPeriod(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • startNewPeriod():function
    • startNewPeriod()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • updateUserState:function
    • updateUserState(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • updateUserState(address):function
    • updateUserState(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • withdraw:function
    • withdraw(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • withdraw(address,uint256):function
    • withdraw(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • withdrawFYTDelegationFrom:function
    • withdrawFYTDelegationFrom(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • withdrawFYTDelegationFrom(address,address,uint256):function
    • withdrawFYTDelegationFrom(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

interface

interface: IFutureVaultInterface

populateTransaction

populateTransaction: { PERIOD_DURATION: any; PERIOD_DURATION(): any; PLATFORM_NAME: any; PLATFORM_NAME(): any; addRewardsToken: any; addRewardsToken(address): any; claimFYT: any; claimFYT(address,uint256): any; convertIBTToUnderlying: any; convertIBTToUnderlying(uint256): any; convertUnderlyingtoIBT: any; convertUnderlyingtoIBT(uint256): any; createFYTDelegationTo: any; createFYTDelegationTo(address,address,uint256): any; deposit: any; deposit(address,uint256): any; exitTerminatedFuture: any; exitTerminatedFuture(address): any; getClaimableFYTForPeriod: any; getClaimableFYTForPeriod(address,uint256): any; getClaimablePT: any; getClaimablePT(address): any; getControllerAddress: any; getControllerAddress(): any; getCurrentPeriodIndex: any; getCurrentPeriodIndex(): any; getFYTofPeriod: any; getFYTofPeriod(uint256): any; getFutureWalletAddress: any; getFutureWalletAddress(): any; getIBTAddress: any; getIBTAddress(): any; getNextPeriodIndex: any; getNextPeriodIndex(): any; getPTAddress: any; getPTAddress(): any; getPTPerAmountDeposited: any; getPTPerAmountDeposited(uint256): any; getPerformanceFeeFactor: any; getPerformanceFeeFactor(): any; getPremiumPerUnderlyingDeposited: any; getPremiumPerUnderlyingDeposited(uint256): any; getRewardTokenAt: any; getRewardTokenAt(uint256): any; getRewardTokensCount: any; getRewardTokensCount(): any; getRewardsRecipient: any; getRewardsRecipient(): any; getTotalDelegated: any; getTotalDelegated(address): any; getTotalUnderlyingDeposited: any; getTotalUnderlyingDeposited(): any; getUnlockableFunds: any; getUnlockableFunds(address): any; getUnrealisedYieldPerPT: any; getUnrealisedYieldPerPT(): any; getUserEarlyUnlockablePremium: any; getUserEarlyUnlockablePremium(address): any; getYieldOfPeriod: any; getYieldOfPeriod(uint256): any; harvestRewards: any; harvestRewards(): any; isRewardToken: any; isRewardToken(address): any; isTerminated: any; isTerminated(): any; pauseLiquidityTransfers: any; pauseLiquidityTransfers(): any; redeemAllVaultRewards: any; redeemAllVaultRewards(): any; redeemVaultRewards: any; redeemVaultRewards(address): any; resumeLiquidityTransfers: any; resumeLiquidityTransfers(): any; setFutureWallet: any; setFutureWallet(address): any; setRegistry: any; setRegistry(address): any; setRewardRecipient: any; setRewardRecipient(address): any; startNewPeriod: any; startNewPeriod(): any; updateUserState: any; updateUserState(address): any; withdraw: any; withdraw(address,uint256): any; withdrawFYTDelegationFrom: any; withdrawFYTDelegationFrom(address,address,uint256): any }

Type declaration

  • PERIOD_DURATION:function
    • PERIOD_DURATION(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • PERIOD_DURATION():function
    • PERIOD_DURATION()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • PLATFORM_NAME:function
    • PLATFORM_NAME(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • PLATFORM_NAME():function
    • PLATFORM_NAME()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • addRewardsToken:function
    • addRewardsToken(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • addRewardsToken(address):function
    • addRewardsToken(address)(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _token: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • claimFYT:function
    • claimFYT(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • claimFYT(address,uint256):function
    • claimFYT(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • convertIBTToUnderlying:function
    • convertIBTToUnderlying(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • convertIBTToUnderlying(uint256):function
    • convertIBTToUnderlying(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • convertUnderlyingtoIBT:function
    • convertUnderlyingtoIBT(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • convertUnderlyingtoIBT(uint256):function
    • convertUnderlyingtoIBT(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • createFYTDelegationTo:function
    • createFYTDelegationTo(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • createFYTDelegationTo(address,address,uint256):function
    • createFYTDelegationTo(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • deposit:function
    • deposit(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • deposit(address,uint256):function
    • deposit(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • exitTerminatedFuture:function
    • exitTerminatedFuture(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • exitTerminatedFuture(address):function
    • exitTerminatedFuture(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • getClaimableFYTForPeriod:function
    • getClaimableFYTForPeriod(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getClaimableFYTForPeriod(address,uint256):function
    • getClaimableFYTForPeriod(address,uint256)(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getClaimablePT:function
    • getClaimablePT(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getClaimablePT(address):function
    • getClaimablePT(address)(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getControllerAddress:function
    • getControllerAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getControllerAddress():function
    • getControllerAddress()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getCurrentPeriodIndex:function
    • getCurrentPeriodIndex(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getCurrentPeriodIndex():function
    • getCurrentPeriodIndex()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFYTofPeriod:function
    • getFYTofPeriod(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFYTofPeriod(uint256):function
    • getFYTofPeriod(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFutureWalletAddress:function
    • getFutureWalletAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFutureWalletAddress():function
    • getFutureWalletAddress()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getIBTAddress:function
    • getIBTAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getIBTAddress():function
    • getIBTAddress()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getNextPeriodIndex:function
    • getNextPeriodIndex(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getNextPeriodIndex():function
    • getNextPeriodIndex()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPTAddress:function
    • getPTAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPTAddress():function
    • getPTAddress()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPTPerAmountDeposited:function
    • getPTPerAmountDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPTPerAmountDeposited(uint256):function
    • getPTPerAmountDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPerformanceFeeFactor:function
    • getPerformanceFeeFactor(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPerformanceFeeFactor():function
    • getPerformanceFeeFactor()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPremiumPerUnderlyingDeposited:function
    • getPremiumPerUnderlyingDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getPremiumPerUnderlyingDeposited(uint256):function
    • getPremiumPerUnderlyingDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardTokenAt:function
    • getRewardTokenAt(_index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardTokenAt(uint256):function
    • getRewardTokenAt(uint256)(_index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardTokensCount:function
    • getRewardTokensCount(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardTokensCount():function
    • getRewardTokensCount()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardsRecipient:function
    • getRewardsRecipient(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardsRecipient():function
    • getRewardsRecipient()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalDelegated:function
    • getTotalDelegated(_delegator: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalDelegated(address):function
    • getTotalDelegated(address)(_delegator: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalUnderlyingDeposited:function
    • getTotalUnderlyingDeposited(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalUnderlyingDeposited():function
    • getTotalUnderlyingDeposited()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUnlockableFunds:function
    • getUnlockableFunds(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUnlockableFunds(address):function
    • getUnlockableFunds(address)(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUnrealisedYieldPerPT:function
    • getUnrealisedYieldPerPT(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUnrealisedYieldPerPT():function
    • getUnrealisedYieldPerPT()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUserEarlyUnlockablePremium:function
    • getUserEarlyUnlockablePremium(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUserEarlyUnlockablePremium(address):function
    • getUserEarlyUnlockablePremium(address)(_user: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getYieldOfPeriod:function
    • getYieldOfPeriod(_periodID: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getYieldOfPeriod(uint256):function
    • getYieldOfPeriod(uint256)(_periodID: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _periodID: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • harvestRewards:function
    • harvestRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • harvestRewards():function
    • harvestRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • isRewardToken:function
    • isRewardToken(_token: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isRewardToken(address):function
    • isRewardToken(address)(_token: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • _token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isTerminated:function
    • isTerminated(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isTerminated():function
    • isTerminated()(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • pauseLiquidityTransfers:function
    • pauseLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • pauseLiquidityTransfers():function
    • pauseLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • redeemAllVaultRewards:function
    • redeemAllVaultRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • redeemAllVaultRewards():function
    • redeemAllVaultRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • redeemVaultRewards:function
    • redeemVaultRewards(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • redeemVaultRewards(address):function
    • redeemVaultRewards(address)(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _rewardToken: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • resumeLiquidityTransfers:function
    • resumeLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • resumeLiquidityTransfers():function
    • resumeLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setFutureWallet:function
    • setFutureWallet(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setFutureWallet(address):function
    • setFutureWallet(address)(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _futureWallet: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setRegistry:function
    • setRegistry(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setRegistry(address):function
    • setRegistry(address)(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _registry: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setRewardRecipient:function
    • setRewardRecipient(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • setRewardRecipient(address):function
    • setRewardRecipient(address)(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • startNewPeriod:function
    • startNewPeriod(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • startNewPeriod():function
    • startNewPeriod()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • updateUserState:function
    • updateUserState(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • updateUserState(address):function
    • updateUserState(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • withdraw:function
    • withdraw(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • withdraw(address,uint256):function
    • withdraw(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _user: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • withdrawFYTDelegationFrom:function
    • withdrawFYTDelegationFrom(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • withdrawFYTDelegationFrom(address,address,uint256):function
    • withdrawFYTDelegationFrom(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • _delegator: string
      • _receiver: string
      • _amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

PERIOD_DURATION

  • PERIOD_DURATION(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

PERIOD_DURATION()

  • PERIOD_DURATION()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

PLATFORM_NAME

  • PLATFORM_NAME(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

PLATFORM_NAME()

  • PLATFORM_NAME()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

_checkRunningEvents

  • _checkRunningEvents(runningEvent: RunningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?: BlockTag): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

  • Parameters

    • runningEvent: RunningEvent
    • log: Log
    • listener: Listener

    Returns Event

addRewardsToken

  • addRewardsToken(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _token: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

addRewardsToken(address)

  • addRewardsToken(address)(_token: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _token: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

attach

  • Parameters

    • addressOrName: string

    Returns IFutureVault

claimFYT

  • claimFYT(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

claimFYT(address,uint256)

  • claimFYT(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider: string | Signer | Provider): IFutureVault

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns IFutureVault

convertIBTToUnderlying

  • convertIBTToUnderlying(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

convertIBTToUnderlying(uint256)

  • convertIBTToUnderlying(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

convertUnderlyingtoIBT

  • convertUnderlyingtoIBT(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

convertUnderlyingtoIBT(uint256)

  • convertUnderlyingtoIBT(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

createFYTDelegationTo

  • createFYTDelegationTo(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _delegator: string
    • _receiver: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

createFYTDelegationTo(address,address,uint256)

  • createFYTDelegationTo(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _delegator: string
    • _receiver: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

deployed

  • Returns Promise<IFutureVault>

deposit

  • deposit(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

deposit(address,uint256)

  • deposit(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

emit

  • emit(eventName: string | EventFilter, ...args: any[]): boolean

  • Parameters

    • eventName: string | EventFilter
    • Rest ...args: any[]

    Returns boolean

exitTerminatedFuture

  • exitTerminatedFuture(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

exitTerminatedFuture(address)

  • exitTerminatedFuture(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

fallback

  • fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

getClaimableFYTForPeriod

  • getClaimableFYTForPeriod(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • _periodIndex: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getClaimableFYTForPeriod(address,uint256)

  • getClaimableFYTForPeriod(address,uint256)(_user: string, _periodIndex: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • _periodIndex: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getClaimablePT

  • getClaimablePT(_user: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getClaimablePT(address)

  • getClaimablePT(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getControllerAddress

  • getControllerAddress(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getControllerAddress()

  • getControllerAddress()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getCurrentPeriodIndex

  • getCurrentPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getCurrentPeriodIndex()

  • getCurrentPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getFYTofPeriod

  • getFYTofPeriod(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • _periodIndex: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getFYTofPeriod(uint256)

  • getFYTofPeriod(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • _periodIndex: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getFutureWalletAddress

  • getFutureWalletAddress(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getFutureWalletAddress()

  • getFutureWalletAddress()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getIBTAddress

  • getIBTAddress(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getIBTAddress()

  • getIBTAddress()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getNextPeriodIndex

  • getNextPeriodIndex(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getNextPeriodIndex()

  • getNextPeriodIndex()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPTAddress

  • getPTAddress(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getPTAddress()

  • getPTAddress()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getPTPerAmountDeposited

  • getPTPerAmountDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPTPerAmountDeposited(uint256)

  • getPTPerAmountDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPerformanceFeeFactor

  • getPerformanceFeeFactor(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPerformanceFeeFactor()

  • getPerformanceFeeFactor()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPremiumPerUnderlyingDeposited

  • getPremiumPerUnderlyingDeposited(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPremiumPerUnderlyingDeposited(uint256)

  • getPremiumPerUnderlyingDeposited(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _amount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getRewardTokenAt

  • getRewardTokenAt(_index: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • _index: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRewardTokenAt(uint256)

  • getRewardTokenAt(uint256)(_index: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • _index: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRewardTokensCount

  • getRewardTokensCount(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getRewardTokensCount()

  • getRewardTokensCount()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getRewardsRecipient

  • getRewardsRecipient(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getRewardsRecipient()

  • getRewardsRecipient()(overrides?: CallOverrides): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getTotalDelegated

  • getTotalDelegated(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _delegator: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalDelegated(address)

  • getTotalDelegated(address)(_delegator: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _delegator: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalUnderlyingDeposited

  • getTotalUnderlyingDeposited(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalUnderlyingDeposited()

  • getTotalUnderlyingDeposited()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUnlockableFunds

  • getUnlockableFunds(_user: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUnlockableFunds(address)

  • getUnlockableFunds(address)(_user: string, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUnrealisedYieldPerPT

  • getUnrealisedYieldPerPT(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUnrealisedYieldPerPT()

  • getUnrealisedYieldPerPT()(overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUserEarlyUnlockablePremium

  • getUserEarlyUnlockablePremium(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

getUserEarlyUnlockablePremium(address)

  • getUserEarlyUnlockablePremium(address)(_user: string, overrides?: CallOverrides): Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

  • Parameters

    • _user: string
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber] & { amountRequired: BigNumber; premiumLocked: BigNumber }>

getYieldOfPeriod

  • getYieldOfPeriod(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _periodID: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getYieldOfPeriod(uint256)

  • getYieldOfPeriod(uint256)(_periodID: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • _periodID: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

harvestRewards

  • harvestRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

harvestRewards()

  • harvestRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

isRewardToken

  • isRewardToken(_token: string, overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • _token: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isRewardToken(address)

  • isRewardToken(address)(_token: string, overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • _token: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isTerminated

  • isTerminated(overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isTerminated()

  • isTerminated()(overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

listenerCount

  • listenerCount(eventName?: string | EventFilter): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

listeners

  • listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
  • listeners(eventName?: string): Listener[]

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns TypedListener<EventArgsArray, EventArgsObject>[]

  • Parameters

    • Optional eventName: string

    Returns Listener[]

off

  • off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): IFutureVault
  • off(eventName: string, listener: Listener): IFutureVault

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns IFutureVault

  • Parameters

    • eventName: string
    • listener: Listener

    Returns IFutureVault

on

  • on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): IFutureVault
  • on(eventName: string, listener: Listener): IFutureVault

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns IFutureVault

  • Parameters

    • eventName: string
    • listener: Listener

    Returns IFutureVault

once

  • once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): IFutureVault
  • once(eventName: string, listener: Listener): IFutureVault

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns IFutureVault

  • Parameters

    • eventName: string
    • listener: Listener

    Returns IFutureVault

pauseLiquidityTransfers

  • pauseLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

pauseLiquidityTransfers()

  • pauseLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

queryFilter

  • queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • event: TypedEventFilter<EventArgsArray, EventArgsObject>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

redeemAllVaultRewards

  • redeemAllVaultRewards(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

redeemAllVaultRewards()

  • redeemAllVaultRewards()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

redeemVaultRewards

  • redeemVaultRewards(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _rewardToken: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

redeemVaultRewards(address)

  • redeemVaultRewards(address)(_rewardToken: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _rewardToken: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

removeAllListeners

  • removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): IFutureVault
  • removeAllListeners(eventName?: string): IFutureVault

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns IFutureVault

  • Parameters

    • Optional eventName: string

    Returns IFutureVault

removeListener

  • removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): IFutureVault
  • removeListener(eventName: string, listener: Listener): IFutureVault

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns IFutureVault

  • Parameters

    • eventName: string
    • listener: Listener

    Returns IFutureVault

resumeLiquidityTransfers

  • resumeLiquidityTransfers(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

resumeLiquidityTransfers()

  • resumeLiquidityTransfers()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setFutureWallet

  • setFutureWallet(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _futureWallet: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setFutureWallet(address)

  • setFutureWallet(address)(_futureWallet: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _futureWallet: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setRegistry

  • setRegistry(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _registry: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setRegistry(address)

  • setRegistry(address)(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _registry: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setRewardRecipient

  • setRewardRecipient(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _recipient: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

setRewardRecipient(address)

  • setRewardRecipient(address)(_recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _recipient: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

startNewPeriod

  • startNewPeriod(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

startNewPeriod()

  • startNewPeriod()(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

updateUserState

  • updateUserState(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

updateUserState(address)

  • updateUserState(address)(_user: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

withdraw

  • withdraw(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

withdraw(address,uint256)

  • withdraw(address,uint256)(_user: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _user: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

withdrawFYTDelegationFrom

  • withdrawFYTDelegationFrom(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _delegator: string
    • _receiver: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

withdrawFYTDelegationFrom(address,address,uint256)

  • withdrawFYTDelegationFrom(address,address,uint256)(_delegator: string, _receiver: string, _amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • _delegator: string
    • _receiver: string
    • _amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

Static getContractAddress

  • getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

  • Parameters

    • transaction: { from: string; nonce: BigNumberish }
      • from: string
      • nonce: BigNumberish

    Returns string

Static getInterface

  • getInterface(contractInterface: ContractInterface): Interface

  • Parameters

    • contractInterface: ContractInterface

    Returns Interface

Static isIndexed

  • isIndexed(value: any): value is Indexed

  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc, the 4/22/2022