search
BasicsStorage providersNodesNetworksSmart contractsReference
githubEdit

Spin up a lite-node

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.

In this guide, we will use the Lotus Filecoin implementation to install a lite-node on MacOS and Ubuntu. For other Linux distributions, check out the Lotus documentationarrow-up-right. To run a lite-node on Windows, install WSL with Ubuntuarrow-up-right on your system and follow the Ubuntu instructions below.

hashtag
Prerequisites

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:

  1. Ensure you have XCodearrow-up-right and Homebrewarrow-up-right installed.

  2. Install the following dependencies:

    brew install go jq pkg-config hwloc coreutils rust

hashtag
Pre-build

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:

  1. Clone the repository and move into the lotus directory:

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

  2. Retrieve the latest Lotus release version:

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

    This should output something like:

    v1.34.1

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

    git checkout v1.34.1

  4. Done! You can move on to the Buildarrow-up-right section.

hashtag
Build the binary

The last thing we need to do to get our node setup is to build the package. The command you need to run depends on which network you want to connect to:

  1. Remove or delete any existing Lotus configuration files on your system:

  2. Make the Lotus binaries and install them:

  3. Once the installation finishes, query the Lotus version to ensure everything is installed successfully and for the correct network:

    This will output something like:

hashtag
Start the node

Let's start the lite-node by connecting to a remote full-node. We can use the public full-nodes from glif.ioarrow-up-right:

  1. Create an environment variable called FULLNODE_API_INFO and set it to the WebSockets address of the node you want to connect to. At the same time, start the Lotus daemon with the --lite tag:

    This will output something like:

  2. The Lotus daemon will continue to run in this terminal window. All subsequent commands we use should be done in a separate terminal window.

hashtag
Expose the API

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

  1. Open ~/.lotus/config.toml and uncomment ListenAddress on line 6:

  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:

    This will output something like:

  4. The Lotus daemon will continue to run in this terminal window. All subsequent commands we use should be done in a separate terminal window.

The lite-node is now set up to accept local JSON-RPC requests! However, we don't have an authorization key, so we won't have access to privileged JSON-RPC methods.

hashtag
Create a key

To access privileged JSON-RPC methods, like creating a new wallet, we need to supply an authentication key with our Curl requests.

  1. Create a new admin token and set the result to a new LOTUS_ADMIN_KEY environment variable:

    This will output something like:

  2. Keep this key handy. We're going to use it in the next section.

hashtag
Send requests

Let's run a couple of commands to see if the JSON-RPC API is set up correctly.

  1. First, let's grab the head of the Filecoin network chain:

    This will output something like:

  2. Next, let's try to create a new wallet. Since this is a privileged method, we need to supply our auth key eyJhbGc...:

    This will output something like:

    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. 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:

    This will output something like:

hashtag
Next steps

You should now have a local lite-node connected to a remote full-node with an admin API key! You can use this setup to continue playing around with the JSON-RPC, or start building your applications on Filecoin!

Was this page helpful?arrow-up-right

PreviousLite-nodesNextFundamentals

Last updated