diff --git a/_api-examples/path_find/create-followup.json b/_api-examples/path_find/create-followup.json new file mode 100644 index 00000000000..764c2de1627 --- /dev/null +++ b/_api-examples/path_find/create-followup.json @@ -0,0 +1,15 @@ +{ + "alternatives": [ + // ... paths omitted from this example; same format as the initial response ... + ], + "destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "destination_amount": { + "currency": "USD", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0.001" + }, + "full_reply": true, + "id": 8, + "source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "type": "path_find" +} diff --git a/_api-examples/path_find/create-response.json b/_api-examples/path_find/create-response.json new file mode 100644 index 00000000000..7104ce6f5a2 --- /dev/null +++ b/_api-examples/path_find/create-response.json @@ -0,0 +1,75 @@ +{ + "id": 8, + "result": { + "alternatives": [ + { + "paths_computed": [ + [ + { + "currency": "USD", + "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", + "type": 48 + }, + { + "account": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", + "type": 1 + }, + { + "account": "rLzpfEnrB2Ro2LtaGd6Af7znRqGxULc4rW", + "type": 1 + } + ], + [ + { + "currency": "USD", + "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", + "type": 48 + }, + { + "account": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", + "type": 1 + }, + { + "account": "rQhbp2h133vD3TJGWkNY5zePHKQUq6vSVm", + "type": 1 + } + ], + [ + { + "currency": "USD", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "type": 48 + } + ], + [ + { + "currency": "USD", + "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq", + "type": 48 + }, + { + "account": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq", + "type": 1 + }, + { + "account": "r4cjaKtZqP2GDjwK3eT9qua4Hqk9Zk2kSy", + "type": 1 + } + ] + ], + "source_amount": "390" + } + ], + "destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "destination_amount": { + "currency": "USD", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0.001" + }, + "full_reply": false, + "id": 8, + "source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" + }, + "status": "success", + "type": "response" +} diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md index 14085db5ddd..7d00b236bf7 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md @@ -7,7 +7,7 @@ labels: - Tokens --- # account_currencies -[[Source]](https://github.com/XRPLF/rippled/blob/df966a9ac6dd986585ecccb206aff24452e41a30/src/ripple/rpc/handlers/AccountCurrencies.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountCurrenciesHandler.cpp "Source") The `account_currencies` command retrieves a list of currencies that an account can send or receive, based on its trust lines. (This is not a thoroughly confirmed list, but it can be used to populate user interfaces.) diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md index e1bf1bd9d5c..7d24e35ddc1 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md @@ -6,7 +6,7 @@ labels: - XRP --- # account_info -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountInfo.cpp "Source") The `account_info` command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger. diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md index c1464a7b591..cdfa9bfde08 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md @@ -1,13 +1,11 @@ --- -html: account_nfts.html -parent: account-methods.html seo: description: Get a list of all NFTs for an account. labels: - - Non-fungible Tokens, NFTs + - Non-fungible Tokens, NFTs --- # account_nfts -[[Source]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountObjects.cpp "Source") The `account_nfts` method returns a list of `NFToken` objects for the specified account. diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md index c866fef3ebf..5157ef191a9 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md @@ -7,7 +7,7 @@ labels: - Decentralized Exchange --- # account_offers -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountOffers.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountOffers.cpp "Source") The `account_offers` method retrieves a list of [offers](../../../../concepts/tokens/decentralized-exchange/offers.md) made by a given [account](../../../../concepts/accounts/index.md) that are outstanding as of a particular [ledger version](../../../../concepts/ledgers/index.md). diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md index 8b2aafa4e2e..1f09102c5e8 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md @@ -1,14 +1,12 @@ --- -html: account_tx.html -parent: account-methods.html seo: description: Get a list of transactions affecting an account. labels: - - Payments - - Accounts + - Payments + - Accounts --- # account_tx -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountTx.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountTx.cpp "Source") The `account_tx` method retrieves a list of validated transactions that involve a given account. diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md index 1717b0f7622..a989c87ac56 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md @@ -1,6 +1,4 @@ --- -html: gateway_balances.html -parent: account-methods.html seo: description: Calculate total amounts issued by an account. labels: @@ -8,7 +6,7 @@ labels: - Accounts --- # gateway_balances -[[Source]](https://github.com/XRPLF/rippled/blob/9111ad1a9dc37d49d085aa317712625e635197c0/src/ripple/rpc/handlers/GatewayBalances.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/GatewayBalances.cpp "Source") The `gateway_balances` command calculates the total balances issued by a given account, optionally excluding amounts held by [operational addresses](../../../../concepts/accounts/account-types.md). diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md index bc796c55079..e275b0029bb 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md @@ -1,13 +1,11 @@ --- -html: noripple_check.html -parent: account-methods.html seo: description: Get recommended changes to an account's Default Ripple and No Ripple settings. labels: - - Tokens + - Tokens --- # noripple_check -[[Source]](https://github.com/XRPLF/rippled/blob/9111ad1a9dc37d49d085aa317712625e635197c0/src/ripple/rpc/handlers/NoRippleCheck.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/NoRippleCheck.cpp "Source") 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](../../../../concepts/tokens/fungible-tokens/rippling.md), compared with the recommended settings. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md index 56f708d56b8..6d7c2bbb7e8 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md @@ -1,13 +1,11 @@ --- -html: ledger.html # Watch carefully for clashes w/ this filename -parent: ledger-methods.html seo: description: Get info about a ledger version. labels: - - Blockchain + - Blockchain --- # ledger -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerHandler.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerHandler.cpp "Source") Retrieve information about the public [ledger](../../../../concepts/ledgers/index.md). diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md index 01b489f67fb..508710343f8 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md @@ -1,13 +1,11 @@ --- -html: ledger_closed.html -parent: ledger-methods.html seo: description: Get the latest closed ledger version. labels: - - Blockchain + - Blockchain --- # ledger_closed -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerClosed.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerClosed.cpp "Source") The `ledger_closed` method returns the unique identifiers of the most recently closed ledger. (This ledger is not necessarily validated and immutable yet.) diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md index 546a92b4171..29a6a1bde1c 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md @@ -1,13 +1,11 @@ --- -html: ledger_current.html -parent: ledger-methods.html seo: description: Get the current working ledger version. labels: - - Blockchain + - Blockchain --- # ledger_current -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerCurrent.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerCurrent.cpp "Source") The `ledger_current` method returns the unique identifiers of the current in-progress [ledger](../../../../concepts/ledgers/index.md). This command is mostly useful for testing, because the ledger returned is still in flux. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md index d9772533cc9..03ccf148378 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md @@ -1,14 +1,12 @@ --- -html: ledger_data.html -parent: ledger-methods.html seo: description: Get the raw contents of a ledger version. labels: - - Blockchain - - Data Retention + - Blockchain + - Data Retention --- # ledger_data -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerData.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerData.cpp "Source") 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. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index 02f61582fb5..0b29c4b2fef 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -1,14 +1,12 @@ --- -html: ledger_entry.html -parent: ledger-methods.html seo: description: Get one element from a ledger version. labels: - - Blockchain - - Data Retention + - Blockchain + - Data Retention --- # ledger_entry -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerEntry.cpp "Source") The `ledger_entry` method returns a single ledger entry from the XRP Ledger in its raw format. See [ledger format][] for information on the different types of entries you can retrieve. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index 70aa9b392c8..77e2b1e584c 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -1,15 +1,13 @@ --- -html: amm_info.html -parent: path-and-order-book-methods.html seo: description: Get info about an Automated Market Maker (AMM) instance. labels: - - Decentralized Exchange - - Cross-Currency - - AMM + - Decentralized Exchange + - Cross-Currency + - AMM --- # amm_info -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AMMInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AMMInfo.cpp "Source") The {% code-page-name /%} method gets information about an [Automated Market Maker (AMM)](/docs/concepts/tokens/decentralized-exchange/automated-market-makers) instance. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md index d1511a01219..c6fbbb5dd57 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md @@ -2,11 +2,11 @@ seo: description: Get information on order book changes labels: - - Decentralized Exchange - - Cross-Currency + - Decentralized Exchange + - Cross-Currency --- # book_changes -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/BookChanges.h "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/BookChanges.h "Source") The {% code-page-name /%} method reports information about changes to the order books in the [decentralized exchange (DEX)](../../../../concepts/tokens/decentralized-exchange/index.md) compared with the previous ledger version. This may be useful for building "candlestick" charts. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md index bb2118faf08..71bd5b879bd 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md @@ -2,11 +2,11 @@ seo: description: Get info about offers to exchange two currencies. labels: - - Decentralized Exchange - - Cross-Currency + - Decentralized Exchange + - Cross-Currency --- # book_offers -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/BookOffers.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/BookOffers.cpp "Source") The `book_offers` method retrieves a list of [offers](../../../../concepts/tokens/decentralized-exchange/offers.md) between two currencies, also known as an _order book_. The response omits [unfunded offers](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) and reports how much of each remaining offer's total is currently funded. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/deposit_authorized.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/deposit_authorized.md index 2f62caabc54..d84d998d736 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/deposit_authorized.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/deposit_authorized.md @@ -2,11 +2,11 @@ seo: description: Check whether an account is authorized to send money directly to another. labels: - - Accounts - - Security + - Accounts + - Security --- # deposit_authorized -[[Source]](https://github.com/XRPLF/rippled/blob/817d2339b8632cb2f97d3edd6f7af33aa7631744/src/ripple/rpc/handlers/DepositAuthorized.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/DepositAuthorized.cpp "Source") The `deposit_authorized` command indicates whether one account is authorized to send payments directly to another. See [Deposit Authorization](../../../../concepts/accounts/depositauth.md) for information on how to require authorization to deliver money to your account. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index 5f02d57360a..2b9fc23fc87 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -5,7 +5,7 @@ labels: - Oracle --- # get_aggregate_price -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/GetAggregatePrice.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/GetAggregatePrice.cpp "Source") The `get_aggregate_price` method retrieves the aggregate price of specified `Oracle` objects, returning three price statistics: mean, median, and trimmed mean. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md index 9c76231efbb..ba241611a9e 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md @@ -1,13 +1,11 @@ --- -html: nft_buy_offers.html -parent: path-and-order-book-methods.html seo: description: Get a list of all buy offers for a NFToken. labels: - - Non-fungible Tokens, NFTs, NFTokens + - NFTs --- # nft_buy_offers -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/NFTOffers.cpp "Source") The `nft_buy_offers` method returns a list of buy offers for a given [NFToken][] object. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md index f84a15e7885..bae010520bc 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md @@ -1,13 +1,11 @@ --- -html: nft_sell_offers.html -parent: path-and-order-book-methods.html seo: description: Get a list of all sell offers for a NFToken. labels: - - Non-fungible Tokens, NFTs, NFTokens + - NFTs --- # nft_sell_offers -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/NFTOffers.cpp "Source") The `nft_sell_offers` method returns a list of sell offers for a given [NFToken][] object. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md index c572fbc25f9..9a75c19d0c1 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md @@ -1,14 +1,12 @@ --- -html: path_find.html -parent: path-and-order-book-methods.html seo: description: Find a path for a payment between two accounts and receive updates. labels: - - Cross-Currency - - Tokens + - Cross-Currency + - Tokens --- # path_find -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/PathFind.cpp "Source") *WebSocket API only!* The `path_find` method searches for a [path](../../../../concepts/tokens/fungible-tokens/paths.md) 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. @@ -21,7 +19,6 @@ There are three different modes, or sub-commands, of the path_find command. Spec 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.) ## path_find create -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source") The `create` sub-command of `path_find` creates an ongoing request to find possible paths along which a payment transaction could be made from one specified account such that another account receives a desired amount of some currency. The initial response contains a suggested path between the two addresses that would result in the desired amount being received. After that, the server sends additional messages, with `"type": "path_find"`, with updates to the potential paths. The frequency of updates is left to the discretion of the server, but it usually means once every few seconds when there is a new ledger version. @@ -62,9 +59,8 @@ The request includes the following parameters: | `destination_account` | String - [Address][] | Yes | The account to find a path to. (In other words, the account that would receive a payment.) | | `destination_amount` | [Currency Amount][] | Yes | How much the destination account would receive. **Special case:** You can specify `"-1"` (for XRP) or provide -1 as the contents of the `value` field (for tokens). This requests a path to deliver as much as possible, while spending no more than the amount specified in `send_max` (if provided). | | `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, only return paths that use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). {% amendment-disclaimer name="PermissionedDEX" /%} | -| `paths` | Array | No | Array of arrays of objects, representing [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) to check. -| `send_max` | [Currency Amount][] | No | Maximum amount that would be spent. Not compatible with `source_currencies`. | -You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path. | +| `paths` | Array | No | Array of arrays of objects, representing [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path. | +| `send_max` | [Currency Amount][] | No | Maximum amount that would be spent. Not compatible with `source_currencies`. | The server also recognizes the following fields, but the results of using them are not guaranteed: `source_currencies`, `bridges`. These fields should be considered reserved for future use. @@ -75,392 +71,28 @@ An example of a successful response: {% tabs %} {% tab label="WebSocket" %} -```json -{ - "id": 1, - "status": "success", - "type": "response", - "result": { - "alternatives": [ - { - "paths_computed": [ - [ - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "currency": "USD", - "issuer": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "currency": "USD", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": "251686" - }, - { - "paths_computed": [ - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "BTC", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.000001541291269274307" - } - }, - { - "paths_computed": [ - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "CHF", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.0009211546262510451" - } - }, - { - "paths_computed": [ - [ - { - "account": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "CNY", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.006293562" - } - }, - { - "paths_computed": [ - [ - { - "account": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "DYM", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.0007157142857142858" - } - }, - { - "paths_computed": [ - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ], - [ - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "EUR", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.0007409623616236163" - } - }, - { - "paths_computed": [ - [ - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - }, - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 48, - "type_hex": "0000000000000030" - }, - { - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "type": 1, - "type_hex": "0000000000000001" - } - ] - ], - "source_amount": { - "currency": "JPY", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0.103412412" - } - } - ], - "destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "destination_amount": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.001" - }, - "id": 1, - "source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "full_reply": false - } -} -``` +{% code-snippet file="/_api-examples/path_find/create-response.json" /%} {% /tab %} {% /tabs %} The initial response follows the [standard format](../../api-conventions/response-formatting.md), with a successful result containing the following fields: -| Field | Type | Description | -|:----------------------|:-----------------|:----------------------------------| -| `alternatives` | Array | Array of objects with suggested [paths](../../../../concepts/tokens/fungible-tokens/paths.md) to take, as described below. If empty, then no paths were found connecting the source and destination accounts. | -| `destination_account` | String | Unique address of the account that would receive a transaction. | -| `destination_amount` | String or Object | [Currency Amount][] that the destination would receive in a transaction. | -| `source_account` | String | Unique address that would send a transaction. | -| `full_reply` | Boolean | If `false`, this is the result of an incomplete search. A later reply may have a better path. If `true`, then this is the best path found. (It is still theoretically possible that a better path could exist, but `rippled` won't find it.) Until you close the pathfinding request, `rippled` continues to send updates each time a new ledger closes. | +| Field | Type | Description | +|:----------------------|:---------------------|:----------------------------------| +| `alternatives` | Array | Array of objects with suggested [paths](../../../../concepts/tokens/fungible-tokens/paths.md) to take, as described below. If empty, then no paths were found connecting the source and destination accounts. | +| `destination_account` | String - [Address][] | The account that would receive a transaction. | +| `destination_amount` | [Currency Amount][] | How much the destination would receive in a transaction. | +| `source_account` | String - [Address][] | The account that would send a transaction. | +| `full_reply` | Boolean | If `false`, this is the result of an incomplete search. A later reply may have a better path. If `true`, then this is the best path found. (It is still theoretically possible that a better path could exist, but `rippled` won't find it.) Until you close the pathfinding request, `rippled` continues to send updates each time a new ledger closes. | Each element in the `alternatives` array is an object that represents a path from one possible source currency (held by the initiating account) to the destination account and currency. This object has the following fields: -| Field | Type | Description | -|:---------------------|:-----------------|:---------------------------------------| -| `paths_computed` | Array | Array of arrays of objects defining [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) | -| `source_amount` | String or Object | [Currency Amount][] that the source would have to send along this path for the destination to receive the desired amount. | -| `destination_amount` | String or Object | _(May be omitted)_ [Currency Amount][] that the destination would receive along this path. Only included if the `destination_amount` from the request was the "-1" special case. | +| Field | Type | Description | +|:---------------------|:--------------------|:---------------------------------------| +| `paths_computed` | Array | Array of arrays of objects defining [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) | +| `source_amount` | [Currency Amount][] | How much the source would have to send along this path for the destination to receive the desired amount. | +| `destination_amount` | [Currency Amount][] | _(May be omitted)_ How much the destination would receive along this path. Only included if the `destination_amount` from the request was the "-1" special case. | ### Possible Errors @@ -479,28 +111,12 @@ Here is an example of an asynchronous follow-up from a path_find create request: {% tabs %} {% tab label="WebSocket" %} -```json -{ - "id": 1, - "type": "path_find", - "alternatives": [ - /* paths omitted from this example; same format as the initial response */ - ], - "destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "destination_amount": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.001" - }, - "source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" -} -``` +{% code-snippet file="/_api-examples/path_find/create-followup.json" /%} {% /tab %} {% /tabs %} ## path_find close -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source") The `close` sub-command of `path_find` instructs the server to stop sending information about the current open pathfinding request. @@ -545,7 +161,6 @@ If there was no outstanding pathfinding request, an error is returned instead. * `noPathRequest` - You tried to close a pathfinding request when there is not an open one. ## path_find status -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L69-L77 "Source") The `status` sub-command of `path_find` requests an immediate update about the client's currently-open pathfinding request. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md index 059fcfa81be..df709995c69 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md @@ -1,14 +1,12 @@ --- -html: ripple_path_find.html -parent: path-and-order-book-methods.html seo: description: Find a path for payment between two accounts, once. labels: - - Cross-Currency - - Tokens + - Cross-Currency + - Tokens --- # ripple_path_find -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/RipplePathFind.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/RipplePathFind.cpp "Source") The `ripple_path_find` method is a simplified version of the [path_find method][] that provides a single response with a [payment path](../../../../concepts/tokens/fungible-tokens/paths.md) 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. diff --git a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md index ca57ebbe4a3..99d9d5d6784 100644 --- a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md +++ b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md @@ -2,13 +2,15 @@ seo: description: Sign a claim for money from a payment channel. labels: - - Payment Channels + - Payment Channels --- # channel_authorize -[[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L41 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/PayChanClaim.cpp "Source") The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP from a payment channel. +{% partial file="/docs/_snippets/public-signing-note.md" /%} + {% amendment-disclaimer name="PayChan" /%} ## Request Format diff --git a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md index 542a965f79c..0393aaae36b 100644 --- a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md +++ b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md @@ -1,13 +1,11 @@ --- -html: channel_verify.html -parent: payment-channel-methods.html seo: description: Check a payment channel claim's signature. labels: - - Payment Channels + - Payment Channels --- # channel_verify -[[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L89 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/PayChanClaim.cpp "Source") The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md index b36c6059cb2..1ed12fc9da8 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md @@ -1,13 +1,11 @@ --- -html: fee.html -parent: server-info-methods.html seo: description: Get information about transaction cost. labels: - - Fees + - Fees --- # fee -[[Source]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/Fee1.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Fee1.cpp "Source") The `fee` command reports the current state of the open-ledger requirements for the [transaction cost](../../../../concepts/transactions/transaction-cost.md). This requires the [FeeEscalation amendment][] to be enabled. diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md index d6dc5e415aa..b236101de8e 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md @@ -2,10 +2,10 @@ seo: description: Look up the public information about a known validator. labels: - - Blockchain + - Blockchain --- # manifest -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Manifest.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/DoManifest.cpp "Source") The {% code-page-name /%} method reports the current "manifest" information for a given validator public key. The "manifest" is a block of data that authorizes an ephemeral signing key with a signature from the validator's master key pair. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %} diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md index 5a9ef274e40..46519bfc14e 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md @@ -1,13 +1,11 @@ --- -html: server_info.html -parent: server-info-methods.html seo: description: Retrieve status of the server in human-readable format. labels: - - Core Server + - Core Server --- # server_info (rippled) -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ServerInfo.cpp "Source") The `server_info` command asks the server for a human-readable version of various information about [the `rippled` server](../../../../concepts/networks-and-servers/index.md) being queried. For [Clio servers](../../../../concepts/networks-and-servers/the-clio-server.md), see [`server_info` (Clio)](../clio-methods/server_info-clio.md) instead. diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md index 7115b6c7f2e..54bd29a603a 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md @@ -1,14 +1,12 @@ --- -html: server_state.html -parent: server-info-methods.html seo: description: Retrieve status of the server in machine-readable format. labels: - - Core Server + - Core Server --- # server_state -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerState.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ServerState.cpp "Source") 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.) diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md index d7e1d9de866..7b4bd4827eb 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md @@ -2,11 +2,11 @@ seo: description: Retrieve API version information. labels: - - Core Server + - Core Server --- # version -[[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/beast/core/SemanticVersion.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Version.h "Source") The `version` command retrieves the API version information for the rippled server. For `Clio` servers, see [`version` (`clio`)](../clio-methods/version.md) instead. diff --git a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md index 0b0a7eafd88..2e63c44f4e3 100644 --- a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md +++ b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md @@ -1,17 +1,15 @@ --- -html: unsubscribe.html -parent: subscription-methods.html seo: description: Stop listening for updates about a particular subject. labels: - - Payments - - Blockchain - - Accounts - - Smart Contracts + - Payments + - Blockchain + - Accounts + - Smart Contracts --- # unsubscribe -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Unsubscribe.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Unsubscribe.cpp "Source") The `unsubscribe` command tells the server to stop sending messages for a particular subscription or set of subscriptions. diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md index 0a0aaf7aed6..b8c036f3ab2 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md @@ -1,14 +1,12 @@ --- -html: submit.html -parent: transaction-methods.html seo: description: Send a transaction to the network. labels: - - Transaction Sending - - Payments + - Transaction Sending + - Payments --- # submit -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Submit.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Submit.cpp "Source") The `submit` method applies a [transaction](../../../protocol/transactions/index.md) and sends it to the network to be confirmed and included in future ledgers. diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit_multisigned.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit_multisigned.md index f27c0c3607b..72b5ba88f03 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit_multisigned.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit_multisigned.md @@ -1,18 +1,14 @@ --- -html: submit_multisigned.html -parent: transaction-methods.html seo: description: Send a multi-signed transaction to the network. labels: - - Transaction Sending + - Transaction Sending --- # submit_multisigned -[[Source]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/SubmitMultiSigned.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/SubmitMultiSigned.cpp "Source") The `submit_multisigned` command applies a [multi-signed](../../../../concepts/accounts/multi-signing.md) transaction and sends it to the network to be included in future ledgers. (You can also submit multi-signed transactions in binary form using the [`submit` command in submit-only mode](submit.md#submit-only-mode).) -This command requires the [MultiSign amendment][] to be enabled. - ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md index 5b6cee92b19..202ef236d4a 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md @@ -1,13 +1,11 @@ --- -html: transaction_entry.html -parent: transaction-methods.html seo: description: Retrieve info about a transaction from a particular ledger version. labels: - - Transaction Sending + - Transaction Sending --- # transaction_entry -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/TransactionEntry.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/TransactionEntry.cpp "Source") 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.) diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md index a5835af244b..307b50d332c 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md @@ -1,15 +1,13 @@ --- -html: tx.html -parent: transaction-methods.html seo: description: Retrieve info about a transaction from all the ledgers on hand. labels: - - Transaction Sending - - Payments + - Transaction Sending + - Payments --- # tx -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Tx.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Tx.cpp "Source") The `tx` method retrieves information on a single [transaction](../../../protocol/transactions/index.md), by its [identifying hash][] or its [CTID](../../api-conventions/ctid.md). diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md index e17c527c61f..c5fa6681ad7 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md @@ -1,11 +1,9 @@ --- -html: tx_history.html -parent: transaction-methods.html seo: description: Retrieve info about all recent transactions. --- # tx_history -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/TxHistory.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/TxHistory.cpp "Source") The `tx_history` method retrieves some of the most recent transactions made. diff --git a/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md b/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md index c790915926c..b8039ba000d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md +++ b/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md @@ -1,13 +1,11 @@ --- -html: ping.html -parent: utility-methods.html seo: description: Confirm connectivity with the server. labels: - - Core Server + - Core Server --- # ping -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Ping.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Ping.cpp "Source") The `ping` command returns an acknowledgement, so that clients can test the connection status and latency. diff --git a/docs/references/http-websocket-apis/public-api-methods/utility-methods/random.md b/docs/references/http-websocket-apis/public-api-methods/utility-methods/random.md index 77672631ac3..353b7833b1d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/utility-methods/random.md +++ b/docs/references/http-websocket-apis/public-api-methods/utility-methods/random.md @@ -1,14 +1,12 @@ --- -html: random.html -parent: utility-methods.html seo: description: Generate a random number. labels: - - Core Server + - Core Server --- # random -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Random.cpp "Source") The `random` command provides a random number to be used as a source of entropy for random number generation by clients.