@oceanprotocol/lib 3.4.1 → 3.4.3

package/dist/types/contracts/Datatoken.d.ts

@@ -0,0 +1,278 @@
+import { Signer } from 'ethers';
+import { AbiItem, ConsumeMarketFee, FreOrderParams, FreCreationParams, ProviderFees, PublishingMarketFee, DispenserParams, OrderParams, DatatokenRoles, ReceiptOrEstimate } from '../@types';
+import { Nft } from './NFT';
+import { Config } from '../config';
+import { SmartContract } from './SmartContract';
+export declare class Datatoken extends SmartContract {
+    abiEnterprise: AbiItem[];
+    nft: Nft;
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Instantiate Datatoken class
+     * @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
+     * @param {AbiItem[]} abiEnterprise Enterprise ABI array of the smart contract
+     */
+    constructor(signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[], abiEnterprise?: AbiItem[]);
+    /**
+     * Approves a spender to spend a certain amount of datatokens.
+     * @param {String} dtAddress Datatoken address
+     * @param {String} spender Spender address
+     * @param {string} amount Number of datatokens, as number. Will be converted to wei
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    approve<G extends boolean = false>(dtAddress: string, spender: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Creates a new FixedRateExchange setup.
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {FixedRateParams} fixedRateParams The parameters required to create a fixed-rate exchange contract.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    createFixedRate<G extends boolean = false>(dtAddress: string, address: string, fixedRateParams: FreCreationParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Creates a new Dispenser
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} dispenserAddress Dispenser contract address
+     * @param {DispenserParams} dispenserParams The parameters required to create a dispenser contract.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    createDispenser<G extends boolean = false>(dtAddress: string, address: string, dispenserAddress: string, dispenserParams: DispenserParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Mints datatokens
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Minter address
+     * @param {String} amount Number of datatokens, as number. Will be converted to wei
+     * @param {String} toAddress only if toAddress is different from the minter
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    mint<G extends boolean = false>(dtAddress: string, address: string, amount: string, toAddress?: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Add Minter for an ERC20 Datatoken
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address caller address
+     * @param {String} minter address which is going to be a Minter
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    addMinter<G extends boolean = false>(dtAddress: string, address: string, minter: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Revoke Minter permission for an ERC20 Datatoken
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address caller address
+     * @param {String} minter address which will have removed the Minter permission
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    removeMinter<G extends boolean = false>(dtAddress: string, address: string, minter: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     *  Adds a payment manager on a datatoken to a desired address.(can set who's going to collect fee when consuming orders)
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} paymentManager  The address of the payment manager
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    addPaymentManager<G extends boolean = false>(dtAddress: string, address: string, paymentManager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Revoke paymentManager permission for an ERC20 Datatoken
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} paymentManager User which will be removed from paymentManager permission
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} trxReceipt
+     */
+    removePaymentManager<G extends boolean = false>(dtAddress: string, address: string, paymentManager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * This function allows to set a new PaymentCollector (receives DT when consuming)
+     * If not set the paymentCollector is the NFT Owner
+     * only NFT owner can call
+     * @param dtAddress Datatoken address
+     * @param address Caller address
+     * @param paymentCollector User to be set as new payment collector
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} trxReceipt
+     */
+    setPaymentCollector<G extends boolean = false>(dtAddress: string, address: string, paymentCollector: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * getPaymentCollector - It returns the current paymentCollector
+     * @param dtAddress datatoken address
+     * @return {Promise<string>}
+     */
+    getPaymentCollector(dtAddress: string): Promise<string>;
+    /**
+     * Transfer tokens(as number) from address to toAddress
+     * @param {String} dtAddress Datatoken address
+     * @param {String} toAddress Receiver address
+     * @param {String} amount Number of datatokens, as number. Will be converted to wei.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    transfer<G extends boolean = false>(dtAddress: string, toAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Transfer in wei from address to toAddress
+     * @param {String} dtAddress Datatoken address
+     * @param {String} toAddress Receiver address
+     * @param {String} amount Number of datatokens (number) expressed as wei
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    transferWei<G extends boolean = false>(dtAddress: string, toAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Start Order: called by payer or consumer prior ordering a service consume on a marketplace.
+     * @param {String} dtAddress Datatoken address
+     * @param {String} consumer Consumer Address
+     * @param {Number} serviceIndex  Service index in the metadata
+     * @param {providerFees} providerFees provider fees
+     * @param {consumeMarketFee} ConsumeMarketFee consume market fees
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} string
+     */
+    startOrder<G extends boolean = false>(dtAddress: string, consumer: string, serviceIndex: number, providerFees: ProviderFees, consumeMarketFee?: ConsumeMarketFee, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Reuse Order: called by payer or consumer having a valid order, but with expired provider access.
+     * Pays the provider fee again, but it will not require a new datatoken payment
+     * Requires previous approval of provider fee.
+     * @param {String} dtAddress Datatoken address
+     * @param {String} orderTxId previous valid order
+     * @param {providerFees} providerFees provider fees
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} string
+     */
+    reuseOrder<G extends boolean = false>(dtAddress: string, orderTxId: string, providerFees: ProviderFees, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Buys 1 DT from the FRE and then startsOrder, while burning that DT
+     * @param {String} dtAddress Datatoken address
+     * @param {OrderParams} orderParams  The parameters required to place an order.
+     * @param {FreParams} freParams The parameters required to buy from a fixed-rate exchange.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    buyFromFreAndOrder<G extends boolean = false>(dtAddress: string, orderParams: OrderParams, freParams: FreOrderParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Gets 1 DT from dispenser and then startsOrder, while burning that DT
+     * @param {String} dtAddress Datatoken address
+     * @param {OrderParams} orderParams - The parameters required to place an order.
+     * @param {String} dispenserContract  dispenser address
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    buyFromDispenserAndOrder<G extends boolean = false>(dtAddress: string, orderParams: OrderParams, dispenserContract: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /** setData
+     * This function allows to store data with a preset key (keccak256(dtAddress)) into NFT 725 Store
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @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>(dtAddress: string, address: string, value: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Clean Datatoken level Permissions (minters, paymentManager and reset the paymentCollector) for an ERC20 Datatoken
+     * Only NFT Owner (at 721 level) can call it.
+     * @param {string} dtAddress Datatoken address where we want to clean permissions
+     * @param {string} address User adress
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    cleanPermissions<G extends boolean = false>(dtAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Returns ERC20 Datatoken user's permissions for a datatoken
+     * @param {String} dtAddress Datatoken adress
+     * @param {String} address user adress
+     * @return {Promise<DatatokenRoles>}
+     */
+    getPermissions(dtAddress: string, address: string): Promise<DatatokenRoles>;
+    /**
+     * Returns the Datatoken cap
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<string>}
+     */
+    getCap(dtAddress: string): Promise<string>;
+    /**
+     * It returns the token decimals, how many supported decimal points
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getDecimals(dtAddress: string): Promise<number>;
+    /**
+     * It returns the token template index.
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getId(dtAddress: string): Promise<number>;
+    /**
+     * It returns the token symbol
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getSymbol(dtAddress: string): Promise<string>;
+    /**
+     *  It returns the name of the token
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getName(dtAddress: string): Promise<string>;
+    /**
+     * It returns the token decimals, how many supported decimal points
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getNFTAddress(dtAddress: string): Promise<string>;
+    /**
+     * It returns the list of fixedRateExchanges created for this datatoken.
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getFixedRates(dtAddress: string): Promise<any[]>;
+    /**
+     * It returns the list of dispensers created for this datatoken.
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getDispensers(dtAddress: string): Promise<any[]>;
+    /**
+     *  Returns true if address has deployERC20 role
+     * @param {String} dtAddress Datatoken adress
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<boolean>}
+     */
+    isDatatokenDeployer(dtAddress: string, address: string): Promise<boolean>;
+    /**
+     * Get Address Balance for datatoken
+     * @param {String} dtAddress Datatoken adress
+     * @param {String} address user adress
+     * @return {Promise<String>} balance  Number of datatokens. Will be converted from wei
+     */
+    balance(datatokenAddress: string, address: string): Promise<string>;
+    /**
+     * Allows to set the fee required by the publisherMarket
+     * only publishMarketFeeAddress can call it
+     * @param {string} datatokenAddress Datatoken adress
+     * @param {string} publishMarketFeeAddress  new publish Market Fee Address
+     * @param {string} publishMarketFeeToken new publish Market Fee Token
+     * @param {string} publishMarketFeeAmount new fee amount
+     * @param {String} address user adress
+     * @param {Boolean} estimateGas if True, return gas estimate
+     */
+    setPublishingMarketFee<G extends boolean = false>(datatokenAddress: string, publishMarketFeeAddress: string, publishMarketFeeToken: string, publishMarketFeeAmount: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Returns the current fee set by the publishing market
+     * @param {String} datatokenAddress Datatoken adress
+     * @return {Promise<PublishingMarketFee>} Current fee set by the publishing market
+     */
+    getPublishingMarketFee(datatokenAddress: string): Promise<PublishingMarketFee>;
+    private getFreOrderParams;
+}

package/dist/types/contracts/Datatoken4.d.ts

@@ -0,0 +1,72 @@
+import { Datatoken } from './Datatoken';
+import { Bytes, Signer } from 'ethers';
+import { AbiItem, ReceiptOrEstimate } from '../@types';
+import { AccessListContract } from './AccessList';
+import { Config } from '../config';
+export declare class Datatoken4 extends Datatoken {
+    accessList: AccessListContract;
+    fileObject: Bytes;
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Instantiate Datatoken class
+     * @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, fileObject: Bytes, network?: string | number, config?: Config, abi?: AbiItem[]);
+    setFileObj(fileObj: Bytes): void;
+    /**
+     * getAllowListContract - It returns the current allowList contract address
+     * @param dtAddress datatoken address
+     * @return {Promise<string>}
+     */
+    getAllowlistContract(dtAddress: string): Promise<string>;
+    /**
+     * getDenyListContract - It returns the current denyList contract address
+     * @param dtAddress datatoken address
+     * @return {Promise<string>}
+     */
+    getDenylistContract(dtAddress: string): Promise<string>;
+    /** setAllowListContract
+     * This function allows to set another address for allowListContract, only by datatoken deployer
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Contract address
+     * @param {String} consumer User address
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    setAllowListContract<G extends boolean = false>(dtAddress: string, address: string, consumer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /** setDenyListContract
+     * This function allows to set another address for allowListContract, only by datatoken deployer
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Contract address
+     * @param {String} consumer User address
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    setDenyListContract<G extends boolean = false>(dtAddress: string, address: string, consumer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /** setFileObject
+     * This function allows to set file object in ecnrypted format, only by datatoken deployer
+     * only DatatokenDeployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    setFileObject<G extends boolean = false>(dtAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * getFileObject - It returns the consumer's file object encrypted format.
+     * @param {String} dtAddress datatoken address
+     * @param {Number} serviceIndex - service index
+     * @param {String} providerAddress
+     * @param {Bytes} providerSignature
+     * @param {Bytes} consumerData
+     * @param {Bytes} consumerSignature
+     * @param {String} consumerAddress
+     * @return {Promise<Bytes>} returns file object
+     */
+    getFileObject(dtAddress: string, serviceIndex: number, providerAddress: string, providerSignature: Bytes, consumerData: Bytes, consumerSignature: Bytes, consumerAddress: string): Promise<Bytes>;
+}

package/dist/types/contracts/Dispenser.d.ts

@@ -0,0 +1,73 @@
+import { Datatoken } from './Datatoken';
+import { SmartContractWithAddress } from './SmartContractWithAddress';
+import { DispenserToken, ReceiptOrEstimate, AbiItem } from '../@types';
+export declare class Dispenser extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Get information about a datatoken dispenser
+     * @param {String} dtAddress
+     * @return {Promise<DispenserToken>}
+     */
+    status(dtAdress: string): Promise<DispenserToken>;
+    /**
+     * Creates a new Dispenser
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Owner address
+     * @param {String} maxTokens max tokens to dispense
+     * @param {String} maxBalance max balance of requester
+     * @param {String} allowedSwapper  only account that can ask tokens. set address(0) if not required
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transactionId
+     */
+    create<G extends boolean = false>(dtAddress: string, address: string, maxTokens: string, maxBalance: string, allowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Activates a dispener.
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {Number} maxTokens max amount of tokens to dispense
+     * @param {Number} maxBalance max balance of user. If user balance is >, then dispense will be rejected
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
+     */
+    activate<G extends boolean = false>(dtAddress: string, maxTokens: string, maxBalance: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Deactivate an existing dispenser.
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
+     */
+    deactivate<G extends boolean = false>(dtAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Sets a new allowed swapper.
+     * @param {String} dtAddress Datatoken address.
+     * @param {String} newAllowedSwapper The address of the new allowed swapper.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    setAllowedSwapper<G extends boolean = false>(dtAddress: string, newAllowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Dispense datatokens to caller.
+     * The dispenser must be active, hold enough datatokens (or be able to mint more)
+     * and respect maxTokens/maxBalance requirements
+     * @param {String} dtAddress Datatoken address.
+     * @param {String} amount Amount of datatokens required.
+     * @param {String} destination address of tokens receiver
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    dispense<G extends boolean = false>(dtAddress: string, amount: string, destination: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Withdraw all tokens from the dispenser
+     * @param {String} dtAddress Datatoken address.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
+     */
+    ownerWithdraw<G extends boolean = false>(dtAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Check if tokens can be dispensed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address that will receive datatokens
+     * @param {String} amount amount of datatokens required.
+     * @return {Promise<Boolean>}
+     */
+    isDispensable(dtAddress: string, datatoken: Datatoken, address: string, amount?: string): Promise<Boolean>;
+}

package/dist/types/contracts/FixedRateExchange.d.ts

@@ -0,0 +1,209 @@
+import { PriceAndFees, FeesInfo, FixedPriceExchange, ReceiptOrEstimate, AbiItem } from '../@types';
+import { SmartContractWithAddress } from './SmartContractWithAddress';
+export declare class FixedRateExchange extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Creates unique exchange identifier.
+     * @param {String} baseToken baseToken contract address
+     * @param {String} datatoken Datatoken contract address
+     * @return {Promise<string>} exchangeId
+     */
+    generateExchangeId(baseToken: string, datatoken: string): Promise<string>;
+    /**
+     * Atomic swap
+     * @param {String} exchangeId ExchangeId
+     * @param {String} datatokenAmount Amount of datatokens
+     * @param {String} maxBaseTokenAmount max amount of baseToken we want to pay for datatokenAmount
+     * @param {String} consumeMarketAddress consumeMarketAddress
+     * @param {String} consumeMarketFee consumeMarketFee in fraction
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    buyDatatokens<G extends boolean = false>(exchangeId: string, datatokenAmount: string, maxBaseTokenAmount: string, consumeMarketAddress?: string, consumeMarketFee?: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Sell datatokenAmount while expecting at least minBaseTokenAmount
+     * @param {String} exchangeId ExchangeId
+     * @param {String} datatokenAmount Amount of datatokens
+     * @param {String} minBaseTokenAmount min amount of baseToken we want to receive back
+     * @param {String} consumeMarketAddress consumeMarketAddress
+     * @param {String} consumeMarketFee consumeMarketFee in fraction
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    sellDatatokens<G extends boolean = false>(exchangeId: string, datatokenAmount: string, minBaseTokenAmount: string, consumeMarketAddress?: string, consumeMarketFee?: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Gets total number of exchanges
+     * @return {Promise<Number>} no of available exchanges
+     */
+    getNumberOfExchanges(): Promise<number>;
+    /**
+     * Set new rate
+     * @param {String} exchangeId Exchange ID
+     * @param {String} newRate New rate
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    setRate<G extends boolean = false>(exchangeId: string, newRate: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Sets a new allowedSwapper
+     * @param {String} exchangeId Exchange ID
+     * @param {String} newAllowedSwapper  The address of the new allowed swapper (set address zero if we want to remove allowed swapper)
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    setAllowedSwapper<G extends boolean = false>(exchangeId: string, newAllowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Activate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    activate<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Deactivate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    deactivate<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Get Exchange Rate
+     * @param {String} exchangeId Exchange ID
+     * @return {Promise<string>} Rate (converted from wei)
+     */
+    getRate(exchangeId: string): Promise<string>;
+    /**
+     * Get Datatoken Supply in the exchange
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<string>}  dt supply formatted
+     */
+    getDatatokenSupply(exchangeId: string): Promise<string>;
+    /**
+     * Returns basetoken supply in the exchange
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<string>} dt supply formatted
+     */
+    getBasetokenSupply(exchangeId: string): Promise<string>;
+    /**
+     * Get Allower Swapper (if set this is the only account which can use this exchange, else is set at address(0))
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<string>} address of allowed swapper
+     */
+    getAllowedSwapper(exchangeId: string): Promise<string>;
+    /**
+     * calcBaseInGivenDatatokensOut - Calculates how many base tokens are needed to get specified amount of datatokens
+     * @param {String} exchangeId Exchange Id
+     * @param {string} datatokenAmount Amount of datatokens user wants to buy
+     * @param {String} consumeMarketFee consumeMarketFee in fraction
+     * @return {Promise<PriceAndFees>} how many base tokens are needed and fees
+     */
+    calcBaseInGivenDatatokensOut(exchangeId: string, datatokenAmount: string, consumeMarketFee?: string): Promise<PriceAndFees>;
+    /**
+     * Returns amount in baseToken that user will receive for datatokenAmount sold
+     * @param {String} exchangeId Exchange Id
+     * @param {Number} datatokenAmount Amount of datatokens
+     * @param {String} consumeMarketFee consumeMarketFee in fraction
+     * @return {Promise<string>} Amount of baseTokens user will receive
+     */
+    getAmountBasetokensOut(exchangeId: string, datatokenAmount: string, consumeMarketFee?: string): Promise<string>;
+    /**
+     * Get exchange details
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<FixedPricedExchange>} Exchange details
+     */
+    getExchange(exchangeId: string): Promise<FixedPriceExchange>;
+    /**
+     * Get fee details for an exchange
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<FeesInfo>} Exchange details
+     */
+    getFeesInfo(exchangeId: string): Promise<FeesInfo>;
+    /**
+     * Returns all exchanges
+     * @param {String} exchangeId Exchang eId
+     * @return {Promise<String[]>} Exchanges list
+     */
+    getExchanges(): Promise<string[]>;
+    /**
+     * Check if an exchange is active
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<Boolean>}
+     */
+    isActive(exchangeId: string): Promise<boolean>;
+    /**
+     * Activate minting option for fixed rate contract
+     * @param {String} exchangeId Exchang eId
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    activateMint<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Deactivate minting for fixed rate
+     * @param {String} exchangeId ExchangeId
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    deactivateMint<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Collect BaseTokens in the contract (anyone can call this, funds are sent to Datatoken.paymentCollector)
+     * @param {String} exchangeId Exchange Id
+     * @param {String} amount amount to be collected
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    collectBasetokens<G extends boolean = false>(exchangeId: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Collect datatokens in the contract (anyone can call this, funds are sent to Datatoken.paymentCollector)
+     * @param {String} exchangeId Exchange Id
+     * @param {String} amount amount to be collected
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    collectDatatokens<G extends boolean = false>(exchangeId: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Collect market fee and send it to marketFeeCollector (anyone can call it)
+     * @param {String} exchangeId Exchange Id
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    collectMarketFee<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Collect ocean fee and send it to OPF collector (anyone can call it)
+     * @param {String} exchangeId Exchange Id
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    collectOceanFee<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Get OPF Collector of fixed rate contract
+     * @return {String}
+     */
+    getOPCCollector(): Promise<string>;
+    /**
+     * Get Router address set in fixed rate contract
+     * @return {String}
+     */
+    getRouter(): Promise<string>;
+    /**
+     * Get Exchange Owner given an exchangeId
+     * @param {String} exchangeId Exchange Id
+     * @return {String} return exchange owner
+     */
+    getExchangeOwner(exchangeId: string): Promise<string>;
+    /**
+     * Set new market fee, only market fee collector can update it
+     * @param {String} exchangeId Exchange Id
+     * @param {String} newMarketFee New market fee
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    updateMarketFee<G extends boolean = false>(exchangeId: string, newMarketFee: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Set new market fee collector, only market fee collector can update it
+     * @param {String} exchangeId Exchange Id
+     * @param {String} newMarketFeeCollector New market fee collector
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} transaction receipt
+     */
+    updateMarketFeeCollector<G extends boolean = false>(exchangeId: string, newMarketFeeCollector: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+}