mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GitBook: [#8] Re-organize content in Orientation section
This commit is contained in:
Akshay Patel
gitbook-bot
parent
863f1674c5
commit
92893cc738
16
SUMMARY.md
16
SUMMARY.md
@ -1,6 +1,9 @@
|
|||||||
# Table of contents
|
# Table of contents
|
||||||
|
|
||||||
* [Orientation](README.md)
|
* [Orientation](README.md)
|
||||||
|
* [Wallet Basics](introduction/wallets.md)
|
||||||
|
* [Set Up MetaMask Wallet](introduction/metamask-setup.md)
|
||||||
|
* [Use Your Wallet to Manage OCEAN Tokens](introduction/wallets-and-ocean-tokens.md)
|
||||||
* [Core Concepts](core-concepts/README.md)
|
* [Core Concepts](core-concepts/README.md)
|
||||||
* [Architecture Overview](core-concepts/architecture.md)
|
* [Architecture Overview](core-concepts/architecture.md)
|
||||||
* [Asset pricing](core-concepts/asset-pricing.md)
|
* [Asset pricing](core-concepts/asset-pricing.md)
|
||||||
@ -29,12 +32,9 @@
|
|||||||
* [Setting up private docker registry for Compute-to-Data environment](building-with-ocean/compute-to-data-docker-registry.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)
|
* [Minikube Compute-to-Data Environment](building-with-ocean/compute-to-data-minikube.md)
|
||||||
* [Set Up a Marketplace](building-with-ocean/marketplace.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)
|
* [Polygon (ex Matic)](building-with-ocean/polygon-bridge.md)
|
||||||
* [Use Your Wallet to Manage OCEAN Tokens](building-with-ocean/wallets-and-ocean-tokens.md)
|
* [Using Ocean Market](building-with-ocean/marketplace-introduction.md)
|
||||||
* [Wallet Basics](building-with-ocean/wallets.md)
|
* [Publish a data asset](building-with-ocean/marketplace-publish-data-asset.md)
|
||||||
* [Using Ocean Market](marketplace-introduction/README.md)
|
* [Download a data asset](building-with-ocean/marketplace-download-data-asset.md)
|
||||||
* [Publish a data asset](marketplace-introduction/marketplace-publish-data-asset.md)
|
* [Add liquidity to liquidity pools](building-with-ocean/marketplace-add-liquidity.md)
|
||||||
* [Download a data asset](marketplace-introduction/marketplace-download-data-asset.md)
|
* [Swap datatokens](building-with-ocean/marketplace-swap.md)
|
||||||
* [Add liquidity to liquidity pools](marketplace-introduction/marketplace-add-liquidity.md)
|
|
||||||
* [Swap datatokens](marketplace-introduction/marketplace-swap.md)
|
|
||||||
|
|||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
title: Add liquidity to liquidity pools
|
|
||||||
description: Tutorial to add liquidity to Ocean pools using Ocean Market
|
description: Tutorial to add liquidity to Ocean pools using Ocean Market
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -11,7 +10,7 @@ description: Tutorial to add liquidity to Ocean pools using Ocean Market
|
|||||||
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.
|
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.
|
3. Connect wallet.
|
||||||
|
|
||||||
<img src="../building-with-ocean/images/marketplace/add-liquidity-connect-wallet.png" alt="connect wallet" data-size="original">
|
<img src="images/marketplace/add-liquidity-connect-wallet.png" alt="connect wallet" data-size="original">
|
||||||
|
|
||||||
### Tutorial
|
### Tutorial
|
||||||
|
|
||||||
@ -23,24 +22,24 @@ Search for the desired asset published on the [Ocean Marketplace](https://v4.mar
|
|||||||
|
|
||||||
After finding the dataset, select **`POOL`** tab and click on **`ADD LIQUIDITY`**.
|
After finding the dataset, select **`POOL`** tab and click on **`ADD LIQUIDITY`**.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 2 - Liquidity amount
|
#### 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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 3 - Transaction: Access to OCEAN tokens
|
#### Step 3 - Transaction: Access to OCEAN tokens
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 4 - Click supply
|
#### Step 4 - Click supply
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 5 - Transaction: Add liquidty
|
#### Step 5 - Transaction: Add liquidty
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
title: Download a data asset
|
|
||||||
description: Tutorial to download assets using Ocean Market
|
description: Tutorial to download assets using Ocean Market
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -11,7 +10,7 @@ description: Tutorial to download assets using Ocean Market
|
|||||||
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.
|
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.
|
3. Connect wallet.
|
||||||
|
|
||||||
<img src="../building-with-ocean/images/marketplace/consume-connect-wallet.png" alt="connect wallet" data-size="original">
|
<img src="images/marketplace/consume-connect-wallet.png" alt="connect wallet" data-size="original">
|
||||||
|
|
||||||
In this tutorial, we will be using the Rinkeby test network.
|
In this tutorial, we will be using the Rinkeby test network.
|
||||||
|
|
||||||
@ -21,22 +20,22 @@ description: Tutorial to download assets using Ocean Market
|
|||||||
|
|
||||||
The buy button is enabled only if the connected wallet address has enough OCEAN tokens to exchange them with 1 datatoken.
|
The buy button is enabled only if the connected wallet address has enough OCEAN tokens to exchange them with 1 datatoken.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 2 - Allow access to OCEAN token(s)
|
#### Step 2 - Allow access to OCEAN token(s)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 3 - Buy a datatoken by exchanging it with OCEAN token(s)
|
#### Step 3 - Buy a datatoken by exchanging it with OCEAN token(s)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 4 - Click download
|
#### Step 4 - Click download
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 5 - Sign message
|
#### Step 5 - Sign message
|
||||||
|
|
||||||
After signing the message, the file download will start.
|
After signing the message, the file download will start.
|
||||||
|
|
||||||
|
|
||||||
@ -1,14 +1,10 @@
|
|||||||
---
|
|
||||||
title: Ocean Market
|
|
||||||
---
|
|
||||||
|
|
||||||
# Using Ocean Market
|
# Using Ocean Market
|
||||||
|
|
||||||
https://v4.market.oceanprotocol.com/
|
https://v4.market.oceanprotocol.com/
|
||||||
|
|
||||||
### Landing page
|
### Landing page
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### About Ocean Market
|
### About Ocean Market
|
||||||
|
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
title: Publish a data asset
|
|
||||||
description: Tutorial to publish assets using the Ocean Market
|
description: Tutorial to publish assets using the Ocean Market
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -16,12 +15,12 @@ Ocean Market provides a convenient interface for individuals and organizations t
|
|||||||
1. Go to [Ocean Market](https://v4.market.oceanprotocol.com)
|
1. Go to [Ocean Market](https://v4.market.oceanprotocol.com)
|
||||||
2. Connect wallet.
|
2. Connect wallet.
|
||||||
|
|
||||||
<img src="../building-with-ocean/images/marketplace/connect-wallet.png" alt="connect wallet" data-size="original">
|
<img src="images/marketplace/connect-wallet.png" alt="connect wallet" data-size="original">
|
||||||
|
|
||||||
In this tutorial, we will be using the Rinkeby test network.
|
In this tutorial, we will be using the Rinkeby test network.
|
||||||
3. Go to the publish page.
|
3. Go to the publish page.
|
||||||
|
|
||||||
<img src="../building-with-ocean/images/marketplace/publish.png" alt="publish page" data-size="original">
|
<img src="images/marketplace/publish.png" alt="publish page" data-size="original">
|
||||||
|
|
||||||
#### Step 1 - Metadata
|
#### Step 1 - Metadata
|
||||||
|
|
||||||
@ -45,7 +44,7 @@ _Mandatory fields are marked with \*_
|
|||||||
|
|
||||||
Tags help the asset to be discoverable. If not provided, the list of tags is empty by default.
|
Tags help the asset to be discoverable. If not provided, the list of tags is empty by default.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 2 - Access details
|
#### Step 2 - Access details
|
||||||
|
|
||||||
@ -71,7 +70,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.
|
This field specifies how long the buyer can access the dataset after the dataset is purchased. This field is editable after the asset publication.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 3 - Pricing
|
#### Step 3 - Pricing
|
||||||
|
|
||||||
@ -95,31 +94,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/).
|
For a deep dive into the fee structure, please refer to this [document](../concepts/fees/).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 4 - Preview
|
#### Step 4 - Preview
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 5 - Blockchain transactions
|
#### Step 5 - Blockchain transactions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\
|
\
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\
|
\
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Confirmation
|
#### Confirmation
|
||||||
|
|
||||||
Now, the asset is successfully published and available in the Ocean Market.
|
Now, the asset is successfully published and available in the Ocean Market.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
On the [profile page](https://v4.market.oceanprotocol.com/profile), the publisher has access to all his published assets.
|
On the [profile page](https://v4.market.oceanprotocol.com/profile), the publisher has access to all his published assets.
|
||||||
|
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
title: Swap datatokens
|
|
||||||
description: Tutorial to swap datatokens for OCEAN tokens using Ocean Market
|
description: Tutorial to swap datatokens for OCEAN tokens using Ocean Market
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -11,7 +10,7 @@ description: Tutorial to swap datatokens for OCEAN tokens using Ocean Market
|
|||||||
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.
|
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.
|
3. Connect wallet.
|
||||||
|
|
||||||
<img src="../building-with-ocean/images/marketplace/consume-connect-wallet.png" alt="connect wallet" data-size="original">
|
<img src="images/marketplace/consume-connect-wallet.png" alt="connect wallet" data-size="original">
|
||||||
|
|
||||||
### Tutorial
|
### Tutorial
|
||||||
|
|
||||||
@ -23,18 +22,18 @@ After finding the dataset, select the **`TRADE`** tab.
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 3 - Transaction: Access to OCEAN token(s)
|
#### Step 3 - Transaction: Access to OCEAN token(s)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 4 - Click swap
|
#### Step 4 - Click swap
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Step 5 - Transaction: Swap tokens
|
#### Step 5 - Transaction: Swap tokens
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,52 +0,0 @@
|
|||||||
---
|
|
||||||
title: Set Up MetaMask Wallet
|
|
||||||
description: Tutorial about how to set up MetaMask for Chrome.
|
|
||||||
---
|
|
||||||
|
|
||||||
> MetaMask can also be used with a TREZOR or Ledger hardware wallet but we don't cover those options below; see [the MetaMask documentation](https://metamask.zendesk.com/hc/en-us/articles/360020394612-How-to-connect-a-Trezor-or-Ledger-Hardware-Wallet).
|
|
||||||
|
|
||||||
## MetaMask Set Up Steps
|
|
||||||
|
|
||||||
1. Go to the [Chrome Web Store for extensions](https://chrome.google.com/webstore/category/extensions) and search for MetaMask.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Install MetaMask. The wallet provides a friendly user interface that will help you through each step. MetaMask gives you two options: importing an existing wallet or creating a new one. Choose to `Create a Wallet`:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- In the next step create a new password for your wallet. Read through and accept the terms and conditions. After that, MetaMask will generate Secret Backup Phrase for you. Write it down and store it in a safe place.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Continue forward. On the next page, MetaMask will ask you to confirm the backup phrase. Select the words in the correct sequence:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Voila! Your account is now created. You can access MetaMask via the browser extension in the top right corner of your browser.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- You can now manage Ether and Ocean Tokens with your wallet. You can copy your account address to the clipboard from the options. When you want someone to send Ether or Ocean Tokens to you, you will have to give them that address. It's not a secret.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
You can also watch our [tutorial video snippets](https://www.youtube.com/playlist?list=PL_dn0wVs9kWolBCbtHaFxsi408cumOeth) if you want more help setting up MetaMask.
|
|
||||||
|
|
||||||
## Set Up Custom Network
|
|
||||||
|
|
||||||
Sometimes it is required to use custom or external networks in MetaMask. We can add a new one through MetaMask's Settings.
|
|
||||||
|
|
||||||
Open the Settings menu and find the `Networks` option. When you open it, you'll be able to see all available networks your MetaMask wallet currently use. Click the `Add Network` button.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
There are a few empty inputs we need to fill:
|
|
||||||
|
|
||||||
- **Network Name:** this is the name that MetaMask is going to use to differentiate your network from the rest.
|
|
||||||
- **New RPC URL:** to operate with a network we need an endpoint (RPC). This can be a public or private URL.
|
|
||||||
- **Chain Id:** each chain has an Id
|
|
||||||
- **Currency Symbol:** it's the currency symbol MetaMask uses for your network
|
|
||||||
- **Block Explorer URL:** MetaMask uses this to provide a direct link to the network block explorer when a new transaction happens
|
|
||||||
|
|
||||||
When all the inputs are filled just click `Save`. MetaMask will automatically switch to the new network.
|
|
||||||
50
introduction/metamask-setup.md
Normal file
50
introduction/metamask-setup.md
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
title: Set Up MetaMask Wallet
|
||||||
|
description: Tutorial about how to set up MetaMask for Chrome.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Set Up MetaMask Wallet
|
||||||
|
|
||||||
|
> MetaMask can also be used with a TREZOR or Ledger hardware wallet but we don't cover those options below; see [the MetaMask documentation](https://metamask.zendesk.com/hc/en-us/articles/360020394612-How-to-connect-a-Trezor-or-Ledger-Hardware-Wallet).
|
||||||
|
|
||||||
|
### MetaMask Set Up Steps
|
||||||
|
|
||||||
|
1. Go to the [Chrome Web Store for extensions](https://chrome.google.com/webstore/category/extensions) and search for MetaMask.
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/metamask-chrome-extension.png" alt="metamask-chrome-store" data-size="original">
|
||||||
|
|
||||||
|
* Install MetaMask. The wallet provides a friendly user interface that will help you through each step. MetaMask gives you two options: importing an existing wallet or creating a new one. Choose to `Create a Wallet`:
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/create-new-metamask-wallet.png" alt="Create a wallet" data-size="original">
|
||||||
|
* In the next step create a new password for your wallet. Read through and accept the terms and conditions. After that, MetaMask will generate Secret Backup Phrase for you. Write it down and store it in a safe place.
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/secret-backup-phrase.png" alt="Secret Backup Phrase" data-size="original">
|
||||||
|
* Continue forward. On the next page, MetaMask will ask you to confirm the backup phrase. Select the words in the correct sequence:
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/confirm-backup-phrase.png" alt="Confirm secret backup phrase" data-size="original">
|
||||||
|
* Voila! Your account is now created. You can access MetaMask via the browser extension in the top right corner of your browser.
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/metamask-browser-extension.png" alt="MetaMask browser extension" data-size="original">
|
||||||
|
* You can now manage Ether and Ocean Tokens with your wallet. You can copy your account address to the clipboard from the options. When you want someone to send Ether or Ocean Tokens to you, you will have to give them that address. It's not a secret.
|
||||||
|
|
||||||
|
<img src="../building-with-ocean/images/manage-tokens.png" alt="Manage tokens" data-size="original">
|
||||||
|
|
||||||
|
You can also watch our [tutorial video snippets](https://www.youtube.com/playlist?list=PL\_dn0wVs9kWolBCbtHaFxsi408cumOeth) if you want more help setting up MetaMask.
|
||||||
|
|
||||||
|
### Set Up Custom Network
|
||||||
|
|
||||||
|
Sometimes it is required to use custom or external networks in MetaMask. We can add a new one through MetaMask's Settings.
|
||||||
|
|
||||||
|
Open the Settings menu and find the `Networks` option. When you open it, you'll be able to see all available networks your MetaMask wallet currently use. Click the `Add Network` button.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
There are a few empty inputs we need to fill:
|
||||||
|
|
||||||
|
* **Network Name:** this is the name that MetaMask is going to use to differentiate your network from the rest.
|
||||||
|
* **New RPC URL:** to operate with a network we need an endpoint (RPC). This can be a public or private URL.
|
||||||
|
* **Chain Id:** each chain has an Id
|
||||||
|
* **Currency Symbol:** it's the currency symbol MetaMask uses for your network
|
||||||
|
* **Block Explorer URL:** MetaMask uses this to provide a direct link to the network block explorer when a new transaction happens
|
||||||
|
|
||||||
|
When all the inputs are filled just click `Save`. MetaMask will automatically switch to the new network.
|
||||||
Loading…
Reference in New Issue
Block a user