Interface IPremiaStaking

Hierarchy

  • BaseContract
    • IPremiaStaking

Properties

DOMAIN_SEPARATOR [internal] addRewards allowance approve balanceOf circulatingSupply decimals decreaseAllowance earlyUnstake estimateSendFee fallback filters getAvailablePremiaAmount getAvailableRewards getDiscount getEarlyUnstakeFee getPendingRewards getPendingUserRewards getPendingWithdrawal getRewardToken getStakeLevels getStakePeriodMultiplier getTotalPower getUserInfo getUserPower harvest harvestAndStake increaseAllowance interface name nonces permit runner sendFrom stake stakeWithPermit startWithdraw supportsInterface symbol target totalSupply transfer transferFrom updateLock withdraw

Methods

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

Properties

DOMAIN_SEPARATOR

DOMAIN_SEPARATOR: TypedContractMethod<[], [string], "view">

Readonly [internal]

[internal]: any

addRewards

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

allowance

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

approve

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

balanceOf

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

circulatingSupply

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

decimals

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

decreaseAllowance

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

earlyUnstake

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

estimateSendFee

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

Readonly fallback

fallback: null | WrappedFallback

filters

filters: {
    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>;
    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

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

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

getAvailableRewards

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

getDiscount

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

getEarlyUnstakeFee

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

getPendingRewards

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

getPendingUserRewards

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

getPendingWithdrawal

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

getRewardToken

getRewardToken: TypedContractMethod<[], [string], "view">

getStakeLevels

getStakeLevels: TypedContractMethod<[], [StakeLevelStructOutput[]], "nonpayable">

getStakePeriodMultiplier

getStakePeriodMultiplier: TypedContractMethod<[period: BigNumberish], [bigint], "nonpayable">

getTotalPower

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

getUserInfo

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

getUserPower

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

harvest

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

harvestAndStake

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

increaseAllowance

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

interface

interface: IPremiaStakingInterface

name

name: TypedContractMethod<[], [string], "view">

nonces

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

permit

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

Readonly runner

runner: null | ContractRunner

sendFrom

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

stake

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

stakeWithPermit

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

startWithdraw

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

supportsInterface

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

symbol

symbol: TypedContractMethod<[], [string], "view">

Readonly target

target: string | Addressable

totalSupply

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

transfer

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

transferFrom

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

updateLock

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

withdraw

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

Methods

addListener

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IPremiaStaking>

attach

  • Parameters

    • addressOrName: AddressLike

    Returns IPremiaStaking

connect

  • Parameters

    • Optional runner: null | ContractRunner

    Returns BaseContract

deployed

deploymentTransaction

  • Returns null | ContractTransactionResponse

emit

  • Parameters

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

    Returns Promise<boolean>

getAddress

  • Returns Promise<string>

getDeployedCode

  • Returns Promise<null | string>

getEvent

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

getFunction

  • 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: "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: "getRewardToken"

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

  • Parameters

    • nameOrSignature: "getStakeLevels"

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

  • Parameters

    • nameOrSignature: "getStakePeriodMultiplier"

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

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

listenerCount

  • 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

  • Parameters

    • event: ContractEventName
    • Optional listener: Listener

    Returns Promise<IPremiaStaking>

on

  • Type Parameters

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

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IPremiaStaking>

  • Type Parameters

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

    Parameters

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

    Returns Promise<IPremiaStaking>

once

  • Type Parameters

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

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IPremiaStaking>

  • Type Parameters

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

    Parameters

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

    Returns Promise<IPremiaStaking>

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

  • Parameters

    • hash: string

    Returns Promise<EventLog[]>

removeAllListeners

  • Type Parameters

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

    Parameters

    • Optional event: TCEvent

    Returns Promise<IPremiaStaking>

removeListener

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IPremiaStaking>

waitForDeployment

  • Returns Promise<IPremiaStaking>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc