@oceanprotocol/lib 4.0.0-next.0 → 4.0.0

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

@@ -1,4 +1,4 @@
-import { DownloadResponse } from '../@types';
+import { DownloadResponse } from '../@types/index.js';
 /**
  * Triggers  a file download from the specified URL when called from a browser context.
  * @param {string} url - The URL of the file to download

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

@@ -3,3 +3,4 @@
  * @param {number} ms - Number of miliseconds to wait
  */
 export declare function sleep(ms: number): Promise<unknown>;
+export declare function isDefined(something: any): boolean;

package/dist/types/utils/OrderUtils.d.ts

@@ -1,5 +1,9 @@
 import { Signer } from 'ethers';
-import { Datatoken, Config, Asset, ConsumeMarketFee, ProviderFees } from '../index';
+import { Asset } from '../@types/Asset.js';
+import { Config } from '../config/Config.js';
+import { Datatoken } from '../contracts/Datatoken.js';
+import { ConsumeMarketFee } from '../@types/Datatoken.js';
+import { ProviderFees } from '../@types/Provider.js';
 /**
  * Orders an asset based on the specified pricing schema and configuration.
  * @param {Asset} asset - The asset to be ordered.

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

@@ -10,3 +10,4 @@ export declare function signHash(signer: Signer, message: string): Promise<{
     r: string;
     s: string;
 }>;
+export declare function signRequest(signer: Signer, message: string): Promise<string>;

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

@@ -1,6 +1,6 @@
 import { Signer } from 'ethers';
-import { Config } from '../config';
-import { ReceiptOrEstimate, ReceiptOrDecimal } from '../@types';
+import { Config } from '../config/index.js';
+import { ReceiptOrEstimate, ReceiptOrDecimal } from '../@types/index.js';
 /**
  * Approve spender to spent amount tokens
  * @param {Signer} signer - The signer object

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

@@ -1,13 +1,13 @@
-export * from './Constants';
-export * from './ContractUtils';
-export * from './DatatokenName';
-export * from './DdoHelpers';
-export * from './FetchHelper';
-export * from './General';
-export * from './Logger';
-export * from './minAbi';
-export * from './SignatureUtils';
-export * from './TokenUtils';
-export * from './ProviderErrors';
-export * from './OrderUtils';
-export * from './Assets';
+export * from './Constants.js';
+export * from './ContractUtils.js';
+export * from './DatatokenName.js';
+export * from './DdoHelpers.js';
+export * from './FetchHelper.js';
+export * from './General.js';
+export * from './Logger.js';
+export * from './minAbi.js';
+export * from './SignatureUtils.js';
+export * from './TokenUtils.js';
+export * from './ProviderErrors.js';
+export * from './OrderUtils.js';
+export * from './Assets.js';

package/docs/classes/Aquarius.md

@@ -18,7 +18,7 @@
 - [querySearch](Aquarius.md#querysearch)
 - [resolve](Aquarius.md#resolve)
 - [validate](Aquarius.md#validate)
-- [waitForAqua](Aquarius.md#waitforaqua)
+- [waitForIndexer](Aquarius.md#waitForIndexer)
 
 ## Constructors
 
@@ -123,7 +123,7 @@ ___
 
 ### validate
 
-▸ **validate**(`ddo`, `signal?`): `Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
+▸ **validate**(`ddo`, `signal?`,`signer?`,`providerUrl?`): `Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
 
 Validate DDO content
 
@@ -132,6 +132,8 @@ Validate DDO content
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `ddo` | [`DDO`](../interfaces/DDO.md) | DID Descriptor Object content. |
+| `signer?` | `Signer` | publisher account (for signature). |
+| `providerUrl?` | `string` | Provider url (to get nonce) |
 | `signal?` | `AbortSignal` | abort signal |
 
 #### Returns
@@ -146,11 +148,11 @@ Validate DDO content
 
 ___
 
-### waitForAqua
+### waitForIndexer
 
-▸ **waitForAqua**(`did`, `txid?`, `signal?`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
+▸ **waitForIndexer**(`did`, `txid?`, `signal?`, `interval=3000`,`maxRetries=100`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
 
-Blocks until Aqua will cache the did (or the update for that did) or timeouts
+Blocks until Indexer will cache the did (or the update for that did) or timeouts
 
 #### Parameters
 
@@ -159,6 +161,8 @@ Blocks until Aqua will cache the did (or the update for that did) or timeouts
 | `did` | `string` | DID of the asset. |
 | `txid?` | `string` | used when the did exists and we expect an update with that txid. |
 | `signal?` | `AbortSignal` | abort signal |
+| `interval` | `number` | retry interval in miliseconds. Default is 3000 |
+| `maxRetries` | `number` | max number of retries. Default is 100 |
 
 #### Returns
 

package/docs/classes/NftFactory.md

@@ -817,7 +817,7 @@ Used as a proxy to order multiple services
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `orders` | [`TokenOrder`](../interfaces/TokenOrder.md)[] | array of of orders |
+| `orders` | [`TokenOrder`](../interfaces/TokenOrder.md)[] | array of orders |
 | `estimateGas?` | `G` | if True, return gas estimate |
 
 #### Returns

package/docs/classes/Provider.md

@@ -97,7 +97,7 @@ ___
 
 ### computeStart
 
-▸ **computeStart**(`providerUri`, `consumer`, `computeEnv`, `dataset`, `algorithm`, `signal?`, `additionalDatasets?`, `output?`): `Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
+▸ **computeStart**(`providerUri`, `signer`, `computeEnv`, `datasets`, `algorithm`, `resources`, `chainId`, `output?`, `freeEnvironment`, `signal?`): `Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
 
 Instruct the provider to start a compute job
 
@@ -106,13 +106,15 @@ Instruct the provider to start a compute job
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `providerUri` | `string` | The provider URI. |
-| `consumer` | `Signer` | - |
+| `signer` | `Signer` | - | The consumer signer/account
 | `computeEnv` | `string` | The compute environment. |
-| `dataset` | [`ComputeAsset`](../interfaces/ComputeAsset.md) | The dataset to start compute on |
+| `datasets` | [`ComputeAsset`](../interfaces/ComputeAsset.md) | The dataset to start compute on |
 | `algorithm` | [`ComputeAlgorithm`](../interfaces/ComputeAlgorithm.md) | The algorithm to start compute with. |
-| `signal?` | `AbortSignal` | abort signal |
-| `additionalDatasets?` | [`ComputeAsset`](../interfaces/ComputeAsset.md)[] | The additional datasets if that is the case. |
+| `resources` | [`ComputeResourceRequest`](../interfaces/ComputeResourcesRequest.md) | The resources to start compute with. |
+| `chainId?` | [`number`] | The network for the payments |
 | `output?` | [`ComputeOutput`](../interfaces/ComputeOutput.md) | The compute job output settings. |
+| `signal?` | `AbortSignal` | abort signal |
+
 
 #### Returns
 
@@ -283,7 +285,7 @@ ___
 
 ### getDownloadUrl
 
-▸ **getDownloadUrl**(`did`, `serviceId`, `fileIndex`, `transferTxId`, `providerUri`, `signer`, `userCustomParameters?`): `Promise`<`any`\>
+▸ **getDownloadUrl**(`did`, `serviceId`, `fileIndex`, `transferTxId`, `providerUri`, `signer`, `policyServer?` `userCustomParameters?`): `Promise`<`any`\>
 
 Gets the download URL.
 
@@ -297,6 +299,7 @@ Gets the download URL.
 | `transferTxId` | `string` | The transfer transaction ID. |
 | `providerUri` | `string` | The provider URI. |
 | `signer` | `Signer` | The signer. |
+| `policyServer` | `any` | The policy server (if any to be used). |
 | `userCustomParameters?` | [`UserCustomParameters`](../interfaces/UserCustomParameters.md) | The user custom parameters. |
 
 #### Returns
@@ -485,7 +488,7 @@ Initializes the provider for a compute request.
 | `computeEnv` | `string` | The compute environment. |
 | `validUntil` | `number` | The job expiration date. |
 | `providerUri` | `string` | The provider URI. |
-| `accountId` | `string` | caller address |
+| `signer` | `Signer` | caller account |
 | `signal?` | `AbortSignal` | abort signal |
 
 #### Returns
@@ -500,6 +503,36 @@ ProviderComputeInitialize data
 
 ___
 
+
+### computeStreamableLogs
+
+▸ **computeStreamableLogs**(`providerUri`, `signer`, `jobId`, `signal?`): `Promise`<`any`\>
+
+Gets the streamable compute logs.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `providerUri` | `string` | The provider URI. |
+| `signer` | `Signer` | The signer. |
+| `jobId` | `string` | The Job Id. |
+| `signal?` | `AbortSignal` | The abort signal. |
+
+
+#### Returns
+
+`Promise`<`any`\>
+
+The compute logs.
+
+#### Defined in
+
+[services/Provider.ts:908](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Provider.ts#L908)
+
+___
+
+
 ### inputMatch
 
 ▸ `Private` **inputMatch**(`input`, `regexp`, `conversorName`): `Object`

package/docs/interfaces/ComputeEnvFees.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeEnvFees
+
+# Interface: ComputeEnvFees
+
+## Table of contents
+
+### Properties
+
+- [feeToken](ComputeEnvFees.md#feeToken)
+- [prices](ComputeEnvFees.md#prices)
+
+## Properties
+
+### feeToken
+
+• **feeToken**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L42)
+
+___
+
+### prices
+
+• **prices**: `ComputeResourcesPricingInfo`[]
+
+#### Defined in
+
+[@types/Compute.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L43)

package/docs/interfaces/ComputeEnvFeesStructure.md

@@ -0,0 +1,20 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeEnvFeesStructure
+
+# Interface: ComputeEnvFeesStructure
+
+## Table of contents
+
+### Properties
+
+- [feeToken](ComputeEnvFeesStructure.md#chainId)
+
+## Properties
+
+### chainId
+
+• **chainId**: `ComputeEnvFees`
+
+#### Defined in
+
+[@types/Compute.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L46)
+

package/docs/interfaces/ComputeEnvironment.md

@@ -7,20 +7,21 @@
 ### Properties
 
 - [consumerAddress](ComputeEnvironment.md#consumeraddress)
-- [cpuNumber](ComputeEnvironment.md#cpunumber)
-- [cpuType](ComputeEnvironment.md#cputype)
+- [totalCpu](ComputeEnvironment.md#totalCpu)
+- [maxCpu](ComputeEnvironment.md#maxCpu)
+- [totalRam](ComputeEnvironment.md#totalRam)
+- [maxRam](ComputeEnvironment.md#maxRam)
+- [maxDisk](ComputeEnvironment.md#maxDisk)
 - [currentJobs](ComputeEnvironment.md#currentjobs)
-- [desc](ComputeEnvironment.md#desc)
-- [diskGB](ComputeEnvironment.md#diskgb)
-- [gpuNumber](ComputeEnvironment.md#gpunumber)
-- [gpuType](ComputeEnvironment.md#gputype)
+- [description](ComputeEnvironment.md#description)
+- [fees](ComputeEnvironment.md#ComputeEnvFeesStructure)
 - [id](ComputeEnvironment.md#id)
 - [lastSeen](ComputeEnvironment.md#lastseen)
 - [maxJobDuration](ComputeEnvironment.md#maxjobduration)
 - [maxJobs](ComputeEnvironment.md#maxjobs)
-- [priceMin](ComputeEnvironment.md#pricemin)
-- [ramGB](ComputeEnvironment.md#ramgb)
 - [storageExpiry](ComputeEnvironment.md#storageexpiry)
+- [lastSeen](ComputeEnvironment.md#lastSeen)
+- [free](ComputeEnvironment.md#free)
 
 ## Properties
 
@@ -30,27 +31,27 @@
 
 #### Defined in
 
-[@types/Compute.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L21)
+[@types/Compute.ts:68](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L68)
 
 ___
 
-### cpuNumber
+### totalCpu
 
-• **cpuNumber**: `number`
+• **totalCpu**: `number`
 
 #### Defined in
 
-[@types/Compute.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L11)
+[@types/Compute.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L58)
 
 ___
 
-### cpuType
+### maxCpu
 
-• **cpuType**: `string`
+• **maxCpu**: `number`
 
 #### Defined in
 
-[@types/Compute.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L12)
+[@types/Compute.ts:59](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L59)
 
 ___
 
@@ -60,47 +61,47 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L19)
+[@types/Compute.ts:66](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L66)
 
 ___
 
-### desc
+### description
 
-• **desc**: `string`
+• **description**: `string`
 
 #### Defined in
 
-[@types/Compute.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L18)
+[@types/Compute.ts:65](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L65)
 
 ___
 
-### diskGB
+### maxDisk
 
-• **diskGB**: `number`
+• **maxDisk**: `number`
 
 #### Defined in
 
-[@types/Compute.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L16)
+[@types/Compute.ts:62](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L62)
 
 ___
 
-### gpuNumber
+### maxRam
 
-• **gpuNumber**: `number`
+• **maxRam**: `number`
 
 #### Defined in
 
-[@types/Compute.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L13)
+[@types/Compute.ts:61](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L61)
 
 ___
 
-### gpuType
+### totalRam
 
-• **gpuType**: `string`
+• **totalRam**: `number`
 
 #### Defined in
 
-[@types/Compute.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L14)
+[@types/Compute.ts:60](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L60)
 
 ___
 
@@ -110,7 +111,7 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L10)
+[@types/Compute.ts:49](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L49)
 
 ___
 
@@ -120,7 +121,7 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L24)
+[@types/Compute.ts:71](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L71)
 
 ___
 
@@ -130,7 +131,7 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:23](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L23)
+[@types/Compute.ts:70](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L70)
 
 ___
 
@@ -140,27 +141,27 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L20)
+[@types/Compute.ts:67](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L67)
 
 ___
 
-### priceMin
+### fees
 
-• **priceMin**: `number`
+• **fees**: `ComputeEnvFeesStructure`
 
 #### Defined in
 
-[@types/Compute.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L17)
+[@types/Compute.ts:63](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L63)
 
 ___
 
-### ramGB
+### free
 
-• **ramGB**: `number`
+• **free**: `boolean`
 
 #### Defined in
 
-[@types/Compute.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L15)
+[@types/Compute.ts:72](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L72)
 
 ___
 
@@ -170,4 +171,14 @@ ___
 
 #### Defined in
 
-[@types/Compute.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L22)
+[@types/Compute.ts:69](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L69)
+
+___
+
+### platform
+
+• **platform**: `RunningPlatform[]`
+
+#### Defined in
+
+[@types/Compute.ts:73](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L73)

package/docs/interfaces/ComputeResourcesPricingInfo.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeResourcesPricingInfo
+
+# Interface: ComputeResourcesPricingInfo
+
+## Table of contents
+
+### Properties
+
+- [type](ComputeResourcesPricingInfo.md#type)
+- [price](ComputeResourcesPricingInfo.md#price)
+
+## Properties
+
+### type
+
+• **type**: `ComputeResourceType`
+
+#### Defined in
+
+[@types/Compute.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L38)
+
+___
+
+### price
+
+• **price**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:39](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L39)

package/docs/interfaces/ComputeResourcesRequest.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeResourcesRequest
+
+# Interface: ComputeResourcesRequest
+
+## Table of contents
+
+### Properties
+
+- [id](ComputeResourcesRequest.md#id)
+- [amount](ComputeResourcesRequest.md#amount)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:63](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L63)
+
+___
+
+### amount
+
+• **amount**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:64](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L64)

package/docs/interfaces/Metadata.md

@@ -186,7 +186,7 @@ ___
 
 • **updated**: `string`
 
-Contains the the date of last update in ISO Date Time
+Contains the date of last update in ISO Date Time
 
 #### Defined in
 

package/docs/interfaces/RunningPlatform.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / RunningPlatform
+
+# Interface: RunningPlatform
+
+## Table of contents
+
+### Properties
+
+- [architecture](RunningPlatform.md#architecture)
+- [os](RunningPlatform.md#os)
+
+## Properties
+
+### architecture
+
+• **architecture**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L31)
+
+___
+
+### os
+
+• **os**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L32)