@oceanprotocol/lib 1.0.0-next.7 → 1.0.0

package/dist/src/aquarius/Aquarius.d.ts

@@ -1,10 +1,32 @@
 import { Asset, DDO, ValidateMetadata } from '../@types/';
 export declare class Aquarius {
     aquariusURL: any;
+    /**
+     * Instantiate Aquarius
+     * @param {String} aquariusURL
+     */
     constructor(aquariusURL: string);
-    resolve(did: string, fetchMethod?: any): Promise<DDO>;
-    sleep(ms: number): Promise<unknown>;
-    waitForAqua(did: string, txid?: string, fetchMethod?: any): Promise<Asset>;
-    validate(ddo: DDO, fetchMethod: any): Promise<ValidateMetadata>;
+    /** Resolves a DID
+     * @param {string} did
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<Asset>} Asset
+     */
+    resolve(did: string, signal?: AbortSignal): Promise<Asset>;
+    /**
+     * Blocks until Aqua will cache the did (or the update for that did) or timeouts
+     
+     * @param {string} did DID of the asset.
+     * @param {string} txid used when the did exists and we expect an update with that txid.
+       * @param {AbortSignal} signal abort signal
+     * @return {Promise<DDO>} DDO of the asset.
+     */
+    waitForAqua(did: string, txid?: string, signal?: AbortSignal): Promise<Asset>;
+    /**
+     * Validate DDO content
+     * @param {DDO} ddo DID Descriptor Object content.
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ValidateMetadata>}.
+     */
+    validate(ddo: DDO, signal?: AbortSignal): Promise<ValidateMetadata>;
 }
 export default Aquarius;

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

@@ -2,9 +2,8 @@ import { Contract } from 'web3-eth-contract';
 import Web3 from 'web3';
 import { TransactionReceipt } from 'web3-core';
 import { AbiItem } from 'web3-utils';
-import { FreCreationParams, Erc20CreateParams, PoolCreationParams, DispenserCreationParams } from '../interfaces';
 import { Config } from '../models/index.js';
-import { ProviderFees } from '../@types/index.js';
+import { ProviderFees, FreCreationParams, Erc20CreateParams, PoolCreationParams, DispenserCreationParams, ConsumeMarketFee } from '../@types/index.js';
 interface Template {
     templateAddress: string;
     isActive: boolean;
@@ -13,54 +12,264 @@ export interface TokenOrder {
     tokenAddress: string;
     consumer: string;
     serviceIndex: number;
-    _providerFees: ProviderFees;
+    _providerFee: ProviderFees;
+    _consumeMarketFee: ConsumeMarketFee;
 }
 export interface NftCreateData {
     name: string;
     symbol: string;
     templateIndex: number;
     tokenURI: string;
+    transferable: boolean;
+    owner: string;
 }
+/**
+ * Provides an interface for NFT Factory contract
+ */
 export declare class NftFactory {
-    GASLIMIT_DEFAULT: number;
     factory721Address: string;
     factory721Abi: AbiItem | AbiItem[];
     web3: Web3;
     config: Config;
     factory721: Contract;
-    constructor(factory721Address: string, web3: Web3, factory721Abi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Instantiate Datatokens.
+     * @param {String} factory721Address
+     * @param {AbiItem | AbiItem[]} factory721ABI
+     * @param {Web3} web3
+     */
+    constructor(factory721Address: string, web3: Web3, network?: string | number, factory721Abi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Get estimated gas cost for deployERC721Contract value
+     * @param {String} address
+     * @param {String} nftData
+     * @return {Promise<string>} NFT datatoken address
+     */
     estGasCreateNFT(address: string, nftData: NftCreateData): Promise<string>;
+    /**
+     * Create new NFT
+     * @param {String} address
+     * @param {NFTCreateData} nftData
+     * @return {Promise<string>} NFT datatoken address
+     */
     createNFT(address: string, nftData: NftCreateData): Promise<string>;
+    /** 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 ERC20 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 ERC20 is deployed from the factory
+     * @param {String} datatoken Datatoken address we want 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 we want to check
+     * @return {Promise<String>} return address(0) if it's not, or the nftAddress if true
+     */
     checkNFT(nftAddress: string): Promise<String>;
+    /**
+     * Estimate gas cost for add721TokenTemplate method
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
     estGasAddNFTTemplate(address: string, templateAddress: string): Promise<any>;
+    /**
+     * Add a new erc721 token template - only factory Owner
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
     addNFTTemplate(address: string, templateAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for disable721TokenTemplate method
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to disable
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     estGasDisableNFTTemplate(address: string, templateIndex: number): Promise<any>;
+    /**
+     * Disable token template - only factory Owner
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to disable
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     disableNFTTemplate(address: string, templateIndex: number): Promise<TransactionReceipt>;
+    /**
+     * Reactivate a previously disabled token template - only factory Owner
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to reactivate
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     estGasReactivateNFTTemplate(address: string, templateIndex: number): Promise<any>;
+    /**
+     * Reactivate a previously disabled token template - only factory Owner
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to reactivate
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     reactivateNFTTemplate(address: string, templateIndex: number): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addTokenTemplate method
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
     estGasAddTokenTemplate(address: string, templateAddress: string): Promise<any>;
+    /**
+     * Add a new erc721 token template - only factory Owner
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
     addTokenTemplate(address: string, templateAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for disableTokenTemplate method
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to disable
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     estGasDisableTokenTemplate(address: string, templateIndex: number): Promise<any>;
+    /**
+     * Disable token template - only factory Owner
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to disable
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     disableTokenTemplate(address: string, templateIndex: number): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for reactivateTokenTemplate method
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to reactivate
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     estGasReactivateTokenTemplate(address: string, templateIndex: number): Promise<any>;
+    /**
+     * Reactivate a previously disabled token template - only factory Owner
+     * @param {String} address
+     * @param {Number} templateIndex index of the template we want to reactivate
+     * @return {Promise<TransactionReceipt>} current token template count
+     */
     reactivateTokenTemplate(address: string, templateIndex: number): Promise<TransactionReceipt>;
+    /** Estimate gas cost for startMultipleTokenOrder method
+     * @param address Caller address
+     * @param orders an array of struct tokenOrder
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     estGasStartMultipleTokenOrder(address: string, orders: TokenOrder[]): Promise<any>;
+    /**
+     * @dev startMultipleTokenOrder
+     *      Used as a proxy to order multiple services
+     *      Users can have inifinite approvals for fees for factory instead of having one approval/ erc20 contract
+     *      Requires previous approval of all :
+     *          - consumeFeeTokens
+     *          - publishMarketFeeTokens
+     *          - erc20 datatokens
+     * @param address Caller address
+     * @param orders an array of struct tokenOrder
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     startMultipleTokenOrder(address: string, orders: TokenOrder[]): Promise<TransactionReceipt>;
-    estGasCreateNftWithErc(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams): Promise<any>;
-    createNftWithErc(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams): Promise<TransactionReceipt>;
-    estGasCreateNftErcWithPool(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, poolParams: PoolCreationParams): Promise<any>;
-    createNftErcWithPool(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, poolParams: PoolCreationParams): Promise<TransactionReceipt>;
-    estGasCreateNftErcWithFixedRate(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, freParams: FreCreationParams): Promise<any>;
-    createNftErcWithFixedRate(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, freParams: FreCreationParams): Promise<TransactionReceipt>;
-    estGasCreateNftErcWithDispenser(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, dispenserParams: DispenserCreationParams): Promise<any>;
-    createNftErcWithDispenser(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, dispenserParams: DispenserCreationParams): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for createNftWithErc20 method
+     * @param address Caller address
+     * @param _NftCreateData input data for nft creation
+     * @param _ErcCreateData input data for erc20 creation
+     *  @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    estGasCreateNftWithErc20(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams): Promise<any>;
+    /**
+     * @dev createNftWithErc20
+     *      Creates a new NFT, then a ERC20,all in one call
+     * @param address Caller address
+     * @param _NftCreateData input data for nft creation
+     * @param _ErcCreateData input data for erc20 creation
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    createNftWithErc20(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for createNftErc20WithPool method
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param poolParams input data for Pool Creation
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    estGasCreateNftErc20WithPool(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, poolParams: PoolCreationParams): Promise<any>;
+    /**
+     * @dev createNftErc20WithPool
+     *      Creates a new NFT, then a ERC20, then a Pool, all in one call
+     *      Use this carefully, because if Pool creation fails, you are still going to pay a lot of gas
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param poolParams input data for Pool Creation
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    createNftErc20WithPool(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, poolParams: PoolCreationParams): Promise<TransactionReceipt>;
+    /** Estimate gas cost for createNftErc20WithFixedRate method
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param freParams input data for FixedRate Creation
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    estGasCreateNftErc20WithFixedRate(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, freParams: FreCreationParams): Promise<any>;
+    /**
+     * @dev createNftErc20WithFixedRate
+     *      Creates a new NFT, then a ERC20, then a FixedRateExchange, all in one call
+     *      Use this carefully, because if Fixed Rate creation fails, you are still going to pay a lot of gas
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param freParams input data for FixedRate Creation
+     *  @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    createNftErc20WithFixedRate(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, freParams: FreCreationParams): Promise<TransactionReceipt>;
+    /** Estimate gas cost for createNftErc20WithFixedRate method
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param dispenserParams input data for Dispenser Creation
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    estGasCreateNftErc20WithDispenser(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, dispenserParams: DispenserCreationParams): Promise<any>;
+    /**
+     * @dev createNftErc20WithDispenser
+     *      Creates a new NFT, then a ERC20, then a Dispenser, all in one call
+     *      Use this carefully, because if Dispenser creation fails, you are still going to pay a lot of gas
+     * @param address Caller address
+     * @param nftCreateData input data for NFT Creation
+     * @param ercParams input data for ERC20 Creation
+     * @param dispenserParams input data for Dispenser Creation
+     *  @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    createNftErc20WithDispenser(address: string, nftCreateData: NftCreateData, ercParams: Erc20CreateParams, dispenserParams: DispenserCreationParams): Promise<TransactionReceipt>;
 }
 export {};

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from './aquarius';
 export * from './pools';
 export * from './tokens';
 export * from './factories';
@@ -5,4 +6,3 @@ export * from './models';
 export * from './utils';
 export * from './@types';
 export * from './provider';
-export * from './interfaces';

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

@@ -1,38 +1,166 @@
 import { LogLevel } from '../utils/Logger';
 import { AbiItem } from 'web3-utils/types';
 export declare class Config {
+    /**
+     * Ethereum node URL.
+     * @type {string}
+     */
     nodeUri?: string;
+    /**
+     * Address of Provider.
+     * @type {string}
+     */
     providerAddress?: string;
+    /**
+     * Metadata Store URL.
+     * @type {string}
+     */
     metadataCacheUri?: string;
+    /**
+     * Provider URL.
+     * @type {string}
+     */
     providerUri?: string;
+    /**
+     * Web3 Provider.
+     * @type {any}
+     */
     web3Provider?: any;
+    /**
+     * Ocean Token address
+     * @type {string}
+     */
     oceanTokenAddress?: string;
+    /**
+     * Factory address
+     * @type {string}
+     */
     erc721FactoryAddress?: string;
+    /**
+     * Factory ABI
+     * @type {string}
+     */
     erc721FFactoryABI?: AbiItem | AbiItem[];
+    /**
+     * datatokens ABI
+     * @type {string}
+     */
     datatokensABI?: AbiItem | AbiItem[];
+    /**
+     * Pool Template address
+     * @type {string}
+     */
     poolTemplateAddress?: string;
+    /**
+     * Pool Factory ABI
+     * @type {string}
+     */
     poolFactoryABI?: AbiItem | AbiItem[];
+    /**
+     * Pool ABI
+     * @type {string}
+     */
     poolABI?: AbiItem | AbiItem[];
+    /**
+     * FixedRateExchangeAddress
+     * @type {string}
+     */
     fixedRateExchangeAddress?: string;
+    /**
+     * FixedRateExchangeAddressABI
+     * @type {any}
+     */
     fixedRateExchangeAddressABI?: AbiItem | AbiItem[];
+    /**
+     * DispenserAddress
+     * @type {string}
+     */
     dispenserAddress?: string;
+    /**
+     * DispenserABI
+     * @type {any}
+     */
     dispenserABI?: AbiItem | AbiItem[];
+    /**
+     * OPFCommunityFeeCollector
+     * @type {string}
+     */
     opfCommunityFeeCollector?: string;
+    /**
+     * SideStaking address
+     * @type {string}
+     */
     sideStakingAddress?: string;
+    /**
+     * block number of the deployment
+     * @type {number}
+     */
     startBlock?: number;
+    /**
+     * Log level.
+     * @type {boolean | LogLevel}
+     */
     verbose?: boolean | LogLevel;
+    /**
+     * Message shown when the user creates its own token.
+     * @type {string}
+     */
     authMessage?: string;
+    /**
+     * Token expiration time in ms.
+     * @type {number}
+     */
     authTokenExpiration?: number;
+    /**
+     * Parity config
+     * @type {string}
+     */
     parityUri?: string;
     threshold?: number;
+    /**
+     * Chain ID
+     * @type {number}
+     */
     chainId: number;
+    /**
+     * Network name ex: mainnet, rinkeby, polygon
+     * @type {string}
+     */
     network: string;
+    /**
+     * Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com
+     * @type {string}
+     */
     subgraphUri: string;
+    /**
+     * Url of the  blockchain exporer ex: https://etherscan.io
+     * @type {string}
+     */
     explorerUri: string;
+    /**
+     * Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls
+     * @type {string}
+     */
     oceanTokenSymbol: string;
+    /**
+     * Specify the transaction Block Timeout
+     * @type {number}
+     */
     transactionBlockTimeout: number;
+    /**
+     * Specify the transaction Confirmation Blocks
+     * @type {number}
+     */
     transactionConfirmationBlocks: number;
+    /**
+     * Specify the transaction Polling Blocks Timeout
+     * @type {number}
+     */
     transactionPollingTimeout: number;
+    /**
+     * Specify the multiplier for the gas fee
+     * @type {number}
+     */
     gasFeeMultiplier: number;
 }
 export default Config;