8.1 KiB
@oceanprotocol/lib / Exports / VeFeeDistributor
Class: VeFeeDistributor
Provides an interface for veOcean contract
Hierarchy
-
↳
VeFeeDistributor
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new VeFeeDistributor(address, signer, network?, config?, abi?)
Instantiate the smart contract.
Parameters
| Name | Type | Description |
|---|---|---|
address |
string |
The address of the contract. |
signer |
Signer |
The signer object. |
network? |
string | number |
Network id or name |
config? |
Config |
The configuration object. |
abi? |
AbiItem[] |
ABI array of the smart contract |
Inherited from
SmartContractWithAddress.constructor
Defined in
contracts/SmartContractWithAddress.ts:17
Properties
abi
• abi: AbiItem[]
Inherited from
Defined in
address
• address: string
Inherited from
SmartContractWithAddress.address
Defined in
contracts/SmartContractWithAddress.ts:6
config
• config: Config
Inherited from
SmartContractWithAddress.config
Defined in
contract
• contract: Contract
Inherited from
SmartContractWithAddress.contract
Defined in
contracts/SmartContractWithAddress.ts:7
signer
• signer: Signer
Inherited from
SmartContractWithAddress.signer
Defined in
Methods
amountToUnits
▸ Protected amountToUnits(token, amount, tokenDecimals?): Promise<string>
Converts an amount of tokens to units
Parameters
| Name | Type | Description |
|---|---|---|
token |
string |
The token to convert |
amount |
string |
The amount of tokens to convert |
tokenDecimals? |
number |
The number of decimals of the token |
Returns
Promise<string>
- The converted amount in units
Inherited from
SmartContractWithAddress.amountToUnits
Defined in
claim
▸ claim<G>(estimateGas?): Promise<ReceiptOrEstimate<G>>
Claim fees for userAddress
Each call to claim look at a maximum of 50 user veOCEAN points.
For accounts with many veOCEAN related actions, this function
may need to be called more than once to claim all available
fees. In the Claimed event that fires, if claim_epoch is
less than max_epoch, the account may claim again
Type parameters
| Name | Type |
|---|---|
G |
extends boolean = false |
Parameters
| Name | Type | Description |
|---|---|---|
estimateGas? |
G |
if True, return gas estimate |
Returns
Promise<ReceiptOrEstimate<G>>
Defined in
contracts/ve/VeFeeDistributor.ts:23
claimMany
▸ claimMany<G>(addresses, estimateGas?): Promise<ReceiptOrEstimate<G>>
Make multiple fee claims in a single call Used to claim for many accounts at once, or to make multiple claims for the same address when that address has significant veOCEAN history
Type parameters
| Name | Type |
|---|---|
G |
extends boolean = false |
Parameters
| Name | Type | Description |
|---|---|---|
addresses |
string[] |
array of addresses to claim |
estimateGas? |
G |
if True, return gas estimate |
Returns
Promise<ReceiptOrEstimate<G>>
Defined in
contracts/ve/VeFeeDistributor.ts:48
getContract
▸ Protected getContract(address, abi?): Contract
Returns a contract instance for the given address
Parameters
| Name | Type | Description |
|---|---|---|
address |
string |
The address of the contract |
abi? |
AbiItem[] |
The ABI of the contract |
Returns
Contract
- The contract instance
Inherited from
SmartContractWithAddress.getContract
Defined in
getDefaultAbi
▸ getDefaultAbi(): AbiItem[]
Returns
AbiItem[]
Overrides
SmartContractWithAddress.getDefaultAbi
Defined in
contracts/ve/VeFeeDistributor.ts:9
getFairGasPrice
▸ Protected getFairGasPrice(): Promise<string>
Retruns the gas price
Returns
Promise<string>
- The fair gas price
Inherited from
SmartContractWithAddress.getFairGasPrice
Defined in
unitsToAmount
▸ Protected unitsToAmount(token, amount, tokenDecimals?): Promise<string>
Converts an amount of units to tokens
Parameters
| Name | Type | Description |
|---|---|---|
token |
string |
The token to convert |
amount |
string |
The amount of units to convert |
tokenDecimals? |
number |
The number of decimals in the token |
Returns
Promise<string>
- The converted amount in tokens
Inherited from
SmartContractWithAddress.unitsToAmount