Class VxPremiaAPI

Hierarchy

BaseAPI
- VxPremiaAPI

Index

Constructors

Properties

Methods

cancelAllStreams castVotes earlyUnstake encodeCastVotes encodeCastVotesSync encodeEarlyUnstake encodeEarlyUnstakeSync encodeHarvest encodeHarvestAndStake encodeHarvestAndStakeSync encodeHarvestSync encodeSendFrom encodeSendFromSync encodeStake encodeStakeSync encodeStakeWithPermit encodeStakeWithPermitSync encodeStartWithdraw encodeStartWithdrawSync encodeUpdateLock encodeUpdateLockSync encodeWithdraw encodeWithdrawSync estimateSendFee getAllLastVaultVotes getAvailablePremiaAmount getAvailableRewards getDiscount getEarlyUnstakeFee getLastUserStakeFromTimestamp getLastUserStakes getPendingRewards getPendingUserRewards getPendingWithdrawal getPendingWithdrawals getStakeHistories getStakeHistory getStakeLevels getStakePeriodMultiplier getTotalPower getUserInfo getUserPower getUserStakes getUserVaultVotesFromTimestamp getUserVotes getVaultVotes getVoteHistory getVotesForVault harvest harvestAndStake sendFrom stake stakeWithPermit startWithdraw updateLock withdraw

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:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

castVotes

castVotes(votes, provider?): Promise<ContractTransactionResponse>
Casts votes.
Parameters
- votes: Vote[]
  
  An array of Vote instances representing the votes to be cast.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:610

earlyUnstake

earlyUnstake(amount, provider?): Promise<ContractTransactionResponse>
Unstakes early.
Parameters
- amount: BigNumberish
  
  The amount to be unstaked.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:1030

encodeCastVotes

encodeCastVotes(votes, provider?): Promise<ContractTransaction>
Encodes a transaction to cast votes.
Parameters
- votes: Vote[]
  
  An array of Vote instances representing the votes to be cast.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:575

encodeCastVotesSync

encodeCastVotesSync(votes, provider?): TransactionData
Encodes a transaction to cast votes.
Parameters
- votes: Vote[]
  
  An array of Vote instances representing the votes to be cast.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:590

encodeEarlyUnstake

encodeEarlyUnstake(amount, provider?): Promise<ContractTransaction>
Encodes a transaction to unstake early.
Parameters
- amount: BigNumberish
  
  The amount to be unstaked.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:994

encodeEarlyUnstakeSync

encodeEarlyUnstakeSync(amount, provider?): TransactionData
Encodes a transaction to unstake early.
Parameters
- amount: BigNumberish
  
  The amount to be unstaked.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:1009

encodeHarvest

encodeHarvest(provider?): Promise<ContractTransaction>
Encodes a transaction to harvest.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:950

encodeHarvestAndStake

encodeHarvestAndStake(options, provider?): 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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:843

encodeHarvestAndStakeSync

encodeHarvestAndStakeSync(options, provider?): TransactionData
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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:881

encodeHarvestSync

encodeHarvestSync(provider?): TransactionData
Encodes a transaction to harvest.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:961

encodeSendFrom

encodeSendFrom(from, destinationChainId, toAddress, amount, refundAddress, zroPaymentAddress, adapterParams, provider?): 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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:466

encodeSendFromSync

encodeSendFromSync(from, destinationChainId, toAddress, amount, refundAddress, zroPaymentAddress, adapterParams, provider?): TransactionData
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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:501

encodeStake

encodeStake(amount, period, provider?): Promise<ContractTransaction>
Encodes a transaction to stake.
Parameters
- amount: BigNumberish
  
  The amount to be staked.
- period: BigNumberish
  
  The staking period.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:631

encodeStakeSync

encodeStakeSync(amount, period, provider?): TransactionData
Encodes a transaction to stake.
Parameters
- amount: BigNumberish
  
  The amount to be staked.
- period: BigNumberish
  
  The staking period.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:649

encodeStakeWithPermit

encodeStakeWithPermit(amount, period, deadline, signature, provider?): Promise<ContractTransaction>
Encodes a transaction to stake using IERC2612 permit.
Parameters
- amount: BigNumberish
  
  The amount of xPremia to stake.
- period: BigNumberish
  
  The lockup period (in seconds).
- deadline: BigNumberish
  
  The deadline after which permit will fail.
- signature: Signature
  
  The signature for the transaction.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:698

encodeStakeWithPermitSync

encodeStakeWithPermitSync(amount, period, deadline, signature, provider?): TransactionData
Encodes a transaction to stake using IERC2612 permit.
Parameters
- amount: BigNumberish
  
  The amount of xPremia to stake.
- period: BigNumberish
  
  The lockup period (in seconds).
- deadline: BigNumberish
  
  The deadline after which permit will fail.
- signature: Signature
  
  The signature for the transaction.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:726

encodeStartWithdraw

encodeStartWithdraw(amount, provider?): Promise<ContractTransaction>
Encodes a transaction to start a withdrawal.
Parameters
- amount: BigNumberish
  
  The amount to be withdrawn.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:1049

encodeStartWithdrawSync

encodeStartWithdrawSync(amount, provider?): TransactionData
Encodes a transaction to start a withdrawal.
Parameters
- amount: BigNumberish
  
  The amount to be withdrawn.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:1064

encodeUpdateLock

encodeUpdateLock(period, provider?): Promise<ContractTransaction>
Encodes a transaction to update the lock period.
Parameters
- period: BigNumberish
  
  The lock period.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:782

encodeUpdateLockSync

encodeUpdateLockSync(period, provider?): TransactionData
Encodes a transaction to update the lock period.
Parameters
- period: BigNumberish
  
  The lock period.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:797

encodeWithdraw

encodeWithdraw(provider?): Promise<ContractTransaction>
Encodes a transaction to withdraw.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
- A promise that resolves to a ContractTransaction instance representing the encoded transaction.
- Defined in src/api/vxPremiaAPI.ts:1105

encodeWithdrawSync

encodeWithdrawSync(provider?): TransactionData
Encodes a transaction to withdraw.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
- The encoded transaction data.
- Defined in src/api/vxPremiaAPI.ts:1116

estimateSendFee

estimateSendFee(destinationChainId, toAddress, amount, useZro, adapterParams, provider?): 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.
- Optional provider: Provider
  
  The custom provider to use for this call.
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:432

getAllLastVaultVotes

getAllLastVaultVotes(orderBy, order, limit?, 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 limit: 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:87

getAvailablePremiaAmount

getAvailablePremiaAmount(provider?): Promise<bigint>
Gets the available amount of Premia.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves the available amount of Premia.
- Defined in src/api/vxPremiaAPI.ts:413

getAvailableRewards

getAvailableRewards(provider?): Promise<[bigint, bigint] & {
rewards: bigint;
unstakeRewards: bigint;
}>
Retrieves the total amount of available rewards.

Params
provider - The custom provider to use for this call.
Parameters
- Optional provider: Provider
Returns Promise<[bigint, bigint] & {
rewards: bigint;
unstakeRewards: bigint;
}>
- A promise that resolves to the amount of available rewards and unstake rewards respectively.
- Defined in src/api/vxPremiaAPI.ts:220

getDiscount

getDiscount(user, provider?): Promise<bigint>
Gets the discount a user receives.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to the user's discount.
- Defined in src/api/vxPremiaAPI.ts:311

getEarlyUnstakeFee

getEarlyUnstakeFee(user, provider?): Promise<bigint>
Gets the fee percentage a user would have to pay to unstake early. (fee percentage * lock amount = fee amount)
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to fee percentage for unstaking early.
- Defined in src/api/vxPremiaAPI.ts:270

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:145

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:116

getPendingRewards

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

Params
provider - The custom provider to use for this call.
Parameters
- Optional provider: Provider
Returns Promise<bigint>
- A promise that resolves to a the total amount of pending rewards.
- Defined in src/api/vxPremiaAPI.ts:238

getPendingUserRewards

getPendingUserRewards(user, provider?): Promise<[bigint, bigint] & {
reward: bigint;
unstakeReward: bigint;
}>
Retrieves the amount of rewards that are pending for a specific user.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<[bigint, bigint] & {
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:252

getPendingWithdrawal

getPendingWithdrawal(user, provider?): Promise<[bigint, bigint, bigint] & {
    amount: bigint;
    startDate: bigint;
    unlockDate: bigint;
}>
Retrieves the information of a pending withdrawal of a user.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<[bigint, bigint, bigint] & {
    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:357

getPendingWithdrawals

getPendingWithdrawals(provider?): Promise<bigint>
Gets the total amount of withdrawals.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to the total amount of pending withdrawals.
- Defined in src/api/vxPremiaAPI.ts:342

getStakeHistories

getStakeHistories(startTime, limit?, skip?): Promise<StakeHistory[]>
Retrieves stake histories for a given start time.
Parameters
- startTime: number
  
  The start time for retrieving stake histories.
- Optional limit: 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:170

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:158

getStakeLevels

getStakeLevels(provider?): Promise<StakeLevelStructOutput[]>
Gets the stake levels.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<StakeLevelStructOutput[]>
- A Promise that resolves to a ContractTransactionResponse instance representing the stake levels.
- Defined in src/api/vxPremiaAPI.ts:380

getStakePeriodMultiplier

getStakePeriodMultiplier(period, provider?): Promise<bigint>
Gets the stake period multiplier.
Parameters
- period: BigNumberish
  
  The duration (in seconds) for which tokens are locked
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- Returns a Promise that resolves to the multiplier for this staking period
- Defined in src/api/vxPremiaAPI.ts:397

getTotalPower

getTotalPower(provider?): Promise<bigint>
Gets the total power across all users (applying the bonus from lockup period chosen)
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to the total power across all users
- Defined in src/api/vxPremiaAPI.ts:283

getUserInfo

getUserInfo(user, provider?): Promise<UserInfoStructOutput>
Gets the information of a user.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<UserInfoStructOutput>
- A promise that resolves to a UserInfoStructOutput instance representing the user's information.
- Defined in src/api/vxPremiaAPI.ts:326

getUserPower

getUserPower(user, provider?): Promise<bigint>
Gets the power associated with a specific user.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to the user's power.
- Defined in src/api/vxPremiaAPI.ts:297

getUserStakes

getUserStakes(startTime, user, limit?, 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 limit: 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:129

getUserVaultVotesFromTimestamp

getUserVaultVotesFromTimestamp(user, timestampFrom, timestampTo, limit?, 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 limit: 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:62

getUserVotes

getUserVotes(user, provider?): Promise<VoteStructOutput[]>
Retrieves all votes a particular user has cast.
Parameters
- user: string
  
  The address of the user.
- Optional provider: Provider
  
  The custom provider to use for this call.
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, limit?, skip?): Promise<VaultVote[]>
Retrieves vault votes for a given user.
Parameters
- user: string
  
  The user's address.
- Optional limit: 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:44

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:107

getVotesForVault

getVotesForVault(vaultAddress, provider?): Promise<bigint>
Retrieves the total number of votes associated with a specific vault.
Parameters
- vaultAddress: string
  
  The Ethereum address of the vault.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
- A promise that resolves to the total number of votes.
- Defined in src/api/vxPremiaAPI.ts:185

harvest

harvest(provider?): Promise<ContractTransactionResponse>
Harvests.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:978

harvestAndStake

harvestAndStake(options, provider?): 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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:925

sendFrom

sendFrom(from, destinationChainId, toAddress, amount, refundAddress, zroPaymentAddress, adapterParams, provider?): 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.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the transaction.
- Defined in src/api/vxPremiaAPI.ts:541

stake

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

stakeWithPermit

stakeWithPermit(amount, period, deadline, signature, provider?): Promise<ContractTransactionResponse>
Stake using IERC2612 permit.
Parameters
- amount: BigNumberish
  
  The amount of xPremia to stake.
- period: BigNumberish
  
  The lockup period (in seconds).
- deadline: BigNumberish
  
  The deadline after which permit will fail.
- signature: Signature
  
  The signature for the transaction.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:760

startWithdraw

startWithdraw(amount, provider?): Promise<ContractTransactionResponse>
Starts a withdrawal.
Parameters
- amount: BigNumberish
  
  The amount to be withdrawn.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:1087

updateLock

updateLock(period, provider?): Promise<ContractTransactionResponse>
Updates the lock period.
Parameters
- period: BigNumberish
  
  The lock period.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:818

withdraw

withdraw(provider?): Promise<ContractTransactionResponse>
Withdraws.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransactionResponse>
- A promise that resolves to a ContractTransactionResponse instance representing the result of the transaction.
- Defined in src/api/vxPremiaAPI.ts:1133

Class VxPremiaAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns VxPremiaAPI

Properties

Readonly premia

Protected streamIndex

Methods

cancelAllStreams

Returns Promise<void>

castVotes

Parameters

votes: Vote[]

Optional provider: Provider

Returns Promise<ContractTransactionResponse>

earlyUnstake

Parameters

amount: BigNumberish

Optional provider: Provider

Returns Promise<ContractTransactionResponse>

encodeCastVotes

Parameters

votes: Vote[]

Optional provider: Provider

Returns Promise<ContractTransaction>

encodeCastVotesSync

Parameters

votes: Vote[]

Optional provider: Provider

Returns TransactionData

encodeEarlyUnstake

Parameters

amount: BigNumberish

Optional provider: Provider

Returns Promise<ContractTransaction>

encodeEarlyUnstakeSync

Parameters

amount: BigNumberish

Optional provider: Provider

Returns TransactionData

encodeHarvest

Parameters

Optional provider: Provider

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

Optional provider: Provider

Returns Promise<ContractTransaction>

encodeHarvestAndStakeSync

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

Optional provider: Provider

Returns TransactionData

encodeHarvestSync

Parameters

Optional provider: Provider

Returns TransactionData

encodeSendFrom

Parameters

from: string

`Readonly` premia

`Protected` streamIndex

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

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

`Optional` provider: Provider

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

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider