# README
xrpl go module
WARNING: this is unstable and the API is likely to change, use at your own risk
Initially this module/package is simply to support some admin tooling for running XRPL nodes and validating nodes.
# Functions
NewNode creates a new XRPL node representation.
NewPeerCommand creates a new "peers" command.
UnmarshalPeers is a convenience function to marshal a JSON peer list into a *PeerList.
# Variables
DefaultStabilityChecker is the packages own opintionated check function for use with a peers StableWith method.
MinVersion is another opinion but it can be set at runtime...
# Structs
Command is a rippled admin command.
Node is an XRPL proxy or validator node.
Peer defines a validator/stock peer node.
PeerCommand is a "peers" rpc admin command.
PeerList represents the output from the 'peers' admin commnad.
Toml is a representation of /.well-known/srp-ledger.toml.
TomlMetadata represents the [[METADATA]] entry.
TomlPrinciple represents an dentry in the [[PRINCIPLES]] toml list.
TomlServer represents an dentry in the [[SERVERS]] toml list.
TomlValidator represents an entry in the [[VALIDATORS]] toml list.
WsMessage encapsulates a websocket txt/binary message.
# Interfaces
RPCCommand defines commands that can be sent to the nodes.
StabilityChecker is the interface that a peer can consumer to check the stability of a peer against some custom rules.