@oceanprotocol/lib 7.0.0-next.4 → 7.0.0-next.6

package/docs/interfaces/ComputeAsset.md

@@ -1,56 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeAsset
-
-# Interface: ComputeAsset
-
-## Table of contents
-
-### Properties
-
-- [documentId](ComputeAsset.md#documentid)
-- [serviceId](ComputeAsset.md#serviceid)
-- [transferTxId](ComputeAsset.md#transfertxid)
-- [userdata](ComputeAsset.md#userdata)
-
-## Properties
-
-### documentId
-
-• **documentId**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:63](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L63)
-
-___
-
-### serviceId
-
-• **serviceId**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:64](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L64)
-
-___
-
-### transferTxId
-
-• `Optional` **transferTxId**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:65](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L65)
-
-___
-
-### userdata
-
-• `Optional` **userdata**: `Object`
-
-#### Index signature
-
-▪ [key: `string`]: `any`
-
-#### Defined in
-
-[@types/Compute.ts:66](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L66)

package/docs/interfaces/ComputeEnvFees.md

@@ -1,30 +0,0 @@
-[@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

@@ -1,20 +0,0 @@
-[@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

@@ -1,177 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeEnvironment
-
-# Interface: ComputeEnvironment
-
-## Table of contents
-
-### Properties
-
-- [id](ComputeEnvironment.md#id)
-- [description](ComputeEnvironment.md#description)
-- [consumerAddress](ComputeEnvironment.md#consumeraddress)
-- [storageExpiry](ComputeEnvironment.md#storageexpiry)
-- [minJobDuration](ComputeEnvironment.md#minjobduration)
-- [maxJobDuration](ComputeEnvironment.md#maxjobduration)
-- [maxJobs](ComputeEnvironment.md#maxjobs)
-- [runningJobs](ComputeEnvironment.md#runningjobs)
-- [runningfreeJobs](ComputeEnvironment.md#runningfreejobs)
-- [fees](ComputeEnvironment.md#fees)
-- [resources](ComputeEnvironment.md#resources)
-- [free](ComputeEnvironment.md#free)
-- [platform](ComputeEnvironment.md#platform)
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-Unique identifier for the compute environment
-
-#### Defined in
-
-[@types/Compute.ts:88](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L88)
-
-___
-
-### description
-
-• **description**: `string`
-
-Description of the compute environment
-
-#### Defined in
-
-[@types/Compute.ts:89](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L89)
-
-___
-
-### consumerAddress
-
-• **consumerAddress**: `string`
-
-Consumer address for the compute environment
-
-#### Defined in
-
-[@types/Compute.ts:90](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L90)
-
-___
-
-### storageExpiry
-
-• `Optional` **storageExpiry**: `number`
-
-Amount of seconds for storage
-
-#### Defined in
-
-[@types/Compute.ts:91](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L91)
-
-___
-
-### minJobDuration
-
-• `Optional` **minJobDuration**: `number`
-
-Minimum billable seconds for a paid job
-
-#### Defined in
-
-[@types/Compute.ts:92](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L92)
-
-___
-
-### maxJobDuration
-
-• `Optional` **maxJobDuration**: `number`
-
-Maximum duration in seconds for a paid job
-
-#### Defined in
-
-[@types/Compute.ts:93](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L93)
-
-___
-
-### maxJobs
-
-• `Optional` **maxJobs**: `number`
-
-Maximum number of simultaneous paid jobs
-
-#### Defined in
-
-[@types/Compute.ts:94](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L94)
-
-___
-
-### runningJobs
-
-• **runningJobs**: `number`
-
-Amount of running jobs (paid jobs)
-
-#### Defined in
-
-[@types/Compute.ts:95](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L95)
-
-___
-
-### runningfreeJobs
-
-• `Optional` **runningfreeJobs**: `number`
-
-Amount of running jobs (free jobs)
-
-#### Defined in
-
-[@types/Compute.ts:96](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L96)
-
-___
-
-### fees
-
-• **fees**: `ComputeEnvFeesStructure`
-
-Fee structure for the compute environment
-
-#### Defined in
-
-[@types/Compute.ts:97](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L97)
-
-___
-
-### resources
-
-• `Optional` **resources**: `ComputeResource[]`
-
-Available compute resources (CPU, memory, storage)
-
-#### Defined in
-
-[@types/Compute.ts:98](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L98)
-
-___
-
-### free
-
-• `Optional` **free**: `ComputeEnvironmentFreeOptions`
-
-Free compute environment options
-
-#### Defined in
-
-[@types/Compute.ts:99](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L99)
-
-___
-
-### platform
-
-• `Optional` **platform**: `RunningPlatform`
-
-Platform information (architecture, OS)
-
-#### Defined in
-
-[@types/Compute.ts:100](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L100)

package/docs/interfaces/ComputeJob.md

@@ -1,173 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeJob
-
-# Interface: ComputeJob
-
-## Table of contents
-
-### Properties
-
-- [agreementId](ComputeJob.md#agreementid)
-- [algoDID](ComputeJob.md#algodid)
-- [dateCreated](ComputeJob.md#datecreated)
-- [dateFinished](ComputeJob.md#datefinished)
-- [did](ComputeJob.md#did)
-- [expireTimestamp](ComputeJob.md#expiretimestamp)
-- [inputDID](ComputeJob.md#inputdid)
-- [jobId](ComputeJob.md#jobid)
-- [owner](ComputeJob.md#owner)
-- [results](ComputeJob.md#results)
-- [status](ComputeJob.md#status)
-- [statusText](ComputeJob.md#statustext)
-- [metadata](ComputeJob.md#metadata)
-- [terminationDetails](ComputeJob.md#terminationdetails)
-
-## Properties
-
-### agreementId
-
-• `Optional` **agreementId**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:45](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L45)
-
-___
-
-### algoDID
-
-• `Optional` **algoDID**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L44)
-
-___
-
-### dateCreated
-
-• **dateCreated**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L38)
-
-___
-
-### dateFinished
-
-• **dateFinished**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:39](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L39)
-
-___
-
-### did
-
-• `Optional` **did**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:36](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L36)
-
-___
-
-### expireTimestamp
-
-• **expireTimestamp**: `number`
-
-#### Defined in
-
-[@types/Compute.ts:46](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L46)
-
-___
-
-### inputDID
-
-• `Optional` **inputDID**: `string`[]
-
-#### Defined in
-
-[@types/Compute.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L43)
-
-___
-
-### jobId
-
-• **jobId**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:37](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L37)
-
-___
-
-### owner
-
-• **owner**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:35](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L35)
-
-___
-
-### results
-
-• **results**: [`ComputeResult`](ComputeResult.md)[]
-
-#### Defined in
-
-[@types/Compute.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L42)
-
-___
-
-### status
-
-• **status**: `number`
-
-#### Defined in
-
-[@types/Compute.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L40)
-
-___
-
-### statusText
-
-• **statusText**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:121](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L121)
-
-___
-
-### metadata
-
-• `Optional` **metadata**: `ComputeJobMetadata`
-
-Custom metadata associated with the compute job
-
-#### Defined in
-
-[@types/Compute.ts:127](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L127)
-
-___
-
-### terminationDetails
-
-• `Optional` **terminationDetails**: `object`
-
-Details about job termination
-
-#### Type declaration
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `exitCode?` | `number` | Exit code of the terminated job |
-| `OOMKilled?` | `boolean` | Whether the job was killed due to out-of-memory |
-
-#### Defined in
-
-[@types/Compute.ts:128](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L128)

package/docs/interfaces/ComputeOutput.md

@@ -1,118 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeOutput
-
-# Interface: ComputeOutput
-
-## Table of contents
-
-### Properties
-
-- [metadata](ComputeOutput.md#metadata)
-- [metadataUri](ComputeOutput.md#metadatauri)
-- [nodeUri](ComputeOutput.md#nodeuri)
-- [owner](ComputeOutput.md#owner)
-- [providerAddress](ComputeOutput.md#provideraddress)
-- [providerUri](ComputeOutput.md#provideruri)
-- [publishAlgorithmLog](ComputeOutput.md#publishalgorithmlog)
-- [publishOutput](ComputeOutput.md#publishoutput)
-- [secretStoreUri](ComputeOutput.md#secretstoreuri)
-- [whitelist](ComputeOutput.md#whitelist)
-
-## Properties
-
-### metadata
-
-• `Optional` **metadata**: [`Metadata`](Metadata.md)
-
-#### Defined in
-
-[@types/Compute.ts:54](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L54)
-
-___
-
-### metadataUri
-
-• `Optional` **metadataUri**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:55](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L55)
-
-___
-
-### nodeUri
-
-• `Optional` **nodeUri**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:56](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L56)
-
-___
-
-### owner
-
-• `Optional` **owner**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:57](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L57)
-
-___
-
-### providerAddress
-
-• `Optional` **providerAddress**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:52](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L52)
-
-___
-
-### providerUri
-
-• `Optional` **providerUri**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:53](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L53)
-
-___
-
-### publishAlgorithmLog
-
-• `Optional` **publishAlgorithmLog**: `boolean`
-
-#### Defined in
-
-[@types/Compute.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L50)
-
-___
-
-### publishOutput
-
-• `Optional` **publishOutput**: `boolean`
-
-#### Defined in
-
-[@types/Compute.ts:51](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L51)
-
-___
-
-### secretStoreUri
-
-• `Optional` **secretStoreUri**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L58)
-
-___
-
-### whitelist
-
-• `Optional` **whitelist**: `string`[]
-
-#### Defined in
-
-[@types/Compute.ts:59](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L59)

package/docs/interfaces/ComputeResourcesPricingInfo.md

@@ -1,30 +0,0 @@
-[@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

@@ -1,34 +0,0 @@
-[@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`
-
-Resource identifier (e.g., 'cpu', 'ram', 'disk')
-
-#### Defined in
-
-[@types/Compute.ts:50](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L50)
-
-___
-
-### amount
-
-• **amount**: `number`
-
-Amount of the specified resource to request. DISK and RAM are in GB, CPU is in number of cores.
-
-#### Defined in
-
-[@types/Compute.ts:51](https://github.com/oceanprotocol/ocean.js/blob/main/src/@types/Compute.ts#L51)

package/docs/interfaces/ComputeResult.md

@@ -1,52 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeResult
-
-# Interface: ComputeResult
-
-## Table of contents
-
-### Properties
-
-- [filename](ComputeResult.md#filename)
-- [filesize](ComputeResult.md#filesize)
-- [index](ComputeResult.md#index)
-- [type](ComputeResult.md#type)
-
-## Properties
-
-### filename
-
-• **filename**: `string`
-
-#### Defined in
-
-[@types/Compute.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L28)
-
-___
-
-### filesize
-
-• **filesize**: `number`
-
-#### Defined in
-
-[@types/Compute.ts:29](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L29)
-
-___
-
-### index
-
-• `Optional` **index**: `number`
-
-#### Defined in
-
-[@types/Compute.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L31)
-
-___
-
-### type
-
-• **type**: [`ComputeResultType`](../modules.md#computeresulttype)
-
-#### Defined in
-
-[@types/Compute.ts:30](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L30)