@oceanprotocol/lib 3.0.4 → 3.1.0

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

@@ -1,197 +1,197 @@
-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
-     * @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;
-    /**
-     * 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[]>;
-    /**
-     * Get current nonce from the provider.
-     * @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>;
-    /**
-     * 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 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 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 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=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[]>;
-    /**
-     * 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>;
-    /** 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 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} 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 {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, 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 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, 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
-     * @param {string} jobId The ID of a compute job.
-     * @param {string} did The ID of the asset
-     * @param {AbortSignal} signal abort signal
-     * @return {Promise<ComputeJob | ComputeJob[]>}
-     */
-    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 {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, consumer: Signer, jobId: string, index: number): Promise<string>;
-    /** Deletes a compute job.
-     * @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, 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>} 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;
+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
+     * @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;
+    /**
+     * 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[]>;
+    /**
+     * Get current nonce from the provider.
+     * @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>;
+    /**
+     * 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 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 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 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=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[]>;
+    /**
+     * 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>;
+    /** 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 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} 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 {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, 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 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, 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
+     * @param {string} jobId The ID of a compute job.
+     * @param {string} did The ID of the asset
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    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 {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, consumer: Signer, jobId: string, index: number): Promise<string>;
+    /** Deletes a compute job.
+     * @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, 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>} 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/services/index.d.ts

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

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

@@ -1,4 +1,4 @@
-export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
-export declare const GASLIMIT_DEFAULT = 1000000;
-export declare const MAX_UINT_256 = "115792089237316195423570985008687907853269984665640564039457584007913129639934";
-export declare const FEE_HISTORY_NOT_SUPPORTED = "Returned error: Method eth_feeHistory not supported.";
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const GASLIMIT_DEFAULT = 1000000;
+export declare const MAX_UINT_256 = "115792089237316195423570985008687907853269984665640564039457584007913129639934";
+export declare const FEE_HISTORY_NOT_SUPPORTED = "Returned error: Method eth_feeHistory not supported.";

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

@@ -1,46 +1,46 @@
-import { Signer, providers, Contract, ContractFunction, BigNumber } from 'ethers';
-import { Config } from '../config';
-export declare function setContractDefaults(contract: Contract, config: Config): Contract;
-/**
- * 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 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 {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(estGas: BigNumber, signer: Signer, gasFeeMultiplier: number, functionToSend: ContractFunction, ...args: any[]): Promise<providers.TransactionResponse>;
+import { Signer, providers, Contract, ContractFunction, BigNumber } from 'ethers';
+import { Config } from '../config';
+export declare function setContractDefaults(contract: Contract, config: Config): Contract;
+/**
+ * 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 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 {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(estGas: BigNumber, signer: Signer, gasFeeMultiplier: number, functionToSend: ContractFunction, ...args: any[]): Promise<providers.TransactionResponse>;

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

@@ -1,14 +1,14 @@
-/**
- * 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[];
-    adjectives: string[];
-}): {
-    name: string;
-    symbol: string;
-};
+/**
+ * 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[];
+    adjectives: string[];
+}): {
+    name: string;
+    symbol: string;
+};

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

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