RPCRipplePathFind class
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. Although the rippled server tries to find the cheapest path or combination of paths for making a payment, it is not guaranteed that the paths returned by this method are, in fact, the best paths.
- Inheritance
-
- Object
- LookupByLedgerRequest
- XRPLedgerRequest<
RipplePathFound> - RPCRipplePathFind
Constructors
-
RPCRipplePathFind.new({required String sourceAccount, required String destinationAccount, required CurrencyAmount destinationAmount, CurrencyAmount? sendMax, List<
XRPCurrencies> ? sourceCurrencies, XRPLLedgerIndex? ledgerIndex = XRPLLedgerIndex.validated})
Properties
- destinationAccount → String
-
final
- destinationAmount → CurrencyAmount
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- ledgerIndex → XRPLLedgerIndex?
-
The ledger index for the lookup.
finalinherited
- method → String
-
The RPC method associated with the request.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sendMax → CurrencyAmount?
-
final
- sourceAccount → String
-
final
-
sourceCurrencies
→ List<
XRPCurrencies> ? -
final
- validate → String?
-
Gets the validation status for the request (default is null == params is valid).
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onResonse(
Map< String, dynamic> result) → RipplePathFound -
Handles the response received from the RPC call.
override
-
toJson(
) → Map< String, dynamic> -
Converts the request to JSON representation.
override
-
toRequest(
int requestId) → RPCRequestDetails -
Converts the request to an RPCRequestDetails object.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited