Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

RCL Helper Tools

RCL is short for Ripple Consensus Ledger.

Quick Start for First Time Users

Go get rcl tools:

go get -u

Set up a temporary working directory:

mkdir -p /tmp/rcl-altnet
cd /tmp/rcl-altnet

Generate some test net XRP to play with:

curl -s -X POST | tee testnet-fund-account.json | python -m json.tool

Note the output of above includes...

    "address": "<ADDRESS>",
    "secret": "<SECRET>"

Copy <ADDRESS> and <SECRET> and replace into the following.

Configure rcl tools to use the altnet account:

echo -e "rippled=wss://" > altnet.cfg
echo -e "[<ADDRESS>]\n\tsecret=<SECRET>\n\tnickname=fund" >> altnet.cfg

(You've created a nickname fund for the testnet account with 10000 XRP.)

Inspect your account with rcl-account tool:

rcl-account show fund

Create a new Ripple address and master signing key with rcl-key tool:

rcl-key generate -nickname hot

The generated address (nickname hot) does not become an account on the test net until it is funded with enough XRP to meet the reserve requirement.

Construct a transaction to send the required XRP to the new address with the rcl-tx send subcommand:

rcl-tx -as fund send hot 100/XRP > /dev/null

Note that rcl-tx logs the transaction details, but it does not sign or submit the transaction. Rather, it pipes the transaction to stdout (/dev/null in above example).

Here's how to use a pipeline to construct the tranaction, and sign it, and save to a file, and submit it to the test net:

rcl-tx -as fund send hot 100/XRP | rcl-key sign | rcl-tx save | rcl-tx submit

You should see tesSUCCESS in the output from rcl-tx submit (after verbose log output).

Finally check that hot account has the balance XRP sent to it:

rcl-account show hot

install and configure

go get

Most commands require configuration, which is loaded from all *.cfg files in a directory. The default location for configuration files is the current working directory.

Here's an example, save to ./rcl.cfg:

# Replace this rippled URL with your own trusted rippled
# Replace with wss://, for the TEST NET

# This creates a nickname, `bitstamp-usd` for the Bitstamp issuing address.
# optional tag will be used when sending to this address, replace the example below wih your own!
	# Put your destination tag below. Remove the "#", which starts a comment.


# deposit XRP to binance

# deposit XRP to sfox

# Add nicknames for your own accounts...


In the directory of each command, go run *.go will build local files. For example, to run local code for the rcl-account command...

cd cmd/rcl-account
go run *.go show rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B
You can’t perform that action at this time.