@oceanprotocol/lib 1.0.0-next.3 → 1.0.0-next.32

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 (60) hide show
  1. package/CHANGELOG.md +1486 -1213
  2. package/README.md +11 -31
  3. package/dist/lib.js +1 -1
  4. package/dist/lib.js.map +1 -1
  5. package/dist/lib.modern.js +1 -1
  6. package/dist/lib.modern.js.map +1 -1
  7. package/dist/lib.module.js +1 -1
  8. package/dist/lib.module.js.map +1 -1
  9. package/dist/lib.umd.js +1 -1
  10. package/dist/lib.umd.js.map +1 -1
  11. package/dist/src/@types/Asset.d.ts +83 -0
  12. package/dist/src/@types/Compute.d.ts +17 -0
  13. package/dist/src/@types/DDO/DDO.d.ts +43 -0
  14. package/dist/src/@types/DDO/Event.d.ts +20 -0
  15. package/dist/src/@types/DDO/Metadata.d.ts +92 -0
  16. package/dist/src/@types/DDO/Service.d.ts +72 -6
  17. package/dist/src/{interfaces/DispenserInterface.d.ts → @types/Dispenser.d.ts} +0 -0
  18. package/dist/src/@types/DownloadResponse.d.ts +4 -0
  19. package/dist/src/{interfaces/Erc20Interface.d.ts → @types/Erc20.d.ts} +6 -1
  20. package/dist/src/@types/Erc721.d.ts +12 -0
  21. package/dist/src/@types/FileMetadata.d.ts +30 -0
  22. package/dist/src/{interfaces/FixedRateInterface.d.ts → @types/FixedPrice.d.ts} +8 -2
  23. package/dist/src/{interfaces/PoolInterface.d.ts → @types/Pool.d.ts} +13 -6
  24. package/dist/src/@types/Provider.d.ts +3 -2
  25. package/dist/src/@types/Router.d.ts +59 -0
  26. package/dist/src/@types/index.d.ts +6 -0
  27. package/dist/src/aquarius/Aquarius.d.ts +26 -4
  28. package/dist/src/factories/NFTFactory.d.ts +222 -18
  29. package/dist/src/index.d.ts +1 -1
  30. package/dist/src/models/Config.d.ts +132 -0
  31. package/dist/src/pools/Router.d.ts +195 -12
  32. package/dist/src/pools/balancer/Pool.d.ts +379 -26
  33. package/dist/src/pools/dispenser/Dispenser.d.ts +112 -3
  34. package/dist/src/pools/fixedRate/FixedRateExchange.d.ts +312 -17
  35. package/dist/src/pools/ssContracts/SideStaking.d.ts +109 -5
  36. package/dist/src/provider/Provider.d.ts +127 -12
  37. package/dist/src/tokens/Datatoken.d.ts +301 -13
  38. package/dist/src/tokens/NFT.d.ts +303 -5
  39. package/dist/src/utils/ConfigHelper.d.ts +1 -1
  40. package/dist/src/utils/Constants.d.ts +1 -0
  41. package/dist/src/utils/ContractUtils.d.ts +12 -0
  42. package/dist/src/utils/DatatokenName.d.ts +4 -0
  43. package/dist/src/utils/FetchHelper.d.ts +3 -2
  44. package/dist/src/utils/General.d.ts +4 -0
  45. package/dist/src/utils/PoolHelpers.d.ts +8 -0
  46. package/dist/src/utils/TokenUtils.d.ts +39 -0
  47. package/dist/src/utils/index.d.ts +4 -2
  48. package/dist/src/utils/minAbi.d.ts +2 -0
  49. package/dist/test/config.d.ts +4 -0
  50. package/docs/beginners_guide.md +4 -4
  51. package/docs/overview.md +100 -9
  52. package/docs/quickstart_marketplace.md +34 -33
  53. package/docs/quickstart_simple.md +18 -16
  54. package/package.json +26 -25
  55. package/dist/src/interfaces/RouterInterface.d.ts +0 -12
  56. package/dist/src/interfaces/index.d.ts +0 -5
  57. package/dist/src/utils/ContractParams.d.ts +0 -4
  58. package/dist/src/utils/GasUtils.d.ts +0 -2
  59. package/dist/test/integration/config.d.ts +0 -3
  60. package/dist/test/unit/config.d.ts +0 -3
package/README.md CHANGED
@@ -13,27 +13,18 @@
13
13
 
14
14
  With ocean.js, you can:
15
15
 
16
- - **Publish** data services: downloadable files or compute-to-data.
17
- Ocean creates a new [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md)
18
- datatoken for each dataset / data service.
19
- - **Mint** datatokens for the service
20
- - **Sell** datatokens via an OCEAN-datatoken Balancer pool (for auto price discovery), or for a fixed price
21
- - **Stake** OCEAN on datatoken pools
22
- - **Consume** datatokens, to access the service
23
- - **Transfer** datatokens to another owner, and **all other ERC20 actions**
24
- using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
16
+ - **Publish** data services: downloadable files or compute-to-data. Create an ERC721 **data NFT** for each service, and ERC20 **datatoken** for access (1.0 datatokens to access).
17
+ - **Sell** datatokens via an OCEAN-datatoken Balancer pool (for auto price discovery), or for a fixed price. Sell data NFTs.
18
+ - **Stake OCEAN** on datatoken pools
19
+ - **Transfer** data NFTs & datatokens to another owner, and **all other ERC721 & ERC20 actions** using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
25
20
 
26
21
  ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
27
22
 
28
- This is in alpha state and you can expect running into problems. If you run into them, please open up a [new issue](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
23
+ This is in alpha state. If you run into problems, please open up a [new issue](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
29
24
 
30
25
  - [📚 Prerequisites](#-prerequisites)
31
26
  - [🏗 Installation](#-installation)
32
- - [🏄 Quickstart](#-quickstart)
33
- - [Beginners Guide](#beginners-guide)
34
- - [Simple Flow](#simple-flow)
35
- - [Marketplace Flow](#marketplace-flow)
36
- - [📖 Learn More](#learn-more)
27
+ - [🏄 Quickstart](#-quickstart): simple flow, marketplace, compute-to-data, more
37
28
  - [🦑 Development](#-development)
38
29
  - [✨ Code Style](#-code-style)
39
30
  - [👩‍🔬 Testing](#-testing)
@@ -93,23 +84,12 @@ async function init() {
93
84
  }
94
85
  ```
95
86
 
96
- ### Beginners Guide
87
+ Here are flows to try out, from beginners to advanced.
97
88
 
98
- This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.
89
+ - **[Beginners guide](docs/beginners_guide.md)** - for developers who are completely new to blockchain, no coding experience is required.
90
+ - **[Simple flow](docs/quickstart_simple.md)** - the essence of Ocean - creating a data NFT & datatoken.
91
+ - **[Marketplace flow](docs/quickstart_marketplace.md)** - a data asset is posted for sale in a datatoken pool, then purchased. Includes metadata and Compute-to-Data.
99
92
 
100
- [Go to beginners guide](docs/beginners_guide.md)
101
-
102
- ### Simple Flow
103
-
104
- This stripped-down flow shows the essence of Ocean. Just downloading, no metadata.
105
-
106
- [Go to simple flow](docs/quickstart_simple.md)
107
-
108
- ### Marketplace Flow
109
-
110
- This batteries-included flow includes metadata, multiple services for one datatoken, and compute-to-data.
111
-
112
- [Go to marketplace flow](docs/quickstart_marketplace.md)
113
93
 
114
94
  ### 📖 Learn more
115
95
 
@@ -243,7 +223,7 @@ Further releases afterwards can be done with `npm run release` again and selecti
243
223
  ## 🏛 License
244
224
 
245
225
  ```
246
- Copyright ((C)) 2021 Ocean Protocol Foundation
226
+ Copyright ((C)) 2022 Ocean Protocol Foundation
247
227
 
248
228
  Licensed under the Apache License, Version 2.0 (the "License");
249
229
  you may not use this file except in compliance with the License.