ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-06 17:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #350 from jhaaaa/reorg-public-methods

Browse Source 
reorg public methods
This commit is contained in:
Jennifer Hasegawa
2018-05-11 11:15:18 -07:00
committed by GitHub
parent 8067e69a96 b322a3de2b
commit 6556bca462
36 changed files with 680 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

398
dactyl-config.yml
View File

@@ -787,13 +787,14 @@ pages:
targets:
- local
- name: Account Methods #TODO: possible md landing content?
- name: Account Methods
html: account-methods.html
funnel: Docs
doc_type: References
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
targets:
- local
@@ -805,18 +806,106 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get a list of payment channels where the account is the source of the channel.
targets:
- local
# TODO: 8 other account methods
- md: references/rippled-api/public-rippled-methods/account-methods/account_currencies.md
html: account_currencies.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get a list of currencies an account can send or receive.
targets:
- local
- name: Ledger Methods #TODO: possible md landing content?
- md: references/rippled-api/public-rippled-methods/account-methods/account_info.md
html: account_info.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get basic data about an account.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/account_lines.md
html: account_lines.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get info about an account's trust lines.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/account_objects.md
html: account_objects.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get all ledger objects owned by an account.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/account_offers.md
html: account_offers.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get info about an account's currency exchange offers.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/account_tx.md
html: account_tx.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get info about an account's transactions.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md
html: gateway_balances.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Calculate total amounts issued by an account.
targets:
- local
- md: references/rippled-api/public-rippled-methods/account-methods/noripple_check.md
html: noripple_check.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Account Methods
blurb: Get recommended changes to an account's DefaultRipple and NoRipple settings.
targets:
- local
- name: Ledger Methods
html: ledger-methods.html
funnel: Docs
doc_type: References
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.
template: template-landing-children.html
targets:
- local
@@ -828,12 +917,55 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Get info about a ledger version.
targets:
- local
# TODO: 5 other ledger methods
- md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md
html: ledger_closed.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Get the latest closed ledger version.
targets:
- local
- name: Transaction Methods #TODO: possible md landing content?
- md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md
html: ledger_current.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Get the current working ledger version.
targets:
- local
- md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md
html: ledger_data.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Get the raw contents of a ledger version.
targets:
- local
- md: references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md
html: ledger_entry.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Ledger Methods
blurb: Get one element from a ledger version.
targets:
- local
- name: Transaction Methods
html: transaction-methods.html # watch for clashes w/ this filename
funnel: Docs
doc_type: References
@@ -841,6 +973,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).
targets:
- local
@@ -851,18 +984,84 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Cryptographically sign a transaction.
targets:
- local
# TODO: 6 other transaction methods
- md: references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md
html: sign_for.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Contribute to a multi-signature.
targets:
- local
- name: Path and Order Book Methods #TODO: possible md landing content?
- md: references/rippled-api/public-rippled-methods/transaction-methods/submit.md
html: submit.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Send a transaction to the network.
targets:
- local
- md: references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md
html: submit_multisigned.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Send a multi-signed transaction to the network.
targets:
- local
- md: references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md
html: transaction_entry.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Retrieve info about a transaction from a particular ledger version.
targets:
- local
- md: references/rippled-api/public-rippled-methods/transaction-methods/tx.md
html: tx.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Retrieve info about a transaction from all the ledgers on hand.
targets:
- local
- md: references/rippled-api/public-rippled-methods/transaction-methods/tx_history.md
html: tx_history.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Transaction Methods
blurb: Retrieve info about all recent transactions.
targets:
- local
- name: Path and Order Book Methods
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
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.
template: template-landing-children.html
targets:
- local
@@ -874,16 +1073,189 @@ pages:
supercategory: rippled API
category: Public rippled Methods
subcategory: Path and Order Book Methods
blurb: Get info about offers to exchange two currencies.
targets:
- local
# TODO: 2 other Path and Order Book methods
- md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/path_find.md
html: path_find.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Path and Order Book Methods
blurb: Find a path for a payment between two accounts and receive updates.
targets:
- local
# TODO: subcategory landings and method pages for:
# - Payment Channel Methods (2)
# - Subscription Methods (2)
# - Server Info Methods (3)
# - Utility Methods (3)
- md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md
html: ripple_path_find.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Path and Order Book Methods
blurb: Find a path for payment between two accounts, once.
targets:
- local
- name: Payment Channel Methods
html: payment-channel-methods.html
funnel: Docs
doc_type: References
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.
template: template-landing-children.html
targets:
- local
- md: references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md
html: channel_authorize.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Payment Channel Methods
blurb: Sign a claim for money from a payment channel.
targets:
- local
- md: references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md
html: channel_verify.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Payment Channel Methods
blurb: Check a payment channel claim's signature.
targets:
- local
- name: Subscription Methods
html: subscription-methods.html
funnel: Docs
doc_type: References
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.
template: template-landing-children.html
targets:
- local
- md: references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md
html: subscribe.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Subscription Methods
blurb: Listen for updates about a particular subject.
targets:
- local
- md: references/rippled-api/public-rippled-methods/subscription-methods/unsubscribe.md
html: unsubscribe.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Subscription Methods
blurb: Stop listening for updates about a particular subject.
targets:
- local
- name: Server Info Methods
html: server-info-methods.html
funnel: Docs
doc_type: References
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.
template: template-landing-children.html
targets:
- local
- md: references/rippled-api/public-rippled-methods/server-info-methods/fee.md
html: fee.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Server Info Methods
blurb: Get information about transaction cost.
targets:
- local
- md: references/rippled-api/public-rippled-methods/server-info-methods/server_info.md
html: server_info.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Server Info Methods
blurb: Retrieve status of the server in human-readable format.
targets:
- local
- md: references/rippled-api/public-rippled-methods/server-info-methods/server_state.md
html: server_state.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Server Info Methods
blurb: Retrieve status of the server in machine-readable format.
targets:
- local
- name: Utility Methods
html: utility-methods.html
funnel: Docs
doc_type: References
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.
template: template-landing-children.html
targets:
- local
- md: references/rippled-api/public-rippled-methods/utility-methods/json.md
html: json.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Utility Methods
blurb: Pass JSON through the commandline.
targets:
- local
- md: references/rippled-api/public-rippled-methods/utility-methods/ping.md
html: ping.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Utility Methods
blurb: Confirm connectivity with the server.
targets:
- local
- md: references/rippled-api/public-rippled-methods/utility-methods/random.md
html: random.html
funnel: Docs
doc_type: References
supercategory: rippled API
category: Public rippled Methods
subcategory: Utility Methods
blurb: Generate a random number.
targets:
- local
- md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md
html: admin-rippled-methods.html