Skip to content
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "collaboration"
title: "Two-party Collaboration"
slug: "/guides/collaboration"
slug: "/cli/guides/collaboration"
displayed_sidebar: null
unlisted: true
---
Expand Down Expand Up @@ -57,35 +57,35 @@ sequenceDiagram

**Preparation**

Alice builds a <a id="solution"><span className="dashed-underline">solution</span></a>—a Docker image containing her script ([1](/cli/guides/collaboration#alice-1-build-a-solution)). She uploads the solution using SPCTL ([2](/cli/guides/collaboration#alice-2-upload-the-solution)) and grants Bob access for verification ([3](/cli/guides/collaboration#alice-3-send-the-solution-to-bob)).
Alice builds a <a id="solution"><span className="dashed-underline">solution</span></a>—a Docker image containing her script ([1](/archive/cli/guides/collaboration#alice-1-build-a-solution)). She uploads the solution using SPCTL ([2](/archive/cli/guides/collaboration#alice-2-upload-the-solution)) and grants Bob access for verification ([3](/archive/cli/guides/collaboration#alice-3-send-the-solution-to-bob)).

Bob (or an independent auditor) downloads the solution ([4](/cli/guides/collaboration#bob-4-download-the-solution)) and verifies that it is safe to process his data ([5](/cli/guides/collaboration#bob-5-verify-the-solution)).
Bob (or an independent auditor) downloads the solution ([4](/archive/cli/guides/collaboration#bob-4-download-the-solution)) and verifies that it is safe to process his data ([5](/archive/cli/guides/collaboration#bob-5-verify-the-solution)).

Bob uploads his dataset to remote storage using SPCTL ([6](/cli/guides/collaboration#bob-6-upload-the-dataset)). The dataset is automatically encrypted during upload, and only Bob holds the key.
Bob uploads his dataset to remote storage using SPCTL ([6](/archive/cli/guides/collaboration#bob-6-upload-the-dataset)). The dataset is automatically encrypted during upload, and only Bob holds the key.

Bob creates an <a id="offer"><span className="dashed-underline">offer</span></a> on the Marketplace ([7](/cli/guides/collaboration#bob-7-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice.
Bob creates an <a id="offer"><span className="dashed-underline">offer</span></a> on the Marketplace ([7](/archive/cli/guides/collaboration#bob-7-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice.

**Execution**

Alice places an <a id="order"><span className="dashed-underline">order</span></a> on Super Protocol using her solution and Bob's offer ID ([8](/cli/guides/collaboration#alice-8-place-an-order)). The order remains **Blocked** by the data suborder.
Alice places an <a id="order"><span className="dashed-underline">order</span></a> on Super Protocol using her solution and Bob's offer ID ([8](/archive/cli/guides/collaboration#alice-8-place-an-order)). The order remains **Blocked** by the data suborder.

Bob manually approves the usage of his dataset for the image with a specific hash ([9](/cli/guides/collaboration#bob-9-complete-the-data-suborder)). If this hash matches the actual solution hash, the <a id="cvm"><span className="dashed-underline">CVM</span></a> begins to process the order. If the hashes do not match, the order will be terminated with an error.
Bob manually approves the usage of his dataset for the image with a specific hash ([9](/archive/cli/guides/collaboration#bob-9-complete-the-data-suborder)). If this hash matches the actual solution hash, the <a id="cvm"><span className="dashed-underline">CVM</span></a> begins to process the order. If the hashes do not match, the order will be terminated with an error.

Once the computation finishes, Alice can download the result ([10](/cli/guides/collaboration#alice-10-download-the-order-results)). All the data within the TEE (solution, dataset, order results, etc.) is automatically deleted.
Once the computation finishes, Alice can download the result ([10](/archive/cli/guides/collaboration#alice-10-download-the-order-results)). All the data within the TEE (solution, dataset, order results, etc.) is automatically deleted.

Both Alice and Bob can retrieve the order report ([11](/cli/guides/collaboration#alice-and-bob-11-get-the-order-report)) that confirms the authenticity of the entire trusted setup.
Both Alice and Bob can retrieve the order report ([11](/archive/cli/guides/collaboration#alice-and-bob-11-get-the-order-report)) that confirms the authenticity of the entire trusted setup.

## Prerequisites

**Alice**:

- [SPCTL](/cli)
- [SPCTL](/archive/cli)
- Docker

**Bob**:

- [SPCTL](/cli)
- [Provider Tools](/cli/guides/provider-tools)
- [SPCTL](/archive/cli)
- [Provider Tools](/archive/cli/guides/provider-tools)

## Preparation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "comfyui"
title: "Custom ComfyUI Workflow"
slug: "/guides/solutions/comfyui"
slug: "/cli/guides/solutions/comfyui"
sidebar_position: 4
---

Expand All @@ -12,7 +12,7 @@ This guide provides step-by-step instructions for preparing a **ComfyUI** workfl

:::note

Due to [testnet limitations](/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future.
Due to [testnet limitations](/archive/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future.

:::

Expand Down Expand Up @@ -93,7 +93,7 @@ You can prepare your model, workflow, and custom node files manually or using Do

- Replace `<MODEL_DIRECTORY>` with the name of the output directory.

The output directory is ready for [upload](/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol.
The output directory is ready for [upload](/archive/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol.

</TabItem>
<TabItem value="manually" label="Manually">
Expand Down Expand Up @@ -154,7 +154,7 @@ You can prepare your model, workflow, and custom node files manually or using Do
└── my-openjourney-workflow.json
```

The model directory is ready for [upload](/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol.
The model directory is ready for [upload](/archive/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol.

</TabItem>
</Tabs>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: "deploy-app-example"
title: "Example: Python script"
slug: "/guides/deploy-app/example"
slug: "/cli/guides/deploy-app/example"
sidebar_position: 1
---

This guide serves as an example to the more general [deployment guide](/cli/guides/deploy-app) and shows how to deploy a Python script on Super Protocol without modifying its code.
This guide serves as an example to the more general [deployment guide](/archive/cli/guides/deploy-app) and shows how to deploy a Python script on Super Protocol without modifying its code.

The [simple script](/files/usd_to_crypto.py) used here as an example calculates how much Bitcoin (BTC) and Ether (ETH) can be bought for given amount in US dollars:

Expand All @@ -19,7 +19,7 @@ In this deployment, the script will be the <a id="solution"><span className="das
## Prerequisites

- Docker
- [SPCTL](/cli)
- [SPCTL](/archive/cli)

### 0. Prepare the files

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "deploy-app"
title: "Deploy Your App"
slug: "/guides/deploy-app"
slug: "/cli/guides/deploy-app"
sidebar_position: 2
---

Expand All @@ -10,7 +10,7 @@ This quick guide provides instructions on deploying your own <a id="solution"><s
## Prerequisites

- Docker
- [SPCTL](/cli)
- [SPCTL](/archive/cli)

## 1. Prepare the solution

Expand All @@ -32,7 +32,7 @@ Always use absolute paths, such as `/sp/...`.

:::

Check the [example](/cli/guides/deploy-app/example) at the end of this guide.
Check the [example](/archive/cli/guides/deploy-app/example) at the end of this guide.

More Dockerfile examples can be found in the [Super-Protocol/solutions](https://github.com/Super-Protocol/solutions) GitHub repository.

Expand Down Expand Up @@ -62,7 +62,7 @@ docker save my-solution:latest | gzip > my-solution.tar.gz

### 1.4. Upload the archive

From your SPCTL directory, [upload](/cli/commands/files/upload) the archive with your solution:
From your SPCTL directory, [upload](/archive/cli/commands/files/upload) the archive with your solution:

```shell
./spctl files upload <ARCHIVE_PATH> \
Expand Down Expand Up @@ -98,7 +98,7 @@ tar -czvf my_data.tar.gz -C ./data .

### 2.2. Upload the archive

From your SPCTL directory, [upload](/cli/commands/files/upload) the archive with your data, just like you did with the solution:
From your SPCTL directory, [upload](/archive/cli/commands/files/upload) the archive with your data, just like you did with the solution:

```shell
./spctl files upload <ARCHIVE_PATH> \
Expand All @@ -116,7 +116,7 @@ For example:

## 3. Deploy

Place an order using the [`workflows create`](/cli/commands/workflows/create) command. For example:
Place an order using the [`workflows create`](/archive/cli/commands/workflows/create) command. For example:

```shell
./spctl workflows create \
Expand All @@ -142,7 +142,7 @@ For example:
./spctl orders get 256587
```

If the status is `Done` or `Error`, you can [download the order result](/cli/commands/orders/download-result):
If the status is `Done` or `Error`, you can [download the order result](/archive/cli/commands/orders/download-result):

```shell
./spctl orders download-result <ORDER_ID>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "fine-tune"
title: "Multi-Party Collaboration"
slug: "/guides/multi-party-collab"
slug: "/cli/guides/multi-party-collab"
sidebar_position: 7
---

Expand Down Expand Up @@ -41,11 +41,11 @@ sequenceDiagram
```
<br/>

Carol builds a <a id="solution"><span className="dashed-underline">solution</span></a>—a Docker image containing her training engine and script ([1](/cli/guides/multi-party-collab#carol-1-build-a-solution)). She uploads the solution using SPCTL ([2](/cli/guides/multi-party-collab#carol-2-upload-the-solution)) and grants Alice and Bob access for verification ([3](/cli/guides/multi-party-collab#carol-3-send-the-solution-to-alice-and-bob)).
Carol builds a <a id="solution"><span className="dashed-underline">solution</span></a>—a Docker image containing her training engine and script ([1](/archive/cli/guides/multi-party-collab#carol-1-build-a-solution)). She uploads the solution using SPCTL ([2](/archive/cli/guides/multi-party-collab#carol-2-upload-the-solution)) and grants Alice and Bob access for verification ([3](/archive/cli/guides/multi-party-collab#carol-3-send-the-solution-to-alice-and-bob)).

Alice and Bob download the solution ([4](/cli/guides/multi-party-collab#alice-and-bob-4-download-the-solution)) and verify that it is safe to process their <a id="data"><span className="dashed-underline">data</span></a> ([5](/cli/guides/multi-party-collab#alice-and-bob-5-verify-the-solution)).
Alice and Bob download the solution ([4](/archive/cli/guides/multi-party-collab#alice-and-bob-4-download-the-solution)) and verify that it is safe to process their <a id="data"><span className="dashed-underline">data</span></a> ([5](/archive/cli/guides/multi-party-collab#alice-and-bob-5-verify-the-solution)).

If Carol cannot share the code with Alice and Bob, and a third-party auditor is involved, the workflow will differ slightly. After uploading, Carol must also create a solution <a id="offer"><span className="dashed-underline">offer</span></a> on Super Protocol Marketplace (similar to Bob's [Step 8](/cli/guides/multi-party-collab#bob-8-create-an-offer)).
If Carol cannot share the code with Alice and Bob, and a third-party auditor is involved, the workflow will differ slightly. After uploading, Carol must also create a solution <a id="offer"><span className="dashed-underline">offer</span></a> on Super Protocol Marketplace (similar to Bob's [Step 8](/archive/cli/guides/multi-party-collab#bob-8-create-an-offer)).

**Prepare the data**:

Expand All @@ -64,9 +64,9 @@ sequenceDiagram
```
<br/>

Alice uploads her model ([6](/cli/guides/multi-party-collab#alice-6-upload-the-model)) and Bob uploads his dataset ([7](/cli/guides/multi-party-collab#bob-7-upload-the-dataset)) to remote storage using SPCTL. Files are automatically encrypted during upload, and only the uploader holds the key.
Alice uploads her model ([6](/archive/cli/guides/multi-party-collab#alice-6-upload-the-model)) and Bob uploads his dataset ([7](/archive/cli/guides/multi-party-collab#bob-7-upload-the-dataset)) to remote storage using SPCTL. Files are automatically encrypted during upload, and only the uploader holds the key.

Bob creates an offer on the Marketplace ([8](/cli/guides/multi-party-collab#bob-8-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice.
Bob creates an offer on the Marketplace ([8](/archive/cli/guides/multi-party-collab#bob-8-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice.

**Execute**:

Expand All @@ -92,28 +92,28 @@ sequenceDiagram
```
<br/>

Alice places an <a id="order"><span className="dashed-underline">order</span></a> on Super Protocol ([9](/cli/guides/multi-party-collab#alice-9-place-an-order)), adding the solution, her model, and Bob's offer. The order does not proceed automatically and remains `Blocked`.
Alice places an <a id="order"><span className="dashed-underline">order</span></a> on Super Protocol ([9](/archive/cli/guides/multi-party-collab#alice-9-place-an-order)), adding the solution, her model, and Bob's offer. The order does not proceed automatically and remains `Blocked`.

Bob manually approves the usage of his dataset for the image with a specific hash ([10](/cli/guides/multi-party-collab#bob-10-complete-the-data-suborder)). If this hash matches the actual solution hash, the <a id="cvm"><span className="dashed-underline">CVM</span></a> begins to process the order. If the hashes do not match, the order will be terminated with an error.
Bob manually approves the usage of his dataset for the image with a specific hash ([10](/archive/cli/guides/multi-party-collab#bob-10-complete-the-data-suborder)). If this hash matches the actual solution hash, the <a id="cvm"><span className="dashed-underline">CVM</span></a> begins to process the order. If the hashes do not match, the order will be terminated with an error.

When the order is complete, Alice downloads the result ([11](/cli/guides/multi-party-collab#alice-11-download-the-order-results)). All the data within the TEE (solution, AI model, dataset, order results, etc.) is automatically deleted.
When the order is complete, Alice downloads the result ([11](/archive/cli/guides/multi-party-collab#alice-11-download-the-order-results)). All the data within the TEE (solution, AI model, dataset, order results, etc.) is automatically deleted.

Both Alice and Bob can retrieve the order report ([12](/cli/guides/multi-party-collab#alice-and-bob-12-get-the-order-report)) that confirms the authenticity of the entire trusted setup.
Both Alice and Bob can retrieve the order report ([12](/archive/cli/guides/multi-party-collab#alice-and-bob-12-get-the-order-report)) that confirms the authenticity of the entire trusted setup.

## Prerequisites

**Alice**:

- [SPCTL](/cli)
- [SPCTL](/archive/cli)

**Bob**:

- [SPCTL](/cli)
- [Provider Tools](/cli/guides/provider-tools)
- [SPCTL](/archive/cli)
- [Provider Tools](/archive/cli/guides/provider-tools)

**Carol**:

- [SPCTL](/cli)
- [SPCTL](/archive/cli)
- Docker

## Prepare the solution
Expand All @@ -138,7 +138,7 @@ Always use absolute paths, such as `/sp/...`.

:::

You may either include the training scripts in the image or upload them separately using SPCTL. In this case, Alice will need to attach the uploaded scripts to the order as `--data` at [Step 9](/cli/guides/multi-party-collab#alice-9-place-an-order).
You may either include the training scripts in the image or upload them separately using SPCTL. In this case, Alice will need to attach the uploaded scripts to the order as `--data` at [Step 9](/archive/cli/guides/multi-party-collab#alice-9-place-an-order).

You can find several Dockerfile examples in the [Super-Protocol/solutions](https://github.com/Super-Protocol/solutions) GitHub repository.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "provider-tools"
title: "Provider Tools"
slug: "/guides/provider-tools"
slug: "/cli/guides/provider-tools"
sidebar_position: 1
---

Expand Down Expand Up @@ -132,13 +132,13 @@ Providers need another copy of SPCTL configured to manage their offers.

Save and close the file.

3. Generate a key for order result encryption using the [`workflows generate-key`](/cli/commands/workflows/generate-key) command. Open `config.json` again and set the generated key to `workflow.resultEncryption.key`. Save and close the file.
3. Generate a key for order result encryption using the [`workflows generate-key`](/archive/cli/commands/workflows/generate-key) command. Open `config.json` again and set the generated key to `workflow.resultEncryption.key`. Save and close the file.
</TabItem>
</Tabs>

### Set up Storj access (optional)

If you already [set up Storj access](/cli/#set-up-storj-access-optional) for your regular SPCTL, you may reuse the same credentials for your provider's SPCTL.
If you already [set up Storj access](/archive/cli/#set-up-storj-access-optional) for your regular SPCTL, you may reuse the same credentials for your provider's SPCTL.

If you skip this step, Super Protocol will automatically provide you with 20 GB of storage.

Expand Down
Loading
Loading