mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
References general file structure (methods)
This commit is contained in:
mDuo13
@@ -1,41 +0,0 @@
|
||||
# References
|
||||
|
||||
## [`rippled` API Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Use the `rippled` API to communicate with a `rippled` server, the core peer-to-peer server that manages the XRP Ledger.
|
||||
|
||||
### [Public `rippled` API Methods](x)
|
||||
Communicate directly with a `rippled` server using these public API methods.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Admin `rippled` API Methods](x)
|
||||
Communicate directly with a `rippled` server using these admin-only API methods.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Transaction Formats](x)
|
||||
A transaction is the only way to modify the XRP Ledger. Get details about its required format.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Ledger Data Formats](x)
|
||||
Learn about the format of individual ledgers that make up the shared, global XRP Ledger.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [API Conventions](x)
|
||||
Get details about these common conventions used across the `rippled` API.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
|
||||
## Other `rippled` API Interfaces
|
||||
Here are a couple of other ways to interface with the `rippled` API.
|
||||
|
||||
### [ripple-lib for JavaScript Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Official client library to the XRP Ledger. Available for JavaScript only.
|
||||
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Data API v2 Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Access info about changes to the XRP Ledger, including transaction history and analytics.
|
||||
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
@@ -0,0 +1,5 @@
|
||||
# API Conventions
|
||||
|
||||
This section describes data types and formats of the `rippled` APIs, including JSON-RPC and WebSocket interfaces.
|
||||
|
||||
Some of these data types also appear in higher-level APIs, including the [Data API](data-api.html).
|
||||
@@ -1,4 +1,4 @@
|
||||
# rippled
|
||||
# rippled API
|
||||
|
||||
The core peer-to-peer server that manages the XRP Ledger is called `rippled`. Each `rippled` server connects to a network of peers, relays cryptographically signed transactions, and maintains a local copy of the complete shared global ledger. The source code for `rippled` is written in C++, and is [available on GitHub under an open-source license](https://github.com/ripple/rippled).
|
||||
|
||||
@@ -385,217 +385,207 @@ pages:
|
||||
# run a validator, run in stand-alone mode, set up private peers, run in
|
||||
# a cluster, capacity planning
|
||||
|
||||
# References -------------------------------------------------------------------
|
||||
|
||||
# - name: References
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# template: template-landing-references.html
|
||||
# html: landing-references.html
|
||||
# sidebar: disabled
|
||||
# blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses.
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: rippled API
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# template: template-landing-children.html
|
||||
# html: reference-rippled-api.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: rippled API Public Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
|
||||
# html: reference-rippled-public.html
|
||||
# template: template-landing-children.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Ledger Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Ledger Methods
|
||||
# template: template-landing-children.html
|
||||
# html: reference-rippled-public-ledger-methods.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/ledger_closed.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Ledger Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/ledger_current.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Ledger Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/ledger_data.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Ledger Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Account Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Account Methods
|
||||
# template: template-landing-children.html
|
||||
# html: reference-rippled-public-account-methods.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/account_channels.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Account Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/account_info.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Account Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Transaction Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Public Methods
|
||||
# subcategory: Transaction Methods
|
||||
# template: template-landing-children.html
|
||||
# html: reference-rippled-public-tx-methods.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: rippled API Admin Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Admin Methods
|
||||
# blurb: Administer a rippled server with these admin API methods.
|
||||
# html: reference-rippled-admin.html
|
||||
# template: template-landing-children.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Server Control Methods
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Admin Methods
|
||||
# subcategory: Server Control Methods
|
||||
# html: reference-rippled-admin-server-control-methods.html
|
||||
# template: template-landing-children.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: rippled-api-methods/ledger_accept.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: rippled API Admin Methods
|
||||
# subcategory: Server Control Methods
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: reference-transaction-format.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: Transaction Format
|
||||
# blurb: A transaction is the only way to modify the XRP Ledger. Get details about its required format.
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Transaction Common Fields #TODO: replace with real md file
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: Transaction Format
|
||||
# html: reference-rippled-transactions-common-fields.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Transaction Types #TODO: replace with real md file
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: Transaction Format
|
||||
# html: reference-rippled-transaction-types.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Transaction Results #TODO: replace with real md file
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: Transaction Format
|
||||
# html: reference-rippled-transaction-results.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: reference-ledger-format.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: Ledger Data Format
|
||||
# blurb: Learn about individual data objects that comprise the XRP Ledger's shared state.
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: API Conventions #TODO: replace with real md file
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# supercategory: rippled API
|
||||
# category: API Conventions
|
||||
# html: reference-rippled-api-conventions.html
|
||||
# blurb: Lorem ipsum dolor sit amet...
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: reference-data-api.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# category: Data API
|
||||
# blurb: Access more XRP Ledger data, including transaction history and analytics.
|
||||
# curated_anchors:
|
||||
# - name: Methods
|
||||
# anchor: "#api-method-reference"
|
||||
# - name: API Conventions
|
||||
# anchor: "#api-conventions"
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
- name: References
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
template: template-landing-references.html
|
||||
html: references.html
|
||||
sidebar: disabled
|
||||
blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses.
|
||||
targets:
|
||||
- local
|
||||
|
||||
# rippled API --------------------------------------------------------------
|
||||
|
||||
- name: rippled API # TODO: md landing page?
|
||||
html: reference-rippled-api.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
template: template-landing-children.html
|
||||
blurb: Use the rippled API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger.
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/api-conventions/api-conventions.md
|
||||
html: api-conventions.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: API Conventions
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: Basic Data Types, Ripple Epoch Time
|
||||
|
||||
- md: references/rippled-api/api-conventions/currency-formatting.md
|
||||
html: currency-formatting.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: API Conventions
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: rippled Server States, Error Formatting
|
||||
|
||||
- name: Public rippled Methods #TODO: possible md landing content?
|
||||
html: public-rippled-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
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
|
||||
|
||||
- name: Account Methods #TODO: possible md landing content?
|
||||
html: account-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Account Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/public-rippled-methods/account-methods/account_channels.md
|
||||
html: account_channels.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Account Methods
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: 8 other account methods
|
||||
|
||||
- name: Ledger Methods #TODO: possible md landing content?
|
||||
html: ledger-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Ledger Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/public-rippled-methods/ledger-methods/ledger.md
|
||||
html: ledger.html # Watch carefully for clashes w/ this filename
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Ledger Methods
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: 5 other ledger methods
|
||||
|
||||
- name: Transaction Methods #TODO: possible md landing content?
|
||||
html: transaction-methods.html # watch for clashes w/ this filename
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Transaction Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/public-rippled-methods/transaction-methods/sign.md
|
||||
html: sign.html # watch for clashes w/ this filename
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Transaction Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: 6 other transaction methods
|
||||
|
||||
- name: Path and Order Book Methods #TODO: possible md landing content?
|
||||
html: path-and-order-book-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Path and Order Book Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md
|
||||
html: book_offers.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Path and Order Book Methods
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: 2 other Path and Order Book methods
|
||||
|
||||
# TODO: subcategory landings and method pages for:
|
||||
# - Payment Channel Methods (2)
|
||||
# - Subscription Methods (2)
|
||||
# - Server Info Methods (3)
|
||||
# - Utility Methods (3)
|
||||
|
||||
- name: Admin rippled Methods #TODO: possible md landing content?
|
||||
html: admin-rippled-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
blurb: Administer a rippled server with these admin API methods.
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Key Generation Methods #TODO: possible md landing content?
|
||||
html: key-generation-methods.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Key Generation Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md
|
||||
html: validation_create.html
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Public rippled Methods
|
||||
subcategory: Key Generation Methods
|
||||
targets:
|
||||
- local
|
||||
|
||||
# TODO: Subcategory landings and pages for:
|
||||
# - Logging and Data Management Methods (5)
|
||||
# - Server Control Methods (4)
|
||||
# - Status and Debugging Messages (8)
|
||||
|
||||
|
||||
# --------------- end "rippled API" section --------------------------------
|
||||
|
||||
# # Temporarily commented out to make building the dev portal faster
|
||||
# - name: RippleAPI Reference # name is required for remote-sourced files
|
||||
# md: https://raw.githubusercontent.com/ripple/ripple-lib/0.21.0/docs/index.md
|
||||
# html: reference-rippleapi.html
|
||||
# html: rippleapi-reference.html
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# category: RippleAPI for JavaScript
|
||||
@@ -612,7 +602,24 @@ pages:
|
||||
# - add_version
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
|
||||
# # Temporarily commented out to make building the dev portal faster
|
||||
# - md: references/data-api.md
|
||||
# funnel: Docs
|
||||
# doc_type: References
|
||||
# category: Data API
|
||||
# blurb: Access more XRP Ledger data, including transaction history and analytics.
|
||||
# curated_anchors:
|
||||
# - name: Methods
|
||||
# anchor: "#api-method-reference"
|
||||
# - name: API Conventions
|
||||
# anchor: "#api-conventions"
|
||||
# targets:
|
||||
# - local
|
||||
|
||||
|
||||
# --------------- end "Docs" section -------------------------------------------
|
||||
# Use Cases --------------------------------------------------------------------
|
||||
- md: use-cases/use-cases.md
|
||||
html: use-cases.html
|
||||
funnel: Use Cases
|
||||
@@ -620,83 +627,85 @@ pages:
|
||||
- buttonize
|
||||
targets:
|
||||
- local
|
||||
#
|
||||
# - md: tutorial-listing-xrp.md # TODO: split up and rename?
|
||||
# funnel: Use Cases
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: use-case-listing-xrp.md
|
||||
# funnel: Use Cases
|
||||
# template: template-use-case.html
|
||||
# useful_background:
|
||||
# - concept-xrp-ledger-intro.html
|
||||
# - tutorial-reliable-transaction-submission.html
|
||||
# - concept-money.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: dev-tools.md
|
||||
# funnel: Dev Tools
|
||||
# filters:
|
||||
# - buttonize
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: RPC Tool
|
||||
# funnel: Dev Tools
|
||||
# html: xrp-ledger-rpc-tool.html
|
||||
# targets:
|
||||
# - local
|
||||
# template: template-xrp-ledger-rpc-tool.html
|
||||
#
|
||||
# - name: WebSocket API Tool
|
||||
# funnel: Dev Tools
|
||||
# template: template-ripple-api-tool.html
|
||||
# html: websocket-api-tool.html
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - name: Data API v2 Tool
|
||||
# funnel: Dev Tools
|
||||
# html: data-api-v2-tool.html
|
||||
# methods_js: js/apitool-methods-data_v2.js
|
||||
# rest_host: https://data.ripple.com
|
||||
# doc_page: reference-data-api.html
|
||||
# sidebar: custom
|
||||
# targets:
|
||||
# - local
|
||||
# template: template-rest-api-tool.html
|
||||
#
|
||||
# - name: ripple.txt Validator
|
||||
# funnel: Dev Tools
|
||||
# html: ripple-txt-validator.html
|
||||
# targets:
|
||||
# - local
|
||||
# template: template-ripple-txt-validator.html
|
||||
#
|
||||
# - name: XRP Test Net Faucet
|
||||
# funnel: Dev Tools
|
||||
# html: xrp-test-net-faucet.html
|
||||
# targets:
|
||||
# - local
|
||||
# template: template-test-net.html
|
||||
#
|
||||
# - md: news.md
|
||||
# funnel: News
|
||||
# targets:
|
||||
# - local
|
||||
#
|
||||
# - md: reference-amendments.md # TODO: rename to news-amendments.md
|
||||
# funnel: News
|
||||
# targets:
|
||||
# - local
|
||||
|
||||
- md: use-cases/listing-xrp.md
|
||||
html: listing-xrp.html
|
||||
funnel: Use Cases
|
||||
template: template-use-case.html
|
||||
useful_background:
|
||||
- xrp-ledger-overview.html
|
||||
- reliable-transaction-submission.html
|
||||
- xrp.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
|
||||
# Dev Tools --------------------------------------------------------------------
|
||||
- md: dev-tools/dev-tools.md
|
||||
funnel: Dev Tools
|
||||
filters:
|
||||
- buttonize
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: RPC Tool
|
||||
funnel: Dev Tools
|
||||
html: xrp-ledger-rpc-tool.html
|
||||
targets:
|
||||
- local
|
||||
template: template-xrp-ledger-rpc-tool.html
|
||||
|
||||
- name: WebSocket API Tool
|
||||
funnel: Dev Tools
|
||||
template: template-websocket-api-tool.html
|
||||
html: websocket-api-tool.html
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Data API v2 Tool
|
||||
funnel: Dev Tools
|
||||
html: data-api-v2-tool.html
|
||||
methods_js: js/apitool-methods-data_v2.js
|
||||
rest_host: https://data.ripple.com
|
||||
doc_page: data-api.html
|
||||
sidebar: custom
|
||||
targets:
|
||||
- local
|
||||
template: template-rest-api-tool.html
|
||||
|
||||
- name: ripple.txt Validator
|
||||
funnel: Dev Tools
|
||||
html: ripple-txt-validator.html
|
||||
targets:
|
||||
- local
|
||||
template: template-ripple-txt-validator.html
|
||||
|
||||
- name: XRP Test Net Faucet
|
||||
funnel: Dev Tools
|
||||
html: xrp-test-net-faucet.html
|
||||
targets:
|
||||
- local
|
||||
template: template-test-net.html
|
||||
|
||||
# News -------------------------------------------------------------------------
|
||||
|
||||
- md: news/news.md
|
||||
funnel: News
|
||||
targets:
|
||||
- local
|
||||
|
||||
- md: news/known-amendments.md
|
||||
funnel: News
|
||||
targets:
|
||||
- local
|
||||
|
||||
# Note: other "News" links (Release Notes, eventually Network Status)
|
||||
# are external to this site
|
||||
|
||||
|
||||
ignore_anchors_in:
|
||||
- data-api-v2-tool.html
|
||||
- ripple-api-tool.html
|
||||
- tool-jsonrpc.html
|
||||
- websocket-api-tool.html
|
||||
|
||||
#Sometimes, a link is not really problematic, but the link checker detects it
|
||||
# as such and the easiest solution is to ignore it.
|
||||
|
||||
Reference in New Issue
Block a user