https://github.com/jcstein/light-nodes
npm & yarn packages for celestia light nodes
https://github.com/jcstein/light-nodes
Last synced: about 2 months ago
JSON representation
npm & yarn packages for celestia light nodes
- Host: GitHub
- URL: https://github.com/jcstein/light-nodes
- Owner: jcstein
- License: apache-2.0
- Created: 2023-08-25T19:57:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-19T23:23:51.000Z (over 1 year ago)
- Last Synced: 2024-10-29T08:02:24.384Z (7 months ago)
- Language: Shell
- Homepage: https://www.npmjs.com/package/light-nodes
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# light nodes
This package is designed for running light nodes on the Arabica devnet and Mocha testnet. It is currently in development, but can be used with the following versions:
- Mainnet: [v0.12.4](https://github.com/celestiaorg/celestia-node/releases/tag/v0.12.4)
- Arabica: [v0.12.4](https://github.com/celestiaorg/celestia-node/releases/tag/v0.12.4)
- Mocha: [v0.12.4](https://github.com/celestiaorg/celestia-node/releases/tag/v0.12.4)
It was built on macOS for macOS and Linux.
## Installation
You can install the package globally using the following command:
### Yarn
```bash
yarn global add light-nodes
```
#### Start a node on Mainnet with yarn
This installs the package, installs a Mainnet Beta light node, and runs it.
```bash
yarn global add light-nodes && mainnet && start
```
#### Start a node on Mocha with yarn
This installs the package, installs a Mocha testnet light node, and runs it.
```bash
yarn global add light-nodes && mocha && start-m
```
#### Start a node on Arabica with yarn
This installs the package, installs a Arabica devnet light node, and runs it.
```bash
yarn global add light-nodes && arabica && start-a
```
#### Uninstall with yarn
To _uninstall_, run:
```bash
yarn global remove light-nodes
```
### NPM
```bash
npm i -g light-nodes
```
#### Start a node on Mainnet with npm
This installs the package, installs an Mainnet light node, and runs it.
```bash
npm i -g light-nodes && mainnet && start
```
#### Start a light node on Arabica with npm
This installs the package, installs a Arabica light node, and runs it.
```bash
npm i -g add light-nodes && arabica && start-a
```
#### Start a light node on Mocha with npm
This installs the package, installs a Mocha light node, and runs it.
```bash
npm i -g add light-nodes && mocha && start-m
```
#### Uninstall with NPM
To _uninstall_, run:
```bash
npm uninstall -g light-nodes
```
## Usage
After installing the package, you can use the light nodes on Mainnet Beta, Arabica devnet,
and Mocha testnet. Here's a basic guide:
### Help
To show the help menu, use:
```bash
light-nodes-help
```
### Mainnet
To initialize a light node on the Mainnet Beta, use the `mainnet` command:
```bash
mainnet
```
Then start the node:
```bash
start
```
### Mocha
To initialize a light node on the Mocha devnet, use the `mocha` command:
```bash
mocha
```
Then start the node:
```bash
start-m
```
### Arabica
To initialize a light node on the Arabica devnet, use the `arabica` command:
```bash
arabica
```
Then start the node:
```bash
start-a
```
## Cleanup
To remove all files associated with light-nodes, use the `clean-light-nodes` command:
```bash
clean-light-nodes
```
This removes:
```bash
CELESTIA_BINARY="$HOME/go/bin/celestia"
CELESTIA_NODE="$HOME/celestia-node"
DATA_STORE_ARABICA="$HOME/.celestia-light-arabica-11"
DATA_STORE_MOCHA="$HOME/.celestia-light-mocha-4"
DATA_STORE_MAINNET="$HOME/.celestia-light"
```
To uninstall Golang, run this in your terminal:
```bash
rm -rf /usr/local/go
```
## Troubleshooting
### Linux
To upgrade your OS:
```bash
sudo apt update && sudo apt upgrade -y
```
If you do not have them already, download essential packages for downloading files, compiling, and building the node:
```bash
sudo apt install curl tar wget clang pkg-config libssl-dev jq build-essential git make ncdu -y
```