Skip to content

Commit

Permalink
Add docs for babylon & pryzm validator testnet & subspace node (#156)
Browse files Browse the repository at this point in the history
* Update docs as per top level navigation

* Add docs for babylon validator testnet

* Add docs for Pryzm validator testnet & subspace node (#157)

* Add docs for subspace node (#160)
  • Loading branch information
aayushmahapatra authored Mar 22, 2024
1 parent 931a5df commit 6d3b750
Show file tree
Hide file tree
Showing 9 changed files with 342 additions and 1 deletion.
Binary file added assets/babylon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions assets/pryzm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions assets/subspace.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions components/marketplace.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ import CelestiaIcon from "../assets/celestia.svg";
import ElixirIcon from "../assets/elixir.png";
import FuelIcon from "../assets/fuel.png";
import LavaIcon from "../assets/lava.png";
import BabylonIcon from "../assets/babylon.png";
import PryzmIcon from "../assets/pryzm.svg";
import SubspaceIcon from "../assets/subspace.svg";
import styles from "../styles/framework.module.css";

const MARKETPLACE_APP_LIST = [
Expand Down Expand Up @@ -223,6 +226,24 @@ const MARKETPLACE_APP_LIST = [
alt: "lava",
title: "Deploy Lava Validator Testnet",
},
{
path: "/marketplace-guide/babylon",
logo: BabylonIcon,
alt: "babylon",
title: "Deploy Babylon Validator Testnet",
},
{
path: "/marketplace-guide/pryzm",
logo: PryzmIcon,
alt: "pryzm",
title: "Deploy Pryzm Validator Testnet",
},
{
path: "/marketplace-guide/subspace",
logo: SubspaceIcon,
alt: "subspace",
title: "Deploy Subspace Node",
},
];

const Marketplace = () => {
Expand Down
3 changes: 3 additions & 0 deletions pages.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ export const Pages = [
["Deploy Elixir Validator Node", "/marketplace-guide/elixir"],
["Deploy Fuel Node", "/marketplace-guide/fuel"],
["Deploy Lava Validator Testnet", "/marketplace-guide/lava"],
["Deploy Babylon Validator Testnet", "/marketplace-guide/babylon"],
["Deploy Pryzm Validator Testnet", "/marketplace-guide/pryzm"],
["Deploy Subspace Node", "/marketplace-guide/subspace"],
["Spheron SDK", "/sdk"],
["Storage SDK", "/sdk/storage"],
["Browser Upload SDK", "/sdk/browser"],
Expand Down
5 changes: 4 additions & 1 deletion pages/marketplace-guide/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,8 @@
"celestia-light": "Deploy Celestia Light Node",
"elixir": "Deploy Elixir Validator Node",
"fuel": "Deploy Fuel Node",
"lava": "Deploy Lava Validator Testnet"
"lava": "Deploy Lava Validator Testnet",
"babylon": "Deploy Babylon Validator Testnet",
"pryzm": "Deploy Pryzm Validator Testnet",
"subspace": "Deploy Subspace Node"
}
106 changes: 106 additions & 0 deletions pages/marketplace-guide/babylon.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import { Callout } from "nextra-theme-docs";
import Navigation from "components/navigation";
import VideoPlayer from "components/video-player";

# How to deploy an Babylon Validator Testnet?

<VideoPlayer embedId="WYxJFuAniuo" />

<Callout type="info">
**NOTE:** Spheron Compute offers the flexibility to create custom
configurations for your instance.
</Callout>

Spheron allows you to deploy a compute instance pre-installed with Babylon, all set up and ready to use on the Akash Network.
To deploy a Babylon validator testnet:

1. Click "New Cluster" on the top right corner.
2. Choose "Compute" to use CPU-based instances for running containers.
3. Choose your desired Compute Type option under **Compute Type**.
4. Select **Start from Marketplace App**.
5. Pick **Babylon Validator Testnet** from the marketplace.
6. Select your preferred **Region**, if any. If you do not add a region, the container will be deployed in **any** region for **Spot**, or in the **us-east** region for **On Demand**. [Click here](/compute/cluster/compute/#region) to know more.
7. Spheron will automatically select the recommended plan for the specific template. If you intend to move forward with the recommended plan, just Click "Deploy" to initiate deployment.
8. Select the instance plan that suits your needs. You can use the "Create Custom Plan" toggle to create custom plans for your CPU based instance.
9. Configure Storage (SSD) plan for your instance. Use the "Add Persistent Storage" toggle to add persistent storage for your instance.
10. Add your "Moniker" under **Template Configuration**.
11. Click "Deploy" to initiate deployment.

## Verify Installation

- The Babylon Validator Testnet can be accessed only after the Compute Instance is provisioned.
Thus, you need to wait for the installation to complete before you can start using it.
- As the node starts, the **Instance Logs** will display the output about the operations performed. You can refresh the logs by clicking the refresh icon.

### Create a New Key for Your Node

You can run the following command in **Shell**:

```sh
babylond keys add wallet
```

### Fund Your Wallet

1. Visit the `#faucet` channel on the official Babylon Discord server.
2. Request funds by sharing the address you created in the channel using the command:

```sh
!faucet <your-address>
```

3. Check your wallet balance using this command:

```sh
babylond q bank balances $(babylond keys show wallet -a)
```

Ensure you have received **1,100,000 ubbn**.

### Generate a BLS Key Pair

Wait for the funds to be credited, then run this command:

```sh
babylond create-bls-key $(babylond keys show wallet -a)
```

### Update Configurations

Run the following commands to update configuration:

```sh
> sed -i -e "s|^key-name *=.*|key-name = \"wallet\"|" $HOME/.babylond/config/app.toml
> sed -i -e "s|^timeout_commit *=.*|timeout_commit = \"10s\"|" $HOME/.babylond/config/config.toml
```

### Verify Network Synchronization

Check the synchronization status with:

```sh
babylond status | jq .SyncInfo
```

Proceed when **`catching_up`** turns to **`false`**.

### Register Your Validator

1. Use the following command to create your validator, replacing placeholders with your information:

```sh
babylond tx checkpointing create-validator --amount 1000000ubbn --pubkey $(babylond tendermint show-validator) --moniker "YOUR_MONIKER_NAME" --details "YOUR_DETAILS" --website "YOUR_WEBSITE_URL" --chain-id bbn-test-2 --commission-rate 0.05 --commission-max-rate 0.20 --commission-max-change-rate 0.01 --min-self-delegation 1 --from wallet --gas-adjustment 1.4 --gas auto --gas-prices 0.00001ubbn -y
```

2. Customize the command with your details: <br /> Replace **`your-moniker-name`**, **`your-details`**, **`your-website`**, and **`your-email`** with your own information.
3. Wait for 2-3 hours before checking your node in the inactive list at [Babylon validators list](https://babylon.explorers.guru/validators)

## Deploy Your Own

Deploy your own Babylon Validator Testnet with Spheron:

[![Deploy with Spheron](https://bafybeihxqi3jlv6cy2ogh6jjljinntisolbspxcrbgykyv6e5xyzujl3aa.ipfs.sphn.link/spheron-deploy.svg)](https://app.spheron.network/#/compute/marketplace?template=Babylon%20Validator%20Testnet&templateId=65bf6c0ac22c1ed319c2ad60)

For more information, refer to the [Babylon docs](https://docs.babylonchain.io/docs/introduction/overview).

<Navigation name="Deploy Babylon Validator Testnet" />
104 changes: 104 additions & 0 deletions pages/marketplace-guide/pryzm.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
import { Callout } from "nextra-theme-docs";
import Navigation from "components/navigation";
import VideoPlayer from "components/video-player";

# How to deploy an Pryzm Validator Testnet?

<VideoPlayer embedId="3yVCl8luZBQ" />

<Callout type="info">
**NOTE:** Spheron Compute offers the flexibility to create custom
configurations for your instance.
</Callout>

Spheron allows you to deploy a compute instance pre-installed with Pryzm, all set up and ready to use on the Akash Network.
To deploy a Pryzm validator testnet:

1. Click "New Cluster" on the top right corner.
2. Choose "Compute" to use CPU-based instances for running containers.
3. Choose your desired Compute Type option under **Compute Type**.
4. Select **Start from Marketplace App**.
5. Pick **Pryzm Validator Testnet** from the marketplace.
6. Select your preferred **Region**, if any. If you do not add a region, the container will be deployed in **any** region for **Spot**, or in the **us-east** region for **On Demand**. [Click here](/compute/cluster/compute/#region) to know more.
7. Spheron will automatically select the recommended plan for the specific template. If you intend to move forward with the recommended plan, just Click "Deploy" to initiate deployment.
8. Select the instance plan that suits your needs. You can use the "Create Custom Plan" toggle to create custom plans for your CPU based instance.
9. Configure Storage (SSD) plan for your instance. Use the "Add Persistent Storage" toggle to add persistent storage for your instance.
10. Add your "Moniker" under **Template Configuration**.
11. Click "Deploy" to initiate deployment.

## Verify Installation

- The Pryzm Validator Testnet can be accessed only after the Compute Instance is provisioned.
Thus, you need to wait for the installation to complete before you can start using it.
- As the node starts, the **Instance Logs** will display the output about the operations performed. You can refresh the logs by clicking the refresh icon.

### Prepare Your Environment

1. Before issuing any commands, initialize your environment by running:

```sh
. $HOME/.profile
```

2. If you encounter an error that says **`/bin/sh: 1: pryzmd: not found`**, run the same command again to fix it.

### Create or Recover Your Wallet

1. **To create a new wallet**

```sh
pryzmd keys add wallet
```

2. **To recover an existing wallet**

```sh
pryzmd keys add wallet --recover
```

Then, enter your mnemonic phrase when prompted.

### Fund Your Wallet

1. Visit the [faucet app](https://testnet.pryzm.zone/faucet) to request test tokens for your wallet.
2. Check your wallet balance using:

```sh
pryzmd q bank balances $(pryzmd keys show wallet -a)
```

Make sure you receive at least **2 upryzm** tokens.

3. If you don't see a balance, your node might still be syncing with the blockchain. Wait until the **`catching_up`** status is **`false`**.
4. Monitor your wallet on the Pryzm Explorer: Keep an eye on your transactions and balance by visiting [Pryzm Explorer](https://testnet.chainsco.pe/pryzm) and entering your wallet address. This step is crucial for ensuring that your wallet has been successfully funded and is correctly reflecting the transactions on the blockchain.

### Verify Network Synchronization

Check the synchronization status with:

```sh
pryzmd status | jq .SyncInfo
```

Proceed when **`catching_up`** turns to **`false`**.

### Register Your Validator

1. Use the following command to create your validator, replacing placeholders with your information:

```sh
pryzmd tx staking create-validator --amount 1000000upryzm --pubkey $(pryzmd tendermint show-validator) --moniker "your-moniker-name" --details "your-details" --website "your-website" --security-contact "your-email" --chain-id indigo-1 --commission-rate 0.05 --commission-max-rate 0.20 --commission-max-change-rate 0.01 --min-self-delegation 1 --from wallet --gas-adjustment 1.4 --gas auto --gas-prices 0.015upryzm -y
```

2. Customize the command with your details: <br /> Replace **`your-moniker-name`**, **`your-details`**, **`your-website`**, and **`your-email`** with your own information.
3. Wait a few minutes after executing this command, before checking your node on the [Pryzm validators list](https://testnet.chainsco.pe/pryzm/validators).

## Deploy Your Own

Deploy your own Pryzm Validator Testnet with Spheron:

[![Deploy with Spheron](https://bafybeihxqi3jlv6cy2ogh6jjljinntisolbspxcrbgykyv6e5xyzujl3aa.ipfs.sphn.link/spheron-deploy.svg)](https://app.spheron.network/#/compute/marketplace?template=Pryzm%20Validator%20Testnet&templateId=65cb8495652cae53edeea11c)

For more information, refer to the [Pryzm docs](https://docs.pryzm.zone/overview/maintain-guides/getting-started/building-pryzmd-docker).

<Navigation name="Deploy Pryzm Validator Testnet" />
82 changes: 82 additions & 0 deletions pages/marketplace-guide/subspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import { Callout } from "nextra-theme-docs";
import Navigation from "components/navigation";

# How to deploy an Subspace Node?

<Callout type="info">
**NOTE:** Spheron Compute offers the flexibility to create custom
configurations for your instance.
</Callout>

Spheron allows you to deploy a compute instance pre-installed with Subspace, all set up and ready to use on the Akash Network.
To deploy a Subspace node:

1. Click "New Cluster" on the top right corner.
2. Choose "Compute" to use CPU-based instances for running containers.
3. Choose your desired Compute Type option under **Compute Type**.
4. Select **Start from Marketplace App**.
5. Pick **Subspace Network** from the marketplace.
6. Select your preferred **Region**, if any. If you do not add a region, the container will be deployed in **any** region for **Spot**, or in the **us-east** region for **On Demand**. [Click here](/compute/cluster/compute/#region) to know more.
7. Select the "farmer" tab under **Personalize Your Compute Service** section.
8. Spheron will automatically select the recommended plan for the specific template. If you intend to move forward with the recommended plan, just Click "Deploy" to initiate deployment.
9. Select the instance plan that suits your needs. You can use the "Create Custom Plan" toggle to create custom plans for your CPU based instance.
10. Configure Storage (SSD) plan for your instance. Use the "Add Persistent Storage" toggle to add persistent storage for your instance.
11. Add your "wallet address" under Template Configuration.
12. Click "Deploy" to initiate deployment.

## Create a Sub Wallet

### Install Sub Wallet Chrome Extension

1. Go to the Chrome Web Store and search for "Sub Wallet - Polkadot Wallet Link". Or Download it from [Here](https://chromewebstore.google.com/detail/subwallet-polkadot-wallet/onhogfjeacnfoofkfgppdlbmlmnplgbn).
2. Click "Add to Chrome" and follow the prompts to install the extension.

### Create a Sub Wallet Account

1. Click on the Sub Wallet extension icon in your Chrome browser.
2. On the SubWallet page, Click "Create a new account".
3. Agree to the terms and conditions by clicking the checkbox and then Click "Continue".
4. Create a secure password for your account. Remember to save it securely as SubWallet cannot recover lost passwords. Copy or download the seed phrase provided.
5. Confirm that you have securely stored the seed phrase by clicking "I have kept it somewhere safe."

### Configure Subspace Gemini 3H Network

1. Click on the settings icon located in the upper right corner.
2. Navigate to the **Network** section and enable "Subspace Gemini 3H".

### Copy Wallet Address

1. Return to the main menu of the SubWallet extension.
2. Click "tSSC" and copy the wallet address.

## Verify Installation

- The Subspace Node can be accessed only after the Compute Instance is provisioned.
Thus, you need to wait for the installation to complete before you can start using it.
- The **Instance Logs** of the "Farmer Service" will display the output about the operations performed.
- You can also access the Subspace Plot Manager using the `Connection URL` provided by Spheron under **Port Policy Info for Port 8080** to verify if the plots are being created.

```
[farmer] Wed, 20 Mar 2024 14:28:22 GMT Single disk farm 0:
[farmer] Wed, 20 Mar 2024 14:28:22 GMT ID: 01HSE46Q16MJHYHYTH8XNDNWYR
[farmer] Wed, 20 Mar 2024 14:28:22 GMT Genesis hash: 0x0c121c75f4ef450f40619e1fca9d1e8e7fbabc42c895bc4790801e85d5a91c34
[farmer] Wed, 20 Mar 2024 14:28:22 GMT Public key: 0xe688bc7cf5f6fa972fec5ee7470f5e8048f3f0157bfe60c608dfce36018fc668
[farmer] Wed, 20 Mar 2024 14:28:22 GMT Allocated space: 93.1 GiB (100.0 GB)
[farmer] Wed, 20 Mar 2024 14:28:22 GMT Directory: /plots/plot1
[farmer] Wed, 20 Mar 2024 14:28:22 GMT INFO subspace_farmer::commands::farm: Collecting already plotted pieces (this will take some time)...
[farmer] Wed, 20 Mar 2024 14:38:16 GMT INFO subspace_farmer::farmer_cache: Piece cache sync 86.74% complete
[farmer] Wed, 20 Mar 2024 14:38:32 GMT INFO subspace_farmer::farmer_cache: Piece cache sync 92.94% complete
[farmer] Wed, 20 Mar 2024 14:38:50 GMT INFO subspace_farmer::farmer_cache: Piece cache sync 99.13% complete
[farmer] Wed, 20 Mar 2024 14:39:02 GMT INFO subspace_farmer::farmer_cache: Finished piece cache synchronization
[farmer] Wed, 20 Mar 2024 14:39:02 GMT INFO {disk_farm_index=0}: subspace_farmer::single_disk_farm::plotting: Plotting sector (0.00% complete) sector_index=0
```

## Deploy Your Own

Deploy your own Subspace Node with Spheron:

[![Deploy with Spheron](https://bafybeihxqi3jlv6cy2ogh6jjljinntisolbspxcrbgykyv6e5xyzujl3aa.ipfs.sphn.link/spheron-deploy.svg)](https://app.spheron.network/#/compute/marketplace?template=Subspace%20Network&templateId=65e7017265cfd941fd91495e)

For more information, refer to the [Subspace docs](https://docs.subspace.network/docs/farming-&-staking/).

<Navigation name="Deploy Subspace Node" />

0 comments on commit 6d3b750

Please sign in to comment.