Porting marketplace launchpad content (#1063)
* Adding content for forking and customise and deploying marketplace * removing mdx tags * Adding FAQ page * COnverting mdx to md in FAQ file * Updating SUMMARY with new pages + creating readme for market creation guide * Updating links * Removing mdx tag from readme content * Saving images * Updating image paths * Removing references to dynamic pricing from faq * Removing liquidity pool question from faq * Removing staking question from faq * Removing references to staking * Fixing images in forking ocean market guide * Updating answer to roadmap question in FAQs * Updating ocean market repo link * Updating inmages & Removing references to pool envs * updating link to deployed site * Updating test in forking Ocean Market section
BIN
.gitbook/assets/market-customisation-1.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
.gitbook/assets/market-customisation-10.1.png
Normal file
After Width: | Height: | Size: 154 KiB |
BIN
.gitbook/assets/market-customisation-10.2.png
Normal file
After Width: | Height: | Size: 125 KiB |
BIN
.gitbook/assets/market-customisation-11.1.png
Normal file
After Width: | Height: | Size: 149 KiB |
BIN
.gitbook/assets/market-customisation-12.png
Normal file
After Width: | Height: | Size: 148 KiB |
BIN
.gitbook/assets/market-customisation-13.png
Normal file
After Width: | Height: | Size: 147 KiB |
BIN
.gitbook/assets/market-customisation-14.png
Normal file
After Width: | Height: | Size: 88 KiB |
BIN
.gitbook/assets/market-customisation-15.png
Normal file
After Width: | Height: | Size: 46 KiB |
BIN
.gitbook/assets/market-customisation-18.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
.gitbook/assets/market-customisation-19.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
.gitbook/assets/market-customisation-2.png
Normal file
After Width: | Height: | Size: 186 KiB |
BIN
.gitbook/assets/market-customisation-20.png
Normal file
After Width: | Height: | Size: 58 KiB |
BIN
.gitbook/assets/market-customisation-21.png
Normal file
After Width: | Height: | Size: 9.4 KiB |
BIN
.gitbook/assets/market-customisation-22.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
.gitbook/assets/market-customisation-23.png
Normal file
After Width: | Height: | Size: 39 KiB |
BIN
.gitbook/assets/market-customisation-24.png
Normal file
After Width: | Height: | Size: 83 KiB |
BIN
.gitbook/assets/market-customisation-25.png
Normal file
After Width: | Height: | Size: 41 KiB |
BIN
.gitbook/assets/market-customisation-3.png
Normal file
After Width: | Height: | Size: 323 KiB |
BIN
.gitbook/assets/market-customisation-4.1.png
Normal file
After Width: | Height: | Size: 345 KiB |
BIN
.gitbook/assets/market-customisation-4.2.jpg
Normal file
After Width: | Height: | Size: 63 KiB |
BIN
.gitbook/assets/market-customisation-4.png
Normal file
After Width: | Height: | Size: 346 KiB |
BIN
.gitbook/assets/market-customisation-5.png
Normal file
After Width: | Height: | Size: 48 KiB |
BIN
.gitbook/assets/market-customisation-6.1.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
.gitbook/assets/market-customisation-6.png
Normal file
After Width: | Height: | Size: 93 KiB |
BIN
.gitbook/assets/market-customisation-7.1.png
Normal file
After Width: | Height: | Size: 7.9 KiB |
BIN
.gitbook/assets/market-customisation-8.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
.gitbook/assets/market-forking-1.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
.gitbook/assets/market-forking-2.png
Normal file
After Width: | Height: | Size: 186 KiB |
@ -6,8 +6,6 @@ description: Ocean Protocol - Tools for the Web3 Data Economy
|
||||
|
||||
In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more.
|
||||
|
||||
OCEAN token is used for staking, and more. [Here](https://oceanprotocol.com/token) are details.
|
||||
|
||||
Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi.
|
||||
|
||||
**Build Data Markets.** Use Ocean Protocol software tools to build your own data marketplace, by either forking [Ocean Market](https://v4.market.oceanprotocol.com/) code or building up with Ocean components.
|
||||
|
@ -4,6 +4,7 @@
|
||||
* [Wallet Basics](building-with-ocean/wallets.md)
|
||||
* [Set Up MetaMask Wallet](orientation/metamask-setup.md)
|
||||
* [Manage Your OCEAN Tokens](building-with-ocean/wallets-and-ocean-tokens.md)
|
||||
* [FAQ](orientation/faq.md)
|
||||
* [Core Concepts](core-concepts/README.md)
|
||||
* [Architecture Overview](core-concepts/architecture.md)
|
||||
* [Data NFTs and Datatokens](core-concepts/datanft-and-datatoken.md)
|
||||
@ -18,7 +19,10 @@
|
||||
* [Download a data asset](using-ocean-market/marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](building-with-ocean/asset-hosting.md)
|
||||
* [Building with ocean](building-with-ocean/README.md)
|
||||
* [Set Up a Marketplace](building-with-ocean/marketplace.md)
|
||||
* [Build a Marketplace](building-with-ocean/build-a-marketplace/README.md)
|
||||
* [Forking Ocean Market](building-with-ocean/build-a-marketplace/forking-ocean-market.md)
|
||||
* [Customising your market](building-with-ocean/build-a-marketplace/customising-your-market.md)
|
||||
* [Deploying your market](building-with-ocean/build-a-marketplace/deploying-market.md)
|
||||
* [Compute-to-Data](building-with-ocean/compute-to-data/README.md)
|
||||
* [Architecture](building-with-ocean/compute-to-data/compute-to-data-architecture.md)
|
||||
* [Datasets & Algorithms](building-with-ocean/compute-to-data/compute-to-data-datasets-algorithms.md)
|
||||
|
50
building-with-ocean/build-a-marketplace/README.md
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Forking Ocean Market
|
||||
description: Forking and customizing Ocean Market (Frontend)
|
||||
featuredImage: images/creatures/mantaray/mantaray-full@2x.png
|
||||
---
|
||||
|
||||
# 🐟 Forking and customizing Ocean Market
|
||||
|
||||
## Outcome
|
||||
|
||||
Your own fully functioning customized fork of Ocean Market is deployed and working.
|
||||
|
||||
## Introduction
|
||||
|
||||
Have you ever thought about monetizing digital assets over the blockchain? Your first instinct might be to head on over to a popular marketplace - but why not create your own marketplace? It’s a lot easier than you might imagine. This guide will cover everything you need to start your own blockchain marketplace in less than an hour. The reason it’s so easy is that we’ll be starting with a fork of Ocean Market, which provides us with some pretty cool tech under-the-hood (if you’re interested in blockchain, read on).
|
||||
|
||||
Using Ocean Market is already a big improvement on the alternatives that are out there, but it gets even better. Ocean Market is completely open-source and freely available under the Apache 2 license. This means that you can fork Ocean Market and set up your own marketplace in just a few steps. Ocean Market is primarily focused on monetizing data, but it can actually handle the sale of any digital asset. This guide will walk you through the process of forking Ocean Market and starting your own marketplace for selling photos; you’ll be surprised how easy it is. No prior blockchain knowledge is required!
|
||||
|
||||
## Content
|
||||
|
||||
The tutorial covers:
|
||||
|
||||
- Forking and running Ocean Market locally
|
||||
- Customising your fork of Ocean market
|
||||
- Quick deployment of Ocean Market
|
||||
|
||||
|
||||
## Preparation
|
||||
|
||||
**Prior knowledge**
|
||||
|
||||
If you’re completely unfamiliar with Ocean Market or web3 applications in general, you will benefit from reading these guides first:
|
||||
|
||||
- To use your clone of Ocean Market, you’ll need a [wallet](https://docs.oceanprotocol.com/tutorials/wallets/). We recommend [getting set up with metamask](https://docs.oceanprotocol.com/tutorials/metamask-setup/).
|
||||
|
||||
- You’ll also need some [Ocean tokens on a testnet](https://docs.oceanprotocol.com/tutorials/wallets-and-ocean-tokens/) to use your marketplace.
|
||||
|
||||
- When you have the testnet tokens, have a go at [publishing a data asset](https://docs.oceanprotocol.com/tutorials/marketplace-publish-data-asset/) on Ocean Market.
|
||||
|
||||
- Run through the process of [consuming a data asset](https://docs.oceanprotocol.com/tutorials/marketplace-consume-data-asset/) on Ocean Market.
|
||||
|
||||
**Required Prerequisites**
|
||||
|
||||
- Git. Instructions for installing Git can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
|
||||
|
||||
- Node.js can be downloaded from [here](https://nodejs.org/en/download/) (we’re using version 16 in this guide)
|
||||
|
||||
- A decent code editor, such as [Visual Studio Code](https://code.visualstudio.com/).
|
||||
|
||||
- You’ll need a Github account to fork Ocean market via [Github](https://github.com/).
|
@ -0,0 +1,182 @@
|
||||
---
|
||||
title: Customising Your Market
|
||||
order: 2
|
||||
hideLanguageSelector: true
|
||||
description: Step by step guide to customizing your fork of Ocean market
|
||||
featuredImage: images/creatures/mantaray/mantaray-full@2x.png
|
||||
---
|
||||
|
||||
# Customizing your fork of Ocean market
|
||||
|
||||
So you’ve got a fully functioning data marketplace at this point, which is pretty cool. But it doesn’t really look like your data marketplace. Right now, it’s still just a clone of Ocean Market — the same branding, name, logo, etc. The next few steps focus on personalizing your data marketplace.
|
||||
|
||||
- Change your Market Name
|
||||
|
||||
- Change the Logo
|
||||
|
||||
- Change the Styling
|
||||
|
||||
- Edit the Publish Form
|
||||
|
||||
- Change the Fee Address
|
||||
|
||||
- Build and host your Data Marketplace
|
||||
|
||||
## Change your Market Name
|
||||
|
||||
It’s now time to open up your favorite code editor and start getting stuck into the code. The first thing we will be doing is changing the name of your marketplace. A decent code editor (such as VS Code) makes this incredibly simple by searching and replacing all the places where the name appears.
|
||||
|
||||
Let’s start by searching and replacing “Ocean Marketplace”. In VS Code there is a magnifying glass symbol in the left-hand panel (arrow 1 in the image below) that will open up the interface for searching and replacing text. Type “Ocean Marketplace” into the first textbox, and the name of your marketplace into the second textbox (arrow 2). To make things simple, there is a button to the right of the second textbox (arrow 3) that will replace all instances at once. You can take a moment to review all the text you’re changing if you wish, and then click this button.
|
||||
|
||||
![Market Customisation](../../.gitbook/assets/market-customisation-3.png)
|
||||
|
||||
Next up, we need to repeat the process but this time we’ll be searching and replacing “Ocean Market”. As you can see in the screenshot below, we have called our fork “Crypto Photos Market”.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-4.png)
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-4.1.png)
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-4.2.jpg)
|
||||
|
||||
Now let’s change the tagline of your site. Open up the folder called “content” and then open the file called “site.json”.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-5.png)
|
||||
|
||||
On line 3 in this file you can enter the tagline that you want for your marketplace.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-6.png)
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-6.1.png)
|
||||
|
||||
## Change the Logo
|
||||
|
||||
The next important step to personalizing your marketplace is setting your own logo. We highly recommend using your logo in SVG format for this. The site logo is stored in the following location:
|
||||
|
||||
```
|
||||
src/@images/logo.svg
|
||||
```
|
||||
|
||||
Delete the “logo.svg” file from that folder and paste your own logo in the same folder. Then, if you rename your logo “logo.svg” everything will work without any problems.
|
||||
|
||||
At this point, it’s a good idea to check how things are looking. First check that you have saved all of your changes, then cancel the build that’s running in your terminal (Ctrl + C OR Cmnd + C) and start it again `npm start`. Once the build has finished, navigate to http://localhost:8000/ and see how things look.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-7.1.png)
|
||||
|
||||
Awesome! Our logo is looking great!
|
||||
|
||||
## Change the Styling
|
||||
|
||||
Hopefully, you like our pink and purple branding, but we don’t expect you to keep it in your own marketplace. This step focuses on applying your own brand colors and styles.
|
||||
|
||||
### Background
|
||||
|
||||
Let’s start with the background. Open up the following CSS file:
|
||||
|
||||
```
|
||||
src/components/App/index.module.css
|
||||
```
|
||||
|
||||
You’ll notice in the screenshot above that we are setting our “wave” background on line 3. Here, you’ll want to use your own background color or image. For this example, we’ll use an SVG background from [here](https://www.svgbackgrounds.com/). First, we save the new background image into the src/images/ folder (same folder as the logo), then we change the CSS to the file location of the new background (see line 3 in the image below).
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-8.png)
|
||||
|
||||
If we save this file and view the site at this point, we get a white section at the top (see image below). And you’ll also notice that the background doesn’t fill all the way down to the bottom of the screen.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-10.1.png)
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-10.2.png)
|
||||
|
||||
To fix this, we need to change the starting position of the background image and change it from no-repeat to repeat. We can do this on line 3.
|
||||
|
||||
When we view our marketplace, we can see that the new background starts at the top and fills the whole page. Perfect!
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-11.1.png)
|
||||
|
||||
## Brand Colors
|
||||
|
||||
Next up, let’s change the background colors to match your individual style. Open up the following file: src/global/\_variables.css. Here you’ll see the global style colors that are set. Now is the time to get creative, or consult your brand handbook (if you already have one).
|
||||
|
||||
You can change these colors as much as you wish until you’re happy with how everything looks. Each time you save your changes, the site will immediately update so you can see how things look. You can see the styles chosen for this example in the image below.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-12.png)
|
||||
|
||||
## Change Fonts
|
||||
|
||||
The final part of the styling that we’ll alter in this guide is the fonts. This is an important step because the font used in Ocean Market is one of the few elements of the market that are copyright protected. If you want to use the same font you’ll need to purchase a license. The other copyrighted elements are the logo and the name — which we have already changed.
|
||||
|
||||
If you don’t already have a brand font, head over to Google Fonts to pick some fonts that suit the brand you’re trying to create. Google makes it nice and easy to see how they’ll look, and it’s simple to import them into your project.
|
||||
|
||||
The global fonts are set in the same file as the colors, scroll down and you’ll see them on lines 36 to 41.
|
||||
|
||||
If you are importing fonts, such as from Google fonts, you need to make sure that you include the import statement at the top of the \_variables.css file.
|
||||
|
||||
As with the color changes, it’s a good idea to save the file with each change and check if the site is looking the way that you expected it to. You can see our eclectic choices below.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-13.png)
|
||||
|
||||
## Customize the Publish Form
|
||||
|
||||
Let’s head to the publish page to see what it looks like with our new styling - so far, so good. But there is one major issue, the publish form is still telling people to publish datasets. On our new marketplace, we want people to publish and sell their photos, so we’re going to have to make some changes here.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-14.png)
|
||||
|
||||
Open up the index.json file from content/publish/index.json - here we change the text to explain that this form is for publishing photos.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-15.png)
|
||||
|
||||
Additionally, the asset type current says dataset, and we need to change this so that it says photo. The simplest way to do this is to change the title of the asset type without changing anything else. Ocean can handle selling any digital asset that can be accessed via a URL, so no further changes are needed to accommodate selling photos.
|
||||
|
||||
Open up src/components/Publish/Metadata/index.tsx and change line 28 so that it says ‘Photo’
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-18.png)
|
||||
|
||||
Great, now our publish page explains that users should be publishing photos and photo is provided as an asset type option. We’ll also leave algorithm as an option in case some data scientists want to do some analysis or image transformation on the photos.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-19.png)
|
||||
|
||||
There is one more thing that is fun to change before we move away from the publish form. You’ll notice that Ocean Market V4 now has a cool SVG generation feature that creates the images for the Data NFT. It creates a series of pink waves. Let’s change this so that it uses our brand colors in the waves!
|
||||
|
||||
Open up /src/@utils/SvgWaves.ts and have a look at lines 27 to 30 where the colors are specified. Currently, the pink color is the one used in the svg generator. You can replace this with your own brand color:
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-21.png)
|
||||
|
||||
If you’re interested in doing some further customization, take a look at lines 53 to 64. You can change these properties to alter how the image looks. Feel free to play around with it. We’ve increased the number of layers from 4 to 5.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-22.png)
|
||||
|
||||
And now your customized publish page is ready for your customers:
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-20.png)
|
||||
|
||||
## Change the Fee Address
|
||||
|
||||
At this point, we have made a lot of changes and hopefully you’re happy with the way that your marketplace is looking. Given that you now have your own awesome photo marketplace, it’s about time we talked about monetizing it. Yup, that’s right - you will earn a commission when people buy and sell photos in your marketplace. In Ocean V4, there are a whole host of new fees and customization options that you can use (read more about that here).
|
||||
|
||||
When someone sets the pricing for their photos in your marketplace, they are informed that a commission will be sent to the owner of the marketplace. You see that at the moment this fee is set to zero, so you’ll want to increase that. And in order to receive the fees you’ll you need to set the address that you want to recieve these fees in.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-23.png)
|
||||
|
||||
This important step is the last thing that we will change in this guide. To set the marketplace fees and address, you’ll need to save them as environmental variables. Create a new file called .env in the root of your repository.
|
||||
|
||||
Copy and paste the following into the file:
|
||||
|
||||
```
|
||||
|
||||
NEXT_PUBLIC_MARKET_FEE_ADDRESS="0x123abc"
|
||||
NEXT_PUBLIC_PUBLISHER_MARKET_ORDER_FEE="0.01"
|
||||
NEXT_PUBLIC_PUBLISHER_MARKET_FIXED_SWAP_FEE="0.01"
|
||||
NEXT_PUBLIC_CONSUME_MARKET_ORDER_FEE="0.01"
|
||||
NEXT_PUBLIC_CONSUME_MARKET_FIXED_SWAP_FEE="0.01"
|
||||
|
||||
```
|
||||
|
||||
You need to replace “0x123abc” with your ethereum address (this is where the fees will be sent) and alter the fees to the levels that you intend them to be at. If you change you mind, these fees can always be altered later.
|
||||
|
||||
Go to [Fees page](https://docs.oceanprotocol.com/concepts/fees/) to know more details about each type of fee and its relevance.
|
||||
|
||||
It is important that the file is saved in the right place at the root of your repository, your file structure should look the same as below.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-24.png)
|
||||
|
||||
Now that’s it; you now have a fully functioning photo marketplace that operates over the blockchain. Everytime someone uses it, you will receive revenue.
|
||||
|
||||
![marketCustomisation](../../.gitbook/assets/market-customisation-25.png)
|
41
building-with-ocean/build-a-marketplace/deploying-market.md
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Deployment of Ocean Market
|
||||
order: 3
|
||||
hideLanguageSelector: true
|
||||
description: Step by step guide to a quick deployment of Ocean Market
|
||||
featuredImage: images/creatures/mantaray/mantaray-full@2x.png
|
||||
---
|
||||
|
||||
# 🔰 Quick deployment of Ocean Market
|
||||
|
||||
All that’s left is for you to host your data marketplace and start sharing it with your future users.
|
||||
|
||||
## **Build and host your Data Marketplace**
|
||||
|
||||
To host your data marketplace, you need to run the build command:
|
||||
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
This takes a few minutes to run. While this is running, you can get prepared to host your new data marketplace. You have many options for hosting your data marketplace (including AWS S3, Vercel, Netlify and many more). In this guide, we will demonstrate how to host it with surge, which is completely free and very easy to use.
|
||||
|
||||
Open up a new terminal window and run the following command to install surge:
|
||||
|
||||
```
|
||||
npm install --global surge
|
||||
```
|
||||
|
||||
When this is complete, navigate back to the terminal window that is building your finished data marketplace. Once the build is completed, enter the following commands to enter the public directory and host it:
|
||||
|
||||
```
|
||||
cd public
|
||||
```
|
||||
|
||||
```
|
||||
surge
|
||||
```
|
||||
|
||||
If this is your first time using surge, you will be prompted to enter an email address and password to create a free account. It will ask you to confirm the directory that it is about to publish, check that you are in the market/public/ directory and press enter to proceed. Now it gives you the option to choose the domain that you want your project to be available on. We have chosen https://crypto-photos.surge.sh which is a free option. You can also set a CNAME value in your DNS to make use of your own custom domain.
|
||||
|
||||
After a few minutes, your upload will be complete, and you’re ready to share your data marketplace. You can view the version we created in this guide [here](https://crypto-photos.surge.sh/).
|
@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Forking Ocean Market
|
||||
order: 1
|
||||
hideLanguageSelector: true
|
||||
description: Forking and running Ocean Market locally.
|
||||
featuredImage: images/creatures/mantaray/mantaray-full@2x.png
|
||||
---
|
||||
|
||||
# Forking and running Ocean Market locally
|
||||
|
||||
One of the best use cases for Ocean is running your own marketplace and monetizing your digital assets. With Ocean you can sell your data directly to your customers with no third party in-between, no need to speak to data with data brokers. Ocean makes this all super easy for you with some pretty cool tech under the hood. Furthermore, an Ocean powered market isn't just limited to selling data, you can use it for selling any type of digital asset!
|
||||
|
||||
Using Ocean Market is already a big improvement on the alternatives that are out there, but it gets even better. Ocean Market is completely open-source and made freely available under the Apache 2 license. This means that you can fork Ocean Market and set up your own data marketplace in just a few steps. This guide will walk you through the process, you’ll be surprised how easy it is. No prior blockchain knowledge is required!
|
||||
|
||||
|
||||
- Fork Ocean Market
|
||||
|
||||
- Clone the market locally
|
||||
|
||||
- Install the dependencies
|
||||
|
||||
- Run your Market fork for the first time
|
||||
|
||||
## Fork Ocean Market
|
||||
|
||||
The first step is to log into Github and navigate to the [Ocean Market repository](https://github.com/oceanprotocol/market), you’ll need to log in or create a Github account. Now you need to click “Fork” in the top right-hand corner. If you are a member of an organization on Github, it will give you the option to clone it into either your personal account or the organization. Choose whichever is suitable for you.
|
||||
|
||||
## Clone the market locally
|
||||
|
||||
Now we need to clone the market fork locally so that we can start making changes to the code. Upon forking Ocean Market, GitHub will take you to the repository page. Here, you should copy the URL of the repository. To do this, click on the green “Code” button and then click the copy icon to copy the HTTPS URL. Make sure that you have git installed and set up and installed on your computer before proceeding. See [this guide](https://git-scm.com/) if you’re not familiar with git.
|
||||
|
||||
## Install the dependencies
|
||||
|
||||
Installing the dependencies is a vital step for running the market. It’s a super simple process, thanks to npm (node package manager). Make sure you have node.js installed, otherwise it will fail. In Ocean Market, we use node.js version 16 and it’s highly recommended that you use the same.
|
||||
|
||||
Enter the following command to install the dependencies:
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
This command will take a few minutes to complete and you’ll see some warnings as it runs (no need to worry about the warnings).
|
||||
|
||||
## Run your Market fork for the first time
|
||||
|
||||
At this point, you are ready to run your data marketplace for the first time. This is another straightforward step that requires just one command:
|
||||
|
||||
```
|
||||
npm start
|
||||
```
|
||||
|
||||
The above command will build the development bundle and run it locally.
|
||||
|
||||
![Forking Ocean Market](../../.gitbook/assets/market-customisation-1.png)
|
||||
|
||||
Great news - your marketplace has successfully been built and is now running locally. Let’s check it out! Open your browser and navigate to http://localhost:8000/. You’ll see that you have a full-on clone of Ocean Market running locally. Give it a go and test out publishing and consuming assets - everything works!
|
||||
|
||||
That’s all that’s required to get a clone of Ocean market working. The whole process is made simple because your clone can happily use all the smart contracts and backend components that are maintained by Ocean Protocol Foundation.
|
||||
|
||||
![Forking Ocean Market](../../.gitbook/assets/market-customisation-2.png)
|
||||
|
||||
So you’ve got a fully functioning marketplace at this point, which is pretty cool. But it doesn’t really look like your marketplace. Right now, it’s still just a clone of Ocean Market - the same branding, name, logo, etc. The next few steps focus on personalizing your marketplace.
|
195
orientation/faq.md
Normal file
@ -0,0 +1,195 @@
|
||||
---
|
||||
title: FAQs
|
||||
description: Frequently Asked Questions about Ocean Protocol
|
||||
order: 5
|
||||
hideLanguageSelector: true
|
||||
featuredImage: images/creatures/mantaray/mantaray-full@2x.png
|
||||
---
|
||||
|
||||
# ❓ Frequently Asked Questions
|
||||
|
||||
Have some questions about Ocean Protocol?
|
||||
|
||||
Hopefully you'll find the answers here! If not then please don't hesitate to reach out to us on [discord](https://discord.gg/TnXjkR5) - there are no stupid questions!
|
||||
|
||||
### General Questions
|
||||
|
||||
<details>
|
||||
<summary>What is a decentralized data marketplace?</summary>
|
||||
|
||||
A data marketplace allows providers to publish data and buyers to consume data. Unlike centralized data marketplaces, decentralized ones give users more control over their data, algorithms and analytics by minimizing custodianship and providing transparent and immutable records of every transaction. With features such as Compute-to-Data (C2D), data and algorithms can be ingested into secure Docker containers where escapes avoided, protecting both the data and algorithms.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What is needed to use a decentralized marketplace?</summary>
|
||||
|
||||
Users access decentralized marketplaces via Metamask. Metamask is an applet interface that manages unique IDs, generated and controlled fully by the user. These unique IDs (aka Ethereum address) are used to store digital assets such as cryptocurrency, datatokens, NFTs and other web3 native assets.
|
||||
|
||||
A Metamask wallet can easily be set up as a browser extension by going to your browser’s web store for extensions and search for “MetaMask”. For additional help setting up your MetaMask wallet, watch our short tutorial video and review these instructions on Ocean’s documentation page.
|
||||
|
||||
Once a user has Metamask installed and an Ethereum address, they can register, consume or stake on datasets on Ocean Market.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>How is Ocean different from other data marketplaces?</summary>
|
||||
|
||||
Ocean Protocol is a decentralized data marketplace which gives users complete control of their data. The Ocean Protocol technology is built on smart contracts, decentralized computer scripts with no intermediary that are triggered by the users. The Ocean Market exposes the functionality of the smart contracts in a browser-friendly interface. Data providers and consumers can discover one another and transact in a peer-to-peer manner with the minimal amount of intermediary involvement.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>How do I price my data?</summary>
|
||||
|
||||
Ocean gives you two different options for pricing your data - fixed price or free. You need to decide what your dataset is worth and how you want to price it. You can change the price but you can’t change the price format (e.g. from fixed to free).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Is my data secure?</summary>
|
||||
|
||||
Yes. Ocean Protocol understands that some data is too sensitive to be shared — potentially due to GDPR or other reasons. For these types of datasets, we offer a unique service called compute-to-data. This enables you to monetise the dataset that sits behind a firewall without ever revealing the raw data to the consumer. For example, researchers and data scientists pay to run their algorithms on the data set and the computation is performed behind a firewall; all the researchers or data scientists receive is the results generated by their algorithm.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Where is my data stored?</summary>
|
||||
|
||||
Ocean does not provide data storage. Users have the choice to store their data on their own servers, cloud or decentralized storage. Users need only to provide a URL to the dataset, which is then encrypted as a means to protect the access to the dataset.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>How do I control who accesses my data?</summary>
|
||||
|
||||
Ocean provides tools for access control, fine grained permissions, passlisting and blocklisting addresses. Data and AI services can be shared under the conditions set by the owner of data. There is no central intermediary, which ensures no one can interfere with the transaction and both the publisher and user have transparency.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Can I restrict who is able to access my dataset?</summary>
|
||||
|
||||
Yes - Ocean has implemented fine grained permissions. This means that you can create allow and deny lists that restrict access from certain individuals or limit access to particular organizations.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What is the reach of Ocean Market - how many data buyers can I sell to?</summary>
|
||||
|
||||
Hundreds of unique datasets are available that are sourced from private individuals, research institutions, commercial enterprises and government. Publishing data on Ocean offers data providers and algorithm owners an exciting new channel to connect with a rapidly growing community of Web3 enthusiasts and data science professionals around the world.
|
||||
|
||||
</details>
|
||||
|
||||
### Technical Questions
|
||||
|
||||
<details>
|
||||
<summary>Why does Ocean Protocol use the Blockchain?</summary>
|
||||
|
||||
For both providers and consumers of data, blockchain is a superior substrate for building applications.Blockchain allows business logic to be instantiated in a network and triggered by the users, without intermediaries. This innovation promises lower transaction costs, higher security, more control, less errors and more transparency & auditability.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>The blockchain is public - does this mean that anyone can access my data?</summary>
|
||||
|
||||
No one is able to access data via the blockchain without purchasing access (with the datatoken) though the smart contract. Ocean smart contracts encrypt the URL to the dataset before it is published on the blockchain. This means that only the encrypted URL will be queryable in the public blockchain. Ocean technology facilitates data access to the consumer via a proxy (Ocean Provider) and the unencrypted url is never exposed.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What is a smart contract and why is it relevant?</summary>
|
||||
|
||||
The blockchain can do more than just store information - it can also run code. A smart contract is an executable script that runs on the blockchain, with no intermediary and is fully transparent and auditable by anyone. In Ocean, smart contracts facilitate access to data and AI if the access conditions set out by the publisher are fulfilled.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What is a datatoken?</summary>
|
||||
|
||||
A datatoken is an access token to datasets and services published in the Ocean ecosystem. Datatokens can be purchased via the Ocean Market or on a decentralized crypto exchange. . If a consumer wishes to access a dataset, they must acquire the datatoken and then exchange the datatoken for access to the dataset.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>How do I acquire datatokens?</summary>
|
||||
|
||||
Datatokens can be acquired and traded in Ocean Market. There are several ways to acquire data tokens. Data publishers can acquire datatokens by publishing datasets and then receiving the generated datatokens.
|
||||
|
||||
Consumers can click "buy" on an asset in Ocean Market to buy and redeem a datatoken in exchange for access to a dataset.
|
||||
|
||||
Datatokens can also be sent from anyone who holds a datatoken for a particular asset.
|
||||
|
||||
</details>
|
||||
|
||||
### Data Selling Questions
|
||||
|
||||
<details>
|
||||
<summary>How are organizations leveraging data sharing?</summary>
|
||||
|
||||
For the most part organizations are leveraging data sharing to benefit from data monetization, however increasingly organizations are also sharing data in order to boost their progress on sustainability goals. For example, data aggregated from vehicles can not only bring new revenue streams to automotive firms but can also be used to battle pollution.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Does it pay to become a marketplace operator?</summary>
|
||||
|
||||
Yes. Marketplace operators benefit from earning commission on marketplace transactions related to data consumption. Ocean Market is primarily focussed on monetising data however it is also designed to handle the sale of any digital asset or service. As a result the total addressable market goes way beyond revenues from just selling data. Operating costs for an Ocean-powered marketplace are moderate and the base code is open source and available free of charge under the Apache 2 license.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Why Publish?</summary>
|
||||
|
||||
Publishing data, algorithms and other digital assets and services on an Ocean-powered marketplace offers numerous opportunities to earn on the future revenue streams connected to that data as well as build lucrative ecosystem that add value to the published asset. It also allows for the discovery and insights into new use cases and applications of the published asset.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What about the price fluctuation of Ocean?</summary>
|
||||
|
||||
Price fluctuation is mitigated through the use of the Ocean backed stable coin H2O.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Who pays for gas fees?</summary>
|
||||
|
||||
Gas fees for marketplace transactions are paid by the user initiating the transaction (for publishing, consuming, etc).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Where do the docker containers run?</summary>
|
||||
|
||||
Dockers containers can run anywhere. Ocean Market use a docker run by the Ocean Protocol Foundation OPF); limit: 1 CPU limit / 60 seconds max. NOTE: This means OPF technically has access to data. In the case of a forked Ocean-powered marketplace the owner of marketplace must set up computation environment. If individual users of the marketplace are concerned with security they should be prepared to host both the data and provide compute-to-data services on premise.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Who pays for the computation?</summary>
|
||||
|
||||
The marketplace owner.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What cryptocurrency do I need for transactions?</summary>
|
||||
|
||||
The type if cryptocurrencies needed for transactions on the marketplace depends on which network(s) the marketplace is running (Ethereum, Polygon, EWT, BSC, Moonriver, etc.). Regardless of network, users will need to have Ocean tokens as well as the corresponding network token, which is used to pay for gas.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Can I use the off the shelf CSS available in the repo?</summary>
|
||||
|
||||
Marketplace name, logo and typeface must be changed by the client. Slight modification would be enough for compliance. For more information consult the READ ME file on GitHub. https://github.com/oceanprotocol/market#-forking
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What’s to come with Ocean this year?</summary>
|
||||
|
||||
Checkout our [roadmap](https://oceanprotocol.com/technology/roadmap) to see what's we are currently working on. If you are interested in tracking our progress towards these goals then take a look at our [github](https://github.com/oceanprotocol/).
|
||||
|
||||
</details>
|