@oceanprotocol/lib 2.0.0-next.0 → 2.0.0-next.2

package/dist/src/contracts/index.d.ts

@@ -6,3 +6,6 @@ export * from './Router';
 export * from './Datatoken';
 export * from './NFT';
 export * from './NFTFactory';
+export * from './ve/VeOcean';
+export * from './ve/VeFeeDistributor';
+export * from './ve/VeAllocate';

package/dist/src/contracts/ve/VeAllocate.d.ts

@@ -0,0 +1,41 @@
+import { AbiItem } from 'web3-utils';
+import { SmartContractWithAddress } from '../SmartContractWithAddress';
+import { ReceiptOrEstimate } from '../../@types';
+/**
+ * Provides an interface for veOcean contract
+ */
+export declare class VeAllocate extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem | AbiItem[];
+    /**
+     * set a specific percentage of veOcean to a specific nft
+     * Maximum allocated percentage is 10000, so 1% is specified as 100
+     * @param {String} userAddress user address
+     * @param {String} amount Percentage used
+     * @param {String} nft NFT address to allocate to
+     * @param {String} chainId chainId of NFT
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    setAllocation<G extends boolean = false>(userAddress: string, amount: string, nft: string, chainId: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * set specific percetage of veOcean to multiple nfts
+     * Maximum allocated percentage is 10000, so 1% is specified as 100
+     * @param {String} userAddress user address
+     * @param {String[]} amount Array of percentages used
+     * @param {String[]} nft Array of NFT addresses
+     * @param {String[]} chainId Array of chainIds
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    setBatchAllocation<G extends boolean = false>(userAddress: string, amount: string[], nft: string[], chainId: number[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /** Get totalAllocation for address
+     * @param {String} userAddress user address
+     * @return {Promise<number>}
+     */
+    getTotalAllocation(userAddress: string): Promise<number>;
+    /** Get getveAllocation for address, nft, chainId
+     * @param {String} userAddress user address
+     * @param {String} nft NFT address to allocate to
+     * @param {String} chainId chainId of NFT
+     * @return {Promise<number>}
+     */
+    getVeAllocation(userAddress: string, nft: string, chainId: string): Promise<number>;
+}

package/dist/src/contracts/ve/VeFeeDistributor.d.ts

@@ -0,0 +1,30 @@
+import { AbiItem } from 'web3-utils';
+import { SmartContractWithAddress } from '../SmartContractWithAddress';
+import { ReceiptOrEstimate } from '../../@types';
+/**
+ * Provides an interface for veOcean contract
+ */
+export declare class VeFeeDistributor extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem | AbiItem[];
+    /**
+     * 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
+     * @param {String} userAddress user address
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    claim<G extends boolean = false>(userAddress: string, estimateGas?: G): 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
+     * @param {String} fromUserAddress user address that sends the tx
+     * @param {String} addresses array of addresses to claim
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    claimMany<G extends boolean = false>(fromUserAddress: string, addresses: string[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+}

package/dist/src/contracts/ve/VeOcean.d.ts

@@ -0,0 +1,69 @@
+import { AbiItem } from 'web3-utils';
+import { SmartContractWithAddress } from '../SmartContractWithAddress';
+import { ReceiptOrEstimate } from '../../@types';
+/**
+ * Provides an interface for veOcean contract
+ */
+export declare class VeOcean extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem | AbiItem[];
+    /**
+     * Deposit `amount` tokens for `userAddress` and lock until `unlockTime`
+     * @param {String} userAddress user address
+     * @param {String} amount Amount of tokens to be locked
+     * @param {Number} unlockTime Timestamp for unlock
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    lockTokens<G extends boolean = false>(userAddress: string, amount: string, unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Deposit `amount` tokens for `toAddress` and add to the existing lock
+     * Anyone (even a smart contract) can deposit for someone else, but cannot extend their locktime and deposit for a brand new user
+     * @param {String} fromUserAddress user address that sends the tx
+     * @param {String} toAddress user address to deposit for
+     * @param {String} amount Amount of tokens to be locked
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    depositFor<G extends boolean = false>(fromUserAddress: string, toAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Deposit `amount` additional tokens for `userAddress` without modifying the unlock time
+     * @param {String} userAddress user address that sends the tx
+     * @param {String} amount Amount of tokens to be locked
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    increaseAmount<G extends boolean = false>(userAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Extend the unlock time for `userAddress` to `unlockTime`
+     * @param {String} userAddress user address that sends the tx
+     * @param {Number} unlockTime Timestamp for new unlock time
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    increaseUnlockTime<G extends boolean = false>(userAddress: string, unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Withdraw all tokens for `userAddress`
+     * @param {String} userAddress user address that sends the tx
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    withdraw<G extends boolean = false>(userAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /** Get voting power for address
+     * @param {String} userAddress user address
+     * @return {Promise<number>}
+     */
+    getVotingPower(userAddress: string): Promise<number>;
+    /** Get locked balance
+     * @param {String} userAddress user address
+     * @return {Promise<string>}
+     */
+    getLockedAmount(userAddress: string): Promise<string>;
+    /** Get untilLock for address
+     * @param {String} userAddress user address
+     * @return {Promise<number>}
+     */
+    lockEnd(userAddress: string): Promise<number>;
+    /** Get total supply
+     * @return {Promise<number>}
+     */
+    totalSupply(): Promise<string>;
+    /** Get token
+     * @return {Promise<string>}
+     */
+    getToken(): Promise<string>;
+}

package/dist/test/unit/veOcean.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.2",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",
@@ -49,7 +49,7 @@
     "web3": "^1.7.4"
   },
   "dependencies": {
-    "@oceanprotocol/contracts": "^1.0.0",
+    "@oceanprotocol/contracts": "^1.1.3",
     "bignumber.js": "^9.0.2",
     "cross-fetch": "^3.1.5",
     "crypto-js": "^4.1.1",