diff --git a/README.md b/README.md index 1a2e717c..d17f3b20 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ description: Help for wherever you are on your Ocean Protocol journey. cover: .gitbook/assets/cover/contribute_banner.png coverY: 0 +layout: landing --- # 👋 Welcome diff --git a/developers/ddo-specification.md b/developers/ddo-specification.md index 54ff12fa..9cc98f0d 100644 --- a/developers/ddo-specification.md +++ b/developers/ddo-specification.md @@ -90,16 +90,7 @@ ArrayOfOptions options A DDO in Ocean has these required attributes: -| Attribute | Type | Description | -| ----------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| **`@context`** | Array of `string` | Contexts used for validation. | -| **`id`** | `string` | Computed as `sha256(address of ERC721 contract + chainId)`. | -| **`version`** | `string` | Version information in [SemVer](https://semver.org) notation referring to this DDO spec version, like `4.1.0`. | -| **`chainId`** | `number` | Stores chainId of the network the DDO was published to. | -| **`nftAddress`** | `string` | NFT contract linked to this asset | -| **`metadata`** | [Metadata](did-ddo.md#metadata) | Stores an object describing the asset. | -| **`services`** | [Services](did-ddo.md#services) | Stores an array of services defining access to the asset. | -| **`credentials`** | [Credentials](did-ddo.md#credentials) | Describes the credentials needed to access a dataset in addition to the `services` definition. | +
AttributeTypeDescription
@contextArray of stringContexts used for validation.
idstringComputed as sha256(address of ERC721 contract + chainId).
versionstringVersion information in SemVer notation referring to this DDO spec version, like 4.1.0.
chainIdnumberStores chainId of the network the DDO was published to.
nftAddressstringNFT contract linked to this asset
metadataMetadataStores an object describing the asset.
servicesServicesStores an array of services defining access to the asset.
credentialsCredentialsDescribes the credentials needed to access a dataset in addition to the services definition.
@@ -242,22 +233,7 @@ A DDO in Ocean has these required attributes: This object holds information describing the actual asset. -| Attribute | Type | Description | -| --------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`created`** | `ISO date/time string` | Contains the date of the creation of the dataset content in ISO 8601 format preferably with timezone designators, e.g. `2000-10-31T01:30:00Z`. | -| **`updated`** | `ISO date/time string` | Contains the date of last update of the dataset content in ISO 8601 format preferably with timezone designators, e.g. `2000-10-31T01:30:00Z`. | -| **`description`**\* | `string` | Details of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for. | -| **`copyrightHolder`** | `string` | The party holding the legal copyright. Empty by default. | -| **`name`**\* | `string` | Descriptive name or title of the asset. | -| **`type`**\* | `string` | Asset type. Includes `"dataset"` (e.g. csv file), `"algorithm"` (e.g. Python script). Each type needs a different subset of metadata attributes. | -| **`author`**\* | `string` | Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.). | -| **`license`**\* | `string` | Short name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ). If it's not specified, the following value will be added: "No License Specified". | -| **`links`** | Array of `string` | Mapping of URL strings for data samples, or links to find out more information. Links may be to either a URL or another asset. | -| **`contentLanguage`** | `string` | The language of the content. Use one of the language codes from the [IETF BCP 47 standard](https://tools.ietf.org/html/bcp47) | -| **`tags`** | Array of `string` | Array of keywords or tags used to describe this content. Empty by default. | -| **`categories`** | Array of `string` | Array of categories associated to the asset. Note: recommended to use `tags` instead of this. | -| **`additionalInformation`** | Object | Stores additional information, this is customizable by publisher | -| **`algorithm`**\*\* | [Algorithm Metadata](did-ddo.md#algorithm-metadata) | Information about asset of `type` `algorithm` | +
AttributeTypeDescription
createdISO date/time stringContains the date of the creation of the dataset content in ISO 8601 format preferably with timezone designators, e.g. 2000-10-31T01:30:00Z.
updatedISO date/time stringContains the date of last update of the dataset content in ISO 8601 format preferably with timezone designators, e.g. 2000-10-31T01:30:00Z.
description*stringDetails of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for.
copyrightHolderstringThe party holding the legal copyright. Empty by default.
name*stringDescriptive name or title of the asset.
type*stringAsset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script). Each type needs a different subset of metadata attributes.
author*stringName of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
license*stringShort name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ). If it's not specified, the following value will be added: "No License Specified".
linksArray of stringMapping of URL strings for data samples, or links to find out more information. Links may be to either a URL or another asset.
contentLanguagestringThe language of the content. Use one of the language codes from the IETF BCP 47 standard
tagsArray of stringArray of keywords or tags used to describe this content. Empty by default.
categoriesArray of stringArray of categories associated to the asset. Note: recommended to use tags instead of this.
additionalInformationObjectStores additional information, this is customizable by publisher
algorithm**Algorithm MetadataInformation about asset of type algorithm
\* Required @@ -289,19 +265,7 @@ 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. | -| **`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. | -| **`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 | +
AttributeTypeDescription
id*stringUnique ID
type*stringType of service access, compute, wss etc.
namestringService friendly name
descriptionstringService description
datatokenAddress*stringDatatoken
serviceEndpoint*stringProvider URL (schema + host)
files*FilesEncrypted file.
timeout*numberDescribing how long the service can be used after consumption is initiated. A timeout of 0 represents no time limit. Expressed in seconds.
compute**ComputeIf service is of type compute, holds information about the compute-related privacy settings & resources.
consumerParametersConsumer ParametersAn object the defines required consumer input before consuming the asset
additionalInformationObjectStores additional information, this is customizable by publisher
\* Required @@ -408,14 +372,7 @@ _Aquarius_ should always verify the checksum after data is decrypted via a _Prov Each asset has a state, which is held by the NFT contract. The possible states are: -| State | Description | Discoverable in Ocean Market | Ordering allowed | Listed under profile | -| ------- | ------------------------------ | ---------------------------- | ---------------- | -------------------- | -| **`0`** | Active | Yes | Yes | Yes | -| **`1`** | End-of-life | No | No | No | -| **`2`** | Deprecated (by another asset) | No | No | No | -| **`3`** | Revoked by publisher | No | No | No | -| **`4`** | Ordering is temporary disabled | Yes | No | Yes | -| **`5`** | Asset unlisted. | No | Yes | Yes | +
StateDescriptionDiscoverable in Ocean MarketOrdering allowedListed under profile
0ActiveYesYesYes
1End-of-lifeNoNoNo
2Deprecated (by another asset)NoNoNo
3Revoked by publisherNoNoNo
4Ordering is temporary disabledYesNoYes
5Asset unlisted.NoYesYes
### Aquarius Enhanced DDO Response @@ -427,15 +384,7 @@ These additional fields are never stored on-chain, and are never taken into cons The `nft` object contains information about the ERC721 NFT contract which represents the intellectual property of the publisher. -| Attribute | Type | Description | -| -------------- | ---------------------- | ----------------------------------------------------------------------------------- | -| **`address`** | `string` | Contract address of the deployed ERC721 NFT contract. | -| **`name`** | `string` | Name of NFT set in contract. | -| **`symbol`** | `string` | Symbol of NFT set in contract. | -| **`owner`** | `string` | ETH account address of the NFT owner. | -| **`state`** | `number` | State of the asset reflecting the NFT contract value. See [State](did-ddo.md#state) | -| **`created`** | `ISO date/time string` | Contains the date of NFT creation. | -| **`tokenURI`** | `string` | tokenURI | +
AttributeTypeDescription
addressstringContract address of the deployed ERC721 NFT contract.
namestringName of NFT set in contract.
symbolstringSymbol of NFT set in contract.
ownerstringETH account address of the NFT owner.
statenumberState of the asset reflecting the NFT contract value. See State
createdISO date/time stringContains the date of NFT creation.
tokenURIstringtokenURI
@@ -460,12 +409,7 @@ The `nft` object contains information about the ERC721 NFT contract which repres The `datatokens` array contains information about the ERC20 datatokens attached to [asset services](did-ddo.md#services). -| Attribute | Type | Description | -| --------------- | -------- | ------------------------------------------------ | -| **`address`** | `string` | Contract address of the deployed ERC20 contract. | -| **`name`** | `string` | Name of NFT set in contract. | -| **`symbol`** | `string` | Symbol of NFT set in contract. | -| **`serviceId`** | `string` | ID of the service the datatoken is attached to. | +
AttributeTypeDescription
addressstringContract address of the deployed ERC20 contract.
namestringName of NFT set in contract.
symbolstringSymbol of NFT set in contract.
serviceIdstringID of the service the datatoken is attached to.
@@ -518,10 +462,7 @@ The `event` section contains information about the last transaction that created Contains information about an asset's purgatory status defined in [`list-purgatory`](https://github.com/oceanprotocol/list-purgatory). Marketplace interfaces are encouraged to prevent certain user actions like adding liquidity on assets in purgatory. -| Attribute | Type | Description | -| ------------ | --------- | --------------------------------------------------------------------------------------------- | -| **`state`** | `boolean` | If `true`, asset is in purgatory. | -| **`reason`** | `string` | If asset is in purgatory, contains the reason for being there as defined in `list-purgatory`. | +
AttributeTypeDescription
statebooleanIf true, asset is in purgatory.
reasonstringIf asset is in purgatory, contains the reason for being there as defined in list-purgatory.
@@ -543,9 +484,7 @@ Contains information about an asset's purgatory status defined in [`list-purgato The `stats` section contains different statistics fields. -| Attribute | Type | Description | -| ------------ | -------- | ------------------------------------------------------------------------------------------------------------ | -| **`orders`** | `number` | How often an asset was ordered, meaning how often it was either downloaded or used as part of a compute job. | +
AttributeTypeDescription
ordersnumberHow often an asset was ordered, meaning how often it was either downloaded or used as part of a compute job.
diff --git a/user-guides/asset-hosting/github.md b/user-guides/asset-hosting/github.md index b961187b..7ddaf964 100644 --- a/user-guides/asset-hosting/github.md +++ b/user-guides/asset-hosting/github.md @@ -14,11 +14,11 @@ Create an account on [Github](https://github.com/). Users might also be asked to **Step 1 - Create a new repository on GitHub or navigate to an existing repository where you want to host your files.** -

If you are creating a new repository, then click on the green New button.

+

Create new repository

Fill in the repository details. **Make sure your Repo is public.** -
+

Make the repository public

### Host Your File @@ -26,21 +26,21 @@ Fill in the repository details. **Make sure your Repo is public.** Go to your repo in Github and above the list of files, select the Add file dropdown menu and click Upload files. Alternatively, you can use version control to push your file to the repo. -
+

Upload file on Github

To select the files you want to upload, drag and drop the file or folder, or click 'choose your files'. -
+

Drag and drop new files on your GitHub repo

In the "Commit message" field, type a short, meaningful commit message that describes the change you made. -
+

Commit changes

Below the commit message field, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, then you should choose to create a new branch for your commit and then create a pull request. After you make your commit (and merge your pull request, if applicable), then click on the file. -
+

Upload successful

**Step 3 - Get the RAW version of your file** @@ -54,13 +54,13 @@ Copy the link in your browser's URL - it should begin with "https://raw.githubus

Grab the RAW github URL from your browser's URL bar

-
+

Copy paste the raw url

**Step 4 - Publish the asset using the Raw link** Now, copy and paste the Raw Github URL into the File field of the Access page in the Ocean Market. -
+

Upload on the Ocean Market

Et voilà! You have now successfully hosted your asset on Github and properly linked it on the Ocean Market.