@oceanprotocol/lib 0.20.2 → 1.0.0-next.11

package/dist/src/provider/Provider.d.ts

@@ -0,0 +1,142 @@
+import Web3 from 'web3';
+import { FileMetadata, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ProviderInitialize } from '../@types/';
+import { DownloadResponse } from '../@types/DownloadResponse';
+export interface HttpCallback {
+    (httpMethod: string, url: string, body: string, header: any): Promise<any>;
+}
+export interface ServiceEndpoint {
+    serviceName: string;
+    method: string;
+    urlPath: string;
+}
+export interface UserCustomParameters {
+    [key: string]: any;
+}
+export declare class Provider {
+    /**
+     * Returns the provider endpoints
+     * @return {Promise<ServiceEndpoint[]>}
+     */
+    getEndpoints(providerUri: string): Promise<any>;
+    getEndpointURL(servicesEndpoints: ServiceEndpoint[], serviceName: string): ServiceEndpoint;
+    /**
+     * Returns the service endpoints that exist in provider.
+     * @param {any} endpoints
+     * @return {Promise<ServiceEndpoint[]>}
+     */
+    getServiceEndpoints(providerEndpoint: string, endpoints: any): Promise<ServiceEndpoint[]>;
+    /** Encrypt DDO using the Provider's own symmetric key
+     * @param {string} providerUri provider uri address
+     * @param {string} consumerAddress Publisher address
+     * @param {AbortSignal} signal abort signal
+     * @param {string} providerEndpoints Identifier of the asset to be registered in ocean
+     * @param {string} serviceEndpoints document description object (DDO)=
+     * @return {Promise<string>} urlDetails
+     */
+    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<string>;
+    createSignature(web3: Web3, accountId: string, agreementId: string): Promise<string>;
+    createHashSignature(web3: Web3, accountId: string, message: string): Promise<string>;
+    /** Encrypt data using the Provider's own symmetric key
+     * @param {string} data data in json format that needs to be sent , it can either be a DDO or a File array
+     * @param {string} providerUri provider uri address
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<string>} urlDetails
+     */
+    encrypt(data: any, providerUri: string, signal?: AbortSignal): Promise<string>;
+    /** Get DDO File details (if possible)
+     * @param {string} did did
+     * @param {number} serviceId the id of the service for which to check the files
+     * @param {string} providerUri uri of the provider that will be used to check the file
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<FileMetadata[]>} urlDetails
+     */
+    checkDidFiles(did: string, serviceId: number, providerUri: string, signal?: AbortSignal): Promise<FileMetadata[]>;
+    /** Get URL details (if possible)
+     * @param {string} url or did
+     * @param {string} providerUri uri of the provider that will be used to check the file
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<FileMetadata[]>} urlDetails
+     */
+    checkFileUrl(url: string, providerUri: string, signal?: AbortSignal): Promise<FileMetadata[]>;
+    /** Initialize a service request.
+     * @param {DDO | string} asset
+     * @param {number} serviceIndex
+     * @param {string} serviceType
+     * @param {string} consumerAddress
+     * @param {UserCustomParameters} userCustomParameters
+     * @param {string} providerUri Identifier of the asset to be registered in ocean
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ProviderInitialize>} ProviderInitialize data
+     */
+    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
+    /** Gets fully signed URL for download
+     * @param {string} did
+     * @param {string} accountId
+     * @param {string} serviceId
+     * @param {number} fileIndex
+     * @param {string} providerUri
+     * @param {Web3} web3
+     * @param {UserCustomParameters} userCustomParameters
+     * @return {Promise<string>}
+     */
+    getDownloadUrl(did: string, accountId: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, web3: Web3, userCustomParameters?: UserCustomParameters): Promise<any>;
+    /** Instruct the provider to start a compute job
+     * @param {string} did
+     * @param {string} consumerAddress
+     * @param {ComputeAlgorithm} algorithm
+     * @param {string} providerUri
+     * @param {Web3} web3
+     * @param {AbortSignal} signal abort signal
+     * @param {ComputeOutput} output
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeStart(providerUri: string, web3: Web3, consumerAddress: string, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput): Promise<ComputeJob | ComputeJob[]>;
+    /** Instruct the provider to Stop the execution of a to stop a compute job.
+     * @param {string} did
+     * @param {string} consumerAddress
+     * @param {string} jobId
+     * @param {string} providerUri
+     * @param {Web3} web3
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, web3: Web3, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    /** Get status for a specific jobId/documentId/owner.
+     * @param {string} did
+     * @param {string} consumerAddress
+     * @param {string} providerUri
+     * @param {Web3} web3
+     * @param {AbortSignal} signal abort signal
+     * @param {string} jobId
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeStatus(providerUri: string, signal?: AbortSignal, jobId?: string, did?: string, consumerAddress?: string): Promise<ComputeJob | ComputeJob[]>;
+    /** Get status for a specific jobId/documentId/owner.
+     * @param {string} jobId
+     * @param {number} index
+     * @param {string} providerUri
+     * @param {string} destination
+     * @param {Web3} web3
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeResult(jobId: string, index: number, accountId: string, providerUri: string, web3: Web3, signal?: AbortSignal): Promise<DownloadResponse | void>;
+    /** Deletes a compute job.
+     * @param {string} did
+     * @param {string} consumerAddress
+     * @param {string} jobId
+     * @param {string} providerUri
+     * @param {Web3} web3
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeDelete(did: string, consumerAddress: string, jobId: string, providerUri: string, web3: Web3, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    /** Check for a valid provider at URL
+     * @param {String} url provider uri address
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<boolean>} string
+     */
+    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
+}
+export declare const ProviderInstance: Provider;
+export default ProviderInstance;

package/dist/src/provider/index.d.ts

@@ -0,0 +1 @@
+export * from './Provider';

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

@@ -0,0 +1,362 @@
+import Web3 from 'web3';
+import { AbiItem } from 'web3-utils';
+import { TransactionReceipt } from 'web3-eth';
+import { Contract } from 'web3-eth-contract';
+import { FreOrderParams, FreCreationParams, ProviderFees } from '../@types';
+import { Nft } from './NFT';
+import { Config } from '../models/index.js';
+/**
+ * ERC20 ROLES
+ */
+interface Roles {
+    minter: boolean;
+    paymentManager: boolean;
+}
+export interface OrderParams {
+    consumer: string;
+    serviceIndex: number;
+    _providerFees: ProviderFees;
+}
+export interface DispenserParams {
+    maxTokens: string;
+    maxBalance: string;
+    withMint?: boolean;
+    allowedSwapper?: string;
+}
+export declare class Datatoken {
+    GASLIMIT_DEFAULT: number;
+    factoryAddress: string;
+    factoryABI: AbiItem | AbiItem[];
+    datatokensAbi: AbiItem | AbiItem[];
+    datatokensEnterpriseAbi: AbiItem | AbiItem[];
+    web3: Web3;
+    config: Config;
+    nft: Nft;
+    /**
+     * Instantiate ERC20 Datatokens
+     * @param {AbiItem | AbiItem[]} datatokensAbi
+     * @param {Web3} web3
+     */
+    constructor(web3: Web3, datatokensAbi?: AbiItem | AbiItem[], datatokensEnterpriseAbi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Estimate gas cost for mint method
+     * @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
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasApprove(dtAddress: string, spender: string, amount: string, address: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Approve
+     * @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<TransactionReceipt>} trxReceipt
+     */
+    approve(dtAddress: string, spender: string, amount: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for mint method
+     * @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 {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasMint(dtAddress: string, address: string, amount: string, toAddress?: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Estimate gas cost for createFixedRate method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} fixedPriceAddress
+     * @param {FixedRateParams} fixedRateParams
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasCreateFixedRate(dtAddress: string, address: string, fixedRateParams: FreCreationParams, contractInstance?: Contract): Promise<any>;
+    /**
+     * Creates a new FixedRateExchange setup.
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} fixedPriceAddress
+     * @param {FixedRateParams} fixedRateParams
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    createFixedRate(dtAddress: string, address: string, fixedRateParams: FreCreationParams): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for createDispenser method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} dispenserAddress ispenser contract address
+     * @param {String} dispenserParams
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasCreateDispenser(dtAddress: string, address: string, dispenserAddress: string, dispenserParams: DispenserParams, contractInstance?: Contract): Promise<any>;
+    /**
+     * Creates a new Dispenser
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Caller address
+     * @param {String} dispenserAddress ispenser contract address
+     * @param {String} dispenserParams
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    createDispenser(dtAddress: string, address: string, dispenserAddress: string, dispenserParams: DispenserParams): Promise<TransactionReceipt>;
+    /**
+     * Mint
+     * @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
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    mint(dtAddress: string, address: string, amount: string, toAddress?: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addMinter method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} minter User which is going to be a Minter
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasAddMinter(dtAddress: string, address: string, minter: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add Minter for an ERC20 datatoken
+     * only ERC20Deployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} minter User which is going to be a Minter
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    addMinter(dtAddress: string, address: string, minter: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for removeMinter method
+     * @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>}
+     */
+    estGasRemoveMinter(dtAddress: string, address: string, minter: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Revoke Minter permission for an ERC20 datatoken
+     * only ERC20Deployer 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>}
+     */
+    removeMinter(dtAddress: string, address: string, minter: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for addPaymentManager method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} paymentManager User which is going to be a Minter
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasAddPaymentManager(dtAddress: string, address: string, paymentManager: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add addPaymentManager (can set who's going to collect fee when consuming orders)
+     * only ERC20Deployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} paymentManager User which is going to be a Minter
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    addPaymentManager(dtAddress: string, address: string, paymentManager: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for removePaymentManager method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} paymentManager User which will be removed from paymentManager permission
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasRemovePaymentManager(dtAddress: string, address: string, paymentManager: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Revoke paymentManager permission for an ERC20 datatoken
+     * only ERC20Deployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} paymentManager User which will be removed from paymentManager permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
+    removePaymentManager(dtAddress: string, address: string, paymentManager: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for setPaymentCollector method
+     * @param dtAddress datatoken address
+     * @param address Caller address
+     * @param paymentCollector User to be set as new payment collector
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasSetPaymentCollector(dtAddress: string, address: string, paymentCollector: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * 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
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
+    setPaymentCollector(dtAddress: string, address: string, paymentCollector: string): Promise<TransactionReceipt>;
+    /** 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
+     * @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
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    transfer(dtAddress: string, toAddress: string, amount: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for transfer method
+     * @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 {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasTransfer(dtAddress: string, toAddress: string, amount: string, address: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * 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
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    transferWei(dtAddress: string, toAddress: string, amount: string, address: string): Promise<TransactionReceipt>;
+    /** Estimate gas cost for startOrder method
+     * @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 {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasStartOrder(dtAddress: string, address: string, consumer: string, serviceIndex: number, providerFees: ProviderFees, contractInstance?: Contract): Promise<any>;
+    /** 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
+     * @return {Promise<TransactionReceipt>} string
+     */
+    startOrder(dtAddress: string, address: string, consumer: string, serviceIndex: number, providerFees: ProviderFees): Promise<TransactionReceipt>;
+    /** Estimate gas cost for buyFromFreAndOrder method
+     * @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 {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasBuyFromFreAndOrder(dtAddress: string, address: string, orderParams: OrderParams, freParams: FreOrderParams, contractInstance?: Contract): Promise<any>;
+    /** 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
+     * @return {Promise<TransactionReceipt>}
+     */
+    buyFromFreAndOrder(dtAddress: string, address: string, orderParams: OrderParams, freParams: FreOrderParams): Promise<TransactionReceipt>;
+    /** Estimate gas cost for buyFromFreAndOrder method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address which calls
+     * @param {OrderParams} orderParams
+     * @param {String} dispenserContract
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasBuyFromDispenserAndOrder(dtAddress: string, address: string, orderParams: OrderParams, dispenserContract: string, contractInstance?: Contract): Promise<any>;
+    /** Gets 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
+     * @return {Promise<TransactionReceipt>}
+     */
+    buyFromDispenserAndOrder(dtAddress: string, address: string, orderParams: OrderParams, dispenserContract: string): Promise<TransactionReceipt>;
+    /** Estimate gas for setData method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} value Data to be stored into 725Y standard
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasSetData(dtAddress: string, address: string, value: string, contractInstance?: Contract): Promise<any>;
+    /** setData
+     * This function allows to store data with a preset key (keccak256(ERC20Address)) into NFT 725 Store
+     * only ERC20Deployer can succeed
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address User address
+     * @param {String} value Data to be stored into 725Y standard
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    setData(dtAddress: string, address: string, value: string): Promise<TransactionReceipt>;
+    /** Estimate gas for cleanPermissions method
+     * @param dtAddress Datatoken address where we want to clean permissions
+     * @param address User adress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasCleanPermissions(dtAddress: string, address: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Clean erc20level 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
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    cleanPermissions(dtAddress: string, address: string): Promise<TransactionReceipt>;
+    /** Returns ERC20 user's permissions for a datatoken
+     * @param {String} dtAddress Datatoken adress
+     * @param {String} address user adress
+     * @return {Promise<Roles>}
+     */
+    getDTPermissions(dtAddress: string, address: string): Promise<Roles>;
+    /** Returns the Datatoken capital
+     * @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<string>;
+    /** 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
+     * @param {String} dtAddress Datatoken adress
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<boolean>}
+     */
+    isERC20Deployer(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>;
+}
+export {};