Class XrplClient

Inheritance
System.Object
XrplClient
Implements
IDisposable
Namespace: Xrpl.Client
Assembly: Xrpl.dll
Syntax
public class XrplClient : object, IXrplClient

Constructors

| Improve this Doc View Source

XrplClient(String, Nullable<Double>, Nullable<String>)

Declaration
public XrplClient(string server, double? feeCushion, string? maxFeeXRP = null)
Parameters
Type Name Description
System.String server
System.Nullable<System.Double> feeCushion
System.Nullable<System.String> maxFeeXRP

Fields

| Improve this Doc View Source

url

Declaration
public readonly string url
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

FeeCushion

Declaration
public double FeeCushion { get; set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

MaxFeeXRP

Declaration
public string MaxFeeXRP { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SocketState

Current web socket client state

Declaration
public WebSocketState SocketState { get; }
Property Value
Type Description
WebSocketState

Methods

| Improve this Doc View Source

AccountChannels(AccountChannelsRequest)

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.

Declaration
public Task<AccountChannels> AccountChannels(AccountChannelsRequest request)
Parameters
Type Name Description
AccountChannelsRequest request

An AccountChannelsRequest request.
Returns
Type Description
Task<AccountChannels>

An AccountChannels response.
| Improve this Doc View Source

AccountCurrencies(AccountCurrenciesRequest)

The account_currencies command retrieves a list of currencies that an account can send or receive, based on its trust lines.

Declaration
public Task<AccountCurrencies> AccountCurrencies(AccountCurrenciesRequest request)
Parameters
Type Name Description
AccountCurrenciesRequest request

An AccountCurrenciesRequest request.
Returns
Type Description
Task<AccountCurrencies>

An AccountCurrencies response.
| Improve this Doc View Source

AccountInfo(AccountInfoRequest)

The account_info command retrieves information about an account, its activity, and its XRP balance.

Declaration
public Task<AccountInfo> AccountInfo(AccountInfoRequest request)
Parameters
Type Name Description
AccountInfoRequest request

An AccountInfoRequest request.
Returns
Type Description
Task<AccountInfo>

An AccountInfo response.
| Improve this Doc View Source

AccountLines(AccountLinesRequest)

The account_lines method returns information about an account's trust lines, including balances in all non-XRP currencies and assets.

Declaration
public Task<AccountLines> AccountLines(AccountLinesRequest request)
Parameters
Type Name Description
AccountLinesRequest request

An AccountLinesRequest request.
Returns
Type Description
Task<AccountLines>

An AccountLines response.
| Improve this Doc View Source

AccountNFTs(AccountNFTsRequest)

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

Declaration
public Task<AccountNFTs> AccountNFTs(AccountNFTsRequest request)
Parameters
Type Name Description
AccountNFTsRequest request

An AccountNFTsRequest request.
Returns
Type Description
Task<AccountNFTs>

An AccountNFTs response.
| Improve this Doc View Source

AccountObjects(AccountObjectsRequest)

The AccountObjects command returns the raw ledger format for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see AccountLines instead.

Declaration
public Task<AccountObjects> AccountObjects(AccountObjectsRequest request)
Parameters
Type Name Description
AccountObjectsRequest request

An AccountObjectsRequest request.
Returns
Type Description
Task<AccountObjects>

An AccountObjects response.
| Improve this Doc View Source

AccountOffers(AccountOffersRequest)

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

Declaration
public Task<AccountOffers> AccountOffers(AccountOffersRequest request)
Parameters
Type Name Description
AccountOffersRequest request

An AccountOffersRequest request.
Returns
Type Description
Task<AccountOffers>

An AccountOffers response.
| Improve this Doc View Source

AccountTransactions(AccountTransactionsRequest)

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

Declaration
public Task<AccountTransactions> AccountTransactions(AccountTransactionsRequest request)
Parameters
Type Name Description
AccountTransactionsRequest request

An AccountTransactionsRequest request.
Returns
Type Description
Task<AccountTransactions>

An AccountTransactions response.
| Improve this Doc View Source

AnyRequest(RippleRequest)

Declaration
public Task<object> AnyRequest(RippleRequest request)
Parameters
Type Name Description
RippleRequest request
Returns
Type Description
Task<System.Object>
| Improve this Doc View Source

Autofill(Dictionary<String, Object>)

Declaration
public Task<Dictionary<string, dynamic>> Autofill(Dictionary<string, dynamic> tx)
Parameters
Type Name Description
Dictionary<System.String, System.Object> tx
Returns
Type Description
Task<Dictionary<System.String, System.Object>>
| Improve this Doc View Source

BookOffers(BookOffersRequest)

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

Declaration
public Task<BookOffers> BookOffers(BookOffersRequest request)
Parameters
Type Name Description
BookOffersRequest request

An BookOffersRequest request.
Returns
Type Description
Task<BookOffers>

An BookOffers response.
| Improve this Doc View Source

Connect()

connect to the server

Declaration
public void Connect()
| Improve this Doc View Source

Disconnect()

Disconnect from server

Declaration
public void Disconnect()
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Fee(FeeRequest)

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

Declaration
public Task<Fee> Fee(FeeRequest request)
Parameters
Type Name Description
FeeRequest request

An FeeRequest request.
Returns
Type Description
Task<Fee>

An Fee response.
| Improve this Doc View Source

GatewayBalances(GatewayBalancesRequest)

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

Declaration
public Task<GatewayBalances> GatewayBalances(GatewayBalancesRequest request)
Parameters
Type Name Description
GatewayBalancesRequest request

An GatewayBalancesRequest request.
Returns
Type Description
Task<GatewayBalances>

An GatewayBalances response.
| Improve this Doc View Source

GetLedgerIndex()

Declaration
public Task<uint> GetLedgerIndex()
Returns
Type Description
Task<System.UInt32>
| Improve this Doc View Source

GetXrpBalance(String)

Declaration
public Task<string> GetXrpBalance(string address)
Parameters
Type Name Description
System.String address
Returns
Type Description
Task<System.String>
| Improve this Doc View Source

Ledger(LedgerRequest)

The ledger_request command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger

Declaration
public Task<LOLedger> Ledger(LedgerRequest request)
Parameters
Type Name Description
LedgerRequest request

An LedgerRequest request.
Returns
Type Description
Task<LOLedger>

An LOLedger response.
| Improve this Doc View Source

LedgerClosed(LedgerClosedRequest)

The ledger_closed method returns the unique identifiers of the most recently closed ledger.

Declaration
public Task<LOBaseLedger> LedgerClosed(LedgerClosedRequest request)
Parameters
Type Name Description
LedgerClosedRequest request

An LedgerClosedRequest response.
Returns
Type Description
Task<LOBaseLedger>

An LOBaseLedger response.
| Improve this Doc View Source

LedgerCurrent(LedgerCurrentRequest)

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.

Declaration
public Task<LOLedgerCurrentIndex> LedgerCurrent(LedgerCurrentRequest request)
Parameters
Type Name Description
LedgerCurrentRequest request

An LedgerCurrentRequest response.
Returns
Type Description
Task<LOLedgerCurrentIndex>

An LOLedgerCurrentIndex response.
| Improve this Doc View Source

LedgerData(LedgerDataRequest)

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.

Declaration
public Task<LOLedgerData> LedgerData(LedgerDataRequest request)
Parameters
Type Name Description
LedgerDataRequest request

An LedgerDataRequest request.
Returns
Type Description
Task<LOLedgerData>

An LOLedgerData response.
| Improve this Doc View Source

LedgerEntry(LedgerEntryRequest)

The ledger_entry method returns a single ledger object from the XRP Ledger in its raw format.
See ledger format for information on the different types of objects you can retrieve.

Declaration
public Task<LOLedgerEntry> LedgerEntry(LedgerEntryRequest request)
Parameters
Type Name Description
LedgerEntryRequest request

An LedgerEntryRequest response.
Returns
Type Description
Task<LOLedgerEntry>

An LOLedgerEntry response.
| Improve this Doc View Source

NFTBuyOffers(NFTBuyOffersRequest)

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

Declaration
public Task<NFTBuyOffers> NFTBuyOffers(NFTBuyOffersRequest request)
Parameters
Type Name Description
NFTBuyOffersRequest request

An NFTBuyOffersRequest request.
Returns
Type Description
Task<NFTBuyOffers>

An NFTBuyOffers response.
| Improve this Doc View Source

NFTSellOffers(NFTSellOffersRequest)

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

Declaration
public Task<NFTSellOffers> NFTSellOffers(NFTSellOffersRequest request)
Parameters
Type Name Description
NFTSellOffersRequest request

An NFTSellOffersRequest request.
Returns
Type Description
Task<NFTSellOffers>

An NFTSellOffers response.
| Improve this Doc View Source

NoRippleCheck(NoRippleCheckRequest)

The noripple_check command provides a quick way to check the status of the Default Ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings

Declaration
public Task<NoRippleCheck> NoRippleCheck(NoRippleCheckRequest request)
Parameters
Type Name Description
NoRippleCheckRequest request
Returns
Type Description
Task<NoRippleCheck>

An NoRippleCheckRequest response.
| Improve this Doc View Source

Ping(PingRequest)

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

Declaration
public Task<object> Ping(PingRequest request)
Parameters
Type Name Description
PingRequest request

An PingRequest request.
Returns
Type Description
Task<System.Object>
| Improve this Doc View Source

Random(RandomRequest)

The random command provides a random number to be used as a source of entropy for random number generation by clients.
https://xrpl.org/random.html#random

Declaration
public Task<object> Random(RandomRequest request)
Parameters
Type Name Description
RandomRequest request

An RandomRequest request.
Returns
Type Description
Task<System.Object>
| Improve this Doc View Source

Request(Dictionary<String, Object>)

Declaration
public Task<Dictionary<string, dynamic>> Request(Dictionary<string, dynamic> request)
Parameters
Type Name Description
Dictionary<System.String, System.Object> request
Returns
Type Description
Task<Dictionary<System.String, System.Object>>
| Improve this Doc View Source

ServerInfo(ServerInfoRequest)

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

Declaration
public Task<ServerInfo> ServerInfo(ServerInfoRequest request)
Parameters
Type Name Description
ServerInfoRequest request

An ServerInfoRequest request.
Returns
Type Description
Task<ServerInfo>

A ServerInfo(ServerInfoRequest) response.
| Improve this Doc View Source

Submit(Dictionary<String, Object>, XrplWallet)

Declaration
public Task<Submit> Submit(Dictionary<string, dynamic> tx, XrplWallet wallet)
Parameters
Type Name Description
Dictionary<System.String, System.Object> tx

Transaction in JSON format with an array of Signers.
To be successful, the weights of the signatures must be equal or higher than the quorum of the SignerList.
XrplWallet wallet
Returns
Type Description
Task<Submit>

An Submit response.
| Improve this Doc View Source

Submit(SubmitRequest)

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

Declaration
public Task<Submit> Submit(SubmitRequest request)
Parameters
Type Name Description
SubmitRequest request

An SubmitRequest request.
Returns
Type Description
Task<Submit>

An Submit response.
| Improve this Doc View Source

Subscribe(SubscribeRequest)

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

Declaration
public Task<object> Subscribe(SubscribeRequest request)
Parameters
Type Name Description
SubscribeRequest request

An SubscribeRequest request.
Returns
Type Description
Task<System.Object>
| Improve this Doc View Source

Tx(TxRequest)

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

Declaration
public Task<TransactionResponseCommon> Tx(TxRequest request)
Parameters
Type Name Description
TxRequest request

An TxRequest request.
Returns
Type Description
Task<TransactionResponseCommon>

An TransactionResponseCommon response.
| Improve this Doc View Source

Unsubscribe(UnsubscribeRequest)

The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions.

Declaration
public Task<object> Unsubscribe(UnsubscribeRequest request)
Parameters
Type Name Description
UnsubscribeRequest request

An UnsubscribeRequest request.
Returns
Type Description
Task<System.Object>

Events

| Improve this Doc View Source

OnConsensusPhase

Declaration
public event OnConsensusStreamResponse OnConsensusPhase
Event Type
Type Description
OnConsensusStreamResponse
| Improve this Doc View Source

OnError

Declaration
public event OnErrorResponse OnError
Event Type
Type Description
OnErrorResponse
| Improve this Doc View Source

OnLedgerClosed

Declaration
public event OnLedgerStreamResponse OnLedgerClosed
Event Type
Type Description
OnLedgerStreamResponse
| Improve this Doc View Source

OnPathFind

Declaration
public event OnPathFindStream OnPathFind
Event Type
Type Description
OnPathFindStream
| Improve this Doc View Source

OnPeerStatusChange

Declaration
public event OnPeerStatusStreamResponse OnPeerStatusChange
Event Type
Type Description
OnPeerStatusStreamResponse
| Improve this Doc View Source

OnResponse

Declaration
public event OnRippleResponse OnResponse
Event Type
Type Description
OnRippleResponse
| Improve this Doc View Source

OnTransaction

Declaration
public event OnTransactionStreamResponse OnTransaction
Event Type
Type Description
OnTransactionStreamResponse
| Improve this Doc View Source

OnValidation

Declaration
public event OnValidationsStreamResponse OnValidation
Event Type
Type Description
OnValidationsStreamResponse

Implements

IDisposable