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

package/docs/interfaces/AbiItem.md

@@ -0,0 +1,107 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AbiItem
+
+# Interface: AbiItem
+
+## Table of contents
+
+### Properties
+
+- [anonymous](AbiItem.md#anonymous)
+- [constant](AbiItem.md#constant)
+- [gas](AbiItem.md#gas)
+- [inputs](AbiItem.md#inputs)
+- [name](AbiItem.md#name)
+- [outputs](AbiItem.md#outputs)
+- [payable](AbiItem.md#payable)
+- [stateMutability](AbiItem.md#statemutability)
+- [type](AbiItem.md#type)
+
+## Properties
+
+### anonymous
+
+• `Optional` **anonymous**: `boolean`
+
+#### Defined in
+
+[@types/Contracts.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L20)
+
+___
+
+### constant
+
+• `Optional` **constant**: `boolean`
+
+#### Defined in
+
+[@types/Contracts.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L21)
+
+___
+
+### gas
+
+• `Optional` **gas**: `number`
+
+#### Defined in
+
+[@types/Contracts.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L28)
+
+___
+
+### inputs
+
+• `Optional` **inputs**: [`AbiInput`](AbiInput.md)[]
+
+#### Defined in
+
+[@types/Contracts.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L22)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[@types/Contracts.ts:23](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L23)
+
+___
+
+### outputs
+
+• `Optional` **outputs**: [`AbiOutput`](AbiOutput.md)[]
+
+#### Defined in
+
+[@types/Contracts.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L24)
+
+___
+
+### payable
+
+• `Optional` **payable**: `boolean`
+
+#### Defined in
+
+[@types/Contracts.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L25)
+
+___
+
+### stateMutability
+
+• `Optional` **stateMutability**: [`StateMutabilityType`](../modules.md#statemutabilitytype)
+
+#### Defined in
+
+[@types/Contracts.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L26)
+
+___
+
+### type
+
+• **type**: [`AbiType`](../modules.md#abitype)
+
+#### Defined in
+
+[@types/Contracts.ts:27](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L27)

package/docs/interfaces/AbiOutput.md

@@ -0,0 +1,52 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AbiOutput
+
+# Interface: AbiOutput
+
+## Table of contents
+
+### Properties
+
+- [components](AbiOutput.md#components)
+- [internalType](AbiOutput.md#internaltype)
+- [name](AbiOutput.md#name)
+- [type](AbiOutput.md#type)
+
+## Properties
+
+### components
+
+• `Optional` **components**: [`AbiOutput`](AbiOutput.md)[]
+
+#### Defined in
+
+[@types/Contracts.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L15)
+
+___
+
+### internalType
+
+• `Optional` **internalType**: `string`
+
+#### Defined in
+
+[@types/Contracts.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L16)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[@types/Contracts.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L13)
+
+___
+
+### type
+
+• **type**: `string`
+
+#### Defined in
+
+[@types/Contracts.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L14)

package/docs/interfaces/Arweave.md

@@ -0,0 +1,32 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Arweave
+
+# Interface: Arweave
+
+## Table of contents
+
+### Properties
+
+- [transactionId](Arweave.md#transactionid)
+- [type](Arweave.md#type)
+
+## Properties
+
+### transactionId
+
+• **transactionId**: `string`
+
+transactionId
+
+#### Defined in
+
+[@types/File.ts:68](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L68)
+
+___
+
+### type
+
+• **type**: ``"arweave"``
+
+#### Defined in
+
+[@types/File.ts:62](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L62)

package/docs/interfaces/Asset.md

@@ -0,0 +1,227 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Asset
+
+# Interface: Asset
+
+DID Descriptor Object.
+Contains metadata about the asset, and define access in at least one service.
+
+## Hierarchy
+
+- [`DDO`](DDO.md)
+
+  ↳ **`Asset`**
+
+## Table of contents
+
+### Properties
+
+- [@context](Asset.md#@context)
+- [chainId](Asset.md#chainid)
+- [credentials](Asset.md#credentials)
+- [datatokens](Asset.md#datatokens)
+- [event](Asset.md#event)
+- [id](Asset.md#id)
+- [metadata](Asset.md#metadata)
+- [nft](Asset.md#nft)
+- [nftAddress](Asset.md#nftaddress)
+- [purgatory](Asset.md#purgatory)
+- [services](Asset.md#services)
+- [stats](Asset.md#stats)
+- [version](Asset.md#version)
+
+## Properties
+
+### @context
+
+• **@context**: `string`[]
+
+Contexts used for validation.
+
+#### Inherited from
+
+[DDO](DDO.md).[@context](DDO.md#@context)
+
+#### 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.
+
+#### Inherited from
+
+[DDO](DDO.md).[chainId](DDO.md#chainid)
+
+#### 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.
+
+#### Inherited from
+
+[DDO](DDO.md).[credentials](DDO.md#credentials)
+
+#### Defined in
+
+[@types/DDO/DDO.ts:57](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L57)
+
+___
+
+### datatokens
+
+• **datatokens**: [`AssetDatatoken`](AssetDatatoken.md)[]
+
+Contains information about the ERC20 Datatokens attached to asset services.
+
+#### Defined in
+
+[@types/Asset.ts:151](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L151)
+
+___
+
+### event
+
+• **event**: [`AssetLastEvent`](AssetLastEvent.md)
+
+Contains information about the last transaction that created or updated the DDO.
+
+#### Overrides
+
+[DDO](DDO.md).[event](DDO.md#event)
+
+#### Defined in
+
+[@types/Asset.ts:157](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L157)
+
+___
+
+### id
+
+• **id**: `string`
+
+DID, descentralized ID.
+Computed as sha256(address of NFT contract + chainId)
+
+#### Inherited from
+
+[DDO](DDO.md).[id](DDO.md#id)
+
+#### 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.
+
+#### Inherited from
+
+[DDO](DDO.md).[metadata](DDO.md#metadata)
+
+#### Defined in
+
+[@types/DDO/DDO.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L44)
+
+___
+
+### nft
+
+• **nft**: [`AssetNft`](AssetNft.md)
+
+Contains information about the ERC721 NFT contract which represents the intellectual property of the publisher.
+
+#### Defined in
+
+[@types/Asset.ts:145](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L145)
+
+___
+
+### nftAddress
+
+• **nftAddress**: `string`
+
+NFT contract address
+
+#### Inherited from
+
+[DDO](DDO.md).[nftAddress](DDO.md#nftaddress)
+
+#### Defined in
+
+[@types/DDO/DDO.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L32)
+
+___
+
+### purgatory
+
+• **purgatory**: [`Purgatory`](Purgatory.md)
+
+Contains information about an asset's purgatory status defined in
+[`list-purgatory`](https://github.com/oceanprotocol/list-purgatory).
+Marketplace interfaces are encouraged to prevent certain user actions like downloading on assets in purgatory.
+
+#### Defined in
+
+[@types/Asset.ts:171](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L171)
+
+___
+
+### services
+
+• **services**: [`Service`](Service.md)[]
+
+Stores an array of services defining access to the asset.
+
+#### Inherited from
+
+[DDO](DDO.md).[services](DDO.md#services)
+
+#### Defined in
+
+[@types/DDO/DDO.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L50)
+
+___
+
+### stats
+
+• **stats**: [`Stats`](Stats.md)
+
+The stats section contains different statistics fields. This section is added by Aquarius
+
+#### Defined in
+
+[@types/Asset.ts:163](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L163)
+
+___
+
+### version
+
+• **version**: `string`
+
+Version information in SemVer notation
+referring to the DDO spec version
+
+#### Inherited from
+
+[DDO](DDO.md).[version](DDO.md#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/AssetDatatoken.md

@@ -0,0 +1,60 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AssetDatatoken
+
+# Interface: AssetDatatoken
+
+## Table of contents
+
+### Properties
+
+- [address](AssetDatatoken.md#address)
+- [name](AssetDatatoken.md#name)
+- [serviceId](AssetDatatoken.md#serviceid)
+- [symbol](AssetDatatoken.md#symbol)
+
+## Properties
+
+### address
+
+• **address**: `string`
+
+Contract address of the deployed Datatoken contract.
+
+#### Defined in
+
+[@types/Asset.ts:72](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L72)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of NFT set in contract.
+
+#### Defined in
+
+[@types/Asset.ts:78](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L78)
+
+___
+
+### serviceId
+
+• **serviceId**: `string`
+
+ID of the service the datatoken is attached to.
+
+#### Defined in
+
+[@types/Asset.ts:90](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L90)
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+Symbol of NFT set in contract.
+
+#### Defined in
+
+[@types/Asset.ts:84](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L84)

package/docs/interfaces/AssetLastEvent.md

@@ -0,0 +1,63 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AssetLastEvent
+
+# Interface: AssetLastEvent
+
+## Table of contents
+
+### Properties
+
+- [block](AssetLastEvent.md#block)
+- [contract](AssetLastEvent.md#contract)
+- [datetime](AssetLastEvent.md#datetime)
+- [from](AssetLastEvent.md#from)
+- [tx](AssetLastEvent.md#tx)
+
+## Properties
+
+### block
+
+• **block**: `number`
+
+#### Defined in
+
+[@types/Asset.ts:134](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L134)
+
+___
+
+### contract
+
+• **contract**: `string`
+
+#### Defined in
+
+[@types/Asset.ts:136](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L136)
+
+___
+
+### datetime
+
+• **datetime**: `string`
+
+#### Defined in
+
+[@types/Asset.ts:137](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L137)
+
+___
+
+### from
+
+• **from**: `string`
+
+#### Defined in
+
+[@types/Asset.ts:135](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L135)
+
+___
+
+### tx
+
+• **tx**: `string`
+
+#### Defined in
+
+[@types/Asset.ts:133](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L133)

package/docs/interfaces/AssetNft.md

@@ -0,0 +1,105 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AssetNft
+
+# Interface: AssetNft
+
+## Table of contents
+
+### Properties
+
+- [address](AssetNft.md#address)
+- [created](AssetNft.md#created)
+- [name](AssetNft.md#name)
+- [owner](AssetNft.md#owner)
+- [state](AssetNft.md#state)
+- [symbol](AssetNft.md#symbol)
+- [tokenURI](AssetNft.md#tokenuri)
+
+## Properties
+
+### address
+
+• **address**: `string`
+
+Contract address of the deployed ERC721 NFT contract.
+
+#### Defined in
+
+[@types/Asset.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L8)
+
+___
+
+### created
+
+• **created**: `string`
+
+Contains the date of NFT creation.
+
+#### Defined in
+
+[@types/Asset.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L44)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of NFT set in contract.
+
+#### Defined in
+
+[@types/Asset.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L14)
+
+___
+
+### owner
+
+• **owner**: `string`
+
+ETH account address of the NFT owner.
+
+#### Defined in
+
+[@types/Asset.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L26)
+
+___
+
+### state
+
+• **state**: ``0`` \| ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5``
+
+State of the asset reflecting the NFT contract value.
+0	Active.
+1	End-of-life.
+2	Deprecated (by another asset).
+3	Revoked by publisher.
+4	Ordering is temporary disabled.
+5  Unlisted in markets.
+
+#### Defined in
+
+[@types/Asset.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L38)
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+Symbol of NFT set in contract.
+
+#### Defined in
+
+[@types/Asset.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L20)
+
+___
+
+### tokenURI
+
+• **tokenURI**: `string`
+
+NFT token URI.
+
+#### Defined in
+
+[@types/Asset.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L50)

package/docs/interfaces/AssetPrice.md

@@ -0,0 +1,47 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AssetPrice
+
+# Interface: AssetPrice
+
+## Table of contents
+
+### Properties
+
+- [tokenAddress](AssetPrice.md#tokenaddress)
+- [tokenSymbol](AssetPrice.md#tokensymbol)
+- [value](AssetPrice.md#value)
+
+## Properties
+
+### tokenAddress
+
+• `Optional` **tokenAddress**: `string`
+
+The address of the token that the price needs to be paid in.
+
+#### Defined in
+
+[@types/Asset.ts:110](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L110)
+
+___
+
+### tokenSymbol
+
+• `Optional` **tokenSymbol**: `string`
+
+The symbol that the price of the asset is expressed in.
+
+#### Defined in
+
+[@types/Asset.ts:104](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L104)
+
+___
+
+### value
+
+• **value**: `number`
+
+The price of the asset expressed as a number. If 0 then the price is FREE.
+
+#### Defined in
+
+[@types/Asset.ts:98](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L98)