@oceanprotocol/lib 2.7.0-next.2 → 3.0.0-next.0

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

@@ -1,8 +1,7 @@
-import { AbiItem } from 'web3-utils/types';
-import { PriceAndFees, FeesInfo, FixedPriceExchange, ReceiptOrEstimate } from '../@types';
+import { PriceAndFees, FeesInfo, FixedPriceExchange, ReceiptOrEstimate, AbiItem } from '../@types';
 import { SmartContractWithAddress } from './SmartContractWithAddress';
 export declare class FixedRateExchange extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem | AbiItem[];
+    getDefaultAbi(): AbiItem[];
     /**
      * Creates unique exchange identifier.
      * @param {String} baseToken baseToken contract address
@@ -15,95 +14,93 @@ export declare class FixedRateExchange extends SmartContractWithAddress {
      * @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} address User address
      * @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>(address: string, exchangeId: string, datatokenAmount: string, maxBaseTokenAmount: string, consumeMarketAddress?: string, consumeMarketFee?: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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} address User address
      * @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>(address: string, exchangeId: string, datatokenAmount: string, minBaseTokenAmount: string, consumeMarketAddress?: string, consumeMarketFee?: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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
-     * @param {String} exchangeId ExchangeId
-     * @param {Number} datatokenAmount Amount of datatokens
      * @return {Promise<Number>} no of available exchanges
      */
     getNumberOfExchanges(): Promise<number>;
     /**
      * Set new rate
-     * @param {String} exchangeId ExchangeId
+     * @param {String} exchangeId Exchange ID
      * @param {String} newRate New rate
-     * @param {String} address User account
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    setRate<G extends boolean = false>(address: string, exchangeId: string, newRate: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    setRate<G extends boolean = false>(exchangeId: string, newRate: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Sets a new allowedSwapper
-     * @param {String} exchangeId ExchangeId
-     * @param {String} newAllowedSwapper newAllowedSwapper (set address zero if we want to remove allowed swapper)
-     * @param {String} address User account
+     * @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>(address: string, exchangeId: string, newAllowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    setAllowedSwapper<G extends boolean = false>(exchangeId: string, newAllowedSwapper: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Activate an exchange
      * @param {String} exchangeId ExchangeId
-     * @param {String} address User address
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    activate<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    activate<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Deactivate an exchange
      * @param {String} exchangeId ExchangeId
-     * @param {String} address User address
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    deactivate<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    deactivate<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
-     * Get Rate
-     * @param {String} exchangeId ExchangeId
+     * 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 ExchangeId
+     * @param {String} exchangeId Exchange Id
      * @return {Promise<string>}  dt supply formatted
      */
     getDatatokenSupply(exchangeId: string): Promise<string>;
     /**
-     * Get BaseToken Supply in the exchange
-     * @param {String} exchangeId ExchangeId
+     * 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 ExchangeId
-     * @return {Promise<string>} address of allowedSwapper
+     * @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 ExchangeId
+     * @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>;
     /**
-     * getBTOut - returns amount in baseToken that user will receive for datatokenAmount sold
-     * @param {String} exchangeId ExchangeId
+     * 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
@@ -111,72 +108,72 @@ export declare class FixedRateExchange extends SmartContractWithAddress {
     getAmountBasetokensOut(exchangeId: string, datatokenAmount: string, consumeMarketFee?: string): Promise<string>;
     /**
      * Get exchange details
-     * @param {String} exchangeId ExchangeId
+     * @param {String} exchangeId Exchange Id
      * @return {Promise<FixedPricedExchange>} Exchange details
      */
     getExchange(exchangeId: string): Promise<FixedPriceExchange>;
     /**
      * Get fee details for an exchange
-     * @param {String} exchangeId ExchangeId
-     * @return {Promise<FixedPricedExchange>} Exchange details
+     * @param {String} exchangeId Exchange Id
+     * @return {Promise<FeesInfo>} Exchange details
      */
     getFeesInfo(exchangeId: string): Promise<FeesInfo>;
     /**
-     * Get all exchanges
-     * @param {String} exchangeId ExchangeId
+     * 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>} Result
+     * @return {Promise<Boolean>}
      */
     isActive(exchangeId: string): Promise<boolean>;
     /**
      * Activate minting option for fixed rate contract
-     * @param {String} exchangeId ExchangeId
-     * @param {String} address User address
+     * @param {String} exchangeId Exchang eId
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    activateMint<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    activateMint<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Deactivate minting for fixed rate
      * @param {String} exchangeId ExchangeId
-     * @param {String} address User address
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    deactivateMint<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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} address User address
-     * @param {String} exchangeId ExchangeId
+     * @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>(address: string, exchangeId: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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} address User address
-     * @param {String} exchangeId ExchangeId
+     * @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>(address: string, exchangeId: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 ExchangeId
-     * @param {String} address User address
+     * @param {String} exchangeId Exchange Id
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    collectMarketFee<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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 ExchangeId
-     * @param {String} address User address
+     * @param {String} exchangeId Exchange Id
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    collectOceanFee<G extends boolean = false>(address: string, exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    collectOceanFee<G extends boolean = false>(exchangeId: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Get OPF Collector of fixed rate contract
      * @return {String}
@@ -189,24 +186,24 @@ export declare class FixedRateExchange extends SmartContractWithAddress {
     getRouter(): Promise<string>;
     /**
      * Get Exchange Owner given an exchangeId
-     * @param {String} exchangeId 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} address user address
-     * @param {String} exchangeId ExchangeId
+     * @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>(address: string, exchangeId: string, newMarketFee: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    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} address user address
-     * @param {String} exchangeId ExchangeId
+     * @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>(address: string, exchangeId: string, newMarketFeeCollector: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    updateMarketFeeCollector<G extends boolean = false>(exchangeId: string, newMarketFeeCollector: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
 }

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

@@ -1,9 +1,8 @@
-import { AbiItem } from 'web3-utils';
-import { TransactionReceipt } from 'web3-eth';
-import { MetadataProof, MetadataAndTokenURI, NftRoles, ReceiptOrEstimate } from '../@types';
+import { BigNumber } from 'ethers';
+import { MetadataProof, MetadataAndTokenURI, NftRoles, ReceiptOrEstimate, AbiItem } from '../@types';
 import { SmartContract } from './SmartContract';
 export declare class Nft extends SmartContract {
-    getDefaultAbi(): AbiItem | AbiItem[];
+    getDefaultAbi(): AbiItem[];
     /**
      * Create new ERC20 Datatoken - only user with DatatokenDeployer permission can succeed
      * @param {String} nftAddress NFT address
@@ -17,14 +16,16 @@ export declare class Nft extends SmartContract {
      * @param {String} name Token name
      * @param {String} symbol Token symbol
      * @param {Number} templateIndex NFT template index
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<string>} ERC20 Datatoken address
      */
-    createDatatoken<G extends boolean = false>(nftAddress: string, address: string, minter: string, paymentCollector: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number, estimateGas?: G): Promise<G extends false ? string : number>;
+    createDatatoken<G extends boolean = false>(nftAddress: string, address: string, minter: string, paymentCollector: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number, estimateGas?: G): Promise<G extends false ? string : BigNumber>;
     /**
      * Add Manager for NFT Contract (only NFT Owner can succeed)
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Owner adress
      * @param {String} manager User adress which is going to be assing manager
+     * @param {Boolean} [estimateGas] if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     addManager<G extends boolean = false>(nftAddress: string, address: string, manager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -33,6 +34,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Owner adress
      * @param {String} manager User adress which is going to be removed as manager
+     * @param {Boolean} [estimateGas] if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     removeManager<G extends boolean = false>(nftAddress: string, address: string, manager: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -41,6 +43,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} datatokenDeployer User adress which is going to have DatatokenDeployer permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     addDatatokenDeployer<G extends boolean = false>(nftAddress: string, address: string, datatokenDeployer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -49,6 +52,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} datatokenDeployer Address of the user to be revoked DatatokenDeployer Permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     removeDatatokenDeployer<G extends boolean = false>(nftAddress: string, address: string, datatokenDeployer: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -57,6 +61,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} metadataUpdater User adress which is going to have Metadata Updater permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     addMetadataUpdater<G extends boolean = false>(nftAddress: string, address: string, metadataUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -65,6 +70,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} metadataUpdater Address of the user to be revoked Metadata updater Permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     removeMetadataUpdater<G extends boolean = false>(nftAddress: string, address: string, metadataUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -73,6 +79,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} storeUpdater User adress which is going to have Store Updater permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     addStoreUpdater<G extends boolean = false>(nftAddress: string, address: string, storeUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -81,6 +88,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Manager adress
      * @param {String} storeUpdater Address of the user to be revoked Store Updater Permission
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     removeStoreUpdater<G extends boolean = false>(nftAddress: string, address: string, storeUpdater: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -91,6 +99,7 @@ export declare class Nft extends SmartContract {
      * Only NFT Owner  can call it.
      * @param {String} nftAddress NFT contract address
      * @param {String} address NFT Owner adress
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     cleanPermissions<G extends boolean = false>(nftAddress: string, address: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -101,6 +110,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftOwner Current NFT Owner adress
      * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
      * @param {Number} tokenId The id of the token to be transfered
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     transferNft<G extends boolean = false>(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -111,6 +121,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftOwner Current NFT Owner adress
      * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
      * @param {Number} tokenId The id of the token to be transfered
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     safeTransferNft<G extends boolean = false>(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -118,12 +129,14 @@ export declare class Nft extends SmartContract {
      * Creates or update Metadata cached by Aquarius. Also, updates the METADATA_DECRYPTOR key
      * @param {String} nftAddress NFT contract address
      * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
-     * @param {String} address Caller address NFT Owner adress
+     * @param {Number} metadataState
+     * @param {String} metadataDecryptorUrl
+     * @param {String} metadataDecryptorAddress
+     * @param {String} flags
+     * @param {String} data
+     * @param {String} metadataHash
+     * @param {MetadataProof[]} metadataProofs
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     setMetadata<G extends boolean = false>(nftAddress: string, address: string, metadataState: number, metadataDecryptorUrl: string, metadataDecryptorAddress: string, flags: string, data: string, metadataHash: string, metadataProofs?: MetadataProof[], estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -132,6 +145,7 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address Caller address
      * @param {MetadataAndTokenURI} metadataAndTokenURI metaDataAndTokenURI object
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     setMetadataAndTokenURI<G extends boolean = false>(nftAddress: string, metadataUpdater: string, metadataAndTokenURI: MetadataAndTokenURI, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
@@ -140,58 +154,67 @@ export declare class Nft extends SmartContract {
      * @param {String} nftAddress NFT contract address
      * @param {String} address Caller address => metadata updater
      * @param {Number} metadataState new metadata state
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} trxReceipt
      */
     setMetadataState<G extends boolean = false>(nftAddress: string, address: string, metadataState: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** set TokenURI on an nft
-     * @param nftAddress NFT contract address
-     * @param address user adress
-     * @param data input data for TokenURI
+    /**
+     * set TokenURI on an nft
+     * @param {String} nftAddress NFT contract address
+     * @param {String} data input data for TokenURI
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transaction receipt
      */
-    setTokenURI<G extends boolean = false>(nftAddress: string, address: string, data: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-    /** Get Owner
+    setTokenURI<G extends boolean = false>(nftAddress: string, data: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Get NFT Owner
      * @param {String} nftAddress NFT contract address
      * @return {Promise<string>} string
      */
     getNftOwner(nftAddress: string): Promise<string>;
-    /** Get users NFT Permissions
+    /**
+     * Gets NFT Permissions for a specified user
      * @param {String} nftAddress NFT contract address
      * @param {String} address user adress
      * @return {Promise<NftRoles>}
      */
     getNftPermissions(nftAddress: string, address: string): Promise<NftRoles>;
-    /** Get users Metadata, return Metadata details
+    /**
+     * Returns Metadata details for an NFT
      * @param {String} nftAddress NFT contract address
      * @return {Promise<Objecta>}
      */
     getMetadata(nftAddress: string): Promise<Object>;
-    /** Get users DatatokenDeployer role
+    /**
+     * Checks if user has DatatokenDeployer role
      * @param {String} nftAddress NFT contract address
      * @param {String} address user adress
      * @return {Promise<boolean>}
      */
     isDatatokenDeployer(nftAddress: string, address: string): Promise<boolean>;
-    /** setData
-     * This function allows to store data with a preset key (keccak256(ERC20Address)) into NFT 725 Store
+    /**
+     * Allows users to store data with a preset key (keccak256(ERC20Address)) into NFT 725 Store
      * only ERC20Deployer can succeed
-     * @param nftAddress erc721 contract adress
-     * @param address user adress
-     * @param key Key of the data to be stored into 725Y standard
-     * @param value Data to be stored into 725Y standard
+     * @param {string} nftAddress Nft datatoken adress
+     * @param {string} address User adress
+     * @param {string} key Key of the data to be stored into 725Y standard
+     * @param {string} value Data to be stored into 725Y standard
+     * @param {boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>} transactionId
      */
-    setData(nftAddress: string, address: string, key: string, value: string): Promise<TransactionReceipt>;
-    /** Gets data at a given `key`
-     * @param {String} nftAddress NFT contract address
-     * @param {String} key the key which value to retrieve
+    setData<G extends boolean = false>(nftAddress: string, address: string, key: string, value: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Gets stored data at a given `key` in an NFT
+     * @param {string} nftAddress - The address of the NFT.
+     * @param {string} key - The key of the data to get.
      * @return {Promise<string>} The data stored at the key
      */
     getData(nftAddress: string, key: string): Promise<string>;
-    /** Gets data at a given `key`
-     * @param {String} nftAddress NFT contract address
-     * @param {String} id
-     * @return {Promise<string>} The data stored at the key
+    /**
+     * Gets the token URI of an NFT.
+     * @param {string} nftAddress - The address of the NFT.
+     * @param {number} id - The ID of the token.
+     * @returns {Promise&lt;string&gt;}
      */
     getTokenURI(nftAddress: string, id: number): Promise<string>;
 }