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

package/docs/interfaces/FileInfo.md

@@ -0,0 +1,118 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FileInfo
+
+# Interface: FileInfo
+
+## Table of contents
+
+### Properties
+
+- [checksum](FileInfo.md#checksum)
+- [contentLength](FileInfo.md#contentlength)
+- [contentType](FileInfo.md#contenttype)
+- [index](FileInfo.md#index)
+- [method](FileInfo.md#method)
+- [type](FileInfo.md#type)
+- [url](FileInfo.md#url)
+- [valid](FileInfo.md#valid)
+
+## Properties
+
+### checksum
+
+• `Optional` **checksum**: `string`
+
+Computed file checksum
+
+#### Defined in
+
+[@types/FileInfo.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L43)
+
+___
+
+### contentLength
+
+• `Optional` **contentLength**: `string`
+
+File content length.
+
+#### Defined in
+
+[@types/FileInfo.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L19)
+
+___
+
+### contentType
+
+• `Optional` **contentType**: `string`
+
+File format, if applicable.
+
+**`Example`**
+
+```ts
+"text/csv"
+```
+
+#### Defined in
+
+[@types/FileInfo.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L13)
+
+___
+
+### index
+
+• `Optional` **index**: `number`
+
+File index.
+
+#### Defined in
+
+[@types/FileInfo.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L25)
+
+___
+
+### method
+
+• `Optional` **method**: `string`
+
+HTTP method used
+
+#### Defined in
+
+[@types/FileInfo.ts:37](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L37)
+
+___
+
+### type
+
+• **type**: `string`
+
+File URL.
+
+#### Defined in
+
+[@types/FileInfo.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L6)
+
+___
+
+### url
+
+• `Optional` **url**: `string`
+
+File URL.
+
+#### Defined in
+
+[@types/FileInfo.ts:31](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L31)
+
+___
+
+### valid
+
+• `Optional` **valid**: `boolean`
+
+check if file exists
+
+#### Defined in
+
+[@types/FileInfo.ts:49](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FileInfo.ts#L49)

package/docs/interfaces/Files.md

@@ -0,0 +1,41 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Files
+
+# Interface: Files
+
+## Table of contents
+
+### Properties
+
+- [datatokenAddress](Files.md#datatokenaddress)
+- [files](Files.md#files)
+- [nftAddress](Files.md#nftaddress)
+
+## Properties
+
+### datatokenAddress
+
+• **datatokenAddress**: `string`
+
+#### Defined in
+
+[@types/File.ts:105](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L105)
+
+___
+
+### files
+
+• **files**: [`UrlFile`](UrlFile.md)[] \| [`GraphqlQuery`](GraphqlQuery.md)[] \| [`Arweave`](Arweave.md)[] \| [`Smartcontract`](Smartcontract-1.md)[] \| [`Ipfs`](Ipfs.md)[]
+
+#### Defined in
+
+[@types/File.ts:106](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L106)
+
+___
+
+### nftAddress
+
+• **nftAddress**: `string`
+
+#### Defined in
+
+[@types/File.ts:104](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L104)

package/docs/interfaces/FixedPriceExchange.md

@@ -0,0 +1,162 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FixedPriceExchange
+
+# Interface: FixedPriceExchange
+
+## Table of contents
+
+### Properties
+
+- [active](FixedPriceExchange.md#active)
+- [allowedSwapper](FixedPriceExchange.md#allowedswapper)
+- [baseToken](FixedPriceExchange.md#basetoken)
+- [btBalance](FixedPriceExchange.md#btbalance)
+- [btDecimals](FixedPriceExchange.md#btdecimals)
+- [btSupply](FixedPriceExchange.md#btsupply)
+- [datatoken](FixedPriceExchange.md#datatoken)
+- [dtBalance](FixedPriceExchange.md#dtbalance)
+- [dtDecimals](FixedPriceExchange.md#dtdecimals)
+- [dtSupply](FixedPriceExchange.md#dtsupply)
+- [exchangeId](FixedPriceExchange.md#exchangeid)
+- [exchangeOwner](FixedPriceExchange.md#exchangeowner)
+- [fixedRate](FixedPriceExchange.md#fixedrate)
+- [withMint](FixedPriceExchange.md#withmint)
+
+## Properties
+
+### active
+
+• **active**: `boolean`
+
+#### Defined in
+
+[@types/FixedPrice.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L32)
+
+___
+
+### allowedSwapper
+
+• **allowedSwapper**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L44)
+
+___
+
+### baseToken
+
+• **baseToken**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:35](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L35)
+
+___
+
+### btBalance
+
+• **btBalance**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L40)
+
+___
+
+### btDecimals
+
+• **btDecimals**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L38)
+
+___
+
+### btSupply
+
+• **btSupply**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L42)
+
+___
+
+### datatoken
+
+• **datatoken**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:34](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L34)
+
+___
+
+### dtBalance
+
+• **dtBalance**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:39](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L39)
+
+___
+
+### dtDecimals
+
+• **dtDecimals**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:37](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L37)
+
+___
+
+### dtSupply
+
+• **dtSupply**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:41](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L41)
+
+___
+
+### exchangeId
+
+• `Optional` **exchangeId**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:45](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L45)
+
+___
+
+### exchangeOwner
+
+• **exchangeOwner**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:33](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L33)
+
+___
+
+### fixedRate
+
+• **fixedRate**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:36](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L36)
+
+___
+
+### withMint
+
+• **withMint**: `boolean`
+
+#### Defined in
+
+[@types/FixedPrice.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L43)

package/docs/interfaces/FreCreationParams.md

@@ -0,0 +1,118 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FreCreationParams
+
+# Interface: FreCreationParams
+
+## Table of contents
+
+### Properties
+
+- [allowedConsumer](FreCreationParams.md#allowedconsumer)
+- [baseTokenAddress](FreCreationParams.md#basetokenaddress)
+- [baseTokenDecimals](FreCreationParams.md#basetokendecimals)
+- [datatokenDecimals](FreCreationParams.md#datatokendecimals)
+- [fixedRate](FreCreationParams.md#fixedrate)
+- [fixedRateAddress](FreCreationParams.md#fixedrateaddress)
+- [marketFee](FreCreationParams.md#marketfee)
+- [marketFeeCollector](FreCreationParams.md#marketfeecollector)
+- [owner](FreCreationParams.md#owner)
+- [withMint](FreCreationParams.md#withmint)
+
+## Properties
+
+### allowedConsumer
+
+• `Optional` **allowedConsumer**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L11)
+
+___
+
+### baseTokenAddress
+
+• **baseTokenAddress**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L3)
+
+___
+
+### baseTokenDecimals
+
+• **baseTokenDecimals**: `number`
+
+#### Defined in
+
+[@types/FixedPrice.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L6)
+
+___
+
+### datatokenDecimals
+
+• **datatokenDecimals**: `number`
+
+#### Defined in
+
+[@types/FixedPrice.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L7)
+
+___
+
+### fixedRate
+
+• **fixedRate**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L8)
+
+___
+
+### fixedRateAddress
+
+• **fixedRateAddress**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L2)
+
+___
+
+### marketFee
+
+• **marketFee**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L9)
+
+___
+
+### marketFeeCollector
+
+• **marketFeeCollector**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L5)
+
+___
+
+### owner
+
+• **owner**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L4)
+
+___
+
+### withMint
+
+• `Optional` **withMint**: `boolean`
+
+#### Defined in
+
+[@types/FixedPrice.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L10)

package/docs/interfaces/FreOrderParams.md

@@ -0,0 +1,85 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / FreOrderParams
+
+# Interface: FreOrderParams
+
+## Table of contents
+
+### Properties
+
+- [baseTokenAddress](FreOrderParams.md#basetokenaddress)
+- [baseTokenDecimals](FreOrderParams.md#basetokendecimals)
+- [exchangeContract](FreOrderParams.md#exchangecontract)
+- [exchangeId](FreOrderParams.md#exchangeid)
+- [marketFeeAddress](FreOrderParams.md#marketfeeaddress)
+- [maxBaseTokenAmount](FreOrderParams.md#maxbasetokenamount)
+- [swapMarketFee](FreOrderParams.md#swapmarketfee)
+
+## Properties
+
+### baseTokenAddress
+
+• **baseTokenAddress**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L18)
+
+___
+
+### baseTokenDecimals
+
+• `Optional` **baseTokenDecimals**: `number`
+
+#### Defined in
+
+[@types/FixedPrice.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L19)
+
+___
+
+### exchangeContract
+
+• **exchangeContract**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L15)
+
+___
+
+### exchangeId
+
+• **exchangeId**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L16)
+
+___
+
+### marketFeeAddress
+
+• **marketFeeAddress**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L21)
+
+___
+
+### maxBaseTokenAmount
+
+• **maxBaseTokenAmount**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L17)
+
+___
+
+### swapMarketFee
+
+• **swapMarketFee**: `string`
+
+#### Defined in
+
+[@types/FixedPrice.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/FixedPrice.ts#L20)

package/docs/interfaces/GraphqlQuery.md

@@ -0,0 +1,69 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / GraphqlQuery
+
+# Interface: GraphqlQuery
+
+## Table of contents
+
+### Properties
+
+- [headers](GraphqlQuery.md#headers)
+- [index](GraphqlQuery.md#index)
+- [query](GraphqlQuery.md#query)
+- [type](GraphqlQuery.md#type)
+- [url](GraphqlQuery.md#url)
+
+## Properties
+
+### headers
+
+• `Optional` **headers**: `FileTypeHeaders`
+
+Headers key value pairs associated with the asset GET request
+
+#### Defined in
+
+[@types/File.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L58)
+
+___
+
+### index
+
+• `Optional` **index**: `number`
+
+#### Defined in
+
+[@types/File.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L40)
+
+___
+
+### query
+
+• **query**: `string`
+
+query
+
+#### Defined in
+
+[@types/File.ts:52](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L52)
+
+___
+
+### type
+
+• **type**: ``"graphql"``
+
+#### Defined in
+
+[@types/File.ts:35](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L35)
+
+___
+
+### url
+
+• **url**: `string`
+
+Endpoint URL
+
+#### Defined in
+
+[@types/File.ts:46](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L46)

package/docs/interfaces/Ipfs.md

@@ -0,0 +1,32 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Ipfs
+
+# Interface: Ipfs
+
+## Table of contents
+
+### Properties
+
+- [hash](Ipfs.md#hash)
+- [type](Ipfs.md#type)
+
+## Properties
+
+### hash
+
+• **hash**: `string`
+
+hash
+
+#### Defined in
+
+[@types/File.ts:78](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L78)
+
+___
+
+### type
+
+• **type**: ``"ipfs"``
+
+#### Defined in
+
+[@types/File.ts:72](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/File.ts#L72)