Client toolkit for interacting with the XRP Ledger: HTTP/WebSocket client, wallet generation and signing, transaction construction and autofill, multisig/ticket support, subscriptions, typed ledger objects, order-book queries.
A Kotlin Multiplatform SDK for the XRP Ledger.
Other supported platforms: JS/Node.js, iOS, macOS, Linux (see Supported Platforms)
// build.gradle.kts
dependencies {
implementation(platform("io.github.agwab:xrpl4k-bom:0.1.0"))
implementation("io.github.agwab:xrpl4k-client") // HTTP + WebSocket client
implementation("io.github.agwab:xrpl4k-crypto") // Key generation & signing
}
dependencies {
implementation platform('io.github.agwab:xrpl4k-bom:0.1.0')
implementation 'io.github.agwab:xrpl4k-client'
implementation 'io.github.agwab:xrpl4k-crypto'
}
Connect to a network, generate a wallet, and send XRP in a few lines:
Use TransactionFlags constants to set bitmask flags on transactions. Combine multiple flags with or:
import org.xrpl.sdk.core.model.transaction.TransactionFlags
import org.xrpl.sdk.core.model.transaction.payment
val tx = payment {
account = wallet.address
destination = Address("rDest...")
amount = 25.xrp
flags = TransactionFlags.Payment.tfPartialPayment or
TransactionFlags.Payment.tfLimitQuality
}
When submitting on behalf of a multi-signed account, pass multisigSigners to autofill
so the fee is correctly multiplied by (1 + signerCount):
import org.xrpl.sdk.client.sugar.autofill
val unsigned = payment {
account = multisigAddress
destination = Address("rDest...")
amount = 5.xrp
}
// 3 signers -> fee = baseFee * 4
val filled = client.autofill(unsigned, multisigSigners = 3).getOrThrow()
Use a pre-created ticket instead of the account's next sequence number:
import org.xrpl.sdk.client.sugar.autofill
val filled = client.autofill(unsigned, ticketSequence = 42u).getOrThrow()
// filled.sequence == 0, filled.ticketSequence == 42
Subscribe to real-time events via WebSocket using Kotlin Flow:
import org.xrpl.sdk.client.subscription.subscribeToLedger
import org.xrpl.sdk.client.subscription.subscribeToAccount
// Stream ledger close events
client.subscribeToLedger().collect { event ->
println("Ledger ${event.ledgerIndex} closed with ${event.txnCount} txns")
}
// Stream events affecting a specific account
client.subscribeToAccount(Address("rAccount...")).collect { event ->
println("Tx ${event.hash}: ${event.engineResult}")
}
Query account-owned objects with type-safe filters and get parsed results:
import org.xrpl.sdk.client.rpc.accountObjects
import org.xrpl.sdk.client.rpc.AccountObjectType
import org.xrpl.sdk.client.model.TicketObject
val result = client.accountObjects(
account = wallet.address,
type = AccountObjectType.Ticket,
).getOrThrow()
// Objects are parsed into typed subtypes of LedgerObject
result.objects.filterIsInstance<TicketObject>().forEach { ticket ->
println("Ticket #${ticket.ticketSequence}")
}
Use CurrencySpec for type-safe order book queries instead of raw JSON:
import org.xrpl.sdk.core.model.amount.CurrencySpec
import org.xrpl.sdk.core.type.CurrencyCode
import org.xrpl.sdk.client.rpc.bookOffers
val usd = CurrencySpec.Issued(CurrencyCode("USD"), Address("rIssuer..."))
val offers = client.bookOffers(
takerGets = usd,
takerPays = CurrencySpec.Xrp,
limit = 10,
).getOrThrow()
offers.offers.forEach { offer ->
println("${offer.account}: ${offer.quality}")
}
See samples/ for 19 runnable examples covering every major SDK feature.
Contributions are welcome. Please open an issue before submitting a pull request for non-trivial changes.
./gradlew jvmTest apiCheck ktlintCheck passesmainMIT License — see LICENSE for details.
import org.xrpl.sdk.client.XrplClient
import org.xrpl.sdk.client.sugar.autofill
import org.xrpl.sdk.client.sugar.submitAndWait
import org.xrpl.sdk.core.Network
import org.xrpl.sdk.core.model.amount.xrp
import org.xrpl.sdk.core.model.transaction.payment
import org.xrpl.sdk.core.result.getOrThrow
import org.xrpl.sdk.core.type.Address
import org.xrpl.sdk.crypto.Wallet
suspend fun main() {
XrplClient { network = Network.Testnet }.use { client ->
// Generate a new wallet (or restore with Wallet.fromSeed("s..."))
val (wallet, seed) = Wallet.generate()
println("Address: ${wallet.address} Seed: $seed")
val tx = payment {
account = wallet.address
destination = Address("rDestinationAddressHere")
amount = 10.xrp
}
val result = client.submitAndWait(tx, wallet).getOrThrow()
println("Validated in ledger ${result.ledgerIndex}: ${result.engineResult}")
}
}
| Example | Description |
|---|
| Send XRP | Simplest XRP transfer — check balance, send, confirm |
| Trust Lines & IOU | trustSet + issued currency payments |
| DEX Trading | Place and cancel orders on the built-in DEX |
| Subscriptions | WebSocket Flow-based ledger/transaction streams |
| NFT Lifecycle | Mint, sell, buy, burn NFTs |
Surfaced from shared tags and platforms — no rankings paid for.