Class MiningAPI

Represents a class for handling operations related to making liquidity mining.

Hierarchy

BaseAPI
- MiningAPI

Index

Constructors

constructor

new MiningAPI(premia): MiningAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns MiningAPI
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

encodeClaim

encodeClaim(vaults, amount, provider?): Promise<ContractTransaction>
Encodes the claim parameters into a transaction that can be broadcasted to the provider network.
Parameters
- vaults: string[]
  
  array of addresses of vaults to claim partial amount.
- amount: BigNumberish
  
  amount of rewards to claim.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
A promise that resolves to a contract transaction for the claim operation.
- Defined in src/api/miningAPI.ts:238

encodeClaimAll

encodeClaimAll(vaults, provider?): Promise<ContractTransaction>
Encodes the claimAll parameters into a transaction that can be broadcasted to the provider network.
Parameters
- vaults: string[]
  
  array of addresses of vaults to claim all rewards.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
A promise that resolves to a contract transaction for the claimAll operation.
- Defined in src/api/miningAPI.ts:201

encodeClaimAllSync

encodeClaimAllSync(vaults, provider?): TransactionData
Encodes the claimAll parameters into a transaction that can be broadcasted to the provider network.
Parameters
- vaults: string[]
  
  array of addresses of vaults to claim all rewards.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
The encoded transaction data.
- Defined in src/api/miningAPI.ts:217

encodeClaimSync

encodeClaimSync(vaults, amount, provider?): TransactionData
Encodes the claim parameters into a transaction that can be broadcasted to the provider network.
Parameters
- vaults: string[]
  
  array of addresses of vaults to claim partial amount.
- amount: BigNumberish
  
  amount of rewards to claim.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
The encoded transaction data.
- Defined in src/api/miningAPI.ts:256

getDualMiningRewards

getDualMiningRewards(__namedParameters, provider?): Promise<bigint>
Returns a promise containing amount of user rewards.
Parameters
- __namedParameters: {
  user: string;
  vault: string;
  }
  - user: string
  - vault: string
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
Promise amount of pending dual mining rewards.
- Defined in src/api/miningAPI.ts:91

getPendingUserRewardsFromVault

getPendingUserRewardsFromVault(__namedParameters, provider?): Promise<bigint>
Returns a promise containing the amount of pending user rewards for a vault.
Parameters
- __namedParameters: {
  user: string;
  vault: string;
  }
  - user: string
  - vault: string
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
Promise the amount of pending user rewards for a vault.
- Defined in src/api/miningAPI.ts:36

getRewardsPerYear

getRewardsPerYear(provider?): Promise<bigint>
Returns the total number of rewards across all targets for the next year.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
A promise that resolves to the total number of rewards across all targets for the next year.
- Defined in src/api/miningAPI.ts:187

getTotalUserRewards

getTotalUserRewards(user, provider?): Promise<bigint>
Returns a promise containing total amount of pending user rewards.
Parameters
- user: {
  user: string;
  }
  
  The address of the user.
  - user: string
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
Promise total amount of pending user rewards.
- Defined in src/api/miningAPI.ts:58

getTotalVotes

getTotalVotes(provider?): Promise<bigint>
Returns the total number of votes across all targets (vaults).
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
A promise that resolves to the total number of votes across all targets (vaults).
- Defined in src/api/miningAPI.ts:141

getUserInfo

getUserInfo(user, vaultAddress, provider?): Promise<IVaultMining.UserInfoStructOutput>
Returns the UserInfo including the votes of the specified user in the vault.
Parameters
- user: string
  
  The address of the user.
- vaultAddress: string
  
  The address of the vault.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<IVaultMining.UserInfoStructOutput>
A promise that resolves to the UserInfo including the votes of the specified user in the vault.
- Defined in src/api/miningAPI.ts:171

getUserRewards

getUserRewards(user, provider?): Promise<bigint>
Returns a promise containing amount of user rewards.
Parameters
- user: {
  user: string;
  }
  
  The address of the user.
  - user: string
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
Promise amount of user rewards.
- Defined in src/api/miningAPI.ts:74

getVaultInfo

getVaultInfo(vaultAddress, provider?): Promise<VaultInfoStructOutput>
Returns the VaultInfo including the number of votes for the specified vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<VaultInfoStructOutput>
A promise that resolves to the VaultInfo including the number of votes for the specified vault.
- Defined in src/api/miningAPI.ts:154

getVoteMultiplier

getVoteMultiplier(vault, provider?): Promise<bigint>
Returns a promise containing vote multipler for a vault.
Parameters
- vault: {
  vault: string;
  }
  
  The address of the vault.
  - vault: string
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
Promise vote multiplier for a vault.
- Defined in src/api/miningAPI.ts:19

previewOptionParams

previewOptionParams(provider?): Promise<[bigint, bigint] & {
maturity: bigint;
strike: bigint;
}>
Returns strike and maturity before claiming premia option rewards.
Parameters
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<[bigint, bigint] & {
maturity: bigint;
strike: bigint;
}>
A promise that resolves to the strike and maturity for premia option rewards.
- Defined in src/api/miningAPI.ts:124

Class MiningAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns MiningAPI

Properties

Readonly premia

Protected streamIndex

Methods

cancelAllStreams

Returns Promise<void>

encodeClaim

Parameters

vaults: string[]

amount: BigNumberish

Optional provider: Provider

Returns Promise<ContractTransaction>

encodeClaimAll

Parameters

vaults: string[]

Optional provider: Provider

Returns Promise<ContractTransaction>

encodeClaimAllSync

Parameters

vaults: string[]

Optional provider: Provider

Returns TransactionData

encodeClaimSync

Parameters

vaults: string[]

amount: BigNumberish

Optional provider: Provider

Returns TransactionData

getDualMiningRewards

Parameters

__namedParameters: { user: string; vault: string; }

user: string

vault: string

Optional provider: Provider

Returns Promise<bigint>

getPendingUserRewardsFromVault

Parameters

__namedParameters: { user: string; vault: string; }

user: string

vault: string

Optional provider: Provider

Returns Promise<bigint>

getRewardsPerYear

Parameters

Optional provider: Provider

Returns Promise<bigint>

getTotalUserRewards

Parameters

user: { user: string; }

user: string

Optional provider: Provider

Returns Promise<bigint>

getTotalVotes

Parameters

Optional provider: Provider

Returns Promise<bigint>

getUserInfo

Parameters

user: string

vaultAddress: string

Optional provider: Provider

Returns Promise<IVaultMining.UserInfoStructOutput>

getUserRewards

Parameters

user: { user: string; }

user: string

Optional provider: Provider

Returns Promise<bigint>

getVaultInfo

`Readonly` premia

`Protected` streamIndex

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

__namedParameters: {
user: string;
vault: string;
}

`Optional` provider: Provider

__namedParameters: {
user: string;
vault: string;
}

`Optional` provider: Provider

`Optional` provider: Provider

user: {
user: string;
}

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

user: {
user: string;
}

`Optional` provider: Provider

`Optional` provider: Provider

vault: {
vault: string;
}

`Optional` provider: Provider

`Optional` provider: Provider

Returns Promise<[bigint, bigint] & {
maturity: bigint;
strike: bigint;
}>