Skip to content
Merged

Main #273

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/fundamentals/certification.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The SubRoot CAs, in turn, issue and sign certificates for [orders](/fundamentals

## Order certificates

The issuing of order certificates involves [Trusted Loader](/whitepaper/tee-provider/#trusted-loader-mechanism)—a mechanism developed to load and run applications within a TEE. Trusted Loader operates inside the Confidential VM that executes the order. This Confidential VM may be deployed within a CPU- or CPU/GPU-based TEE, such as Intel TDX, AMD SEV-SNP, NVIDIA GPU TEE, or other, making the whole system TEE-agnostic.
The issuing of order certificates involves [Trusted Loader](/whitepaper/tee-provider/#trusted-loader-mechanism)—a mechanism developed to load and run applications within a TEE. Trusted Loader operates inside the Confidential VM that executes the order. This Confidential VM may be deployed within a CPU-based or CPU/GPU-augmented TEE using technologies such as Intel TDX, AMD SEV-SNP, NVIDIA Confidential Computing, or others, making the system TEE-agnostic.

To receive an order certificate, the Trusted Loader sends a request to a SubRoot CA providing the quote and a public key. The SubRoot CA verifies the quote, issues the order certificate, and signs it with the provided public key.

Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/account/web2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 2

This window shows the settings of your [Web2 User account](/marketplace/account#web2-user-account).

<img src={require('../images/demo-account.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/web2-account.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: "all-orders"
title: "All Orders"
slug: "/orders/all-orders"
sidebar_position: 2
slug: "/all-orders"
sidebar_position: 6
---

This screens displays the full list of the orders you placed on Super Protocol. Read [How to Place an Order](/marketplace/guides/place-order) for step-by-step instructions.
This screens displays the full list of the orders you placed on Super Protocol.

<img src={require('../images/all-orders.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand All @@ -23,6 +23,6 @@ The table in the center of the screen provides essential information about your
- **Model**: the main model used in the order.
- **Datasets**: the main dataset used in the order. Note that there may be several datasets in the order.

Clicking an order opens its [**Order**](/marketplace/orders/order) screen with detailed information.
Clicking an order opens its [**Order**](/marketplace/all-orders/order) screen with detailed information.

The contents of all orders are encrypted and accessible only to the users who placed them. However, general information about orders is recorded on the blockchain and publicly visible due to the blockchain's transparent nature.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: "order"
title: "Order"
slug: "/orders/order"
sidebar_position: 3
slug: "/all-orders/order"
sidebar_position: 1
---

This screen provides detailed information about an order. Read about [Orders](/fundamentals/orders).
This screen provides detailed information about a particular order. Read about [Orders](/fundamentals/orders).

<img src={require('../../images/order.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/order.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand All @@ -27,11 +27,6 @@ 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:

- **Canceling**: the order is being canceled by the customer's request.
Expand Down Expand Up @@ -76,7 +71,7 @@ These buttons are only visible to the user who placed the order.

The **Cancel Order** button lets you cancel the order and transfer the remaining balance back to your wallet. Clicking the button initiates the cancellation process by creating a transaction that Web3 users should **Confirm** in MetaMask. If you **Reject** the transaction, the cancellation process will not proceed.

<img src={require('../../images/metamask-transaction.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/metamask-transaction.png').default} width="auto" height="auto" border="1"/>
<br/>

### Extend Lease
Expand All @@ -86,7 +81,7 @@ The **Extend Lease** button opens the **Extend Lease** window that allows you to
- For Fine-tune orders, it may be necessary to finish the computation.
- For Deploy orders, it increases the time the model will be running.

<img src={require('../../images/extend-lease.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/extend-lease.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand All @@ -105,7 +100,7 @@ The **Get Result** button allows you to download a file containing:

The **Providers** tab contains additional information about the order and its suborders.

<img src={require('../../images/order-providers.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/order-providers.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand All @@ -117,7 +112,7 @@ Read more about [order types](/fundamentals/orders).

The **Tunnel Orders** tab contains information about tunnel orders related to the main order. The tab is visible only for orders that utilize tunnels.

<img src={require('../../images/order-tunnels.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/order-tunnels.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand All @@ -135,7 +130,7 @@ The **Tunnel Orders** tab contains information about tunnel orders related to th

The **Events** tab contains information on what is happening with the order.

<img src={require('../../images/order-events.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/order-events.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand Down
54 changes: 54 additions & 0 deletions docs/marketplace/confidentiality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
id: "confidentiality"
title: "Check Confidentiality"
slug: "/confidentiality"
sidebar_position: 21
---

*Check Confidentiality* is a service that verifies the authenticity of a domain deployed on Super Protocol and ensures its content is running in a valid Trusted Execution Environment (TEE).

<img src={require('./images/check-confidentiality.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Super Protocol uses *SSL/TLS certificates* to encrypt the data exchange between the user's browser and the web server inside the Tunnel Client deployment. Besides, Super Protocol Certification Authorities issue certificates for every order—[*order certificates*](/fundamentals/certification).

The Check Confidentiality service performs the following:

- Validates the order certificate chain to ensure the order is being processed in a correct TEE.
- Validates the integrity of the [Tunnel Client](/fundamentals/tunnels) deployment.
- Checks if the solution is a Marketplace offer (for instance, a specific [engine](/marketplace/order-builder#engine)). Otherwise, you will see a warning "Deployed solution is not an offer" meaning the solution cannot be verified.

<img src={require('./images/check-confidentiality-not-offer.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

To view the service report, paste the domain URL, for example, **Access Link** available on the [**Order**](/marketplace/all-orders/order) screen of a deployed model.

## Validation

The Tunnel Client signs the fingerprint of the domain SSL/TLS certificate with the order certificate's private key. Then, it provides to the Check Confidentiality service:

- The SSL/TLS certificate fingerprint—the expected fingerprint.
- The fingerprint signature. A valid signature means the Tunnel Client has the private key to the order certificate.
- The order certificate chain to check that all the certificates in the chain have not expired or been revoked. A valid certificate chain means the order is being processed in a correct TEE.

## Fingerprint comparison

You can compare the certificate fingerprint with the expected fingerprint, preventing possible man-in-the-middle attacks.

The Check Confidentiality service displays the expected SSL/TLS certificate signature:

<img src={require('./images/check-confidentiality-fingerprint.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

To compare the expected SSL/TLS certificate signature with the domain SSL/TLS certificate signature, find the latter in your web browser:

<img src={require('./images/check-confidentiality-connection-1.png').default} width="auto" height="auto" border="1"/>
<br/>

<img src={require('./images/check-confidentiality-connection-2.png').default} width="auto" height="auto" border="1"/>
<br/>

<img src={require('./images/check-confidentiality-connection-3.png').default} width="auto" height="auto" border="1"/>
6 changes: 6 additions & 0 deletions docs/marketplace/extras/.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: "extras"
title: "Extras"
slug: "/extras"
sidebar_position: 20
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: "release-history"
title: "Release History"
slug: "/release-history"
sidebar_position: 7
sidebar_position: 22
---

Features coming up in the next phases:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "place-order"
title: "How to Place an Order"
title: "Place an Order"
slug: "/guides/place-order"
sidebar_position: 2
---
Expand All @@ -23,29 +23,23 @@ Select a model you want to deploy. You can add either a model from the Marketpla
<Tabs>
<TabItem value="marketplace" label="Marketplace" default>

To lease a model listed on the Marketplace, open the list of available **Models** and click the blue **[+]** button next to a model you want to add to the order.
To lease a model listed on the Marketplace, open the list of available **Models** and click the blue **Deploy** button next to a model you want to add to the order.

<img src={require('../images/marketplace-models-menu.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/deploy-models.png').default} width="auto" height="auto" border="1"/>

</TabItem>
<TabItem value="my-content" label="My Content">
<TabItem value="my-offers" label="My Content">

To add your own model, you must prepare and upload it first. Read [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) and [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) for step-by-step instructions.

When your model is uploaded, open **My Files** and click the blue **[+]** button next to a model to add it to the order.
When your model is uploaded, open **My Content** and click the blue **Deploy** button next to a model to add it to the order.

<img src={require('../images/my-files-menu.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/deploy-my-content.png').default} width="auto" height="auto" border="1"/>

</TabItem>
</Tabs>

Once you add a model, open the **Order Builder** by clicking **Order** in the top panel of the Marketplace web app.

<img src={require('../images/marketplace-order-builder.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

**Order Builder** is a tool to pick the order's components, configure them, calculate prices, and place orders. Read about the [Order Builder](/marketplace/orders/order-builder).
Once you add a model, you will be redirected to the **Order Builder**. There, you can modify the order's components, configure them, check the prices, and place the order. Read about the [Order Builder](/marketplace/order-builder).

## Step 2. Add an engine

Expand All @@ -62,7 +56,7 @@ Each engine exists in two variants:

Click the blue **[+]** button to add the engine to the order.

If a yellow warning icon appears, it indicates that the selected engine is [incompatible](/marketplace/orders/order-builder/compatibility) with the selected model. Select another engine.
If a yellow warning icon appears, it indicates that the selected engine is [incompatible](/marketplace/order-builder/compatibility) with the selected model. Select another engine.

Once you add an engine, you can open its configuration by pressing the **Settings** button. Only make changes if you are confident in what you are doing, as modifying these settings can cause the model to fail to deploy. For more information about the settings, refer to the documentation for [Text Generation Web UI](https://github.com/oobabooga/text-generation-webui/wiki) and [ComfyUI](https://docs.comfy.org/).

Expand Down Expand Up @@ -96,7 +90,7 @@ Set the desired **Lease Time**. During the testnet, it must be from two to four
<br/>
<br/>

Click the **Checkout** button. The system will check for [compatibility issues](/marketplace/orders/order-builder/compatibility) you need to fix. If there are no issues, the order will proceed to the next step.
Click the **Checkout** button. The system will check for [compatibility issues](/marketplace/order-builder/compatibility) you need to fix. If there are no issues, the order will proceed to the next step.

## Step 5. Confirm transactions

Expand Down Expand Up @@ -124,7 +118,7 @@ If the MetaMask browser extension does not open automatically, open it manually
<br/>
<br/>

Once the Deploy order is placed successfully, you will be redirected to its [**Order**](/marketplace/orders/order) screen.
Once the Deploy order is placed successfully, you will be redirected to its [**Order**](/marketplace/all-orders/order) screen.

## Step 6. Manage the order

Expand Down
12 changes: 5 additions & 7 deletions docs/marketplace/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ sidebar_position: 2

| **Guide** | **Description** |
| :- | :- |
| [How to Log In](/marketplace/guides/log-in) | Log in as a Web3 user and set up the account. |
| [How to Place an Order](/marketplace/guides/place-order) | Build and place an order using a model from **Marketplace** or **My Content**. |
| [How to Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. |
| [How to Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. |
| [How to Set Up Storage](/marketplace/guides/storage) | Set up your personal storage as a Web3 user. |
| [Troubleshooting](/marketplace/guides/troubleshooting) | Fix the most common issues. |
| How to Create an Offer | Register a provider and create an offer from an uploaded file. |
| [Log In as a Web3 user](/marketplace/guides/log-in) | Log in as a Web3 user and set up the account. |
| [Upload a Model (TGWUI)](/marketplace/guides/upload-tgwui) | Prepare and upload a model supported by Text Generation Web UI. |
| [Upload a Model (ComfyUI)](/marketplace/guides/upload-comfyui) | Prepare and upload a model supported by ComfyUI. |
| [Set Up Storage](/marketplace/guides/storage) | Set up your personal storage as a Web3 user. |
| [Troubleshooting](/marketplace/guides/troubleshooting) | Fix the most common issues. |
2 changes: 1 addition & 1 deletion docs/marketplace/guides/log-in.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "log-in"
title: "How to Log In (Web3)"
title: "Log In as a Web3 user"
slug: "/guides/log-in"
sidebar_position: 1
---
Expand Down
4 changes: 2 additions & 2 deletions docs/marketplace/guides/storage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "storage"
title: "How to Set Up Personal Storage"
title: "Set Up Personal Storage"
slug: "/guides/storage"
sidebar_position: 6
---
Expand Down Expand Up @@ -53,7 +53,7 @@ Select the **Your Storj account** radio button, fill in the fields, and click **
| S3 Access Key (Read) | Access Key with **Read** permission |
| S3 Secret Key (Read) | Secret Key with **Read** permissions |

<img src={require('../images/web3acc-storj.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/web3-storage.png').default} width="auto" height="auto" border="1"/>
<br/>

## Contact Super Protocol
Expand Down
2 changes: 2 additions & 0 deletions docs/marketplace/guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ If the **Enter Marketplace** button is stuck in the loading state, open the Meta

If MetaMask shows no requests, refresh the page and press the **Enter Marketplace** button again.

Some wallet extensions may interfere with login attempts. If you have other wallet extensions installed, temporarily switch them off and try to log in again.

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](https://discord.gg/superprotocol) for a quick update.
Expand Down
8 changes: 3 additions & 5 deletions docs/marketplace/guides/upload-comfyui.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "upload-comfyui"
title: "How to Upload a Model (ComfyUI)"
title: "Upload a Model (ComfyUI)"
slug: "/guides/upload-comfyui"
sidebar_position: 5
---
Expand Down Expand Up @@ -42,9 +42,7 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support

### Model size

The size of your model should not exceed 13 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 CPU-only machines without GPU support. If you plan on deploying on CPU, choose a smaller model.
Due to current [testnet limitations](/marketplace/limitations), the size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future.

## Step 2. Create a TAR.GZ archive

Expand Down Expand Up @@ -200,7 +198,7 @@ You can prepare your model manually or using Docker and a script provided by Sup

In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the **My Files** screen and press the **Upload File** button.

<img src={require('../images/my-files-upload.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/my-content-upload.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand Down
8 changes: 3 additions & 5 deletions docs/marketplace/guides/upload-tgwui.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "upload-tgwui"
title: "How to Upload a Model (TGWUI)"
title: "Upload a Model (TGWUI)"
slug: "/guides/upload-tgwui"
sidebar_position: 4
---
Expand Down Expand Up @@ -37,9 +37,7 @@ If your model is from Hugging Face, ensure its _task_ matches one of the support

### Model size

The size of your model should not exceed 13 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 CPU-only machines without GPU support. If you plan on deploying on CPU, choose a smaller model.
Due to current [testnet limitations](/marketplace/limitations), the size of your model should not exceed 13 GB; otherwise, deployment may fail. More machines with larger slots to support bigger models will be available in the future.

## Step 2. Select files

Expand Down Expand Up @@ -248,7 +246,7 @@ Ensure the model directory contains no hidden files and directories. Archive the

In the [Marketplace web app](https://marketplace.superprotocol.com/), go to the **My Files** screen and press the **Upload File** button.

<img src={require('../images/my-files-upload.png').default} width="auto" height="auto" border="1"/>
<img src={require('../images/my-content-upload.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

Expand Down
Binary file modified docs/marketplace/images/all-orders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/basurero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/check-confidentiality.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/confirm-transactions-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/marketplace/images/demo-account.png
Binary file not shown.
Binary file added docs/marketplace/images/deploy-models.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/deploy-my-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/edit-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/enter-marketplace-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/marketplace/images/marketplace-models-menu.png
Binary file not shown.
Binary file not shown.
Binary file modified docs/marketplace/images/marketplace-web3acc-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/marketplace-web3acc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/mas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/models-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/marketplace/images/models-tiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/my-content-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marketplace/images/my-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/marketplace/images/my-files-menu.png
Diff not rendered.
Binary file removed docs/marketplace/images/my-files-upload.png
Diff not rendered.
Binary file removed docs/marketplace/images/my-files.png
Diff not rendered.
Binary file modified docs/marketplace/images/offer-about.png
Binary file removed docs/marketplace/images/offer-added.png
Diff not rendered.
Binary file modified docs/marketplace/images/offer-pricing.png
Binary file removed docs/marketplace/images/order-builder-compute.png
Diff not rendered.
Binary file modified docs/marketplace/images/order-builder-engine-settings.png
Binary file removed docs/marketplace/images/order-builder-engine.png
Diff not rendered.
Binary file modified docs/marketplace/images/order-builder-footer.png
Binary file modified docs/marketplace/images/order-builder.png
Binary file modified docs/marketplace/images/upload-content-done.png
Binary file modified docs/marketplace/images/upload-content.png
Binary file added docs/marketplace/images/web2-account.png
Binary file modified docs/marketplace/images/web3-account.png
Binary file added docs/marketplace/images/web3-storage.png
Binary file removed docs/marketplace/images/web3acc-storj.png
Diff not rendered.
Loading
Loading