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

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/README.md

@@ -0,0 +1,192 @@
+@oceanprotocol/lib / [Exports](modules.md)
+
+[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
+
+<h1 align="center">ocean.js</h1>
+
+> JavaScript library to privately & securely publish, exchange, and consume data.
+
+[![npm](https://img.shields.io/npm/v/@oceanprotocol/lib.svg)](https://www.npmjs.com/package/@oceanprotocol/lib)
+[![Build Status](https://github.com/oceanprotocol/ocean.js/workflows/CI/badge.svg)](https://github.com/oceanprotocol/ocean.js/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6381c81b8ac568a53537/maintainability)](https://codeclimate.com/github/oceanprotocol/ocean.js/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6381c81b8ac568a53537/test_coverage)](https://codeclimate.com/github/oceanprotocol/ocean.js/test_coverage)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-7b1173.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
+
+With ocean.js, you can:
+
+- **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).
+- **Sell** datatokens for a fixed price. Sell data NFTs.
+- **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.
+
+ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
+
+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=).
+
+- [📚 Prerequisites](#-prerequisites)
+- [🏗 Installation & Usage](#-installation--usage)
+- [🦑 Development](#-development)
+- [✨ Code Style](#-code-style)
+- [👩‍🔬 Testing](#-testing)
+  - [Unit Tests](#unit-tests)
+  - [Integration Tests](#integration-tests)
+- [🛳 Production](#-production)
+- [⬆️ Releases](#️-releases)
+  - [Production](#production)
+  - [Pre-Releases](#pre-releases)
+- [🏛 License](#-license)
+
+## 📚 Prerequisites
+
+- node.js ([Install from here](https://nodejs.org/en/download/))
+- Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
+- A Unix based operating system (Mac or Linux)
+
+## 🏗 Installation & Usage
+
+```bash
+npm install @oceanprotocol/lib
+```
+
+- Checkout our [code examples](CodeExamples.md) or [compute to data examples](C2DExamples.md) to see how you can use ocean.js.
+- Refer to the [Ocean Protocol documentation](https://docs.oceanprotocol.com/) for more guides and tutorials.
+- Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol.
+- If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
+- If you notice any bugs or issues with ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
+
+## 🦑 Development
+
+The project is authored with TypeScript and compiled with `tsc`.
+
+To start compiler in watch mode:
+
+```bash
+npm install
+npm start
+```
+
+## ✨ Code Style
+
+For linting and auto-formatting you can use from the root of the project:
+
+```bash
+# lint all js with eslint
+npm run lint
+
+# auto format all js & css with prettier, taking all configs into account
+npm run format
+```
+
+## 👩‍🔬 Testing
+
+Test suite for unit & integration tests is setup with [Mocha](https://mochajs.org) as test runner, and [nyc](https://github.com/istanbuljs/nyc) for coverage reporting. A combined coverage report is sent to CodeClimate via the `coverage` GitHub Actions job.
+
+Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a `ganache-cli` instance:
+
+```bash
+git clone https://github.com/oceanprotocol/barge
+cd barge
+
+./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
+```
+
+You can then proceed to run in another terminal.
+
+Let ocean.js know where to pickup the smart contract addresses, which has been written out by Barge in this location:
+
+```
+export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"
+```
+
+Build metadata:
+
+```
+npm run build:metadata
+```
+
+Executing linting, type checking, unit, and integration tests with coverage reporting all in one go:
+
+```bash
+npm test
+```
+
+### Unit Tests
+
+You can execute the unit tests individually with:
+
+```bash
+npm run test:unit
+# same thing, but with coverage reporting
+npm run test:unit:cover
+```
+
+### Integration Tests
+
+You can execute the integration tests individually with:
+
+```bash
+npm run test:integration
+# same thing, but with coverage reporting
+npm run test:integration:cover
+```
+
+> Note: On macOS, changes to the `provider`, `metadataCache` and `subgraph` URLs are required, as their default `barge` IPs can not be accessed due to network constraints on macOS. Instead use `http://127.0.0.1` for each direct call to the mentioned services, but keep the internal `provider` URL (`http://172.15.0.4:8030`) hardcoded inside all DDO's `serviceEndpoint`, and when calling `nft.setMetadata()`.
+
+## 🛳 Production
+
+To create a production build, run from the root of the project:
+
+```bash
+npm run build
+```
+
+## ⬆️ Releases
+
+Releases are managed semi-automatically. They are always manually triggered from a developer's machine with release scripts.
+
+### Production
+
+From a clean `main` branch you can run the release task bumping the version accordingly based on semantic versioning:
+
+```bash
+npm run release
+```
+
+The task does the following:
+
+- bumps the project version in `package.json`, `package-lock.json`
+- auto-generates and updates the CHANGELOG.md file from commit messages
+- creates a Git tag
+- commits and pushes everything
+- creates a GitHub release with commit messages as description
+- Git tag push will trigger a GitHub Action workflow to do a npm release
+
+For the GitHub releases steps a GitHub personal access token, exported as `GITHUB_TOKEN` is required. [Setup](https://github.com/release-it/release-it#github-releases)
+
+### Pre-Releases
+
+For pre-releases, this is required for the first one like `v0.18.0-next.0`:
+
+```bash
+./node_modules/.bin/release-it major|minor|patch --preRelease=next
+```
+
+Further releases afterwards can be done with `npm run release` again and selecting the appropriate next version, in this case `v0.18.0-next.1` and so on.
+
+## 🏛 License
+
+```
+Copyright ((C)) 2023 Ocean Protocol Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

package/docs/classes/Aquarius.md

@@ -0,0 +1,171 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Aquarius
+
+# Class: Aquarius
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Aquarius.md#constructor)
+
+### Properties
+
+- [aquariusURL](Aquarius.md#aquariusurl)
+
+### Methods
+
+- [getAssetMetadata](Aquarius.md#getassetmetadata)
+- [querySearch](Aquarius.md#querysearch)
+- [resolve](Aquarius.md#resolve)
+- [validate](Aquarius.md#validate)
+- [waitForAqua](Aquarius.md#waitforaqua)
+
+## Constructors
+
+### constructor
+
+• **new Aquarius**(`aquariusURL`)
+
+Instantiate Aquarius
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `aquariusURL` | `string` |
+
+#### Defined in
+
+[services/Aquarius.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L21)
+
+## Properties
+
+### aquariusURL
+
+• **aquariusURL**: `string`
+
+#### Defined in
+
+[services/Aquarius.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L15)
+
+## Methods
+
+### getAssetMetadata
+
+▸ **getAssetMetadata**(`did`, `signal?`): `Promise`<`any`\>
+
+Search over the DDOs using a query.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `did` | `string` | DID of the asset |
+| `signal?` | `AbortSignal` | abort signal |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[services/Aquarius.ts:135](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L135)
+
+___
+
+### querySearch
+
+▸ **querySearch**(`query`, `signal?`): `Promise`<`any`\>
+
+Search over the DDOs using a query.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the DDOs. |
+| `signal?` | `AbortSignal` | abort signal |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[services/Aquarius.ts:166](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L166)
+
+___
+
+### resolve
+
+▸ **resolve**(`did`, `signal?`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
+
+Resolves a DID
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `did` | `string` | DID of the asset. |
+| `signal?` | `AbortSignal` | abort signal |
+
+#### Returns
+
+`Promise`<[`Asset`](../interfaces/Asset.md)\>
+
+Asset
+
+#### Defined in
+
+[services/Aquarius.ts:30](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L30)
+
+___
+
+### validate
+
+▸ **validate**(`ddo`, `signal?`): `Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
+
+Validate DDO content
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ddo` | [`DDO`](../interfaces/DDO.md) | DID Descriptor Object content. |
+| `signal?` | `AbortSignal` | abort signal |
+
+#### Returns
+
+`Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
+
+.
+
+#### Defined in
+
+[services/Aquarius.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L94)
+
+___
+
+### waitForAqua
+
+▸ **waitForAqua**(`did`, `txid?`, `signal?`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
+
+Blocks until Aqua will cache the did (or the update for that did) or timeouts
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `did` | `string` | DID of the asset. |
+| `txid?` | `string` | used when the did exists and we expect an update with that txid. |
+| `signal?` | `AbortSignal` | abort signal |
+
+#### Returns
+
+`Promise`<[`Asset`](../interfaces/Asset.md)\>
+
+DDO of the asset.
+
+#### Defined in
+
+[services/Aquarius.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L58)