RPCPathFind class
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. 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. Due to server load, pathfinding may not find the best results. Additionally, you should be careful with the pathfinding results from untrusted servers. A server could be modified to return less-than-optimal paths to earn money for its operators. If you do not have your own server that you can trust with pathfinding, you should compare the results of pathfinding from multiple servers run by different parties, to minimize the risk of a single server returning poor results. (Note: A server returning less-than-optimal results is not necessarily proof of malicious behavior; it could also be a symptom of heavy server load.)
- Inheritance
-
- Object
- LookupByLedgerRequest
- XRPLedgerRequest<
Map< String, dynamic> > - RPCPathFind
Constructors
-
RPCPathFind.new({required PathFindSubcommand subcommand, required String sourceAccount, required String destinationAccount, required CurrencyAmount destinationAmount, CurrencyAmount? sendMax, List<
List< ? paths})PathStep> >
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
-
paths
→ List<
List< ?PathStep> > -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sendMax → CurrencyAmount?
-
final
- sourceAccount → String
-
final
- subcommand → PathFindSubcommand
-
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) → Map<String, dynamic> -
Handles the response received from the RPC call.
inherited
-
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