@oceanprotocol/lib 1.0.0-next.10 → 1.0.0-next.14

package/dist/src/pools/fixedRate/FixedRateExchange.d.ts

@@ -3,6 +3,7 @@ import { Contract } from 'web3-eth-contract';
 import { AbiItem } from 'web3-utils/types';
 import Web3 from 'web3';
 import { Config } from '../../models/index.js';
+import { PriceAndFees } from '../..';
 export interface FixedPriceExchange {
     active: boolean;
     exchangeOwner: string;
@@ -39,6 +40,7 @@ export declare enum FixedRateCreateProgressStep {
 }
 export declare class FixedRateExchange {
     GASLIMIT_DEFAULT: number;
+    /** Ocean related functions */
     oceanAddress: string;
     fixedRateAddress: string;
     fixedRateExchangeAbi: AbiItem | AbiItem[];
@@ -47,50 +49,328 @@ export declare class FixedRateExchange {
     contract: Contract;
     config: Config;
     ssAbi: AbiItem | AbiItem[];
+    /**
+     * Instantiate FixedRateExchange
+     * @param {any} web3
+     * @param {any} fixedRateExchangeAbi
+     */
     constructor(web3: Web3, fixedRateAddress: string, fixedRateExchangeAbi?: AbiItem | AbiItem[], oceanAddress?: string, config?: Config);
     amountToUnits(token: string, amount: string): Promise<string>;
     unitsToAmount(token: string, amount: string): Promise<string>;
+    /**
+     * Creates unique exchange identifier.
+     * @param {String} datatoken Datatoken contract address
+     * @param {String} owner Owner of the exchange
+     * @return {Promise<string>} exchangeId
+     */
     generateExchangeId(baseToken: string, datatoken: string, owner: string): Promise<string>;
+    /**
+     * Estimate gas cost for buyDT
+     * @param {String} account
+     * @param {String} dtAmount datatoken amount we want to buy
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estBuyDT(account: string, datatokenAddress: string, dtAmount: string, maxBaseTokenAmount: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Atomic swap
+     * @param {String} exchangeId ExchangeId
+     * @param {String} datatokenAmount Amount of datatokens
+     * @param {String} maxBaseTokenAmount max amount of baseToken we want to pay for datatokenAmount
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     buyDT(address: string, exchangeId: string, datatokenAmount: string, maxBaseTokenAmount: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for sellDT
+     * @param {String} account
+     * @param {String} dtAmount datatoken amount we want to sell
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estSellDT(account: string, datatokenAddress: string, dtAmount: string, maxBaseTokenAmount: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Atomic swap
+     * @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
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     sellDT(address: string, exchangeId: string, datatokenAmount: string, minBaseTokenAmount: string): Promise<TransactionReceipt>;
+    /**
+     * 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>;
+    /**
+     * Estimate gas cost for setRate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} newRate New rate
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estSetRate(account: string, exchangeId: string, newRate: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new rate
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} newRate New rate
+     * @param {String} address User account
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     setRate(address: string, exchangeId: string, newRate: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for setRate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newAllowedSwapper new allowed swapper address
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estSetAllowedSwapper(account: string, exchangeId: string, newAllowedSwapper: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new rate
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newAllowedSwapper newAllowedSwapper (set address zero if we want to remove allowed swapper)
+     * @param {String} address User account
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     setAllowedSwapper(address: string, exchangeId: string, newAllowedSwapper: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for activate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estActivate(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Activate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     activate(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for deactivate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estDeactivate(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Deactivate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     deactivate(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Get Rate
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>} Rate (converted from wei)
+     */
     getRate(exchangeId: string): Promise<string>;
+    /**
+     * Get Datatoken Supply in the exchange
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>}  dt supply formatted
+     */
     getDTSupply(exchangeId: string): Promise<string>;
+    /**
+     * Get BaseToken Supply in the exchange
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>} dt supply formatted
+     */
     getBTSupply(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
+     */
     getAllowedSwapper(exchangeId: string): Promise<string>;
-    getAmountBTIn(exchangeId: string, datatokenAmount: string): Promise<string>;
+    /**
+     * calcBaseInGivenOutDT - Calculates how many base tokens are needed to get specified amount of datatokens
+     * @param {String} exchangeId ExchangeId
+     * @param {string} datatokenAmount Amount of datatokens user wants to buy
+     * @return {Promise<PriceAndFees>} how many base tokens are needed and fees
+     */
+    calcBaseInGivenOutDT(exchangeId: string, datatokenAmount: string): Promise<PriceAndFees>;
+    /**
+     * getBTOut - returns amount in baseToken that user will receive for datatokenAmount sold
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} datatokenAmount Amount of datatokens
+     * @return {Promise<string>} Amount of baseTokens user will receive
+     */
     getAmountBTOut(exchangeId: string, datatokenAmount: string): Promise<string>;
+    /**
+     * Get exchange details
+     * @param {String} exchangeId ExchangeId
+     * @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
+     */
     getFeesInfo(exchangeId: string): Promise<FeesInfo>;
+    /**
+     * Get all exchanges
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<String[]>} Exchanges list
+     */
     getExchanges(): Promise<string[]>;
+    /**
+     * Check if an exchange is active
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<Boolean>} Result
+     */
     isActive(exchangeId: string): Promise<boolean>;
+    /**
+     * Estimate gas cost for activate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estActivateMint(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Activate minting option for fixed rate contract
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     activateMint(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for deactivate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estDeactivateMint(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Deactivate minting for fixed rate
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     deactivateMint(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collectBT
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estCollectBT(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect BaseTokens in the contract (only exchange owner)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     collectBT(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collecDT
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estCollectDT(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect datatokens in the contract (only exchange owner)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     collectDT(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collecMarketFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estCollectMarketFee(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect market fee and send it to marketFeeCollector (anyone can call it)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     collectMarketFee(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collectOceanFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estCollectOceanFee(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect ocean fee and send it to OPF collector (anyone can call it)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     collectOceanFee(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Get OPF Collector of fixed rate contract
+     * @return {String}
+     */
     getOPCCollector(): Promise<string>;
+    /**
+     * Get Router address set in fixed rate contract
+     * @return {String}
+     */
     getRouter(): Promise<string>;
+    /**
+     * Get Exchange Owner given an exchangeId
+     * @param {String} exchangeId ExchangeId
+     * @return {String} return exchange owner
+     */
     getExchangeOwner(exchangeId: string): Promise<string>;
+    /**
+     * Estimate gas cost for updateMarketFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estUpdateMarketFee(account: string, exchangeId: string, newMarketFee: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new market fee, only market fee collector can update it
+     * @param {String} address user address
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     updateMarketFee(address: string, exchangeId: string, newMarketFee: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for updateMarketFeeCollector
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee collector
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estUpdateMarketFeeCollector(account: string, exchangeId: string, newMarketFeeCollector: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new market fee collector, only market fee collector can update it
+     * @param {String} address user address
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFeeCollector New market fee collector
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     updateMarketFeeCollector(address: string, exchangeId: string, newMarketFeeCollector: string): Promise<TransactionReceipt>;
 }

package/dist/src/pools/ssContracts/SideStaking.d.ts

@@ -11,20 +11,122 @@ export declare class SideStaking {
     constructor(web3: Web3, ssAbi?: AbiItem | AbiItem[], config?: Config);
     amountToUnits(token: string, amount: string): Promise<string>;
     unitsToAmount(token: string, amount: string): Promise<string>;
+    /**
+     * Get (total vesting amount + token released from the contract when adding liquidity)
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
     getDatatokenCirculatingSupply(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get actual dts in circulation (vested token withdrawn from the contract +
+           token released from the contract when adding liquidity)
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
     getDatatokenCurrentCirculatingSupply(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get Publisher address
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
     getPublisherAddress(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getBaseToken(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get Pool Address
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getPoolAddress(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get baseToken balance in the contract
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getBaseTokenBalance(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get dt balance in the staking contract available for being added as liquidity
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getDatatokenBalance(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get block when vesting ends
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String} end block for vesting amount
+     */
     getvestingEndBlock(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get total amount vesting
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getvestingAmount(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get last block publisher got some vested tokens
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getvestingLastBlock(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get how much has been taken from the vesting amount
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
     getvestingAmountSoFar(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Estimate gas cost for getVesting
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estGetVesting(account: string, ssAddress: string, datatokenAddress: string, contractInstance?: Contract): Promise<number>;
+    /** Send vested tokens available to the publisher address, can be called by anyone
+     *
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {TransactionReceipt}
+     */
     getVesting(account: string, ssAddress: string, datatokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for getVesting
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
     estSetPoolSwapFee(account: string, ssAddress: string, datatokenAddress: string, poolAddress: string, swapFee: number, contractInstance?: Contract): Promise<number>;
+    /** Send vested tokens available to the publisher address, can be called by anyone
+     *
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {TransactionReceipt}
+     */
     setPoolSwapFee(account: string, ssAddress: string, datatokenAddress: string, poolAddress: string, swapFee: number): Promise<TransactionReceipt>;
+    /**
+     * Get Router address set in side staking contract
+     * @param {String} ssAddress side staking contract address
+     * @return {String}
+     */
     getRouter(ssAddress: string): Promise<string>;
 }

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

@@ -1,5 +1,5 @@
 import Web3 from 'web3';
-import { FileMetadata, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ProviderInitialize } from '../@types/';
+import { FileMetadata, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize } from '../@types/';
 import { DownloadResponse } from '../@types/DownloadResponse';
 export interface HttpCallback {
     (httpMethod: string, url: string, body: string, header: any): Promise<any>;
@@ -13,22 +13,134 @@ 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[]>;
+    /** Get Compute Environments
+     * @return {Promise<ComputeEnvironment[]>} urlDetails
+     */
+    getComputeEnvironments(providerUri: string, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
+    /** 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 {string} computeEnv
+     * @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;