ripple

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

crypto package

data package

websockets package

Documentation

Index

• type AccountInfoRequest
• type AccountInfoResponse
• type Opt
• type Request
• type SubmitRequest
• type SubmitResponse
• type XRP
  • func NewXRP(opt Opt) XRP

Types

type AccountInfoRequest

type AccountInfoRequest struct {
	Account     string `json:"account"`
	Strict      bool   `json:"strict"`
	LedgerIndex string `json:"ledger_index"`
	Queue       bool   `json:"queue"`
}

type AccountInfoResponse

type AccountInfoResponse struct {
	Result struct {
		AccountData struct {
			Account           string `json:"Account"`
			Balance           string `json:"Balance"`
			Flags             int    `json:"Flags"`
			LedgerEntryType   string `json:"LedgerEntryType"`
			OwnerCount        int    `json:"OwnerCount"`
			PreviousTxnID     string `json:"PreviousTxnID"`
			PreviousTxnLgrSeq int    `json:"PreviousTxnLgrSeq"`
			RegularKey        string `json:"RegularKey"`
			Sequence          int    `json:"Sequence"`
			Index             string `json:"index"`
		} `json:"account_data"`
		LedgerCurrentIndex int `json:"ledger_current_index"`
		QueueData          struct {
			TxnCount int `json:"txn_count"`
		} `json:"queue_data"`
		Status    string `json:"status"`
		Validated bool   `json:"validated"`
	} `json:"result"`
}

type Opt

type Opt struct {
	Seed    *data.Seed
	KeyType data.KeyType
	ApiUrl  string
}

type Request

type Request struct {
	Method string        `json:"method"`
	Params []interface{} `json:"params"`
}

type SubmitRequest

type SubmitRequest struct {
	TxBlob string `json:"tx_blob"`
}

type SubmitResponse

type SubmitResponse struct {
}

type XRP

type XRP interface {
	Do(dst interface{}, method string, params ...interface{}) error

	AccountInfo(request AccountInfoRequest) (*AccountInfoResponse, error)
	Submit(request SubmitRequest) (*SubmitResponse, error)

	Sign(transaction data.Transaction, fee data.Value) error
}

func NewXRP

func NewXRP(opt Opt) XRP