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

package/docs/interfaces/Credentials.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Credentials
+
+# Interface: Credentials
+
+## Table of contents
+
+### Properties
+
+- [allow](Credentials.md#allow)
+- [deny](Credentials.md#deny)
+
+## Properties
+
+### allow
+
+• **allow**: [`Credential`](Credential.md)[]
+
+#### Defined in
+
+[@types/DDO/Credentials.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L7)
+
+___
+
+### deny
+
+• **deny**: [`Credential`](Credential.md)[]
+
+#### Defined in
+
+[@types/DDO/Credentials.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L8)

package/docs/interfaces/DDO.md

@@ -0,0 +1,137 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DDO
+
+# Interface: DDO
+
+DID Descriptor Object.
+Contains metadata about the asset, and define access in at least one service.
+
+## Hierarchy
+
+- **`DDO`**
+
+  ↳ [`Asset`](Asset.md)
+
+## Table of contents
+
+### Properties
+
+- [@context](DDO.md#@context)
+- [chainId](DDO.md#chainid)
+- [credentials](DDO.md#credentials)
+- [event](DDO.md#event)
+- [id](DDO.md#id)
+- [metadata](DDO.md#metadata)
+- [nftAddress](DDO.md#nftaddress)
+- [services](DDO.md#services)
+- [version](DDO.md#version)
+
+## Properties
+
+### @context
+
+• **@context**: `string`[]
+
+Contexts used for validation.
+
+#### Defined in
+
+[@types/DDO/DDO.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L12)
+
+___
+
+### chainId
+
+• **chainId**: `number`
+
+ChainId of the network the DDO was published to.
+
+#### Defined in
+
+[@types/DDO/DDO.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L38)
+
+___
+
+### credentials
+
+• `Optional` **credentials**: [`Credentials`](Credentials.md)
+
+Describes the credentials needed to access a dataset
+in addition to the services definition.
+
+#### Defined in
+
+[@types/DDO/DDO.ts:57](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L57)
+
+___
+
+### event
+
+• `Optional` **event**: [`Event`](Event.md)
+
+Describes the event of last metadata event
+
+#### Defined in
+
+[@types/DDO/DDO.ts:63](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L63)
+
+___
+
+### id
+
+• **id**: `string`
+
+DID, descentralized ID.
+Computed as sha256(address of NFT contract + chainId)
+
+#### Defined in
+
+[@types/DDO/DDO.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L19)
+
+___
+
+### metadata
+
+• **metadata**: [`Metadata`](Metadata.md)
+
+Stores an object describing the asset.
+
+#### Defined in
+
+[@types/DDO/DDO.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L44)
+
+___
+
+### nftAddress
+
+• **nftAddress**: `string`
+
+NFT contract address
+
+#### Defined in
+
+[@types/DDO/DDO.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L32)
+
+___
+
+### services
+
+• **services**: [`Service`](Service.md)[]
+
+Stores an array of services defining access to the asset.
+
+#### Defined in
+
+[@types/DDO/DDO.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L50)
+
+___
+
+### version
+
+• **version**: `string`
+
+Version information in SemVer notation
+referring to the DDO spec version
+
+#### Defined in
+
+[@types/DDO/DDO.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L26)

package/docs/interfaces/DatatokenCreateParams.md

@@ -0,0 +1,107 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DatatokenCreateParams
+
+# Interface: DatatokenCreateParams
+
+## Table of contents
+
+### Properties
+
+- [cap](DatatokenCreateParams.md#cap)
+- [feeAmount](DatatokenCreateParams.md#feeamount)
+- [feeToken](DatatokenCreateParams.md#feetoken)
+- [minter](DatatokenCreateParams.md#minter)
+- [mpFeeAddress](DatatokenCreateParams.md#mpfeeaddress)
+- [name](DatatokenCreateParams.md#name)
+- [paymentCollector](DatatokenCreateParams.md#paymentcollector)
+- [symbol](DatatokenCreateParams.md#symbol)
+- [templateIndex](DatatokenCreateParams.md#templateindex)
+
+## Properties
+
+### cap
+
+• **cap**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L10)
+
+___
+
+### feeAmount
+
+• **feeAmount**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L9)
+
+___
+
+### feeToken
+
+• **feeToken**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L8)
+
+___
+
+### minter
+
+• **minter**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L5)
+
+___
+
+### mpFeeAddress
+
+• **mpFeeAddress**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L7)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L11)
+
+___
+
+### paymentCollector
+
+• **paymentCollector**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L6)
+
+___
+
+### symbol
+
+• `Optional` **symbol**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L12)
+
+___
+
+### templateIndex
+
+• **templateIndex**: `number`
+
+#### Defined in
+
+[@types/Datatoken.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L4)

package/docs/interfaces/DatatokenRoles.md

@@ -0,0 +1,30 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DatatokenRoles
+
+# Interface: DatatokenRoles
+
+## Table of contents
+
+### Properties
+
+- [minter](DatatokenRoles.md#minter)
+- [paymentManager](DatatokenRoles.md#paymentmanager)
+
+## Properties
+
+### minter
+
+• **minter**: `boolean`
+
+#### Defined in
+
+[@types/Datatoken.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L28)
+
+___
+
+### paymentManager
+
+• **paymentManager**: `boolean`
+
+#### Defined in
+
+[@types/Datatoken.ts:29](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L29)

package/docs/interfaces/DispenserCreationParams.md

@@ -0,0 +1,63 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserCreationParams
+
+# Interface: DispenserCreationParams
+
+## Table of contents
+
+### Properties
+
+- [allowedSwapper](DispenserCreationParams.md#allowedswapper)
+- [dispenserAddress](DispenserCreationParams.md#dispenseraddress)
+- [maxBalance](DispenserCreationParams.md#maxbalance)
+- [maxTokens](DispenserCreationParams.md#maxtokens)
+- [withMint](DispenserCreationParams.md#withmint)
+
+## Properties
+
+### allowedSwapper
+
+• `Optional` **allowedSwapper**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L6)
+
+___
+
+### dispenserAddress
+
+• **dispenserAddress**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L2)
+
+___
+
+### maxBalance
+
+• **maxBalance**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L4)
+
+___
+
+### maxTokens
+
+• **maxTokens**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L3)
+
+___
+
+### withMint
+
+• `Optional` **withMint**: `boolean`
+
+#### Defined in
+
+[@types/Dispenser.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L5)

package/docs/interfaces/DispenserParams.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserParams
+
+# Interface: DispenserParams
+
+## Table of contents
+
+### Properties
+
+- [allowedSwapper](DispenserParams.md#allowedswapper)
+- [maxBalance](DispenserParams.md#maxbalance)
+- [maxTokens](DispenserParams.md#maxtokens)
+- [withMint](DispenserParams.md#withmint)
+
+## Properties
+
+### allowedSwapper
+
+• `Optional` **allowedSwapper**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L43)
+
+___
+
+### maxBalance
+
+• **maxBalance**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:41](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L41)
+
+___
+
+### maxTokens
+
+• **maxTokens**: `string`
+
+#### Defined in
+
+[@types/Datatoken.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L40)
+
+___
+
+### withMint
+
+• `Optional` **withMint**: `boolean`
+
+#### Defined in
+
+[@types/Datatoken.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L42)

package/docs/interfaces/DispenserToken.md

@@ -0,0 +1,85 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserToken
+
+# Interface: DispenserToken
+
+## Table of contents
+
+### Properties
+
+- [active](DispenserToken.md#active)
+- [allowedSwapper](DispenserToken.md#allowedswapper)
+- [balance](DispenserToken.md#balance)
+- [isMinter](DispenserToken.md#isminter)
+- [maxBalance](DispenserToken.md#maxbalance)
+- [maxTokens](DispenserToken.md#maxtokens)
+- [owner](DispenserToken.md#owner)
+
+## Properties
+
+### active
+
+• **active**: `boolean`
+
+#### Defined in
+
+[@types/Dispenser.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L10)
+
+___
+
+### allowedSwapper
+
+• **allowedSwapper**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L16)
+
+___
+
+### balance
+
+• **balance**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L14)
+
+___
+
+### isMinter
+
+• **isMinter**: `boolean`
+
+#### Defined in
+
+[@types/Dispenser.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L15)
+
+___
+
+### maxBalance
+
+• **maxBalance**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L13)
+
+___
+
+### maxTokens
+
+• **maxTokens**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L12)
+
+___
+
+### owner
+
+• **owner**: `string`
+
+#### Defined in
+
+[@types/Dispenser.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L11)

package/docs/interfaces/DownloadResponse.md

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

package/docs/interfaces/Event.md

@@ -0,0 +1,73 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Event
+
+# Interface: Event
+
+## Table of contents
+
+### Properties
+
+- [block](Event.md#block)
+- [contract](Event.md#contract)
+- [datetime](Event.md#datetime)
+- [from](Event.md#from)
+- [txid](Event.md#txid)
+
+## Properties
+
+### block
+
+• `Optional` **block**: `number`
+
+Block of txid
+
+#### Defined in
+
+[@types/DDO/Event.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L12)
+
+___
+
+### contract
+
+• `Optional` **contract**: `string`
+
+Contract
+
+#### Defined in
+
+[@types/DDO/Event.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L24)
+
+___
+
+### datetime
+
+• `Optional` **datetime**: `string`
+
+datetime of tx
+
+#### Defined in
+
+[@types/DDO/Event.ts:30](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L30)
+
+___
+
+### from
+
+• `Optional` **from**: `string`
+
+Sender of tx
+
+#### Defined in
+
+[@types/DDO/Event.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L18)
+
+___
+
+### txid
+
+• `Optional` **txid**: `string`
+
+TX id of the last create/update
+
+#### Defined in
+
+[@types/DDO/Event.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L6)

package/docs/interfaces/FeesInfo.md

@@ -0,0 +1,74 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FeesInfo
+
+# Interface: FeesInfo
+
+## Table of contents
+
+### Properties
+
+- [exchangeId](FeesInfo.md#exchangeid)
+- [marketFee](FeesInfo.md#marketfee)
+- [marketFeeAvailable](FeesInfo.md#marketfeeavailable)
+- [marketFeeCollector](FeesInfo.md#marketfeecollector)
+- [oceanFeeAvailable](FeesInfo.md#oceanfeeavailable)
+- [opcFee](FeesInfo.md#opcfee)
+
+## Properties
+
+### exchangeId
+
+• **exchangeId**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:54](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L54)
+
+___
+
+### marketFee
+
+• **marketFee**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L50)
+
+___
+
+### marketFeeAvailable
+
+• **marketFeeAvailable**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:52](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L52)
+
+___
+
+### marketFeeCollector
+
+• **marketFeeCollector**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:51](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L51)
+
+___
+
+### oceanFeeAvailable
+
+• **oceanFeeAvailable**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:53](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L53)
+
+___
+
+### opcFee
+
+• **opcFee**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:49](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L49)