@oceanprotocol/lib 3.0.0-next.1 → 3.0.0-next.2

package/docs/interfaces/ComputeAlgorithm.md

@@ -0,0 +1,82 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeAlgorithm
+
+# Interface: ComputeAlgorithm
+
+## Table of contents
+
+### Properties
+
+- [algocustomdata](ComputeAlgorithm.md#algocustomdata)
+- [documentId](ComputeAlgorithm.md#documentid)
+- [meta](ComputeAlgorithm.md#meta)
+- [serviceId](ComputeAlgorithm.md#serviceid)
+- [transferTxId](ComputeAlgorithm.md#transfertxid)
+- [userdata](ComputeAlgorithm.md#userdata)
+
+## Properties
+
+### algocustomdata
+
+• `Optional` **algocustomdata**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Defined in
+
+[@types/Compute.ts:74](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L74)
+
+___
+
+### documentId
+
+• `Optional` **documentId**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:70](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L70)
+
+___
+
+### meta
+
+• `Optional` **meta**: [`MetadataAlgorithm`](MetadataAlgorithm.md)
+
+#### Defined in
+
+[@types/Compute.ts:72](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L72)
+
+___
+
+### serviceId
+
+• `Optional` **serviceId**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:71](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L71)
+
+___
+
+### transferTxId
+
+• `Optional` **transferTxId**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:73](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L73)
+
+___
+
+### userdata
+
+• `Optional` **userdata**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Defined in
+
+[@types/Compute.ts:75](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L75)

package/docs/interfaces/ComputeAsset.md

@@ -0,0 +1,56 @@
+[@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/ComputeEnvironment.md

@@ -0,0 +1,173 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ComputeEnvironment
+
+# Interface: ComputeEnvironment
+
+## Table of contents
+
+### Properties
+
+- [consumerAddress](ComputeEnvironment.md#consumeraddress)
+- [cpuNumber](ComputeEnvironment.md#cpunumber)
+- [cpuType](ComputeEnvironment.md#cputype)
+- [currentJobs](ComputeEnvironment.md#currentjobs)
+- [desc](ComputeEnvironment.md#desc)
+- [diskGB](ComputeEnvironment.md#diskgb)
+- [gpuNumber](ComputeEnvironment.md#gpunumber)
+- [gpuType](ComputeEnvironment.md#gputype)
+- [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)
+
+## Properties
+
+### consumerAddress
+
+• **consumerAddress**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L21)
+
+___
+
+### cpuNumber
+
+• **cpuNumber**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L11)
+
+___
+
+### cpuType
+
+• **cpuType**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L12)
+
+___
+
+### currentJobs
+
+• **currentJobs**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L19)
+
+___
+
+### desc
+
+• **desc**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L18)
+
+___
+
+### diskGB
+
+• **diskGB**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L16)
+
+___
+
+### gpuNumber
+
+• **gpuNumber**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L13)
+
+___
+
+### gpuType
+
+• **gpuType**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L14)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[@types/Compute.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L10)
+
+___
+
+### lastSeen
+
+• **lastSeen**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L24)
+
+___
+
+### maxJobDuration
+
+• **maxJobDuration**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:23](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L23)
+
+___
+
+### maxJobs
+
+• **maxJobs**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L20)
+
+___
+
+### priceMin
+
+• **priceMin**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L17)
+
+___
+
+### ramGB
+
+• **ramGB**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L15)
+
+___
+
+### storageExpiry
+
+• **storageExpiry**: `number`
+
+#### Defined in
+
+[@types/Compute.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L22)

package/docs/interfaces/ComputeJob.md

@@ -0,0 +1,140 @@
+[@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)
+
+## 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:41](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Compute.ts#L41)

package/docs/interfaces/ComputeOutput.md

@@ -0,0 +1,118 @@
+[@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/ComputeResult.md

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

package/docs/interfaces/ConsumeMarketFee.md

@@ -0,0 +1,41 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ConsumeMarketFee
+
+# Interface: ConsumeMarketFee
+
+## Table of contents
+
+### Properties
+
+- [consumeMarketFeeAddress](ConsumeMarketFee.md#consumemarketfeeaddress)
+- [consumeMarketFeeAmount](ConsumeMarketFee.md#consumemarketfeeamount)
+- [consumeMarketFeeToken](ConsumeMarketFee.md#consumemarketfeetoken)
+
+## Properties
+
+### consumeMarketFeeAddress
+
+• **consumeMarketFeeAddress**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L16)
+
+___
+
+### consumeMarketFeeAmount
+
+• **consumeMarketFeeAmount**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L18)
+
+___
+
+### consumeMarketFeeToken
+
+• **consumeMarketFeeToken**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L17)

package/docs/interfaces/Credential.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Credential
+
+# Interface: Credential
+
+## Table of contents
+
+### Properties
+
+- [type](Credential.md#type)
+- [values](Credential.md#values)
+
+## Properties
+
+### type
+
+• **type**: `string`
+
+#### Defined in
+
+[@types/DDO/Credentials.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L2)
+
+___
+
+### values
+
+• **values**: `string`[]
+
+#### Defined in
+
+[@types/DDO/Credentials.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L3)