README
¶
XRPL-GO
The xrpl-go library provides a Go implementation for interacting with the XRP Ledger. From serialization to signing transactions, the library allows users to work with the most
complex elements of the XRP Ledger. A full library of models for all transactions and core server rippled API objects are provided.
Disclaimer
This library is still in development and not yet intended for production use.
Requirements
Requiring Go version 1.22.0 and later.
Download latest Go version
Packages
| Name | Description |
|---|---|
| addresscodec | Provides functions for encoding and decoding XRP Ledger addresses |
| binarycodec | Implements binary serialization and deserialization of XRP Ledger objects |
| keypairs | Handles generation and management of cryptographic key pairs for XRP Ledger accounts |
| xrpl | Core package containing the main functionality for interacting with the XRP Ledger |
| examples | Contains example code demonstrating usage of the xrpl-go library |
Report an issue
If you find any issues, please report them to the XRPL-GO GitHub repository.
License
The xrpl-go library is licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
Huge thanks to the btcsuite developers for creating this code, which we adapted for our use in compliance with the Copyfree Initiative.
|
Huge thanks to the btcsuite developers for creating this code, which we adapted for our use in compliance with the Copyfree Initiative. |
|
serdes/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
examples
|
|
|
autofill/rpc
command
|
|
|
autofill/ws
command
|
|
|
batch/rpc
command
|
|
|
batch/ws
command
|
|
|
checks/rpc
command
|
|
|
checks/ws
command
|
|
|
clawback/rpc
command
|
|
|
clawback/ws
command
|
|
|
credential/rpc
command
|
|
|
credential/ws
command
|
|
|
deep-freeze/rpc
command
|
|
|
deep-freeze/ws
command
|
|
|
delegate-set/rpc
command
|
|
|
delegate-set/ws
command
|
|
|
deposit-preauth/rpc
command
|
|
|
deposit-preauth/ws
command
|
|
|
faucet/rpc
command
|
|
|
faucet/ws
command
|
|
|
ledger/rpc
command
|
|
|
ledger/ws
command
|
|
|
mptoken/rpc
command
|
|
|
mptoken/ws
command
|
|
|
multisigning/rpc
command
|
|
|
multisigning/ws
command
|
|
|
nft/nft-accept/rpc
command
|
|
|
nft/nft-accept/ws
command
|
|
|
nft/nft-burn/rpc
command
|
|
|
nft/nft-burn/ws
command
|
|
|
nft/nft-cancel/rpc
command
|
|
|
nft/nft-cancel/ws
command
|
|
|
nft/nft-modify/rpc
command
|
|
|
nft/nft-modify/ws
command
|
|
|
partial-payment/rpc
command
|
|
|
partial-payment/ws
command
|
|
|
paths/rpc
command
|
|
|
paths/ws
command
|
|
|
queries/account-tx/rpc
command
|
|
|
queries/account-tx/ws
command
|
|
|
send-payment/rpc
command
|
|
|
send-payment/ws
command
|
|
|
send-xrp/rpc
command
|
|
|
send-xrp/ws
command
|
|
|
set-regular-key/rpc
command
|
|
|
set-regular-key/ws
command
|
|
|
subscription/ws
command
|
|
|
token-issuance/rpc
command
|
|
|
token-issuance/ws
command
|
|
|
use-tickets/rpc
command
|
|
|
use-tickets/ws
command
|
|
|
wallet
command
|
|
|
testutil
Package interfaces is a generated GoMock package.
|
Package interfaces is a generated GoMock package. |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.