@oceanprotocol/lib 7.0.0-next.0 → 7.0.0-next.10

package/docs/interfaces/ServiceComputeOptions.md

@@ -1,63 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ServiceComputeOptions
-
-# Interface: ServiceComputeOptions
-
-## Table of contents
-
-### Properties
-
-- [allowNetworkAccess](ServiceComputeOptions.md#allownetworkaccess)
-- [allowRawAlgorithm](ServiceComputeOptions.md#allowrawalgorithm)
-- [publisherTrustedAlgorithmPublishers](ServiceComputeOptions.md#publishertrustedalgorithmpublishers)
-- [publisherTrustedAlgorithms](ServiceComputeOptions.md#publishertrustedalgorithms)
-
-## Properties
-
-### allowNetworkAccess
-
-• **allowNetworkAccess**: `boolean`
-
-If true, the algorithm job will have network access.
-
-#### Defined in
-
-[@types/DDO/Service.ts:34](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L34)
-
-___
-
-### allowRawAlgorithm
-
-• **allowRawAlgorithm**: `boolean`
-
-If true, any passed raw text will be allowed to run.
-Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input.
-Should be false by default in all implementations.
-
-#### Defined in
-
-[@types/DDO/Service.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L28)
-
-___
-
-### publisherTrustedAlgorithmPublishers
-
-• **publisherTrustedAlgorithmPublishers**: `string`[]
-
-If empty, then any published algorithm is allowed.
-Otherwise, only published algorithms by some publishers are allowed
-
-#### Defined in
-
-[@types/DDO/Service.ts:41](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L41)
-
-___
-
-### publisherTrustedAlgorithms
-
-• **publisherTrustedAlgorithms**: [`PublisherTrustedAlgorithm`](PublisherTrustedAlgorithm.md)[]
-
-If empty, then any published algorithm is allowed. (see below)
-
-#### Defined in
-
-[@types/DDO/Service.ts:47](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L47)

package/docs/interfaces/ServiceEndpoint.md

@@ -1,41 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ServiceEndpoint
-
-# Interface: ServiceEndpoint
-
-## Table of contents
-
-### Properties
-
-- [method](ServiceEndpoint.md#method)
-- [serviceName](ServiceEndpoint.md#servicename)
-- [urlPath](ServiceEndpoint.md#urlpath)
-
-## Properties
-
-### method
-
-• **method**: `string`
-
-#### Defined in
-
-[@types/Provider.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L32)
-
-___
-
-### serviceName
-
-• **serviceName**: `string`
-
-#### Defined in
-
-[@types/Provider.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L31)
-
-___
-
-### urlPath
-
-• **urlPath**: `string`
-
-#### Defined in
-
-[@types/Provider.ts:33](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Provider.ts#L33)

package/docs/interfaces/Smartcontract-1.md

@@ -1,58 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Smartcontract
-
-# Interface: Smartcontract
-
-## Table of contents
-
-### Properties
-
-- [abi](Smartcontract-1.md#abi)
-- [address](Smartcontract-1.md#address)
-- [chainId](Smartcontract-1.md#chainid)
-- [type](Smartcontract-1.md#type)
-
-## Properties
-
-### abi
-
-• **abi**: [`AbiItem`](AbiItem.md)
-
-Function ABI (not the entire smartcontract abi)
-
-#### Defined in
-
-[@types/File.ts:100](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L100)
-
-___
-
-### address
-
-• **address**: `string`
-
-Smartcontract address
-
-#### Defined in
-
-[@types/File.ts:88](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L88)
-
-___
-
-### chainId
-
-• **chainId**: `number`
-
-ChainId
-
-#### Defined in
-
-[@types/File.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L94)
-
-___
-
-### type
-
-• **type**: ``"smartcontract"``
-
-#### Defined in
-
-[@types/File.ts:82](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L82)

package/docs/interfaces/Stats.md

@@ -1,47 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Stats
-
-# Interface: Stats
-
-## Table of contents
-
-### Properties
-
-- [allocated](Stats.md#allocated)
-- [orders](Stats.md#orders)
-- [price](Stats.md#price)
-
-## Properties
-
-### allocated
-
-• `Optional` **allocated**: `number`
-
-Total amount of veOCEAN allocated on this asset.
-
-#### Defined in
-
-[@types/Asset.ts:129](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L129)
-
-___
-
-### orders
-
-• **orders**: `number`
-
-How often an asset was consumed, meaning how often it was either downloaded or used as part of a compute job.
-
-#### Defined in
-
-[@types/Asset.ts:117](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L117)
-
-___
-
-### price
-
-• **price**: [`AssetPrice`](AssetPrice.md)
-
-Contains information about the price of this asset.
-
-#### Defined in
-
-[@types/Asset.ts:123](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L123)

package/docs/interfaces/Template.md

@@ -1,30 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Template
-
-# Interface: Template
-
-## Table of contents
-
-### Properties
-
-- [isActive](Template.md#isactive)
-- [templateAddress](Template.md#templateaddress)
-
-## Properties
-
-### isActive
-
-• **isActive**: `boolean`
-
-#### Defined in
-
-[@types/NFTFactory.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L5)
-
-___
-
-### templateAddress
-
-• **templateAddress**: `string`
-
-#### Defined in
-
-[@types/NFTFactory.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L4)

package/docs/interfaces/TokenOrder.md

@@ -1,63 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / TokenOrder
-
-# Interface: TokenOrder
-
-## Table of contents
-
-### Properties
-
-- [\_consumeMarketFee](TokenOrder.md#_consumemarketfee)
-- [\_providerFee](TokenOrder.md#_providerfee)
-- [consumer](TokenOrder.md#consumer)
-- [serviceIndex](TokenOrder.md#serviceindex)
-- [tokenAddress](TokenOrder.md#tokenaddress)
-
-## Properties
-
-### \_consumeMarketFee
-
-• **\_consumeMarketFee**: [`ConsumeMarketFee`](ConsumeMarketFee.md)
-
-#### Defined in
-
-[@types/NFTFactory.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L13)
-
-___
-
-### \_providerFee
-
-• **\_providerFee**: [`ProviderFees`](ProviderFees.md)
-
-#### Defined in
-
-[@types/NFTFactory.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L12)
-
-___
-
-### consumer
-
-• **consumer**: `string`
-
-#### Defined in
-
-[@types/NFTFactory.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L10)
-
-___
-
-### serviceIndex
-
-• **serviceIndex**: `number`
-
-#### Defined in
-
-[@types/NFTFactory.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L11)
-
-___
-
-### tokenAddress
-
-• **tokenAddress**: `string`
-
-#### Defined in
-
-[@types/NFTFactory.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/NFTFactory.ts#L9)

package/docs/interfaces/UrlFile.md

@@ -1,71 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / UrlFile
-
-# Interface: UrlFile
-
-## Table of contents
-
-### Properties
-
-- [headers](UrlFile.md#headers)
-- [index](UrlFile.md#index)
-- [method](UrlFile.md#method)
-- [type](UrlFile.md#type)
-- [url](UrlFile.md#url)
-
-## Properties
-
-### headers
-
-• `Optional` **headers**: `FileTypeHeaders`
-
-Headers key value pairs associated with the asset GET request
-
-#### Defined in
-
-[@types/File.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L32)
-
-___
-
-### index
-
-• `Optional` **index**: `number`
-
-File index.
-
-#### Defined in
-
-[@types/File.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L14)
-
-___
-
-### method
-
-• **method**: `string`
-
-HTTP method used
-
-#### Defined in
-
-[@types/File.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L26)
-
-___
-
-### type
-
-• **type**: ``"url"``
-
-#### Defined in
-
-[@types/File.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L8)
-
-___
-
-### url
-
-• **url**: `string`
-
-File URL.
-
-#### Defined in
-
-[@types/File.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L20)

package/docs/interfaces/UserCustomParameters.md

@@ -1,7 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / UserCustomParameters
-
-# Interface: UserCustomParameters
-
-## Indexable
-
-▪ [key: `string`]: `any`

package/docs/interfaces/ValidateMetadata.md

@@ -1,52 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ValidateMetadata
-
-# Interface: ValidateMetadata
-
-## Table of contents
-
-### Properties
-
-- [errors](ValidateMetadata.md#errors)
-- [hash](ValidateMetadata.md#hash)
-- [proof](ValidateMetadata.md#proof)
-- [valid](ValidateMetadata.md#valid)
-
-## Properties
-
-### errors
-
-• `Optional` **errors**: `Object`
-
-#### Defined in
-
-[@types/DDO/Metadata.ts:148](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L148)
-
-___
-
-### hash
-
-• `Optional` **hash**: `string`
-
-#### Defined in
-
-[@types/DDO/Metadata.ts:149](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L149)
-
-___
-
-### proof
-
-• `Optional` **proof**: [`MetadataProof`](MetadataProof.md)
-
-#### Defined in
-
-[@types/DDO/Metadata.ts:150](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L150)
-
-___
-
-### valid
-
-• **valid**: `Boolean`
-
-#### Defined in
-
-[@types/DDO/Metadata.ts:147](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L147)