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

package/docs/interfaces/OrderParams.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / OrderParams
+
+# Interface: OrderParams
+
+## Table of contents
+
+### Properties
+
+- [\_consumeMarketFee](OrderParams.md#_consumemarketfee)
+- [\_providerFee](OrderParams.md#_providerfee)
+- [consumer](OrderParams.md#consumer)
+- [serviceIndex](OrderParams.md#serviceindex)
+
+## Properties
+
+### \_consumeMarketFee
+
+• **\_consumeMarketFee**: [`ConsumeMarketFee`](ConsumeMarketFee.md)
+
+#### Defined in
+
+[@types/Datatoken.ts:36](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L36)
+
+___
+
+### \_providerFee
+
+• **\_providerFee**: [`ProviderFees`](ProviderFees.md)
+
+#### Defined in
+
+[@types/Datatoken.ts:35](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L35)
+
+___
+
+### consumer
+
+• **consumer**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:33](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L33)
+
+___
+
+### serviceIndex
+
+• **serviceIndex**: `number`
+
+#### Defined in
+
+[@types/Datatoken.ts:34](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L34)

package/docs/interfaces/PriceAndFees.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / PriceAndFees
+
+# Interface: PriceAndFees
+
+## Table of contents
+
+### Properties
+
+- [baseTokenAmount](PriceAndFees.md#basetokenamount)
+- [consumeMarketFeeAmount](PriceAndFees.md#consumemarketfeeamount)
+- [marketFeeAmount](PriceAndFees.md#marketfeeamount)
+- [oceanFeeAmount](PriceAndFees.md#oceanfeeamount)
+
+## Properties
+
+### baseTokenAmount
+
+• **baseTokenAmount**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L25)
+
+___
+
+### consumeMarketFeeAmount
+
+• **consumeMarketFeeAmount**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L28)
+
+___
+
+### marketFeeAmount
+
+• **marketFeeAmount**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:27](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L27)
+
+___
+
+### oceanFeeAmount
+
+• **oceanFeeAmount**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L26)

package/docs/interfaces/ProviderComputeInitialize.md

@@ -0,0 +1,41 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ProviderComputeInitialize
+
+# Interface: ProviderComputeInitialize
+
+## Table of contents
+
+### Properties
+
+- [datatoken](ProviderComputeInitialize.md#datatoken)
+- [providerFee](ProviderComputeInitialize.md#providerfee)
+- [validOrder](ProviderComputeInitialize.md#validorder)
+
+## Properties
+
+### datatoken
+
+• `Optional` **datatoken**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L20)
+
+___
+
+### providerFee
+
+• `Optional` **providerFee**: [`ProviderFees`](ProviderFees.md)
+
+#### Defined in
+
+[@types/Provider.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L22)
+
+___
+
+### validOrder
+
+• `Optional` **validOrder**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L21)

package/docs/interfaces/ProviderComputeInitializeResults.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ProviderComputeInitializeResults
+
+# Interface: ProviderComputeInitializeResults
+
+## Table of contents
+
+### Properties
+
+- [algorithm](ProviderComputeInitializeResults.md#algorithm)
+- [datasets](ProviderComputeInitializeResults.md#datasets)
+
+## Properties
+
+### algorithm
+
+• `Optional` **algorithm**: [`ProviderComputeInitialize`](ProviderComputeInitialize.md)
+
+#### Defined in
+
+[@types/Provider.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L26)
+
+___
+
+### datasets
+
+• `Optional` **datasets**: [`ProviderComputeInitialize`](ProviderComputeInitialize.md)[]
+
+#### Defined in
+
+[@types/Provider.ts:27](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L27)

package/docs/interfaces/ProviderFees.md

@@ -0,0 +1,96 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ProviderFees
+
+# Interface: ProviderFees
+
+## Table of contents
+
+### Properties
+
+- [providerData](ProviderFees.md#providerdata)
+- [providerFeeAddress](ProviderFees.md#providerfeeaddress)
+- [providerFeeAmount](ProviderFees.md#providerfeeamount)
+- [providerFeeToken](ProviderFees.md#providerfeetoken)
+- [r](ProviderFees.md#r)
+- [s](ProviderFees.md#s)
+- [v](ProviderFees.md#v)
+- [validUntil](ProviderFees.md#validuntil)
+
+## Properties
+
+### providerData
+
+• **providerData**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L8)
+
+___
+
+### providerFeeAddress
+
+• **providerFeeAddress**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L2)
+
+___
+
+### providerFeeAmount
+
+• **providerFeeAmount**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L4)
+
+___
+
+### providerFeeToken
+
+• **providerFeeToken**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L3)
+
+___
+
+### r
+
+• **r**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L6)
+
+___
+
+### s
+
+• **s**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L7)
+
+___
+
+### v
+
+• **v**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L5)
+
+___
+
+### validUntil
+
+• **validUntil**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L9)

package/docs/interfaces/ProviderInitialize.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ProviderInitialize
+
+# Interface: ProviderInitialize
+
+## Table of contents
+
+### Properties
+
+- [computeAddress](ProviderInitialize.md#computeaddress)
+- [datatoken](ProviderInitialize.md#datatoken)
+- [nonce](ProviderInitialize.md#nonce)
+- [providerFee](ProviderInitialize.md#providerfee)
+
+## Properties
+
+### computeAddress
+
+• **computeAddress**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L15)
+
+___
+
+### datatoken
+
+• **datatoken**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L13)
+
+___
+
+### nonce
+
+• **nonce**: `string`
+
+#### Defined in
+
+[@types/Provider.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L14)
+
+___
+
+### providerFee
+
+• **providerFee**: [`ProviderFees`](ProviderFees.md)
+
+#### Defined in
+
+[@types/Provider.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L16)

package/docs/interfaces/PublisherTrustedAlgorithm.md

@@ -0,0 +1,47 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / PublisherTrustedAlgorithm
+
+# Interface: PublisherTrustedAlgorithm
+
+## Table of contents
+
+### Properties
+
+- [containerSectionChecksum](PublisherTrustedAlgorithm.md#containersectionchecksum)
+- [did](PublisherTrustedAlgorithm.md#did)
+- [filesChecksum](PublisherTrustedAlgorithm.md#fileschecksum)
+
+## Properties
+
+### containerSectionChecksum
+
+• **containerSectionChecksum**: `string`
+
+Hash of algorithm’s metadata.algorithm.container section.
+
+#### Defined in
+
+[@types/DDO/Service.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L18)
+
+___
+
+### did
+
+• **did**: `string`
+
+The DID of the algorithm which is trusted by the publisher.
+
+#### Defined in
+
+[@types/DDO/Service.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L6)
+
+___
+
+### filesChecksum
+
+• **filesChecksum**: `string`
+
+Hash of algorithm’s files section.
+
+#### Defined in
+
+[@types/DDO/Service.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L12)

package/docs/interfaces/PublishingMarketFee.md

@@ -0,0 +1,41 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / PublishingMarketFee
+
+# Interface: PublishingMarketFee
+
+## Table of contents
+
+### Properties
+
+- [publishMarketFeeAddress](PublishingMarketFee.md#publishmarketfeeaddress)
+- [publishMarketFeeAmount](PublishingMarketFee.md#publishmarketfeeamount)
+- [publishMarketFeeToken](PublishingMarketFee.md#publishmarketfeetoken)
+
+## Properties
+
+### publishMarketFeeAddress
+
+• **publishMarketFeeAddress**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L22)
+
+___
+
+### publishMarketFeeAmount
+
+• **publishMarketFeeAmount**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L24)
+
+___
+
+### publishMarketFeeToken
+
+• **publishMarketFeeToken**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:23](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L23)

package/docs/interfaces/Purgatory.md

@@ -0,0 +1,34 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Purgatory
+
+# Interface: Purgatory
+
+## Table of contents
+
+### Properties
+
+- [reason](Purgatory.md#reason)
+- [state](Purgatory.md#state)
+
+## Properties
+
+### reason
+
+• **reason**: `string`
+
+If asset is in purgatory, contains the reason for being there as defined in `list-purgatory`.
+
+#### Defined in
+
+[@types/Asset.ts:64](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L64)
+
+___
+
+### state
+
+• **state**: `boolean`
+
+If `true`, asset is in purgatory.
+
+#### Defined in
+
+[@types/Asset.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L58)

package/docs/interfaces/SearchQuery.md

@@ -0,0 +1,67 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / SearchQuery
+
+# Interface: SearchQuery
+
+## Table of contents
+
+### Properties
+
+- [aggs](SearchQuery.md#aggs)
+- [from](SearchQuery.md#from)
+- [query](SearchQuery.md#query)
+- [size](SearchQuery.md#size)
+- [sort](SearchQuery.md#sort)
+
+## Properties
+
+### aggs
+
+• `Optional` **aggs**: `any`
+
+#### Defined in
+
+[services/Aquarius.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L11)
+
+___
+
+### from
+
+• `Optional` **from**: `number`
+
+#### Defined in
+
+[services/Aquarius.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L6)
+
+___
+
+### query
+
+• **query**: `any`
+
+#### Defined in
+
+[services/Aquarius.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L9)
+
+___
+
+### size
+
+• `Optional` **size**: `number`
+
+#### Defined in
+
+[services/Aquarius.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L7)
+
+___
+
+### sort
+
+• `Optional` **sort**: `Object`
+
+#### Index signature
+
+▪ [jsonPath: `string`]: `string`
+
+#### Defined in
+
+[services/Aquarius.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L10)

package/docs/interfaces/Service.md

@@ -0,0 +1,138 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Service
+
+# Interface: Service
+
+## Table of contents
+
+### Properties
+
+- [additionalInformation](Service.md#additionalinformation)
+- [compute](Service.md#compute)
+- [datatokenAddress](Service.md#datatokenaddress)
+- [description](Service.md#description)
+- [files](Service.md#files)
+- [id](Service.md#id)
+- [name](Service.md#name)
+- [serviceEndpoint](Service.md#serviceendpoint)
+- [timeout](Service.md#timeout)
+- [type](Service.md#type)
+
+## Properties
+
+### additionalInformation
+
+• `Optional` **additionalInformation**: `any`
+
+Stores service specific additional information, this is customizable by publisher
+
+#### Defined in
+
+[@types/DDO/Service.ts:109](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L109)
+
+___
+
+### compute
+
+• `Optional` **compute**: [`ServiceComputeOptions`](ServiceComputeOptions.md)
+
+If service is of type compute, holds information about the compute-related privacy settings & resources.
+
+#### Defined in
+
+[@types/DDO/Service.ts:103](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L103)
+
+___
+
+### datatokenAddress
+
+• **datatokenAddress**: `string`
+
+Datatoken address
+
+#### Defined in
+
+[@types/DDO/Service.ts:73](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L73)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+Service description
+
+#### Defined in
+
+[@types/DDO/Service.ts:97](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L97)
+
+___
+
+### files
+
+• **files**: `string`
+
+Encrypted file URLs.
+
+#### Defined in
+
+[@types/DDO/Service.ts:67](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L67)
+
+___
+
+### id
+
+• **id**: `string`
+
+Unique ID
+
+#### Defined in
+
+[@types/DDO/Service.ts:55](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L55)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+Service friendly name
+
+#### Defined in
+
+[@types/DDO/Service.ts:91](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L91)
+
+___
+
+### serviceEndpoint
+
+• **serviceEndpoint**: `string`
+
+Provider URL (schema + host).
+
+#### Defined in
+
+[@types/DDO/Service.ts:79](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L79)
+
+___
+
+### timeout
+
+• **timeout**: `number`
+
+Describing how long the service can be used after consumption is initiated.
+
+#### Defined in
+
+[@types/DDO/Service.ts:85](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L85)
+
+___
+
+### type
+
+• **type**: `string`
+
+Type of service (access, compute, wss.
+
+#### Defined in
+
+[@types/DDO/Service.ts:61](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L61)