Interface IVaultMining

Hierarchy

  • BaseContract
    • IVaultMining

Properties

[internal] addRewards claim claimAll fallback filters getDualMiningPools getPendingUserRewardsFromVault getPendingVaultRewards getRewardsAvailable getRewardsPerYear getTotalUserRewards getTotalVotes getUserInfo getUserRewards getVaultInfo getVoteMultiplier interface previewOptionParams runner target updateUser(address,address) updateUser(address,uint256,uint256,uint256) updateVault updateVaults

Methods

addListener attach connect deploymentTransaction emit getAddress getDeployedCode getEvent getFunction listenerCount listeners off on once queryFilter queryTransaction removeAllListeners removeListener waitForDeployment

Properties

Readonly [internal]

[internal]: any

@_ignore:

addRewards

addRewards: TypedContractMethod<[amount: BigNumberish], [void], "nonpayable">

claim

claim: TypedContractMethod<[vaults: AddressLike[], amount: BigNumberish], [void], "nonpayable">

claimAll

claimAll: TypedContractMethod<[vaults: AddressLike[]], [void], "nonpayable">

Readonly fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {
    AddDualMiningPool: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    AddDualMiningPool(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    AllocateRewards: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    AllocateRewards(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Claim: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Claim(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RemoveDualMiningPool: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RemoveDualMiningPool(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetRewardsPerYear: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetRewardsPerYear(uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetVoteMultiplier: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetVoteMultiplier(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateVaultVotes: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateVaultVotes(address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

  • AddDualMiningPool: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • AddDualMiningPool(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • AllocateRewards: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • AllocateRewards(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Claim: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Claim(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RemoveDualMiningPool: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RemoveDualMiningPool(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetRewardsPerYear: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetRewardsPerYear(uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetVoteMultiplier: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetVoteMultiplier(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateVaultVotes: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateVaultVotes(address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getDualMiningPools

getDualMiningPools: TypedContractMethod<[vault: AddressLike], [string[]], "view">

getPendingUserRewardsFromVault

getPendingUserRewardsFromVault: TypedContractMethod<[user: AddressLike, vault: AddressLike], [bigint], "view">

getPendingVaultRewards

getPendingVaultRewards: TypedContractMethod<[vault: AddressLike], [bigint], "view">

getRewardsAvailable

getRewardsAvailable: TypedContractMethod<[], [bigint], "view">

getRewardsPerYear

getRewardsPerYear: TypedContractMethod<[], [bigint], "view">

getTotalUserRewards

getTotalUserRewards: TypedContractMethod<[user: AddressLike], [bigint], "view">

getTotalVotes

getTotalVotes: TypedContractMethod<[], [bigint], "view">

getUserInfo

getUserInfo: TypedContractMethod<[user: AddressLike, vault: AddressLike], [IVaultMining.UserInfoStructOutput], "view">

getUserRewards

getUserRewards: TypedContractMethod<[user: AddressLike], [bigint], "view">

getVaultInfo

getVaultInfo: TypedContractMethod<[vault: AddressLike], [VaultInfoStructOutput], "view">

getVoteMultiplier

getVoteMultiplier: TypedContractMethod<[vault: AddressLike], [bigint], "view">

interface

interface: IVaultMiningInterface

previewOptionParams

previewOptionParams: TypedContractMethod<[], [[bigint, bigint] & {
    maturity: bigint;
    strike: bigint;
}], "view">

Readonly runner

runner: null | ContractRunner

The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

For example, a Contract connected to a [[Provider]] may only execute read-only operations.

Readonly target

target: string | Addressable

The target to connect to.

This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

updateUser(address,address)

updateUser(address,address): TypedContractMethod<[user: AddressLike, vault: AddressLike], [void], "nonpayable">

updateUser(address,uint256,uint256,uint256)

updateUser(address,uint256,uint256,uint256): TypedContractMethod<[user: AddressLike, newUserShares: BigNumberish, newTotalShares: BigNumberish, utilisationRate: BigNumberish], [void], "nonpayable">

updateVault

updateVault: TypedContractMethod<[vault: AddressLike], [void], "nonpayable">

updateVaults

updateVaults: TypedContractMethod<[], [void], "nonpayable">

Methods

addListener

  • Alias for [on].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IVaultMining>

attach

  • Return a new Contract instance with the same ABI and runner, but a different %%target%%.

    Parameters

    • target: string | Addressable

    Returns BaseContract

connect

  • Parameters

    • Optional runner: null | ContractRunner

    Returns IVaultMining

deploymentTransaction

  • Return the transaction used to deploy this contract.

    This is only available if this instance was returned from a [[ContractFactory]].

    Returns null | ContractTransactionResponse

emit

  • Emit an %%event%% calling all listeners with %%args%%.

    Resolves to true if any listeners were called.

    Parameters

    • event: ContractEventName
    • Rest ...args: any[]

    Returns Promise<boolean>

getAddress

  • Return the resolved address of this Contract.

    Returns Promise<string>

getDeployedCode

  • Return the deployed bytecode or null if no bytecode is found.

    Returns Promise<null | string>

getEvent

  • Parameters

    • key: "AddDualMiningPool"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "AllocateRewards"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Claim"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "RemoveDualMiningPool"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SetRewardsPerYear"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SetVoteMultiplier"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "UpdateVaultVotes"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getFunction

  • Type Parameters

    • T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>

    Parameters

    • key: string | FunctionFragment

    Returns T

  • Parameters

    • nameOrSignature: "addRewards"

    Returns TypedContractMethod<[amount: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "claim"

    Returns TypedContractMethod<[vaults: AddressLike[], amount: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "claimAll"

    Returns TypedContractMethod<[vaults: AddressLike[]], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "getDualMiningPools"

    Returns TypedContractMethod<[vault: AddressLike], [string[]], "view">

  • Parameters

    • nameOrSignature: "getPendingUserRewardsFromVault"

    Returns TypedContractMethod<[user: AddressLike, vault: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getPendingVaultRewards"

    Returns TypedContractMethod<[vault: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getRewardsAvailable"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "getRewardsPerYear"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "getTotalUserRewards"

    Returns TypedContractMethod<[user: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getTotalVotes"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "getUserInfo"

    Returns TypedContractMethod<[user: AddressLike, vault: AddressLike], [IVaultMining.UserInfoStructOutput], "view">

  • Parameters

    • nameOrSignature: "getUserRewards"

    Returns TypedContractMethod<[user: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getVaultInfo"

    Returns TypedContractMethod<[vault: AddressLike], [VaultInfoStructOutput], "view">

  • Parameters

    • nameOrSignature: "getVoteMultiplier"

    Returns TypedContractMethod<[vault: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "previewOptionParams"

    Returns TypedContractMethod<[], [[bigint, bigint] & {
        maturity: bigint;
        strike: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "updateUser(address,address)"

    Returns TypedContractMethod<[user: AddressLike, vault: AddressLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateUser(address,uint256,uint256,uint256)"

    Returns TypedContractMethod<[user: AddressLike, newUserShares: BigNumberish, newTotalShares: BigNumberish, utilisationRate: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateVault"

    Returns TypedContractMethod<[vault: AddressLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateVaults"

    Returns TypedContractMethod<[], [void], "nonpayable">

listenerCount

  • Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.

    Parameters

    • Optional event: ContractEventName

    Returns Promise<number>

listeners

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent

    Returns Promise<TypedListener<TCEvent>[]>

  • Parameters

    • Optional eventName: string

    Returns Promise<Listener[]>

off

  • Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.

    Parameters

    • event: ContractEventName
    • Optional listener: Listener

    Returns Promise<IVaultMining>

on

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IVaultMining>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<IVaultMining>

once

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IVaultMining>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<IVaultMining>

queryFilter

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

queryTransaction

  • @_ignore:

    Parameters

    • hash: string

    Returns Promise<EventLog[]>

removeAllListeners

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • Optional event: TCEvent

    Returns Promise<IVaultMining>

removeListener

  • Alias for [off].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IVaultMining>

waitForDeployment

  • Returns Promise<IVaultMining>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc