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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file xrpl-sidechain-cli-1.0.0b4.tar.gz.

File metadata

  • Download URL: xrpl-sidechain-cli-1.0.0b4.tar.gz
  • Upload date:
  • Size: 33.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.1 Darwin/21.6.0

File hashes

Hashes for xrpl-sidechain-cli-1.0.0b4.tar.gz
Algorithm Hash digest
SHA256 3079b117df8febb2295364307b6aadc9da5e172b90e786cdd5593a79393f7149
MD5 c1fd8a621d591f18a7dedff8a41995ea
BLAKE2b-256 7eaaca4aa67bf5c121bbee1f476fc8eb52623929a2f7a9745047d3c19feffa68

See more details on using hashes here.

File details

Details for the file xrpl_sidechain_cli-1.0.0b4-py3-none-any.whl.

File metadata

File hashes

Hashes for xrpl_sidechain_cli-1.0.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 a0305d88bcc3f671a84e9ae5165de93bd5c0ccdf006cf45a32d9243a6440808a
MD5 f9d7a4c910270c8298dbcbc9e83e09e2
BLAKE2b-256 6b42a7d4e0b7a48cabfa40110b1781d608833f92a59eec3065ec14781f13f4b6

See more details on using hashes here.

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