@oceanprotocol/lib 2.7.0 → 3.0.0-next.1

package/dist/src/contracts/ve/VeOcean.d.ts

@@ -1,48 +1,47 @@
-import { AbiItem } from 'web3-utils';
 import { SmartContractWithAddress } from '../SmartContractWithAddress';
-import { ReceiptOrEstimate } from '../../@types';
+import { ReceiptOrEstimate, AbiItem } from '../../@types';
 /**
  * Provides an interface for veOcean contract
  */
 export declare class VeOcean extends SmartContractWithAddress {
-    getDefaultAbi(): AbiItem | AbiItem[];
+    getDefaultAbi(): AbiItem[];
     /**
      * Deposit `amount` tokens for `userAddress` and lock until `unlockTime`
-     * @param {String} userAddress user address
      * @param {String} amount Amount of tokens to be locked
      * @param {Number} unlockTime Timestamp for unlock
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>}
      */
-    lockTokens<G extends boolean = false>(userAddress: string, amount: string, unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    lockTokens<G extends boolean = false>(amount: string, unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Deposit `amount` tokens for `toAddress` and add to the existing lock
      * Anyone (even a smart contract) can deposit for someone else, but cannot extend their locktime and deposit for a brand new user
-     * @param {String} fromUserAddress user address that sends the tx
      * @param {String} toAddress user address to deposit for
      * @param {String} amount Amount of tokens to be locked
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>}
      */
-    depositFor<G extends boolean = false>(fromUserAddress: string, toAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    depositFor<G extends boolean = false>(toAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Deposit `amount` additional tokens for `userAddress` without modifying the unlock time
-     * @param {String} userAddress user address that sends the tx
      * @param {String} amount Amount of tokens to be locked
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>}
      */
-    increaseAmount<G extends boolean = false>(userAddress: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    increaseAmount<G extends boolean = false>(amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Extend the unlock time for `userAddress` to `unlockTime`
-     * @param {String} userAddress user address that sends the tx
      * @param {Number} unlockTime Timestamp for new unlock time
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>}
      */
-    increaseUnlockTime<G extends boolean = false>(userAddress: string, unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    increaseUnlockTime<G extends boolean = false>(unlockTime: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /**
      * Withdraw all tokens for `userAddress`
-     * @param {String} userAddress user address that sends the tx
+     * @param {Boolean} estimateGas if True, return gas estimate
      * @return {Promise<ReceiptOrEstimate>}
      */
-    withdraw<G extends boolean = false>(userAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    withdraw<G extends boolean = false>(estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
     /** Get voting power for address
      * @param {String} userAddress user address
      * @return {Promise<number>}

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

@@ -16,18 +16,17 @@ export declare class Aquarius {
      */
     constructor(aquariusURL: string);
     /** Resolves a DID
-     * @param {string} did
+     * @param {string} did DID of the asset.
      * @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.
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<Asset>} DDO of the asset.
      */
     waitForAqua(did: string, txid?: string, signal?: AbortSignal): Promise<Asset>;
     /**

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

@@ -1,19 +1,28 @@
-import Web3 from 'web3';
+import { Signer } from 'ethers';
 import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, Smartcontract, GraphqlQuery } from '../@types';
 export declare class Provider {
     /**
      * Returns the provider endpoints
-     * @return {Promise<ServiceEndpoint[]>}
+     * @param {string} providerUri - the provider url
+     * @return {Promise<any>}
      */
     getEndpoints(providerUri: string): Promise<any>;
+    /**
+     * This function returns the endpoint URL for a given service name.
+     * @param {ServiceEndpoint[]} servicesEndpoints - The array of service endpoints
+     * @param {string} serviceName - The name of the service
+     * @returns {ServiceEndpoint} The endpoint URL for the given service name
+     */
     getEndpointURL(servicesEndpoints: ServiceEndpoint[], serviceName: string): ServiceEndpoint;
     /**
-     * Returns the service endpoints that exist in provider.
-     * @param {any} endpoints
-     * @return {Promise<ServiceEndpoint[]>}
+     * This function returns an array of service endpoints for a given provider endpoint.
+     * @param {string} providerEndpoint - The provider endpoint
+     * @param {any} endpoints - The endpoints object
+     * @returns {ServiceEndpoint[]} An array of service endpoints
      */
     getServiceEndpoints(providerEndpoint: string, endpoints: any): Promise<ServiceEndpoint[]>;
-    /** Gets current nonce
+    /**
+     * Get current nonce from the provider.
      * @param {string} providerUri provider uri address
      * @param {string} consumerAddress Publisher address
      * @param {AbortSignal} signal abort signal
@@ -22,91 +31,109 @@ export declare class Provider {
      * @return {Promise<string>} urlDetails
      */
     getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<string>;
-    signProviderRequest(web3: Web3, accountId: string, message: string, password?: string): Promise<string>;
-    /** Encrypt data using the Provider's own symmetric key
+    /**
+     * Sign a provider request with a signer.
+     * @param {Signer} signer - The signer to use.
+     * @param {string} message - The message to sign.
+     * @returns {Promise<string>} A promise that resolves with the signature.
+     */
+    signProviderRequest(signer: Signer, 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 {number} chainId network's id so provider can choose the corresponding web3 object
+     * @param {number} chainId network's id so provider can choose the corresponding Signer object
      * @param {string} providerUri provider uri address
      * @param {AbortSignal} signal abort signal
      * @return {Promise<string>} urlDetails
      */
     encrypt(data: any, chainId: number, providerUri: string, signal?: AbortSignal): Promise<string>;
-    /** Get DDO File details (if possible)
-     * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
-     * @param {string} 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 {boolean} withChecksum if true, will return checksum of files content
-     * @param {AbortSignal} signal abort signal
-     * @return {Promise<FileInfo[]>} urlDetails
+    /**
+     * Get file details for a given DID and service ID.
+     * @param {string} did - The DID to check.
+     * @param {string} serviceId - The service ID to check.
+     * @param {string} providerUri - The URI of the provider.
+     * @param {boolean} [withChecksum=false] - Whether or not to include a checksum.
+     * @param {AbortSignal} [signal] - An optional abort signal.
+     * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
     checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
-    /** Get URL details (if possible)
+    /**
+     * Get File details (if possible)
      * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
      * @param {string} providerUri uri of the provider that will be used to check the file
-     * @param {boolean} withChecksum if true, will return checksum of files content
-     * @param {AbortSignal} signal abort signal
-     * @return {Promise<FileInfo[]>} urlDetails
+     * @param {boolean} [withChecksum=false] - Whether or not to include a checksum.
+     * @param {AbortSignal} [signal] - An optional abort signal.
+     * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
     getFileInfo(file: UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
-    /** 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
+    /**
+     * Returns compute environments from a provider.
+     * @param {string} providerUri - The URI of the provider.
+     * @param {AbortSignal} [signal] - An optional abort signal.
+     * @returns {Promise<{[chainId: number]: ComputeEnvironment[]}>} A promise that resolves with an object containing compute environments for each chain ID.
+     */
+    getComputeEnvironments(providerUri: string, signal?: AbortSignal): Promise<{
+        [chainId: number]: ComputeEnvironment[];
+    }>;
+    /**
+     * Initializes the provider for a service request.
+     * @param {string} did - The asset DID .
+     * @param {string} serviceId - The asset service ID.
+     * @param {number} fileIndex - The file index.
+     * @param {string} consumerAddress - The consumer address.
+     * @param {string} providerUri - The URI of the provider.
+     * @param {AbortSignal} [signal] - The abort signal if any.
+     * @param {UserCustomParameters} [userCustomParameters] - The custom parameters if any.
+     * @param {string} [computeEnv] - The compute environment if any.
+     * @param {number} [validUntil] - The validity time if any.
+     * @returns {Promise<ProviderInitialize>} A promise that resolves with ProviderInitialize response.
      */
     initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
-    /** Initialize a compute request.
-     * @param {ComputeAsset} assets
-     * @param {ComputeAlgorithmber} algorithm
-     * @param {string} computeEnv
-     * @param {number} validUntil
-     * @param {string} providerUri Identifier of the asset to be registered in ocean
-     * @param {string} accountId
+    /** Initializes the provider for a compute request.
+     * @param {ComputeAsset[]} assets The datasets array to initialize compute request.
+     * @param {ComputeAlgorithmber} algorithm The algorithm to use.
+     * @param {string} computeEnv The compute environment.
+     * @param {number} validUntil  The job expiration date.
+     * @param {string} providerUri The provider URI.
+     * @param {string} accountId caller address
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
     initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, validUntil: number, providerUri: string, accountId: string, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
-    /** 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>;
+    /**
+     * Gets the download URL.
+     * @param {string} did - The DID.
+     * @param {string} serviceId - The service ID.
+     * @param {number} fileIndex - The file index.
+     * @param {string} transferTxId - The transfer transaction ID.
+     * @param {string} providerUri - The provider URI.
+     * @param {Signer} signer - The signer.
+     * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
+     * @returns {Promise<any>} The download URL.
+     */
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signer: Signer, 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 {string} providerUri The provider URI.
+     * @param {Signer} signer The consumer signer object.
+     * @param {string} computeEnv The compute environment.
+     * @param {ComputeAsset} dataset The dataset to start compute on
+     * @param {ComputeAlgorithm} algorithm The algorithm to start compute with.
      * @param {AbortSignal} signal abort signal
-     * @param {ComputeOutput} output
-     * @return {Promise<ComputeJob | ComputeJob[]>}
+     * @param {ComputeAsset[]} additionalDatasets The additional datasets if that is the case.
+     * @param {ComputeOutput} output The compute job output settings.
+     * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    computeStart(providerUri: string, web3: Web3, consumerAddress: string, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput): Promise<ComputeJob | ComputeJob[]>;
+    computeStart(providerUri: string, consumer: Signer, 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 {string} did the asset did
+     * @param {string} consumerAddress The consumer address.
+     * @param {string} jobId the compute job id
+     * @param {string} providerUri The provider URI.
+     * @param {Signer} signer The consumer signer object.
      * @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[]>;
+    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, signer: Signer, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute status for a specific jobId/documentId/owner.
      * @param {string} providerUri The URI of the provider we want to query
      * @param {string} consumerAddress The consumer ethereum address
@@ -118,32 +145,53 @@ export declare class Provider {
     computeStatus(providerUri: string, consumerAddress: string, jobId?: string, did?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute result url
      * @param {string} providerUri The URI of the provider we want to query
-     * @param {Web3} web3 Web3 instance
-     * @param {string} consumerAddress The consumer ethereum address
+     * @param {Signer} consumer consumer Signer wallet object
      * @param {string} jobId The ID of a compute job.
      * @param {number} index Result index
      * @return {Promise<string>}
      */
-    getComputeResultUrl(providerUri: string, web3: Web3, consumerAddress: string, jobId: string, index: number): Promise<string>;
+    getComputeResultUrl(providerUri: string, consumer: Signer, jobId: string, index: number): Promise<string>;
     /** Deletes a compute job.
-     * @param {string} did
-     * @param {string} consumerAddress
-     * @param {string} jobId
-     * @param {string} providerUri
-     * @param {Web3} web3
+     * @param {string} did asset did
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} jobId the compute job ID
+     * @param {string} providerUri The URI of the provider we want to query
      * @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[]>;
+    computeDelete(did: string, consumer: Signer, jobId: string, providerUri: string, 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
+     * @return {Promise<boolean>} valid or not
      */
     isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
+    /**
+     * Private method that removes the leading 0x from a string.
+     * @param {string} input - The input string.
+     * @returns The transformed string.
+     */
     private noZeroX;
+    /**
+     * Private method that removes the leading 0x from a string.
+     * @param {string} input - The input string.
+     * @param {boolean} zeroOutput - Whether to include 0x in the output if the input is valid and zeroOutput is true.
+     * @returns The transformed string.
+     */
     private zeroXTransformer;
+    /**
+     * Private method that matches an input string against a regular expression and returns the first capture group.
+     * @param {string} input - The input string to match.
+     * @param {RegExp} regexp - The regular expression to match against.
+     * @param {string} conversorName - The name of the method calling this function.
+     * @returns An object with two properties: `valid` (a boolean indicating whether the input matched the regular expression) and `output` (the first capture group of the match, or the original input if there was no match).
+     */
     private inputMatch;
+    /**
+     * Private method that fetches data from a URL using the GET method.
+     * @param {string} url - The URL to fetch data from.
+     * @returns A Promise that resolves to a Response object.
+     */
     private getData;
 }
 export declare const ProviderInstance: Provider;

package/dist/src/utils/ContractUtils.d.ts

@@ -1,26 +1,46 @@
-import Web3 from 'web3';
-import { Contract } from 'web3-eth-contract';
+import { Signer, providers, Contract, ContractFunction, BigNumber } from 'ethers';
 import { Config } from '../config';
-import { TransactionReceipt } from 'web3-core';
 export declare function setContractDefaults(contract: Contract, config: Config): Contract;
-export declare function getFairGasPrice(web3: Web3, gasFeeMultiplier: number): Promise<string>;
-export declare function unitsToAmount(web3: Web3, token: string, amount: string, tokenDecimals?: number): Promise<string>;
-export declare function amountToUnits(web3: Web3, token: string, amount: string, tokenDecimals?: number): Promise<string>;
 /**
- * Estimates the gas used when a function would be executed on chain
- * @param {string} from account that calls the function
- * @param {Function} functionToEstimateGas function that we need to estimate the gas
- * @param {...any[]} args arguments of the function
- * @return {Promise<number>} gas cost of the function
+ * Asynchronous function that returns a fair gas price based on the current gas price and a multiplier.
+ * @param {Signer} signer - The signer object to use for fetching the current gas price.
+ * @param {number} gasFeeMultiplier - The multiplier to apply to the current gas price. If not provided, the current gas price is returned as a string.
+ * @returns A Promise that resolves to a string representation of the fair gas price.
+ */
+export declare function getFairGasPrice(signer: Signer, gasFeeMultiplier: number): Promise<string>;
+/**
+ * Asynchronous function that returns the number of decimal places for a given token.
+ * @param {Signer} signer - The signer object to use for fetching the token decimals.
+ * @param {string} token - The address of the token contract.
+ * @returns A Promise that resolves to the number of decimal places for the token.
+ */
+export declare function getTokenDecimals(signer: Signer, token: string): Promise<any>;
+/**
+ * Converts an amount of units to tokens
+ * @param {Signer} signer -  The signer object to use.
+ * @param {string} token - The token to convert
+ * @param {string} amount - The amount of units to convert
+ * @param {number} [tokenDecimals] - The number of decimals in the token
+ * @returns {Promise<string>} - The converted amount in tokens
+ */
+export declare function unitsToAmount(signer: Signer, token: string, amount: string, tokenDecimals?: number): Promise<string>;
+/**
+ * Converts an amount of tokens to units
+ * @param {Signer} signer -  The signer object to use.
+ * @param {string} token - The token to convert
+ * @param {string} amount - The amount of tokens to convert
+ * @param {number} [tokenDecimals] - The number of decimals of the token
+ * @returns {Promise<string>} - The converted amount in units
  */
-export declare function calculateEstimatedGas(from: string, functionToEstimateGas: Function, ...args: any[]): Promise<number>;
+export declare function amountToUnits(signer: Signer, token: string, amount: string, tokenDecimals?: number): Promise<string>;
+export declare function getEventFromTx(txReceipt: any, eventName: any): any;
 /**
  * Send the transation on chain
- * @param {string} from account that calls the function
- * @param {any} estGas estimated gas for the transaction
- * @param {Web3} web3 web3 objcet
+ * @param {BigNumber} estGas estimated gas for the transaction
+ * @param {Signer} signer signer object
+ * @param {number} gasFeeMultiplier number represinting the multiplier we apply to gas fees
  * @param {Function} functionToSend function that we need to send
  * @param {...any[]} args arguments of the function
  * @return {Promise<any>} transaction receipt
  */
-export declare function sendTx(from: string, estGas: number, web3: Web3, gasFeeMultiplier: number, functionToSend: Function, ...args: any[]): Promise<TransactionReceipt>;
+export declare function sendTx(estGas: BigNumber, signer: Signer, gasFeeMultiplier: number, functionToSend: ContractFunction, ...args: any[]): Promise<providers.TransactionResponse>;

package/dist/src/utils/DatatokenName.d.ts

@@ -1,6 +1,9 @@
 /**
- * Generate new datatoken name & symbol from a word list
- * @return {<{ name: String; symbol: String }>} datatoken name & symbol. Produces e.g. "Endemic Jellyfish Token" & "ENDJEL-45"
+ * This function generates a datatoken name and symbol from a given word list.
+ * @param {Object} [wordList] - An object containing an array of nouns and adjectives.
+ * @param {string[]} [wordList.nouns] - An array of nouns.
+ * @param {string[]} [wordList.adjectives] - An array of adjectives.
+ * @returns {Object} Returns an object containing the generated name and symbol. Produces e.g. "Endemic Jellyfish Token" & "ENDJEL-45"
  */
 export declare function generateDtName(wordList?: {
     nouns: string[];

package/dist/src/utils/DdoHelpers.d.ts

@@ -1,2 +1,13 @@
+/**
+ * Generates a valid DID
+ * @param {string} nftAddress - The NFT address
+ * @param {number} chainId - The chain ID
+ * @returns {string} - The DID
+ */
 export declare function generateDid(nftAddress: string, chainId: number): string;
+/**
+ * Returns the SHA256 hash of the input data
+ * @param {any} data - The input data
+ * @returns {string} - The SHA256 hash of the input data
+ */
 export declare function getHash(data: any): string;

package/dist/src/utils/FetchHelper.d.ts

@@ -1,3 +1,14 @@
 import { DownloadResponse } from '../@types';
+/**
+ * Triggers  a file download from the specified URL when called from a browser context.
+ * @param {string} url - The URL of the file to download
+ * @returns {Promise<void>} - A Promise that resolves when the file has been downloaded
+ */
 export declare function downloadFileBrowser(url: string): Promise<void>;
+/**
+ * Triggers  a file download from the specified URL when called from a browser context.
+ * @param {string} url - The URL of the file to download
+ * @param {number} [index] - The file index
+ * @returns {Promise<void>} - A Promise that resolves when the file has been downloaded
+ */
 export declare function downloadFile(url: string, index?: number): Promise<DownloadResponse>;

package/dist/src/utils/General.d.ts

@@ -1,4 +1,5 @@
 /**
  * Simple blocking sleep function
+ * @param {number} ms - Number of miliseconds to wait
  */
 export declare function sleep(ms: number): Promise<unknown>;

package/dist/src/utils/ProviderErrors.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessage(error: Object): string;

package/dist/src/utils/SignatureUtils.d.ts

@@ -1,5 +1,11 @@
-import Web3 from 'web3';
-export declare function signHash(web3: Web3, message: string, address: string): Promise<{
+import { Signer } from 'ethers';
+/**
+ * Signs the hash of a message using the provided signer.
+ * @param {Signer} signer - The signer to use for signing the hash.
+ * @param {string} message - The message to sign.
+ * @returns {Promise<string>} - A Promise that resolves to the signature of the hash of the message.
+ */
+export declare function signHash(signer: Signer, message: string): Promise<{
     v: string;
     r: string;
     s: string;

package/dist/src/utils/TokenUtils.d.ts

@@ -1,70 +1,70 @@
-import Web3 from 'web3';
+import { Signer } from 'ethers';
 import { Config } from '../config';
-import { ReceiptOrEstimate } from '../@types';
+import { ReceiptOrEstimate, ReceiptOrDecimal } from '../@types';
 /**
  * Approve spender to spent amount tokens
- * @param {Web3} web3
- * @param {Config} config
- * @param {String} account
- * @param {String} tokenAddress
- * @param {String} spender
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} account - The address of the caller
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} spender - The address of the spender
  * @param {String} amount amount of ERC20 Datatokens (always expressed as wei)
  * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
- * @param {number} tokenDecimals optional number of decimals of the token
- * @param {boolean} estimateGas  if true, returns the estimate gas cost for calling the method
+ * @param {number} [tokenDecimals] optional number of decimals of the token
+ * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
  */
-export declare function approve<G extends boolean = false>(web3: Web3, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, tokenDecimals?: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+export declare function approve<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, tokenDecimals?: number, estimateGas?: G): Promise<ReceiptOrDecimal<G> | number>;
 /**
  * Approve spender to spent amount tokens
- * @param {Web3} web3
- * @param {Config} config
- * @param {String} account
- * @param {String} tokenAddress
- * @param {String} spender
- * @param {String} amount amount of ERC20 tokens (always expressed as wei)
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} account - The address of the caller
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} spender - The address of the spender
+ * @param {string} amount amount of ERC20 tokens (always expressed as wei)
  * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
- * @param {boolean} estimateGas  if true, returns the estimate gas cost for calling the method
+ * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
  */
-export declare function approveWei<G extends boolean = false>(web3: Web3, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+export declare function approveWei<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
 /**
  * Moves amount tokens from the caller’s account to recipient.
- * @param {String} account
- * @param {String} tokenAddress
- * @param {String} recipient
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} recipient - The address of the tokens receiver
  * @param {String} amount amount of ERC20 Datatokens (not as wei)
- * @param {String} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
+ * @param {String} estimateGas  if true returns the gas estimate
  */
-export declare function transfer<G extends boolean = false>(web3: Web3, config: Config, account: string, tokenAddress: string, recipient: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+export declare function transfer<G extends boolean = false>(signer: Signer, config: Config, tokenAddress: string, recipient: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
 /**
  * Get Allowance for any Datatoken
- * @param {Web3} web3
- * @param {String } tokenAdress
- * @param {String} account
- * @param {String} spender
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {string} spender - The address of the spender
  * @param {number} tokenDecimals optional number of decimals of the token
  */
-export declare function allowance(web3: Web3, tokenAddress: string, account: string, spender: string, tokenDecimals?: number): Promise<string>;
+export declare function allowance(signer: Signer, tokenAddress: string, account: string, spender: string, tokenDecimals?: number): Promise<string>;
 /**
  * Get balance for any Datatoken
- * @param {Web3} web3
- * @param {String} tokenAdress
- * @param {String} owner
- * @param {String} spender
- * @param {number} tokenDecimals optional number of decimals of the token
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {number} [tokenDecimals] optional number of decimals of the token
  */
-export declare function balance(web3: Web3, tokenAddress: string, account: string, tokenDecimals?: number): Promise<string>;
+export declare function balance(signer: Signer, tokenAddress: string, account: string, tokenDecimals?: number): Promise<string>;
 /**
- * Get Allowance for any erc20
- * @param {Web3} web3
- * @param {String} tokenAdress
- * @param {String} account
- * @param {String} spender
+ * Get Allowance in wei for any erc20
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {string} spender - The address of the spneder
  */
-export declare function allowanceWei(web3: Web3, tokenAddress: string, account: string, spender: string): Promise<string>;
+export declare function allowanceWei(signer: Signer, tokenAddress: string, account: string, spender: string): Promise<string>;
 /**
  * Get decimals for any Datatoken
- * @param {Web3} web3
- * @param {String} tokenAdress
+ * @param {Signer} signer - The signer object
+ * @param {String} tokenAddress - The address of the token
  * @return {Promise<number>} Number of decimals of the token
  */
-export declare function decimals(web3: Web3, tokenAddress: string): Promise<number>;
+export declare function decimals(signer: Signer, tokenAddress: string): Promise<number>;

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

@@ -8,3 +8,4 @@ export * from './Logger';
 export * from './minAbi';
 export * from './SignatureUtils';
 export * from './TokenUtils';
+export * from './ProviderErrors';