@oceanprotocol/lib 3.0.4 → 3.1.0

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

@@ -1,165 +1,165 @@
-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;
-}
+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 +1,107 @@
-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>>;
-}
+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 +1,45 @@
-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;
-}
+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;
+}