Class VxPremiaAPI

Hierarchy

BaseAPI
- VxPremiaAPI

Constructors

constructor

new VxPremiaAPI(premia): VxPremiaAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns VxPremiaAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:17

Properties

`Readonly` premia

premia: Premia

Methods

castVotes

castVotes(votes): Promise<ContractTransactionResponse>
Casts votes.
Parameters
- votes: Vote[]
  
  An array of Vote instances representing the votes to be cast.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:480

earlyUnstake

earlyUnstake(amount): Promise<ContractTransactionResponse>
Unstakes early.
Parameters
- amount: BigNumberish
  
  The amount to be unstaked.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:658

encodeCastVotes

encodeCastVotes(votes): Promise<ContractTransaction>
Encodes a transaction to cast votes.
Parameters
- votes: Vote[]
  
  An array of Vote instances representing the votes to be cast.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:463

encodeEarlyUnstake

encodeEarlyUnstake(amount): Promise<ContractTransaction>
Encodes a transaction to unstake early.
Parameters
- amount: BigNumberish
  
  The amount to be unstaked.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:646

encodeHarvest

encodeHarvest(): Promise<ContractTransaction>
Encodes a transaction to harvest.

Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:620

encodeHarvestAndStake

encodeHarvestAndStake(options): Promise<ContractTransaction>
Encodes a transaction to harvest and stake.
Parameters
- options: {
      allowanceTarget: string;
      amountOutMin: BigNumberish;
      callee: string;
      data: string;
      refundAddress: string;
      stakePeriod: BigNumberish;
  }
  
  The options for the operation.
  - allowanceTarget: string
    
    The allowance target address.
  - amountOutMin: BigNumberish
    
    The minimum amount out.
  - callee: string
    
    The callee address.
  - data: string
    
    The data for the operation.
  - refundAddress: string
    
    The refund address.
  - stakePeriod: BigNumberish
    
    The stake period.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:564

encodeSendFrom

encodeSendFrom(from, destinationChainId, toAddress, amount, refundAddress, zroPaymentAddress, adapterParams): Promise<ContractTransaction>
Encodes a transaction to bridge vxPREMIA tokens to the destination chain.
Parameters
- from: string
  
  The address from which the tokens will be sent.
- destinationChainId: BigNumberish
  
  The id of the destination chain.
- toAddress: string
  
  The address to which the tokens will be sent.
- amount: BigNumberish
  
  The amount of tokens to be sent.
- refundAddress: string
  
  The address to which the tokens will be refunded in case of failure.
- zroPaymentAddress: string
  
  The address to which the ZRO payment will be sent.
- adapterParams: BytesLike
  
  The adapter params.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:399

encodeStake

encodeStake(amount, period): Promise<ContractTransaction>
Encodes a transaction to stake.
Parameters
- amount: BigNumberish
  
  The amount to be staked.
- period: BigNumberish
  
  The staking period.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:497

encodeStartWithdraw

encodeStartWithdraw(amount): Promise<ContractTransaction>
Encodes a transaction to start a withdrawal.
Parameters
- amount: BigNumberish
  
  The amount to be withdrawn.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:675

encodeUpdateLock

encodeUpdateLock(period): Promise<ContractTransaction>
Encodes a transaction to update the lock period.
Parameters
- period: BigNumberish
  
  The lock period.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:531

encodeWithdraw

encodeWithdraw(): Promise<ContractTransaction>
Encodes a transaction to withdraw.

Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:705

estimateSendFee

estimateSendFee(destinationChainId, toAddress, amount, useZro, adapterParams): Promise<[bigint, bigint] & {
nativeFee: bigint;
zroFee: bigint;
}>
Estimates the fee for bridging vxPREMIA to the destination chain.
Parameters
- destinationChainId: BigNumberish
  
  The id of the destination chain.
- toAddress: string
  
  The address to which the tokens will be sent.
- amount: BigNumberish
  
  The amount of tokens to be sent.
- useZro: boolean
  
  Whether to use ZRO or not.
- adapterParams: BytesLike
  
  The adapter params.
Returns Promise<[bigint, bigint] & {
nativeFee: bigint;
zroFee: bigint;
}>
- A promise that resolves to the fee for bridging vxPREMIA to the destination chain.
- Defined in src/api/vxPremiaAPI.ts:369

getAllLastVaultVotes

getAllLastVaultVotes(orderBy, order, first?, skip?): Promise<VaultVote[]>
Retrieves all the last vault votes.
Parameters
- orderBy: string
  
  The field to order the results by.
- order: string
  
  The order direction ('asc' or 'desc').
- Optional first: number = 100
  
  The maximum number of records to retrieve.
- Optional skip: number = 0
  
  The number of records to skip.
Returns Promise<VaultVote[]>
A promise that resolves to an array of vault votes.
- Defined in src/api/vxPremiaAPI.ts:91

getAvailablePremiaAmount

getAvailablePremiaAmount(): Promise<bigint>
Gets the available amount of Premia.

Returns Promise<bigint>
- A promise that resolves the available amount of Premia.
- Defined in src/api/vxPremiaAPI.ts:353

getAvailableRewards

getAvailableRewards(): Promise<{
rewards: bigint;
unstakeRewards: bigint;
}>
Retrieves the total amount of available rewards.

Returns Promise<{
rewards: bigint;
unstakeRewards: bigint;
}>
- A promise that resolves to the amount of available rewards and unstake rewards respectively.
- Defined in src/api/vxPremiaAPI.ts:216

getDiscount

getDiscount(user): Promise<bigint>
Gets the discount a user receives.
Parameters
- user: string
  
  The address of the user.
Returns Promise<bigint>
- A promise that resolves to the user's discount.
- Defined in src/api/vxPremiaAPI.ts:282

getEarlyUnstakeFee

getEarlyUnstakeFee(user): Promise<bigint>
Gets the fee a user would have to pay to unstake early.
Parameters
- user: string
  
  The address of the user.
Returns Promise<bigint>
- A promise that resolves to fee for unstaking early.
- Defined in src/api/vxPremiaAPI.ts:251

getLastUserStakeFromTimestamp

getLastUserStakeFromTimestamp(timestamp, user): Promise<UserStake[]>
Retrieves the last user stake from a given timestamp.
Parameters
- timestamp: number
  
  The timestamp for retrieving the stake.
- user: string
  
  The user's address.
Returns Promise<UserStake[]>
A promise that resolves to an array of user stakes.
- Defined in src/api/vxPremiaAPI.ts:149

getLastUserStakes

getLastUserStakes(): Promise<UserStake[]>
Retrieves the last user stakes.

Returns Promise<UserStake[]>
A promise that resolves to an array of user stakes.
- Defined in src/api/vxPremiaAPI.ts:120

getPendingRewards

getPendingRewards(): Promise<bigint>
Calculates the total amount of rewards that are pending distribution.

Returns Promise<bigint>
- A promise that resolves to a the total amount of pending rewards.
- Defined in src/api/vxPremiaAPI.ts:228

getPendingUserRewards

getPendingUserRewards(user): Promise<{
reward: bigint;
unstakeReward: bigint;
}>
Retrieves the amount of rewards that are pending for a specific user.
Parameters
- user: string
  
  The address of the user.
Returns Promise<{
reward: bigint;
unstakeReward: bigint;
}>
- A promise that resolves to the amount of rewards and unstake rewards that are pending for the user respectively.
- Defined in src/api/vxPremiaAPI.ts:239

getPendingWithdrawal

getPendingWithdrawal(user): Promise<{
    amount: bigint;
    startDate: bigint;
    unlockDate: bigint;
}>
Retrieves the information of a pending withdrawal of a user.
Parameters
- user: string
  
  The address of the user.
Returns Promise<{
    amount: bigint;
    startDate: bigint;
    unlockDate: bigint;
}>
- A promise that resolves to the amount, start date, and unlock date of the user's pending withdrawal respectively.
- Defined in src/api/vxPremiaAPI.ts:318

getPendingWithdrawals

getPendingWithdrawals(): Promise<bigint>
Gets the total amount of withdrawals.

Returns Promise<bigint>
- A promise that resolves to the total amount of pending withdrawals.
- Defined in src/api/vxPremiaAPI.ts:306

getStakeHistories

getStakeHistories(startTime, first?, skip?): Promise<StakeHistory[]>
Retrieves stake histories for a given start time.
Parameters
- startTime: number
  
  The start time for retrieving stake histories.
- Optional first: number = 100
  
  The maximum number of records to retrieve.
- Optional skip: number = 0
  
  The number of records to skip.
Returns Promise<StakeHistory[]>
A promise that resolves to an array of stake histories.
- Defined in src/api/vxPremiaAPI.ts:174

getStakeHistory

getStakeHistory(id): Promise<StakeHistory>
Retrieves stake history for a given id.
Parameters
- id: string
  
  The id of the stake.
Returns Promise<StakeHistory>
A promise that resolves to the stake history.
- Defined in src/api/vxPremiaAPI.ts:162

getStakeLevels

getStakeLevels(): Promise<StakeLevelStructOutput[]>
Gets the stake levels.

Returns Promise<StakeLevelStructOutput[]>
- A Promise that resolves to a ContractTransactionResponse instance representing the stake levels.
- Defined in src/api/vxPremiaAPI.ts:331

getStakePeriodMultiplier

getStakePeriodMultiplier(period): Promise<bigint>
Gets the stake period multiplier.
Parameters
- period: BigNumberish
  
  The duration (in seconds) for which tokens are locked
Returns Promise<bigint>
- Returns a Promise that resolves to the multiplier for this staking period
- Defined in src/api/vxPremiaAPI.ts:343

getTotalPower

getTotalPower(): Promise<bigint>
Gets the total power across all users (applying the bonus from lockup period chosen)

Returns Promise<bigint>
- A promise that resolves to the total power across all users
- Defined in src/api/vxPremiaAPI.ts:261

getUserInfo

getUserInfo(user): Promise<UserInfoStructOutput>
Gets the information of a user.
Parameters
- user: string
  
  The address of the user.
Returns Promise<UserInfoStructOutput>
- A promise that resolves to a UserInfoStructOutput instance representing the user's information.
- Defined in src/api/vxPremiaAPI.ts:294

getUserPower

getUserPower(user): Promise<bigint>
Gets the power associated with a specific user.
Parameters
- user: string
  
  The address of the user.
Returns Promise<bigint>
- A promise that resolves to the user's power.
- Defined in src/api/vxPremiaAPI.ts:272

getUserStakes

getUserStakes(startTime, user, first?, skip?): Promise<UserStake[]>
Retrieves user stakes for a given start time.
Parameters
- startTime: number
  
  The start time for retrieving stakes.
- user: string
  
  The user's address.
- Optional first: number = 100
  
  The maximum number of records to retrieve.
- Optional skip: number = 0
  
  The number of records to skip.
Returns Promise<UserStake[]>
A promise that resolves to an array of user stakes.
- Defined in src/api/vxPremiaAPI.ts:133

getUserVaultVotesFromTimestamp

getUserVaultVotesFromTimestamp(user, timestampFrom, timestampTo, first?, skip?): Promise<VaultVote[]>
Retrieves vault votes for a given user and timestamp range.
Parameters
- user: string
  
  The user's address.
- timestampFrom: number
  
  The start timestamp for the range.
- timestampTo: number
  
  The end timestamp for the range.
- Optional first: number = 100
  
  The maximum number of records to retrieve.
- Optional skip: number = 0
  
  The number of records to skip.
Returns Promise<VaultVote[]>
A promise that resolves to an array of vault votes.
- Defined in src/api/vxPremiaAPI.ts:65

getUserVotes

getUserVotes(user): Promise<VoteStructOutput[]>
Retrieves all votes a particular user has cast.
Parameters
- user: string
  
  The address of the user.
Returns Promise<VoteStructOutput[]>
- A promise that resolves to an array of VoteStructOutput instances representing each vote the user has cast.
- Defined in src/api/vxPremiaAPI.ts:203

getVaultVotes

getVaultVotes(user, first?, skip?): Promise<VaultVote[]>
Retrieves vault votes for a given user.
Parameters
- user: string
  
  The user's address.
- Optional first: number = 100
  
  The maximum number of records to retrieve.
- Optional skip: number = 0
  
  The number of records to skip.
Returns Promise<VaultVote[]>
A promise that resolves to an array of vault votes.
- Defined in src/api/vxPremiaAPI.ts:46

getVoteHistory

getVoteHistory(id): Promise<VoteHistory>
Retrieves vote history for a given id.
Parameters
- id: string
  
  The id of the vote.
Returns Promise<VoteHistory>
A promise that resolves to the vote history.
- Defined in src/api/vxPremiaAPI.ts:111

getVotesForVault

getVotesForVault(vaultAddress): Promise<bigint>
Retrieves the total number of votes associated with a specific vault.
Parameters
- vaultAddress: string
  
  The Ethereum address of the vault.
Returns Promise<bigint>
- A promise that resolves to the total number of votes.
- Defined in src/api/vxPremiaAPI.ts:188

harvest

harvest(): Promise<ContractTransactionResponse>
Harvests.

Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:631

harvestAndStake

harvestAndStake(options): Promise<ContractTransactionResponse>
Harvests and stakes.
Parameters
- options: {
      allowanceTarget: string;
      amountOutMin: BigNumberish;
      callee: string;
      data: string;
      refundAddress: string;
      stakePeriod: BigNumberish;
  }
  
  The options for the operation.
  - allowanceTarget: string
    
    The allowance target address.
  - amountOutMin: BigNumberish
    
    The minimum amount out.
  - callee: string
    
    The callee address.
  - data: string
    
    The data for the operation.
  - refundAddress: string
    
    The refund address.
  - stakePeriod: BigNumberish
    
    The stake period.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:599

sendFrom

sendFrom(from, destinationChainId, toAddress, amount, refundAddress, zroPaymentAddress, adapterParams): Promise<ContractTransactionResponse>
Bridges vxPREMIA tokens to the destination chain.
Parameters
- from: string
  
  The address from which the tokens will be sent.
- destinationChainId: BigNumberish
  
  The id of the destination chain.
- toAddress: string
  
  The address to which the tokens will be sent.
- amount: BigNumberish
  
  The amount of tokens to be sent.
- refundAddress: string
  
  The address to which the tokens will be refunded in case of failure.
- zroPaymentAddress: string
  
  The address to which the ZRO payment will be sent.
- adapterParams: BytesLike
  
  The adapter params.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the transaction.
- Defined in src/api/vxPremiaAPI.ts:432

stake

stake(amount, period): Promise<ContractTransactionResponse>
Stakes an amount for a certain period.
Parameters
- amount: BigNumberish
  
  The amount to be staked.
- period: BigNumberish
  
  The staking period.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:513

startWithdraw

startWithdraw(amount): Promise<ContractTransactionResponse>
Starts a withdrawal.
Parameters
- amount: BigNumberish
  
  The amount to be withdrawn.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:689

updateLock

updateLock(period): Promise<ContractTransactionResponse>
Updates the lock period.
Parameters
- period: BigNumberish
  
  The lock period.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:543

withdraw

withdraw(): Promise<ContractTransactionResponse>
Withdraws.

Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:716

Class VxPremiaAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns VxPremiaAPI

Properties

Readonly premia

Methods

castVotes

Parameters

votes: Vote[]

Returns Promise<ContractTransactionResponse>

earlyUnstake

Parameters

amount: BigNumberish

Returns Promise<ContractTransactionResponse>

encodeCastVotes

Parameters

votes: Vote[]

Returns Promise<ContractTransaction>

encodeEarlyUnstake

Parameters

amount: BigNumberish

Returns Promise<ContractTransaction>

encodeHarvest

Returns Promise<ContractTransaction>

encodeHarvestAndStake

Parameters

options: { allowanceTarget: string; amountOutMin: BigNumberish; callee: string; data: string; refundAddress: string; stakePeriod: BigNumberish; }

allowanceTarget: string

amountOutMin: BigNumberish

callee: string

data: string

refundAddress: string

stakePeriod: BigNumberish

Returns Promise<ContractTransaction>

encodeSendFrom

Parameters

from: string

destinationChainId: BigNumberish

toAddress: string

amount: BigNumberish

refundAddress: string

zroPaymentAddress: string

adapterParams: BytesLike

Returns Promise<ContractTransaction>

encodeStake

Parameters

amount: BigNumberish

period: BigNumberish

Returns Promise<ContractTransaction>

encodeStartWithdraw

Parameters

amount: BigNumberish

Returns Promise<ContractTransaction>

encodeUpdateLock

Parameters

period: BigNumberish

Returns Promise<ContractTransaction>

encodeWithdraw

Returns Promise<ContractTransaction>

estimateSendFee

Parameters

destinationChainId: BigNumberish

toAddress: string

amount: BigNumberish

useZro: boolean

adapterParams: BytesLike

Returns Promise<[bigint, bigint] & { nativeFee: bigint; zroFee: bigint; }>

getAllLastVaultVotes

Parameters

orderBy: string

order: string

Optional first: number = 100

`Readonly` premia

options: {
allowanceTarget: string;
amountOutMin: BigNumberish;
callee: string;
data: string;
refundAddress: string;
stakePeriod: BigNumberish;
}

Returns Promise<[bigint, bigint] & {
nativeFee: bigint;
zroFee: bigint;
}>

`Optional` first: number = 100

`Optional` skip: number = 0

Returns Promise<{
rewards: bigint;
unstakeRewards: bigint;
}>

Returns Promise<{
reward: bigint;
unstakeReward: bigint;
}>

Returns Promise<{
amount: bigint;
startDate: bigint;
unlockDate: bigint;
}>

`Optional` first: number = 100

`Optional` skip: number = 0

`Optional` first: number = 100

`Optional` skip: number = 0