Crate xrpl_sdk_jsonrpc

A strongly-typed client for the XRP Ledger HTTP JSONRPC API.

Re-exports

pub use client::Client;

pub use client::Result;

Modules

account_channels

The account_channels method returns information about an account’s Payment Channels. This includes only channels where the specified account is the channel’s source, not the destination. (A channel’s “source” and “owner” are the same.) All information retrieved is relative to a particular version of the ledger.

account_currencies

https://xrpl.org/account_currencies.html

account_info

https://xrpl.org/account_info.html

account_lines

https://xrpl.org/account_lines.html

account_nfts

The account_nfts method returns a list of NFToken objects for the specified account.

account_objects

https://xrpl.org/account_objects.html

account_offers

The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.

account_tx

The account_tx method retrieves a list of transactions that involved the specified account.

book_offers

The book_offers method retrieves a list of offers, also known as the order book, between two currencies.

client

deposit_authorized

The deposit_authorized command indicates whether one account is authorized to send payments directly to another. See Deposit Authorization for information on how to require authorization to deliver money to your account.

error

fee

The fee command reports the current state of the open-ledger requirements for the transaction cost.

gateway_balances

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

get_offer_object

https://xrpl.org/ledger_entry.html

ledger

https://xrpl.org/ledger.html

ledger_closed

The ledger_closed method returns the unique identifiers of the most recently closed ledger. (This ledger is not necessarily validated and immutable yet.)

ledger_current

The ledger_current method returns the unique identifiers of the current in-progress ledger. This command is mostly useful for testing, because the ledger returned is still in flux.

ledger_data

The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.

ledger_entry

https://xrpl.org/ledger_entry.html

manifest

The manifest method reports the current “manifest” information for a given validator public key. The “manifest” is the public portion of that validator’s configured token. Updated in: rippled 1.7.0

nft_buy_offers

The nft_buy_offers method returns a list of buy offers for a given NFToken object.

nft_sell_offers

The nft_sell_offers method returns a list of sell offers for a given NFToken object.

path_find

WebSocket API only! The path_find method searches for a path along which a transaction can possibly be made, and periodically sends updates when the path changes over time. For a simpler version that is supported by JSON-RPC, see the ripple_path_find method. For payments occurring strictly in XRP, it is not necessary to find a path, because XRP can be sent directly to any account.

ping

The ping command returns an acknowledgement, so that clients can test the connection status and latency.

random

The random command provides a random number to be used as a source of entropy for random number generation by clients.

ripple_path_find

The ripple_path_find method is a simplified version of the path_find method that provides a single response with a payment path you can use right away. It is available in both the WebSocket and JSON-RPC APIs. However, the results tend to become outdated as time passes. Instead of making multiple calls to stay updated, you should instead use the path_find method to subscribe to continued updates where possible.

server_info

The server_info command asks the server for a human-readable version of various information about the rippled server being queried.

server_state

The server_state command asks the server for various machine-readable information about the rippled server’s current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)

submit

The submit method applies a transaction and sends it to the network to be confirmed and included in future ledgers.

subscribe

The subscribe method requests periodic notifications from the server when certain events happen.

transaction_entry

The transaction_entry method retrieves information on a single transaction from a specific ledger version. (The tx method, by contrast, searches all ledgers for the specified transaction. We recommend using that method instead.)

tx

The tx method retrieves information on a single transaction, by its identifying hash.

unsubscribe

https://xrpl.org/unsubscribe.html

with_ledger_spec

with_pagination

Structs

AccountChannel

AccountChannelsRequest

AccountChannelsResponse

AccountCurrenciesRequest

AccountCurrenciesResponse

AccountInfoRequest

AccountInfoResponse

AccountLine

AccountLinesRequest

AccountLinesResponse

AccountNftsRequest

AccountNftsResponse

AccountObjectsRequest

AccountObjectsResponse

AccountOffer

AccountOffersRequest

AccountOffersResponse

AccountTransaction

AccountTxRequest

AccountTxResponse

BookOffersRequest

BookOffersResponse

DepositAuthorizedRequest

DepositAuthorizedResponse

Details

Drops

Various information about the transaction cost (the Fee field of a transaction), in drops of XRP.

ExpandLedgerRequest

FeeRequest

FeeResponse

GatewayBalancesRequest

GatewayBalancesResponse

GetOfferObjectRequest

GetOfferObjectResponse

Ledger

LedgerClosedEvent

LedgerClosedRequest

LedgerClosedResponse

LedgerCurrentRequest

LedgerCurrentResponse

LedgerData

LedgerDataRequest

LedgerDataResponse

LedgerEntryRequest

LedgerEntryResponse

LedgerRequest

LedgerResponse

Levels

Various information about the transaction cost, in fee levels. The ratio in fee levels applies to any transaction relative to the minimum cost of that particular transaction.

ManifestRequest

ManifestResponse

NFToken

The NFToken object represents a single non-fungible token (NFT). It is not stored on its own, but is contained in a NFTokenPage object alongside other NFTs.

NftBuyOffersRequest

NftBuyOffersResponse

NftSellOffersRequest

NftSellOffersResponse

OfferParams

Path

PingRequest

PingResponse

RandomRequest

RandomResponse

RequestPagination

Pagination part of request, see https://xrpl.org/markers-and-pagination.html

ResponsePagination

Pagination part of response, see https://xrpl.org/markers-and-pagination.html

RetrieveLedgerSpec

Ledger specification when retrieving data

ReturnLedgerSpec

Ledger specification in returned data

RipplePathFindRequest

RipplePathFindResponse

SIValidatedLedger

SSValidatedLedger

ServerInfo

ServerInfoRequest

ServerInfoResponse

ServerState

ServerStateRequest

ServerStateResponse

StateAccountingInfo

Information about the time the server spends in server state. This can be useful for tracking the long-term health of your server’s connectivity to the network.

SubmitRequest

SubscribeRequest

SubscribeResponse

TransactionEntryRequest

TransactionEntryResponse

TransactionEvent

TxRequest

TxResponse

UnsubscribeRequest

UnsubscribeResponse

ValidationReceivedEvent

Enums

ObjectType

Traits

WithLedgerSpec

Request that allows specifying ledger index to execute request on. See https://xrpl.org/basic-data-types.html#specifying-ledgers.

WithRequestPagination

Request that allows specifying pagination. See https://xrpl.org/markers-and-pagination.html.

WithResponsePagination

Response that allows specifying pagination. See https://xrpl.org/markers-and-pagination.html.

Type Aliases

SubmitResponse