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.
AccountObjectsResult	accountObjects(AccountObjectsRequestParams params)	Get the AccountObjectsResult for the account specified in params by making an account_objects method call.
AccountOffersResult	accountOffers(AccountCurrenciesRequestParams 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.
ChannelVerifyResult	channelVerify(Hash256 channelId, XrpCurrencyAmount amount, String signature, String publicKey)	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.
JsonRpcClient	getJsonRpcClient()
LedgerResult	ledger(LedgerRequestParams params)	Get the contents of a ledger by sending a ledger method request.
RipplePathFindResult	ripplePathFind(RipplePathFindRequestParams params)	Try to find a payment path for a rippling payment by sending a ripple_path_find method request.
ServerInfo	serverInfo()	Get the "server_info" for the rippled node.
<T extends Transaction> SignedTransaction<T>	signTransaction(Wallet wallet, T unsignedTransaction)	Sign a Transaction with the private key from a Wallet.
<T extends Transaction> SubmitResult<T>	submit(SignedTransaction signedTransaction)	Submit a SignedTransaction to the XRP Ledger.
<T extends Transaction> SubmitResult<T>	submit(SignedTransaction<T> signedTransaction)	Submit a SignedTransaction to the ledger.
<T extends Transaction> SubmitResult<T>	submit(Wallet wallet, T unsignedTransaction)	Submit a Transaction to the XRP Ledger.
<T extends Transaction> SubmitMultiSignedResult<T>	submitMultisigned(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 Detail

XrplClient

public XrplClient(okhttp3.HttpUrl rippledUrl)

Public constructor.

Parameters:

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

Method Detail

submit

public <T extends Transaction> SubmitResult<T> submit(Wallet wallet,
                                                      T unsignedTransaction)
                                               throws JsonRpcClientErrorException

Submit a Transaction to the XRP Ledger.

Type Parameters:

T - The type of Transaction that is being submitted.

Parameters:

wallet - The Wallet of the XRPL account submitting unsignedTransaction.

unsignedTransaction - An unsigned Transaction to submit. Transaction.transactionSignature() must not be provided, and Transaction.signingPublicKey() must be provided.

Returns:

The SubmitResult resulting from the submission request.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

See Also:

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

submit

public <T extends Transaction> SubmitResult<T> submit(SignedTransaction<T> signedTransaction)
                                               throws JsonRpcClientErrorException

Submit a SignedTransaction to the ledger.

Type Parameters:

T - The type of Transaction contained in the SignedTransaction object.

Parameters:

signedTransaction - A SignedTransaction to submit.

Returns:

The SubmitResult resulting from the submission request.

Throws:

JsonRpcClientErrorException - If jsonRpcClient throws an error.

submit

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

Submit a SignedTransaction to the XRP Ledger.

Type Parameters:

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

Parameters:

signedTransaction - A SignedTransaction 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(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 multisigned Transaction.

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"

serverInfo

public ServerInfo serverInfo()
                      throws JsonRpcClientErrorException

Get the "server_info" for the rippled node.

Returns:

A ServerInfo 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.

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(AccountCurrenciesRequestParams 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.

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.

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(Hash256 channelId,
                                         XrpCurrencyAmount amount,
                                         String signature,
                                         String publicKey)
                                  throws JsonRpcClientErrorException

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

Parameters:

channelId - A Hash256 containing the Channel ID.

amount - An XrpCurrencyAmount representing the amount of the claim.

signature - The signature of the PaymentChannelClaim transaction.

publicKey - A String containing the public key associated with the key used to generate the signature.

Returns:

The result of the request, as a ChannelVerifyResult.

Throws:

JsonRpcClientErrorException - if jsonRpcClient throws an error.

signTransaction

public <T extends Transaction> SignedTransaction<T> signTransaction(Wallet wallet,
                                                                    T unsignedTransaction)

Sign a Transaction with the private key from a Wallet.

Type Parameters:

T - The actual polymorphic type of Transaction to sign.

Parameters:

wallet - A Wallet with a private key to sign the transaction with.

unsignedTransaction - A Transaction without a signature.

Returns:

A SignedTransaction.

getJsonRpcClient

public JsonRpcClient getJsonRpcClient()