mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-82: change request with no subject merged in GitBook
This commit is contained in:
Veronica Manuel
gitbook-bot
parent
13eef91f8e
commit
ab98ffa808
@ -12,7 +12,10 @@
|
||||
* [📜 How To's](how-tos/README.md)
|
||||
* [Publish an NFT](how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download NFT Assets](how-tos/marketplace-download-data-asset.md)
|
||||
* [Host NFT Assets](how-tos/asset-hosting.md)
|
||||
* [Host NFT Assets](how-tos/asset-hosting/README.md)
|
||||
* [Arweave](how-tos/asset-hosting/arweave.md)
|
||||
* [AWS](how-tos/asset-hosting/aws.md)
|
||||
* [Azure Cloud](how-tos/asset-hosting/azure-cloud.md)
|
||||
* [How to Get veOCEAN](how-tos/how-to-get-veocean.md)
|
||||
* [Compute-to-Data](how-tos/compute-to-data.md)
|
||||
* [Using Ocean Market](how-tos/using-ocean-market.md)
|
||||
|
||||
@ -45,7 +45,7 @@ The following guides will help you get started with buying and selling data:
|
||||
|
||||
* [Publish a data asset](../how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](../how-tos/marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](../how-tos/asset-hosting.md)
|
||||
* [Publishing with hosting services](../how-tos/asset-hosting/)
|
||||
|
||||
### Build Your Own Data Market
|
||||
|
||||
|
||||
224
how-tos/asset-hosting/README.md
Normal file
224
how-tos/asset-hosting/README.md
Normal file
@ -0,0 +1,224 @@
|
||||
---
|
||||
description: >-
|
||||
Tutorial to host your data and algorithm NFT assets using cloud services like
|
||||
Arweave, AWS, and Azure.
|
||||
---
|
||||
|
||||
# Host NFT Assets
|
||||
|
||||
### Overview
|
||||
|
||||
To publish on the Ocean Marketplace, publishers must first host their assets! It is up to the asset publisher to decide where to host the asset. For example, a publisher can store the content on decentralized storage like Arweave or choose a centralized solution like their AWS server, private cloud server, or other third-party hosting services. Through publishing, the information required to access the asset is encrypted and stored as a part of DDO on the blockchain. Buyers don't have access directly to this information, but they interact with the [Provider](https://github.com/oceanprotocol/provider#provider), which decrypts it and acts as a proxy to serve the asset. The DDO only stores the location of the file, which is accessed on-demand by the Provider. Implementing a security policy that allows only the Provider to access the file and blocks requests from other unauthorized actors is recommended. One of the possible ways to achieve this is to allow only the Provider's IP address to access the data. But, not all hosting services provide this feature. So, the publishers must consider the security features while choosing a hosting service.
|
||||
|
||||
On Ocean Marketplace, a publisher must provide the asset information during the publish step in the field shown in the below image. The information is a `link` for a classic URL, a `transaction ID` for a file stored on Arweave or a `CID` for an IPFS file.
|
||||
|
||||
|
||||
|
||||
Publishers can choose any hosting service of their choice. The below section explains how to use commonly used hosting services with Ocean Marketplace.
|
||||
|
||||
⚠️ Note **Please use a proper hosting solution to keep your files.** Systems like `Google Drive` are not specifically designed for this use case. They include various virus checks and rate limiters that prevent the `Provider` to download the asset once it was purchased.
|
||||
|
||||
### Decentralized hosting
|
||||
|
||||
#### Arweave
|
||||
|
||||
[Arweave](https://www.arweave.org/) is a global, permanent, and decentralized data storage layer that allows you to store documents and applications forever. Arweave is different from other decentralized storage solutions in that there is only one up-front cost to upload each file.
|
||||
|
||||
**Step 1 - Get a new wallet and AR tokens**
|
||||
|
||||
Download & save a new wallet (JSON key file) and receive a small amount of AR tokens for free using the [Arweave faucet](https://faucet.arweave.net/). If you already have an Arweave browser wallet, you can skip to Step 3.
|
||||
|
||||
At the time of writing, the faucet provides 0.02 AR which is more than enough to upload a file.
|
||||
|
||||
If at any point you need more AR tokens, you can fund your wallet from one of Arweave's [supported exchanges](https://arwiki.wiki/#/en/Exchanges).
|
||||
|
||||
**Step 2 - Load the key file into the arweave.app web wallet**
|
||||
|
||||
Open [arweave.app](https://arweave.app/) in a browser. Select the '+' icon in the bottom left corner of the screen. Import the JSON key file from step 1.
|
||||
|
||||
|
||||
|
||||
**Step 3 - Upload file**
|
||||
|
||||
Select the newly imported wallet by clicking the "blockies" style icon in the top left corner of the screen. Select **Send.** Click the **Data** field and select the file you wish to upload.
|
||||
|
||||
|
||||
|
||||
The fee in AR tokens will be calculated based on the size of the file and displayed near the bottom middle part of the screen. Select **Submit** to submit the transaction.
|
||||
|
||||
After submitting the transaction, select **Transactions** and wait until the transaction appears and eventually finalizes. This can take over 5 minutes so please be patient.
|
||||
|
||||
**Step 4 - Copy the transaction ID**
|
||||
|
||||
Once the transaction finalizes, select it, and copy the transaction ID.
|
||||
|
||||
|
||||
|
||||
**Step 5 - Publish the asset with the transaction ID**
|
||||
|
||||
|
||||
|
||||
### Centralized hosting
|
||||
|
||||
#### AWS
|
||||
|
||||
AWS provides various options to host data and multiple configuration possibilities. Publishers are required to do their research and decide what would be the right choice. The below steps provide one of the possible ways to host data using an AWS S3 bucket and publish it on Ocean Marketplace.
|
||||
|
||||
**Prerequisite**
|
||||
|
||||
Create an account on [AWS](https://aws.amazon.com/s3/). Users might also be asked to provide payment details and billing addresses that are out of this tutorial's scope.
|
||||
|
||||
**Step 1 - Create a storage account**
|
||||
|
||||
**Go to AWS portal**
|
||||
|
||||
Go to the AWS portal for S3: https://aws.amazon.com/s3/ and select from the upper right corner `Create an AWS account` as shown below.
|
||||
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
)
|
||||
|
||||
**Create a bucket**
|
||||
|
||||
After logging into the new account, search for the available services and select `S3` type of storage.
|
||||
|
||||
|
||||
|
||||
To create an S3 bucket, choose `Create bucket`.
|
||||
|
||||
|
||||
|
||||
Fill in the form with the necessary information. Then, the bucket is up & running.
|
||||
|
||||
|
||||
|
||||
**Step 2 - Upload asset on S3 bucket**
|
||||
|
||||
Now, the asset can be uploaded by selecting the bucket name and choosing `Upload` in the `Objects` tab.
|
||||
|
||||
|
||||
|
||||
**Add files to the bucket**
|
||||
|
||||
Get the files and add them to the bucket.
|
||||
|
||||
The file is an example used in multiple Ocean repositories, and it can be found [here](https://raw.githubusercontent.com/oceanprotocol/c2d-examples/main/branin\_and\_gpr/branin.arff).
|
||||
|
||||
|
||||
|
||||
The permissions and properties can be set afterward, for the moment keep them as default.
|
||||
|
||||
After selecting `Upload`, make sure that the status is `Succeeded`.
|
||||
|
||||
|
||||
|
||||
**Step 3 - Access the Object URL on S3 Bucket**
|
||||
|
||||
By default, the permissions of accessing the file from the S3 bucket are set to private. To publish an asset on the market, the S3 URL needs to be public. This step shows how to set up access control policies to grant permissions to others.
|
||||
|
||||
**Editing permissions**
|
||||
|
||||
Go to the `Permissions` tab and select `Edit` and then uncheck `Block all public access` boxes to give everyone read access to the object and click `Save`.
|
||||
|
||||
If editing the permissions is unavailable, modify the `Object Ownership` by enabling the ACLs as shown below.
|
||||
|
||||
|
||||
|
||||
**Modifying bucket policy**
|
||||
|
||||
To have the bucket granted public access, its policy needs to be modified likewise.
|
||||
|
||||
Note that the `<BUCKET-NAME>` must be chosen from the personal buckets dashboard.
|
||||
|
||||
```JSON
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "Public S3 Bucket",
|
||||
"Principal": "*",
|
||||
"Effect": "Allow",
|
||||
"Action": "s3:GetObject",
|
||||
"Resource": "arn:aws:s3:::<BUCKET-NAME>/*"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
After saving the changes, the bucket should appear as `Public` access.
|
||||
|
||||
|
||||
|
||||
**Verify the object URL on public access**
|
||||
|
||||
Select the file from the bucket that needs verification and select `Open`. Now download the file on your system.
|
||||
|
||||
|
||||
|
||||
**Step 4 - Get the S3 Bucket Link & Publish Asset on Market**
|
||||
|
||||
Now that the S3 endpoint has public access, the asset will be hosted successfully.
|
||||
|
||||
Go to [Ocean Market](https://market.oceanprotocol.com/publish/1) to complete the form for asset creation.
|
||||
|
||||
Copy the `Object URL` that can be found at `Object Overview` from the AWS S3 bucket and paste it into the `File` field from the form found at [step 2](https://market.oceanprotocol.com/publish/2) as it is illustrated below.
|
||||
|
||||
|
||||
|
||||
#### Azure storage
|
||||
|
||||
Azure provides various options to host data and multiple configuration possibilities. Publishers are required to do their research and decide what would be the right choice. The below steps provide one of the possible ways to host data using Azure storage and publish it on Ocean Marketplace.
|
||||
|
||||
**Prerequisite**
|
||||
|
||||
Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might also be asked to provide payment details and billing addresses that are out of this tutorial's scope.
|
||||
|
||||
**Step 1 - Create a storage account**
|
||||
|
||||
**Go to Azure portal**
|
||||
|
||||
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
|
||||
|
||||
|
||||
|
||||
**Create a new storage account**
|
||||
|
||||
.png>)
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
|
||||
|
||||
**Storage account created**
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
|
||||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
**Select the file to be published and click Generate SAS**
|
||||
|
||||
|
||||
|
||||
**Configure the SAS details and click `Generate SAS token and URL`**
|
||||
|
||||
.png>)
|
||||
|
||||
**Copy the generated link**
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 5 - Publish the asset using the generated link**
|
||||
|
||||
Now, copy and paste the link into the Publish page in the Ocean Marketplace.
|
||||
|
||||
|
||||
2
how-tos/asset-hosting/arweave.md
Normal file
2
how-tos/asset-hosting/arweave.md
Normal file
@ -0,0 +1,2 @@
|
||||
# Arweave
|
||||
|
||||
2
how-tos/asset-hosting/aws.md
Normal file
2
how-tos/asset-hosting/aws.md
Normal file
@ -0,0 +1,2 @@
|
||||
# AWS
|
||||
|
||||
2
how-tos/asset-hosting/azure-cloud.md
Normal file
2
how-tos/asset-hosting/azure-cloud.md
Normal file
@ -0,0 +1,2 @@
|
||||
# Azure Cloud
|
||||
|
||||
@ -10,7 +10,7 @@ description: How to download data and algorithm assets on the Ocean Market
|
||||
2. Search for assets using the search bar in the top right corner of the page. The Ocean Marketplace provides features to search the Data/Algorithms by text, and users can also sort the result by published date.
|
||||
3. Connect your wallet. If you know the network the asset is hosted on, then you can also select the network from the dropdown to the left of the Connect Wallet button to filter!
|
||||
|
||||
|
||||
|
||||
|
||||
### Steps to Download
|
||||
|
||||
@ -18,7 +18,7 @@ description: How to download data and algorithm assets on the Ocean Market
|
||||
|
||||
The Buy button is enabled only if the connected wallet address has enough OCEAN tokens to purchase the asset.
|
||||
|
||||
|
||||
|
||||
|
||||
Are you buying an asset on the Polygon network? Then you'll need mOCEAN "matic OCEAN" to buy assets! Watch our tutorial how to get mOCEAN so that you can go shopping on the Ocean Market 🤑🛒
|
||||
|
||||
@ -28,18 +28,18 @@ Learn how to get mOCEAN
|
||||
|
||||
#### Step 2 - Confirm the 1st of 3 transactions - Allow access to OCEAN tokens
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 3 - Confirm the 2nd of 3 transactions - Buy the asset in exchange for OCEAN tokens 💸
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 4 - Download the asset ⬇️
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 5 - Sign the 3rd last transaction ✍️
|
||||
|
||||
After signing the message, the file download will start.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -22,13 +22,13 @@ Please note Ocean Protocol maintains a purgatory list [here](https://github.com/
|
||||
2. Connect your wallet. 
|
||||
3. Select the network where you would like to publish your NFT (ex. Ethereum, Polygon, etc).
|
||||
|
||||
|
||||
|
||||
|
||||
In this tutorial, we will be using the Polygon Mumbai test network.
|
||||
|
||||
4\. Click on the Publish link on the top left corner of the page.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 1 - Metadata 🤓
|
||||
|
||||
@ -52,7 +52,7 @@ _Mandatory fields are marked with \*_
|
||||
|
||||
Tags help the asset to be searchable. If not provided, the list of tags is empty by default.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Continue.
|
||||
|
||||
@ -78,7 +78,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.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 3 - Pricing 🫰
|
||||
|
||||
@ -93,15 +93,15 @@ With the _fixed pricing_ schema, the publisher sets the price that buyers will p
|
||||
|
||||
With the _free pricing_ schema, the publisher provides an asset that is free to be downloaded by anyone.
|
||||
|
||||
For more information on the pricing models, please refer this [document](../../developers/core-concepts/asset-pricing.md).
|
||||
For more information on the pricing models, please refer this [document](../developers/core-concepts/asset-pricing.md).
|
||||
|
||||
For a deep dive into the fee structure, please refer to this [document](../../developers/core-concepts/fees.md).
|
||||
For a deep dive into the fee structure, please refer to this [document](../developers/core-concepts/fees.md).
|
||||
|
||||
|
||||
|
||||
|
||||
#### Step 4 - Preview 🔍
|
||||
|
||||
|
||||
|
||||
|
||||
If you are happy with the Preview of your NFT, then click Continue!
|
||||
|
||||
@ -109,15 +109,15 @@ If you are happy with the Preview of your NFT, then click Continue!
|
||||
|
||||
To publish your NFT on-chain, you must go through three steps including signing two transactions with your wallet. Note: this will cost some gas fees!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Confirmation 🥳
|
||||
|
||||
Now, your NFT is successfully published and available in the Ocean Market!
|
||||
|
||||
|
||||
|
||||
|
||||
On the [profile page](https://v4.market.oceanprotocol.com/profile), a publisher has access to all their published assets.
|
||||
|
||||
|
||||
@ -10,23 +10,23 @@ In previous versions of Ocean liquidity pools and dynamic pricing were supported
|
||||
2. Click _View All_ and look for Ocean Pool Token (OPT) transfers. Those transactions always come from the pool contract, which you can click on.
|
||||
3. On the pool contract page, go to _Contract_ -> _Read Contract_.
|
||||
|
||||
|
||||
|
||||
|
||||
4\. Go to field `20. balanceOf` and insert your ETH address. This will retrieve your pool share token balance in wei.
|
||||
|
||||
|
||||
|
||||
|
||||
5\. Copy this number as later you will use it as the `poolAmountIn` parameter.
|
||||
|
||||
6\. Go to field `55. totalSupply` to get the total amount of pool shares, in wei.
|
||||
|
||||
|
||||
|
||||
|
||||
7\. Divide the number by 2 to get the maximum of pool shares you can send in one pool exit transaction. If your number retrieved in former step is bigger, you have to send multiple transactions.
|
||||
|
||||
8\. Go to _Contract_ -> _Write Contract_ and connect your wallet. Be sure to have your wallet connected to network of the pool.
|
||||
|
||||
|
||||
|
||||
|
||||
9\. Go to the field `5. exitswapPoolAmountIn`
|
||||
|
||||
@ -34,8 +34,8 @@ In previous versions of Ocean liquidity pools and dynamic pricing were supported
|
||||
* For `minAmountOut` use anything, like `1`
|
||||
* Hit _Write_
|
||||
|
||||
|
||||
|
||||
|
||||
10\. Confirm transaction in Metamask
|
||||
|
||||
|
||||
|
||||
|
||||
@ -17,15 +17,15 @@ Learn to:
|
||||
|
||||
* [Publish an NFT](marketplace-publish-data-asset.md)
|
||||
* [Download NFT Assets](marketplace-download-data-asset.md)
|
||||
* [Host Your Assets](asset-hosting.md)
|
||||
* [Host Your Assets](asset-hosting/)
|
||||
|
||||
#### Getting Basic 💁♀️
|
||||
|
||||
If you are new to web3 and blockchain technologies then we suggest you first get familiar with some Web3 basics:
|
||||
|
||||
* [Wallet Basics](../../tutorials/building-with-ocean/wallets.md) 👛
|
||||
* [Set Up MetaMask](../../tutorials/orientation/metamask-setup.md) [Wallet ](../../tutorials/orientation/metamask-setup.md)🦊
|
||||
* [Manage Your OCEAN Tokens](../../tutorials/building-with-ocean/wallets-and-ocean-tokens.md) 🪙
|
||||
* [Wallet Basics](../tutorials/building-with-ocean/wallets.md) 👛
|
||||
* [Set Up MetaMask](../tutorials/orientation/metamask-setup.md) [Wallet ](../tutorials/orientation/metamask-setup.md)🦊
|
||||
* [Manage Your OCEAN Tokens](../tutorials/building-with-ocean/wallets-and-ocean-tokens.md) 🪙
|
||||
|
||||
#### Removing Liquidity
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user