ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 03:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #395 from jhaaaa/pub-method-land

Browse Source 
Fixes to Public Methods landing page
This commit is contained in:
Jennifer Hasegawa
2018-05-22 09:38:19 -07:00
committed by GitHub
parent 90e6c0900a faef6e393b
commit ed5c439e4f
2 changed files with 89 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
content/references/rippled-api/public-rippled-methods/public-rippled-methods.md
View File

@@ -1,47 +1,88 @@
# Public rippled Methods
Communicate directly with a `rippled` server using these public API methods.
Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server.
Public methods include operations such as checking the state of the ledger, finding a path to connecting users, and submitting a transaction, among others.
## List of Methods
Communicate directly with a `rippled` server using the following public API methods. Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server.
* [`account_currencies` - Get a list of currencies an account can send or receive](account_currencies.html)
* [`account_channels` - Get a list of payment channels where the account is the source of the channel](account_channels.html)
* [`account_info` - Get basic data about an account](account_info.html)
* [`account_lines` - Get info about an account's trust lines](account_lines.html)
* [`account_objects` - Get all ledger objects owned by an account](account_objects.html)
* [`account_offers` - Get info about an account's currency exchange offers](account_offers.html)
* [`account_tx` - Get info about an account's transactions](account_tx.html)
* [`book_offers` - Get info about offers to exchange two currencies](book_offers.html)
* [`channel_authorize` - Sign a claim for money from a payment channel](channel_authorize.html)
* [`channel_verify` - Check a payment channel claim's signature](channel_verify.html)
* [`fee` - Get information about transaction cost](fee.html)
* [`gateway_balances` - Calculate total amounts issued by an account](gateway_balances.html)
* [`ledger` - Get info about a ledger version](ledger.html)
* [`ledger_closed` - Get the latest closed ledger version](ledger_closed.html)
* [`ledger_current` - Get the current working ledger version](ledger_current.html)
* [`ledger_data` - Get the raw contents of a ledger version](ledger_data.html)
* [`ledger_entry` - Get one element from a ledger version](ledger_entry.html)
* [`noripple_check` - Get recommended changes to an account's DefaultRipple and NoRipple settings](noripple_check.html)
* [`path_find` - Find a path for a payment between two accounts and receive updates](path_find.html)
* [`ping` - Confirm connectivity with the server](ping.html)
* [`random` - Generate a random number](random.html)
* [`ripple_path_find` - Find a path for payment between two accounts, once](ripple_path_find.html)
* [`server_info` - Retrieve status of the server in human-readable format](server_info.html)
* [`server_state` - Retrieve status of the server in machine-readable format](server_state.html)
* [`sign` - Cryptographically sign a transaction](sign.html)
* [`sign_for` - Contribute to a multi-signature](sign_for.html)
* [`submit` - Send a transaction to the network](submit.html)
* [`submit_multisigned` - Send a multi-signed transaction to the network](submit_multisigned.html)
* [`subscribe` - Listen for updates about a particular subject](subscribe.html)
* [`transaction_entry` - Retrieve info about a transaction from a particular ledger version](transaction_entry.html)
* [`tx` - Retrieve info about a transaction from all the ledgers on hand](tx.html)
* [`tx_history` - Retrieve info about all recent transactions](tx_history.html)
* [`unsubscribe` - Stop listening for updates about a particular subject](unsubscribe.html)
## [Account Methods](account-methods.html)
An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.
* **[`account_channels`](account_channels.html)** - Get a list of payment channels where the account is the source of the channel.
* **[`account_currencies`](account_currencies.html)** - Get a list of currencies an account can send or receive.
* **[`account_info`](account_info.html)** - Get basic data about an account.
* **[`account_lines`](account_lines.html)** - Get info about an account's trust lines.
* **[`account_objects`](account_objects.html)** - Get all ledger objects owned by an account.
* **[`account_offers`](account_offers.html)** - Get info about an account's currency exchange offers.
* **[`account_tx`](account_tx.html)** - Get inf about an account's transactions.
* **[`gateway_balances`](gateway_balances.html)** - Calculate total amounts issued by an account.
* **[`noripple_check`](noripple_check.html)** - Get recommended changes to an account's DefaultRipple and NoRipple settings.
## [Ledger Methods](ledger-methods.html)
A ledger version contains a header, a transaction tree, and a state tree, which contain account settings, trustlines, balances, transactions, and other data. Use these methods to retrieve ledger info.
* **[`ledger`](ledger.html)** - Get info about a ledger version.
* **[`ledger_closed`](ledger_closed.html)** - Get the latest closed ledger version.
* **[`ledger_current`](ledger_current.html)** - Get the current working ledger version.
* **[`ledger_data`](ledger_data.html)** - Get the raw contents of a ledger version.
* **[`ledger_entry`](ledger_entry.html)** - Get one element from a ledger version.
## [Transaction Methods](transaction-methods.html)
Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.
* **[`sign`](sign.html)** - Cryptographically sign a transaction.
* **[`sign_for`](sign_for.html)** - Contribute to a multi-signature.
* **[`submit`](submit.html)** - Send a transaction to the network.
* **[`submit_multisigned`](submit_multisigned.html)** - Send a multi-signed transaction to the network.
* **[`transaction_entry`](transaction_entry.html)** - Retrieve info about a transaction from a particular ledger version.
* **[`tx`](tx.html)** - Retrieve info about a transaction from all the ledgers on hand.
* **[`tx_history`](tx_history.html)** - Retrieve info about all recent transactions.
## [Path and Order Book Methods](path-and-order-book-methods.html)
Paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books. Use these methods to work with paths and other books.
* **[`book_offers`](book_offers.html)** - Get info about offers to exchange two currencies.
* **[`path_find`](path_find.html)** - Find a path for a payment between two accounts and receive updates.
* **[`ripple_path_find`](ripple_path_find.html)** - Find a path for payment between two accounts, once.
## [Payment Channel Methods](payment-channel-methods.html)
Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.
* **[`channel_authorize`](channel_authorize.html)** - Sign a claim for money from a payment channel.
* **[`channel_verify`](channel_verify.html)** - Check a payment channel claim's signature.
## [Subscription Methods](subscription-methods.html)
Use these methods to enable the server to push updates to your client when various events happen, so that you can know and react right away. _WebSocket API only._
* **[`subscribe`](subscribe.html)** - Listen for updates about a particular subject.
* **[`unsubscribe`](unsubscribe.html)** - Stop listening for updates about a particular subject.
## [Server Info Methods](server-info-methods.html)
Use these methods to retrieve information about the current state of the `rippled` server.
* **[`fee`](fee.html)** - Get information about transaction cost.
* **[`server_info`](server_info.html)** - Retrieve status of the server in human-readable format.
* **[`server_state`](server_state.html)** - Retrieve status of the server in machine-readable format.
## [Utility Methods](utility-methods.html)
Use these methods to perform convenient tasks, such as ping and random number generation.
* **[`json`](json.html)** - Use as a proxy to running other commands. Accepts the parameters for the command as a JSON value. _Commandline only._
* **[`ping`](ping.html)** - Confirm connectivity with the server.
* **[`random`](random.html)** - Generate a random number.
## Deprecated Methods

17
dactyl-config.yml
View File

@@ -1025,7 +1025,6 @@ pages:
supercategory: rippled API
category: Public rippled Methods
blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
template: template-landing-children.html
targets:
- local
@@ -1036,8 +1035,8 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: An Account in the XRP Ledger represents a holder of XRP and a sender of transactions. Accounts can send and receive XRP and issued assets, participate in the decentralized exchange, and change their own settings. Creating an account involves generating keys and then receiving XRP from another account.
template: template-landing-children.html
blurb: An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.
targets:
- local
@@ -1147,7 +1146,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Each rippled server keeps a complete copy of the XRP Ledger's current state, which contains all the accounts, transactions, offers, and other data in the network in an optimized tree format. As transactions and offers are proposed, each server incorporates them into its current copy of the ledger, closes it periodically, and (if configured) participates in advancing the globally-validated version. After the network reaches consensus, that ledger version is validated and becomes permanently immutable. Any transactions that were not included in one ledger version become candidates to be included in the next validated version.
blurb: A ledger version contains a header, a transaction tree, and a state tree, which contain account settings, trustlines, balances, transactions, and other data. Use these methods to retrieve ledger info.
template: template-landing-children.html
targets:
- local
@@ -1215,7 +1214,7 @@ pages:
category: Public rippled Methods
subcategory: Transaction Methods
template: template-landing-children.html
blurb: Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions, which include not only payments, but also currency-exchange offers, account settings, and changes to the properties of the ledger itself (like adopting new features).
blurb: Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.
targets:
- local
@@ -1303,7 +1302,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Path and Order Book Methods
blurb: In the XRP Ledger, paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books.
blurb: Paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books. Use these methods to work with paths and other books.
template: template-landing-children.html
targets:
- local
@@ -1348,7 +1347,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Payment Channel Methods
blurb: Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Learn about methods that work on payment channels.
blurb: Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.
template: template-landing-children.html
targets:
- local
@@ -1382,7 +1381,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Subscription Methods
blurb: Using subscriptions, you can have the server push updates to your client when various events happen, so that you can know and react right away. Subscriptions are only supported in the WebSocket API, where you can receive additional responses in the same channel. JSON-RPC support for subscription callbacks is deprecated and may not work as expected.
blurb: Use these methods to enable the server to push updates to your client when various events happen, so that you can know and react right away. WebSocket API only.
template: template-landing-children.html
targets:
- local
@@ -1416,7 +1415,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Server Info Methods
blurb: Learn about methods that enable you to retrieve information about the current state of the rippled server. These may be useful for monitoring the health of the server, or in preparing to make requests to other API methods.
blurb: Use these methods to retrieve information about the current state of the rippled server.
template: template-landing-children.html
targets:
- local
@@ -1461,7 +1460,7 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Utility Methods
blurb: Learn about methods that provide convenient functions, such as ping and a random number generator.
blurb: Use these methods to perform convenient tasks, such as ping and random number generation.
template: template-landing-children.html
targets:
- local