README
¶
ripple
Go packages to interact with the Ripple protocol.
The data, crypto, and websockets packages are very functional and quite well tested. Most websockets commands are implemented but not all.
The peers and ledger packages are the least polished packages currently, and they are very much unfinished (and the tests might be non-existent or non-functional), but better to get the code out in the open.
We've included command-line tools to show how to apply the library:
- listener: connects to rippled servers with the peering protocol and displays the traffic
- subscribe: tracks ledgers and transactions via websockets and explains each transaction's metadata
- tx: creates transactions, signs them, and submits them via websockets
- vanity: generates new ripple wallets in search of vanity addresses
The hope is one day that these packages might lay the foundations for an alternative implementation of the Ripple daemon. This is, however, a long way off!
Please bear in mind that this has been an exercise that has taken a lot of time, so if you want to help and are not a developer, bounties and thanks are more than welcome. Please see the AUTHORS file. If you'd like to chat about the code, have a look here:
Test Coverage
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config provides a simple way of signing submitting groups of transactions for the same account.
|
Package config provides a simple way of signing submitting groups of transactions for the same account. |
|
Package data aims to provides all the data types that are needed to build tools, clients and servers for use on the Ripple network.
|
Package data aims to provides all the data types that are needed to build tools, clients and servers for use on the Ripple network. |
|
Utiltities for formatting Ripple data in a terminal
|
Utiltities for formatting Ripple data in a terminal |
|
tools
|
|
|
explain
Tool to explain transactions either individually, in a ledger or belonging to an account.
|
Tool to explain transactions either individually, in a ledger or belonging to an account. |
|
vanity
Simple tool to find the seeds for ripple account ids which match a regular expression
|
Simple tool to find the seeds for ripple account ids which match a regular expression |