Package org.xrpl.xrpl4j.client

Class XrplClient

java.lang.Object

org.xrpl.xrpl4j.client.XrplClient

@Beta
public class XrplClient
extends Object

A client which wraps a rippled network client and is responsible for higher order functionality such as signing and serializing transactions, as well as hiding certain implementation details from the public API such as JSON RPC request object creation.

Note: This client is currently marked as Beta, and should be used as a reference implementation ONLY.

Constructor Summary

Constructors

Constructor	Description
XrplClient(okhttp3.HttpUrl rippledUrl)	Public constructor.

Method Summary

Modifier and Type	Method	Description
AccountChannelsResult	accountChannels(AccountChannelsRequestParams params)	Get the AccountChannelsResult for the account specified in params by making an account_channels method call.
AccountCurrenciesResult	accountCurrencies(AccountCurrenciesRequestParams params)	Get the AccountCurrenciesResult for the account specified in params by making an account_currencies method call.
AccountInfoResult	accountInfo(AccountInfoRequestParams params)	Get the AccountInfoResult for the account specified in params by making an account_info method call.
AccountLinesResult	accountLines(AccountLinesRequestParams params)	Get the trust lines for a given account by sending an account_lines method request.
AccountNftsResult	accountNfts(AccountNftsRequestParams params)	Get the AccountNftsResult for the account specified in params by making an account_channels method call.
AccountNftsResult	accountNfts(Address account)	Return AccountNftsResult for an Address.
AccountObjectsResult	accountObjects(AccountObjectsRequestParams params)	Get the AccountObjectsResult for the account specified in params by making an account_objects method call.
AccountOffersResult	accountOffers(AccountOffersRequestParams params)	Get the AccountOffersResult for the account specified in params by making an account_offers method call.
AccountTransactionsResult	accountTransactions(AccountTransactionsRequestParams params)	Get the AccountTransactionsResult for the account specified in params by making an account_tx method call.
AccountTransactionsResult	accountTransactions(Address address)	Get the AccountTransactionsResult for the specified address by making an account_tx method call.
AmmInfoResult	ammInfo(AmmInfoRequestParams params)	Get info about an AMM by making a call to the amm_info rippled RPC method.
BookOffersResult	bookOffers(BookOffersRequestParams params)	Send a book_offers RPC request.
ChannelVerifyResult	channelVerify(ChannelVerifyRequestParams params)	Verify a payment channel claim signature by making a "channel_verify" rippled API method call.
DepositAuthorizedResult	depositAuthorized(DepositAuthorizedRequestParams params)	Indicates whether one account is authorized to send payments directly to another.
FeeResult	fee()	Get the current state of the open-ledger requirements for transaction costs.
GatewayBalancesResult	gatewayBalances(GatewayBalancesRequestParams params)	Get the issued currency balances of an issuing account by making a "gateway_balances" rippled API method call.
JsonRpcClient	getJsonRpcClient()
protected com.google.common.primitives.UnsignedInteger	getMostRecentlyValidatedLedgerIndex()	Get the ledger index of a tx result response.
protected Optional<? extends TransactionResult<? extends Transaction>>	getValidatedTransaction(Hash256 transactionHash)	Get the TransactionResult for the transaction with the hash transactionHash.
Finality	isFinal(Hash256 transactionHash, LedgerIndex submittedOnLedgerIndex, com.google.common.primitives.UnsignedInteger lastLedgerSequence, com.google.common.primitives.UnsignedInteger transactionAccountSequence, Address account)	Check if the transaction is final on the ledger or not.
LedgerResult	ledger(LedgerRequestParams params)	Get the contents of a ledger by sending a ledger method request.
<T extends LedgerObject> LedgerEntryResult<T>	ledgerEntry(LedgerEntryRequestParams<T> params)	Retrieve a LedgerObject by sending a ledger_entry RPC request.
protected boolean	ledgerGapsExistBetween(com.google.common.primitives.UnsignedLong submittedLedgerSequence, com.google.common.primitives.UnsignedLong lastLedgerSequence)	Check if there missing ledgers in rippled in the given range.
NftBuyOffersResult	nftBuyOffers(NftBuyOffersRequestParams params)	Get the NftBuyOffersResult for the NfTokenId specified in params by making an nft_buy_offers method call.
NftInfoResult	nftInfo(NftInfoRequestParams params)	Returns information about a given NFT.
NftSellOffersResult	nftSellOffers(NftSellOffersRequestParams params)	Get the NftSellOffersResult for the NfTokenId specified in params by making an nft_sell_offers method call.
RipplePathFindResult	ripplePathFind(RipplePathFindRequestParams params)	Try to find a payment path for a rippling payment by sending a ripple_path_find method request.
ServerInfoResult	serverInformation()	Get the "server_info" for the rippled node RippledServerInfo, clio server ClioServerInfo and reporting mode server ReportingModeServerInfo.
<T extends Transaction> SubmitResult<T>	submit(SingleSignedTransaction<T> signedTransaction)	Submit a SingleSignedTransaction to the XRP Ledger.
<T extends Transaction> SubmitMultiSignedResult<T>	submitMultisigned(MultiSignedTransaction<T> transaction)	Submit a multisigned Transaction to the ledger.
<T extends Transaction> TransactionResult<T>	transaction(TransactionRequestParams params, Class<T> transactionType)	Get a transaction from the ledger by sending a tx method request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XrplClient

public XrplClient(okhttp3.HttpUrl rippledUrl)

Public constructor.

Parameters:

rippledUrl - The HttpUrl of the rippled node to connect to.

Method Details

submit

public <T extends Transaction> SubmitResult<T> submit(SingleSignedTransaction<T> signedTransaction)
                                               throws JsonRpcClientErrorException,
com.fasterxml.jackson.core.JsonProcessingException

Submit a SingleSignedTransaction to the XRP Ledger.

Type Parameters:

T - The type of signed Transaction that is being submitted.

Parameters:

signedTransaction - A SingleSignedTransaction to submit.

Returns:

The SubmitResult resulting from the submission request.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

com.fasterxml.jackson.core.JsonProcessingException - if any JSON is invalid.

See Also:

• "https://xrpl.org/submit.html"

submitMultisigned

public <T extends Transaction>
SubmitMultiSignedResult<T> submitMultisigned(MultiSignedTransaction<T> transaction)
                                      throws JsonRpcClientErrorException

Submit a multisigned Transaction to the ledger.

Type Parameters:

T - A type parameter for the type of Transaction being submitted.

Parameters:

transaction - A MultiSignedTransaction.

Returns:

A SubmitMultiSignedResult of type XrplClient.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

fee

public FeeResult fee()
              throws JsonRpcClientErrorException

Get the current state of the open-ledger requirements for transaction costs.

Returns:

A FeeResult containing information about current transaction costs.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

See Also:

• "https://xrpl.org/fee.html"

getMostRecentlyValidatedLedgerIndex

protected com.google.common.primitives.UnsignedInteger getMostRecentlyValidatedLedgerIndex()
                                                                                    throws JsonRpcClientErrorException

Get the ledger index of a tx result response. If not present, throw an exception.

Returns:

A string containing value of last validated ledger index.

Throws:

JsonRpcClientErrorException - when client encounters errors related to calling rippled JSON RPC API..

getValidatedTransaction

protected Optional<? extends TransactionResult<? extends Transaction>> getValidatedTransaction(Hash256 transactionHash)

Get the TransactionResult for the transaction with the hash transactionHash.

Parameters:

transactionHash - Hash256 of the transaction to get the TransactionResult for.

Returns:

the TransactionResult for a validated transaction and empty response for a Transaction that is expired or not found.

ledgerGapsExistBetween

protected boolean ledgerGapsExistBetween(com.google.common.primitives.UnsignedLong submittedLedgerSequence,
 com.google.common.primitives.UnsignedLong lastLedgerSequence)

Check if there missing ledgers in rippled in the given range.

Parameters:

submittedLedgerSequence - LedgerIndex at which the Transaction was submitted on.

lastLedgerSequence - he ledger index/sequence of type UnsignedInteger after which the transaction will expire and won't be applied to the ledger.

Returns:

Boolean to indicate if there are gaps in the ledger range.

isFinal

public Finality isFinal(Hash256 transactionHash,
 LedgerIndex submittedOnLedgerIndex,
 com.google.common.primitives.UnsignedInteger lastLedgerSequence,
 com.google.common.primitives.UnsignedInteger transactionAccountSequence,
 Address account)

Check if the transaction is final on the ledger or not.

Parameters:

transactionHash - Hash256 of the submitted transaction to check the status for.

submittedOnLedgerIndex - LedgerIndex on which the transaction with hash transactionHash was submitted. This can be obtained from submit() response of the tx as validatedLedgerIndex.

lastLedgerSequence - The ledger index/sequence of type UnsignedInteger after which the transaction will expire and won't be applied to the ledger.

transactionAccountSequence - The sequence number of the account submitting the Transaction. A Transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account.

account - The unique Address of the account that initiated this transaction.

Returns:

true if the Transaction is final/validated else false.

serverInformation

public ServerInfoResult serverInformation()
                                   throws JsonRpcClientErrorException

Get the "server_info" for the rippled node RippledServerInfo, clio server ClioServerInfo and reporting mode server ReportingModeServerInfo. You should be able to handle all these response types as ServerInfo.

Returns:

A ServerInfoResult containing information about the server.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

See Also:

• "https://xrpl.org/server_info.html"

accountChannels

public AccountChannelsResult accountChannels(AccountChannelsRequestParams params)
                                      throws JsonRpcClientErrorException

Get the AccountChannelsResult for the account specified in params by making an account_channels method call.

Parameters:

params - The AccountChannelsRequestParams to send in the request.

Returns:

The AccountChannelsResult returned by the account_channels method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountCurrencies

public AccountCurrenciesResult accountCurrencies(AccountCurrenciesRequestParams params)
                                          throws JsonRpcClientErrorException

Get the AccountCurrenciesResult for the account specified in params by making an account_currencies method call.

Parameters:

params - The AccountCurrenciesRequestParams to send in the request.

Returns:

The AccountCurrenciesResult returned by the account_currencies method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountInfo

public AccountInfoResult accountInfo(AccountInfoRequestParams params)
                              throws JsonRpcClientErrorException

Get the AccountInfoResult for the account specified in params by making an account_info method call.

Parameters:

params - The AccountInfoRequestParams to send in the request.

Returns:

The AccountInfoResult returned by the account_info method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountNfts

public AccountNftsResult accountNfts(Address account)
                              throws JsonRpcClientErrorException

Return AccountNftsResult for an Address.

Parameters:

account - to get the NFTs for.

Returns:

AccountNftsResult containing list of accounts for an address.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountNfts

public AccountNftsResult accountNfts(AccountNftsRequestParams params)
                              throws JsonRpcClientErrorException

Get the AccountNftsResult for the account specified in params by making an account_channels method call.

Parameters:

params - The AccountNftsRequestParams to send in the request.

Returns:

The AccountNftsResult returned by the account_nfts method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

nftBuyOffers

public NftBuyOffersResult nftBuyOffers(NftBuyOffersRequestParams params)
                                throws JsonRpcClientErrorException

Get the NftBuyOffersResult for the NfTokenId specified in params by making an nft_buy_offers method call.

Parameters:

params - The NftBuyOffersRequestParams to send in the request.

Returns:

The NftBuyOffersResult returned by the nft_buy_offers method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

nftSellOffers

public NftSellOffersResult nftSellOffers(NftSellOffersRequestParams params)
                                  throws JsonRpcClientErrorException

Get the NftSellOffersResult for the NfTokenId specified in params by making an nft_sell_offers method call.

Parameters:

params - The NftSellOffersRequestParams to send in the request.

Returns:

The NftSellOffersResult returned by the nft_sell_offers method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

nftInfo

public NftInfoResult nftInfo(NftInfoRequestParams params)
                      throws JsonRpcClientErrorException

Returns information about a given NFT. This method is only supported on Clio servers. Sending this request to a Reporting Mode or rippled node will result in an exception.

Parameters:

params - The NftInfoRequestParams to send in the request.

Returns:

The NftInfoResult returned by the nft_info method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error, or if the request was made to a non-Clio node.

accountObjects

public AccountObjectsResult accountObjects(AccountObjectsRequestParams params)
                                    throws JsonRpcClientErrorException

Get the AccountObjectsResult for the account specified in params by making an account_objects method call.

Parameters:

params - The AccountObjectsRequestParams to send in the request.

Returns:

The AccountObjectsResult returned by the account_objects method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountOffers

public AccountOffersResult accountOffers(AccountOffersRequestParams params)
                                  throws JsonRpcClientErrorException

Get the AccountOffersResult for the account specified in params by making an account_offers method call.

Parameters:

params - The AccountOffersRequestParams to send in the request.

Returns:

The AccountOffersResult returned by the account_offers method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

depositAuthorized

public DepositAuthorizedResult depositAuthorized(DepositAuthorizedRequestParams params)
                                          throws JsonRpcClientErrorException

Indicates whether one account is authorized to send payments directly to another.

Parameters:

params - A DepositAuthorizedRequestParams to send in the request.

Returns:

The DepositAuthorizedResult returned by the deposit_authorized method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountTransactions

public AccountTransactionsResult accountTransactions(Address address)
                                              throws JsonRpcClientErrorException

Get the AccountTransactionsResult for the specified address by making an account_tx method call.

Parameters:

address - The Address of the account to request.

Returns:

The AccountTransactionsResult returned by the account_tx method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountTransactions

public AccountTransactionsResult accountTransactions(AccountTransactionsRequestParams params)
                                              throws JsonRpcClientErrorException

Get the AccountTransactionsResult for the account specified in params by making an account_tx method call.

Parameters:

params - The AccountTransactionsRequestParams to send in the request.

Returns:

The AccountTransactionsResult returned by the account_tx method call.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

transaction

public <T extends Transaction> TransactionResult<T> transaction(TransactionRequestParams params,
 Class<T> transactionType)
                                                         throws JsonRpcClientErrorException

Get a transaction from the ledger by sending a tx method request.

Type Parameters:

T - Type parameter for the type of Transaction that the TransactionResult will

Parameters:

params - The TransactionRequestParams to send in the request.

transactionType - The Transaction type of the transaction with the hash params.transaction().

Returns:

A TransactionResult containing the requested transaction and other metadata.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

ledger

public LedgerResult ledger(LedgerRequestParams params)
                    throws JsonRpcClientErrorException

Get the contents of a ledger by sending a ledger method request.

Parameters:

params - The LedgerRequestParams to send in the request.

Returns:

A LedgerResult containing the ledger details.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

ledgerEntry

public <T extends LedgerObject>
LedgerEntryResult<T> ledgerEntry(LedgerEntryRequestParams<T> params)
                          throws JsonRpcClientErrorException

Retrieve a LedgerObject by sending a ledger_entry RPC request.

Type Parameters:

T - The type of LedgerObject that should be returned in rippled's response.

Parameters:

params - A LedgerEntryRequestParams containing the request parameters.

Returns:

A LedgerEntryResult of type XrplClient.

Throws:

JsonRpcClientErrorException

ripplePathFind

public RipplePathFindResult ripplePathFind(RipplePathFindRequestParams params)
                                    throws JsonRpcClientErrorException

Try to find a payment path for a rippling payment by sending a ripple_path_find method request.

Parameters:

params - The RipplePathFindRequestParams to send in the request.

Returns:

A RipplePathFindResult containing possible paths.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

bookOffers

public BookOffersResult bookOffers(BookOffersRequestParams params)
                            throws JsonRpcClientErrorException

Send a book_offers RPC request.

Parameters:

params - The BookOffersRequestParams to send in the request.

Returns:

A BookOffersResult.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

accountLines

public AccountLinesResult accountLines(AccountLinesRequestParams params)
                                throws JsonRpcClientErrorException

Get the trust lines for a given account by sending an account_lines method request.

Parameters:

params - The AccountLinesRequestParams to send in the request.

Returns:

The AccountLinesResult containing the requested trust lines.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

channelVerify

public ChannelVerifyResult channelVerify(ChannelVerifyRequestParams params)
                                  throws JsonRpcClientErrorException

Verify a payment channel claim signature by making a "channel_verify" rippled API method call.

Parameters:

params - The ChannelVerifyRequestParams to send in the request.

Returns:

The result of the request, as a ChannelVerifyResult.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

gatewayBalances

public GatewayBalancesResult gatewayBalances(GatewayBalancesRequestParams params)
                                      throws JsonRpcClientErrorException

Get the issued currency balances of an issuing account by making a "gateway_balances" rippled API method call.

Parameters:

params - The GatewayBalancesRequestParams to send in the request.

Returns:

The result of the request, as a GatewayBalancesResult.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

ammInfo

@Beta
public AmmInfoResult ammInfo(AmmInfoRequestParams params)
                      throws JsonRpcClientErrorException

Get info about an AMM by making a call to the amm_info rippled RPC method.

Parameters:

params - The AmmInfoRequestParams to send in the request.

Returns:

A AmmInfoResult.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

getJsonRpcClient

public JsonRpcClient getJsonRpcClient()