mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-482: change request with no subject merged in GitBook
This commit is contained in:
Mihai Badea
gitbook-bot
parent
d03a281c33
commit
e0585a82d5
@ -5,8 +5,8 @@
|
||||
* [Explore](discover/explore.md)
|
||||
* [Basic Concepts](discover/engage.md)
|
||||
* [Ocean 101](discover/ocean-101.md)
|
||||
* [Wallets](discover/wallets.md)
|
||||
* [Set Up MetaMask Wallet](discover/metamask-setup.md)
|
||||
* [Wallets](discover/wallets/README.md)
|
||||
* [Set Up MetaMask Wallet](discover/wallets/metamask-setup.md)
|
||||
* [Networks](discover/networks/README.md)
|
||||
* [Bridges](discover/networks/bridges.md)
|
||||
* [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md)
|
||||
@ -42,7 +42,7 @@
|
||||
* [Pricing Schemas](developers/asset-pricing.md)
|
||||
* [Fees](developers/fees.md)
|
||||
* [Metadata](developers/contracts/metadata.md)
|
||||
* [Fractional Ownership](developers/datanft-and-datatoken/fractional-ownership.md)
|
||||
* [Fractional Ownership](developers/fractional-ownership.md)
|
||||
* [Community Monetization](developers/community-monetization.md)
|
||||
* [Identifiers & Metadata](developers/Identifiers-Metadata.md)
|
||||
* [DDO Specification](developers/ddo-specification.md)
|
||||
|
||||
@ -23,4 +23,4 @@ These [smart contracts](contracts/) form the backbone of Ocean Protocol, empower
|
||||
|
||||
<figure><img src="../.gitbook/assets/smart-contracts.png" alt=""><figcaption><p>Smart Contracts</p></figcaption></figure>
|
||||
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/) will gently introduce you to the magical world of [web3](../discover/wallets.md) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/) will gently introduce you to the magical world of [web3](../discover/wallets/) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
|
||||
@ -46,7 +46,7 @@ Prominently featured within this layer is [Ocean Market](../user-guides/using-oc
|
||||
|
||||
### Layer 4: The Friendly Wallets
|
||||
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/wallets.md), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../discover/wallets.md).
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/wallets/), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../discover/wallets/).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -7,10 +7,85 @@ description: >-
|
||||
the DDO standard.
|
||||
---
|
||||
|
||||
# DDO Full Specification
|
||||
# DDO Specification
|
||||
|
||||
**v4.1.0**
|
||||
|
||||
<< Diagram Work in Progress>>
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
DDO ||--|{ Metadata : contains
|
||||
DDO ||--|{ Services : contains
|
||||
Services ||--|{ ConsumerParameters : contains
|
||||
Metadata ||--|{ AlgorithmMetadata : contains
|
||||
AlgorithmMetadata ||--|{ Container : contains
|
||||
DDO {
|
||||
arrayOfString context
|
||||
string id
|
||||
string version
|
||||
number chainID
|
||||
string nftAddress
|
||||
Metadata metadata
|
||||
Services services
|
||||
Credentials credentials
|
||||
}
|
||||
Metadata {
|
||||
ISODateTimeString created
|
||||
ISODateTimeString updated
|
||||
string description
|
||||
string copyrightHolder
|
||||
string name
|
||||
string type
|
||||
string author
|
||||
string license
|
||||
arrayOfString links
|
||||
string contentLanguage
|
||||
arrayOfString tags
|
||||
arrayOfStrings categories
|
||||
Object additionalInformation
|
||||
AlgorithmMetadata algorithm
|
||||
}
|
||||
|
||||
AlgorithmMetadata {
|
||||
string language
|
||||
string version
|
||||
ConsumerParameters consumerParameters
|
||||
Container container
|
||||
}
|
||||
|
||||
Container {
|
||||
string entrypoint
|
||||
string image
|
||||
string tag
|
||||
string checksum
|
||||
}
|
||||
|
||||
Services {
|
||||
string id
|
||||
string type
|
||||
string name
|
||||
string description
|
||||
string datatokenAddress
|
||||
string serviceEndpoint
|
||||
Files files
|
||||
number timeout
|
||||
Compute compute
|
||||
ConsumerParameters consumerParameters
|
||||
Object additionalInformation
|
||||
}
|
||||
|
||||
ConsumerParameters {
|
||||
string name
|
||||
string type
|
||||
string label
|
||||
boolean required
|
||||
string description
|
||||
string-number-boolean default
|
||||
ArrayOfOptions options
|
||||
}
|
||||
```
|
||||
|
||||
## Required Attributes
|
||||
|
||||
A DDO in Ocean has these required attributes:
|
||||
@ -184,7 +259,7 @@ This object holds information describing the actual asset.
|
||||
| **`additionalInformation`** | Object | Stores additional information, this is customizable by publisher |
|
||||
| **`algorithm`**\*\* | [Algorithm Metadata](did-ddo.md#algorithm-metadata) | Information about asset of `type` `algorithm` |
|
||||
|
||||
\* Required 
|
||||
\* Required
|
||||
|
||||
\*\* Required for algorithms only
|
||||
|
||||
@ -215,22 +290,23 @@ Services define the access for an asset, and each service is represented by its
|
||||
An asset should have at least one service to be actually accessible, and can have as many services which make sense for a specific use case.
|
||||
|
||||
| Attribute | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| **`id`*** | `string` | Unique ID |
|
||||
| **`type`*** | `string` |Type of service `access`, `compute`, `wss` etc. |
|
||||
| --------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **`id`**\* | `string` | Unique ID |
|
||||
| **`type`**\* | `string` | Type of service `access`, `compute`, `wss` etc. |
|
||||
| **`name`** | `string` | Service friendly name |
|
||||
| **`description`** | `string` | Service description |
|
||||
| **`datatokenAddress`*** | `string` | Datatoken |
|
||||
| **`serviceEndpoint`*** | `string` | Provider URL (schema + host) |
|
||||
| **`files`*** | [Files](did-ddo.md#files) | Encrypted file. |
|
||||
| **`timeout`*** | `number` | Describing how long the service can be used after consumption is initiated. A timeout of `0` represents no time limit. Expressed in seconds. |
|
||||
| **`compute`**** | [Compute](developers/compute-to-data/compute-options.md) | If service is of `type` `compute`, holds information about the compute-related privacy settings & resources. |
|
||||
| **`datatokenAddress`**\* | `string` | Datatoken |
|
||||
| **`serviceEndpoint`**\* | `string` | Provider URL (schema + host) |
|
||||
| **`files`**\* | [Files](did-ddo.md#files) | Encrypted file. |
|
||||
| **`timeout`**\* | `number` | Describing how long the service can be used after consumption is initiated. A timeout of `0` represents no time limit. Expressed in seconds. |
|
||||
| **`compute`**\*\* | [Compute](developers/compute-to-data/compute-options.md) | If service is of `type` `compute`, holds information about the compute-related privacy settings & resources. |
|
||||
| **`consumerParameters`** | [Consumer Parameters](developers/compute-to-data/compute-options.md#consumer-parameters) | An object the defines required consumer input before consuming the asset |
|
||||
| **`additionalInformation`** | Object | Stores additional information, this is customizable by publisher |
|
||||
|
||||
\* Required 
|
||||
\* Required
|
||||
|
||||
\*\* Required for compute assets only
|
||||
|
||||
#### Files
|
||||
|
||||
The `files` field is returned as a `string` which holds the encrypted file URLs.
|
||||
|
||||
@ -21,7 +21,7 @@ It's worth noting that for the second approach, one might consider utilizing pla
|
||||
|
||||
These concerns are effectively addressed by employing a tokenized DAO, as previously described.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/dao.jpeg" alt=""><figcaption><p>DAO</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/dao.jpeg" alt=""><figcaption><p>DAO</p></figcaption></figure>
|
||||
|
||||
Data DAOs present a fascinating use case whenever a group of individuals desires to collectively manage data or consolidate data for increased bargaining power. Such DAOs can take the form of unions, cooperatives, or trusts.
|
||||
|
||||
@ -77,4 +77,4 @@ Alternatively, you can manually configure the network on Metamask by using the f
|
||||
| Currency Symbol | `MATIC` |
|
||||
| Block Explorer URL | [`https://polygonscan.com`](https://polygonscan.com) |
|
||||
|
||||
Follow our guide to learn how to use those values to [set up a custom network in MetaMask](../metamask-setup.md#set-up-custom-network).
|
||||
Follow our guide to learn how to use those values to [set up a custom network in MetaMask](../wallets/metamask-setup.md#set-up-custom-network).
|
||||
|
||||
@ -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/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### What is a wallet?
|
||||
|
||||
@ -12,27 +12,27 @@ Before you can publish or purchase assets, you will need a crypto wallet. As Met
|
||||
|
||||
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.
|
||||
|
||||
@ -42,7 +42,7 @@ Sometimes it is required to use custom or external networks in MetaMask. We can
|
||||
|
||||
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 in:
|
||||
|
||||
@ -25,6 +25,6 @@ The Ocean Market is a place for buyers + sellers of top-notch data and algorithm
|
||||
|
||||
**If you are new to web3** and blockchain technologies then we suggest you first get familiar with some Web3 basics:
|
||||
|
||||
* [Wallet Basics](../discover/wallets.md) 👛
|
||||
* [Set Up MetaMask](../discover/metamask-setup.md) [Wallet ](../discover/metamask-setup.md)🦊
|
||||
* [Wallet Basics](../discover/wallets/) 👛
|
||||
* [Set Up MetaMask](../discover/wallets/metamask-setup.md) [Wallet ](../discover/wallets/metamask-setup.md)🦊
|
||||
* [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md) 🪙
|
||||
|
||||
Loading…
Reference in New Issue
Block a user