Skip to main content

A CLI that helps you set up an XRPL sidechain.

Project description

xrpl-sidechain-cli

Install

pip install xrpl-sidechain-cli

NOTE: if you're looking at the repo before it's published, this won't work. Instead, you'll do this:

git clone https://github.com/xpring-eng/sidechain-cli.git
cd sidechain-cli
# install poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
poetry install
poetry shell

Install rippled and the xbridge witness.

rippled: https://xrpl.org/install-rippled.html

witness: https://github.com/seelabs/xbridge_witness

Get started

export XCHAIN_CONFIG_DIR={filepath where you want your config files stored}
export RIPPLED_EXE={rippled exe filepath}
export WITNESSD_EXE={witnessd exe filepath}
./scripts/tutorial.sh

To stop the servers:

sidechain-cli server stop --all

Use Commands

sidechain-cli --help

Each subcommand also has a --help flag, to tell you what fields you'll need.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xrpl-sidechain-cli-1.0.0b4.tar.gz (33.2 kB view hashes)

Uploaded Source

Built Distribution

xrpl_sidechain_cli-1.0.0b4-py3-none-any.whl (48.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page