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

package/docs/interfaces/Metadata.md

@@ -0,0 +1,193 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Metadata
+
+# Interface: Metadata
+
+## Table of contents
+
+### Properties
+
+- [additionalInformation](Metadata.md#additionalinformation)
+- [algorithm](Metadata.md#algorithm)
+- [author](Metadata.md#author)
+- [categories](Metadata.md#categories)
+- [contentLanguage](Metadata.md#contentlanguage)
+- [copyrightHolder](Metadata.md#copyrightholder)
+- [created](Metadata.md#created)
+- [description](Metadata.md#description)
+- [license](Metadata.md#license)
+- [links](Metadata.md#links)
+- [name](Metadata.md#name)
+- [tags](Metadata.md#tags)
+- [type](Metadata.md#type)
+- [updated](Metadata.md#updated)
+
+## Properties
+
+### additionalInformation
+
+• `Optional` **additionalInformation**: `any`
+
+Stores additional information, this is customizable by publisher
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:137](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L137)
+
+___
+
+### algorithm
+
+• `Optional` **algorithm**: [`MetadataAlgorithm`](MetadataAlgorithm.md)
+
+Information about asset of type algorithm. Required for algorithm assets.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:131](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L131)
+
+___
+
+### author
+
+• **author**: `string`
+
+Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:87](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L87)
+
+___
+
+### categories
+
+• `Optional` **categories**: `string`[]
+
+Array of categories associated to the asset. Note: recommended to use tags instead of this.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:113](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L113)
+
+___
+
+### contentLanguage
+
+• `Optional` **contentLanguage**: `string`
+
+The language of the content. Use one of the language codes from the IETF BCP 47 standard
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:125](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L125)
+
+___
+
+### copyrightHolder
+
+• `Optional` **copyrightHolder**: `string`
+
+The party holding the legal copyright. Empty by default.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:119](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L119)
+
+___
+
+### created
+
+• **created**: `string`
+
+Contains the date of publishing in ISO Date Time
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:56](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L56)
+
+___
+
+### description
+
+• **description**: `string`
+
+Details of what the resource is.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:74](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L74)
+
+___
+
+### license
+
+• **license**: `string`
+
+Short name referencing the license of the asset.
+If it’s not specified, the following value will be added: “No License Specified”.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L94)
+
+___
+
+### links
+
+• `Optional` **links**: `string`[]
+
+Mapping of URL strings for data samples, or links to find out more information.
+Links may be to either a URL or another asset.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:101](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L101)
+
+___
+
+### name
+
+• **name**: `string`
+
+Descriptive name or title of the asset.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:68](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L68)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string`[]
+
+Array of keywords or tags used to describe this content. Empty by default.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:107](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L107)
+
+___
+
+### type
+
+• **type**: ``"dataset"`` \| ``"algorithm"``
+
+Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
+Each type needs a different subset of metadata attributes.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:81](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L81)
+
+___
+
+### updated
+
+• **updated**: `string`
+
+Contains the the date of last update in ISO Date Time
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:62](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L62)

package/docs/interfaces/MetadataAlgorithm.md

@@ -0,0 +1,69 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / MetadataAlgorithm
+
+# Interface: MetadataAlgorithm
+
+## Table of contents
+
+### Properties
+
+- [container](MetadataAlgorithm.md#container)
+- [language](MetadataAlgorithm.md#language)
+- [rawcode](MetadataAlgorithm.md#rawcode)
+- [version](MetadataAlgorithm.md#version)
+
+## Properties
+
+### container
+
+• **container**: `Object`
+
+Object describing the Docker container image.
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `checksum` | `string` | Checksum of the Docker image. |
+| `entrypoint` | `string` | The command to execute, or script to run inside the Docker image. |
+| `image` | `string` | Name of the Docker image. |
+| `tag` | `string` | Tag of the Docker image. |
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L24)
+
+___
+
+### language
+
+• `Optional` **language**: `string`
+
+Programming language used to implement the software.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L6)
+
+___
+
+### rawcode
+
+• `Optional` **rawcode**: `string`
+
+Rawcode
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L18)
+
+___
+
+### version
+
+• `Optional` **version**: `string`
+
+Version of the software preferably in SemVer notation.
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L12)

package/docs/interfaces/MetadataAndTokenURI.md

@@ -0,0 +1,107 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / MetadataAndTokenURI
+
+# Interface: MetadataAndTokenURI
+
+## Table of contents
+
+### Properties
+
+- [data](MetadataAndTokenURI.md#data)
+- [flags](MetadataAndTokenURI.md#flags)
+- [metaDataDecryptorAddress](MetadataAndTokenURI.md#metadatadecryptoraddress)
+- [metaDataDecryptorUrl](MetadataAndTokenURI.md#metadatadecryptorurl)
+- [metaDataHash](MetadataAndTokenURI.md#metadatahash)
+- [metaDataState](MetadataAndTokenURI.md#metadatastate)
+- [metadataProofs](MetadataAndTokenURI.md#metadataproofs)
+- [tokenId](MetadataAndTokenURI.md#tokenid)
+- [tokenURI](MetadataAndTokenURI.md#tokenuri)
+
+## Properties
+
+### data
+
+• **data**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L8)
+
+___
+
+### flags
+
+• **flags**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L7)
+
+___
+
+### metaDataDecryptorAddress
+
+• **metaDataDecryptorAddress**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L6)
+
+___
+
+### metaDataDecryptorUrl
+
+• **metaDataDecryptorUrl**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L5)
+
+___
+
+### metaDataHash
+
+• **metaDataHash**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L9)
+
+___
+
+### metaDataState
+
+• **metaDataState**: `number`
+
+#### Defined in
+
+[@types/NFT.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L4)
+
+___
+
+### metadataProofs
+
+• `Optional` **metadataProofs**: [`MetadataProof`](MetadataProof.md)[]
+
+#### Defined in
+
+[@types/NFT.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L12)
+
+___
+
+### tokenId
+
+• **tokenId**: `number`
+
+#### Defined in
+
+[@types/NFT.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L10)
+
+___
+
+### tokenURI
+
+• **tokenURI**: `string`
+
+#### Defined in
+
+[@types/NFT.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L11)

package/docs/interfaces/MetadataProof.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / MetadataProof
+
+# Interface: MetadataProof
+
+## Table of contents
+
+### Properties
+
+- [r](MetadataProof.md#r)
+- [s](MetadataProof.md#s)
+- [v](MetadataProof.md#v)
+- [validatorAddress](MetadataProof.md#validatoraddress)
+
+## Properties
+
+### r
+
+• `Optional` **r**: `string`
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:142](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L142)
+
+___
+
+### s
+
+• `Optional` **s**: `string`
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:143](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L143)
+
+___
+
+### v
+
+• `Optional` **v**: `number`
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:144](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L144)
+
+___
+
+### validatorAddress
+
+• `Optional` **validatorAddress**: `string`
+
+#### Defined in
+
+[@types/DDO/Metadata.ts:141](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L141)

package/docs/interfaces/NftCreateData.md

@@ -0,0 +1,74 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / NftCreateData
+
+# Interface: NftCreateData
+
+## Table of contents
+
+### Properties
+
+- [name](NftCreateData.md#name)
+- [owner](NftCreateData.md#owner)
+- [symbol](NftCreateData.md#symbol)
+- [templateIndex](NftCreateData.md#templateindex)
+- [tokenURI](NftCreateData.md#tokenuri)
+- [transferable](NftCreateData.md#transferable)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[@types/NFTFactory.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L17)
+
+___
+
+### owner
+
+• **owner**: `string`
+
+#### Defined in
+
+[@types/NFTFactory.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L22)
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+#### Defined in
+
+[@types/NFTFactory.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L18)
+
+___
+
+### templateIndex
+
+• **templateIndex**: `number`
+
+#### Defined in
+
+[@types/NFTFactory.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L19)
+
+___
+
+### tokenURI
+
+• **tokenURI**: `string`
+
+#### Defined in
+
+[@types/NFTFactory.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L20)
+
+___
+
+### transferable
+
+• **transferable**: `boolean`
+
+#### Defined in
+
+[@types/NFTFactory.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L21)

package/docs/interfaces/NftRoles.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / NftRoles
+
+# Interface: NftRoles
+
+## Table of contents
+
+### Properties
+
+- [deployERC20](NftRoles.md#deployerc20)
+- [manager](NftRoles.md#manager)
+- [store](NftRoles.md#store)
+- [updateMetadata](NftRoles.md#updatemetadata)
+
+## Properties
+
+### deployERC20
+
+• **deployERC20**: `boolean`
+
+#### Defined in
+
+[@types/NFT.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L17)
+
+___
+
+### manager
+
+• **manager**: `boolean`
+
+#### Defined in
+
+[@types/NFT.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L16)
+
+___
+
+### store
+
+• **store**: `boolean`
+
+#### Defined in
+
+[@types/NFT.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L19)
+
+___
+
+### updateMetadata
+
+• **updateMetadata**: `boolean`
+
+#### Defined in
+
+[@types/NFT.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFT.ts#L18)

package/docs/interfaces/Operation.md

@@ -0,0 +1,145 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Operation
+
+# Interface: Operation
+
+## Table of contents
+
+### Properties
+
+- [amountsIn](Operation.md#amountsin)
+- [amountsOut](Operation.md#amountsout)
+- [exchangeIds](Operation.md#exchangeids)
+- [marketFeeAddress](Operation.md#marketfeeaddress)
+- [maxPrice](Operation.md#maxprice)
+- [operation](Operation.md#operation)
+- [source](Operation.md#source)
+- [swapMarketFee](Operation.md#swapmarketfee)
+- [tokenIn](Operation.md#tokenin)
+- [tokenOut](Operation.md#tokenout)
+
+## Properties
+
+### amountsIn
+
+• **amountsIn**: `string` \| `number`
+
+when swapExactAmountIn is EXACT amount IN
+expressed in Wei
+
+#### Defined in
+
+[@types/Router.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L31)
+
+___
+
+### amountsOut
+
+• **amountsOut**: `string` \| `number`
+
+when swapExactAmountIn is MIN amount OUT
+expressed in Wei
+
+#### Defined in
+
+[@types/Router.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L42)
+
+___
+
+### exchangeIds
+
+• **exchangeIds**: `string`
+
+used for FixedRate or Dispenser
+
+#### Defined in
+
+[@types/Router.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L6)
+
+___
+
+### marketFeeAddress
+
+• **marketFeeAddress**: `string`
+
+market fee address to receive fees
+
+#### Defined in
+
+[@types/Router.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L58)
+
+___
+
+### maxPrice
+
+• **maxPrice**: `string` \| `number`
+
+max price (only for pools)
+expressed in Wei
+
+#### Defined in
+
+[@types/Router.ts:48](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L48)
+
+___
+
+### operation
+
+• **operation**: `number`
+
+operation:
+0 - swapExactAmountIn
+1 - swapExactAmountOut
+2 - FixedRateExchange
+3 - Dispenser
+
+#### Defined in
+
+[@types/Router.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L20)
+
+___
+
+### source
+
+• **source**: `string`
+
+pool Address
+
+#### Defined in
+
+[@types/Router.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L11)
+
+___
+
+### swapMarketFee
+
+• **swapMarketFee**: `string`
+
+swap fee amount
+
+#### Defined in
+
+[@types/Router.ts:53](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L53)
+
+___
+
+### tokenIn
+
+• **tokenIn**: `string`
+
+token in address
+
+#### Defined in
+
+[@types/Router.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L25)
+
+___
+
+### tokenOut
+
+• **tokenOut**: `string`
+
+token out address
+
+#### Defined in
+
+[@types/Router.ts:36](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Router.ts#L36)