Skip to content

Commit c0ed74d

Browse files
author
Sean Katz
committed
Refactor all pages to reflect manual steps and not just scripts
1 parent cdaed2c commit c0ed74d

18 files changed

+505
-130
lines changed

‎docs/faq.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ sidebar_position: 1
88
This section is the same as the #FAQ channel in Discord. If you need further help hop on to our support channels there.
99
:::
1010

11+
12+
## Dictionary
13+
14+
#### Keyring
15+
The keyring holds the private/public keypairs used to interact with a node. For instance, a validator key needs to be set up before running the blockchain node, so that blocks can be correctly signed. The private key can be stored in different locations, called "backends", such as a file or the operating system's own key storage. ([learn more here](https://docs.cosmos.network/master/run-node/keyring.html))
16+
17+
1118
## Nodes, Validators and Providers
1219
### I have problems running the install scripts {#install-troubleshooting}
1320

@@ -26,4 +33,5 @@ Troubleshooting:
2633
```bash
2734
account lava@XYZ not found: key not found
2835
```
29-
1. Make sure your account is funded from Lava side before you try to stake as a validator
36+
1. Make sure your account is funded from Lava side before you try to stake as a validator
37+

‎docs/lava-blockchain-intro.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
# Lava Blockchain Reference
2-
This section will help you get to know the Lava Blockchain technical reference.
3-
4-
If you got here, it means you are a Lava Developer/Contributor, or just interested in learning lava flows.
1+
# Lava Blockchain
2+
This section will help you get to know the Lava Blockchain, run a node, join the network and contribute to it.

‎docs/lava-blockchain/account-wallet.mdx

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 10
3+
title: Account & Wallet
4+
slug: /wallet
5+
---
6+
7+
Lava uses Cosmos bank & account modules and enables you to use any standard Cosmos wallet.
8+
9+
## Keplr integration
10+
11+
<button class="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded-full">
12+
Button
13+
</button>

‎docs/lava-blockchain/faucet.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 10
3+
title: Faucet
4+
slug: /faucet
5+
---
6+
7+
Coming soon.

‎docs/lava-blockchain/join-mainnet.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
sidebar_position: 3
3+
slug: /join-mainnet
4+
---
5+
6+
# Join Mainnet?
7+
8+
:::danger
9+
Mainnet is not available yet (and neither is a mainnet LAVA token).
10+
:::

‎docs/lava-blockchain/join-testnet.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_position: 2
3+
slug: /join-testnet
4+
---
5+
6+
import RoadmapItem from '@site/src/components/RoadmapItem';
7+
8+
# Join Testnet
9+
10+
:::tip Joined Testnet? Be a validator!
11+
You are now running a Node in the Lava network 🎉🥳!
12+
13+
Congrats, happy to have you here 😻 Celebrate it with us on Discord.
14+
15+
When you're ready, start putting the node to use **as a validator**:
16+
[<RoadmapItem icon="🧑‍⚖️" title="Power as a Validator" description="Validate blocks, secure the network, earn rewards"/>](/validator-intro.md#stake)
17+
18+
:::

‎docs/lava-node-intro.md

+32-30
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
11
# Run a Node
2-
This section will help you prepare a server and set up your Lava node.
2+
This section will help you prepare a server & set up your Lava node.
33

4-
## Step 1 - Prepare a server
4+
First, make sure you read the hardware requirements below.
5+
6+
**Then, select your option for installing `lavad`:**
7+
1. [Use prebuilt](./lava-node/node-use-prebuilt.md) - **common for most users** ⭐️
8+
2. [Build source](./lava-node/node-build-source.md) - common for code contributors
9+
10+
<details>
11+
12+
<summary>Not sure how to choose?</summary>
13+
14+
:::note Powering Lava? 🌋
15+
- Want to [be a validator](/validator-intro.md)? Use option [1. prebuilt](./lava-node/node-use-prebuilt.md)
16+
- Want to [be a provider](/provider-intro.md)? Use option [1. prebuilt](./lava-node/node-use-prebuilt.md)
17+
:::
18+
19+
20+
:::note Accessing Web3 APIs? ⚡️
21+
- Need access fast? No need for a node, just use the [gateway](/access-apis/gateway-access.md).
22+
- Want full D-access (Decentralized access)? [coming soon](/access-apis/d-access.md).
23+
:::
24+
25+
:::note Open Source contributor?
26+
- Use option [2.Source](/lava-node/node-build-source.md)
27+
:::
28+
29+
</details>
30+
31+
## Node requirements
532

633
### Deployment options
734
- VPS instance (on any cloud provider) - recommended ⭐️
@@ -16,7 +43,7 @@ As the network grows, bandwidth, CPU, and memory requirements rise. Large hard d
1643

1744
Also, running on testnet and mainnet will feature different requirements.
1845

19-
**Recommended testnet**
46+
**Recommended for Testnet**
2047

2148
| Node Type | RAM | Storage | CPU
2249
| ----------- | --------------------- | ----------- | ---
@@ -33,7 +60,7 @@ Settings:
3360
</details>
3461

3562
### Operating system
36-
- For using the installer - you need to run **`Ubuntu` - `20`** or newer.
63+
- For using the prebuilt - you need to run **`Ubuntu` - `20`** or newer.
3764
- sudo permissions on your machine (e.g. can run `sudo hostname`)
3865

3966
:::info
@@ -51,30 +78,5 @@ Need to run a different OS? Let us know in Discord.
5178
- 22231 - provider port
5279
- 22241 - provider port
5380

54-
## Step 2 - Install
55-
56-
**There are 3 options to install a node:**
57-
1. [Use installer](/lava-node/node-use-installer.md) - **common for most users** ⭐️
58-
2. [Build source](/lava-node/node-build-source.md) - common for code contributors
59-
3. [Connect remote](/lava-node/node-connect-remote.md) - misc usages
60-
61-
<details>
62-
63-
<summary>Not sure how to choose?</summary>
64-
65-
:::note Powering Lava? 🌋
66-
- Want to [be a validator](/validator-intro.md)? Use option [1. Installer](/lava-node/node-use-installer.md)
67-
- Want to [be a provider](/provider-intro.md)? Use option [1. Installer](/lava-node/node-use-installer.md) or [3. Remote](/lava-node/node-connect-remote.md)
68-
:::
69-
81+
## Step 2 - Choose a setup & join the network
7082

71-
:::note Accessing Web3 APIs? ⚡️
72-
- Need access fast? No need for a node, just use the [gateway](/access-apis/gateway-access.md).
73-
- Want full D-access (Decentralized access)? [coming soon](/access-apis/d-access.md).
74-
:::
75-
76-
:::note Open Source contributor?
77-
- Use option [2.Build](/lava-node/node-build-source.md)
78-
:::
79-
80-
</details>

‎docs/lava-node/node-build-source.md

+38
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,42 @@ slug: /node-build-source
66
# Build source
77

88
:::info Coming Soon 🚧
9+
Source is not yet available publicly
910
:::
11+
12+
This page will explain how to install the `lavad` binary to your system from source
13+
14+
## Steps
15+
16+
### 1. Update system
17+
```
18+
sudo apt update
19+
```
20+
21+
```
22+
sudo apt upgrade --yes
23+
```
24+
25+
### 2. Install build requirements
26+
**Install make and gcc.**
27+
28+
```
29+
sudo apt install git build-essential ufw curl jq snapd --yes
30+
```
31+
32+
**Install go:**
33+
```
34+
wget -q -O - https://git.io/vQhTU | bash -s -- --version 1.18.1
35+
```
36+
37+
After installed, open new terminal to properly load go
38+
39+
### 3. Install `lavad` binary
40+
41+
```
42+
cd $HOME
43+
git clone https://github.com/lava/lava
44+
cd lava
45+
git checkout main
46+
make install
47+
```

‎docs/lava-node/node-connect-remote.md

-9
This file was deleted.

‎docs/lava-node/node-use-installer.md

-51
This file was deleted.

‎docs/lava-node/node-use-prebuilt.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_position: 1
3+
title: Use prebuilt
4+
slug: /node-use-prebuilt
5+
---
6+
7+
# Use prebuilt `lavad`
8+
9+
:::warning
10+
WIP
11+
:::
12+
13+
Download the latest version from the release page:
14+
```
15+
curl -s --user-agent "$s3_creds_user" --referer "$s3_creds_pass" "$binary_url" >$temp_dir/lavad
16+
17+
```

0 commit comments

Comments
 (0)