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

clarifications, update DDO flow image

Browse Source
This commit is contained in:
Matthias Kretschmann 2021-11-04 20:10:21 +01:00
parent a68f1dcee3
commit a505f35add
Signed by: m
GPG Key ID: 606EEEF3C479A91F
4 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
content/concepts/did-ddo.md
View File

@ -31,7 +31,7 @@ The DDO is stored on-chain as part of the NFT contract and it is stored encrypte
Here is the complete flow: Here is the complete flow:
![DDO_flow](images/DDO_flow.png) ![DDO_flow](images/ddo-flow.png)
```text ```text
title DDO flow title DDO flow
@ -118,15 +118,15 @@ Example:
#### Algorithm Metadata #### Algorithm Metadata
An asset of type `algorithm` has the following additional attributes under `algorithm` within the `metadata` object: An asset of type `algorithm` has additional attributes under `metadata.algorithm`, describing the algorithm and the Docker environment it is supposed to be run under.
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------------- | ----------- | -------- | ------------------------------------------------------- | | --------------- | ----------- | -------- | ------------------------------------------------------------------------------------------ |
| **`language`** | `string` | | Language used to implement the software. | | **`language`** | `string` | | Language used to implement the software. |
| **`version`** | `string` | | Version of the software. | | **`version`** | `string` | | Version of the software preferably in [SemVer](https://semver.org) notation. E.g. `1.0.0`. |
| **`container`** | `container` | **✓** | Object describing the Docker container image. See below | | **`container`** | `container` | **✓** | Object describing the Docker container image. See below |
The `container` object has the following attributes defining the Docker image the algorithm needs to run: The `container` object has the following attributes defining the Docker image for running the algorithm:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| ---------------- | -------- | -------- | ----------------------------------------------------------------- | | ---------------- | -------- | -------- | ----------------------------------------------------------------- |
@ -145,7 +145,7 @@ The `container` object has the following attributes defining the Docker image th
"license": "https://market.oceanprotocol.com/terms", "license": "https://market.oceanprotocol.com/terms",
"algorithm": { "algorithm": {
"language": "Node.js", "language": "Node.js",
"version": "v1", "version": "1.0.0",
"container": { "container": {
"entrypoint": "node $ALGO", "entrypoint": "node $ALGO",
"image": "ubuntu", "image": "ubuntu",
@ -171,7 +171,7 @@ Example:
### Services ### Services
Services define the access to the asset, and each service is represented by its respective datatoken. Services define the access for an asset, and each service is represented by its respective datatoken.
An asset should have at least one service to be actually accessible, but can have as many services which make sense for a specific use case. An asset should have at least one service to be actually accessible, but can have as many services which make sense for a specific use case.
@ -359,14 +359,14 @@ These additional fields are never stored on-chain, and are never taken into cons
### NFT ### NFT
The `nft` object contains information about the NFT contract which represents the intellectual property of the publisher. The `nft` object contains information about the ERC721 NFT contract which represents the intellectual property of the publisher.
| Attribute | Type | Description | | Attribute | Type | Description |
| ------------- | -------- | ---------------------------------------------- | | ------------- | -------- | ----------------------------------------------------- |
| **`address`** | `string` | Contract address of the deployed NFT contract. | | **`address`** | `string` | Contract address of the deployed ERC721 NFT contract. |
| **`name`** | `string` | Name of NFT set in contract. | | **`name`** | `string` | Name of NFT set in contract. |
| **`symbol`** | `string` | Symbol of NFT set in contract. | | **`symbol`** | `string` | Symbol of NFT set in contract. |
| **`owner`** | `string` | ETH account address of the NFT owner. | | **`owner`** | `string` | ETH account address of the NFT owner. |
Example: Example:

BIN
content/concepts/images/DDO_flow.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 68 KiB

BIN
content/concepts/images/ddo-content.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 30 KiB

BIN
content/concepts/images/ddo-flow.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 102 KiB