9bf71ba4f0
* add ethers * global updates * ve updates * ve tests * contract updates * first test passing * downgrade to ethers 5.7.2 * add log * add tx wait * full NftFactory.test * add wait * add Router tests * fix dispenser * Nft test * add dispenser tests * add fre tests part 1 * WIP datatoken unit tests * add DFRewards test * increase gas estimate * increase gas estimate * Work datatoken unit tests * datatoken test more tests * finished datatoken tests * fix nft get data * fix nft transfer tests * Provider int tests * Updating CodeExamples.md * update provider & fix publish flow int test * wip publish edit consume integration test * more work on publish edit consume integration test * fix edit publish edit consume integration test * add 3 int tests * Updating ComputeExamples.md * fix signature and download * fix compute flow integration test * udapte handleComputeOrder helper * update datatoken instance * update datatoken global variable * mint ocean tokens to consumer as well and added logs * update compute exammples * Updating ComputeExamples.md * wip code examples readme * update code examples readme * Updating CodeExamples.md * run all tests * update dep in readme * update readme * code examples update metadata flags * update dt instance in code examples md * set metadata updates * Updating CodeExamples.md * update code examples readme structure * Updating CodeExamples.md * update readmes table links * Updating CodeExamples.md * Updating ComputeExamples.md * clean-up * Updating CodeExamples.md * added missing unit tests for usdc fixed rate exchange tests * more cleanup and jsdoc updates * more jsdoc updates * donw with jsdoc updates * handle provider errors * add missing error handling file * adds most of the provider errors * update get compute env return type * Release 3.0.0-next.0 * adding Typedoc to ethers branch * update provider signature message * fix lint * Release 3.0.0-next.1 * fix lint * adding Typedoc to ethers branch * Updating CI to build and commit the documentation * Updating documentation * Updating script permissions * fix todos add missing logic to send tx * npm package cleanups * Release 3.0.0-next.2 * update log messages for errors * Release 3.0.0-next.3 * fix gasFee issue on sendTx * Release 3.0.0-next.4 * add consume params typings (#1731) * fix gas fee estimate * remove comments * add some delays before resolving datasets * adds delay to Publish flow tests * Release 3.0.0-next.5 --------- Co-authored-by: Bogdan Fazakas <bogdan.fazakas@gmail.com> Co-authored-by: GitHub Actions Bot <> Co-authored-by: Jamie Hewitt <jamie.hewitt15@gmail.com> Co-authored-by: Jamie Hewitt <jamie@oceanprotocol.com>
8.4 KiB
@oceanprotocol/lib / Exports / DfRewards
Class: DfRewards
Provides an interface for DFRewards contract
Hierarchy
-
↳
DfRewards
Table of contents
Constructors
Properties
Methods
- allocateRewards
- amountToUnits
- claimRewards
- getAvailableRewards
- getContract
- getDefaultAbi
- getFairGasPrice
- unitsToAmount
Constructors
constructor
• new DfRewards(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
allocateRewards
▸ allocateRewards<G>(userAddresses, amounts, tokenAddress, estimateGas?): Promise<ReceiptOrEstimate<G>>
allocate rewards to address. An approve must exist before calling this function.
Type parameters
| Name | Type |
|---|---|
G |
extends boolean = false |
Parameters
| Name | Type | Description |
|---|---|---|
userAddresses |
string[] |
array of users that will receive rewards |
amounts |
string[] |
array of amounts |
tokenAddress |
string |
token address |
estimateGas? |
G |
if True, return gas estimate |
Returns
Promise<ReceiptOrEstimate<G>>
Defined in
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
claimRewards
▸ claimRewards<G>(userAddress, tokenAddress, estimateGas?): Promise<ReceiptOrEstimate<G>>
claim rewards for any address
Type parameters
| Name | Type |
|---|---|
G |
extends boolean = false |
Parameters
| Name | Type | Description |
|---|---|---|
userAddress |
string |
user address to claim |
tokenAddress |
string |
token address |
estimateGas? |
G |
if True, return gas estimate |
Returns
Promise<ReceiptOrEstimate<G>>
Defined in
getAvailableRewards
▸ getAvailableRewards(userAddress, tokenAddress): Promise<string>
Get available DF Rewards for a token
Parameters
| Name | Type | Description |
|---|---|---|
userAddress |
string |
user address |
tokenAddress |
string |
token address |
Returns
Promise<string>
Defined in
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
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