Interface IVxPremia

Hierarchy

  • BaseContract
    • IVxPremia

Properties

DOMAIN_SEPARATOR: TypedContractMethod<[], [string], "view">
[internal]: any
addRewards: TypedContractMethod<[amount: BigNumberish], [void], "nonpayable">
allowance: TypedContractMethod<[holder: AddressLike, spender: AddressLike], [bigint], "view">
approve: TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
balanceOf: TypedContractMethod<[account: AddressLike], [bigint], "view">
castVotes: TypedContractMethod<[votes: VoteStruct[]], [void], "nonpayable">
circulatingSupply: TypedContractMethod<[], [bigint], "view">
decimals: TypedContractMethod<[], [bigint], "view">
decreaseAllowance: TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
earlyUnstake: TypedContractMethod<[amount: BigNumberish], [void], "nonpayable">
estimateSendFee: TypedContractMethod<[dstChainId: BigNumberish, toAddress: BytesLike, amount: BigNumberish, useZro: boolean, adapterParams: BytesLike], [[bigint, bigint] & {
    nativeFee: bigint;
    zroFee: bigint;
}], "view">
fallback: null | WrappedFallback
filters: {
    AddVote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    AddVote(address,uint8,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BridgeLock: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BridgeLock(address,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    EarlyUnstakeRewardCollected: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    EarlyUnstakeRewardCollected(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Harvest: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Harvest(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ReceiveFromChain: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ReceiveFromChain(uint16,bytes,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RemoveVote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RemoveVote(address,uint8,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RewardsAdded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RewardsAdded(uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SendToChain: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SendToChain(address,uint16,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetUseCustomAdapterParams: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SetUseCustomAdapterParams(bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Stake: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Stake(address,uint256,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Unstake: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Unstake(address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateLock: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateLock(address,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdraw(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

  • AddVote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • AddVote(address,uint8,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • BridgeLock: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • BridgeLock(address,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • EarlyUnstakeRewardCollected: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • EarlyUnstakeRewardCollected(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Harvest: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Harvest(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ReceiveFromChain: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ReceiveFromChain(uint16,bytes,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RemoveVote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RemoveVote(address,uint8,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RewardsAdded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • RewardsAdded(uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SendToChain: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SendToChain(address,uint16,bytes,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetUseCustomAdapterParams: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SetUseCustomAdapterParams(bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Stake: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Stake(address,uint256,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Unstake: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Unstake(address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateLock: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateLock(address,uint64,uint64): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Withdraw(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
getAvailablePremiaAmount: TypedContractMethod<[], [bigint], "view">
getAvailableRewards: TypedContractMethod<[], [[bigint, bigint] & {
    rewards: bigint;
    unstakeRewards: bigint;
}], "view">
getDiscount: TypedContractMethod<[user: AddressLike], [bigint], "view">
getEarlyUnstakeFee: TypedContractMethod<[user: AddressLike], [bigint], "view">
getPendingRewards: TypedContractMethod<[], [bigint], "view">
getPendingUserRewards: TypedContractMethod<[user: AddressLike], [[bigint, bigint] & {
    reward: bigint;
    unstakeReward: bigint;
}], "view">
getPendingWithdrawal: TypedContractMethod<[user: AddressLike], [[bigint, bigint, bigint] & {
    amount: bigint;
    startDate: bigint;
    unlockDate: bigint;
}], "view">
getPendingWithdrawals: TypedContractMethod<[], [bigint], "view">
getPoolVotes: TypedContractMethod<[version: BigNumberish, target: BytesLike], [bigint], "view">
getRewardToken: TypedContractMethod<[], [string], "view">
getStakeLevels: TypedContractMethod<[], [StakeLevelStructOutput[]], "view">
getStakePeriodMultiplier: TypedContractMethod<[period: BigNumberish], [bigint], "view">
getTotalPower: TypedContractMethod<[], [bigint], "view">
getUserInfo: TypedContractMethod<[user: AddressLike], [UserInfoStructOutput], "view">
getUserPower: TypedContractMethod<[user: AddressLike], [bigint], "view">
getUserVotes: TypedContractMethod<[user: AddressLike], [VoteStructOutput[]], "view">
harvest: TypedContractMethod<[], [void], "nonpayable">
harvestAndStake: TypedContractMethod<[s: SwapArgsStruct, stakePeriod: BigNumberish], [void], "nonpayable">
increaseAllowance: TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
interface: IVxPremiaInterface
name: TypedContractMethod<[], [string], "view">
nonces: TypedContractMethod<[owner: AddressLike], [bigint], "view">
permit: TypedContractMethod<[owner: AddressLike, spender: AddressLike, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike], [void], "nonpayable">
runner: null | ContractRunner
sendFrom: TypedContractMethod<[from: AddressLike, dstChainId: BigNumberish, toAddress: BytesLike, amount: BigNumberish, refundAddress: AddressLike, zroPaymentAddress: AddressLike, adapterParams: BytesLike], [void], "payable">
stake: TypedContractMethod<[amount: BigNumberish, period: BigNumberish], [void], "nonpayable">
stakeWithPermit: TypedContractMethod<[amount: BigNumberish, period: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike], [void], "nonpayable">
startWithdraw: TypedContractMethod<[amount: BigNumberish], [void], "nonpayable">
supportsInterface: TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">
symbol: TypedContractMethod<[], [string], "view">
target: string | Addressable
totalSupply: TypedContractMethod<[], [bigint], "view">
transfer: TypedContractMethod<[recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
transferFrom: TypedContractMethod<[holder: AddressLike, recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
updateLock: TypedContractMethod<[period: BigNumberish], [void], "nonpayable">
withdraw: TypedContractMethod<[], [void], "nonpayable">

Methods

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IVxPremia>

  • Parameters

    • addressOrName: AddressLike

    Returns IVxPremia

  • Parameters

    • Optional runner: null | ContractRunner

    Returns BaseContract

  • Returns Promise<IVxPremia>

  • Returns null | ContractTransactionResponse

  • Parameters

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

    Returns Promise<boolean>

  • Returns Promise<string>

  • Returns Promise<null | string>

  • Parameters

    • key: "AddVote"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Approval"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "BridgeLock"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "EarlyUnstakeRewardCollected"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Harvest"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "ReceiveFromChain"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "RemoveVote"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "RewardsAdded"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SendToChain"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SetUseCustomAdapterParams"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Stake"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Transfer"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Unstake"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "UpdateLock"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Withdraw"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Type Parameters

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

    Parameters

    • key: string | FunctionFragment

    Returns T

  • Parameters

    • nameOrSignature: "DOMAIN_SEPARATOR"

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

  • Parameters

    • nameOrSignature: "addRewards"

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

  • Parameters

    • nameOrSignature: "allowance"

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

  • Parameters

    • nameOrSignature: "approve"

    Returns TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "balanceOf"

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

  • Parameters

    • nameOrSignature: "castVotes"

    Returns TypedContractMethod<[votes: VoteStruct[]], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "circulatingSupply"

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

  • Parameters

    • nameOrSignature: "decimals"

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

  • Parameters

    • nameOrSignature: "decreaseAllowance"

    Returns TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "earlyUnstake"

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

  • Parameters

    • nameOrSignature: "estimateSendFee"

    Returns TypedContractMethod<[dstChainId: BigNumberish, toAddress: BytesLike, amount: BigNumberish, useZro: boolean, adapterParams: BytesLike], [[bigint, bigint] & {
        nativeFee: bigint;
        zroFee: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getAvailablePremiaAmount"

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

  • Parameters

    • nameOrSignature: "getAvailableRewards"

    Returns TypedContractMethod<[], [[bigint, bigint] & {
        rewards: bigint;
        unstakeRewards: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getDiscount"

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

  • Parameters

    • nameOrSignature: "getEarlyUnstakeFee"

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

  • Parameters

    • nameOrSignature: "getPendingRewards"

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

  • Parameters

    • nameOrSignature: "getPendingUserRewards"

    Returns TypedContractMethod<[user: AddressLike], [[bigint, bigint] & {
        reward: bigint;
        unstakeReward: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getPendingWithdrawal"

    Returns TypedContractMethod<[user: AddressLike], [[bigint, bigint, bigint] & {
        amount: bigint;
        startDate: bigint;
        unlockDate: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getPendingWithdrawals"

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

  • Parameters

    • nameOrSignature: "getPoolVotes"

    Returns TypedContractMethod<[version: BigNumberish, target: BytesLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getRewardToken"

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

  • Parameters

    • nameOrSignature: "getStakeLevels"

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

  • Parameters

    • nameOrSignature: "getStakePeriodMultiplier"

    Returns TypedContractMethod<[period: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "getTotalPower"

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

  • Parameters

    • nameOrSignature: "getUserInfo"

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

  • Parameters

    • nameOrSignature: "getUserPower"

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

  • Parameters

    • nameOrSignature: "getUserVotes"

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

  • Parameters

    • nameOrSignature: "harvest"

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

  • Parameters

    • nameOrSignature: "harvestAndStake"

    Returns TypedContractMethod<[s: SwapArgsStruct, stakePeriod: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "increaseAllowance"

    Returns TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "name"

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

  • Parameters

    • nameOrSignature: "nonces"

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

  • Parameters

    • nameOrSignature: "permit"

    Returns TypedContractMethod<[owner: AddressLike, spender: AddressLike, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "sendFrom"

    Returns TypedContractMethod<[from: AddressLike, dstChainId: BigNumberish, toAddress: BytesLike, amount: BigNumberish, refundAddress: AddressLike, zroPaymentAddress: AddressLike, adapterParams: BytesLike], [void], "payable">

  • Parameters

    • nameOrSignature: "stake"

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

  • Parameters

    • nameOrSignature: "stakeWithPermit"

    Returns TypedContractMethod<[amount: BigNumberish, period: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "startWithdraw"

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

  • Parameters

    • nameOrSignature: "supportsInterface"

    Returns TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">

  • Parameters

    • nameOrSignature: "symbol"

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

  • Parameters

    • nameOrSignature: "totalSupply"

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

  • Parameters

    • nameOrSignature: "transfer"

    Returns TypedContractMethod<[recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "transferFrom"

    Returns TypedContractMethod<[holder: AddressLike, recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "updateLock"

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

  • Parameters

    • nameOrSignature: "withdraw"

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

  • Parameters

    • Optional event: ContractEventName

    Returns Promise<number>

  • Type Parameters

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

    Parameters

    • event: TCEvent

    Returns Promise<TypedListener<TCEvent>[]>

  • Parameters

    • Optional eventName: string

    Returns Promise<Listener[]>

  • Parameters

    • event: ContractEventName
    • Optional listener: Listener

    Returns Promise<IVxPremia>

  • Type Parameters

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

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IVxPremia>

  • Type Parameters

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

    Parameters

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

    Returns Promise<IVxPremia>

  • Type Parameters

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

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IVxPremia>

  • Type Parameters

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

    Parameters

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

    Returns Promise<IVxPremia>

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

  • Parameters

    • hash: string

    Returns Promise<EventLog[]>

  • Type Parameters

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

    Parameters

    • Optional event: TCEvent

    Returns Promise<IVxPremia>

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IVxPremia>

  • Returns Promise<IVxPremia>

Generated using TypeDoc