Documentation
/
Tutorials
/
Java
/
Build Applications with Java Library
/
Get Started Using Java Library
Last updated
Edit

Get Started Using Java Library

This tutorial walks you through the basics of building an XRP Ledger-connected application using xrpl4j, a pure Java library built to interact with the XRP Ledger.

This tutorial is intended for beginners and should take no longer than 30 minutes to complete.

Learning Goals

In this tutorial, you'll learn:

  • The basic building blocks of XRP Ledger-based applications.
  • How to connect to the XRP Ledger using xrpl4j.
  • How to get an account on the Testnet using xrpl4j.
  • How to use the xrpl4j library to look up information about an account on the XRP Ledger.
  • How to put these steps together to create a Java app.

Requirements

  • The xrpl4j library supports Java 1.8 and later.
  • A project management tool such as Maven or Gradle.

Installation

The xrpl4j library is available on Maven Central. xrpl4j is split into multiple artifacts, which can be imported as needed.

In this tutorial, you need the xrpl4j-client, xrpl4j-address-codec, xrpl4j-keypairs, and xrpl4j-model modules.

To install with Maven, add the following to your project's pom.xml file and then run mvn install:

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.xrpl</groupId>
      <artifactId>xrpl4j-bom</artifactId>
      <version>3.0.1</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
      <groupId>org.xrpl</groupId>
      <artifactId>xrpl4j-core</artifactId>
      <version>3.0.1</version>
    </dependency>
    <dependency>
      <groupId>org.xrpl</groupId>
      <artifactId>xrpl4j-client</artifactId>
      <version>3.0.1</version>
    </dependency>
</dependencies>

Check out the xrpl4j sample project for a full Maven project containing the code from this tutorial.

Start Building

When you're working with the XRP Ledger, there are a few things you'll need to manage, whether you're adding XRP to your account, integrating with the decentralized exchange, or issuing tokens. This tutorial walks you through basic patterns common to getting started with all of these use cases and provides sample code for implementing them.

Here are the basic steps you'll need to cover for almost any XRP Ledger project:

  1. Connect to the XRP Ledger.
  2. Get an account.
  3. Query the XRP Ledger.

1. Connect to the XRP Ledger

To make queries and submit transactions, you need to connect to the XRP Ledger. To do this with xrpl4j, you can use an XrplClient:

/ Construct a network client
HttpUrl rippledUrl = HttpUrl.get("https://s.altnet.rippletest.net:51234/");
System.out.println("Constructing an XrplClient connected to " + rippledUrl);
XrplClient xrplClient = new XrplClient(rippledUrl);

Connect to the production XRP Ledger

The sample code in the previous section shows you how to connect to the Testnet, which is one of the available parallel networks. When you're ready to integrate with the production XRP Ledger, you'll need to connect to the Mainnet. You can do that in two ways:

2. Get account

To store value and execute transactions on the XRP Ledger, you need to get an account: a set of keys and an address that's been funded with enough XRP to meet the account reserve. The address is the identifier of your account and you use the private key to sign transactions that you submit to the XRP Ledger. For production purposes, you should take care to store your keys and set up a secure signing method.

To generate a new account, xrpl4j provides the DefaultWalletFactory.

// Create a random KeyPair
KeyPair randomKeyPair = Seed.ed25519Seed().deriveKeyPair();
System.out.println("Generated KeyPair: " + randomKeyPair);

The result of a call to walletFactory.randomWallet(true).wallet() is a Wallet instance:

System.out.println(testWallet);

// print output
Wallet {
    privateKey= -HIDDEN-,
    publicKey=ED90635A6F2A5905D3D5CD2C14905FFB2D838185993576CA4CEE24A920D0D6BD6B,
    classicAddress=raj5eirfEpbN9YzG9FzB8ZPNyjpFvH6ycV,
    xAddress=T76mQFr9zLGi2LCjVDgJ7mEQCk4767SdEL32mZFygpdGcFf,
    isTest=true
}

For testing and development purposes, you can use a FaucetClient connected to the XRP Ledger Testnet:

// Fund the account using the testnet Faucet
FaucetClient faucetClient = FaucetClient.construct(HttpUrl.get("https://faucet.altnet.rippletest.net"));
faucetClient.fundAccount(FundAccountRequest.of(classicAddress));
System.out.println("Funded the account using the Testnet faucet.");

3. Query the XRP Ledger

You can query the XRP Ledger to get information about a specific account, a specific transaction, the state of a current or a historical ledger, and the XRP Ledger's decentralized exchange. You need to make these queries, among other reasons, to look up account info to follow best practices for reliable transaction submission.

Here, we'll use the XrplClient we constructed to look up information about the account we got in the previous step.

// Look up your Account Info
AccountInfoRequestParams requestParams = AccountInfoRequestParams.of(classicAddress);
AccountInfoResult accountInfoResult = xrplClient.accountInfo(requestParams);

4. Putting it all together

Using these building blocks, we can create a Java app that:

  1. Gets an account on the Testnet.
  2. Connects to the XRP Ledger.
  3. Looks up and prints information about the account you created.
// Construct a network client
HttpUrl rippledUrl = HttpUrl.get("https://s.altnet.rippletest.net:51234/");
System.out.println("Constructing an XrplClient connected to " + rippledUrl);
XrplClient xrplClient = new XrplClient(rippledUrl);

// Create a random KeyPair
KeyPair randomKeyPair = Seed.ed25519Seed().deriveKeyPair();
System.out.println("Generated KeyPair: " + randomKeyPair);

// Derive the Classic and X-Addresses from testWallet
Address classicAddress = randomKeyPair.publicKey().deriveAddress();
XAddress xAddress = AddressCodec.getInstance().classicAddressToXAddress(classicAddress, true);
System.out.println("Classic Address: " + classicAddress);
System.out.println("X-Address: " + xAddress);

// Fund the account using the testnet Faucet
FaucetClient faucetClient = FaucetClient.construct(HttpUrl.get("https://faucet.altnet.rippletest.net"));
faucetClient.fundAccount(FundAccountRequest.of(classicAddress));
System.out.println("Funded the account using the Testnet faucet.");

// Look up your Account Info
AccountInfoRequestParams requestParams = AccountInfoRequestParams.of(classicAddress);
AccountInfoResult accountInfoResult = xrplClient.accountInfo(requestParams);

// Print the result
System.out.println(accountInfoResult);

To run the app, you can download the code from Github and run GetAccountInfo either from your IDE or from the command line.

git clone https://github.com/XRPLF/xrpl4j-sample.git
cd xrpl4j-sample
mvn compile exec:java -Dexec.mainClass="org.xrpl.xrpl4j.samples.GetAccountInfo"

You should see output similar to this example:

Running the GetAccountInfo sample...
Constructing an XrplClient connected to https://s.altnet.rippletest.net:51234/
Generated KeyPair: KeyPair{
  privateKey=PrivateKey{value=[redacted], destroyed=false},
  publicKey=PublicKey{value=UnsignedByteArray{unsignedBytes=List(size=33)},
  base58Value=aKGgrZL2WTc85HJSkQGuKfinem5oMH1uCJankSWFATGUhqvygxir,
  base16Value=EDFB1073327CCBDA342AD685AF1C04530294866B9CB10C21126DC004BFDBA287D1,
  keyType=ED25519
  }
}
Classic Address: rBXHGshqXu3Smy9FUsQTmo49bGpQUQEm3X
X-Address: T7yMiiJJCmgY2yg5WB2davUedDeBFAG5B8r9KHjKCxDdvv3
Funded the account using the Testnet faucet.
AccountInfoResult{
  status=success,
  accountData=AccountRootObject{
    ledgerEntryType=ACCOUNT_ROOT,
    account=rDNwS2t4afhBogKqSFFmsDi1k7gmeGhz4p,
    balance=10000000000,
    flags=0,
    ownerCount=0,
    previousTransactionId=0000000000000000000000000000000000000000000000000000000000000000,
    previousTransactionLedgerSequence=0,
    sequence=37649083,
    signerLists=[],
    index=F607809578C2A413774B9A240480B8B7B10C3E296CA609337D2F41813F566B92
  },
  ledgerCurrentIndex=37649083,
  validated=false
}

Interpreting the response

The response fields contained in AccountInfoResult that you want to inspect in most cases are:

  • accountData.sequence — This is the sequence number of the next valid transaction for the account. You need to specify the sequence number when you prepare transactions.

  • accountData.balance — This is the account's balance of XRP, in drops. You can use this to confirm that you have enough XRP to send (if you're making a payment) and to meet the current transaction cost for a given transaction.

  • validated — Indicates whether the returned data is from a validated ledger. When inspecting transactions, it's important to confirm that the results are final before further processing the transaction. If validated is true then you know for sure the results won't change. For more information about best practices for transaction processing, see Reliable Transaction Submission.

For a detailed description of every response field, see account_info.

Keep on building

Now that you know how to use xrpl4j to connect to the XRP Ledger, get an account, and look up information about it, you can also use xrpl4j to:

Previous page
Next page