npm - @oceanprotocol/lib - Versions diffs - 7.0.0-next.0 → 7.0.0-next.10 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (105) hide show

package/dist/lib.cjs +4 -3
package/dist/lib.module.mjs +4 -3
package/dist/lib.umd.js +4 -3
package/dist/types/@types/Compute.d.ts +21 -0
package/dist/types/@types/Provider.d.ts +39 -0
package/dist/types/services/providers/BaseProvider.d.ts +35 -32
package/dist/types/services/providers/HttpProvider.d.ts +4 -2
package/dist/types/services/providers/P2pProvider.d.ts +39 -37
package/package.json +27 -21
package/.mocharc.json +0 -8
package/.nvmrc +0 -1
package/CHANGELOG.md +0 -3228
package/Cheatsheet.md +0 -326
package/CodeExamples.md +0 -881
package/ComputeExamples.md +0 -941
package/dist/lib.cjs.map +0 -1
package/dist/lib.modern.js +0 -4
package/dist/lib.modern.js.map +0 -1
package/dist/lib.module.mjs.map +0 -1
package/dist/lib.umd.js.map +0 -1
package/docs/.nojekyll +0 -1
package/docs/README.md +0 -195
package/docs/classes/Aquarius.md +0 -175
package/docs/classes/Config.md +0 -481
package/docs/classes/ConfigHelper.md +0 -66
package/docs/classes/Datatoken.md +0 -1123
package/docs/classes/Dispenser.md +0 -502
package/docs/classes/Escrow.md +0 -285
package/docs/classes/FixedRateExchange.md +0 -1068
package/docs/classes/Logger.md +0 -191
package/docs/classes/Nft.md +0 -970
package/docs/classes/NftFactory.md +0 -861
package/docs/classes/Provider.md +0 -727
package/docs/classes/Router.md +0 -645
package/docs/classes/SmartContract.md +0 -193
package/docs/classes/SmartContractWithAddress.md +0 -268
package/docs/enums/LogLevel.md +0 -63
package/docs/interfaces/AbiInput.md +0 -63
package/docs/interfaces/AbiItem.md +0 -107
package/docs/interfaces/AbiOutput.md +0 -52
package/docs/interfaces/Arweave.md +0 -32
package/docs/interfaces/Asset.md +0 -227
package/docs/interfaces/AssetDatatoken.md +0 -60
package/docs/interfaces/AssetLastEvent.md +0 -63
package/docs/interfaces/AssetNft.md +0 -105
package/docs/interfaces/AssetPrice.md +0 -47
package/docs/interfaces/ComputeAlgorithm.md +0 -82
package/docs/interfaces/ComputeAsset.md +0 -56
package/docs/interfaces/ComputeEnvFees.md +0 -30
package/docs/interfaces/ComputeEnvFeesStructure.md +0 -20
package/docs/interfaces/ComputeEnvironment.md +0 -177
package/docs/interfaces/ComputeJob.md +0 -173
package/docs/interfaces/ComputeOutput.md +0 -118
package/docs/interfaces/ComputeResourcesPricingInfo.md +0 -30
package/docs/interfaces/ComputeResourcesRequest.md +0 -34
package/docs/interfaces/ComputeResult.md +0 -52
package/docs/interfaces/ConsumeMarketFee.md +0 -41
package/docs/interfaces/Credential.md +0 -30
package/docs/interfaces/Credentials.md +0 -30
package/docs/interfaces/DDO.md +0 -137
package/docs/interfaces/DatatokenCreateParams.md +0 -107
package/docs/interfaces/DatatokenRoles.md +0 -30
package/docs/interfaces/DispenserCreationParams.md +0 -63
package/docs/interfaces/DispenserParams.md +0 -52
package/docs/interfaces/DispenserToken.md +0 -85
package/docs/interfaces/DownloadResponse.md +0 -30
package/docs/interfaces/Event.md +0 -73
package/docs/interfaces/FeesInfo.md +0 -74
package/docs/interfaces/FileInfo.md +0 -118
package/docs/interfaces/Files.md +0 -41
package/docs/interfaces/FixedPriceExchange.md +0 -162
package/docs/interfaces/FreCreationParams.md +0 -118
package/docs/interfaces/FreOrderParams.md +0 -85
package/docs/interfaces/GraphqlQuery.md +0 -69
package/docs/interfaces/Ipfs.md +0 -32
package/docs/interfaces/Metadata.md +0 -193
package/docs/interfaces/MetadataAlgorithm.md +0 -69
package/docs/interfaces/MetadataAndTokenURI.md +0 -107
package/docs/interfaces/MetadataProof.md +0 -52
package/docs/interfaces/NftCreateData.md +0 -74
package/docs/interfaces/NftRoles.md +0 -52
package/docs/interfaces/Operation.md +0 -145
package/docs/interfaces/OrderParams.md +0 -52
package/docs/interfaces/PriceAndFees.md +0 -52
package/docs/interfaces/ProviderComputeInitialize.md +0 -41
package/docs/interfaces/ProviderComputeInitializeResults.md +0 -43
package/docs/interfaces/ProviderFees.md +0 -96
package/docs/interfaces/ProviderInitialize.md +0 -52
package/docs/interfaces/PublisherTrustedAlgorithm.md +0 -47
package/docs/interfaces/PublishingMarketFee.md +0 -41
package/docs/interfaces/Purgatory.md +0 -34
package/docs/interfaces/RunningPlatform.md +0 -30
package/docs/interfaces/SearchQuery.md +0 -67
package/docs/interfaces/Service.md +0 -138
package/docs/interfaces/ServiceComputeOptions.md +0 -63
package/docs/interfaces/ServiceEndpoint.md +0 -41
package/docs/interfaces/Smartcontract-1.md +0 -58
package/docs/interfaces/Stats.md +0 -47
package/docs/interfaces/Template.md +0 -30
package/docs/interfaces/TokenOrder.md +0 -63
package/docs/interfaces/UrlFile.md +0 -71
package/docs/interfaces/UserCustomParameters.md +0 -7
package/docs/interfaces/ValidateMetadata.md +0 -52
package/docs/modules.md +0 -850
package/typedoc.json +0 -4

package/docs/classes/Config.md DELETED Viewed

@@ -1,481 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Config
-# Class: Config
-## Table of contents
-### Constructors
-- [constructor](Config.md#constructor)
-### Properties
-- [DFRewards](Config.md#dfrewards)
-- [DFStrategyV1](Config.md#dfstrategyv1)
-- [authMessage](Config.md#authmessage)
-- [authTokenExpiration](Config.md#authtokenexpiration)
-- [chainId](Config.md#chainid)
-- [datatokensABI](Config.md#datatokensabi)
-- [dispenserABI](Config.md#dispenserabi)
-- [dispenserAddress](Config.md#dispenseraddress)
-- [explorerUri](Config.md#exploreruri)
-- [fixedRateExchangeAddress](Config.md#fixedrateexchangeaddress)
-- [fixedRateExchangeAddressABI](Config.md#fixedrateexchangeaddressabi)
-- [gasFeeMultiplier](Config.md#gasfeemultiplier)
-- [metadataCacheUri](Config.md#metadatacacheuri)
-- [network](Config.md#network)
-- [nftFactoryAddress](Config.md#nftfactoryaddress)
-- [nodeUri](Config.md#nodeuri)
-- [oceanTokenAddress](Config.md#oceantokenaddress)
-- [oceanTokenSymbol](Config.md#oceantokensymbol)
-- [opfCommunityFeeCollector](Config.md#opfcommunityfeecollector)
-- [parityUri](Config.md#parityuri)
-- [providerAddress](Config.md#provideraddress)
-- [providerUri](Config.md#provideruri)
-- [sideStakingAddress](Config.md#sidestakingaddress)
-- [startBlock](Config.md#startblock)
-- [subgraphUri](Config.md#subgraphuri)
-- [threshold](Config.md#threshold)
-- [transactionBlockTimeout](Config.md#transactionblocktimeout)
-- [transactionConfirmationBlocks](Config.md#transactionconfirmationblocks)
-- [transactionPollingTimeout](Config.md#transactionpollingtimeout)
-- [veAllocate](Config.md#veallocate)
-- [veDelegation](Config.md#vedelegation)
-- [veDelegationProxy](Config.md#vedelegationproxy)
-- [veFeeDistributor](Config.md#vefeedistributor)
-- [veFeeEstimate](Config.md#vefeeestimate)
-- [veOCEAN](Config.md#veocean)
-- [verbose](Config.md#verbose)
-- [web3Provider](Config.md#web3provider)
-## Constructors
-### constructor
-• **new Config**()
-## Properties
-### DFRewards
-• `Optional` **DFRewards**: `string`
-#### Defined in
-[config/Config.ts:180](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L180)
-___
-### DFStrategyV1
-• `Optional` **DFStrategyV1**: `string`
-#### Defined in
-[config/Config.ts:181](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L181)
-___
-### authMessage
-• `Optional` **authMessage**: `string`
-Message shown when the user creates its own token.
-#### Defined in
-[config/Config.ts:105](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L105)
-___
-### authTokenExpiration
-• `Optional` **authTokenExpiration**: `number`
-Token expiration time in ms.
-#### Defined in
-[config/Config.ts:111](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L111)
-___
-### chainId
-• **chainId**: `number`
-Chain ID
-#### Defined in
-[config/Config.ts:125](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L125)
-___
-### datatokensABI
-• `Optional` **datatokensABI**: [`AbiItem`](../interfaces/AbiItem.md) \| [`AbiItem`](../interfaces/AbiItem.md)[]
-datatokens ABI
-#### Defined in
-[config/Config.ts:52](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L52)
-___
-### dispenserABI
-• `Optional` **dispenserABI**: [`AbiItem`](../interfaces/AbiItem.md) \| [`AbiItem`](../interfaces/AbiItem.md)[]
-DispenserABI
-#### Defined in
-[config/Config.ts:76](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L76)
-___
-### dispenserAddress
-• `Optional` **dispenserAddress**: `string`
-DispenserAddress
-#### Defined in
-[config/Config.ts:70](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L70)
-___
-### explorerUri
-• **explorerUri**: `string`
-Url of the  blockchain exporer ex: https://etherscan.io
-#### Defined in
-[config/Config.ts:143](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L143)
-___
-### fixedRateExchangeAddress
-• `Optional` **fixedRateExchangeAddress**: `string`
-FixedRateExchangeAddress
-#### Defined in
-[config/Config.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L58)
-___
-### fixedRateExchangeAddressABI
-• `Optional` **fixedRateExchangeAddressABI**: [`AbiItem`](../interfaces/AbiItem.md) \| [`AbiItem`](../interfaces/AbiItem.md)[]
-FixedRateExchangeAddressABI
-#### Defined in
-[config/Config.ts:64](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L64)
-___
-### gasFeeMultiplier
-• **gasFeeMultiplier**: `number`
-Specify the multiplier for the gas fee
-#### Defined in
-[config/Config.ts:173](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L173)
-___
-### metadataCacheUri
-• `Optional` **metadataCacheUri**: `string`
-Metadata Store URL.
-#### Defined in
-[config/Config.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L21)
-___
-### network
-• **network**: `string`
-Network name ex: mainnet, goerli, polygon
-#### Defined in
-[config/Config.ts:131](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L131)
-___
-### nftFactoryAddress
-• `Optional` **nftFactoryAddress**: `string`
-Factory address
-#### Defined in
-[config/Config.ts:46](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L46)
-___
-### nodeUri
-• `Optional` **nodeUri**: `string`
-Ethereum node URL.
-#### Defined in
-[config/Config.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L9)
-___
-### oceanTokenAddress
-• `Optional` **oceanTokenAddress**: `string`
-Ocean Token address
-#### Defined in
-[config/Config.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L40)
-___
-### oceanTokenSymbol
-• **oceanTokenSymbol**: `string`
-Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls
-#### Defined in
-[config/Config.ts:149](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L149)
-___
-### opfCommunityFeeCollector
-• `Optional` **opfCommunityFeeCollector**: `string`
-OPFCommunityFeeCollector
-#### Defined in
-[config/Config.ts:82](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L82)
-___
-### parityUri
-• `Optional` **parityUri**: `string`
-Parity config
-#### Defined in
-[config/Config.ts:117](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L117)
-___
-### providerAddress
-• `Optional` **providerAddress**: `string`
-Address of Provider.
-#### Defined in
-[config/Config.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L15)
-___
-### providerUri
-• `Optional` **providerUri**: `string`
-Provider URL.
-#### Defined in
-[config/Config.ts:27](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L27)
-___
-### sideStakingAddress
-• `Optional` **sideStakingAddress**: `string`
-SideStaking address
-#### Defined in
-[config/Config.ts:88](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L88)
-___
-### startBlock
-• `Optional` **startBlock**: `number`
-block number of the deployment
-#### Defined in
-[config/Config.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L94)
-___
-### subgraphUri
-• **subgraphUri**: `string`
-Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com
-#### Defined in
-[config/Config.ts:137](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L137)
-___
-### threshold
-• `Optional` **threshold**: `number`
-#### Defined in
-[config/Config.ts:119](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L119)
-___
-### transactionBlockTimeout
-• **transactionBlockTimeout**: `number`
-Specify the transaction Block Timeout
-#### Defined in
-[config/Config.ts:155](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L155)
-___
-### transactionConfirmationBlocks
-• **transactionConfirmationBlocks**: `number`
-Specify the transaction Confirmation Blocks
-#### Defined in
-[config/Config.ts:161](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L161)
-___
-### transactionPollingTimeout
-• **transactionPollingTimeout**: `number`
-Specify the transaction Polling Blocks Timeout
-#### Defined in
-[config/Config.ts:167](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L167)
-___
-### veAllocate
-• `Optional` **veAllocate**: `string`
-#### Defined in
-[config/Config.ts:175](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L175)
-___
-### veDelegation
-• `Optional` **veDelegation**: `string`
-#### Defined in
-[config/Config.ts:177](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L177)
-___
-### veDelegationProxy
-• `Optional` **veDelegationProxy**: `string`
-#### Defined in
-[config/Config.ts:179](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L179)
-___
-### veFeeDistributor
-• `Optional` **veFeeDistributor**: `string`
-#### Defined in
-[config/Config.ts:178](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L178)
-___
-### veFeeEstimate
-• `Optional` **veFeeEstimate**: `string`
-#### Defined in
-[config/Config.ts:182](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L182)
-___
-### veOCEAN
-• `Optional` **veOCEAN**: `string`
-#### Defined in
-[config/Config.ts:176](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L176)
-___
-### verbose
-• `Optional` **verbose**: `boolean` \| [`LogLevel`](../enums/LogLevel.md)
-Log level.
-#### Defined in
-[config/Config.ts:99](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L99)
-___
-### web3Provider
-• `Optional` **web3Provider**: `any`
-Web3 Provider.
-#### Defined in
-[config/Config.ts:34](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/Config.ts#L34)

package/docs/classes/ConfigHelper.md DELETED Viewed

@@ -1,66 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ConfigHelper
-# Class: ConfigHelper
-## Table of contents
-### Constructors
-- [constructor](ConfigHelper.md#constructor)
-### Methods
-- [getAddressesFromEnv](ConfigHelper.md#getaddressesfromenv)
-- [getConfig](ConfigHelper.md#getconfig)
-## Constructors
-### constructor
-• **new ConfigHelper**()
-## Methods
-### getAddressesFromEnv
-▸ **getAddressesFromEnv**(`network`, `customAddresses?`): `Partial`<[`Config`](Config.md)\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `network` | `string` |
-| `customAddresses?` | `any` |
-#### Returns
-`Partial`<[`Config`](Config.md)\>
-#### Defined in
-[config/ConfigHelper.ts:124](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/ConfigHelper.ts#L124)
-___
-### getConfig
-▸ **getConfig**(`network`, `infuraProjectId?`): [`Config`](Config.md)
-Returns the config object for a specific network supported by the oceanprotocol stack
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `network` | `string` \| `number` | the network's chainId or name |
-| `infuraProjectId?` | `string` | optional infura project id that will replace the configs node URI |
-#### Returns
-[`Config`](Config.md)
-Config obhjedct
-#### Defined in
-[config/ConfigHelper.ts:214](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/config/ConfigHelper.ts#L214)