oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

GITBOOK-236: change request with no subject merged in GitBook

Browse Source
This commit is contained in:
Jamie Hewitt 2023-05-23 15:17:13 +00:00 committed by gitbook-bot
parent 95c3e6b08f
commit fc42c2a543
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
20 changed files with 63 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/cover/contribute (1) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 320 KiB

0
.gitbook/assets/wallet/balance-of (1) (1).png → .gitbook/assets/liquidity/remove-liquidity-2 (1) (1).png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

BIN
.gitbook/assets/liquidity/remove-liquidity-2 (1) (2).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

BIN
.gitbook/assets/liquidity/remove-liquidity-2 (1) (3).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

4
README.md
View File

@ -1,10 +1,10 @@
---
description: Help for wherever you are on your Ocean Protocol journey.
cover: .gitbook/assets/cover/contribute (1).png
cover: .gitbook/assets/cover/contribute (1) (1).png
coverY: 0
layout: landing
---
# 👋 Welcome
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card (1).png">discover_card (1).png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card (1).png">user_guides_card (1).png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card (1).png">developer_tutorials_card (1).png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card (1).png">data_science_card (1).png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card (1).png">infrastructure_card (1).png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card (1).png">contribute_card (1).png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card.png">developer_tutorials_card.png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/rewards_card (1).png">rewards_card (1).png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card (1).png">rewards_card (1).png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>

5
SUMMARY.md
View File

@ -27,7 +27,7 @@
* [How to Data Farm](user-guides/how-to-data-farm.md)
* [Claim OCEAN Rewards](user-guides/claim-ocean-rewards.md)
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md)
* [👨💻 👨💻 Developers](developers/README.md)
* [👨💻 👨💻 👨💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md)
* [Data NFTs and Datatokens](developers/datanft-and-datatoken.md)
* [Roles](developers/roles.md)
@ -67,9 +67,6 @@
* [Encryption / Decryption](developers/provider/encryption-decryption.md)
* [Compute Endpoints](developers/provider/compute-endpoints.md)
* [Authentication Endpoints](developers/provider/authentication-endpoints.md)
* [Get Requests](developers/provider/get-requests.md)
* [Post Requests](developers/provider/post-requests.md)
* [Provider](developers/provider/provider.md)
* [📊 Data Science](data-science/README.md)
* [🔨 Infrastructure](infrastructure/README.md)
* [Setup a Server](infrastructure/setup-server.md)

2
contribute/README.md
View File

@ -1,7 +1,7 @@
---
title: Ways to Contribute
description: Help to improve and develop Ocean core software.
cover: ../.gitbook/assets/cover/contribute (1) (2).png
cover: ../.gitbook/assets/cover/contribute (1) (1) (1).png
coverY: 0
---

2
developers/datanft-and-datatoken.md
View File

@ -62,7 +62,7 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed-
### High-Level Behavior
![High-Level Flow](<../.gitbook/assets/architecture/high-level-flow (1).png>)
![High-Level Flow](../.gitbook/assets/architecture/high-level-flow.png)
Here's an example.

39
developers/provider/README.md
View File

@ -1,2 +1,41 @@
---
description: The "Provider" service is an integral part of the Ocean Protocol stack
---
# Provider
### What is Provider?
It is a REST API designed specifically for the provision of data services. It essentially acts as a proxy that encrypts and decrypts the metadata and access information for the data asset.
Constructed using the Python Flask HTTP server, the Provider service is the only component in the Ocean Protocol stack with the ability to access your data, it is an important layer of security for your information.
The Provider service has several key functions. Firstly, it performs on-chain checks to ensure the buyer has permission to access the asset. Secondly, it encrypts the URL and metadata during the publication phase, providing security for your data during the initial upload.
The Provider decrypts the URL when a dataset is downloaded and it streams the data directly to the buyer, it never reveals the asset URL to the buyer. This provides a layer of security and ensures that access is only provided when necessary.
Additionally, the Provider service offers compute services by establishing a connection to the C2D environment. This enables users to compute and manipulate data within the Ocean Protocol stack, adding a new level of utility and function to this data services platform.
### What does Provider do?
* The only component that can access your data
* Performs checks on chain for buyer permissions and payments
* Encrypts the URL and metadata during publish
* Decrypts the URL when the dataset is downloaded or a compute job is started
* Provides access to data assets by streaming data (and never the URL)
* Provides compute services (connects to C2D environment)
* Typically run by the Data Provider
### What technology is used?
Python Flask HTTP server
### How to run the provider?
We recommend checking the README in the [Provider GitHub repository](https://www.amazon.co.uk/dp/B08XBBTLJ8/ref=twister\_B09XVHYH99?\_encoding=UTF8\&th=1) for the steps to run the Provider. If you see any errors in the instructions, please open an issue within the GitHub repository.&#x20;
### Ocean Provider Endpoints Specification
The following pages in this section specify the endpoints for Ocean Provider that have been implemented by the core developers.
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean\_provider/routes/README.md).

7
developers/provider/general-endpoints.md
View File

@ -1,7 +1,6 @@
# General Endpoints
### nonce endpoint
### Nonce
#### GET /api/services/nonce
@ -27,6 +26,8 @@ Response:
}
```
### File Info
#### POST /api/services/fileinfo
Retrieves Content-Type and Content-Length from the given URL or asset.
@ -124,4 +125,4 @@ Response:
{
"": ""
}
```
```

4
developers/provider/get-requests.md
View File

@ -1,4 +0,0 @@
# Get Requests

5
developers/provider/post-requests.md
View File

@ -1,5 +0,0 @@
# Post Requests
### File info endpoint

18
developers/provider/provider.md
View File

@ -1,18 +0,0 @@
# Provider
[https://v4.provider.oceanprotocol.com](https://v4.provider.oceanprotocol.com)
## Ocean Provider Endpoints Specification
This document specifies the endpoints for Ocean Provider to be implemented by the core developers.
If you want to see the provider URLs for our supported networks, kindly check for `Provider` component on this [page](https://docs.oceanprotocol.com/core-concepts/networks).
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean\_provider/routes/README.md).
### Initial service request endpoint

2
discover/wallets.md
View File

@ -6,7 +6,7 @@ description: Fundamental knowledge of using ERC-20 crypto wallets.
Ocean Protocol users require an ERC-20 compatible wallet to manage their OCEAN and ETH tokens. In this guide, we will provide some recommendations for different wallet options.
<figure><img src="../.gitbook/assets/show-wallet.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
### What is a wallet?

2
infrastructure/setup-server.md
View File

@ -28,7 +28,7 @@ Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the numb
Also, select the region where you want Aquarius to be hosted and a root password.
![Select region](../.gitbook/assets/server-setup/server-setup3.png)
![Select region](<../.gitbook/assets/server-setup/server-setup3 (1).png>)
![Click create Droplet](../.gitbook/assets/server-setup/server-setup4.png)

18
user-guides/asset-hosting/azure-cloud.md
View File

@ -18,41 +18,41 @@ Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might al
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
![Select storage accounts](<../../.gitbook/assets/hosting/azure1 (1).png>)
![Select storage accounts](../../.gitbook/assets/hosting/azure1.png)
**Create a new storage account**
![Create a storage account](../../.gitbook/assets/hosting/azure2.png)
![Create a storage account](<../../.gitbook/assets/hosting/azure2 (1).png>)
**Fill in the details**
![Add details](<../../.gitbook/assets/hosting/azure3 (1).png>)
![Add details](../../.gitbook/assets/hosting/azure3.png)
**Storage account created**
![Storage account created](../../.gitbook/assets/hosting/azure4.png)
![Storage account created](<../../.gitbook/assets/hosting/azure4 (1).png>)
**Step 2 - Create a blob container**
![Create a blob container](<../../.gitbook/assets/hosting/azure5 (1).png>)
![Create a blob container](../../.gitbook/assets/hosting/azure5.png)
**Step 3 - Upload a file**
![Upload a file](../../.gitbook/assets/hosting/azure6.png)
![Upload a file](<../../.gitbook/assets/hosting/azure6 (1).png>)
**Step 4 - Share the file**
**Select the file to be published and click Generate SAS**
![Click generate SAS](<../../.gitbook/assets/hosting/azure7 (1).png>)
![Click generate SAS](../../.gitbook/assets/hosting/azure7.png)
**Configure the SAS details and click `Generate SAS token and URL`**
![Generate link to file](../../.gitbook/assets/hosting/azure8.png)
![Generate link to file](<../../.gitbook/assets/hosting/azure8 (1).png>)
**Copy the generated link**
![Copy the link](../../.gitbook/assets/hosting/azure9.png)
![Copy the link](<../../.gitbook/assets/hosting/azure9 (1).png>)
**Step 5 - Publish the asset using the generated link**

2
user-guides/claim-ocean-rewards.md
View File

@ -14,7 +14,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](get-veocean-
Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page.
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab (1).png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️

2
user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md
View File

@ -50,7 +50,7 @@ description: How to publish a C2D algorithm NFT on the Ocean Market
* Your preview should look like the following:
<figure><img src="../../.gitbook/assets/c2d/preview-publish.png" alt="" width="375"><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/c2d/preview-publish (1).png" alt="" width="375"><figcaption></figcaption></figure>
#### Step 8 - Submit the transactions

2
user-guides/compute-to-data/publish-a-c2d-data-nft.md
View File

@ -78,7 +78,7 @@ description: How to publish a data NFT with C2D configurations
#### Congratulations! You have fully finished the C2D flow. Check your work by verifying that your algorithm appears on the data NFT's page, like in the following example:
<figure><img src="../../.gitbook/assets/c2d/double-check-work.png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/c2d/double-check-work (1).png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
If you would like to run the compute job, then simply click the radio button to the left of the algorithm's name and click Buy Compute Job.

2
user-guides/remove-liquidity-using-etherscan.md
View File

@ -14,7 +14,7 @@ Liquidity pools and dynamic pricing used to be supported in previous versions of
4\. Go to field `20. balanceOf` and insert your ETH address. This will retrieve your pool share token balance in wei.
<figure><img src="../.gitbook/assets/wallet/balance-of (1) (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-2 (1) (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
5\. Copy this number as later you will use it as the `poolAmountIn` parameter.