Skip to content

Commit

Permalink
Several documentation fixes (#192)
Browse files Browse the repository at this point in the history 
* fix: remove edit link

* fix: docs fixes
  • Loading branch information
@aaitor
aaitor authored Dec 13, 2024
1 parent 8d018a0 commit 5b4a10b
Show file tree
Hide file tree
Showing 10 changed files with 105 additions and 89 deletions.
5 changes: 0 additions & 5 deletions docs/cli/environments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ The Native token is **MATIC**. This environment has the network name **matic** a
The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.matic.nevermined.app. <br/>
The Nevermined Node can be found on https://node.matic.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>



Expand Down Expand Up @@ -86,7 +85,6 @@ The Native token is **ETH**. This environment has the network name **arbitrum-on
The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.arbitrum.nevermined.app. <br/>
The Nevermined Node can be found on https://node.arbitrum.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>



Expand All @@ -102,7 +100,6 @@ The Native token is **ETH**. This environment has the network name **base** and
The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.base.nevermined.app. <br/>
The Nevermined Node can be found on https://node.base.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>



Expand All @@ -118,7 +115,6 @@ The Native token is **xDAI**. This environment has the network name **gnosis** a
The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.gnosis.nevermined.app. <br/>
The Nevermined Node can be found on https://node.gnosis.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>



Expand All @@ -134,7 +130,6 @@ The Native token is **ETH**. This environment has the network name **optimism**
The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.optimism.nevermined.app. <br/>
The Nevermined Node can be found on https://node.optimism.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>



Expand Down
20 changes: 8 additions & 12 deletions docs/environments/nvm-dev-envs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -706,14 +706,14 @@
}
</style>
<style>
.task-list-item {
list-style-type: none;
}

.task-list-item-checkbox {
margin-left: -20px;
vertical-align: middle;
pointer-events: none;
.task-list-item {
list-style-type: none;
}

.task-list-item-checkbox {
margin-left: -20px;
vertical-align: middle;
pointer-events: none;
}
</style>
<style>
Expand Down Expand Up @@ -904,10 +904,6 @@ <h3 id="public-mumbai-deployment-v3-1">Public Mumbai deployment (v3)</h3>
</tr>
</tbody>
</table>
<p>All the contract events are exposed via <a href="https://thegraph.com/">The Graph</a>. You can find all the <code>Polygon Mumbai</code> Nevermined Subgraphs here (search by Nevermined):</p>
<p><a href="https://thegraph.com/hosted-service">https://thegraph.com/hosted-service</a></p>
<p>For example for Nevermined Polygon Mumbai:</p>
<p><a href="https://thegraph.com/hosted-service/subgraph/nevermined-io/publicmumbaiv2neverminedtoken">https://thegraph.com/hosted-service/subgraph/nevermined-io/publicmumbaiv2neverminedtoken</a></p>



Expand Down
23 changes: 10 additions & 13 deletions docs/environments/nvm-dev-envs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,17 @@ The network fee in Nevermined testnets is **1%** and the receiver of that fee is

## Testing - (Arbitrum Sepolia)

### Public Arbitrum sepolia deployment (v3)
This is a **testing** network deployment of the Nevermined Protocol in the Arbitrum Sepolia network. You can use this network if you want to integrate with Nevermined in a Arbitrum Testnet.

This is a **public** network deployment (`TAG_NAME=public`) of the Nevermined Contracts v3 in the Arbitrum Sepolia network. You can use this network if you want to integrate with Nevermined in a Arbitrum Testnet.

The **addresses** of the Nevermined Contracts can be found here: https://artifacts.nevermined.network/421614/public/contracts_v3.5.7.json
* Network: **Arbitrum Sepolia**
* Contracts Version: **3.5.9**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/421614/public/contracts_v3.5.9.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/421614/public/contracts_v3.5.9.json)

The **ABIs of the contracts** to connect via SDK can be download from here: https://artifacts.nevermined.network/421614/public/contracts_v3.5.7.tar.gz

| Environment | Network | Contracts Version | Tag | Component | URL | Comments |
|-------------|---------|-------------------|-----|-----------|-----|----------|
| [public-v3-arbitrum-sepolia](https://artifacts.nevermined.network/421614/public/contracts_v3.5.7.json) | Arbitrum Sepolia | 3.5.7 | public | Node | https://node.testing.nevermined.app | |
| public-v3-arbitrum-sepolia | Arbitrum Sepolia | - | public | Marketplace API | https://marketplace-api.testing.nevermined.app | |

All the contract events are exposed via [The Graph](https://thegraph.com/). You can find all the `Arbitrum Sepolia` Nevermined Subgraphs here (search by Nevermined):

https://thegraph.com/hosted-service
| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.testing.nevermined.app | |
| Proxy | https://proxy.testing.nevermined.app | |
| Marketplace API | https://marketplace-api.testing.nevermined.app | |

101 changes: 68 additions & 33 deletions docs/environments/nvm-prod-envs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,64 +18,99 @@ The network fee in Nevermined production environments is **1%** and the receiver

## Production environment (Arbitrum)

* Network: **Arbitrum One**
* Contracts Version: **3.5.9**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/42161/public/contracts_v3.5.9.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/42161/public/contracts_v3.5.9.json)

### Version 3.5.7

| Environment | Network | Contracts Version | Tag | Component | URL | Comments |
|-------------|---------|-------------------|-----|-----------|-----|----------|
| public-nvm-v3-arbitrum | Arbitrum One | 3.5.7 | public | Node | https://node.arbitrum.nevermined.app | |
| public-nvm-v3-arbitrum | Arbitrum | 3.5.7 | public | Marketplace API | https://marketplace-api.arbitrum.nevermined.app | |

All the contract events are exposed via [The Graph](https://thegraph.com/). You can find all the `Arbitrum` Nevermined Subgraphs here (search by Nevermined):
| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.arbitrum.nevermined.app | |
| Proxy | https://proxy.arbitrum.nevermined.app | |
| Marketplace API | https://marketplace-api.arbitrum.nevermined.app | |

## Polygon environment

### Version 3.5.7

| Environment | Network | Contracts Version | Tag | Component | URL | Comments |
|-------------|---------|-------------------|-----|-----------|-----|----------|
| public-nvm-v3-matic | Polygon Matic | 3.5.7 | public | Node | https://node.matic.nevermined.app | |
| public-nvm-v3-matic | Polygon Matic | 3.5.7 | public | Marketplace API | https://marketplace-api.matic.nevermined.app | |

All the contract events are exposed via [The Graph](https://thegraph.com/). You can find all the `Polygon Matic` Nevermined Subgraphs here (search by Nevermined):

https://thegraph.com/hosted-service
* Network: **Polygon Matic**
* Contracts Version: **3.5.9**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/137/public/contracts_v3.5.9.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/137/public/contracts_v3.5.9.json)

For example for Nevermined Polygon Matic:
| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.matic.nevermined.app | |
| Proxy | https://proxy.matic.nevermined.app | |
| Marketplace API | https://marketplace-api.matic.nevermined.app | |

https://thegraph.com/hosted-service/subgraph/nevermined-io/publicmaticv2neverminedtoken

## Gnosis

The `v3.5.7` contracts are also deployed in the **Gnosis** network:
* Network: **Gnosis**
* Contracts Version: **3.5.7**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/100/public/contracts_v3.5.7.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/100/public/contracts_v3.5.7.json)

| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.gnosis.nevermined.app | |
| Proxy | https://proxy.gnosis.nevermined.app | |
| Marketplace API | https://marketplace-api.gnosis.nevermined.app | |

* Smart Contract addresses can be found [here](https://artifacts.nevermined.network/100/public/contracts_v3.5.7.json)
* The ABIs of the contracts to connect via SDK can be downloaded from [here](https://artifacts.nevermined.network/100/public/contracts_v3.5.7.tar.gz)

## Optimism

The `v3.5.7` contracts are also deployed in the **Optimism Mainnet** network:
* Network: **Optimism Mainnet**
* Contracts Version: **3.5.7**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/10/public/contracts_v3.5.7.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/10/public/contracts_v3.5.7.json)

| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.optimism.nevermined.app | |
| Proxy | https://proxy.optimism.nevermined.app | |
| Marketplace API | https://marketplace-api.optimism.nevermined.app | |

* Smart Contract addresses can be found [here](https://artifacts.nevermined.network/10/public/contracts_v3.5.7.json)
* The ABIs of the contracts to connect via SDK can be downloaded from [here](https://artifacts.nevermined.network/10/public/contracts_v3.5.7.tar.gz)

## Base

The `v3.5.7` contracts are also deployed in the **Base Mainnet** network:
* Network: **Base**
* Contracts Version: **3.5.7**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/8453/public/contracts_v3.5.7.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/8453/public/contracts_v3.5.7.json)

| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.base.nevermined.app | |
| Proxy | https://proxy.base.nevermined.app | |
| Marketplace API | https://marketplace-api.base.nevermined.app | |

* Smart Contract addresses can be found [here](https://artifacts.nevermined.network/8453/public/contracts_v3.5.7.json)
* The ABIs of the contracts to connect via SDK can be downloaded from [here](https://artifacts.nevermined.network/8453/public/contracts_v3.5.7.tar.gz)

## Peaq

The `v3.5.7` contracts are also deployed in the **Base Mainnet** network:
* Network: **Peaq Mainnet**
* Contracts Version: **3.5.9**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/3338/public/contracts_v3.5.9.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/3338/public/contracts_v3.5.9.json)

| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.peaq.nevermined.app | |
| Proxy | https://proxy.peaq.nevermined.app | |
| Marketplace API | https://marketplace-api.peaq.nevermined.app | |


* Smart Contract addresses can be found [here](https://artifacts.nevermined.network/3338/public/contracts_v3.5.7.json)
* The ABIs of the contracts to connect via SDK can be downloaded from [here](https://artifacts.nevermined.network/3338/public/contracts_v3.5.7.tar.gz)

## Celo

The `v3.5.7` contracts are also deployed in the **Celo Mainnet** network:
* Network: **Celo Mainnet**
* Contracts Version: **3.5.7**
* [Contracts Artifacts - ABIs](https://artifacts.nevermined.network/42220/public/contracts_v3.5.7.tar.gz)
* [Contracts Addresses](https://artifacts.nevermined.network/42220/public/contracts_v3.5.7.json)

* Smart Contract addresses can be found [here](https://artifacts.nevermined.network/42220/public/contracts_v3.5.7.json)
* The ABIs of the contracts to connect via SDK can be downloaded from [here](https://artifacts.nevermined.network/42220/public/contracts_v3.5.7.tar.gz)
| Component | URL | Comments |
|-----------|-----|-------------------|
| Node | https://node.celo.nevermined.app | |
| Proxy | https://proxy.celo.nevermined.app | |
| Marketplace API | https://marketplace-api.celo.nevermined.app | |
2 changes: 1 addition & 1 deletion docs/nevermined-sdk/example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export const neverminedNodeAddress =
export const marketplaceUri = 'https://marketplace-api.testing.nevermined.app'

// The url of the The Graph deployment of Nevermined
const graphHttpUri = process.env.GRAPH_HTTP_URI || 'https://api.thegraph.com/subgraphs/name/nevermined-io/public'
const graphHttpUri = process.env.GRAPH_HTTP_URI

// represent USDC token in arbitrum-sepolia that can be claimed in the faucet https://faucet.circle.com/
export const erc20TokenAddress = process.env.ERC20_TOKEN_ADDRESS || '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d'
Expand Down
2 changes: 1 addition & 1 deletion docs/protocol/foundations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ With the intention of providing answers to the previous problems, in Nevermined

## Registration

Allow the registration of AI Agents, File Assets (datasets, reports, output files, etc.) and Payment Plans. Payment Plans have a price (ERC20 & Native tokens supported) and the purchase of the plan gives access to all the assets (agents, files, etc).
Allow the registration of AI Agents, File Assets (datasets, reports, output files, etc.) and Payment Plans. Payment Plans have a price (Fiat and crypto payments via ERC20 & Native tokens supported) and the purchase of the plan gives access to all the assets (agents, files, etc).

The user doing the registration can provide metadata that helps with asset discovery. Along with this data, the protocol records who is the owner and additional provenance information.

Expand Down
12 changes: 9 additions & 3 deletions docs/protocol/user-flows.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,18 @@ If the request sent by the user was processed correctly, Nevermined infrastructu

It allows the registration of assets (agents, models, payment plans, etc) in a Nevermined network. The registration happens directly from the Publisher and involves the following steps:

1. The publisher locally computes the DID using the Metadata and registers it on-chain in the DIDRegistry contract associated with the URL where the metadata will be stored
1. The publisher locally computes the unique identifier of the asset (aka [DID](architecture/specs/Spec-DID.md)) using the [Metadata](../architecture/specs/Spec-METADATA.md) and registers it on-chain in the DIDRegistry contract associated with the URL where the metadata will be stored
2. The publisher stores the metadata and any existing Metadata API implementation

Having a DID any user can resolve the metadata by having the DID query the DIDRegistry Smart Contract:
:::info

1. The user having the DID can get the full metadata url
A DID stands for Decentralized Identifier. You can find further information about the DID standard in the [W3C DID specification](https://www.w3.org/TR/did-core/) and how this is used on the Nevermined Protocol [here](../architecture/specs/Spec-DID).

:::

Having a DID of an asset, any user can resolve the metadata describing that asset:

1. The user having the DID can get the full metadata url from the `DIDRegistry` contract
2. Having the metadata url the user can fetch the complete metadata from the Metadata API

![Sequence Diagram Registration](images/sequience_registration.png)
Loading

0 comments on commit 5b4a10b

Please sign in to comment.