Update cli docs

nevermined-io · Jun 6, 2024 · 47726fd · 47726fd
1 parent 7bc53ef
commit 47726fd
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 82 deletions.
diff --git 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` |  &#x2612;  |  ``  | 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` |  &#x2612;  |    | 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<br/>
-
-It decrypts a previously encrypted file using the password provided.<br/>
-
-#### 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<br/>
-
-It encrypts a file using the password provided.<br/>
-
-#### 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<br/>
 
@@ -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` |  &#x2612;  |    | The identifier of the agreement created by the buyer |
+| **numCredits** | `number` |  &#x2612;  |    | The number of credits to order |
 
 
 #### Example/s

diff --git 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/<br/>
 
  **Testnet** 
-The Native token is **ETH**. This environment has the network name **geth-localnet** and the chain id/network id **1337**. <br/>
+The Native token is **ETH**. This environment has the network name **geth-localnet** and the chain id/network id **undefined**. <br/>
 
 ### 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.<br/>
 
  **Testnet** 
-The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **421614**. <br/>
+The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **undefined**. <br/>
 
 ### 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. <br/>
-The Nevermined Node can be found on https://node.staging.nevermined.app and uses the public address **0x046d0698926aFa3ab6D6591f03063488F3Fb4327**.<br/>
+The Nevermined Node can be found on https://node.staging.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.<br/>
 
 
 
 
 
-## appMumbai
-Nevermined One testnet environment where users can interact with Nevermined protocol.<br/>
-
- **Testnet** 
-The Native token is **MATIC**. This environment has the network name **mumbai** and the chain id/network id **80001**. <br/>
-
-### 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. <br/>
-The Nevermined Node can be found on https://node.mumbai.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.<br/>
- The subgraphs to fetch contracts events can be found on https://api.thegraph.com/subgraphs/name/nevermined-io/public .<br/>
-
-
-
-
 ## appMatic
 The Polygon production environment where users can interact with Nevermined protocol.<br/>
 
  **Production Environment** 
-The Native token is **MATIC**. This environment has the network name **matic** and the chain id/network id **137**. <br/>
+The Native token is **MATIC**. This environment has the network name **matic** and the chain id/network id **undefined**. <br/>
 
 ### 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. <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/>
@@ -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.<br/>
 
  **Testnet** 
-The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **421614**. <br/>
+The Native token is **ETH**. This environment has the network name **arbitrum-sepolia** and the chain id/network id **undefined**. <br/>
 
 ### 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. <br/>
-The Nevermined Node can be found on https://node.testing.nevermined.app and uses the public address **0x046d0698926aFa3ab6D6591f03063488F3Fb4327**.<br/>
+The Nevermined Node can be found on https://node.testing.nevermined.app and uses the public address **0x5838B5512cF9f12FE9f2beccB20eb47211F9B0bc**.<br/>
 
 
 
@@ -95,28 +79,76 @@ 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.<br/>
 
  **Production Environment** 
-The Native token is **ETH**. This environment has the network name **arbitrum-one** and the chain id/network id **42161**. <br/>
+The Native token is **ETH**. This environment has the network name **arbitrum-one** and the chain id/network id **undefined**. <br/>
 
 ### 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. <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/>
 
 
 
 
+## appBase
+The Base production environment where users can interact with Nevermined protocol.<br/>
+
+ **Production Environment** 
+The Native token is **ETH**. This environment has the network name **base** and the chain id/network id **undefined**. <br/>
+
+### 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. <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/>
+
+
+
+
 ## appGnosis
 The Gnosis production environment where users can interact with Nevermined protocol.<br/>
 
  **Production Environment** 
-The Native token is **xDAI**. This environment has the network name **gnosis** and the chain id/network id **100**. <br/>
+The Native token is **xDAI**. This environment has the network name **gnosis** and the chain id/network id **undefined**. <br/>
 
 ### 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. <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/>
 
+
+
+
+## appOptimism
+The Optimism production environment where users can interact with Nevermined protocol.<br/>
+
+ **Production Environment** 
+The Native token is **ETH**. This environment has the network name **optimism** and the chain id/network id **undefined**. <br/>
+
+### 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. <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/>
+
+
+
+
+## appCelo
+The Celo production environment where users can interact with Nevermined protocol.<br/>
+
+ **Production Environment** 
+The Native token is **CELO**. This environment has the network name **celo** and the chain id/network id **undefined**. <br/>
+
+### 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. <br/>
+The Nevermined Node can be found on http://node.celo.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
+
+