@oceanprotocol/lib 3.2.3 → 3.3.1

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

@@ -1,220 +0,0 @@
-import { BigNumber } from 'ethers';
-import { MetadataProof, MetadataAndTokenURI, NftRoles, ReceiptOrEstimate, AbiItem } from '../@types';
-import { SmartContract } from './SmartContract';
-export declare class Nft extends SmartContract {
-    getDefaultAbi(): AbiItem[];
-    /**
-     * Create new ERC20 Datatoken - only user with DatatokenDeployer permission can succeed
-     * @param {String} nftAddress NFT address
-     * @param {String} address User address
-     * @param {String} minter User set as initial minter for the Datatoken
-     * @param {String} paymentCollector initial paymentCollector for this DT
-     * @param {String} mpFeeAddress Consume marketplace fee address
-     * @param {String} feeToken address of the token marketplace wants to add fee on top
-     * @param {String} feeAmount amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
-     * @param {String} cap Maximum cap (Number) - will be converted to wei
-     * @param {String} name Token name
-     * @param {String} symbol Token symbol
-     * @param {Number} templateIndex NFT template index
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<string>} ERC20 Datatoken address
-     */
-    createDatatoken<G extends boolean = false>(nftAddress: string, address: string, minter: string, paymentCollector: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number, estimateGas?: G): Promise<G extends false ? string : BigNumber>;
-    /**
-     * Add Manager for NFT Contract (only NFT Owner can succeed)
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Owner adress
-     * @param {String} manager User adress which is going to be assing manager
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    addManager<G extends boolean = false>(nftAddress: string, address: string, manager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Removes a specific manager for NFT Contract (only NFT Owner can succeed)
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Owner adress
-     * @param {String} manager User adress which is going to be removed as manager
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    removeManager<G extends boolean = false>(nftAddress: string, address: string, manager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Add DatatokenDeployer permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} datatokenDeployer User adress which is going to have DatatokenDeployer permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    addDatatokenDeployer<G extends boolean = false>(nftAddress: string, address: string, datatokenDeployer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Remove DatatokenDeployer permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} datatokenDeployer Address of the user to be revoked DatatokenDeployer Permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    removeDatatokenDeployer<G extends boolean = false>(nftAddress: string, address: string, datatokenDeployer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Add Metadata Updater permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} metadataUpdater User adress which is going to have Metadata Updater permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    addMetadataUpdater<G extends boolean = false>(nftAddress: string, address: string, metadataUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Remove Metadata Updater permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} metadataUpdater Address of the user to be revoked Metadata updater Permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    removeMetadataUpdater<G extends boolean = false>(nftAddress: string, address: string, metadataUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Add Store Updater permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} storeUpdater User adress which is going to have Store Updater permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    addStoreUpdater<G extends boolean = false>(nftAddress: string, address: string, storeUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Remove Store Updater permission - only Manager can succeed
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Manager adress
-     * @param {String} storeUpdater Address of the user to be revoked Store Updater Permission
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    removeStoreUpdater<G extends boolean = false>(nftAddress: string, address: string, storeUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * This function allows to remove all ROLES at NFT level: Managers, DatatokenDeployer, MetadataUpdater, StoreUpdater
-     * Even NFT Owner has to readd himself as Manager
-     * Permissions at Datatoken level stay.
-     * Only NFT Owner  can call it.
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address NFT Owner adress
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    cleanPermissions<G extends boolean = false>(nftAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Transfers the NFT
-     * will clean all permissions both on NFT and Datatoken level.
-     * @param {String} nftAddress NFT contract address
-     * @param {String} nftOwner Current NFT Owner adress
-     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
-     * @param {Number} tokenId The id of the token to be transfered
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    transferNft<G extends boolean = false>(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * safeTransferNFT Used for transferring the NFT, can be used by an approved relayer
-     * will clean all permissions both on NFT and Datatoken level.
-     * @param {String} nftAddress NFT contract address
-     * @param {String} nftOwner Current NFT Owner adress
-     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
-     * @param {Number} tokenId The id of the token to be transfered
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    safeTransferNft<G extends boolean = false>(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Creates or update Metadata cached by Aquarius. Also, updates the METADATA_DECRYPTOR key
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address Caller address NFT Owner adress
-     * @param {Number} metadataState
-     * @param {String} metadataDecryptorUrl
-     * @param {String} metadataDecryptorAddress
-     * @param {String} flags
-     * @param {String} data
-     * @param {String} metadataHash
-     * @param {MetadataProof[]} metadataProofs
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    setMetadata<G extends boolean = false>(nftAddress: string, address: string, metadataState: number, metadataDecryptorUrl: string, metadataDecryptorAddress: string, flags: string, data: string, metadataHash: string, metadataProofs?: MetadataProof[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     *  Helper function to improve UX sets both MetaData & TokenURI in one tx
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address Caller address
-     * @param {MetadataAndTokenURI} metadataAndTokenURI metaDataAndTokenURI object
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    setMetadataAndTokenURI<G extends boolean = false>(nftAddress: string, metadataUpdater: string, metadataAndTokenURI: MetadataAndTokenURI, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * setMetadataState Used for updating the metadata State
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address Caller address => metadata updater
-     * @param {Number} metadataState new metadata state
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
-     */
-    setMetadataState<G extends boolean = false>(nftAddress: string, address: string, metadataState: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * set TokenURI on an nft
-     * @param {String} nftAddress NFT contract address
-     * @param {String} data input data for TokenURI
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} transaction receipt
-     */
-    setTokenURI<G extends boolean = false>(nftAddress: string, data: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Get NFT Owner
-     * @param {String} nftAddress NFT contract address
-     * @return {Promise<string>} string
-     */
-    getNftOwner(nftAddress: string): Promise<string>;
-    /**
-     * Gets NFT Permissions for a specified user
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address user adress
-     * @return {Promise<NftRoles>}
-     */
-    getNftPermissions(nftAddress: string, address: string): Promise<NftRoles>;
-    /**
-     * Returns Metadata details for an NFT
-     * @param {String} nftAddress NFT contract address
-     * @return {Promise<Objecta>}
-     */
-    getMetadata(nftAddress: string): Promise<Object>;
-    /**
-     * Checks if user has DatatokenDeployer role
-     * @param {String} nftAddress NFT contract address
-     * @param {String} address user adress
-     * @return {Promise<boolean>}
-     */
-    isDatatokenDeployer(nftAddress: string, address: string): Promise<boolean>;
-    /**
-     * Allows users to store data with a preset key (keccak256(ERC20Address)) into NFT 725 Store
-     * only ERC20Deployer can succeed
-     * @param {string} nftAddress Nft datatoken adress
-     * @param {string} address User adress
-     * @param {string} key Key of the data to be stored into 725Y standard
-     * @param {string} value Data to be stored into 725Y standard
-     * @param {boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} transactionId
-     */
-    setData<G extends boolean = false>(nftAddress: string, address: string, key: string, value: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Gets stored data at a given `key` in an NFT
-     * @param {string} nftAddress - The address of the NFT.
-     * @param {string} key - The key of the data to get.
-     * @return {Promise<string>} The data stored at the key
-     */
-    getData(nftAddress: string, key: string): Promise<string>;
-    /**
-     * Gets the token URI of an NFT.
-     * @param {string} nftAddress - The address of the NFT.
-     * @param {number} id - The ID of the token.
-     * @returns {Promise&lt;string&gt;}
-     */
-    getTokenURI(nftAddress: string, id: number): Promise<string>;
-}

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

@@ -1,165 +0,0 @@
-import { BigNumber } from 'ethers';
-import { AbiItem, FreCreationParams, DatatokenCreateParams, DispenserCreationParams, NftCreateData, Template, TokenOrder, ReceiptOrEstimate } from '../@types';
-import { SmartContractWithAddress } from './SmartContractWithAddress';
-/**
- * Provides an interface for NFT Factory contract
- */
-export declare class NftFactory extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem[];
-    /**
-     * Create new data NFT
-     * @param {NFTCreateData} nftData The data needed to create an NFT.
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<string|BigNumber>} The transaction hash or the gas estimate.
-     */
-    createNFT<G extends boolean = false>(nftData: NftCreateData, estimateGas?: G): Promise<G extends false ? string : BigNumber>;
-    /**
-     * Get Current NFT Count (NFT created)
-     * @return {Promise<number>} Number of NFT created from this factory
-     */
-    getCurrentNFTCount(): Promise<number>;
-    /**
-     * Get Current Datatoken Count
-     * @return {Promise<number>} Number of DTs created from this factory
-     */
-    getCurrentTokenCount(): Promise<number>;
-    /**
-     *  Get Factory Owner
-     * @return {Promise<string>} Factory Owner address
-     */
-    getOwner(): Promise<string>;
-    /**
-     * Get Current NFT Template Count
-     * @return {Promise<number>} Number of NFT Template added to this factory
-     */
-    getCurrentNFTTemplateCount(): Promise<number>;
-    /**
-     * Get Current Template  Datatoken (ERC20) Count
-     * @return {Promise<number>} Number of Datatoken Template added to this factory
-     */
-    getCurrentTokenTemplateCount(): Promise<number>;
-    /**
-     * Get NFT Template
-     * @param {number} index Template index
-     * @return {Promise<Template>} Number of Template added to this factory
-     */
-    getNFTTemplate(index: number): Promise<Template>;
-    /**
-     * Get Datatoken (ERC20) Template
-     * @param {number} index Template index
-     * @return {Promise<Template>} DT Template info
-     */
-    getTokenTemplate(index: number): Promise<Template>;
-    /**
-     * Check if Datatoken is deployed from the factory
-     * @param {String} datatoken Datatoken address to check
-     * @return {Promise<Boolean>} return true if deployed from this factory
-     */
-    checkDatatoken(datatoken: string): Promise<Boolean>;
-    /**
-     * Check if  NFT is deployed from the factory
-     * @param {String} nftAddress nftAddress address to check
-     * @return {Promise<String>} return address(0) if it's not, or the nftAddress if true
-     */
-    checkNFT(nftAddress: string): Promise<String>;
-    /**
-     * Add a new NFT token template - only factory Owner
-     * @param {String} address caller address
-     * @param {String} templateAddress template address to add
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    addNFTTemplate<G extends boolean = false>(address: string, templateAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Disable token template - only factory Owner
-     * @param {String} address
-     * @param {Number} templateIndex index of the template we want to disable
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} current token template count
-     */
-    disableNFTTemplate<G extends boolean = false>(address: string, templateIndex: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Reactivate a previously disabled token template - only factory Owner
-     * @param {String} address
-     * @param {Number} templateIndex index of the template we want to reactivate
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} current token template count
-     */
-    reactivateNFTTemplate<G extends boolean = false>(address: string, templateIndex: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Add a new NFT token template - only factory Owner
-     * @param {String} address caller address
-     * @param {String} templateAddress template address to add
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    addTokenTemplate<G extends boolean = false>(address: string, templateAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Disable token template - only factory Owner
-     * @param {String} address caller address
-     * @param {Number} templateIndex index of the template we want to disable
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} current token template count
-     */
-    disableTokenTemplate<G extends boolean = false>(address: string, templateIndex: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Reactivate a previously disabled token template - only factory Owner
-     * @param {String} address caller address
-     * @param {Number} templateIndex index of the template we want to reactivate
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} current token template count
-     */
-    reactivateTokenTemplate<G extends boolean = false>(address: string, templateIndex: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     *      Used as a proxy to order multiple services
-     *      Users can have inifinite approvals for fees for factory instead of having one approval/ Datatoken contract
-     *      Requires previous approval of all :
-     *          - consumeFeeTokens
-     *          - publishMarketFeeTokens
-     *          - ERC20 Datatokens
-     * @param {TokenOrder[]} orders array of of orders
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>} transaction receipt
-     */
-    startMultipleTokenOrder<G extends boolean = false>(orders: TokenOrder[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     *  Creates a new NFT, then a datatoken,all in one call
-     * @param {NftCreateData} nftCreateData - The data required to create an NFT.
-     * @param {DatatokenCreateParams} dtParams - The parameters required to create a datatoken.
-     * @param {boolean} [estimateGas] - Whether to return only estimate gas or not.
-     * @return {Promise<ReceiptOrEstimate>} transaction receipt
-     */
-    createNftWithDatatoken<G extends boolean = false>(nftCreateData: NftCreateData, dtParams: DatatokenCreateParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Creates an NFT with a datatoken with a fixed rate  all in one call.
-     * be aware if Fixed Rate creation fails, you are still going to pay a lot of gas
-     * @param {NftCreateData} nftCreateData - The data required to create an NFT.
-     * @param {DatatokenCreateParams} dtParams - The parameters required to create a datatoken.
-     * @param {FreCreationParams} freParams - The parameters required to create a fixed-rate exchange contract.
-     * @param {boolean} [estimateGas] - Whether to return only estimate gas or not.
-     * @returns {Promis<ReceiptOrEstimate<G>>}
-     */
-    createNftWithDatatokenWithFixedRate<G extends boolean = false>(nftCreateData: NftCreateData, dtParams: DatatokenCreateParams, freParams: FreCreationParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Creates an NFT with a datatoken with a dispenser in one call.
-     * Be aware if Fixed Rate creation fails, you are still going to pay a lot of gas
-     * @param {NftCreateData} nftCreateData - The data required to create an NFT.
-     * @param {DatatokenCreateParams} dtParams - The parameters required to create a datatoken.
-     * @param {DispenserCreationParams} dispenserParams - The parameters required to create a dispenser contract.
-     * @param {boolean} [estimateGas] - Whether to estimate gas or not.
-     * @returns {Promis<ReceiptOrEstimate<G>>}
-     */
-    createNftWithDatatokenWithDispenser<G extends boolean = false>(nftCreateData: NftCreateData, dtParams: DatatokenCreateParams, dispenserParams: DispenserCreationParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Gets the parameters required to create an ERC20 token.
-     * @param {DatatokenCreateParams} dtParams - The parameters required to create a datatoken.
-     * @returns {Promise<any>}
-     */
-    private getErcCreationParams;
-    /**
-     * Gets the parameters required to create a fixed-rate exchange contract.
-     * @param {FreCreationParams} freParams - The parameters required to create a fixed-rate exchange contract.
-     * @returns {Promise<any> }
-     */
-    private getFreCreationParams;
-}

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

@@ -1,107 +0,0 @@
-import { Operation, ReceiptOrEstimate, AbiItem } from '../@types';
-import { SmartContractWithAddress } from './SmartContractWithAddress';
-/**
- * Provides an interface for FactoryRouter contract
- */
-export declare class Router extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem[];
-    /**
-     * * Buys a batch of datatokens.
-     * one single call to buy multiple DT for multiple assets.
-     * require tokenIn approvals for router from user. (except for dispenser operations)
-     * @param {Operation[]} operations - The operations to execute.
-     * @param {boolean} [estimateGas=false] - Whether to return only the estimate gas or not.
-     * @return {Promise<ReceiptOrEstimate>} Transaction receipt
-     */
-    buyDatatokenBatch<G extends boolean = false>(operations: Operation[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Checks if a token is on approved tokens list,
-     * if true opfFee is lower in pools with that token/DT
-     * @param {string} address - The address of the token to check.
-     * @return {Promise<boolean>} true if is on the list.
-     */
-    isApprovedToken(address: string): Promise<boolean>;
-    /**
-     * Check if an address is a Fixed Rate contract.
-     * @param {string} address - The address of the fixed rate exchange to check.
-     * @return {Promise<boolean>} true if is a Fixed Rate contract
-     */
-    isFixedPrice(address: string): Promise<boolean>;
-    /**
-     * Get Router Owner
-     * @return {Promise<string>} Router Owner address
-     */
-    getOwner(): Promise<string>;
-    /**
-     * Get NFT Factory address
-     * @return {Promise<string>} NFT Factory address
-     */
-    getNFTFactory(): Promise<string>;
-    /**
-     * Adds a token to the list of tokens with reduced fees
-     * @param {String} address caller address
-     * @param {String} tokenAddress token address to add
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    addApprovedToken<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Removes a token if exists from the list of tokens with reduced fees
-     * @param {String} address caller address
-     * @param {String} tokenAddress token address to remove
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    removeApprovedToken<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Adds an address to the list of fixed rate contracts
-     * @param {String} address caller address
-     * @param {String} tokenAddress contract address to add
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    addFixedRateContract<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Removes an address from the list of fixed rate contracts
-     * @param {String} address caller address
-     * @param {String} tokenAddress contract address to add
-     * @param {Boolean} [estimateGas] if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    removeFixedRateContract<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Adds an address to the list of dispensers
-     * @param {String} address caller address
-     * @param {String} tokenAddress contract address to add
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    addDispenserContract<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * Removes an address from the list of dispensers
-     * @param {String} address caller address
-     * @param {String} tokenAddress address Contract to be removed
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    removeDispenserContract<G extends boolean = false>(address: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** Get OPF Fee per token
-     * @return {Promise<number>} OPC fee for a specific baseToken
-     */
-    getOPCFee(baseToken: string): Promise<number>;
-    /** Get Current OPF Fee
-     * @return {Promise<number>} OPF fee
-     */
-    getCurrentOPCFee(): Promise<number>;
-    /**
-     * Updates OP Community Fees
-     * @param {String} address caller address
-     * @param {number} newSwapOceanFee Amount charged for swapping with ocean approved tokens
-     * @param {number} newSwapNonOceanFee Amount charged for swapping with non ocean approved tokens
-     * @param {number} newConsumeFee Amount charged from consumeFees
-     * @param {number} newProviderFee Amount charged for providerFees
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    updateOPCFee<G extends boolean = false>(address: string, newSwapOceanFee: number, newSwapNonOceanFee: number, newConsumeFee: number, newProviderFee: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-}

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

@@ -1,45 +0,0 @@
-import { Signer, Contract } from 'ethers';
-import { AbiItem } from '../@types';
-import { Config } from '../config';
-export declare abstract class SmartContract {
-    signer: Signer;
-    config: Config;
-    abi: AbiItem[];
-    abstract getDefaultAbi(): any;
-    /**
-     * Instantiate the smart contract.
-     * @param {Signer} signer The signer object.
-     * @param {string | number} [network] Network id or name
-     * @param {Config} [config] The configuration object.
-     * @param {AbiItem[]} [abi] ABI array of the smart contract
-     */
-    constructor(signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[]);
-    /**
-     * Converts an amount of tokens to units
-     * @param {string} token - The token to convert
-     * @param {string} amount - The amount of tokens to convert
-     * @param {number} [tokenDecimals] - The number of decimals of the token
-     * @returns {Promise<string>} - The converted amount in units
-     */
-    protected amountToUnits(token: string, amount: string, tokenDecimals?: number): Promise<string>;
-    /**
-     * Converts an amount of units to tokens
-     * @param {string} token - The token to convert
-     * @param {string} amount - The amount of units to convert
-     * @param {number} [tokenDecimals] - The number of decimals in the token
-     * @returns {Promise<string>} - The converted amount in tokens
-     */
-    protected unitsToAmount(token: string, amount: string, tokenDecimals?: number): Promise<string>;
-    /**
-     * Retruns the gas price
-     * @returns {Promise<string>} - The fair gas price
-     */
-    protected getFairGasPrice(): Promise<string>;
-    /**
-     * Returns a contract instance for the given address
-     * @param {string} address - The address of the contract
-     * @param {AbiItem[]} [abi] - The ABI of the contract
-     * @returns {Contract} - The contract instance
-     */
-    protected getContract(address: string, abi?: AbiItem[]): Contract;
-}

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

@@ -1,17 +0,0 @@
-import { Signer, Contract } from 'ethers';
-import { AbiItem } from '../@types';
-import { Config } from '../config';
-import { SmartContract } from './SmartContract';
-export declare abstract class SmartContractWithAddress extends SmartContract {
-    address: string;
-    contract: Contract;
-    /**
-     * Instantiate the smart contract.
-     * @param {string} address The address of the contract.
-     * @param {Signer} signer The signer object.
-     * @param {string | number} network Network id or name
-     * @param {Config} config The configuration object.
-     * @param {AbiItem[]} abi ABI array of the smart contract
-     */
-    constructor(address: string, signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[]);
-}

package/dist/src/contracts/df/DfRewards.d.ts

@@ -1,31 +0,0 @@
-import { SmartContractWithAddress } from '../SmartContractWithAddress';
-import { AbiItem, ReceiptOrEstimate } from '../../@types';
-/**
- * Provides an interface for DFRewards contract
- */
-export declare class DfRewards extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem[];
-    /** Get available DF Rewards for a token
-     * @param {String} userAddress user address
-     * @param {String} tokenAddress token address
-     * @return {Promise<string>}
-     */
-    getAvailableRewards(userAddress: string, tokenAddress: string): Promise<string>;
-    /**
-     * claim rewards for any address
-     * @param {String} userAddress user address to claim
-     * @param {String} tokenAddress token address
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    claimRewards<G extends boolean = false>(userAddress: string, tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /**
-     * allocate rewards to address.  An approve must exist before calling this function.
-     * @param {String[]} userAddresses array of users that will receive rewards
-     * @param {String[]} amounts array of amounts
-     * @param {String} tokenAddress token address
-     * @param {Boolean} estimateGas if True, return gas estimate
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    allocateRewards<G extends boolean = false>(userAddresses: string[], amounts: string[], tokenAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-}

package/dist/src/contracts/df/DfStrategyV1.d.ts

@@ -1,21 +0,0 @@
-import { SmartContractWithAddress } from '../SmartContractWithAddress';
-import { ReceiptOrEstimate, AbiItem } from '../../@types';
-/**
- * Provides an interface for dfStrategyV1 contract
- */
-export declare class DfStrategyV1 extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem[];
-    /** Get available DF Rewards for multiple tokens
-     * @param {String} userAddress user address
-     * @param {String} tokenAddresses array of tokens
-     * @return {Promise<string[]>}
-     */
-    getMultipleAvailableRewards(userAddress: string, tokenAddresses: string[]): Promise<string[]>;
-    /**
-     * claim multiple token rewards for any address
-     * @param {String} userAddress user address to claim
-     * @param {String} tokenAddresses array of tokens
-     * @return {Promise<ReceiptOrEstimate>}
-     */
-    claimMultipleRewards<G extends boolean = false>(userAddress: string, tokenAddresses: string[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-}

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

@@ -1,14 +0,0 @@
-export * from './SmartContract';
-export * from './SmartContractWithAddress';
-export * from './Dispenser';
-export * from './FixedRateExchange';
-export * from './Router';
-export * from './Datatoken';
-export * from './NFT';
-export * from './NFTFactory';
-export * from './ve/VeOcean';
-export * from './ve/VeFeeDistributor';
-export * from './ve/VeFeeEstimate';
-export * from './ve/VeAllocate';
-export * from './df/DfRewards';
-export * from './df/DfStrategyV1';

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

@@ -1,38 +0,0 @@
-import { SmartContractWithAddress } from '../SmartContractWithAddress';
-import { ReceiptOrEstimate, AbiItem } from '../../@types';
-/**
- * Provides an interface for veOcean contract
- */
-export declare class VeAllocate extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem[];
-    /**
-     * set a specific percentage of veOcean to a specific nft
-     * Maximum allocated percentage is 10000, so 1% is specified as 100
-     * @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>(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[]} 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>(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>;
-}