Start Building with Example Code

Code Samples

Browse sample code for building common use cases on the XRP Ledger

Introductory Code Samples

Connect to the XRP Ledger and query it for data.

Quickstart Samples

Create a test harness for XRPL features using JavaScript or Python.

Account Configurator

Create accounts on Testnet or Devnet and try different configuration settings. You can also get account configuration settings for live accounts on Mainnet.

Address Encoding

Encode XRP Ledger addresses in base58. (This reference implementation is equivalent to the ones included in most client libraries.)

AMM CLOB Demo

Simulate how offers interact with each other and AMMs on the XRPL DEX.

Assign a Regular Key Pair

Generate a regular key pair and associate it with your account.

Batch

Code samples showing how to create and submit a Batch transaction .

Build a Browser Wallet

Implement a non-custodial wallet application that runs in a web browser and can check an account's balances, send XRP, and notify when the account receives incoming transactions.

Build a Wallet

Implement a non-custodial wallet application that runs on a desktop and can check an account's balances, send XRP, and notify when the account receives incoming transactions.

Calculate Reserves

Look up and calculate an account's reserve requirements.

Clawback

Create, configure, and execute a Clawback transaction to reclaim issued tokens from a trust line on the XRPL.

Confidential Transfers

Issue a Multi-Purpose Token (MPT) that supports confidential transfers, send confidential payments between holders, and claw back a holder's confidential balance.

Create AMM

Code samples for the Create an Automated Market Maker tutorial , showing how to make set up a new AMM.

Create and Claim a Payment Channel

Create, claim and verify a Payment Channel.

Create, Update, and Delete Decentralized Identifiers (DIDs)

Create, update, and delete decentralized identifiers (DIDs). A Decentralized Identifier (DID) is a new type of identifier defined by the World Wide Web Consortium (W3C) that enables verifiable, digital identities.

Create, Update, and Delete Price Oracles

Create, update, and delete Price Oracles. A price oracle is a mechanism that feeds external data, such as asset prices, and exchange rates, onto the XRPLedger.

Credential

Create, accept, and delete a credential on the XRPL using dedicated transactions between issuer and subject wallets.

Credential Issuing Service

This sample code shows how to issue credentials to XRPL users using a basic API service.

Cryptographic Key Derivation

Derive secp256k1 or Ed25519 key pairs from seeds in any of the XRP Ledger's encodings and formats. (This implementation is equivalent to the ones included in most client libraries.)

Delegate

Example delegating payment permission to an account and executing on behalf the delegator.

Delegate Permissions

Delegate permissions to another account, so that the account can send transactions on your behalf.

Delete Account

Delete an account from the XRP Ledger, removing its data and sending its XRP to another account.

DepositPreauth

Example of DepositPreauth transaction demonstrating how deposit permissions can be managed.

Disable Master Key Pair

Disable the master key pair that is connected to an account by default. WARNING: This can blackhole the account, making it so no one can use it or access its funds anymore.

Escrows

Create, finish, and cancel Escrows using conditional or time-based release.

Freezes

Freeze and unfreeze issued tokens, check freeze status, or give up the ability to freeze tokens.

Get a Transaction on the Ledger

Retrieve and display a transaction on the ledger.

Implement Reliable Transaction Submission

Send a transaction and see its validation response. For the implementation in this example, we have made the following decisions:

Issue a Fungible Token

Configure issuer settings and issue fungible tokens to another account.

Issue an MPT with Metadata

Shows how to issue a Multi-Purpose Token (MPT) with metadata encoded according to the XLS-89 schema, then update its mutable properties and declare a property immutable, as defined by XLS-94D.

Lending Protocol Examples

Code samples showing how to create a loan broker, claw back first-loss capital, deposit and withdraw first-loss capital, create a loan, manage a loan, and repay a loan.

Manage Permissioned Domains

Create a permissioned domain to restrict access to financial services that meet compliance requirements, update it with new credentials, or delete a domain you own.

Markers and Pagination

Iterate over a ledger_data method request that requires multiple calls.

Monitor Incoming Payments with WebSocket

Use the WebSocket protocol to watch for incoming payments to an XRP Ledger address, without using a client library.

Multisign a transaction.

Create and submit a SignerListSet and multisign a transaction.

NFT Examples

Various NFT-related actions. Also see the Quickstart Samples for more code related to NFT tutorials.

Normalize Currency Codes

Convert from a string from either the XRP Ledger's "standard" 3-character or "non-standard" 40-character hexadecimal format into a string for humans to read.

Remove Regular Key Pair

Remove the regular key pair assigned to an account.

Require Destination Tags

Require incoming payments to specify a Destination Tag so you know whom to credit.

Secure Signing

Sign transactions from the security of your own machine.

Send an MPT Examples

Send a Multi-Purpose Token (MPT) payment between two accounts and compare balances before and after to confirm the transfer.

Send Partial Payments

Send a partial payment, which delivers less than the amount specified. Partial payments are useful for deducting fees and exchange rates from the amount delivered instead of adding them to the amount sent, but they can also lead to exploits if an integration incorrectly assumes a successful payment delivered the whole amount.

Send XRP

Send a direct XRP payment to another account in the XRP Ledger.

Single Asset Vault Examples

Shows how to create, deposit into, and withdraw from single asset vaults on the XRP Ledger.

Submit and Verify

Demonstrates how to submit a signed transaction blob to the XRP Ledger and wait for a final result.

Trade in the Decentralized Exchange

Look up Offers in the Decentralized Exchange and buy a fungible token by spending XRP.

Transaction Serialization

Convert transactions and other XRPL data from JSON to their canonical binary format for signing or cryptographic verification. (This reference implementation is equivalent to the ones included in most client libraries.)

Use AMM Auction Slot to Save on Fees

Estimate the fees that would be paid for trading through an AMM and use the auction slot to save on fees if applicable.

Use Checks

Create, cash, and cancel Checks for exact or flexible amounts.

Use Paths

Extract paths from RipplePathFind and send a payment using paths.

Use Tickets

Create a batch of Tickets and use one to send a transaction outside the normal Sequence order.

Verify Credential

Check whether a specific account holds a specific credential, and the credential is currently valid.

Walk Owner Directory

Iterate over an account's owner directory and display how many ledger entries are in each page. In cases of highly active accounts, this can demonstrate the extent of "fragmentation" with skipped page numbers and non-full pages.

Contribute Code Samples

Help the XRPL community by submitting your own code samples

Fork and clone

Fork the xrpl-dev-portal repo. Using git, clone the fork to your computer.

Add to folder

Add your sample code to the content/_code-samples/ folder. Be sure to include a README.mdthat summarizes what it does and anything else people should know about it.

Commit and push

Commit your changes and push them to your fork on GitHub.

Open a pull request

Open a pull request to the original repo. Maintainers will review your submission and suggest changes if necessary. If the code sample is helpful, it'll be merged and added to XRPL.org!