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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/commands/files/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 3

This command group contains commands to manage files in third-party storage such as Storj.

Most of these commands require a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj) section to create a bucket and access grants and set up SPCTL.
Most of these commands require a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj-access) section to create a bucket and access grants and set up SPCTL.

## Commands

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/files/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The primary purpose of this command is to make the uploading files available for

Depending on the options, the command provides two ways to upload and store the files. Choose one that suits you better:

- **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.
- **Uploads to storage directly.** This requires a Storj account and SPCTL [configured](/cli#set-up-storj-access) 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 SPPI 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/commands/solutions/prepare) command. For data, it is an archive containing the dataset files.

Expand Down Expand Up @@ -74,7 +74,7 @@ The following command uploads the `content.tar.gz` file located in the SPCTL roo
./spctl files upload content.tar.gz
```

To execute this command successfully, you need a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj) section to create a bucket and access grants and set up SPCTL.
To execute this command successfully, you need a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj-access) section to create a bucket and access grants and set up SPCTL.

### Example 2. Upload by creating a storage order

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section contains the list of commands for the Super Protocol CLI tool SPCTL

| **Group** | **Description** |
| :- | :- |
| [tokens](/cli/commands/tokens) | Receive test TEE and POL test tokens; **testnet only**. |
| [tokens](/cli/commands/tokens) | Receive SPPI and BNB 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. |
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/add-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The offer slot JSON file must contain the following objects and strings:
- `usage`: object with terms and conditions of usage
+ `maxTimeMinutes`: minutes; `0` for no limit
+ `minTimeMinutes`: minutes; `0` for no limit
+ `price`: denominations of TEE token
+ `price`: denominations of SPPI token
+ `priceType`: `1` for fixed price, `0` for price per hour; learn more about [price types](/fundamentals/orders#cost-and-pricing)
- `option`: object with internet access configuration (only for value offers)
+ `bandwidth`: bits per second
Expand Down Expand Up @@ -84,7 +84,7 @@ Offer slot JSON file template with example values:

Note that some of the data is represented differently in the Marketplace GUI:
- `diskUsage` and `ram` values are converted to gibibytes (GiB) by the formula `initialValue / (1024 ^ 3)`
- `price` value is converted to TEE tokens by the formula `initialValue / (10 ^ 18)`
- `price` value is converted to SPPI tokens by the formula `initialValue / (10 ^ 18)`
- `bandwidth` value is converted to megabits per second (Mbps) by the formula `initialValue / (10 ^ 6)`
- `traffic` value is converted to gigabytes (GB) by the formula `initialValue / (10 ^ 9)`

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/orders/replenish-deposit.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).
| **Name** | **Description** |
| :- | :- |
| `<orderId>` | ID of the order. |
| `<tokenAmount>` | Amount of TEE tokens to deposit. |
| `<tokenAmount>` | Amount of SPPI tokens to deposit. |

## Option

Expand All @@ -35,7 +35,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

## Example

The following command adds 3 TEE tokens to the deposit of the order with ID 1312:
The following command adds 3 SPPI tokens to the deposit of the order with ID 1312:

```
./spctl orders replenish-deposit 1312 3
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/tokens/balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: "/commands/tokens/balance"
sidebar_label: "balance"
---

Displays the balance of TEE and POL tokens in your wallet.
Displays the balance of SPPI and BNB tokens in your wallet.

## Syntax

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/tokens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ sidebar_position: 1

---

This command group contains commands to manage test TEE and POL tokens.
This command group contains commands to manage SPPI and BNB tokens.

TEE tokens are necessary to pay for orders in Super Protocol. POL tokens are for processing transactions on Polygon blockchains.
SPPI tokens are necessary to pay for orders in Super Protocol. BNB tokens are necessary for processing transactions on the opBNB blockchain.

## Commands

| **Command** | **Description** |
| :- | :- |
| [tokens balance](/cli/commands/tokens/balance) | Gets the wallet balance. |
| [tokens request](/cli/commands/tokens/request) | Requests test tokens; **testnet only**. |
| [tokens request](/cli/commands/tokens/request) | Requests test tokens. |
8 changes: 4 additions & 4 deletions docs/cli/commands/tokens/request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: "/commands/tokens/request"
sidebar_label: "request"
---

Requests test TEE and POL tokens.
Requests SPPI and BNB tokens.

This command is only available during the Testnet. Be mindful of [Testnet limitations](/marketplace/limitations).

Expand All @@ -25,14 +25,14 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

| **Name** | **Description** |
| :- | :- |
| `--tee` | Request for Super Protocol TEE tokens. |
| `--matic` | Request for Polygon POL tokens. |
| `--tee` | Request for SPPI tokens. |
| `--matic` | Request for BNB tokens. |
| `--config <path>` | Path to the SPCTL configuration file. The default is `./config.json`. |
| `--help`, `-h` | Help for the command. |

## Example

The following command requests TEE tokens:
The following command requests SPPI tokens:

```
./spctl tokens request --tee
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/workflows/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).
| `--tee-slot-count <inc>` | Configuration slot increments—how many times the selected slot is applied. Use this option together with `--tee`. <br/><br/>If you do not use this option, the increments will be calculated automatically. |
| `--tee-options <optionId> [<optionId> ...]` | IDs of [configuration options](/fundamentals/slots#configuration) separated by spaces. Use `--tee-options` together with `--tee`. <br/><br/>If you do not use `--tee-options`, configuration options will be selected automatically. |
| `--tee-options-count <inc> [<inc> ...]` | Increments for each configuration option separated by spaces. Use `--tee-options-count` together with `--tee` and `--tee-options`. <br/><br/>If you do not use `--tee-options-count`, increments will be calculated automatically. |
| `--deposit <teeTokens>` | [Deposit](/fundamentals/orders#lease-deposit-and-balance) in TEE tokens. The default is the minimum required deposit. |
| `--deposit <teeTokens>` | [Deposit](/fundamentals/orders#lease-deposit-and-balance) in SPPI tokens. The default is the minimum required deposit. |
| `--min-rent-minutes <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>` | Path to the SPCTL configuration file. The default is `./config.json`. |
| `--help`, `-h` | Help for the command. |
2 changes: 1 addition & 1 deletion docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can also download and install SPCTL manually from the Super Protocol [GitHub

Execute the `./spctl setup` command to initiate the setup dialog. First, provide your Testnet Access Token and then your Testnet Private Key. You can find them in your Testnet invitation email.

Further, SPCTL asks if you have a Storj bucket with configured access grants. This step is optional. Select `No` if you do not have them yet. You can configure Storj and provide this information [later in this guide](/cli#set-up-storj) or skip this step entirely.
Further, SPCTL asks if you have a Storj bucket with configured access grants. This step is optional. Select `No` if you do not have them yet. You can configure Storj and provide this information [later in this guide](/cli#set-up-storj-access) or skip this step entirely.

After that, SPCTL creates `config.json` in the SPCTL root directory. If you need to update your account information, execute `./spctl setup` again or modify `config.json` manually in any text editor.

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/cli_guides/providers_offers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide explains how to register a _provider_ on Super Protocol and create _s

:::info Testnet limitations

As of Testnet 5, you can only create solution and data offers. The ability to create _storage_ and _compute offers_ will be available in future releases. Monetization is only possible with test TEE tokens until the project goes to Mainnet.
As of Testnet 5, you can only create solution and data offers. The ability to create _storage_ and _compute offers_ will be available in future releases. Monetization is only possible with SPPI tokens until the project goes to Mainnet.

:::

Expand Down Expand Up @@ -169,7 +169,7 @@ Offer providers need the following Super Protocol accounts:
- Three _provider accounts_:
+ _Authority account_: can change provider's records; the main provider account
+ _Action account_: executes actions on behalf of the authority account
+ _Token receiver account_: receives rewards in TEE tokens for providing offers on Super Protocol.
+ _Token receiver account_: receives rewards in SPPI tokens for providing offers on Super Protocol.

### Create accounts

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/deployment_guides/blockchain/oracles.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You will need:
- Polygon Testnet Wallet #1 - for deploying "x509 verifier" smart contract. Wallet needs to contain test POL tokens.
- Polygon Testnet Wallet #2 - for deploying Oracle smart contract. Wallet needs to contain test POL tokens.

You can create the wallets using MetaMask and follow [this guide](https://support.polygon.technology/support/solutions/articles/82000907114-how-to-add-amoy-network-in-your-wallet-) to add the Polygon Amoy Testnet network. Save their addresses and private keys, you will need them later in the guide. You can receive free test POL tokens [here](https://faucet.polygon.technology/).
You can create the wallets using MetaMask and follow [this guide](https://support.polygon.technology/support/solutions/articles/82000907114-how-to-add-amoy-network-in-your-wallet-) to add the Polygon Amoy Testnet network. Save their addresses and private keys, you will need them later in the guide.

We highly recommend that you create two different wallets on Polygon Testnet specifically for this guide. But if you are going to use a single wallet, please make sure that you do not use it for any other operations, as they might disrupt the Oracle.

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/deployment_guides/python/solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ After running the command, `solution.tar.gz` and `metadata.json` files are gener

## Upload the solution

Solution needs to be uploaded to decentralized storage before it may be executed in TEE. The storage credentials have been configured during the [SPCTL setup](/cli#set-up-storj).
Solution needs to be uploaded to decentralized storage before it may be executed in TEE. The storage credentials have been configured during the [SPCTL setup](/cli#set-up-storj-access).

Run the following command:

Expand Down
6 changes: 3 additions & 3 deletions docs/developers/deployment_guides/tunnels/manual_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/commands/tokens/request) command. Be mindful of testnet [limitations](/marketplace/limitations).
**Tip:** to create order make sure that you have sufficient amount of SPPI and BNB 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:

Expand Down Expand Up @@ -160,7 +160,7 @@ Record changes might take some time. Please contact your domain registrar for mo

After a few minutes, open your browser and go to your domain!

Don't forget to replenish the tunnel orders with TEE tokens if you want your site to stay up.
Don't forget to replenish the tunnel orders with SPPI tokens if you want your site to stay up.

## Create more tunnels

Expand Down Expand Up @@ -188,7 +188,7 @@ For example, repeat some of the previous steps to deploy another couple of tunne

### Limits

When creating an order in the example, the parameter `--min-rent-minutes` is set to 60. This means that the tunnel server and tunnel client will operate for 60 minutes. If needed, replace the minute value with the desired duration, but keep in mind that you may need more TEE tokens. Please refer to the testnet [limitations](/marketplace/limitations).
When creating an order in the example, the parameter `--min-rent-minutes` is set to 60. This means that the tunnel server and tunnel client will operate for 60 minutes. If needed, replace the minute value with the desired duration, but keep in mind that you may need more SPPI tokens. Please refer to the testnet [limitations](/marketplace/limitations).

### Deploying your own solutions

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/deployment_guides/tunnels/static_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This will result in `tunnel-server-data.tar.gz`.

### Upload archive

Solution needs to be encrypted and uploaded to decentralized storage before it may be executed in Super Protocol. The storage credentials will need to have been configured during the [SPCTL setup](/cli#set-up-storj):
Solution needs to be encrypted and uploaded to decentralized storage before it may be executed in Super Protocol. The storage credentials will need to have been configured during the [SPCTL setup](/cli#set-up-storj-access):

```
./spctl files upload tunnel-server-data.tar.gz --output tunnel-server-data.json --filename tunnel-server-data.tar.gz
Expand All @@ -44,7 +44,7 @@ This command will produce `tunnel-server-data.json`.

### Create a tunnel server order

You are now ready to start the Tunnel Server order. Note the parameter `--min-rent-minutes` which will deposit enough TEE tokens to ensure the tunnel is running for at least the specified period of time (in minutes). For this example we've set it to 60 minutes.
You are now ready to start the Tunnel Server order. Note the parameter `--min-rent-minutes` which will deposit enough SPPI tokens to ensure the tunnel is running for at least the specified period of time (in minutes). For this example we've set it to 60 minutes.

```
./spctl workflows create --tee 1 --solution 6,2 --solution 11,10 --data tunnel-server-data.json --storage 25,30 --min-rent-minutes 60
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/marketplace_gui/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ If everything is done correctly, you will see your account address and token bal

Super Protocol uses two types of tokens, and you will need both of them:

- POL tokens, to pay for Polygon blockchain transactions
- TEE tokens, to pay for offers and receive payments in Super Protocol.
- BNB tokens, to pay for opBNB blockchain transactions.
- SPPI tokens, to pay for offers and receive payments in Super Protocol.

To get tokens, use the buttons at the top of the page.

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/marketplace_gui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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/commands/offers) |
| Receive test TEE and POL tokens | [`tokens request`](/cli/commands/tokens/request) |
| Receive SPPI and BNB 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) |
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/marketplace_gui/walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Creating the tunnels takes about 20-30 minutes. You might need to refresh the pa

But while you wait, let's talk about the order. It consists of the main compute order (whose status is also the order status) as well as *sub-orders*, which are all the other offers, each with its own separate order related to the main order. The other offers are in status `Done` because they have transferred their content to the compute for execution and that's where their function ended. But - you might still be paying hourly to the providers of those offers.

A very important function is *Replenish Deposit*. Predictably, the order keeps working only as long as there is money (TEE) on the deposit. The deposit is being decreased every hour by the total *Price Per Hour* amount that you saw when creating the order. This includes charges by the compute, but also possibly by some other offers if they charge by the hour. When the deposit ends - the order stops. But you will be warned in advance when your deposit nearly depleted - you will see a very orange *Awaiting Payment* warning, which means that it's time to refill your deposit (if you want).
A very important function is *Replenish Deposit*. Predictably, the order keeps working only as long as there is money (SPPI tokens) on the deposit. The deposit is being decreased every hour by the total *Price Per Hour* amount that you saw when creating the order. This includes charges by the compute, but also possibly by some other offers if they charge by the hour. When the deposit ends - the order stops. But you will be warned in advance when your deposit nearly depleted - you will see a very orange *Awaiting Payment* warning, which means that it's time to refill your deposit (if you want).

<img src={require('../images/marketplace_15.png').default}/>

Expand Down
Loading
Loading