From 7d444aae03e08f2bd00aa4197f25bd2bb752c3a2 Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 18:12:28 +0100 Subject: [PATCH 1/9] chore: add src/README --- src/README.md | 127 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 src/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..8f9283e --- /dev/null +++ b/src/README.md @@ -0,0 +1,127 @@ +
+ +

+ + + + nautilus logo + + +

+ +

+ The Data Economy TypeScript Toolkit +

+ +

+ + + + Version + + + + + + Apache-2.0 License + + + + + + GitHub Actions Workflow Status + + +

+ + +A TypeScript library enabling you to explore the Data Economy. It is built on top of [ocean.js](https://github.com/oceanprotocol/ocean.js) and offers feature complete, automated interactions with any [Ocean Protocol](https://oceanprotocol.com) ecosystem. + +## Overview +nautilus addresses many common pain points faced by developers interacting with the data economy by offering a range of features enhancing productivity and efficiency. +You will find a quick introduction on this page to get you setup with the **Data Economy TypeScript Toolkit**. + +Looking for dedicated feature documentations? Follow the links below: +- [Download](https://nautilus.delta-dao.com/docs/guides/download) +- [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) +- [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) +- [Editing](https://nautilus.delta-dao.com/docs/guides/edit) + + +## Quick Start +### 1. Setup your Signer +Firstly, create the signer you want to use with your nautilus instance. nautilus uses the ethers.js `Signer`. You can read more about possible configurations in the [official documentation](https://docs.ethers.org/v5/api/signer/). + +```ts twoslash +import { Wallet, providers } from 'ethers' +import { Nautilus } from '@deltadao/nautilus' + +const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') // [!code focus] +const signer = new Wallet('0x...', provider) // [!code focus] +``` + +In this example we create an ethers `Wallet` from a given private key and connect to a RPC provider of our choice. + +### 2. Setup the nautilus instance +Now that you have a Signer set up, you can use it to bootstrap your nautilus client instance. + +``` ts twoslash +import { Wallet, providers } from 'ethers' +import { Nautilus } from '@deltadao/nautilus' + +const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') +const signer = new Wallet('0x...', provider) + +const nautilus = await Nautilus.create(signer) // [!code focus] +``` + +Note, that we use the previously created Wallet and pass it to Nautilus to create the instance with this signer. + +### 3. Interact with the data economy +With the client instance bootstrapped you can now trigger any transactions or access calls supported by OceanProtocol. + +``` ts twoslash +import { Wallet, providers } from 'ethers' +import { Nautilus } from '@deltadao/nautilus' + +const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') +const signer = new Wallet('0x...', provider) + +const nautilus = await Nautilus.create(signer) + +const accessUrl = await nautilus.access({ assetDid: 'did:op:12345'}) // [!code focus] +const data = await fetch(accessUrl) // [!code focus] +``` + +In this example we construct a one-time `accessUrl` and can then use it to fetch the data associated with the respective data service. + +## Next Steps + +For a more complete look at the nautilus interface, you can head to the [`Nautilus` Instance](https://nautilus.delta-dao.com/docs/api/Nautilus) documentation. + +Find dedicated feature documentation by following one of the links below: +- [Download](https://nautilus.delta-dao.com/docs/guides/download) +- [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) +- [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) +- [Editing](https://nautilus.delta-dao.com/docs/guides/edit) + + +If you want to jump straight into code, feel free to take a look at some of our code examples in the [nautilus-examples repository](https://github.com/deltaDAO/nautilus-examples). + +## License + +``` +Copyright ((C)) 2023 deltaDAO AG + +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. +``` From c8c40c72958571d4ab8b59a9d2e8ebaa61ae40d0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 27 Mar 2024 17:15:15 +0000 Subject: [PATCH 2/9] Version Packages --- .changeset/eleven-pans-look.md | 7 ------- .changeset/famous-pots-deny.md | 5 ----- .changeset/lucky-drinks-occur.md | 5 ----- .changeset/pre.json | 15 --------------- .changeset/small-tigers-repeat.md | 6 ------ src/CHANGELOG.md | 16 ++++++++++++++++ src/package.json | 10 +++++++--- 7 files changed, 23 insertions(+), 41 deletions(-) delete mode 100644 .changeset/eleven-pans-look.md delete mode 100644 .changeset/famous-pots-deny.md delete mode 100644 .changeset/lucky-drinks-occur.md delete mode 100644 .changeset/pre.json delete mode 100644 .changeset/small-tigers-repeat.md diff --git a/.changeset/eleven-pans-look.md b/.changeset/eleven-pans-look.md deleted file mode 100644 index d715a39..0000000 --- a/.changeset/eleven-pans-look.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"@deltadao/nautilus": patch ---- - -Fix error in next build -- Fixes an error with starting compute jobs -- Fixes `tslib` dependency issues diff --git a/.changeset/famous-pots-deny.md b/.changeset/famous-pots-deny.md deleted file mode 100644 index e5baf28..0000000 --- a/.changeset/famous-pots-deny.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@deltadao/nautilus": patch ---- - -next release diff --git a/.changeset/lucky-drinks-occur.md b/.changeset/lucky-drinks-occur.md deleted file mode 100644 index 2879342..0000000 --- a/.changeset/lucky-drinks-occur.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@deltadao/nautilus": patch ---- - -bump ocean.js diff --git a/.changeset/pre.json b/.changeset/pre.json deleted file mode 100644 index 9ba8f44..0000000 --- a/.changeset/pre.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "mode": "exit", - "tag": "next", - "initialVersions": { - "docs": "0.1.0", - "@deltadao/nautilus": "1.0.0-beta.2", - "test": "0.0.0" - }, - "changesets": [ - "eleven-pans-look", - "famous-pots-deny", - "lucky-drinks-occur", - "small-tigers-repeat" - ] -} diff --git a/.changeset/small-tigers-repeat.md b/.changeset/small-tigers-repeat.md deleted file mode 100644 index da81804..0000000 --- a/.changeset/small-tigers-repeat.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@deltadao/nautilus': patch ---- - -- add stopCompute functionality -- fix an issue with setting trusted algorithms diff --git a/src/CHANGELOG.md b/src/CHANGELOG.md index 8f7536b..7ab3a30 100644 --- a/src/CHANGELOG.md +++ b/src/CHANGELOG.md @@ -1,5 +1,21 @@ # @deltadao/nautilus +## 1.0.0 + +### Patch Changes + +- [#108](https://github.com/deltaDAO/nautilus/pull/108) [`3e8b148`](https://github.com/deltaDAO/nautilus/commit/3e8b1484fa5656a0a46fc818ca118dfda32786fc) Thanks [@moritzkirstein](https://github.com/moritzkirstein)! - Fix error in next build + + - Fixes an error with starting compute jobs + - Fixes `tslib` dependency issues + +- [#103](https://github.com/deltaDAO/nautilus/pull/103) [`8f71689`](https://github.com/deltaDAO/nautilus/commit/8f71689b3cd4fa02502e01adddfe309afecdf5d2) Thanks [@moritzkirstein](https://github.com/moritzkirstein)! - next release + +- [#106](https://github.com/deltaDAO/nautilus/pull/106) [`399cd55`](https://github.com/deltaDAO/nautilus/commit/399cd55ead131534f0165ef01f698553cb26290d) Thanks [@moritzkirstein](https://github.com/moritzkirstein)! - bump ocean.js + +- [#83](https://github.com/deltaDAO/nautilus/pull/83) [`59b5d93`](https://github.com/deltaDAO/nautilus/commit/59b5d9348ca75300523c9857eba1f99abe441c01) Thanks [@moritzkirstein](https://github.com/moritzkirstein)! - - add stopCompute functionality + - fix an issue with setting trusted algorithms + ## 1.0.0-next.5 ### Patch Changes diff --git a/src/package.json b/src/package.json index 529974d..1337670 100644 --- a/src/package.json +++ b/src/package.json @@ -1,7 +1,7 @@ { "name": "@deltadao/nautilus", "description": "A typescript library enabling automated publish & consume in Ocean Protocol ecosystems", - "version": "1.0.0-next.5", + "version": "1.0.0", "type": "module", "main": "./_cjs/index.js", "module": "./_esm/index.js", @@ -33,7 +33,9 @@ "documents": "./src/**/*.gql.ts", "generates": { "./src/@types/subgraph/api.ts": { - "plugins": ["typescript"] + "plugins": [ + "typescript" + ] }, "./src/": { "preset": "near-operation-file", @@ -41,7 +43,9 @@ "baseTypesPath": "@types/subgraph/api.ts", "extension": ".generated.ts" }, - "plugins": ["typescript-operations"], + "plugins": [ + "typescript-operations" + ], "config": { "omitOperationSuffix": true, "typesPrefix": "I" From ad937ddef94b394b7acbacfd27ee2bed0235aa0e Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 18:40:32 +0100 Subject: [PATCH 3/9] chore: remove link from README --- README.md | 3 --- src/README.md | 3 --- 2 files changed, 6 deletions(-) diff --git a/README.md b/README.md index 8f9283e..0940198 100644 --- a/README.md +++ b/README.md @@ -97,15 +97,12 @@ In this example we construct a one-time `accessUrl` and can then use it to fetch ## Next Steps -For a more complete look at the nautilus interface, you can head to the [`Nautilus` Instance](https://nautilus.delta-dao.com/docs/api/Nautilus) documentation. - Find dedicated feature documentation by following one of the links below: - [Download](https://nautilus.delta-dao.com/docs/guides/download) - [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) - [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) - [Editing](https://nautilus.delta-dao.com/docs/guides/edit) - If you want to jump straight into code, feel free to take a look at some of our code examples in the [nautilus-examples repository](https://github.com/deltaDAO/nautilus-examples). ## License diff --git a/src/README.md b/src/README.md index 8f9283e..0940198 100644 --- a/src/README.md +++ b/src/README.md @@ -97,15 +97,12 @@ In this example we construct a one-time `accessUrl` and can then use it to fetch ## Next Steps -For a more complete look at the nautilus interface, you can head to the [`Nautilus` Instance](https://nautilus.delta-dao.com/docs/api/Nautilus) documentation. - Find dedicated feature documentation by following one of the links below: - [Download](https://nautilus.delta-dao.com/docs/guides/download) - [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) - [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) - [Editing](https://nautilus.delta-dao.com/docs/guides/edit) - If you want to jump straight into code, feel free to take a look at some of our code examples in the [nautilus-examples repository](https://github.com/deltaDAO/nautilus-examples). ## License From 484979de20b0127abc421d247725ad0f048624c5 Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 18:55:10 +0100 Subject: [PATCH 4/9] chore: remove docs changeset --- .changeset/weak-laws-study.md | 5 ----- package-lock.json | 2 +- 2 files changed, 1 insertion(+), 6 deletions(-) delete mode 100644 .changeset/weak-laws-study.md diff --git a/.changeset/weak-laws-study.md b/.changeset/weak-laws-study.md deleted file mode 100644 index dda37e7..0000000 --- a/.changeset/weak-laws-study.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docs": major ---- - -Update docs for version 1 release diff --git a/package-lock.json b/package-lock.json index 2ed5084..335347e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20214,7 +20214,7 @@ }, "src": { "name": "@deltadao/nautilus", - "version": "1.0.0-next.4", + "version": "1.0.0", "license": "Apache-2.0", "dependencies": { "@oceanprotocol/lib": "3.3.0", From c8b4d4d5978a4a48c7a5ab198f82042440d4b9c5 Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 19:08:29 +0100 Subject: [PATCH 5/9] chore: README symlink --- .changeset/fifty-spies-behave.md | 5 ++ README.md | 125 +------------------------------ 2 files changed, 6 insertions(+), 124 deletions(-) create mode 100644 .changeset/fifty-spies-behave.md mode change 100644 => 120000 README.md diff --git a/.changeset/fifty-spies-behave.md b/.changeset/fifty-spies-behave.md new file mode 100644 index 0000000..83af346 --- /dev/null +++ b/.changeset/fifty-spies-behave.md @@ -0,0 +1,5 @@ +--- +"@deltadao/nautilus": patch +--- + +Version Bump diff --git a/README.md b/README.md deleted file mode 100644 index 0940198..0000000 --- a/README.md +++ /dev/null @@ -1,124 +0,0 @@ -
- -

- - - - nautilus logo - - -

- -

- The Data Economy TypeScript Toolkit -

- -

- - - - Version - - - - - - Apache-2.0 License - - - - - - GitHub Actions Workflow Status - - -

- - -A TypeScript library enabling you to explore the Data Economy. It is built on top of [ocean.js](https://github.com/oceanprotocol/ocean.js) and offers feature complete, automated interactions with any [Ocean Protocol](https://oceanprotocol.com) ecosystem. - -## Overview -nautilus addresses many common pain points faced by developers interacting with the data economy by offering a range of features enhancing productivity and efficiency. -You will find a quick introduction on this page to get you setup with the **Data Economy TypeScript Toolkit**. - -Looking for dedicated feature documentations? Follow the links below: -- [Download](https://nautilus.delta-dao.com/docs/guides/download) -- [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) -- [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) -- [Editing](https://nautilus.delta-dao.com/docs/guides/edit) - - -## Quick Start -### 1. Setup your Signer -Firstly, create the signer you want to use with your nautilus instance. nautilus uses the ethers.js `Signer`. You can read more about possible configurations in the [official documentation](https://docs.ethers.org/v5/api/signer/). - -```ts twoslash -import { Wallet, providers } from 'ethers' -import { Nautilus } from '@deltadao/nautilus' - -const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') // [!code focus] -const signer = new Wallet('0x...', provider) // [!code focus] -``` - -In this example we create an ethers `Wallet` from a given private key and connect to a RPC provider of our choice. - -### 2. Setup the nautilus instance -Now that you have a Signer set up, you can use it to bootstrap your nautilus client instance. - -``` ts twoslash -import { Wallet, providers } from 'ethers' -import { Nautilus } from '@deltadao/nautilus' - -const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') -const signer = new Wallet('0x...', provider) - -const nautilus = await Nautilus.create(signer) // [!code focus] -``` - -Note, that we use the previously created Wallet and pass it to Nautilus to create the instance with this signer. - -### 3. Interact with the data economy -With the client instance bootstrapped you can now trigger any transactions or access calls supported by OceanProtocol. - -``` ts twoslash -import { Wallet, providers } from 'ethers' -import { Nautilus } from '@deltadao/nautilus' - -const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') -const signer = new Wallet('0x...', provider) - -const nautilus = await Nautilus.create(signer) - -const accessUrl = await nautilus.access({ assetDid: 'did:op:12345'}) // [!code focus] -const data = await fetch(accessUrl) // [!code focus] -``` - -In this example we construct a one-time `accessUrl` and can then use it to fetch the data associated with the respective data service. - -## Next Steps - -Find dedicated feature documentation by following one of the links below: -- [Download](https://nautilus.delta-dao.com/docs/guides/download) -- [Compute to Data](https://nautilus.delta-dao.com/docs/guides/compute) -- [Publishing](https://nautilus.delta-dao.com/docs/guides/publish) -- [Editing](https://nautilus.delta-dao.com/docs/guides/edit) - -If you want to jump straight into code, feel free to take a look at some of our code examples in the [nautilus-examples repository](https://github.com/deltaDAO/nautilus-examples). - -## License - -``` -Copyright ((C)) 2023 deltaDAO AG - -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. -``` diff --git a/README.md b/README.md new file mode 120000 index 0000000..351df1d --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +src/README.md \ No newline at end of file From f78a848b9d23a682567104d3d79109582a2cd678 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 27 Mar 2024 18:10:53 +0000 Subject: [PATCH 6/9] Version Packages --- .changeset/fifty-spies-behave.md | 5 ----- src/CHANGELOG.md | 6 ++++++ src/package.json | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) delete mode 100644 .changeset/fifty-spies-behave.md diff --git a/.changeset/fifty-spies-behave.md b/.changeset/fifty-spies-behave.md deleted file mode 100644 index 83af346..0000000 --- a/.changeset/fifty-spies-behave.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@deltadao/nautilus": patch ---- - -Version Bump diff --git a/src/CHANGELOG.md b/src/CHANGELOG.md index 7ab3a30..f8d6118 100644 --- a/src/CHANGELOG.md +++ b/src/CHANGELOG.md @@ -1,5 +1,11 @@ # @deltadao/nautilus +## 1.0.1 + +### Patch Changes + +- [`c8b4d4d`](https://github.com/deltaDAO/nautilus/commit/c8b4d4d5978a4a48c7a5ab198f82042440d4b9c5) Thanks [@moritzkirstein](https://github.com/moritzkirstein)! - Version Bump + ## 1.0.0 ### Patch Changes diff --git a/src/package.json b/src/package.json index 1337670..3904fe3 100644 --- a/src/package.json +++ b/src/package.json @@ -1,7 +1,7 @@ { "name": "@deltadao/nautilus", "description": "A typescript library enabling automated publish & consume in Ocean Protocol ecosystems", - "version": "1.0.0", + "version": "1.0.1", "type": "module", "main": "./_cjs/index.js", "module": "./_esm/index.js", From 99a0002b389ead7c6661f9ecb5034d8d1f16dd9d Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 19:29:26 +0100 Subject: [PATCH 7/9] docs: remove sponsors --- docs/pages/index.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index a0262f2..aee5f74 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -157,10 +157,6 @@ We are committed to nautilus as an open-source project. Reach out if you are abl - [deltaDAO contact](mailto:contact@delta-dao.com) -# Sponsors - -::sponsors -
From 2e9590372b648eda02b8b971cc2bc1ebd40f3f26 Mon Sep 17 00:00:00 2001 From: Moritz Kirstein Date: Wed, 27 Mar 2024 19:30:07 +0100 Subject: [PATCH 8/9] docs: update index --- docs/pages/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index aee5f74..4e7afed 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -61,10 +61,10 @@ import { HomePage } from 'vocs/components'
- beta + version
- Version 1.0.0 + 1.0.1
From b14edf93183e33a20aac781a5b8e9fa5b7bd7d1c Mon Sep 17 00:00:00 2001 From: Sebastian Abromeit <38963270+Abrom8@users.noreply.github.com> Date: Mon, 1 Apr 2024 10:53:53 +0200 Subject: [PATCH 9/9] Update README.md --- src/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/README.md b/src/README.md index 0940198..0186856 100644 --- a/src/README.md +++ b/src/README.md @@ -56,8 +56,8 @@ Firstly, create the signer you want to use with your nautilus instance. nautilus import { Wallet, providers } from 'ethers' import { Nautilus } from '@deltadao/nautilus' -const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') // [!code focus] -const signer = new Wallet('0x...', provider) // [!code focus] +const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') +const signer = new Wallet('0x...', provider) ``` In this example we create an ethers `Wallet` from a given private key and connect to a RPC provider of our choice. @@ -72,7 +72,7 @@ import { Nautilus } from '@deltadao/nautilus' const provider = new providers.JsonRpcProvider('https://rpc.dev.pontus-x.eu') const signer = new Wallet('0x...', provider) -const nautilus = await Nautilus.create(signer) // [!code focus] +const nautilus = await Nautilus.create(signer) ``` Note, that we use the previously created Wallet and pass it to Nautilus to create the instance with this signer. @@ -89,8 +89,8 @@ const signer = new Wallet('0x...', provider) const nautilus = await Nautilus.create(signer) -const accessUrl = await nautilus.access({ assetDid: 'did:op:12345'}) // [!code focus] -const data = await fetch(accessUrl) // [!code focus] +const accessUrl = await nautilus.access({ assetDid: 'did:op:12345'}) +const data = await fetch(accessUrl) ``` In this example we construct a one-time `accessUrl` and can then use it to fetch the data associated with the respective data service.