From 47726fd2cb2b6d01be8c5edf784f6aca7e3b78c8 Mon Sep 17 00:00:00 2001 From: Nevermined BOT Date: Thu, 6 Jun 2024 12:46:01 +0000 Subject: [PATCH] Update cli docs --- docs/cli/cli_commands.md | 56 ++----------------------- docs/cli/environments.md | 90 +++++++++++++++++++++++++++------------- 2 files changed, 64 insertions(+), 82 deletions(-) diff --git a/docs/cli/cli_commands.md b/docs/cli/cli_commands.md index 0335e3b0c4..aedbd6e55a 100644 --- a/docs/cli/cli_commands.md +++ b/docs/cli/cli_commands.md @@ -843,7 +843,7 @@ A Smart Contract is represented by an ABI file that includes the definition of i | **symbol** | `string` | | `NVM` | The nft contract symbol | | **uri** | `string` | | | The nft metadata uri | | **cap** | `number` | | `0` | The max number of tokens created in this NFT contract. If 0 means unlimitted | -| **approve** | `array` | | | A list of addresses to be approved to manage the NFT contract | +| **operators** | `array` | ☒ | `` | A list of addresses to be approved to manage the NFT contract | | **addOperator** | `boolean` | | `true` | If true adds the Nevermined Transfer condition with permissions to mint NFTs | | **nftType** | `number` | | `721` | The NFT type | @@ -1299,7 +1299,7 @@ A Smart Contract is represented by an ABI file that includes the definition of i | **name** | `string` | | `NVM NFT` | The nft contract name | | **symbol** | `string` | | `NVM` | The nft contract symbol | | **uri** | `string` | | | The nft metadata uri | -| **approve** | `array` | | | A list of addresses to be approved to manage the NFT contract | +| **operators** | `array` | ☒ | | A list of addresses to be approved to manage the NFT contract | | **addOperator** | `boolean` | | `true` | If true adds the Nevermined Transfer condition with permissions to mint NFTs | | **nftType** | `number` | | `1155` | The NFT type | @@ -1691,57 +1691,6 @@ ncli utils upload README.md -### decrypt [file] -Decrypt a file
- -It decrypts a previously encrypted file using the password provided.
- -#### Positional Arguments - -| Name of the Argument | Type | Is required? | Default value | Description | -|----------------------|------|-------------:|--------------:|-------------| -| **file** | `string` | | | The path to the file to decrypt | -| **password** | `string` | | | The password to be used to decrypt the file | - - - -#### Example/s - - -```bash -ncli utils decrypt README.md --password 12345678 -``` - - - -### encrypt [file] -Encrypt a file
- -It encrypts a file using the password provided.
- -#### Positional Arguments - -| Name of the Argument | Type | Is required? | Default value | Description | -|----------------------|------|-------------:|--------------:|-------------| -| **file** | `string` | | | The path to the file to encrypt | - - -#### Optional Arguments - -| Name of the Argument | Type | Is required? | Default value | Description | -|----------------------|------|-------------:|--------------:|-------------| -| **password** | `string` | | | The password to be used to encrypt the file. If empty, a new password will be generated | - - -#### Example/s - - -```bash -ncli utils encrypt README.md --password 12345678 -``` - - - ### publish-nft-metadata It publish the metadata associated to a NFT into external storage
@@ -2085,6 +2034,7 @@ When a user orders an asset attached to a NFT, this command purchases that NFT a | Name of the Argument | Type | Is required? | Default value | Description | |----------------------|------|-------------:|--------------:|-------------| | **agreementId** | `string` | ☒ | | The identifier of the agreement created by the buyer | +| **numCredits** | `number` | ☒ | | The number of credits to order | #### Example/s diff --git a/docs/cli/environments.md b/docs/cli/environments.md index e4e848fa59..a18c43b6aa 100644 --- a/docs/cli/environments.md +++ b/docs/cli/environments.md @@ -15,7 +15,7 @@ Nevermined is a web3 developers framework that can be deployed and used across m This environment is used for local development. If you want to have a fully functional environment running on your computer, please visit https://github.com/nevermined-io/tools/
**Testnet** -The Native token is **ETH**. This environment has the network name **geth-localnet** and the chain id/network id **1337**.
+The Native token is **ETH**. This environment has the network name **geth-localnet** and the chain id/network id **undefined**.
### Nevermined configuration @@ -31,43 +31,27 @@ The Nevermined Node can be found on http://node.nevermined.localnet and uses the Nevermined One internal environment where Nevermined developers can integrate new versions of the application.
**Testnet** -The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **421614**.
+The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **undefined**.
### Nevermined configuration - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** + 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.staging.nevermined.app.
-The Nevermined Node can be found on https://node.staging.nevermined.app and uses the public address **0x046d0698926aFa3ab6D6591f03063488F3Fb4327**.
+The Nevermined Node can be found on https://node.staging.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.
-## appMumbai -Nevermined One testnet environment where users can interact with Nevermined protocol.
- - **Testnet** -The Native token is **MATIC**. This environment has the network name **mumbai** and the chain id/network id **80001**.
- -### Nevermined configuration - - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** -The Marketplace API used can be found on https://marketplace-api.mumbai.nevermined.app.
-The Nevermined Node can be found on https://node.mumbai.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.
- The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
- - - - ## appMatic The Polygon production environment where users can interact with Nevermined protocol.
**Production Environment** -The Native token is **MATIC**. This environment has the network name **matic** and the chain id/network id **137**.
+The Native token is **MATIC**. This environment has the network name **matic** and the chain id/network id **undefined**.
### Nevermined configuration - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** + 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.
The Nevermined Node can be found on https://node.matic.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
@@ -79,13 +63,13 @@ The Nevermined Node can be found on https://node.matic.nevermined.app and uses t Nevermined App (Arbitrum Sepolia) testnet environment where users can interact with Nevermined protocol.
**Testnet** -The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **421614**.
+The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **undefined**.
### Nevermined configuration - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** + 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.testing.nevermined.app.
-The Nevermined Node can be found on https://node.testing.nevermined.app and uses the public address **0x046d0698926aFa3ab6D6591f03063488F3Fb4327**.
+The Nevermined Node can be found on https://node.testing.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.
@@ -95,11 +79,11 @@ The Nevermined Node can be found on https://node.testing.nevermined.app and uses The Arbitrum One production environment where users can interact with Nevermined protocol.
**Production Environment** -The Native token is **ETH**. This environment has the network name **arbitrum-one** and the chain id/network id **42161**.
+The Native token is **ETH**. This environment has the network name **arbitrum-one** and the chain id/network id **undefined**.
### Nevermined configuration - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** + 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.
The Nevermined Node can be found on https://node.arbitrum.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
@@ -107,16 +91,64 @@ The Nevermined Node can be found on https://node.arbitrum.nevermined.app and use +## appBase +The Base production environment where users can interact with Nevermined protocol.
+ + **Production Environment** +The Native token is **ETH**. This environment has the network name **base** and the chain id/network id **undefined**.
+ +### Nevermined configuration + + 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.
+The Nevermined Node can be found on https://node.base.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
+ The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
+ + + + ## appGnosis The Gnosis production environment where users can interact with Nevermined protocol.
**Production Environment** -The Native token is **xDAI**. This environment has the network name **gnosis** and the chain id/network id **100**.
+The Native token is **xDAI**. This environment has the network name **gnosis** and the chain id/network id **undefined**.
### Nevermined configuration - The Nevermined contracts deployed have the version: **3.5.6** The Nevermined contracts are labeled with the tag name: **public** + 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.
The Nevermined Node can be found on https://node.gnosis.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
+ + + +## appOptimism +The Optimism production environment where users can interact with Nevermined protocol.
+ + **Production Environment** +The Native token is **ETH**. This environment has the network name **optimism** and the chain id/network id **undefined**.
+ +### Nevermined configuration + + 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.
+The Nevermined Node can be found on https://node.optimism.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
+ The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .
+ + + + +## appCelo +The Celo production environment where users can interact with Nevermined protocol.
+ + **Production Environment** +The Native token is **CELO**. This environment has the network name **celo** and the chain id/network id **undefined**.
+ +### Nevermined configuration + + 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.celo.nevermined.app.
+The Nevermined Node can be found on http://node.celo.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.
+ +