From 863f1674c5bdedf565fdb42f84e3860d924d68dc Mon Sep 17 00:00:00 2001 From: Akshay Patel Date: Sun, 3 Jul 2022 11:29:46 +0000 Subject: [PATCH] GitBook: [#7] Create section: Using Ocean Market --- SUMMARY.md | 17 ++++--- building-with-ocean/introduction.md | 14 ------ .../marketplace-add-liquidity.md | 46 ------------------- .../marketplace-download-data-asset.md | 42 ----------------- building-with-ocean/marketplace-swap.md | 40 ---------------- .../README.md | 11 ++--- .../marketplace-add-liquidity.md | 46 +++++++++++++++++++ .../marketplace-download-data-asset.md | 42 +++++++++++++++++ .../marketplace-publish-data-asset.md | 20 ++++---- marketplace-introduction/marketplace-swap.md | 40 ++++++++++++++++ 10 files changed, 151 insertions(+), 167 deletions(-) delete mode 100644 building-with-ocean/introduction.md delete mode 100644 building-with-ocean/marketplace-add-liquidity.md delete mode 100644 building-with-ocean/marketplace-download-data-asset.md delete mode 100644 building-with-ocean/marketplace-swap.md rename building-with-ocean/marketplace-introduction.md => marketplace-introduction/README.md (68%) create mode 100644 marketplace-introduction/marketplace-add-liquidity.md create mode 100644 marketplace-introduction/marketplace-download-data-asset.md rename {building-with-ocean => marketplace-introduction}/marketplace-publish-data-asset.md (83%) create mode 100644 marketplace-introduction/marketplace-swap.md diff --git a/SUMMARY.md b/SUMMARY.md index 8831d500..3d475439 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,9 +1,6 @@ # Table of contents * [Orientation](README.md) -* [API references](api-references/README.md) - * [Aquarius REST API](api-references/aquarius-rest-api.md) - * [Provider REST API](api-references/provider-rest-api.md) * [Core Concepts](core-concepts/README.md) * [Architecture Overview](core-concepts/architecture.md) * [Asset pricing](core-concepts/asset-pricing.md) @@ -20,6 +17,9 @@ * [Quickstart](core-concepts/quickstart.md) * [Data NFTs and datatoken roles](core-concepts/roles.md) * [Reporting Vulnerabilities](core-concepts/vulnerabilities.md) +* [API references](api-references/README.md) + * [Aquarius REST API](api-references/aquarius-rest-api.md) + * [Provider REST API](api-references/provider-rest-api.md) * [Building with ocean](building-with-ocean/README.md) * [Publish assets using hosting services](building-with-ocean/asset-hosting.md) * [Binance Smart Chain (BSC)](building-with-ocean/bsc-bridge.md) @@ -28,14 +28,13 @@ * [Compute-to-Data](building-with-ocean/compute-to-data-datasets-algorithms.md) * [Setting up private docker registry for Compute-to-Data environment](building-with-ocean/compute-to-data-docker-registry.md) * [Minikube Compute-to-Data Environment](building-with-ocean/compute-to-data-minikube.md) - * [Overview of Tutorials](building-with-ocean/introduction.md) - * [Add liquidity to liquidity pools](building-with-ocean/marketplace-add-liquidity.md) - * [Download a data asset](building-with-ocean/marketplace-download-data-asset.md) - * [Ocean Market](building-with-ocean/marketplace-introduction.md) - * [Publish a data asset](building-with-ocean/marketplace-publish-data-asset.md) - * [Swap datatokens](building-with-ocean/marketplace-swap.md) * [Set Up a Marketplace](building-with-ocean/marketplace.md) * [Set Up MetaMask Wallet](building-with-ocean/metamask-setup.md) * [Polygon (ex Matic)](building-with-ocean/polygon-bridge.md) * [Use Your Wallet to Manage OCEAN Tokens](building-with-ocean/wallets-and-ocean-tokens.md) * [Wallet Basics](building-with-ocean/wallets.md) +* [Using Ocean Market](marketplace-introduction/README.md) + * [Publish a data asset](marketplace-introduction/marketplace-publish-data-asset.md) + * [Download a data asset](marketplace-introduction/marketplace-download-data-asset.md) + * [Add liquidity to liquidity pools](marketplace-introduction/marketplace-add-liquidity.md) + * [Swap datatokens](marketplace-introduction/marketplace-swap.md) diff --git a/building-with-ocean/introduction.md b/building-with-ocean/introduction.md deleted file mode 100644 index c1f7d80b..00000000 --- a/building-with-ocean/introduction.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Overview of Tutorials -description: ---- - -These tutorials cover: - -- Using Web3 wallets with Ocean -- Set up a marketplace -- Run a compute-to-data environment -- Storage setup - Azure, AWS or local -- Fine-grained permissions - - diff --git a/building-with-ocean/marketplace-add-liquidity.md b/building-with-ocean/marketplace-add-liquidity.md deleted file mode 100644 index 26c7da89..00000000 --- a/building-with-ocean/marketplace-add-liquidity.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Add liquidity to liquidity pools -description: Tutorial to add liquidity to Ocean pools using Ocean Market ---- - -## Access marketplace - -1. Go to Ocean Marketplace. -2. Search for the data asset. - The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. - -3. Connect wallet. - - ![connect wallet](images/marketplace/add-liquidity-connect-wallet.png 'Connect wallet') - -## Tutorial - -### Find an asset - -Search for the desired asset published on the Ocean Marketplace. - -### Step 1 - Select pool tab - -After finding the dataset, select **`POOL`** tab and click on **`ADD LIQUIDITY`**. - -![add liquidity part-1](images/marketplace/add-liquidity-1.png 'POOL tab') - -### Step 2 - Liquidity amount - -Enter the amount of OCEAN tokens you want to add. The expected amount of pool shares and percentages for the provided amount will be displayed. - -![add liquidity part-2](images/marketplace/add-liquidity-2.png 'Add liquidity amount') - -### Step 3 - Transaction: Access to OCEAN tokens - -![add liquidity part-3](images/marketplace/add-liquidity-3.png 'Transaction: Approve spend limit') - -### Step 4 - Click supply - -![add liquidity part-4](images/marketplace/add-liquidity-4.png 'SUPPLY liquidity') - -### Step 5 - Transaction: Add liquidty - -![add liquidity part-5](images/marketplace/add-liquidity-5.png 'Transaction: Add liquidity') - -![add liquidity part-6](images/marketplace/add-liquidity-6.png 'View transaction') diff --git a/building-with-ocean/marketplace-download-data-asset.md b/building-with-ocean/marketplace-download-data-asset.md deleted file mode 100644 index 916822eb..00000000 --- a/building-with-ocean/marketplace-download-data-asset.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Download a data asset -description: Tutorial to download assets using Ocean Market ---- - -## Access marketplace - -1. Go to Ocean Marketplace. -2. Search for the data asset. - The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. - -3. Connect wallet. - - ![connect wallet](images/marketplace/consume-connect-wallet.png 'Connect wallet') - - In this tutorial, we will be using the Rinkeby test network. - -## Tutorial - -### Step 1 - Click buy - -The buy button is enabled only if the connected wallet address has enough OCEAN tokens to exchange them with 1 datatoken. - -![consume part-1](images/marketplace/consume-1.png 'Buy') - -### Step 2 - Allow access to OCEAN token(s) - -![consume part-3](images/marketplace/consume-2.png 'Transaction 1: Permissions to access OCEAN tokens') - -### Step 3 - Buy a datatoken by exchanging it with OCEAN token(s) - -![consume part-4](images/marketplace/consume-3.png 'Transaction 2: Buy datatoken') - -### Step 4 - Click download - -![consume part-5](images/marketplace/consume-4.png 'Download asset') - -### Step 5 - Sign message - -After signing the message, the file download will start. - -![consume part-6](images/marketplace/consume-5.png 'Sign') diff --git a/building-with-ocean/marketplace-swap.md b/building-with-ocean/marketplace-swap.md deleted file mode 100644 index 0bcb5ade..00000000 --- a/building-with-ocean/marketplace-swap.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Swap datatokens -description: Tutorial to swap datatokens for OCEAN tokens using Ocean Market ---- - -## Access marketplace - -1. Go to Ocean Marketplace. -2. Search for the data asset. - The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. - -3. Connect wallet. - - ![connect wallet](images/marketplace/consume-connect-wallet.png 'Connect wallet') - -## Tutorial - -### Step 1 - Select TRADE tab - -After finding the dataset, select the **`TRADE`** tab. - -### Step 2 - Trade amount - -Enter the amount of OCEAN tokens to swap. The datatokens amount to receive is displayed with the swap fees information. The reverse operation(swap datatokens to OCEAN tokens) is also available on the trade tab. - -![swap part-1](images/marketplace/Swap-1.png 'Amount of OCEANs to swap') - -### Step 3 - Transaction: Access to OCEAN token(s) - -![swap part-2](images/marketplace/Swap-2.png 'Transaction: Approve spend limit') - -### Step 4 - Click swap - -![swap part-3](images/marketplace/Swap-3.png 'Swap tokens') - -### Step 5 - Transaction: Swap tokens - -![swap part-4](images/marketplace/Swap-4.png 'Transaction: Swap tokens') - -![swap part-5](images/marketplace/Swap-5.png 'View transaction') diff --git a/building-with-ocean/marketplace-introduction.md b/marketplace-introduction/README.md similarity index 68% rename from building-with-ocean/marketplace-introduction.md rename to marketplace-introduction/README.md index dbb0f6eb..89cb1c47 100644 --- a/building-with-ocean/marketplace-introduction.md +++ b/marketplace-introduction/README.md @@ -1,18 +1,17 @@ --- title: Ocean Market -description: --- +# Using Ocean Market + https://v4.market.oceanprotocol.com/ -## Landing page +### Landing page -![marketplace landing-page](images/marketplace/marketplace-landing-page.png 'Approve contract transaction') +![marketplace landing-page](../building-with-ocean/images/marketplace/marketplace-landing-page.png) -## About Ocean Market +### About Ocean Market 1. Ocean Market enables publishers to monetize their data and/or algorithms through blockchain technology. - 2. Consumers can purchase access to data, algorithms, compute services. - 3. Liquidity providers can add their OCEAN tokens to liquidity pools and earn interest on the transactions. diff --git a/marketplace-introduction/marketplace-add-liquidity.md b/marketplace-introduction/marketplace-add-liquidity.md new file mode 100644 index 00000000..825bef53 --- /dev/null +++ b/marketplace-introduction/marketplace-add-liquidity.md @@ -0,0 +1,46 @@ +--- +title: Add liquidity to liquidity pools +description: Tutorial to add liquidity to Ocean pools using Ocean Market +--- + +# Add liquidity to liquidity pools + +### Access marketplace + +1. Go to Ocean [Marketplace](https://v4.market.oceanprotocol.com/). +2. Search for the data asset. The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. +3. Connect wallet. + + connect wallet + +### Tutorial + +#### Find an asset + +Search for the desired asset published on the [Ocean Marketplace](https://v4.market.oceanprotocol.com/). + +#### Step 1 - Select pool tab + +After finding the dataset, select **`POOL`** tab and click on **`ADD LIQUIDITY`**. + +![add liquidity part-1](../building-with-ocean/images/marketplace/add-liquidity-1.png) + +#### Step 2 - Liquidity amount + +Enter the amount of OCEAN tokens you want to add. The expected amount of pool shares and percentages for the provided amount will be displayed. + +![add liquidity part-2](../building-with-ocean/images/marketplace/add-liquidity-2.png) + +#### Step 3 - Transaction: Access to OCEAN tokens + +![add liquidity part-3](../building-with-ocean/images/marketplace/add-liquidity-3.png) + +#### Step 4 - Click supply + +![add liquidity part-4](../building-with-ocean/images/marketplace/add-liquidity-4.png) + +#### Step 5 - Transaction: Add liquidty + +![add liquidity part-5](../building-with-ocean/images/marketplace/add-liquidity-5.png) + +![add liquidity part-6](../building-with-ocean/images/marketplace/add-liquidity-6.png) diff --git a/marketplace-introduction/marketplace-download-data-asset.md b/marketplace-introduction/marketplace-download-data-asset.md new file mode 100644 index 00000000..86a87110 --- /dev/null +++ b/marketplace-introduction/marketplace-download-data-asset.md @@ -0,0 +1,42 @@ +--- +title: Download a data asset +description: Tutorial to download assets using Ocean Market +--- + +# Download a data asset + +### Access marketplace + +1. Go to Ocean [Marketplace](https://v4.market.oceanprotocol.com/). +2. Search for the data asset. The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. +3. Connect wallet. + + connect wallet + + In this tutorial, we will be using the Rinkeby test network. + +### Tutorial + +#### Step 1 - Click buy + +The buy button is enabled only if the connected wallet address has enough OCEAN tokens to exchange them with 1 datatoken. + +![consume part-1](../building-with-ocean/images/marketplace/consume-1.png) + +#### Step 2 - Allow access to OCEAN token(s) + +![consume part-3](../building-with-ocean/images/marketplace/consume-2.png) + +#### Step 3 - Buy a datatoken by exchanging it with OCEAN token(s) + +![consume part-4](../building-with-ocean/images/marketplace/consume-3.png) + +#### Step 4 - Click download + +![consume part-5](../building-with-ocean/images/marketplace/consume-4.png) + +#### Step 5 - Sign message + +After signing the message, the file download will start. + +![consume part-6](../building-with-ocean/images/marketplace/consume-5.png) diff --git a/building-with-ocean/marketplace-publish-data-asset.md b/marketplace-introduction/marketplace-publish-data-asset.md similarity index 83% rename from building-with-ocean/marketplace-publish-data-asset.md rename to marketplace-introduction/marketplace-publish-data-asset.md index 13da9494..a70d4be3 100644 --- a/building-with-ocean/marketplace-publish-data-asset.md +++ b/marketplace-introduction/marketplace-publish-data-asset.md @@ -16,12 +16,12 @@ Ocean Market provides a convenient interface for individuals and organizations t 1. Go to [Ocean Market](https://v4.market.oceanprotocol.com) 2. Connect wallet. - connect wallet + connect wallet In this tutorial, we will be using the Rinkeby test network. 3. Go to the publish page. - publish page + publish page #### Step 1 - Metadata @@ -45,7 +45,7 @@ _Mandatory fields are marked with \*_ Tags help the asset to be discoverable. If not provided, the list of tags is empty by default. -![publish part-1](images/marketplace/publish-1.png) +![publish part-1](../building-with-ocean/images/marketplace/publish-1.png) #### Step 2 - Access details @@ -71,7 +71,7 @@ _Mandatory fields are marked with \*_ This field specifies how long the buyer can access the dataset after the dataset is purchased. This field is editable after the asset publication. -![publish part-2](images/marketplace/publish-2.png) +![publish part-2](../building-with-ocean/images/marketplace/publish-2.png) #### Step 3 - Pricing @@ -95,31 +95,31 @@ The publisher can also change the **Swap Fee** of the liquidity pool. For a deep dive into the fee structure, please refer to this [document](../concepts/fees/). -![publish part-3](images/marketplace/publish-3.png) +![publish part-3](../building-with-ocean/images/marketplace/publish-3.png) #### Step 4 - Preview -![publish part-4](images/marketplace/publish-4.png) +![publish part-4](../building-with-ocean/images/marketplace/publish-4.png) #### Step 5 - Blockchain transactions -![publish part-5](images/marketplace/publish-5.png) +![publish part-5](../building-with-ocean/images/marketplace/publish-5.png) \ -![publish part-6](images/marketplace/publish-6.png) +![publish part-6](../building-with-ocean/images/marketplace/publish-6.png) \ -![publish part-7](images/marketplace/publish-7.png) +![publish part-7](../building-with-ocean/images/marketplace/publish-7.png) #### Confirmation Now, the asset is successfully published and available in the Ocean Market. -![publish success](images/marketplace/publish-8.png) +![publish success](../building-with-ocean/images/marketplace/publish-8.png) On the [profile page](https://v4.market.oceanprotocol.com/profile), the publisher has access to all his published assets. diff --git a/marketplace-introduction/marketplace-swap.md b/marketplace-introduction/marketplace-swap.md new file mode 100644 index 00000000..0a862fcb --- /dev/null +++ b/marketplace-introduction/marketplace-swap.md @@ -0,0 +1,40 @@ +--- +title: Swap datatokens +description: Tutorial to swap datatokens for OCEAN tokens using Ocean Market +--- + +# Swap datatokens + +### Access marketplace + +1. Go to Ocean [Marketplace](https://v4.market.oceanprotocol.com/). +2. Search for the data asset. The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date. +3. Connect wallet. + + connect wallet + +### Tutorial + +#### Step 1 - Select TRADE tab + +After finding the dataset, select the **`TRADE`** tab. + +#### Step 2 - Trade amount + +Enter the amount of OCEAN tokens to swap. The datatokens amount to receive is displayed with the swap fees information. The reverse operation(swap datatokens to OCEAN tokens) is also available on the trade tab. + +![swap part-1](../building-with-ocean/images/marketplace/Swap-1.png) + +#### Step 3 - Transaction: Access to OCEAN token(s) + +![swap part-2](../building-with-ocean/images/marketplace/Swap-2.png) + +#### Step 4 - Click swap + +![swap part-3](../building-with-ocean/images/marketplace/Swap-3.png) + +#### Step 5 - Transaction: Swap tokens + +![swap part-4](../building-with-ocean/images/marketplace/Swap-4.png) + +![swap part-5](../building-with-ocean/images/marketplace/Swap-5.png)