@oceanprotocol/lib 2.7.0 → 3.0.0-next.0

package/dist/src/@types/Contracts.d.ts

@@ -0,0 +1,26 @@
+export declare type AbiType = 'function' | 'constructor' | 'event' | 'fallback';
+export declare type StateMutabilityType = 'pure' | 'view' | 'nonpayable' | 'payable';
+export interface AbiInput {
+    name: string;
+    type: string;
+    indexed?: boolean;
+    components?: AbiInput[];
+    internalType?: string;
+}
+export interface AbiOutput {
+    name: string;
+    type: string;
+    components?: AbiOutput[];
+    internalType?: string;
+}
+export interface AbiItem {
+    anonymous?: boolean;
+    constant?: boolean;
+    inputs?: AbiInput[];
+    name?: string;
+    outputs?: AbiOutput[];
+    payable?: boolean;
+    stateMutability?: StateMutabilityType;
+    type: AbiType;
+    gas?: number;
+}

package/dist/src/@types/DDO/Metadata.d.ts

@@ -1,6 +1,6 @@
 export interface MetadataAlgorithm {
     /**
-     * Language used to implement the software.
+     * Programming language used to implement the software.
      * @type {string}
      */
     language?: string;
@@ -106,7 +106,7 @@ export interface Metadata {
      */
     contentLanguage?: string;
     /**
-     * Information about asset of typealgorithm
+     * Information about asset of type algorithm. Required for algorithm assets.
      * @type {MetadataAlgorithm}
      */
     algorithm?: MetadataAlgorithm;

package/dist/src/@types/File.d.ts

@@ -1,4 +1,4 @@
-import { AbiItem } from 'web3-utils';
+import { AbiItem } from './Contracts';
 interface FileTypeHeaders {
     [key: string]: string;
 }

package/dist/src/@types/ReturnTypes.d.ts

@@ -1,2 +1,3 @@
-import { TransactionReceipt } from 'web3-core';
-export declare type ReceiptOrEstimate<G extends boolean = false> = G extends false ? TransactionReceipt : number;
+import { BigNumber, providers } from 'ethers';
+export declare type ReceiptOrEstimate<G extends boolean = false> = G extends false ? providers.TransactionResponse : BigNumber;
+export declare type ReceiptOrDecimal<G extends boolean = false> = G extends false ? providers.TransactionResponse : number;

package/dist/src/@types/index.d.ts

@@ -4,6 +4,7 @@ export * from './DDO/Event';
 export * from './DDO/Metadata';
 export * from './DDO/Service';
 export * from './Asset';
+export * from './Contracts';
 export * from './File';
 export * from './FileInfo';
 export * from './Compute';

package/dist/src/config/Config.d.ts

@@ -1,4 +1,4 @@
-import { AbiItem } from 'web3-utils/types';
+import { AbiItem } from '../@types';
 import { LogLevel } from '../utils';
 export declare class Config {
     /**

package/dist/src/config/ConfigHelper.d.ts

@@ -2,5 +2,11 @@ import { Config } from '.';
 export declare const configHelperNetworks: Config[];
 export declare class ConfigHelper {
     getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config>;
+    /**
+     * Returns the config object for a specific network supported by the oceanprotocol stack
+     * @param {string | number} network the network's chainId or name
+     * @param {string} infuraProjectId optional infura project id that will replace the configs node URI
+     * @return {Config} Config obhjedct
+     */
     getConfig(network: string | number, infuraProjectId?: string): Config;
 }

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

@@ -1,53 +1,56 @@
-import Web3 from 'web3';
-import { AbiItem } from 'web3-utils';
-import { TransactionReceipt } from 'web3-eth';
-import { ConsumeMarketFee, FreOrderParams, FreCreationParams, ProviderFees, PublishingMarketFee, DispenserParams, OrderParams, DatatokenRoles, ReceiptOrEstimate } from '../@types';
+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 | AbiItem[];
+    abiEnterprise: AbiItem[];
     nft: Nft;
-    getDefaultAbi(): AbiItem | AbiItem[];
+    getDefaultAbi(): AbiItem[];
     /**
-     * Instantiate ERC20 Datatokens
-     * @param {AbiItem | AbiItem[]} datatokensAbi
-     * @param {Web3} web3
+     * 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(web3: Web3, network?: string | number, config?: Config, abi?: AbiItem | AbiItem[], abiEnterprise?: AbiItem | AbiItem[]);
+    constructor(signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[], abiEnterprise?: AbiItem[]);
     /**
-     * Approve
+     * 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 {String} address User adress
-     * @return {Promise<ReceiptOrEstimate>} trxReceipt
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
      */
-    approve<G extends boolean = false>(dtAddress: string, spender: string, amount: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 {String} fixedPriceAddress
-     * @param {FixedRateParams} fixedRateParams
-     * @return {Promise<ReceiptOrEstimate>} transactionId
+     * @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 ispenser contract address
-     * @param {String} dispenserParams
+     * @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>>;
     /**
-     * Mint
+     * 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>>;
@@ -55,8 +58,9 @@ export declare class Datatoken extends SmartContract {
      * Add Minter for an ERC20 Datatoken
      * only DatatokenDeployer can succeed
      * @param {String} dtAddress Datatoken address
-     * @param {String} address User address
-     * @param {String} minter User which is going to be a Minter
+     * @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>>;
@@ -64,18 +68,19 @@ export declare class Datatoken extends SmartContract {
      * Revoke Minter permission for an ERC20 Datatoken
      * only DatatokenDeployer can succeed
      * @param {String} dtAddress Datatoken address
-     * @param {String} address User address
-     * @param {String} minter User which will be removed from Minter permission
-     * @param {Contract} contractInstance optional contract instance
-     * @return {Promise<any>}
+     * @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>>;
     /**
-     * Add addPaymentManager (can set who's going to collect fee when consuming orders)
+     *  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 User address
-     * @param {String} paymentManager User which is going to be a Minter
+     * @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>>;
@@ -85,6 +90,7 @@ export declare class Datatoken extends SmartContract {
      * @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>>;
@@ -92,120 +98,135 @@ export declare class Datatoken extends SmartContract {
      * 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 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
+    /**
+     * getPaymentCollector - It returns the current paymentCollector
      * @param dtAddress datatoken address
      * @return {Promise<string>}
      */
     getPaymentCollector(dtAddress: string): Promise<string>;
     /**
-     * Transfer as number from address to toAddress
+     * 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. To be converted to wei.
-     * @param {String} address User adress
+     * @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(dtAddress: string, toAddress: string, amount: string, address: string): Promise<TransactionReceipt>;
+    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, as number. Expressed as wei
-     * @param {String} address User adress
+     * @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, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** Start Order: called by payer or consumer prior ordering a service consume on a marketplace.
+    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} address User address which calls
      * @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, address: 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.
+    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} address User address which calls
      * @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, address: string, orderTxId: string, providerFees: ProviderFees, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** Buys 1 DT from the FRE and then startsOrder, while burning that DT
+    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 {String} address User address which calls
-     * @param {OrderParams} orderParams Consumer Address
-     * @param {FreParams} freParams Amount of tokens that is going to be transfered
+     * @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, address: string, orderParams: OrderParams, freParams: FreOrderParams, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** Gets DT from dispenser and then startsOrder, while burning that DT
+    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 {String} address User address which calls
-     * @param {OrderParams} orderParams
-     * @param {String} dispenserContract
+     * @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, address: string, orderParams: OrderParams, dispenserContract: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 dtAddress Datatoken address where we want to clean permissions
-     * @param address User adress
+     * @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
+    /**
+     * 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 capital
+    /**
+     * 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
+    /**
+     * It returns the token decimals, how many supported decimal points
      * @param {String} dtAddress Datatoken adress
      * @return {Promise<number>}
      */
-    getDecimals(dtAddress: string): Promise<string>;
-    /** It returns the token symbol
+    getDecimals(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
+    /**
+     *  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
+    /**
+     * It returns the token decimals, how many supported decimal points
      * @param {String} dtAddress Datatoken adress
      * @return {Promise<number>}
      */
     getNFTAddress(dtAddress: string): Promise<string>;
-    /**  Returns true if address has deployERC20 role
+    /**
+     *  Returns true if address has deployERC20 role
      * @param {String} dtAddress Datatoken adress
      * @param {String} dtAddress Datatoken adress
      * @return {Promise<boolean>}
@@ -219,24 +240,21 @@ export declare class Datatoken extends SmartContract {
      */
     balance(datatokenAddress: string, address: string): Promise<string>;
     /**
-     * @dev setPublishingMarketFee
-     *      Only publishMarketFeeAddress can call it
-     *      This function allows to set the fee required by the publisherMarket
+     * 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>>;
     /**
-     * @dev getPublishingMarketFee
-     *      Get publishingMarket Fee
-     *      This function allows to get the current fee set by the publishing market
+     * Returns the current fee set by the publishing market
      * @param {String} datatokenAddress Datatoken adress
-     * @param {String} address user adress
      * @return {Promise<PublishingMarketFee>} Current fee set by the publishing market
      */
-    getPublishingMarketFee(datatokenAddress: string, address: string): Promise<PublishingMarketFee>;
+    getPublishingMarketFee(datatokenAddress: string): Promise<PublishingMarketFee>;
     private getFreOrderParams;
 }

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

@@ -1,13 +1,12 @@
-import { AbiItem } from 'web3-utils';
 import { Datatoken } from './Datatoken';
 import { SmartContractWithAddress } from './SmartContractWithAddress';
-import { DispenserToken, ReceiptOrEstimate } from '../@types';
+import { DispenserToken, ReceiptOrEstimate, AbiItem } from '../@types';
 export declare class Dispenser extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem | AbiItem[];
+    getDefaultAbi(): AbiItem[];
     /**
      * Get information about a datatoken dispenser
      * @param {String} dtAddress
-     * @return {Promise<FixedPricedExchange>} Exchange details
+     * @return {Promise<DispenserToken>}
      */
     status(dtAdress: string): Promise<DispenserToken>;
     /**
@@ -17,54 +16,55 @@ export declare class Dispenser extends SmartContractWithAddress {
      * @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 new dispener.
+     * 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 {String} address User address (must be owner of the datatoken)
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
      */
-    activate<G extends boolean = false>(dtAddress: string, maxTokens: string, maxBalance: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 {String} address User address (must be owner of the datatoken)
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
      */
-    deactivate<G extends boolean = false>(dtAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    deactivate<G extends boolean = false>(dtAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
-     * Sets a new allowedSwapper.
-     * @param {String} dtAddress refers to datatoken address.
-     * @param {String} address User address (must be owner of the datatoken)
-     * @param {String} newAllowedSwapper refers to the new allowedSwapper
-     * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
+     * 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, address: string, newAllowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 DT (or be able to mint more)
+     * The dispenser must be active, hold enough datatokens (or be able to mint more)
      * and respect maxTokens/maxBalance requirements
-     * @param {String} dtAddress refers to datatoken address.
-     * @param {String} address User address
-     * @param {String} amount amount of datatokens required.
-     * @param {String} destination who will receive the tokens
-     * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
+     * @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, address: string, amount: string, destination: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 refers to datatoken address.
-     * @param {String} address User address (must be owner of the dispenser)
-     * @return {Promise<ReceiptOrEstimate>} TransactionReceipt
+     * @param {String} dtAddress Datatoken address.
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>}
      */
-    ownerWithdraw<G extends boolean = false>(dtAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    ownerWithdraw<G extends boolean = false>(dtAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Check if tokens can be dispensed
-     * @param {String} dtAddress
+     * @param {String} dtAddress Datatoken address
      * @param {String} address User address that will receive datatokens
      * @param {String} amount amount of datatokens required.
      * @return {Promise<Boolean>}