Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomFutureWallet

Hierarchy

  • Contract
    • CustomFutureWallet

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

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

    Returns CustomFutureWallet

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: { DEFAULT_ADMIN_ROLE: any; DEFAULT_ADMIN_ROLE(): any; WITHRAWALS_PAUSED: any; WITHRAWALS_PAUSED(): any; getFutureAddress: any; getFutureAddress(): any; getIBTAddress: any; getIBTAddress(): any; getRedeemableYield: any; getRedeemableYield(uint256,address): any; getRewardsRecipient: any; getRewardsRecipient(): any; getRoleAdmin: any; getRoleAdmin(bytes32): any; getRoleMember: any; getRoleMember(bytes32,uint256): any; getRoleMemberCount: any; getRoleMemberCount(bytes32): any; grantRole: any; grantRole(bytes32,address): any; harvestRewards: any; harvestRewards(): any; hasRole: any; hasRole(bytes32,address): any; initialize: any; initialize(address,address): any; redeemAllWalletRewards: any; redeemAllWalletRewards(): any; redeemWalletRewards: any; redeemWalletRewards(address): any; redeemYield: any; redeemYield(uint256): any; registerExpiredFuture: any; registerExpiredFuture(uint256): any; renounceRole: any; renounceRole(bytes32,address): any; revokeRole: any; revokeRole(bytes32,address): any; setRewardRecipient: any; setRewardRecipient(address): any; toggleWithdrawalPause: any; toggleWithdrawalPause(): any }

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getFutureAddress():function
    • getFutureAddress()(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>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • _periodIndex: BigNumberish
      • _user: string
      • 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>

  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRoleAdmin(bytes32):function
    • getRoleAdmin(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<string>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRoleMember(bytes32,uint256):function
    • getRoleMember(bytes32,uint256)(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleMemberCount(bytes32):function
    • getRoleMemberCount(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • grantRole(bytes32,address):function
    • grantRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • 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>

  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • hasRole(bytes32,address):function
    • hasRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • initialize:function
    • initialize(_futureVault: string, _admin: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _futureVault: string
      • _admin: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • initialize(address,address):function
    • initialize(address,address)(_futureVault: string, _admin: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _futureVault: string
      • _admin: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • _rewardToken: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • _rewardToken: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemYield:function
    • redeemYield(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • redeemYield(uint256):function
    • redeemYield(uint256)(_periodIndex: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _periodIndex: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerExpiredFuture:function
    • registerExpiredFuture(_amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerExpiredFuture(uint256):function
    • registerExpiredFuture(uint256)(_amount: BigNumberish, overrides?: CallOverrides): Promise<void>

    • Parameters

      • _amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • renounceRole(bytes32,address):function
    • renounceRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • revokeRole(bytes32,address):function
    • revokeRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>

    • Parameters

      • role: BytesLike
      • account: 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>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { DEFAULT_ADMIN_ROLE: any; DEFAULT_ADMIN_ROLE(): any; WITHRAWALS_PAUSED: any; WITHRAWALS_PAUSED(): any; getFutureAddress: any; getFutureAddress(): any; getIBTAddress: any; getIBTAddress(): any; getRedeemableYield: any; getRedeemableYield(uint256,address): any; getRewardsRecipient: any; getRewardsRecipient(): any; getRoleAdmin: any; getRoleAdmin(bytes32): any; getRoleMember: any; getRoleMember(bytes32,uint256): any; getRoleMemberCount: any; getRoleMemberCount(bytes32): any; grantRole: any; grantRole(bytes32,address): any; harvestRewards: any; harvestRewards(): any; hasRole: any; hasRole(bytes32,address): any; initialize: any; initialize(address,address): any; redeemAllWalletRewards: any; redeemAllWalletRewards(): any; redeemWalletRewards: any; redeemWalletRewards(address): any; redeemYield: any; redeemYield(uint256): any; registerExpiredFuture: any; registerExpiredFuture(uint256): any; renounceRole: any; renounceRole(bytes32,address): any; revokeRole: any; revokeRole(bytes32,address): any; setRewardRecipient: any; setRewardRecipient(address): any; toggleWithdrawalPause: any; toggleWithdrawalPause(): any }

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFutureAddress():function
    • getFutureAddress()(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>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • _periodIndex: BigNumberish
      • _user: string
      • 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>

  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleAdmin(bytes32):function
    • getRoleAdmin(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleMember(bytes32,uint256):function
    • getRoleMember(bytes32,uint256)(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getRoleMemberCount(bytes32):function
    • getRoleMemberCount(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • grantRole(bytes32,address):function
    • grantRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • account: string
      • 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>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • hasRole(bytes32,address):function
    • hasRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • initialize:function
    • initialize(_futureVault: string, _admin: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • redeemYield(uint256):function
    • redeemYield(uint256)(_periodIndex: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • renounceRole(bytes32,address):function
    • renounceRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • revokeRole(bytes32,address):function
    • revokeRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • role: BytesLike
      • account: 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>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

filters

filters: { RewardTokenRedeemed: any; RewardsHarvested: any; RewardsRecipientUpdated: any; RoleAdminChanged: any; RoleGranted: any; RoleRevoked: any; WithdrawalsPauseChanged: any; YieldRedeemed: any }

Type declaration

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

    • Parameters

      • _token: null
      • _amount: null

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

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

    • Returns TypedEventFilter<[], {}>

  • RewardsRecipientUpdated:function
    • RewardsRecipientUpdated(_recipient: null): TypedEventFilter<[string], { _recipient: string }>

    • Parameters

      • _recipient: null

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

  • RoleAdminChanged:function
    • RoleAdminChanged(role: null | BytesLike, previousAdminRole: null | BytesLike, newAdminRole: null | BytesLike): TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

    • Parameters

      • role: null | BytesLike
      • previousAdminRole: null | BytesLike
      • newAdminRole: null | BytesLike

      Returns TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

  • RoleGranted:function
    • RoleGranted(role: null | BytesLike, account: null | string, sender: null | string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • role: null | BytesLike
      • account: null | string
      • sender: null | string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • RoleRevoked:function
    • RoleRevoked(role: null | BytesLike, account: null | string, sender: null | string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • role: null | BytesLike
      • account: null | string
      • sender: null | string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • WithdrawalsPauseChanged:function
    • WithdrawalsPauseChanged(_withdrawalPaused: null): TypedEventFilter<[boolean], { _withdrawalPaused: boolean }>

    • Parameters

      • _withdrawalPaused: null

      Returns TypedEventFilter<[boolean], { _withdrawalPaused: boolean }>

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

    • Parameters

      • _user: null
      • _periodIndex: null

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

functions

functions: { DEFAULT_ADMIN_ROLE: any; DEFAULT_ADMIN_ROLE(): any; WITHRAWALS_PAUSED: any; WITHRAWALS_PAUSED(): any; getFutureAddress: any; getFutureAddress(): any; getIBTAddress: any; getIBTAddress(): any; getRedeemableYield: any; getRedeemableYield(uint256,address): any; getRewardsRecipient: any; getRewardsRecipient(): any; getRoleAdmin: any; getRoleAdmin(bytes32): any; getRoleMember: any; getRoleMember(bytes32,uint256): any; getRoleMemberCount: any; getRoleMemberCount(bytes32): any; grantRole: any; grantRole(bytes32,address): any; harvestRewards: any; harvestRewards(): any; hasRole: any; hasRole(bytes32,address): any; initialize: any; initialize(address,address): any; redeemAllWalletRewards: any; redeemAllWalletRewards(): any; redeemWalletRewards: any; redeemWalletRewards(address): any; redeemYield: any; redeemYield(uint256): any; registerExpiredFuture: any; registerExpiredFuture(uint256): any; renounceRole: any; renounceRole(bytes32,address): any; revokeRole: any; revokeRole(bytes32,address): any; setRewardRecipient: any; setRewardRecipient(address): any; toggleWithdrawalPause: any; toggleWithdrawalPause(): any }

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getFutureAddress():function
    • getFutureAddress()(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]>

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

    • Parameters

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

      Returns Promise<[BigNumber]>

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

    • Parameters

      • _periodIndex: BigNumberish
      • _user: string
      • 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]>

  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRoleAdmin(bytes32):function
    • getRoleAdmin(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRoleMember(bytes32,uint256):function
    • getRoleMember(bytes32,uint256)(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<[string]>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getRoleMemberCount(bytes32):function
    • getRoleMemberCount(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<[BigNumber]>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • grantRole(bytes32,address):function
    • grantRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • role: BytesLike
      • account: string
      • 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>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • hasRole(bytes32,address):function
    • hasRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<[boolean]>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • initialize:function
    • initialize(_futureVault: string, _admin: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • redeemYield(uint256):function
    • redeemYield(uint256)(_periodIndex: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • renounceRole(bytes32,address):function
    • renounceRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • revokeRole(bytes32,address):function
    • revokeRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • role: BytesLike
      • account: 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>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

interface

interface: CustomFutureWalletInterface

populateTransaction

populateTransaction: { DEFAULT_ADMIN_ROLE: any; DEFAULT_ADMIN_ROLE(): any; WITHRAWALS_PAUSED: any; WITHRAWALS_PAUSED(): any; getFutureAddress: any; getFutureAddress(): any; getIBTAddress: any; getIBTAddress(): any; getRedeemableYield: any; getRedeemableYield(uint256,address): any; getRewardsRecipient: any; getRewardsRecipient(): any; getRoleAdmin: any; getRoleAdmin(bytes32): any; getRoleMember: any; getRoleMember(bytes32,uint256): any; getRoleMemberCount: any; getRoleMemberCount(bytes32): any; grantRole: any; grantRole(bytes32,address): any; harvestRewards: any; harvestRewards(): any; hasRole: any; hasRole(bytes32,address): any; initialize: any; initialize(address,address): any; redeemAllWalletRewards: any; redeemAllWalletRewards(): any; redeemWalletRewards: any; redeemWalletRewards(address): any; redeemYield: any; redeemYield(uint256): any; registerExpiredFuture: any; registerExpiredFuture(uint256): any; renounceRole: any; renounceRole(bytes32,address): any; revokeRole: any; revokeRole(bytes32,address): any; setRewardRecipient: any; setRewardRecipient(address): any; toggleWithdrawalPause: any; toggleWithdrawalPause(): any }

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFutureAddress():function
    • getFutureAddress()(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>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • _periodIndex: BigNumberish
      • _user: string
      • 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>

  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRoleAdmin(bytes32):function
    • getRoleAdmin(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRoleMember(bytes32,uint256):function
    • getRoleMember(bytes32,uint256)(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • index: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRoleMemberCount(bytes32):function
    • getRoleMemberCount(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • grantRole(bytes32,address):function
    • grantRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • account: string
      • 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>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • hasRole(bytes32,address):function
    • hasRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • initialize:function
    • initialize(_futureVault: string, _admin: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • redeemYield(uint256):function
    • redeemYield(uint256)(_periodIndex: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • renounceRole(bytes32,address):function
    • renounceRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • revokeRole(bytes32,address):function
    • revokeRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • role: BytesLike
      • account: 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>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

DEFAULT_ADMIN_ROLE

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

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

DEFAULT_ADMIN_ROLE()

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

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

WITHRAWALS_PAUSED

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

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

WITHRAWALS_PAUSED()

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

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

_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

attach

  • Parameters

    • addressOrName: string

    Returns CustomFutureWallet

connect

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns CustomFutureWallet

deployed

  • Returns Promise<CustomFutureWallet>

emit

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

  • Parameters

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

    Returns boolean

fallback

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

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

getFutureAddress

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

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getFutureAddress()

  • getFutureAddress()(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>

getRedeemableYield

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

  • Parameters

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

    Returns Promise<BigNumber>

getRedeemableYield(uint256,address)

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

  • Parameters

    • _periodIndex: BigNumberish
    • _user: string
    • 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>

getRoleAdmin

  • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>

  • Parameters

    • role: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRoleAdmin(bytes32)

  • getRoleAdmin(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<string>

  • Parameters

    • role: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRoleMember

  • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • role: BytesLike
    • index: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRoleMember(bytes32,uint256)

  • getRoleMember(bytes32,uint256)(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>

  • Parameters

    • role: BytesLike
    • index: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string>

getRoleMemberCount

  • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • role: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getRoleMemberCount(bytes32)

  • getRoleMemberCount(bytes32)(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

  • Parameters

    • role: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

grantRole

  • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

grantRole(bytes32,address)

  • grantRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • role: BytesLike
    • account: string
    • 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>

harvestRewards()

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

  • Parameters

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

    Returns Promise<ContractTransaction>

hasRole

  • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • role: BytesLike
    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

hasRole(bytes32,address)

  • hasRole(bytes32,address)(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>

  • Parameters

    • role: BytesLike
    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

initialize

  • initialize(_futureVault: string, _admin: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

initialize(address,address)

  • initialize(address,address)(_futureVault: string, _admin: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

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>): CustomFutureWallet
  • off(eventName: string, listener: Listener): CustomFutureWallet

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

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

    Returns CustomFutureWallet

  • Parameters

    • eventName: string
    • listener: Listener

    Returns CustomFutureWallet

on

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

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

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

    Returns CustomFutureWallet

  • Parameters

    • eventName: string
    • listener: Listener

    Returns CustomFutureWallet

once

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

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

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

    Returns CustomFutureWallet

  • Parameters

    • eventName: string
    • listener: Listener

    Returns CustomFutureWallet

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>[]>

redeemAllWalletRewards

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

  • Parameters

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

    Returns Promise<ContractTransaction>

redeemAllWalletRewards()

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

  • Parameters

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

    Returns Promise<ContractTransaction>

redeemWalletRewards

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

  • Parameters

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

    Returns Promise<ContractTransaction>

redeemWalletRewards(address)

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

  • Parameters

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

    Returns Promise<ContractTransaction>

redeemYield

  • redeemYield(_periodIndex: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

redeemYield(uint256)

  • redeemYield(uint256)(_periodIndex: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

registerExpiredFuture

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

  • Parameters

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

    Returns Promise<ContractTransaction>

registerExpiredFuture(uint256)

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

  • Parameters

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

    Returns Promise<ContractTransaction>

removeAllListeners

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

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns CustomFutureWallet

  • Parameters

    • Optional eventName: string

    Returns CustomFutureWallet

removeListener

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

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

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

    Returns CustomFutureWallet

  • Parameters

    • eventName: string
    • listener: Listener

    Returns CustomFutureWallet

renounceRole

  • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

renounceRole(bytes32,address)

  • renounceRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

revokeRole

  • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

revokeRole(bytes32,address)

  • revokeRole(bytes32,address)(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • role: BytesLike
    • account: 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>

toggleWithdrawalPause

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

  • Parameters

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

    Returns Promise<ContractTransaction>

toggleWithdrawalPause()

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

  • Parameters

    • 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