diff --git a/docs/cli/cli_commands/offers/index.md b/docs/cli/cli_commands/offers/index.md deleted file mode 100644 index fad2da67..00000000 --- a/docs/cli/cli_commands/offers/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: "cli-commands-offers" -title: "offers" -slug: "/cli_commands/offers" -sidebar_position: 6 - ---- - -This command group contains commands to view and manage [offers](/fundamentals/offers). Note that [Marketplace GUI](/developers/marketplace) can be more convenient to use than most of these commands. - -## Commands - -| **Command** | **Description** | -| :- | :- | -| [offers list](/cli/cli_commands/offers/offers/list) | Lists available offers. | -| [offers get](/cli/cli_commands/offers/offers/get) | Displays information on an offer. | -| [offers get-info](/cli/cli_commands/offers/offers/get-info) | Displays information on an offer as stored on the blockchain. | -| [offers download-content](/cli/cli_commands/offers/offers/download-content) | Downloads the content of an offer. | -| [offers update](/cli/cli_commands/offers/offers/update) | Updates an offer. | -| [offers disable](/cli/cli_commands/offers/offers/disable) | Disables an enabled offer. | -| [offers enable](/cli/cli_commands/offers/offers/enable) | Enables a disabled offer. | - -### Slot-related commands - -| **Command** | **Description** | -| :- | :- | -| [offers add-slot](/cli/cli_commands/offers/slots/add-slot) | Adds a new slot to an existing offer. | -| [offers update-slot](/cli/cli_commands/offers/slots/update-slot) | Updates a slot. | -| [offers delete-slot](/cli/cli_commands/offers/slots/delete-slot) | Deletes a slot. | -| [offers get-slot](/cli/cli_commands/offers/slots/get-slot) | Displays information on a slot. | - -### Option-related command - -This command only works with compute offers. - -| **Command** | **Description** | -| :- | :- | -| [offers get-option](/cli/cli_commands/offers/options/get-option) | Displays information for an option. | diff --git a/docs/cli/cli_commands/orders/index.md b/docs/cli/cli_commands/orders/index.md deleted file mode 100644 index 0637c7fe..00000000 --- a/docs/cli/cli_commands/orders/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: "cli-orders" -title: "orders" -slug: "/cli_commands/orders" -sidebar_position: 5 - ---- - -This command group contains commands to track and manage [orders](/fundamentals/orders). Note that [Marketplace GUI](/developers/marketplace) can be more convenient to use than most of the commands in this group. - -## Commands - -| **Command** | **Description** | -| :- | :- | -| [orders cancel](/cli/cli_commands/orders/cancel) | Cancels an order. | -| [orders download-result](/cli/cli_commands/orders/download-result) | Downloads the order result. | -| [orders get](/cli/cli_commands/orders/get) | Displays information on an order. | -| [orders list](/cli/cli_commands/orders/list) | Lists orders. | -| [orders replenish-deposit](/cli/cli_commands/orders/replenish-deposit) | Replenishes the order deposit. | \ No newline at end of file diff --git a/docs/cli/cli_commands/providers/index.md b/docs/cli/cli_commands/providers/index.md deleted file mode 100644 index 9a99bf59..00000000 --- a/docs/cli/cli_commands/providers/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: "providers" -title: "providers" -slug: "/cli_commands/providers" -sidebar_position: 7 - ---- - -This command group contains commands to view and update [providers](/fundamentals/offers). - -## Commands - -| **Command** | **Description** | -| :- | :- | -| [providers get](/cli/cli_commands/providers/get) | Displays information on a provider using its authority account address. | -| [providers update](/cli/cli_commands/providers/update) | Updates the current provider information. | -| [providers list](/cli/cli_commands/providers/list) | Lists all providers. | \ No newline at end of file diff --git a/docs/cli/cli_commands/workflows/create.md b/docs/cli/cli_commands/workflows/create.md deleted file mode 100644 index 8f3910fb..00000000 --- a/docs/cli/cli_commands/workflows/create.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -id: "create" -title: "workflows create" -slug: "/cli_commands/workflows/create" -sidebar_label: "create" ---- - -Creates a main compute order and necessary suborders: solution, data, and storage. - -The output of the command contains the order ID necessary to track and manage the order with the [`orders`](/cli/cli_commands/orders) commands or via the [Marketplace GUI](/developers/marketplace/). - -For solutions and data, you can add to an order either Marketplace [offers](/fundamentals/offers) or [uploaded files](/cli/cli_commands/files/upload). Refer to the [fundamentals](/fundamentals) and the [Marketplace Walkthrough](/developers/marketplace/walkthrough/) to understand the logic of the Super Protocol order creation process. - -## Syntax - -``` -./spctl workflows create \ - --solution {,[] | } [--solution ...] \ - --storage ,[] \ - [--data {,[] | }] [--data ...] \ - [--tee ,[]] \ - [--tee-slot-count ] \ - [--tee-options [ ...]] \ - [--tee-options-count [ ...]] \ - [--deposit ] \ - [--min-rent-minutes ] \ - [--config ] \ - [--help | -h] -``` - -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). - -## Options - -|
**Name**
| **Description** | -| :- | :- | -| `--solution {,[] │ }` | Solution you are adding to the order:

• For a Marketplace offer, state the solution offer ID and the solution [requirement slot](/fundamentals/slots#requirements) ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically.
• For an [uploaded](/cli/cli_commands/files/upload) solution, state the path to the solution resource JSON file.

You can use this option multiple times. | -| `--storage ,[]` | Storage offer you are adding to the order. State the storage offer ID and the storage requirement slot ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically. | -| `--data {,[] │ }` | Data you are adding to the order:

• For a Marketplace offer, state the data offer ID and the data requirement slot ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically.
• For [uploaded](/cli/cli_commands/files/upload) data, state the path to the data resource JSON file.

You can use this option multiple times.

Although this option is technically not mandatory, most solutions require data. | -| `--tee ,[]` | Compute offer you are adding to the order. State the compute offer ID and, optionally, the [configuration slot](/fundamentals/slots#configuration) ID, separated by a comma. If the configuration slot is not specified, it will be selected automatically.

If you do not use this option, the compute offer and its configuration will be selected automatically. | -| `--tee-slot-count ` | Configuration slot increments—how many times the selected slot is applied. Use this option together with `--tee`.

If you do not use this option, the increments will be calculated automatically. | -| `--tee-options [ ...]` | IDs of [configuration options](/fundamentals/slots#configuration) separated by spaces. Use `--tee-options` together with `--tee`.

If you do not use `--tee-options`, configuration options will be selected automatically. | -| `--tee-options-count [ ...]` | Increments for each configuration option separated by spaces. Use `--tee-options-count` together with `--tee` and `--tee-options`.

If you do not use `--tee-options-count`, increments will be calculated automatically. | -| `--deposit ` | [Deposit](/fundamentals/orders#lease-deposit-and-balance) in TEE tokens. The default is the minimum required deposit. | -| `--min-rent-minutes ` | Compute [lease time](/fundamentals/orders#lease-deposit-and-balance) in minutes. Using this option will increase the required deposit. The default is the minimum required time. | -| `--config ` | Path to the SPCTL configuration file. The default is `./config.json`. | -| `--help`, `-h` | Help for the command. | - -## Examples - -The following are three examples of using the `workflows create` command: - -- With automatic selection of a compute offer -- With manual selection of a compute offer -- With uploaded solution and data. - -### Example 1. Super Chat with automatic compute selection - -The following command deploys [Super Chat](/developers/offers/superchat): - -``` -./spctl workflows create \ - --solution 12,12 \ - --solution 6,2 \ - --data 17,22 \ - --storage 25,30 -``` - -Where: - -- `--solution 12,12`: [Tunnels Launcher](https://marketplace.superprotocol.com/solutions?offer=offerId%3D12) solution (offer ID 12, requirement slot ID 12) -- `--solution 6,2`: [Node.js Base Image](https://marketplace.superprotocol.com/?offer=offerId%3D6) solution (offer ID 6, requirement slot ID 2). Tunnels Launcher requires this solution to work -- `--data 17,22`: [Super Chat Config](https://marketplace.superprotocol.com/data?offer=offerId%3D17) dataset (offer ID 17, requirement slot ID 22) -- `--storage 25,30`: [Storj DCS Offer](https://marketplace.superprotocol.com/storage?offer=offerId%3D25) (offer ID 25, requirement slot ID 30) - -The absence of the `--tee` option means that the system will automatically select the most suitable compute offer and its configuration for your workload. However, in certain scenarios, you might want to specify the exact compute offer: - -``` -./spctl workflows create \ - --tee 4 \ - --solution 12,12 \ - --solution 6,2 \ - --data 17,22 \ - --storage 25,30 -``` - -The `--tee 4` option adds [TEE Offer #4](https://marketplace.superprotocol.com/compute?offer=offerId%3D4) (offer ID: 4) to the order. The lack of other `--tee`-related options and arguments lets the system determine the configuration slot and options automatically. - -### Example 2. Super Chat with manual compute selection - -The following command deploys [Super Chat](/developers/offers/superchat) without automatic selection: - -``` -./spctl workflows create \ - --tee 4,7 \ - --tee-slot-count 4 \ - --tee-options 10 \ - --tee-options-count 7 \ - --solution 12,12 \ - --solution 6,2 \ - --data 17,22 \ - --storage 25,30 \ - --deposit 2 \ - --min-rent-minutes 120 -``` - -Where: - -- `--tee 4,7`: [TEE Offer #4](https://marketplace.superprotocol.com/compute?offer=offerId%3D4) (offer ID: 4, configuration slot ID: 7) -- `--tee-slot-count 4`: four increments—apply the selected configuration slot four times -- `--tee-options 10`: configuration option with ID 10 -- `--tee-options-count 7`: seven increments—apply the selected configuration option seven times -- `--deposit 2`: deposit is 2 TEE tokens -- `--min-rent-minutes 120`: a minimum lease time is 120 minutes -- Other options are explained in the previous example. - -If the `--deposit` and `--min-rent-minutes` options are not specified, SPCTL uses the default minimums. The minimum lease time is the biggest of the minimum time values of all the offers in the order. - -For the offers in this example, the minimum deposit is 1.120 TEE tokens and the minimum lease time is 60 minutes: - -- The requirement slot with ID 7 of [TEE Offer #4](https://marketplace.superprotocol.com/compute?offer=offerId%3D4) has the minimum lease time of 10 minutes; four increments result in 40 minutes. -- The requirement slot with ID 12 of [Tunnels Launcher](https://marketplace.superprotocol.com/solutions?offer=offerId%3D12) (offer ID: 12) has the minimum lease time of 60 minutes. -- Other offers in the order do not restrict the minimum lease time. - -### Example 3. Uploaded solution and data - -The following command creates an order using an [uploaded](/cli/cli_commands/files/upload) solution and data instead of adding Marketplace offers: - -``` -./spctl workflows create \ - --solution ./python-solution.json \ - --solution 5,1 \ - --data ./data-input-1.json \ - --data ./data-input-2.json \ - --storage 25,30 -``` - -Where: - -- `--solution ./python-solution.json`: uploaded solution specified in the `python-solution.json` resource file in the SPCTL root directory -- `--solution 5,1`: [Python Base Image](https://marketplace.superprotocol.com/solutions?offer=offerId%3D5) (offer ID: 5, requirement slot: ID 1) -- `--data ./data-input-1.json` and `--data ./data-input-2.json`: uploaded datasets specified in the `data-input-1.json` and `data-input-2.json` resource files in the SPCTL root directory. - -Learn more about deploying custom solutions in the [Deployment guides](/developers/deployment_guides). diff --git a/docs/cli/cli_commands/files/delete.md b/docs/cli/commands/files/delete.md similarity index 83% rename from docs/cli/cli_commands/files/delete.md rename to docs/cli/commands/files/delete.md index 62f640a8..c8f679dd 100644 --- a/docs/cli/cli_commands/files/delete.md +++ b/docs/cli/commands/files/delete.md @@ -1,13 +1,13 @@ --- id: "cli-files-delete" title: "files delete" -slug: "/cli_commands/files/delete" +slug: "/commands/files/delete" sidebar_label: "delete" --- Deletes a file in remote storage using the information in a resource JSON file. -The resource JSON file is created as a result of the [`files upload`](/cli/cli_commands/files/upload) command. +The resource JSON file is created as a result of the [`files upload`](/cli/commands/files/upload) command. ## Syntax @@ -17,7 +17,7 @@ The resource JSON file is created as a result of the [`files upload`](/cli/cli_c [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/files/download.md b/docs/cli/commands/files/download.md similarity index 86% rename from docs/cli/cli_commands/files/download.md rename to docs/cli/commands/files/download.md index 9753dfe4..45bec22b 100644 --- a/docs/cli/cli_commands/files/download.md +++ b/docs/cli/commands/files/download.md @@ -1,13 +1,13 @@ --- id: "cli-files-download" title: "files download" -slug: "/cli_commands/files/download" +slug: "/commands/files/download" sidebar_label: "download" --- Downloads a file from remote storage and decrypts it using the information in a resource JSON file. -The resource JSON file is created as a result of the [`files upload`](/cli/cli_commands/files/upload) command. +The resource JSON file is created as a result of the [`files upload`](/cli/commands/files/upload) command. ## Syntax @@ -17,7 +17,7 @@ The resource JSON file is created as a result of the [`files upload`](/cli/cli_c [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/files/index.md b/docs/cli/commands/files/index.md similarity index 54% rename from docs/cli/cli_commands/files/index.md rename to docs/cli/commands/files/index.md index c7a31d81..f6c5b853 100644 --- a/docs/cli/cli_commands/files/index.md +++ b/docs/cli/commands/files/index.md @@ -1,7 +1,7 @@ --- id: "cli-files" title: "files" -slug: "/cli_commands/files" +slug: "/commands/files" sidebar_position: 3 --- @@ -14,6 +14,6 @@ Most of these commands require a Storj account and SPCTL configured to use it. R | **Command** | **Description** | | :- | :- | -| [files delete](/cli/cli_commands/files/delete) | Deletes a file in remote storage. | -| [files download](/cli/cli_commands/files/download) | Downloads and decrypt a file from remote storage. | -| [files upload](/cli/cli_commands/files/upload) | Uploads a file to remote storage or creates a storage order. | \ No newline at end of file +| [files delete](/cli/commands/files/delete) | Deletes a file in remote storage. | +| [files download](/cli/commands/files/download) | Downloads and decrypt a file from remote storage. | +| [files upload](/cli/commands/files/upload) | Uploads a file to remote storage or creates a storage order. | \ No newline at end of file diff --git a/docs/cli/cli_commands/files/upload.md b/docs/cli/commands/files/upload.md similarity index 88% rename from docs/cli/cli_commands/files/upload.md rename to docs/cli/commands/files/upload.md index 9c743f3b..ba4fdc6c 100644 --- a/docs/cli/cli_commands/files/upload.md +++ b/docs/cli/commands/files/upload.md @@ -1,7 +1,7 @@ --- id: "cli-files-upload" title: "files upload" -slug: "/cli_commands/files/upload" +slug: "/commands/files/upload" sidebar_label: "upload" --- @@ -9,7 +9,7 @@ Uploads a file to remote storage such as Storj. The primary purpose of this command is to make the uploading files available for download and execution. This is necessary in two cases: -- With the [`workflows create`](/cli/cli_commands/workflows/create) command, **users** can add the uploaded solution or data to an order instead of a Marketplace offer. In this case, a short-term storage period is enough. +- With the [`workflows create`](/cli/commands/workflows/create) command, **users** can add the uploaded solution or data to an order instead of a Marketplace offer. In this case, a short-term storage period is enough. - Solution and data **providers** can store the contents of their offers to make them available for customers' orders. This requires a long-term storage period. Depending on the options, the command provides two ways to upload and store the files. Choose one that suits you better: @@ -17,7 +17,7 @@ Depending on the options, the command provides two ways to upload and store the - **Uploads to storage directly.** This requires a Storj account and SPCTL [configured](/cli#set-up-storj) to use it. The command will upload the file to the root directory of the bucket specified in the SPCTL configuration file. - **Creates a storage order using a Marketplace storage offer.** This does not require a Storj account but requires paying TEE tokens for the order according to the offer pricing and selected lease duration. -The input of the command is a TAR.GZ archive file. For solutions, this file is created by the [`solutions prepare`](/cli/cli_commands/solutions/prepare) command. For data, it is an archive containing the dataset files. +The input of the command is a TAR.GZ archive file. For solutions, this file is created by the [`solutions prepare`](/cli/commands/solutions/prepare) command. For data, it is an archive containing the dataset files. The output of the command is a resource JSON file with the information for a compute provider on how to access the uploaded file. @@ -36,7 +36,7 @@ The output of the command is a resource JSON file with the information for a com [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments @@ -51,7 +51,7 @@ Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax) | `--filename ` | Desired name of the resulting file in storage. The default is a random string. | | `--output ` | Path to save the output resource JSON file. The default is `./resource.json`. | | `--skip-encryption` | Flag to skip file encryption before uploading. The default is `false`. | -| `--metadata ` | Path to a metadata file for adding fields to the resource JSON file. This file is generated by the [solutions prepare](/cli/cli_commands/solutions/prepare) command. | +| `--metadata ` | Path to a metadata file for adding fields to the resource JSON file. This file is generated by the [solutions prepare](/cli/commands/solutions/prepare) command. | | `--max-concurrent ` | Maximum concurrent pieces to upload at once per transfer to limit the number of threads. Use only when dealing with a memory-constrained environment. | | `--storage ` | Option to use a storage offer. State the storage offer ID and the requirement slot ID, separated by a comma. | | `--min-rent-minutes ` | Storage lease period in minutes. Use this option together with `--storage`. The default is `60`. | @@ -89,7 +89,7 @@ Where: - `--storage 25,33`: create a storage order using the [Storj DCS Offer](https://marketplace.superprotocol.com/storage?offer=offerId%3D25&tab=pricing) (offer ID: 25) and the requirement slot with ID 33. - `--min-rent-minutes 120`: set the lease period for 120 minutes. -Since the `--storage` option is set, the command does not require a Storj account. However, when the lease period is over, the content will become unavailable unless you [replenish the order deposit](/cli/cli_commands/orders/replenish-deposit). +Since the `--storage` option is set, the command does not require a Storj account. However, when the lease period is over, the content will become unavailable unless you [replenish the order deposit](/cli/commands/orders/replenish-deposit). ### Example 3. Use additional options diff --git a/docs/cli/cli_commands/index.md b/docs/cli/commands/index.md similarity index 74% rename from docs/cli/cli_commands/index.md rename to docs/cli/commands/index.md index 6aa08e12..4af1326b 100644 --- a/docs/cli/cli_commands/index.md +++ b/docs/cli/commands/index.md @@ -1,7 +1,7 @@ --- -id: "cli_commands" +id: "cli-commands" title: "CLI Commands" -slug: "/cli_commands" +slug: "/commands" sidebar_position: 2 --- @@ -13,14 +13,14 @@ This section contains the list of commands for the Super Protocol CLI tool SPCTL | **Group** | **Description** | | :- | :- | -| [tokens](/cli/cli_commands/tokens) | Receive test TEE and POL test tokens; **testnet only**. | -| [solutions](/cli/cli_commands/solutions) | Prepare a solution for deployment. | -| [files](/cli/cli_commands/files) | Manage files in decentralized storage. | -| [workflows](/cli/cli_commands/workflows) | Create a new order. | -| [orders](/cli/cli_commands/orders) | Manage your orders. | -| [offers](/cli/cli_commands/offers) | View and manage Marketplace offers. | -| [providers](/cli/cli_commands/providers) | View and manage offer providers. | -| [quotes](/cli/cli_commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. | +| [tokens](/cli/commands/tokens) | Receive test TEE and POL test tokens; **testnet only**. | +| [solutions](/cli/commands/solutions) | Prepare a solution for deployment. | +| [files](/cli/commands/files) | Manage files in decentralized storage. | +| [workflows](/cli/commands/workflows) | Create a new order. | +| [orders](/cli/commands/orders) | Manage your orders. | +| [offers](/cli/commands/offers) | View and manage Marketplace offers. | +| [providers](/cli/commands/providers) | View and manage offer providers. | +| [quotes](/cli/commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. | ## Command syntax @@ -30,13 +30,13 @@ SPCTL uses the following syntax format for commands: ./spctl ``` -_Command groups_ contain functionally related commands. Check the complete list of command groups in the [previous section](/cli/cli_commands#command-groups). +_Command groups_ contain functionally related commands. Check the complete list of command groups in the [previous section](/cli/commands#command-groups). _Commands_ perform a specific function, like placing an order or showing the list of providers. -For example, the [`tokens`](/cli/cli_commands/tokens) command group includes the following commands: -- [`balance`](/cli/cli_commands/tokens/balance): checks the balance -- [`request`](/cli/cli_commands/tokens/request): requests testnet tokens. +For example, the [`tokens`](/cli/commands/tokens) command group includes the following commands: +- [`balance`](/cli/commands/tokens/balance): checks the balance +- [`request`](/cli/commands/tokens/request): requests testnet tokens. _Options_ modify the command behavior and are prefixed by double hyphen `--`. For example, `--help` is an option that displays help information for a command. @@ -56,7 +56,7 @@ Never include these special characters, except backslash `\`, in the final comma ### Example -The following is a mandatory option `--solution` of the [`workflows create`](/cli/cli_commands/workflows/create) command: +The following is a mandatory option `--solution` of the [`workflows create`](/cli/commands/workflows/create) command: ``` --solution {,[] | } @@ -71,4 +71,4 @@ So, the final format of this option must be one of the following: - `--solution ,`. For example, `--solution 13,15`. - `--solution `. For example, `--solution ./python-solution.json`. -Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol). Community Managers will be happy to help. \ No newline at end of file +Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol). \ No newline at end of file diff --git a/docs/cli/cli_commands/offers/add-slot.md b/docs/cli/commands/offers/add-slot.md similarity index 90% rename from docs/cli/cli_commands/offers/add-slot.md rename to docs/cli/commands/offers/add-slot.md index 6a130b21..08c8d4b6 100644 --- a/docs/cli/cli_commands/offers/add-slot.md +++ b/docs/cli/commands/offers/add-slot.md @@ -1,14 +1,14 @@ --- -id: "add-slot" +id: "cli-offers-add-slot" title: "offers add-slot" -slug: "/cli_commands/offers/slots/add-slot" +slug: "/commands/offers/add-slot" sidebar_label: "add-slot" -sidebar_position: 10 +sidebar_position: 8 --- Creates an additional [requirement slot](/fundamentals/slots#requirements) in an offer using the information in an offer slot JSON file. -Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offer-requirements) guide to create the initial offer requirements. +Refer to the [Providers and Offers] guide to create the initial offer requirements. **Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers). @@ -22,7 +22,7 @@ Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offe [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/delete-slot.md b/docs/cli/commands/offers/delete-slot.md similarity index 72% rename from docs/cli/cli_commands/offers/delete-slot.md rename to docs/cli/commands/offers/delete-slot.md index a8a56e94..3d053d95 100644 --- a/docs/cli/cli_commands/offers/delete-slot.md +++ b/docs/cli/commands/offers/delete-slot.md @@ -1,16 +1,16 @@ --- -id: "delete-slot" +id: "cli-offers-delete-slot" title: "offers delete-slot" -slug: "/cli_commands/offers/slots/delete-slot" +slug: "/commands/offers/delete-slot" sidebar_label: "delete-slot" -sidebar_position: 12 +sidebar_position: 10 --- Deletes a [requirement slot](/fundamentals/slots#requirements) in an [offer](/fundamentals/offers). **Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers). -Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/cli_commands/offers/slots/get-slot) command to get additional information on a slot. +Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/commands/offers/get-slot) command to get additional information on a slot. ## Syntax @@ -22,7 +22,7 @@ Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the I [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/disable.md b/docs/cli/commands/offers/disable.md similarity index 80% rename from docs/cli/cli_commands/offers/disable.md rename to docs/cli/commands/offers/disable.md index 565b47a1..760f8586 100644 --- a/docs/cli/cli_commands/offers/disable.md +++ b/docs/cli/commands/offers/disable.md @@ -1,9 +1,9 @@ --- -id: "offers-disable" +id: "cli-offers-disable" title: "offers disable" -slug: "/cli_commands/offers/offers/disable" +slug: "/commands/offers/disable" sidebar_label: "disable" -sidebar_position: 7 +sidebar_position: 6 --- Disables an existing enabled offer. @@ -18,7 +18,7 @@ Disables an existing enabled offer. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/download-content.md b/docs/cli/commands/offers/download-content.md similarity index 84% rename from docs/cli/cli_commands/offers/download-content.md rename to docs/cli/commands/offers/download-content.md index 18675600..4c797560 100644 --- a/docs/cli/cli_commands/offers/download-content.md +++ b/docs/cli/commands/offers/download-content.md @@ -1,7 +1,7 @@ --- -id: "offers-download-content" +id: "cli-offers-download-content" title: "offers download-content" -slug: "/cli_commands/offers/offers/download-content" +slug: "/commands/offers/download-content" sidebar_label: "download-content" sidebar_position: 4 --- @@ -19,7 +19,7 @@ The command only works with offers that allow this operation. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/enable.md b/docs/cli/commands/offers/enable.md similarity index 80% rename from docs/cli/cli_commands/offers/enable.md rename to docs/cli/commands/offers/enable.md index 1a5ebcfc..a2c963d8 100644 --- a/docs/cli/cli_commands/offers/enable.md +++ b/docs/cli/commands/offers/enable.md @@ -1,9 +1,9 @@ --- -id: "offers-enable" +id: "cli-offers-enable" title: "offers enable" -slug: "/cli_commands/offers/offers/enable" +slug: "/commands/offers/enable" sidebar_label: "enable" -sidebar_position: 8 +sidebar_position: 7 --- Enables an existing disabled offer. @@ -18,7 +18,7 @@ Enables an existing disabled offer. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/get-info.md b/docs/cli/commands/offers/get-info.md similarity index 88% rename from docs/cli/cli_commands/offers/get-info.md rename to docs/cli/commands/offers/get-info.md index 9b64586c..fc4a5643 100644 --- a/docs/cli/cli_commands/offers/get-info.md +++ b/docs/cli/commands/offers/get-info.md @@ -1,7 +1,7 @@ --- -id: "offers-get-info" +id: "cli-offers-get-info" title: "offers get-info" -slug: "/cli_commands/offers/offers/get-info" +slug: "/commands/offers/get-info" sidebar_label: "get-info" sidebar_position: 3 --- @@ -17,7 +17,7 @@ Displays the information on an offer as stored on the blockchain. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/get-option.md b/docs/cli/commands/offers/get-option.md similarity index 83% rename from docs/cli/cli_commands/offers/get-option.md rename to docs/cli/commands/offers/get-option.md index ea089bcd..f354c8fd 100644 --- a/docs/cli/cli_commands/offers/get-option.md +++ b/docs/cli/commands/offers/get-option.md @@ -1,9 +1,9 @@ --- -id: "get-option" +id: "cli-offers-get-option" title: "offers get-option" -slug: "/cli_commands/offers/options/get-option" +slug: "/commands/offers/get-option" sidebar_label: "get-option" -sidebar_position: 9 +sidebar_position: 12 --- Displays the information on a [configuration option](/fundamentals/slots) of a compute offer. @@ -18,7 +18,7 @@ Displays the information on a [configuration option](/fundamentals/slots) of a c [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Options diff --git a/docs/cli/cli_commands/offers/get-slot.md b/docs/cli/commands/offers/get-slot.md similarity index 79% rename from docs/cli/cli_commands/offers/get-slot.md rename to docs/cli/commands/offers/get-slot.md index c00605f7..5f927d50 100644 --- a/docs/cli/cli_commands/offers/get-slot.md +++ b/docs/cli/commands/offers/get-slot.md @@ -1,14 +1,14 @@ --- -id: "offers-get-slot" +id: "cli-offers-get-slot" title: "offers get-slot" -slug: "/cli_commands/offers/slots/get-slot" +slug: "/commands/offers/get-slot" sidebar_label: "get-slot" -sidebar_position: 13 +sidebar_position: 11 --- Displays the information for a [requirement slot](/fundamentals/slots#requirements) in an offer. -Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. +Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all slots in an offer. ## Syntax @@ -21,7 +21,7 @@ Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the I [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/get.md b/docs/cli/commands/offers/get.md similarity index 88% rename from docs/cli/cli_commands/offers/get.md rename to docs/cli/commands/offers/get.md index 6cf5991a..0be6bb41 100644 --- a/docs/cli/cli_commands/offers/get.md +++ b/docs/cli/commands/offers/get.md @@ -1,7 +1,7 @@ --- -id: "offers-get" +id: "cli-offers-get" title: "offers get" -slug: "/cli_commands/offers/offers/get" +slug: "/commands/offers/get" sidebar_label: "get" sidebar_position: 2 --- @@ -17,7 +17,7 @@ Displays information on an offer. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/commands/offers/index.md b/docs/cli/commands/offers/index.md new file mode 100644 index 00000000..56280c70 --- /dev/null +++ b/docs/cli/commands/offers/index.md @@ -0,0 +1,38 @@ +--- +id: "cli-offers" +title: "offers" +slug: "/commands/offers" +sidebar_position: 6 + +--- + +This command group contains commands to view and manage [offers](/fundamentals/offers). Note that [Marketplace web app](https://marketplace.superprotocol.com/marketplace) can be more convenient to use than most of these commands. + +## Commands + +| **Command** | **Description** | +| :- | :- | +| [offers list](/cli/commands/offers/list) | Lists available offers. | +| [offers get](/cli/commands/offers/get) | Displays information on an offer. | +| [offers get-info](/cli/commands/offers/get-info) | Displays information on an offer as stored on the blockchain. | +| [offers download-content](/cli/commands/offers/download-content) | Downloads the content of an offer. | +| [offers update](/cli/commands/offers/update) | Updates an offer. | +| [offers disable](/cli/commands/offers/disable) | Disables an enabled offer. | +| [offers enable](/cli/commands/offers/enable) | Enables a disabled offer. | + +### Slot-related commands + +| **Command** | **Description** | +| :- | :- | +| [offers add-slot](/cli/commands/offers/add-slot) | Adds a new slot to an existing offer. | +| [offers update-slot](/cli/commands/offers/update-slot) | Updates a slot. | +| [offers delete-slot](/cli/commands/offers/delete-slot) | Deletes a slot. | +| [offers get-slot](/cli/commands/offers/get-slot) | Displays information on a slot. | + +### Option-related command + +This command only works with compute offers. + +| **Command** | **Description** | +| :- | :- | +| [offers get-option](/cli/commands/offers/get-option) | Displays information for an option. | diff --git a/docs/cli/cli_commands/offers/list.md b/docs/cli/commands/offers/list.md similarity index 93% rename from docs/cli/cli_commands/offers/list.md rename to docs/cli/commands/offers/list.md index cf54ceae..253d1ac6 100644 --- a/docs/cli/cli_commands/offers/list.md +++ b/docs/cli/commands/offers/list.md @@ -1,7 +1,7 @@ --- -id: "offers-list" +id: "cli-offers-list" title: "offers list" -slug: "/cli_commands/offers/offers/list" +slug: "/commands/offers/list" sidebar_label: "list" sidebar_position: 1 --- @@ -20,7 +20,7 @@ Displays a list of available offers. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/update-slot.md b/docs/cli/commands/offers/update-slot.md similarity index 65% rename from docs/cli/cli_commands/offers/update-slot.md rename to docs/cli/commands/offers/update-slot.md index c70bb92d..75dcfae5 100644 --- a/docs/cli/cli_commands/offers/update-slot.md +++ b/docs/cli/commands/offers/update-slot.md @@ -1,18 +1,18 @@ --- -id: "update-slot" +id: "cli-offers-update-slot" title: "offers update-slot" -slug: "/cli_commands/offers/slots/update-slot" +slug: "/commands/offers/update-slot" sidebar_label: "update-slot" -sidebar_position: 11 +sidebar_position: 9 --- Updates a [requirement slot](/fundamentals/slots#requirements) in an existing offer using the information in a JSON file. **Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers). -Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/cli_commands/offers/slots/get-slot) command to get additional information on a slot. +Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/commands/offers/get-slot) command to get additional information on a slot. -Refer to [Offer requirements](/developers/cli_guides/providers_offers#offer-requirements) to create the initial offer requirements. Refer to the description of the [`offers add-slot`](/cli/cli_commands/offers/slots/add-slot) command for the JSON file format and object descriptions. +Refer to [Offer requirements] to create the initial offer requirements. Refer to the description of the [`offers add-slot`](/cli/commands/offers/add-slot) command for the JSON file format and object descriptions. ## Syntax @@ -25,7 +25,7 @@ Refer to [Offer requirements](/developers/cli_guides/providers_offers#offer-requ [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/offers/update.md b/docs/cli/commands/offers/update.md similarity index 94% rename from docs/cli/cli_commands/offers/update.md rename to docs/cli/commands/offers/update.md index 606345a3..0a9f2094 100644 --- a/docs/cli/cli_commands/offers/update.md +++ b/docs/cli/commands/offers/update.md @@ -1,14 +1,14 @@ --- -id: "offers-update" +id: "cli-offers-update" title: "offers update" -slug: "/cli_commands/offers/offers/update" +slug: "/commands/offers/update" sidebar_label: "update" -sidebar_position: 6 +sidebar_position: 5 --- Updates information of an existing offer using an offer description JSON file. -Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offer-description) guide to create the initial offer description. +Refer to the [Providers and Offers] guide to create the initial offer description. **Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers). @@ -21,7 +21,7 @@ Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offe [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/orders/cancel.md b/docs/cli/commands/orders/cancel.md similarity index 80% rename from docs/cli/cli_commands/orders/cancel.md rename to docs/cli/commands/orders/cancel.md index 33c5dbff..ad835ddf 100644 --- a/docs/cli/cli_commands/orders/cancel.md +++ b/docs/cli/commands/orders/cancel.md @@ -1,7 +1,7 @@ --- -id: "orders-cancel" +id: "cli-orders-cancel" title: "orders cancel" -slug: "/cli_commands/orders/cancel" +slug: "/commands/orders/cancel" sidebar_label: "cancel" --- @@ -15,7 +15,7 @@ Cancels an order. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/orders/download-result.md b/docs/cli/commands/orders/download-result.md similarity index 89% rename from docs/cli/cli_commands/orders/download-result.md rename to docs/cli/commands/orders/download-result.md index 191e81c6..920f7c49 100644 --- a/docs/cli/cli_commands/orders/download-result.md +++ b/docs/cli/commands/orders/download-result.md @@ -1,7 +1,7 @@ --- id: "cli-orders-download-result" title: "orders download-result" -slug: "/cli_commands/orders/download-result" +slug: "/commands/orders/download-result" sidebar_label: "download-result" --- @@ -23,7 +23,7 @@ If the order status is `Error`, the result archive will contain a text file with [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/orders/get.md b/docs/cli/commands/orders/get.md similarity index 92% rename from docs/cli/cli_commands/orders/get.md rename to docs/cli/commands/orders/get.md index efd336e4..6ac0953c 100644 --- a/docs/cli/cli_commands/orders/get.md +++ b/docs/cli/commands/orders/get.md @@ -1,7 +1,7 @@ --- -id: "orders-get" +id: "cli-orders-get" title: "orders get" -slug: "/cli_commands/orders/get" +slug: "/commands/orders/get" sidebar_label: "get" --- @@ -20,7 +20,7 @@ This command allows you to check any order, not only yours. The information on a [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/commands/orders/index.md b/docs/cli/commands/orders/index.md new file mode 100644 index 00000000..8e44c71b --- /dev/null +++ b/docs/cli/commands/orders/index.md @@ -0,0 +1,19 @@ +--- +id: "cli-orders" +title: "orders" +slug: "/commands/orders" +sidebar_position: 5 + +--- + +This command group contains commands to track and manage [orders](/fundamentals/orders). Note that [Marketplace web app](https://marketplace.superprotocol.com/marketplace) can be more convenient to use than most of the commands in this group. + +## Commands + +| **Command** | **Description** | +| :- | :- | +| [orders cancel](/cli/commands/orders/cancel) | Cancels an order. | +| [orders download-result](/cli/commands/orders/download-result) | Downloads the order result. | +| [orders get](/cli/commands/orders/get) | Displays information on an order. | +| [orders list](/cli/commands/orders/list) | Lists orders. | +| [orders replenish-deposit](/cli/commands/orders/replenish-deposit) | Replenishes the order deposit. | \ No newline at end of file diff --git a/docs/cli/cli_commands/orders/list.md b/docs/cli/commands/orders/list.md similarity index 93% rename from docs/cli/cli_commands/orders/list.md rename to docs/cli/commands/orders/list.md index a9ea65ea..3f9081ac 100644 --- a/docs/cli/cli_commands/orders/list.md +++ b/docs/cli/commands/orders/list.md @@ -1,7 +1,7 @@ --- id: "cli-orders-list" title: "orders list" -slug: "/cli_commands/orders/list" +slug: "/commands/orders/list" sidebar_label: "list" --- @@ -23,7 +23,7 @@ This command displays a list of all orders and suborders, unless the `--my-accou [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Options diff --git a/docs/cli/cli_commands/orders/replenish-deposit.md b/docs/cli/commands/orders/replenish-deposit.md similarity index 76% rename from docs/cli/cli_commands/orders/replenish-deposit.md rename to docs/cli/commands/orders/replenish-deposit.md index 0f85b23d..28325e16 100644 --- a/docs/cli/cli_commands/orders/replenish-deposit.md +++ b/docs/cli/commands/orders/replenish-deposit.md @@ -1,13 +1,13 @@ --- id: "cli-orders-replenish-deposit" title: "orders replenish-deposit" -slug: "/cli_commands/orders/replenish-deposit" +slug: "/commands/orders/replenish-deposit" sidebar_label: "replenish-deposit" --- Replenishes the order deposit. -Certain orders require a positive deposit balance to keep running. For example, [Offer Provisioner](/developers/cli_guides/providers_offers#step-5-run-offer-provisioner) and storage orders. +Certain orders require a positive deposit balance to keep running. ## Syntax @@ -17,7 +17,7 @@ Certain orders require a positive deposit balance to keep running. For example, [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/providers/get.md b/docs/cli/commands/providers/get.md similarity index 90% rename from docs/cli/cli_commands/providers/get.md rename to docs/cli/commands/providers/get.md index 064ca3c1..36f16a6d 100644 --- a/docs/cli/cli_commands/providers/get.md +++ b/docs/cli/commands/providers/get.md @@ -1,7 +1,7 @@ --- id: "cli-providers-get" title: "providers get" -slug: "/cli_commands/providers/get" +slug: "/commands/providers/get" sidebar_label: "get" --- @@ -16,7 +16,7 @@ Displays the information on a provider using its authority account address. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/commands/providers/index.md b/docs/cli/commands/providers/index.md new file mode 100644 index 00000000..b3c7e5d1 --- /dev/null +++ b/docs/cli/commands/providers/index.md @@ -0,0 +1,17 @@ +--- +id: "cli-providers" +title: "providers" +slug: "/commands/providers" +sidebar_position: 7 + +--- + +This command group contains commands to view and update [providers](/fundamentals/offers). + +## Commands + +| **Command** | **Description** | +| :- | :- | +| [providers get](/cli/commands/providers/get) | Displays information on a provider using its authority account address. | +| [providers update](/cli/commands/providers/update) | Updates the current provider information. | +| [providers list](/cli/commands/providers/list) | Lists all providers. | \ No newline at end of file diff --git a/docs/cli/cli_commands/providers/list.md b/docs/cli/commands/providers/list.md similarity index 90% rename from docs/cli/cli_commands/providers/list.md rename to docs/cli/commands/providers/list.md index 36c82130..746e9da6 100644 --- a/docs/cli/cli_commands/providers/list.md +++ b/docs/cli/commands/providers/list.md @@ -1,7 +1,7 @@ --- id: "cli-providers-list" title: "providers list" -slug: "/cli_commands/providers/list" +slug: "/commands/providers/list" sidebar_label: "list" --- @@ -16,7 +16,7 @@ Lists all registered providers. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Options diff --git a/docs/cli/cli_commands/providers/update.md b/docs/cli/commands/providers/update.md similarity index 88% rename from docs/cli/cli_commands/providers/update.md rename to docs/cli/commands/providers/update.md index a8c44f0e..3fdb11ac 100644 --- a/docs/cli/cli_commands/providers/update.md +++ b/docs/cli/commands/providers/update.md @@ -1,13 +1,13 @@ --- id: "cli-providers-update" title: "providers update" -slug: "/cli_commands/providers/update" +slug: "/commands/providers/update" sidebar_label: "update" --- Updates the current provider using a provider info JSON file. -Provider Tools creates a provider info JSON file in [Step 4 of the Providers and Offers](/developers/cli_guides/providers_offers#step-4-register-the-provider-and-offer) guide. +Provider Tools creates a provider info JSON file in [Step 4 of the Providers and Offers] guide. **Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers). @@ -20,7 +20,7 @@ Provider Tools creates a provider info JSON file in [Step 4 of the Providers and [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Options diff --git a/docs/cli/cli_commands/quotes/index.md b/docs/cli/commands/quotes/index.md similarity index 64% rename from docs/cli/cli_commands/quotes/index.md rename to docs/cli/commands/quotes/index.md index 30db8c6d..633c72ba 100644 --- a/docs/cli/cli_commands/quotes/index.md +++ b/docs/cli/commands/quotes/index.md @@ -1,7 +1,7 @@ --- -id: "cli-files" +id: "cli-quotes" title: "quotes" -slug: "/cli_commands/quotes" +slug: "/commands/quotes" sidebar_position: 9 --- @@ -12,4 +12,4 @@ This command group contains a single command to verify the authenticity and inte | **Command** | **Description** | | :- | :- | -| [quotes validate](/cli/cli_commands/quotes/validate) | Checks the confidentiality of a domain. | \ No newline at end of file +| [quotes validate](/cli/commands/quotes/validate) | Checks the confidentiality of a domain. | \ No newline at end of file diff --git a/docs/cli/cli_commands/quotes/validate.md b/docs/cli/commands/quotes/validate.md similarity index 75% rename from docs/cli/cli_commands/quotes/validate.md rename to docs/cli/commands/quotes/validate.md index beb2e408..11a2bc62 100644 --- a/docs/cli/cli_commands/quotes/validate.md +++ b/docs/cli/commands/quotes/validate.md @@ -1,14 +1,12 @@ --- id: "cli-quotes-validate" title: "quotes validate" -slug: "/cli_commands/quotes/validate" +slug: "/commands/quotes/validate" sidebar_label: "validate" --- Checks if the domain content runs in a confidential environment. The command also displays if the domain content is a Super Protocol offer. -In the Marketplace GUI, use the [**Check Confidentiality**](/developers/marketplace/confidentiality) feature. - ## Syntax ``` @@ -17,7 +15,7 @@ In the Marketplace GUI, use the [**Check Confidentiality**](/developers/marketpl [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/solutions/generate-key.md b/docs/cli/commands/solutions/generate-key.md similarity index 73% rename from docs/cli/cli_commands/solutions/generate-key.md rename to docs/cli/commands/solutions/generate-key.md index d0a79c73..627dceb8 100644 --- a/docs/cli/cli_commands/solutions/generate-key.md +++ b/docs/cli/commands/solutions/generate-key.md @@ -1,13 +1,13 @@ --- -id: "solutions-generate-key" +id: "cli-solutions-generate-key" title: "solutions generate-key" -slug: "/cli_commands/solutions/generate-key" +slug: "/commands/solutions/generate-key" sidebar_label: "generate-key" --- Generates a signing key necessary to prepare a solution. -Docker needs this key to [pack a solution](/cli/cli_commands/solutions/prepare) into a container. +Docker needs this key to [pack a solution](/cli/commands/solutions/prepare) into a container. ## Syntax @@ -17,7 +17,7 @@ Docker needs this key to [pack a solution](/cli/cli_commands/solutions/prepare) [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/solutions/index.md b/docs/cli/commands/solutions/index.md similarity index 51% rename from docs/cli/cli_commands/solutions/index.md rename to docs/cli/commands/solutions/index.md index 621966b1..726c250c 100644 --- a/docs/cli/cli_commands/solutions/index.md +++ b/docs/cli/commands/solutions/index.md @@ -1,7 +1,7 @@ --- -id: "solutions" +id: "cli-solutions" title: "solutions" -slug: "/cli_commands/solutions" +slug: "/commands/solutions" sidebar_position: 2 --- @@ -12,5 +12,5 @@ This command group contains commands to prepare a solution for deployment on Sup | **Command** | **Description** | | :- | :- | -| [solutions generate-key](/cli/cli_commands/solutions/generate-key) | Generates a solution signing key. | -| [solutions prepare](/cli/cli_commands/solutions/prepare) | Prepares a solution for deployment. | \ No newline at end of file +| [solutions generate-key](/cli/commands/solutions/generate-key) | Generates a solution signing key. | +| [solutions prepare](/cli/commands/solutions/prepare) | Prepares a solution for deployment. | \ No newline at end of file diff --git a/docs/cli/cli_commands/solutions/prepare.md b/docs/cli/commands/solutions/prepare.md similarity index 88% rename from docs/cli/cli_commands/solutions/prepare.md rename to docs/cli/commands/solutions/prepare.md index bcb696e8..914c1865 100644 --- a/docs/cli/cli_commands/solutions/prepare.md +++ b/docs/cli/commands/solutions/prepare.md @@ -1,19 +1,19 @@ --- -id: "solutions-prepare" +id: "cli-solutions-prepare" title: "solutions prepare" -slug: "/cli_commands/solutions/prepare" +slug: "/commands/solutions/prepare" sidebar_label: "prepare" --- Packs and signs a solution with [Gramine](https://gramineproject.io/) and writes a [manifest](https://gramine.readthedocs.io/en/stable/manifest-syntax.html). -This allows the execution of the "graminized" solution code inside a Trusted Execution Environment. When the solution is prepared and packed, you can [upload](/cli/cli_commands/files/upload) the resulting archive to a distributed storage to use the solution in orders. +This allows the execution of the "graminized" solution code inside a Trusted Execution Environment. When the solution is prepared and packed, you can [upload](/cli/commands/files/upload) the resulting archive to a distributed storage to use the solution in orders. The input of the command is the following: - Directory with the solution and all its dependencies -- Signing key file generated by the [solutions generate-key](/cli/cli_commands/solutions/generate-key) command -- Node.js or Python base image downloaded from their respective offers using the [offers download-content](/cli/cli_commands/offers/offers/download-content) command: +- Signing key file generated by the [solutions generate-key](/cli/commands/solutions/generate-key) command +- Node.js or Python base image downloaded from their respective offers using the [offers download-content](/cli/commands/offers/download-content) command: + Python Base Image: `./spctl offers download-content 5` + Node.js Base Image: `./spctl offers download-content 6`. @@ -42,7 +42,7 @@ Note that the base image is graminized but not included in the output archive fi [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Arguments diff --git a/docs/cli/cli_commands/tokens/balance.md b/docs/cli/commands/tokens/balance.md similarity index 80% rename from docs/cli/cli_commands/tokens/balance.md rename to docs/cli/commands/tokens/balance.md index e6d84369..71d39e91 100644 --- a/docs/cli/cli_commands/tokens/balance.md +++ b/docs/cli/commands/tokens/balance.md @@ -1,7 +1,7 @@ --- -id: "tokens-balance" +id: "cli-tokens-balance" title: "tokens balance" -slug: "/cli_commands/tokens/balance" +slug: "/commands/tokens/balance" sidebar_label: "balance" --- @@ -15,7 +15,7 @@ Displays the balance of TEE and POL tokens in your wallet. [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Option diff --git a/docs/cli/cli_commands/tokens/index.md b/docs/cli/commands/tokens/index.md similarity index 58% rename from docs/cli/cli_commands/tokens/index.md rename to docs/cli/commands/tokens/index.md index e534e884..23c41cd8 100644 --- a/docs/cli/cli_commands/tokens/index.md +++ b/docs/cli/commands/tokens/index.md @@ -1,7 +1,7 @@ --- -id: "tokens" +id: "cli-tokens" title: "tokens" -slug: "/cli_commands/tokens" +slug: "/commands/tokens" sidebar_position: 1 --- @@ -14,5 +14,5 @@ TEE tokens are necessary to pay for orders in Super Protocol. POL tokens are for | **Command** | **Description** | | :- | :- | -| [tokens balance](/cli/cli_commands/tokens/balance) | Gets the wallet balance. | -| [tokens request](/cli/cli_commands/tokens/request) | Requests test tokens; **testnet only**. | +| [tokens balance](/cli/commands/tokens/balance) | Gets the wallet balance. | +| [tokens request](/cli/commands/tokens/request) | Requests test tokens; **testnet only**. | diff --git a/docs/cli/cli_commands/tokens/request.md b/docs/cli/commands/tokens/request.md similarity index 83% rename from docs/cli/cli_commands/tokens/request.md rename to docs/cli/commands/tokens/request.md index e919ccbf..205eb807 100644 --- a/docs/cli/cli_commands/tokens/request.md +++ b/docs/cli/commands/tokens/request.md @@ -1,7 +1,7 @@ --- -id: "tokens-request" +id: "cli-tokens-request" title: "tokens request" -slug: "/cli_commands/tokens/request" +slug: "/commands/tokens/request" sidebar_label: "request" --- @@ -19,7 +19,7 @@ This command is only available during the Testnet. Be mindful of [Testnet limita [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Options diff --git a/docs/cli/commands/workflows/create.md b/docs/cli/commands/workflows/create.md new file mode 100644 index 00000000..5410f65f --- /dev/null +++ b/docs/cli/commands/workflows/create.md @@ -0,0 +1,47 @@ +--- +id: "cli-workflows-create" +title: "workflows create" +slug: "/commands/workflows/create" +sidebar_label: "create" +--- + +Creates a main compute order and necessary suborders: solution, data, and storage. + +The output of the command contains the order ID necessary to track and manage the order with the [`orders`](/cli/commands/orders) commands or in the [Marketplace web app](https://marketplace.superprotocol.com/marketplace). + +For solutions and data, you can add to an order either Marketplace [offers](/fundamentals/offers) or [uploaded files](/cli/commands/files/upload). Refer to the [fundamentals](/fundamentals) to understand the logic of the Super Protocol order creation process. + +## Syntax + +``` +./spctl workflows create \ + --solution {,[] | } [--solution ...] \ + --storage ,[] \ + [--data {,[] | }] [--data ...] \ + [--tee ,[]] \ + [--tee-slot-count ] \ + [--tee-options [ ...]] \ + [--tee-options-count [ ...]] \ + [--deposit ] \ + [--min-rent-minutes ] \ + [--config ] \ + [--help | -h] +``` + +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). + +## Options + +|
**Name**
| **Description** | +| :- | :- | +| `--solution {,[] │ }` | Solution you are adding to the order:

• For a Marketplace offer, state the solution offer ID and the solution [requirement slot](/fundamentals/slots#requirements) ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically.
• For an [uploaded](/cli/commands/files/upload) solution, state the path to the solution resource JSON file.

You can use this option multiple times. | +| `--storage ,[]` | Storage offer you are adding to the order. State the storage offer ID and the storage requirement slot ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically. | +| `--data {,[] │ }` | Data you are adding to the order:

• For a Marketplace offer, state the data offer ID and the data requirement slot ID (optional), separated by a comma. If the requirement slot is not specified, it will be selected automatically.
• For [uploaded](/cli/commands/files/upload) data, state the path to the data resource JSON file.

You can use this option multiple times.

Although this option is technically not mandatory, most solutions require data. | +| `--tee ,[]` | Compute offer you are adding to the order. State the compute offer ID and, optionally, the [configuration slot](/fundamentals/slots#configuration) ID, separated by a comma. If the configuration slot is not specified, it will be selected automatically.

If you do not use this option, the compute offer and its configuration will be selected automatically. | +| `--tee-slot-count ` | Configuration slot increments—how many times the selected slot is applied. Use this option together with `--tee`.

If you do not use this option, the increments will be calculated automatically. | +| `--tee-options [ ...]` | IDs of [configuration options](/fundamentals/slots#configuration) separated by spaces. Use `--tee-options` together with `--tee`.

If you do not use `--tee-options`, configuration options will be selected automatically. | +| `--tee-options-count [ ...]` | Increments for each configuration option separated by spaces. Use `--tee-options-count` together with `--tee` and `--tee-options`.

If you do not use `--tee-options-count`, increments will be calculated automatically. | +| `--deposit ` | [Deposit](/fundamentals/orders#lease-deposit-and-balance) in TEE tokens. The default is the minimum required deposit. | +| `--min-rent-minutes ` | Compute [lease time](/fundamentals/orders#lease-deposit-and-balance) in minutes. Using this option will increase the required deposit. The default is the minimum required time. | +| `--config ` | Path to the SPCTL configuration file. The default is `./config.json`. | +| `--help`, `-h` | Help for the command. | diff --git a/docs/cli/cli_commands/workflows/generate-key.md b/docs/cli/commands/workflows/generate-key.md similarity index 80% rename from docs/cli/cli_commands/workflows/generate-key.md rename to docs/cli/commands/workflows/generate-key.md index 12c1ceef..7c112ed4 100644 --- a/docs/cli/cli_commands/workflows/generate-key.md +++ b/docs/cli/commands/workflows/generate-key.md @@ -1,7 +1,7 @@ --- -id: "generate-key" +id: "cli-workflows-generate-key" title: "workflows generate-key" -slug: "/cli_commands/workflows/generate-key" +slug: "/commands/workflows/generate-key" sidebar_label: "generate-key" --- @@ -17,7 +17,7 @@ SPCTL generates this key automatically during the [configuration](/cli). Use thi [--help | -h] ``` -Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax). +Read about the Super Protocol [command syntax](/cli/commands#command-syntax). ## Option diff --git a/docs/cli/cli_commands/workflows/index.md b/docs/cli/commands/workflows/index.md similarity index 53% rename from docs/cli/cli_commands/workflows/index.md rename to docs/cli/commands/workflows/index.md index 2541e694..94d26806 100644 --- a/docs/cli/cli_commands/workflows/index.md +++ b/docs/cli/commands/workflows/index.md @@ -1,7 +1,7 @@ --- id: "cli-workflows" title: "workflows" -slug: "/cli_commands/workflows" +slug: "/commands/workflows" sidebar_position: 4 --- @@ -12,5 +12,5 @@ This command group contains commands to create an [order](/fundamentals/orders) | **Command** | **Description** | | :- | :- | -| [workflows generate-key](/cli/cli_commands/workflows/generate-key) |Generates a private key to decrypt order results. | -| [workflows create](/cli/cli_commands/workflows/create) | Creates an order. | \ No newline at end of file +| [workflows generate-key](/cli/commands/workflows/generate-key) |Generates a private key to decrypt order results. | +| [workflows create](/cli/commands/workflows/create) | Creates an order. | \ No newline at end of file diff --git a/docs/cli/index.md b/docs/cli/index.md index 5c9aa619..bce3d476 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -89,16 +89,16 @@ Do not change the preconfigured parameters and fill in the following ones: |:-|:-| |accessToken| Your Testnet Access Token from the Testnet invitation email|| |accountPrivateKey| Your Testnet Private Key from the Testnet invitation email| -|key| Private key for order result encryption. Use the [workflows generate-key](/cli/cli_commands/workflows/generate-key) command to create this key| +|key| Private key for order result encryption. Use the [workflows generate-key](/cli/commands/workflows/generate-key) command to create this key| |bucket| Name of your Storj bucket (optional)| |writeAccessToken| Storj access grant with **write** and **delete** permissions for this bucket (optional)| |readAccessToken| Storj access grant with **read** permission for this bucket (optional)| ## For offer providers -This section is for offer providers only. If you are a regular user, skip it and go to the next section to [create a test order](/cli#create-a-test-order). +This section is for offer providers only. Skip it if you are a regular user. -Offer providers need another copy of SPCTL configured for their provider accounts. If you completed all the necessary steps in the [Providers and Offers](/developers/cli_guides/providers_offers) guide, you should have the configuration file created automatically in your Provider Tools directory. Its name looks like this: +Offer providers need another copy of SPCTL configured for their provider accounts. If you completed all the necessary steps in the [Providers and Offers] guide, you should have the configuration file created automatically in your Provider Tools directory. Its name looks like this: ```spctl-config-0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAa.json``` @@ -106,7 +106,7 @@ Where `0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAa` is your Authority Account wal Rename this file to `config.json` so SPCTL can recognize it as its configuration file. Copy or download the SPCTL executable to the Provider Tools root directory. -Alternatively, copy this provider's SPCTL config to your User Account's SPCTL directory. Use the `--config` option with [SPCTL commands](/cli/cli_commands) to manage your provider and orders. For example: +Alternatively, copy this provider's SPCTL config to your User Account's SPCTL directory. Use the `--config` option with [SPCTL commands](/cli/commands) to manage your provider and orders. For example: ``` ./spctl orders list --my-account --type tee --config spctl-config-0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAa.json @@ -153,7 +153,7 @@ Do not change the preconfigured parameters and fill in the following ones: |accessToken| Your regular Testnet Access Token from the Testnet invitation email| |accountPrivateKey| Private Key of your provider's Action Account| |authorityAccountPrivateKey| Private Key of your provider's Authority Account| -|key| Private key for order result encryption. Use the key from your User Account or generate a new one with the [workflows generate-key](/cli/cli_commands/workflows/generate-key) command| +|key| Private key for order result encryption. Use the key from your User Account or generate a new one with the [workflows generate-key](/cli/commands/workflows/generate-key) command| |bucket| Name of your Storj bucket (optional)| |writeAccessToken| Storj access grant with **write** and **delete** permissions for this bucket (optional)| |readAccessToken| Storj access grant with **read** permission for this bucket (optional)| @@ -168,42 +168,9 @@ You can find the section with your Authority and Action Accounts Private Keys in }, ``` -## Create a test order - -Before you create an order, ensure you have the latest version of SPCTL. Execute the following command to see the version you are currently using: - -``` -./spctl --version -``` - -Go to the SPCTL's [GitHub page](https://github.com/Super-Protocol/ctl/releases) to see the latest version. - -Use the [`tokens request`](https://docs.dev.superprotocol.com/developers/cli_commands/tokens/request) command to get free test TEE and POL tokens: - -``` -./spctl tokens request --tee -./spctl tokens request --matic -``` - -It may take a couple of minutes for the tokens to appear on your account. When you have them, execute the [`workflows create`](/cli/cli_commands/workflows/create) command to create a [Super Chat](/developers/offers/superchat) order: - -``` -./spctl workflows create --solution 12,12 --solution 6,2 --data 17,22 --storage 25,30 -``` - -When your order is created, you will see the following in the last line of the CLI output: - -``` -Workflow was created, TEE order id: [""] -``` - -Where `` is the ID of your order. - -It usually takes 20-25 minutes for this order to be done. You can then check the order status using the [`orders`](/cli/cli_commands/orders) command or in [Marketplace GUI](/developers/marketplace). - ## Set up Storj -This step is optional. You can add a Marketplace storage offer to the [`files upload`](/cli/cli_commands/files/upload) command instead of configuring Storj. However, for additional control, you can set up and use your storage. +This step is optional. You can add a Marketplace storage offer to the [`files upload`](/cli/commands/files/upload) command instead of configuring Storj. However, for additional control, you can set up and use your storage. Register a [Storj](https://www.storj.io/) account if you do not have one yet. diff --git a/docs/developers/cli_guides/providers_offers.md b/docs/developers/cli_guides/providers_offers.md index c728c0d8..aff3c772 100644 --- a/docs/developers/cli_guides/providers_offers.md +++ b/docs/developers/cli_guides/providers_offers.md @@ -87,7 +87,7 @@ Go to your SPCTL directory and create the offer content using your Testnet user **For solution offers** -Use the [`solutions prepare`](/cli/cli_commands/solutions/prepare) command. It will pack and sign the solution with [Gramine](https://gramineproject.io/) to prepare it for execution inside a Trusted Execution Environment. The command will create a TAR.GZ archive with the solution and a metadata JSON file. +Use the [`solutions prepare`](/cli/commands/solutions/prepare) command. It will pack and sign the solution with [Gramine](https://gramineproject.io/) to prepare it for execution inside a Trusted Execution Environment. The command will create a TAR.GZ archive with the solution and a metadata JSON file. You can find a detailed example of preparing a Python solution in the [Python deployment guide](/developers/deployment_guides/python/solution_prep). @@ -120,7 +120,7 @@ Both ways have pros and cons. Pick the one that suits you better. It is a simpler and quicker way to upload offer content if you do not have a Storj account and have not configured SPCTL to use it. However, you must regularly check the storage order and [keep it alive](/developers/cli_guides/providers_offers#lease-on-uploaded-offer-content). Otherwise, your offer content will eventually become unavailable. -Execute the following [`files upload`](/cli/cli_commands/files/upload) command to create a storage order on Super Protocol with your offer content: +Execute the following [`files upload`](/cli/commands/files/upload) command to create a storage order on Super Protocol with your offer content: ``` ./spctl files upload --storage 25,33 --min-rent-minutes 43200 @@ -129,11 +129,11 @@ Execute the following [`files upload`](/cli/cli_commands/files/upload) command t Where - `` is the name of the archive file with your prepared solution or data. - `--storage 25,33` is the slot ID 33 of the storage offer ID 25. The maximum disk capacity for this slot is 0.977 GB; you may choose [another slot](https://marketplace.superprotocol.com/storage?offer=offerId%3D25&tab=pricing) that suits your offer content better. -- `--min-rent-minutes 43200` is the lease time set to 30 days. The offer content will be available for that period. You can make the lease time shorter or longer. You can also [replenish the balance](/cli/cli_commands/orders/replenish-deposit) later to prolong the storage order. +- `--min-rent-minutes 43200` is the lease time set to 30 days. The offer content will be available for that period. You can make the lease time shorter or longer. You can also [replenish the balance](/cli/commands/orders/replenish-deposit) later to prolong the storage order. As a result, SPCTL generates the `resource.json` file with information for a compute provider to access your uploaded offer content. Copy this file to the Provider Tools directory. This file also contains the storage order ID. Use it to check the storage order and replenish the deposit if necessary. -You can check all your orders, including storage orders, by using the [`orders list`](/cli/cli_commands/orders/list) command. Note that you cannot see your storage orders in the Marketplace GUI. +You can check all your orders, including storage orders, by using the [`orders list`](/cli/commands/orders/list) command. Note that you cannot see your storage orders in the Marketplace GUI. **Upload to a Storj account** @@ -145,7 +145,7 @@ Both Free Trial and Pro Storj accounts are suitable. However, if you have a free ::: -Execute the following [`files upload`](/cli/cli_commands/files/upload) command to upload your offer content to Storj using SPCTL: +Execute the following [`files upload`](/cli/commands/files/upload) command to upload your offer content to Storj using SPCTL: ``` ./spctl files upload @@ -254,7 +254,7 @@ Fill in the following values: + `offers`: state the IDs of such required offers, including the IDs of their dependencies. Put each ID in quotation marks and separate with a comma. See the examples below. + `types`: state the types of the required offers. The type must be either `2` for a solution offer in `"offers"` or `3` for a data offer in `"offers"`. If there are several IDs in `"offers"`, state the type for each of them. Put each number in quotation marks and separate with a comma. See the examples below. -Refer to the documentation of the [`offers update`](/cli/cli_commands/offers/offers/update) command to learn more. +Refer to the documentation of the [`offers update`](/cli/commands/offers/update) command to learn more. **Example 1** @@ -316,7 +316,7 @@ To get more examples, check existing offers via the Marketplace GUI:
-Or via CLI using the SPCTL [`offers get`](/cli/cli_commands/offers/offers/get) command: +Or via CLI using the SPCTL [`offers get`](/cli/commands/offers/get) command: ``` ./spctl offers get value 8 @@ -358,7 +358,7 @@ The following is an `offer-slot.json` template file with example values: Copy it to your `offer-slot.json` file and modify all the values as necessary. Since this is your offer, only you know the [price](/fundamentals/orders#cost-and-pricing) and compute configuration your solution or data needs to run. Every offer can have multiple requirements slots. You must create a separate JSON file for each slot. -Refer to the [`offers add-slot`](/cli/cli_commands/offers/slots/add-slot) command's documentation to learn more about the objects and strings in this file. +Refer to the [`offers add-slot`](/cli/commands/offers/add-slot) command's documentation to learn more about the objects and strings in this file. To get more examples, check existing offers via the Marketplace GUI: @@ -366,7 +366,7 @@ To get more examples, check existing offers via the Marketplace GUI:
-Or via CLI using the [offers get-slot](/cli/cli_commands/offers/slots/get-slot) command: +Or via CLI using the [offers get-slot](/cli/commands/offers/get-slot) command: ``` ./spctl offers get-slot value --offer 8 --slot 4 @@ -426,7 +426,7 @@ Provider Tools also creates a provider SPCTL configuration file in its root dire Rename this file to `config.json` so SPCTL can recognize it as its configuration file. Copy or [download](/cli) SPCTL to the Provider Tools directory. It is your provider SPCTL. -Alternatively, copy this provider's SPCTL config to your SPCTL directory. Use the `--config` option with [SPCTL commands](/cli/cli_commands) to manage your provider and orders. For example: +Alternatively, copy this provider's SPCTL config to your SPCTL directory. Use the `--config` option with [SPCTL commands](/cli/commands) to manage your provider and orders. For example: ``` ./spctl orders list --my-account --type tee --config spctl-config-0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAa.json @@ -479,9 +479,9 @@ When the order is created, you will see the ID of the Offer Provisioner order in {"Successfully created workflow with id: 3394. You can go to https://marketplace.superprotocol.com/order/3394 to track order status."} ``` -Alternatively, you can create an Offer Provisioner order manually. Pack the content of the `execution-controller` directory (`config.json` and `.env`) into a TAR.GZ archive and upload it using the [`files upload`](/cli/cli_commands/files/upload) command. Add the resulting `resource.json` to the order as data and the Offer Provisioner solution offer (ID 26) as a solution using either Marketplace GUI or the `workflows create` SPCTL command. +Alternatively, you can create an Offer Provisioner order manually. Pack the content of the `execution-controller` directory (`config.json` and `.env`) into a TAR.GZ archive and upload it using the [`files upload`](/cli/commands/files/upload) command. Add the resulting `resource.json` to the order as data and the Offer Provisioner solution offer (ID 26) as a solution using either Marketplace GUI or the `workflows create` SPCTL command. -Check that your offer is on the blockchain using the [offers get](/cli/cli_commands/offers/offers/get) command: +Check that your offer is on the blockchain using the [offers get](/cli/commands/offers/get) command: ``` ./spctl offers get value @@ -515,17 +515,17 @@ As a provider, you must ensure your offer stays active. Keep track of the storag Ensure your storage order does not end. -If you created a [storage order](/cli/cli_commands/files/upload) for your offer content in [Step 1](/developers/cli_guides/providers_offers#upload-offer-content), keep track of the balance and replenish it in time. +If you created a [storage order](/cli/commands/files/upload) for your offer content in [Step 1](/developers/cli_guides/providers_offers#upload-offer-content), keep track of the balance and replenish it in time. ::: -If the storage order expires, the TEE can no longer access your uploaded offer content, and the customer order will fail. Execute the [`orders list`](/cli/cli_commands/orders/list) SPCTL command from your user account to get the list of your storage orders: +If the storage order expires, the TEE can no longer access your uploaded offer content, and the customer order will fail. Execute the [`orders list`](/cli/commands/orders/list) SPCTL command from your user account to get the list of your storage orders: ``` ./spctl orders list --my-account --type storage ``` -Use the [`orders get`](/cli/cli_commands/orders/get) command to check the total and unspent deposits. Use the [`orders replenish-deposit`](/cli/cli_commands/orders/replenish-deposit) command to add tokens to the balance of the storage order. +Use the [`orders get`](/cli/commands/orders/get) command to check the total and unspent deposits. Use the [`orders replenish-deposit`](/cli/commands/orders/replenish-deposit) command to add tokens to the balance of the storage order. ### Lease on Offer Provisioner @@ -537,7 +537,7 @@ Keep track of the balance and replenish it in time. Without a response from Offe ::: -Execute the [`orders list`](/cli/cli_commands/orders/list) command using the provider SPCTL to get the list of your Offer Provisioner orders: +Execute the [`orders list`](/cli/commands/orders/list) command using the provider SPCTL to get the list of your Offer Provisioner orders: ``` ./spctl orders list --my-account --type tee @@ -545,14 +545,14 @@ Execute the [`orders list`](/cli/cli_commands/orders/list) command using the pro An [Offer Provisioner order](/developers/cli_guides/providers_offers#create-an-offer-provisioner-order) must always be active and ready to authorize its offer. -Use the [`orders get`](/cli/cli_commands/orders/get) command to check the total and unspent deposits. Use the [`orders replenish-deposit`](/cli/cli_commands/orders/replenish-deposit) command to add tokens to the Offer Provisioner order. +Use the [`orders get`](/cli/commands/orders/get) command to check the total and unspent deposits. Use the [`orders replenish-deposit`](/cli/commands/orders/replenish-deposit) command to add tokens to the Offer Provisioner order. ## FAQ ### Update provider info -It is possible to update provider information such as name, description, action account, and token receiver account. Make changes to `provider.json` you saved in [Step 4](/developers/cli_guides/providers_offers#step-4-register-the-provider-and-offer) and use the [`providers update`](/cli/cli_commands/providers/update) SPCTL command from your current action account. -It is possible to update provider information such as name, description, action account, and token receiver account. Make changes to `provider.json` you saved in [Step 4](/developers/cli_guides/providers_offers#step-4-register-the-provider-and-offer) and use the [`providers update`](/cli/cli_commands/providers/update) SPCTL command from your current action account. +It is possible to update provider information such as name, description, action account, and token receiver account. Make changes to `provider.json` you saved in [Step 4](/developers/cli_guides/providers_offers#step-4-register-the-provider-and-offer) and use the [`providers update`](/cli/commands/providers/update) SPCTL command from your current action account. +It is possible to update provider information such as name, description, action account, and token receiver account. Make changes to `provider.json` you saved in [Step 4](/developers/cli_guides/providers_offers#step-4-register-the-provider-and-offer) and use the [`providers update`](/cli/commands/providers/update) SPCTL command from your current action account. If you changed your action account address, update the Provider SPCTL's `config.json` with the new action account private key. @@ -560,13 +560,13 @@ If you changed your action account address, update the Provider SPCTL's `config. **Offer description:** -Modify `offer-info.json` you have prepared in [Step 3](/developers/cli_guides/providers_offers#offer-description) and then run the [`offers update`](/cli/cli_commands/offers/offers/update) command using the Provider SPCTL. +Modify `offer-info.json` you have prepared in [Step 3](/developers/cli_guides/providers_offers#offer-description) and then run the [`offers update`](/cli/commands/offers/update) command using the Provider SPCTL. **Offer requirements (slots):** -Modify `offer-slot.json` you have prepared in [Step 3](/developers/cli_guides/providers_offers#offer-requirements) and then run the [`offers update-slot`](/cli/cli_commands/offers/slots/update-slot) command using the Provider SPCTL. +Modify `offer-slot.json` you have prepared in [Step 3](/developers/cli_guides/providers_offers#offer-requirements) and then run the [`offers update-slot`](/cli/commands/offers/update-slot) command using the Provider SPCTL. -Similarly, you can use the [`offers add-slot`](/cli/cli_commands/offers/slots/add-slot) command to add another slot and the [`offers delete-slot`](/cli/cli_commands/offers/slots/delete-slot) command to remove a slot. +Similarly, you can use the [`offers add-slot`](/cli/commands/offers/add-slot) command to add another slot and the [`offers delete-slot`](/cli/commands/offers/delete-slot) command to remove a slot. ### Create additional offers @@ -578,7 +578,7 @@ You can also manually edit the `PROVIDER_OFFERS_JSON` array in the `.env` file t ### Enable/disable offers -Disable your offer if you no longer want to provide your application or data on Super Protocol. Execute the [`offers disable`](/cli/cli_commands/offers/offers/disable) command from your Provider SPCTL: +Disable your offer if you no longer want to provide your application or data on Super Protocol. Execute the [`offers disable`](/cli/commands/offers/disable) command from your Provider SPCTL: ``` ./spctl offers disable @@ -586,7 +586,7 @@ Disable your offer if you no longer want to provide your application or data on Replace `` with the ID of the offer you want to disable. -It will make the offer unavailable to use but will not delete it. Later, if you want to reinstate it back to active status, use the [`offers enable`](/cli/cli_commands/offers/offers/enable) command. +It will make the offer unavailable to use but will not delete it. Later, if you want to reinstate it back to active status, use the [`offers enable`](/cli/commands/offers/enable) command. ### Inactive offers diff --git a/docs/developers/cli_guides/quick_guide.md b/docs/developers/cli_guides/quick_guide.md index ecb8e046..d9a80c40 100644 --- a/docs/developers/cli_guides/quick_guide.md +++ b/docs/developers/cli_guides/quick_guide.md @@ -11,13 +11,13 @@ This quick guide will take you step by step through deploying a solution and dat ### Step 1. Pack a solution -To prepare a solution for execution inside a Trusted Execution Environment, pack and sign it with [Gramine](https://gramineproject.io/). To do this, run the [`solutions prepare`](/cli/cli_commands/solutions/prepare) command. +To prepare a solution for execution inside a Trusted Execution Environment, pack and sign it with [Gramine](https://gramineproject.io/). To do this, run the [`solutions prepare`](/cli/commands/solutions/prepare) command. It will create a TAR.GZ archive with the solution and a JSON file with essential metadata. ### Step 2. Upload the solution to the storage -Run the [`files upload`](/cli/cli_commands/files/upload) command using the TAR.GZ archive from the previous step. +Run the [`files upload`](/cli/commands/files/upload) command using the TAR.GZ archive from the previous step. The command will create a resource JSON file with the information for the compute resource on how to access and download the solution. @@ -45,7 +45,7 @@ tar -czvf archived_data.tar.gz -C ./data . ### Step 2. Upload the data to the storage -Run the [`files upload`](/cli/cli_commands/files/upload) command using the TAR.GZ archive from the previous step. +Run the [`files upload`](/cli/commands/files/upload) command using the TAR.GZ archive from the previous step. The command will create a resource JSON file with the information for the compute resource on how to access and download the data. @@ -53,12 +53,12 @@ The command will create a resource JSON file with the information for the comput ### Step 3. Create an order -Run the [`workflows create`](/cli/cli_commands/workflows/create) using the resource JSON file created in Step 2. When the order is created, you will see the order ID in the terminal output. +Run the [`workflows create`](/cli/commands/workflows/create) using the resource JSON file created in Step 2. When the order is created, you will see the order ID in the terminal output. It may be more convenient to use the [**Marketplace GUI**](/developers/marketplace/) for this and the following step. ### Step 4. Receive the result -Orders take a few minutes to process. Use the [`orders get`](/cli/cli_commands/orders/get) command to track the progress. When the order status is `Done`, retrieve the result using the [`orders download-result`](/cli/cli_commands/orders/download-result) command. +Orders take a few minutes to process. Use the [`orders get`](/cli/commands/orders/get) command to track the progress. When the order status is `Done`, retrieve the result using the [`orders download-result`](/cli/commands/orders/download-result) command. Certain solutions, such as Tunnel Server, may have the result available earlier. For them, the status `Processing` means they are live and operational. Read more in the [Usage scenarios](Usage scenarios) section. \ No newline at end of file diff --git a/docs/developers/deployment_guides/blockchain/oracles.md b/docs/developers/deployment_guides/blockchain/oracles.md index 6d9b06e9..8baa7144 100644 --- a/docs/developers/deployment_guides/blockchain/oracles.md +++ b/docs/developers/deployment_guides/blockchain/oracles.md @@ -174,7 +174,7 @@ In this step we will cover the first component. All the solutions deployed on Super Protocol have to use a base image solution offer. In this case it will be a Node.js base image. -Go to your project root directory and execute this [command](/cli/cli_commands/offers/offers/download-content): +Go to your project root directory and execute this [command](/cli/commands/offers/download-content): ```shell ./spctl offers download-content 6 @@ -190,7 +190,7 @@ Next, we will build a Docker image of the service. For the Docker image to run i ./spctl solutions generate-key signing-key ``` -Execute the following [command](/cli/cli_commands/solutions/prepare) in the root of your project to prepare and pack the solution: +Execute the following [command](/cli/commands/solutions/prepare) in the root of your project to prepare and pack the solution: ```shell ./spctl solutions prepare --pack-solution oracle-solution.tar.gz --write-default-manifest --base-image-path ./solutions/Blockchain/sp-oracle/script/run/ signing-key @@ -207,7 +207,7 @@ MRSIGNER: 36f3bb39d10617852d1eef2f5066d8f9add2c65fb1a026d86398fec405fe725c **Save these values!** Important: different MRENCLAVE and MRSIGNER values are generated for each run of the `prepare` command. -Finally, we will [encrypt and upload](/cli/cli_commands/files/upload) the prepared solution to decentralized storage (Storj): +Finally, we will [encrypt and upload](/cli/commands/files/upload) the prepared solution to decentralized storage (Storj): ```shell ./spctl files upload oracle-solution.tar.gz --output oracle-solution.json --filename oracle-solution.tar.gz --metadata ./metadata.json @@ -344,7 +344,7 @@ An `oracle-input.json` will be created. We will use this file and `oracle-soluti The result will be an order ID. -You can check the status of the order using [Marketplace GUI](/developers/marketplace) or this [command](/cli/cli_commands/orders/get): +You can check the status of the order using [Marketplace GUI](/developers/marketplace) or this [command](/cli/commands/orders/get): ```shell ./spctl orders get diff --git a/docs/developers/deployment_guides/python/data.md b/docs/developers/deployment_guides/python/data.md index f2c28016..61fef429 100644 --- a/docs/developers/deployment_guides/python/data.md +++ b/docs/developers/deployment_guides/python/data.md @@ -24,7 +24,7 @@ Please make sure that system or hidden files are not included into the archive. ::: ## Upload data archives -And [upload](/cli/cli_commands/files/upload) archives to storage: +And [upload](/cli/commands/files/upload) archives to storage: ``` ./spctl files upload input-1.tar.gz --output input-1.json --filename input-1.tar.gz diff --git a/docs/developers/deployment_guides/python/exec_result.md b/docs/developers/deployment_guides/python/exec_result.md index 6e2838f2..c7700ac2 100644 --- a/docs/developers/deployment_guides/python/exec_result.md +++ b/docs/developers/deployment_guides/python/exec_result.md @@ -15,7 +15,7 @@ Now you will need to execute together: * Python base image solution offer from the [Marketplace](https://marketplace.superprotocol.com/solutions?offerId=5&offer=offerId%3D5); * Your two datasets represented by `input-1.json` and `input-2.json` (which will direct TEE to download the archives from storage). -Use the following [command](/cli/cli_commands/workflows/create): +Use the following [command](/cli/commands/workflows/create): ``` ./spctl workflows create --tee 1,1 --tee-slot-count 1 --storage 25,30 --solution 5,1 --solution solution.json --data input-1.json --data input-2.json @@ -25,7 +25,7 @@ An order ID is generated upon execution. ## Check Order Status -You can check the order status using the [Marketplace GUI](/developers/marketplace) or the SPCTL [command](/cli/cli_commands/orders/get): +You can check the order status using the [Marketplace GUI](/developers/marketplace) or the SPCTL [command](/cli/commands/orders/get): ``` ./spctl orders get @@ -35,7 +35,7 @@ When the status turns to `Done`, proceed to the next step. ## Receive Result -Retrieve the result using the [Marketplace GUI](/developers/marketplace) or the following [command](/cli/cli_commands/orders/download-result): +Retrieve the result using the [Marketplace GUI](/developers/marketplace) or the following [command](/cli/commands/orders/download-result): ``` ./spctl orders download-result diff --git a/docs/developers/deployment_guides/python/solution.md b/docs/developers/deployment_guides/python/solution.md index f2685aa2..512251e9 100644 --- a/docs/developers/deployment_guides/python/solution.md +++ b/docs/developers/deployment_guides/python/solution.md @@ -114,7 +114,7 @@ If done correctly, the `output` directory should contain `.csv` file with result Now that we are happy with the way solution runs locally, the next steps are related to preparation for deployment to Super Protocol. -Run the following [command](/cli/cli_commands/solutions/generate-key) in the directory where you placed the SPCTL executable to generate the signing key for the solution: +Run the following [command](/cli/commands/solutions/generate-key) in the directory where you placed the SPCTL executable to generate the signing key for the solution: ``` ./spctl solutions generate-key signing-key @@ -122,7 +122,7 @@ Run the following [command](/cli/cli_commands/solutions/generate-key) in the dir ## Pack the solution -When the Docker image should run inside an Intel SGX enclave, the image has to be built and signed with [Gramine](https://gramine.readthedocs.io/en/latest/gsc-installation.html) (a.k.a graminized). Execute the following [command](/cli/cli_commands/solutions/prepare) to prepare and pack the solution: +When the Docker image should run inside an Intel SGX enclave, the image has to be built and signed with [Gramine](https://gramine.readthedocs.io/en/latest/gsc-installation.html) (a.k.a graminized). Execute the following [command](/cli/commands/solutions/prepare) to prepare and pack the solution: ``` ./spctl solutions prepare --pack-solution solution.tar.gz --write-default-manifest \ diff --git a/docs/developers/deployment_guides/tunnels/develop.md b/docs/developers/deployment_guides/tunnels/develop.md index 90044810..ca508602 100644 --- a/docs/developers/deployment_guides/tunnels/develop.md +++ b/docs/developers/deployment_guides/tunnels/develop.md @@ -87,7 +87,7 @@ server.listen(port, () => { ## Testing -Test your solution using our Node.js base image. You need to test specifically with the same base image that is contained in the Node.js base image offer. You can download it using this [command](/cli/cli_commands/offers/offers/download-content): +Test your solution using our Node.js base image. You need to test specifically with the same base image that is contained in the Node.js base image offer. You can download it using this [command](/cli/commands/offers/download-content): ```bash ./spctl offers download-content 6 diff --git a/docs/developers/deployment_guides/tunnels/manual_run.md b/docs/developers/deployment_guides/tunnels/manual_run.md index 615df8f3..fb7293c5 100644 --- a/docs/developers/deployment_guides/tunnels/manual_run.md +++ b/docs/developers/deployment_guides/tunnels/manual_run.md @@ -26,7 +26,7 @@ Create an archive of the token: tar -czf tunnel-server-data.tar.gz -C ./tunnel-server-data . ``` -Encrypt and upload the archive to storage using the [`files upload`](/cli/cli_commands/files/upload) command: +Encrypt and upload the archive to storage using the [`files upload`](/cli/commands/files/upload) command: ```bash ./spctl files upload tunnel-server-data.tar.gz --output tunnel-server-data.json --filename tunnel-server-data.tar.gz @@ -40,7 +40,7 @@ Create an order for Tunnel Server using the `tunnel-server-data.json` file conta ./spctl workflows create --tee 1 --solution 6,2 --solution 11,10 --data tunnel-server-data.json --storage 25,30 --orders-limit 10 --min-rent-minutes 60 ``` -**Tip:** to create order make sure that you have sufficient amount of TEE and POL tokens in your testnet wallet. You can get more tokens using the [tokens request](/cli/cli_commands/tokens/request) command. Be mindful of testnet [limitations](/marketplace/limitations). +**Tip:** to create order make sure that you have sufficient amount of TEE and POL tokens in your testnet wallet. You can get more tokens using the [tokens request](/cli/commands/tokens/request) command. Be mindful of testnet [limitations](/marketplace/limitations). The last line of the output will look like this: @@ -50,7 +50,7 @@ Workflow was created, TEE order id: ["XXXX"] Where XXXX is the order ID. -You can check the status of the order using [Marketplace GUI](/developers/marketplace) or this [command](/cli/cli_commands/orders/get): +You can check the status of the order using [Marketplace GUI](/developers/marketplace) or this [command](/cli/commands/orders/get): ```shell ./spctl orders get @@ -123,7 +123,7 @@ Add the folder to archive: tar -czf tunnel-client-data.tar.gz -C ./tunnel-client-data . ``` -Encrypt and upload the archive to storage using the [files upload](/cli/cli_commands/files/upload) command: +Encrypt and upload the archive to storage using the [files upload](/cli/commands/files/upload) command: ```bash ./spctl files upload tunnel-client-data.tar.gz --output tunnel-client-data.json --filename tunnel-client-data.tar.gz diff --git a/docs/developers/deployment_guides/tunnels/static_content.md b/docs/developers/deployment_guides/tunnels/static_content.md index d59edc7d..0249cadf 100644 --- a/docs/developers/deployment_guides/tunnels/static_content.md +++ b/docs/developers/deployment_guides/tunnels/static_content.md @@ -134,7 +134,7 @@ Remember the resulting order ID. ### Check Order Status -You can check the status of the server and client tunnels using the order ID's using this [command](/cli/cli_commands/orders/get): +You can check the status of the server and client tunnels using the order ID's using this [command](/cli/commands/orders/get): ``` ./spctl orders get diff --git a/docs/developers/index.md b/docs/developers/index.md index 7b45ff7d..d9794822 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -23,7 +23,7 @@ If you are just starting out, feel your way around Super Protocol using the Mark When you know the basics, try SPCTL—the Super Protocol CLI tool: 1. [Configure SPCTL](/cli) as a user. -2. Read about the [fundamentals](/fundamentals), [Testnet limitations](/marketplace/limitations), and key [CLI commands](/cli/cli_commands). +2. Read about the [fundamentals](/fundamentals), [Testnet limitations](/marketplace/limitations), and key [CLI commands](/cli/commands). 3. Read the [Quick Deployment Guide](/developers/cli_guides/quick_guide) to learn about deploying your solutions. 4. Choose a [deployment guide](/developers/deployment_guides/) to get an example for additional deployment scenarios. diff --git a/docs/developers/marketplace_gui/confidentiality.md b/docs/developers/marketplace_gui/confidentiality.md index 638345cc..d0fd5721 100644 --- a/docs/developers/marketplace_gui/confidentiality.md +++ b/docs/developers/marketplace_gui/confidentiality.md @@ -9,7 +9,7 @@ _Quote verification_ checks the authenticity and integrity of a Trusted Executio In simple terms, quote verification ensures that the content of a domain is running in a TEE. Additionally, if the content is Super Protocol solution offers, the quote verification links the content to the offers. -For quote verification, use the [`quotes validate`](/cli/cli_commands/quotes/validate) CLI command or the **Check confidentiality** function in the Marketplace GUI. +For quote verification, use the [`quotes validate`](/cli/commands/quotes/validate) CLI command or the **Check confidentiality** function in the Marketplace GUI. ## Check how it works diff --git a/docs/developers/marketplace_gui/index.md b/docs/developers/marketplace_gui/index.md index b46c40ae..92251460 100644 --- a/docs/developers/marketplace_gui/index.md +++ b/docs/developers/marketplace_gui/index.md @@ -5,7 +5,7 @@ slug: "/marketplace/" sidebar_position: 3 --- -Marketplace graphical interface (GUI) is a user-friendly web interface to [Marketplace](/fundamentals). It also provides an interactive learning experience for new users. GUI serves as a companion tool to the Super Protocol command-line interface (CLI) tool [SPCTL](/cli/cli_commands). However, GUI capabilities are currently limited so it is not a full alternative to CLI. +Marketplace graphical interface (GUI) is a user-friendly web interface to [Marketplace](/fundamentals). It also provides an interactive learning experience for new users. GUI serves as a companion tool to the Super Protocol command-line interface (CLI) tool [SPCTL](/cli/commands). However, GUI capabilities are currently limited so it is not a full alternative to CLI. Go to Marketplace GUI: [**marketplace.superprotocol.com**](https://marketplace.superprotocol.com/) @@ -26,29 +26,29 @@ The things you can do in the Marketplace GUI and the their respective CLI comman | **Function** | **SPCTL Command** | |:-----------------------------------------------|:------------------------------------------------------------------------------| -| View details of offers available on blockchain | [`offers`](/cli/cli_commands/offers) | -| Receive test TEE and POL tokens | [`tokens request`](/cli/cli_commands/tokens/request) | -| Create orders using offers | [`workflows create`](/cli/cli_commands/workflows/create) | -| Use your own data for the solution offers | [`workflows create`](/cli/cli_commands/workflows/create) | -| Generate encryption keys for orders | [`workflows generate-key`](/cli/cli_commands/workflows/generate-key) | -| See list of all your orders | [`orders list`](/cli/cli_commands/orders/list) | -| See details and statuses of specific orders | [`orders get`](/cli/cli_commands/orders/get) | -| Replenish order deposits | [`orders replenish-deposit`](/cli/cli_commands/orders/replenish-deposit) | -| Cancel orders | [`orders cancel`](/cli/cli_commands/orders/cancel) | -| Receive order results | [`orders download-result`](/cli/cli_commands/orders/download-result) | -| Check confidentiality | [`quotes validate`](/cli/cli_commands/quotes/validate) | +| View details of offers available on blockchain | [`offers`](/cli/commands/offers) | +| Receive test TEE and POL tokens | [`tokens request`](/cli/commands/tokens/request) | +| Create orders using offers | [`workflows create`](/cli/commands/workflows/create) | +| Use your own data for the solution offers | [`workflows create`](/cli/commands/workflows/create) | +| Generate encryption keys for orders | [`workflows generate-key`](/cli/commands/workflows/generate-key) | +| See list of all your orders | [`orders list`](/cli/commands/orders/list) | +| See details and statuses of specific orders | [`orders get`](/cli/commands/orders/get) | +| Replenish order deposits | [`orders replenish-deposit`](/cli/commands/orders/replenish-deposit) | +| Cancel orders | [`orders cancel`](/cli/commands/orders/cancel) | +| Receive order results | [`orders download-result`](/cli/commands/orders/download-result) | +| Check confidentiality | [`quotes validate`](/cli/commands/quotes/validate) | ## Available in the Marketplace CLI only -The most important functions available only in [SPCTL](/cli/cli_commands): +The most important functions available only in [SPCTL](/cli/commands): | **Function** | **SPCTL Command** | |:-----------------------------------------------|:------------------------------------------------------------------------------| -| Prepare a solution for execution | [`solutions prepare`](/cli/cli_commands/solutions/prepare) | -| Upload files to storage | [`files upload`](/cli/cli_commands/files/upload) | -| Create orders using your solutions | [`workflows create`](/cli/cli_commands/workflows/create) | -| Update an offer | [`offers update`](/cli/cli_commands/offers/offers/update) and [`offers update-slot`](/cli/cli_commands/offers/slots/update-slot)| -| Update a provider | [`providers update`](/cli/cli_commands/providers/update) | +| Prepare a solution for execution | [`solutions prepare`](/cli/commands/solutions/prepare) | +| Upload files to storage | [`files upload`](/cli/commands/files/upload) | +| Create orders using your solutions | [`workflows create`](/cli/commands/workflows/create) | +| Update an offer | [`offers update`](/cli/commands/offers/update) and [`offers update-slot`](/cli/commands/offers/update-slot)| +| Update a provider | [`providers update`](/cli/commands/providers/update) | Refer to the [Providers and offers](/developers/cli_guides/providers_offers) guide to register a provider and create a solution or data offer. diff --git a/docs/developers/marketplace_gui/moderation.md b/docs/developers/marketplace_gui/moderation.md index fd2c9d6f..d0691812 100644 --- a/docs/developers/marketplace_gui/moderation.md +++ b/docs/developers/marketplace_gui/moderation.md @@ -20,7 +20,7 @@ Marketplace GUI has a special filter that divides the offers into four categorie -These categories are exclusive meaning an offer can belong only to one category. Offers with the **Disabled** status do not appear in the Marketplace GUI. Providers can use [`offers disable`](/cli/cli_commands/offers/offers/disable) and [`offers enable`](/cli/cli_commands/offers/offers/enable) commands to manage this. +These categories are exclusive meaning an offer can belong only to one category. Offers with the **Disabled** status do not appear in the Marketplace GUI. Providers can use [`offers disable`](/cli/commands/offers/disable) and [`offers enable`](/cli/commands/offers/enable) commands to manage this. ## Requirements diff --git a/docs/marketplace/guides/place-order.md b/docs/marketplace/guides/place-order.md index b7984bbc..1e8ed82a 100644 --- a/docs/marketplace/guides/place-order.md +++ b/docs/marketplace/guides/place-order.md @@ -78,7 +78,7 @@ Click the blue **[+]** button to add a machine to the order. **In Queue** shows the number of orders waiting for an empty slot on this machine. If it is not zero, your order may take longer to process. Consider choosing another compute offer. - +Screenshot showing the queue status indicator for compute offers
## Step 4. Set lease time @@ -128,7 +128,7 @@ Once the Deploy order is placed successfully, you will be redirected to its [**O ## Step 6. Manage the order -Your order may take about 30 minutes to process if you used a model from Marketplace and up to one hour for uploaded models. You can check the order status in the **Order** screen. When the model is deployed and available, you will see **Deployed** in the order status and **Online** in the tunnel's status. +Your order may take about 30 minutes to process if you used a model from Marketplace and up to one hour for uploaded models. You can check the order status on the **Order** screen. When the model is deployed and available, you will see **Deployed** in the order status and **Online** in the tunnel's status.
diff --git a/docs/marketplace/guides/troubleshooting.md b/docs/marketplace/guides/troubleshooting.md index 28adddc3..4c2bacd2 100644 --- a/docs/marketplace/guides/troubleshooting.md +++ b/docs/marketplace/guides/troubleshooting.md @@ -19,7 +19,7 @@ If MetaMask shows no requests, refresh the page and press the **Enter Marketplac If the problem persists, restart your browser and unlock MetaMask before trying to enter the Marketplace. -This issue may also occur due to Marketplace maintenance. Wait a few minutes and try again, or contact Super Protocol on Discord for a quick update. +This issue may also occur due to Marketplace maintenance. Wait a few minutes and try again, or contact Super Protocol on [Discord](https://discord.gg/superprotocol) for a quick update. ## Order status: Error diff --git a/docs/marketplace/guides/upload.md b/docs/marketplace/guides/upload.md index e47e9f42..ebfa6a75 100644 --- a/docs/marketplace/guides/upload.md +++ b/docs/marketplace/guides/upload.md @@ -12,7 +12,7 @@ This guide provides step-by-step instructions for uploading a model to Super Pro ## Step 1. Check requirements -Ensure your model meets the Super Protocol requirements. Otherwise, the order may fail. +Ensure your model meets the following Super Protocol requirements. ### Model category @@ -44,30 +44,36 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support The size of your model should not exceed 10 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future. -Note that large models may perform poorly on TDX machines without GPU support. If you plan on deploying on CPU, choose a smaller model. +Note that large models may perform poorly on CPU-only machines without GPU support. If you plan on deploying on CPU, choose a smaller model. ## Step 2. Select files -Model repositories contain multiple files. Often, not all of them are required. Select files following the instructions for your model's format. +Model repositories contain multiple files. Often, not all of them are required. -### GGUF and GGML formats +Create a directory for the model files—the model directory. Select files following the instructions for your model format and place them to the model directory. -For models in thes formats, the files in the repository usually contain variants of the same model with different quantization. Note that higher-bit quantization means a larger file. +If multiple formats are available, choose one of them and remove the others. For example, one of the highlighted sets of files on the following screenshot should be removed: + + +
-Choose one file and place it in a separate directory. For example: +### GGUF and GGML + +For models in these formats, the files in the repository usually contain variants of the same model with different quantization. Note that higher-bit quantization means a larger file. + +Choose one file and place it in the model directory. For example:
-### Safetensors formats +### Safetensors -Place all files from the repository in a separate directory. For example: +Place all model files from the repository in the model directory. For example:
-
-Avoid duplications to reduce uploading time. Some repositories contain several variants of the same model. For example, one of the the highlighted files on the following screenshot can be removed: +Some repositories contain several variants of the same model. Avoid duplications to reduce upload time. For example, one of the the highlighted files on the following screenshot can be removed:
@@ -78,82 +84,94 @@ If a single consolidated `model.safetensors` file and multiple `model-xxxxx-of-y
-### Multiple formats - -If multiple formats are available, choose one of them and remove the others. For example, one of the highlighted sets of files on the following screenshot should be removed: - - -
-
- -:::note - -For some models, you should remove additional formats in the model's root directory and subdirectories. - -::: - ## Step 3. Create a TAR.GZ archive -Ensure your model's directory contains no hidden files and subdirectories. Archive the directory with the selected model files into a TAR.GZ file using the following instructions: +Ensure the model directory contains no hidden files and directories. Archive the model directory into a TAR.GZ file using the following instructions: - On Windows, open PowerShell or Windows Command Prompt and run the following command: + On Windows, open PowerShell, navigate to the directory that contains the model directory, and run the following command: ``` - tar.exe -czvf + tar.exe -czvf ``` - Replace `` with the path and desired name of the output archive. Replace `` with the path to the folder with the model files. + - Replace `` with the desired name of the output archive. + - Replace `` with the name of the model directory. For example: ``` - tar.exe -czvf C:\SPData\mymodel.tar.gz C:\SPData\my-model + tar.exe -czvf my-model.tar.gz my-model ``` Wait for the process to complete; it may take a few minutes. + Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive: + + ``` + tar.exe -tzvf + ``` + + - Replace `` with the name of the archive. + Alternatively, install a file archiver like [7-Zip](https://www.7-zip.org/) or similar to create a TAR.GZ archive using a graphical user interface instead of a command line. - On Linux, open a terminal and run the following command: + On Linux, open a terminal, navigate to the directory that contains the model directory, and run the following command: ``` - tar -czvf + tar -czvf ``` - Replace `` with the path and desired name of the output archive. Replace `` with the path to the directory with the model files. + - Replace `` with the path and desired name of the output archive. + - Replace `` with the name of the model directory. For example: ``` - tar -czvf mymodel.tar.gz ./my-model + tar -czvf mymodel.tar.gz my-model ``` Wait for the process to complete; it may take a few minutes. + + Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive: + + ``` + tar -tzvf + ``` + + - Replace `` with the name of the archive. - On macOS, open the Terminal and run the following command: + On macOS, open the Terminal, navigate to the directory that contains the model directory, and run the following command: ``` - tar --no-mac-metadata --no-xattrs -czvf + tar --no-mac-metadata --no-xattrs -czvf ``` - Replace `` with the path and desired name of the output archive. Replace `` with the path to the directory with the model files. + Replace `` with the path and desired name of the output archive. Replace `` with the name of the model directory. For example: ``` - tar --no-mac-metadata --no-xattrs -czvf mymodel.tar.gz ./my-model + tar --no-mac-metadata --no-xattrs -czvf mymodel.tar.gz my-model ``` Wait for the process to complete; it may take a few minutes. + + Ensure the model directory is at the root of the archive; otherwise, deployment may fail. Run the following command to view the contents of the archive: + + ``` + tar -tzvf + ``` + + - Replace `` with the name of the archive. @@ -168,7 +186,7 @@ In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the Fill out the form: -- **Content Name**: type the desired model name. It may be different from the file name. Providing a meaningful name makes it easier to find the model later. +- **Content Name**: type the desired model name. It may be different from the archive name. Providing a meaningful name makes it easier to find the model later. - **Category**: choose the model category from the drop-down menu. You can only choose one. - **Engine**: choose compatible engines from the drop-down menu. Select both available options. diff --git a/docs/marketplace/images/hf-gguf.png b/docs/marketplace/images/hf-gguf.png index cb1aa431..da45590c 100644 Binary files a/docs/marketplace/images/hf-gguf.png and b/docs/marketplace/images/hf-gguf.png differ diff --git a/docs/marketplace/images/hf-safetensors-consolidated.png b/docs/marketplace/images/hf-safetensors-consolidated.png index 6650ebcc..dac3e9f0 100644 Binary files a/docs/marketplace/images/hf-safetensors-consolidated.png and b/docs/marketplace/images/hf-safetensors-consolidated.png differ diff --git a/docs/marketplace/images/hf-safetensors-duplicates.png b/docs/marketplace/images/hf-safetensors-duplicates.png index 68a36490..be70171c 100644 Binary files a/docs/marketplace/images/hf-safetensors-duplicates.png and b/docs/marketplace/images/hf-safetensors-duplicates.png differ diff --git a/docs/marketplace/orders/order-builder/index.md b/docs/marketplace/orders/order-builder/index.md index a2bad0d7..dfb70361 100644 --- a/docs/marketplace/orders/order-builder/index.md +++ b/docs/marketplace/orders/order-builder/index.md @@ -96,7 +96,7 @@ The system automatically calculates a compute configuration that meets or exceed Clicking the machine's name opens its [**Offer**](/marketplace/marketplace/offer) window. - +Screenshot showing the queue status indicator for compute offers
Learn more about [requirements and configurations](/fundamentals/slots). diff --git a/docs/marketplace/orders/order/index.md b/docs/marketplace/orders/order/index.md index c64df64e..5d91db65 100644 --- a/docs/marketplace/orders/order/index.md +++ b/docs/marketplace/orders/order/index.md @@ -19,22 +19,28 @@ The contents of an order are encrypted and accessible only to the user who place - **Suspended**. The order is awaiting the creation of suborders. - **Blocked**. A suborder temporarily blocks the order to generate access keys and authorize the confidential computing device to access the suborder's content. -- **New**. The order is awaiting in the queue for the computing device to become available. -- **Processing**. The machine is executing the order inside a Trusted Execution Environment. -- **Deployed**. The model is deployed and running. -- **Done**. The computation is done, and the order result is available for download. For Deploy orders, it also means the model is no longer running. +- **In Queue**. The order is awaiting in the queue for the computing device to become available. +- **Processing**. The machine is executing the order inside a Trusted Execution Environment. + +Statuses specific for Deploy orders: + +- **Deployed**. The model is running and available via the **Access Link**. +- **Done**. The model is no longer running. + +Statuses specific for Fine-tune orders: + +- **Ready**. The new layer is available for download using the **Get Result** button. +- **Done**. The order result is no longer available for download. Additional possible statuses: -- **Cancelling**: the order is being canceled by the customer's request. +- **Canceling**: the order is being canceled by the customer's request. - **Canceled**: the order has been canceled successfully, and the remaining order deposit was transferred back to the customer's wallet. -- **Error**: the order was not completed successfully due to an error. To check the error message, download the order result by clicking the **Get Result** button. Read about the [most common errors and how to fix them](/marketplace/guides/troubleshooting). +- **Error**: the order was not completed successfully due to an error. To check the error message, download the order result by clicking the **Get Result** button. Read about the [most common errors and how to fix them](/marketplace/guides/troubleshooting#order-status-error). Learn more about [statuses](/fundamentals/orders#order-status). -**Lease Remaining** indicates the remaining time until the order is completed and gets the Done status. It is calculated by dividing the remaining order balance by the total cost of all the offers priced per hour. - -For Deploy orders, it is the duration the model will remain operational. For storage suborders, it is the duration the order result will remain available for download. +**Lease Remaining** indicates the remaining time until the order is completed and gets the Done status. It is calculated by dividing the remaining order balance by the total cost of all the offers priced per hour. For Deploy orders with the Deployed status, it is the duration the model will remain operational. ## Financials @@ -52,7 +58,7 @@ The **Deployment** section informs about the launched tunnel. Tunnels enable end - **Creating**: the tunnel order has been placed, but the tunnel or the model is not ready yet. The AI engine's web UI is not accessible. - **Online**: the tunnel is operational, and the model is running. End users may access the AI engine's web UI via the **Access Link**. -- **Offline**: the tunnel order is done, and the tunnel is no longer available. The AI engine's web UI is inaccessible, but the expired **Access Link** remains visible. +- **Offline**: the tunnel order is done, and the tunnel is no longer available. The model is inaccessible, but the expired **Access Link** remains visible. To get detailed information about the tunnel orders related to the main order, open the **Tunnels Orders** tab at the bottom of the screen. The **Tunnels** section and the **Tunnels Orders** tab only exist for orders that utilize tunnels and are only visible to the user who placed the order. @@ -62,7 +68,7 @@ Depending on the order status, different buttons are visible: - **Cancel Order** and **Extend Lease** for orders with the Suspended, Blocked, New, or Processing statuses. - **Get Result** for orders with the Done, Error, and Canceled statuses. -- No buttons for orders with the Cancelling status. +- No buttons for orders with the Canceling status. These buttons are only visible to the user who placed the order. diff --git a/docs/marketplace/release-history/index.md b/docs/marketplace/release-history/index.md new file mode 100644 index 00000000..9552459b --- /dev/null +++ b/docs/marketplace/release-history/index.md @@ -0,0 +1,25 @@ +--- +id: "release-history" +title: "Release History" +slug: "/release-history" +sidebar_position: 7 +--- + +Features coming up in the next phases: + +- Publishing offers on the Marketplace from the uploaded files. +- Fine-tuning—train new layers of the original models. +- Support for datasets. +- More models available on the Marketplace. +- More AI engines and model categories. +- A light UI theme. + +_November 21, 2024:_ + +**AI Marketplace Phase 2** + +- A demo account with AOuth2 login for a quick start. +- Support for Intel TDX and NVIDIA GPU confidential computing. +- Deploying AI models with confidential tunnels using a variety of AI engines and settings. +- Uploading your models to the Super Protocol cloud or personal Storj accounts. +- UI/UX redesign. \ No newline at end of file