Merge pull request #2215 from XRPLF/place_indexes

Add index md files
This commit is contained in:
Rome Reginelli
2023-10-18 13:44:23 -07:00
committed by GitHub
105 changed files with 1007 additions and 503 deletions

View File

@@ -0,0 +1,8 @@
---
html: key-generation-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Key Generation Methods
Use these methods to generate and manage keys.

View File

@@ -0,0 +1,8 @@
---
html: logging-and-data-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Logging and Data Management Methods
Use these methods to manage log levels and other data, such as ledgers.

View File

@@ -0,0 +1,8 @@
---
html: peer-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Peer Management Methods
Use these methods to manage your server's peer-to-peer connections.

View File

@@ -0,0 +1,8 @@
---
html: server-control-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Server Control Methods
Use these methods to manage the rippled server.

View File

@@ -7,6 +7,7 @@ labels:
- Core Server
---
# validation_seed
[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source")
The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server. [Disabled since: rippled 0.29.1](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")

View File

@@ -0,0 +1,8 @@
---
html: signing-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Signing Methods
Use these methods to work with transactions.

View File

@@ -0,0 +1,8 @@
---
html: status-and-debugging-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Status and Debugging Methods
Use these methods to check the status of the network and server.

View File

@@ -0,0 +1,8 @@
---
html: http-websocket-apis.html
parent: references.html
template: pagetype-category.html.jinja
---
# HTTP / WebSocket APIs
Communicate directly with rippled, the core peer-to-peer server that manages the XRP Ledger.

View File

@@ -0,0 +1,11 @@
---
html: peer-port-methods.html
parent: http-websocket-apis.html
template: pagetype-category.html.jinja
blurb: Special API methods for sharing network topology and status metrics, served on the XRPL Peer Protocol port.
---
# Peer Port Methods
Separate from the [WebSocket / HTTP APIs](http-websocket-apis.html), `rippled` servers provide a few special API methods from the same port they use for XRP Ledger [peer protocol](peer-protocol.html) communications. These methods provide status information about the server itself and its connectivity to the peer-to-peer network, and are intended mainly for monitoring and administration.
**Security:** Most `rippled` servers use a self-signed TLS certificate to respond to peer port requests. By default, most tools (including web browsers) flag or block such responses for being untrusted. You must ignore the certificate checking (for example, if using cURL, add the `--insecure` flag) to display a response from those servers, or configure the server with a TLS certificate signed by a known Certificate Authority.

View File

@@ -0,0 +1,8 @@
---
html: account-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Account Methods
An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.

View File

@@ -0,0 +1,8 @@
---
html: clio-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Clio Server
Use these methods to retrieve information using Clio server APIs.

View File

@@ -0,0 +1,8 @@
---
html: ledger-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Ledger Methods
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.

View File

@@ -0,0 +1,8 @@
---
html: path-and-order-book-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Path and Order Book Methods
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.

View File

@@ -0,0 +1,8 @@
---
html: payment-channel-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Payment Channel Methods
Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.

View File

@@ -0,0 +1,8 @@
---
html: server-info-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Server Info Methods
Use these methods to retrieve information about the current state of the rippled server.

View File

@@ -6,6 +6,7 @@ labels:
- Core Server
---
# server_state
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/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.)

View File

@@ -0,0 +1,8 @@
---
html: subscription-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Subscription Methods
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.

View File

@@ -9,6 +9,7 @@ labels:
- Smart Contracts
---
# unsubscribe
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Unsubscribe.cpp "Source")
The `unsubscribe` command tells the server to stop sending messages for a particular subscription or set of subscriptions.

View File

@@ -0,0 +1,8 @@
---
html: transaction-methods.html # watch for clashes w/ this filename
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Transaction Methods
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.

View File

@@ -7,6 +7,7 @@ labels:
- Payments
---
# tx
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Tx.cpp "Source")
The `tx` method retrieves information on a single [transaction](transaction-formats.html), by its [identifying hash][].

View File

@@ -0,0 +1,8 @@
---
html: utility-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Utility Methods
Use these methods to perform convenient tasks, such as ping and random number generation.

View File

@@ -6,6 +6,7 @@ labels:
- Core Server
---
# random
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/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.