Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifies git checkout steps. Cleans up grammar and formatting. #1

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Clarifies git checkout steps. Cleans up grammar and formatting. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
87 changes: 52 additions & 35 deletions nodes/lite-nodes/spin-up-a-lite-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
description: >-
Lite-nodes are a simplified node option that allow developers to perform
lightweight tasks on a local node. This page covers how to spin-up a lite node
on your local machine.
Lite-nodes are a simplified node option that allows developers to perform lightweight tasks on a local node. This page covers how to spin up a lite node on your local machine.
---

# Spin up a lite-node

In this guide, we’re going to use the [Lotus](../implementations/lotus.md) Filecoin implementation. We’ll show how to install a lite-node on MacOS and Ubuntu. For other Linux distributions, check out the [Lotus documentation](https://lotus.filecoin.io/lotus/install/linux/#building-from-source). To run a lite-node on Windows, install [WLS with Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#1-overview) on your system and follow the _Ubuntu_ instructions below.
In this guide, we will use the [Lotus](../implementations/lotus.md) Filecoin implementation to install a lite-node on MacOS and Ubuntu. For other Linux distributions, check out the [Lotus documentation](https://lotus.filecoin.io/lotus/install/linux/#building-from-source). To run a lite-node on Windows, install [WLS with Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#1-overview) on your system and follow the _Ubuntu_ instructions below.

## Prerequisites

Lite-nodes have relatively lightweight hardware requirements – it’s possible to run a lite-node on a Raspberry Pi 4. Your machine should meet the following hardware requirements:
Lite-nodes have relatively lightweight hardware requirements. Your machine should meet the following hardware requirements:

1. At least 2 GiB of RAM
2. A dual-core CPU.
3. At least 4 GiB of storage space.

To build the lite-node, you’ll need some specific software. Run the following command to install the software prerequisites:

Expand All @@ -23,30 +22,30 @@ To build the lite-node, you’ll need some specific software. Run the following
1. Ensure you have [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh/) installed.
2. Install the following dependencies:

```sh
```shell
brew install go jq pkg-config hwloc coreutils rust
```

{% endtab %}
{% tab title="Ubuntu" %}
1. Install the following dependencies:

```sh
```shell
sudo apt update -y
sudo apt install mesa-opencl-icd ocl-icd-opencl-dev gcc git jq pkg-config curl clang build-essential hwloc libhwloc-dev wget -y
```

2. [Install Go](https://go.dev/doc/install) and add `/usr/local/go/bin` to your `$PATH` variable:

```sh
```shell
wget https://go.dev/dl/go1.21.7.linux-amd64.tar.gz
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.21.7.linux-amd64.tar.gz
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc && source ~/.bashrc
```

3. [Install Rust](https://www.rust-lang.org/tools/install), choose the standard installation option, and source the `~/.cargo/env` config file:

```sh
```shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
```
Expand All @@ -56,52 +55,64 @@ To build the lite-node, you’ll need some specific software. Run the following

## Pre-build

Before we can build the Lotus binaries, there’s some setup we need to do. MacOS users should select their CPU architecture from the tabs:
Before we can build the Lotus binaries, we need to follow a few pre-build steps. MacOS users should select their CPU architecture from the tabs:

{% tabs %}
{% tab title="MacOS Intel" %}
1. Clone the repository, and move into the `lotus` directory:
1. Clone the repository and move into the `lotus` directory:

```sh
```shell
git clone https://github.com/filecoin-project/lotus.git
cd lotus/
```

2. Checkout the latest release branch. First retrieve the latest release version:
2. Retrieve the latest Lotus release version:

```sh
```shell
git tag -l 'v*' | grep -v '-' | sort -V -r | head -n 1
```

Using the value returned from the previous command, i.e. v1.29.0, and checkout that branch:
This should output something like:

```sh
```output
v1.29.0
```

3. Using the value returned from the previous command, checkout to the latest release branch:

```shell
git checkout v1.29.0
```

3. Done! You can move on to the [Build](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node/#build-the-binary) section.
4. Done! You can move on to the [Build](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node/#build-the-binary) section.
{% endtab %}
{% tab title="MacOS ARM" %}
1. Clone the repository, and move into the `lotus` directory:
1. Clone the repository and move into the `lotus` directory:

```sh
```shell
git clone https://github.com/filecoin-project/lotus.git
cd lotus
```

2. Checkout the latest release branch. First retrieve the latest release version:
2. Retrieve the latest Lotus release version:

```sh
```shell
git tag -l 'v*' | grep -v '-' | sort -V -r | head -n 1
```

Using the value returned from the previous command, i.e. v1.29.0, and checkout that branch:
This should output something like:

```output
v1.29.0
```

3. Using the value returned from the previous command, checkout to the latest release branch:

```sh
```shell
git checkout v1.29.0
```

3. Create the necessary environment variables to allow Lotus to run on M1 architecture:
4. Create the necessary environment variables to allow Lotus to run on M1 architecture:

```bash
export LIBRARY_PATH=/opt/homebrew/lib
Expand All @@ -112,28 +123,34 @@ Before we can build the Lotus binaries, there’s some setup we need to do. MacO
4. Done! You can move on to the [Build](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node/#build-the-binary) section.
{% endtab %}
{% tab title="Ubuntu" %}
1. Clone the repository, and move into the `lotus` directory:
1. Clone the repository and move into the `lotus` directory:

```sh
```shell
git clone https://github.com/filecoin-project/lotus.git
cd lotus
```

2. Checkout the latest release branch. First retrieve the latest release version:
2. Retrieve the latest Lotus release version:

```sh
```shell
git tag -l 'v*' | grep -v '-' | sort -V -r | head -n 1
```

Using the value returned from the previous command, i.e. v1.29.0, and checkout that branch:
This should output something like:

```output
v1.29.0
```

3. Using the value returned from the previous command, checkout to the latest release branch:

```sh
```shell
git checkout v1.29.0
```

3. If your processor was released later than an AMD Zen or Intel Ice Lake CPU, enable the use of SHA extensions by adding these two environment variables. If in doubt, ignore this command and move on to [the next section](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node/#build-the-binary).
4. If your processor was released later than an AMD Zen or Intel Ice Lake CPU, enable SHA extensions by adding these two environment variables. If in doubt, ignore this command and move on to [the next section](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node/#build-the-binary).

```sh
```shell
export RUSTFLAGS="-C target-cpu=native -g"
export FFI_BUILD_FROM_SOURCE=1
```
Expand Down Expand Up @@ -245,7 +262,7 @@ Let's start the lite-node by connecting to a remote full-node. We can use the pu

## Expose the API

To send JSON-RPC requests to our lite-node we need to expose the API.
To send JSON-RPC requests to our lite-node, we need to expose the API.

{% tabs %}
{% tab title="Mainnet" %}
Expand Down Expand Up @@ -301,7 +318,7 @@ To send JSON-RPC requests to our lite-node we need to expose the API.
```

2. Open the terminal window where your lite-node is running and press `CTRL` + `c` to close the daemon.
3. In the same window restart the lite-node:
3. In the same window, restart the lite-node:

```shell
FULLNODE_API_INFO=wss://wss.calibration.node.glif.io/apigw/lotus lotus daemon --lite
Expand Down Expand Up @@ -390,7 +407,7 @@ Let's run a couple of commands to see if the JSON-RPC API is set up correctly.

The result field is the public key for our address. The private key is stored within our lite-node.

3. Set the new address as the default wallet for our lite-node, reminder to replace the Bearer token with our auth key `eyJhbGc...` and the `"params"` value with the wallet address, `f1vuc4...`, returned from the previous command:
3. Set the new address as the default wallet for our lite-node. Remember to replace the Bearer token with our auth key `eyJhbGc...` and the `"params"` value with the wallet address, `f1vuc4...`, returned from the previous command:

```shell
curl -X POST '127.0.0.1:1234/rpc/v0' \
Expand Down