From b7777d3f3717fc80092bca96110da2375b17c658 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 23 Jul 2019 16:00:40 -0700 Subject: [PATCH] More 'See Also' sections --- .../concepts/consensus-network/consensus.md | 21 ++++++++++++++----- .../authorized-trust-lines.md | 16 ++++++++++++++ content/concepts/issued-currencies/freezes.md | 11 ++++++++-- .../issuing-and-operational-addresses.md | 14 +++++++++++++ content/concepts/issued-currencies/paths.md | 13 ++++++++++++ .../concepts/issued-currencies/rippling.md | 17 ++++++++++++++- .../issued-currencies/transfer-fees.md | 16 ++++++++++++++ .../trust-lines-and-issuing.md | 13 ++++++++++++ content/concepts/payment-types/checks.md | 2 +- .../payment-types/complex-payment-types.md | 3 --- .../payment-types/cross-currency-payments.md | 13 ++++++++---- .../payment-types/direct-xrp-payments.md | 13 ++++++++---- content/concepts/payment-types/escrow.md | 2 +- .../payment-types/payment-channels.md | 14 +++++++++++-- 14 files changed, 145 insertions(+), 23 deletions(-) delete mode 100644 content/concepts/payment-types/complex-payment-types.md diff --git a/content/concepts/consensus-network/consensus.md b/content/concepts/consensus-network/consensus.md index 98262767b3..31029d76a4 100644 --- a/content/concepts/consensus-network/consensus.md +++ b/content/concepts/consensus-network/consensus.md @@ -161,12 +161,23 @@ Best practices for applications submitting transactions include: - Take care to use a server with a continuous ledger history to detect this case 10. - It may be necessary to check the status of a transaction repeatedly until the ledger identified by `LastLedgerSequence` is validated. -## Further Resources +## See Also + +- **Concepts:** + - [Introduction to Consensus](intro-to-consensus.html) + - [Consensus Research](consensus-research.html) + - [Ripple Consensus Video](https://www.youtube.com/watch?v=pj1QVb1vlC0) +- **Tutorials:** + - [Reliable Transaction Submission](reliable-transaction-submission.html) + - [Run `rippled` as a Validator](run-rippled-as-a-validator.html) +- **References:** + - [Ledger Format Reference](ledger-data-formats.html) + - [Transaction Format Reference](transaction-formats.html) + - [consensus_info method][] + - [validator_list_sites method][] + - [validators method][] + -- [Consensus White Paper](https://ripple.com/files/ripple_consensus_whitepaper.pdf) -- [Ledger Format Reference](ledger-data-formats.html) -- [Ripple Consensus Video](https://www.youtube.com/watch?v=pj1QVb1vlC0) -- [Reliable Transaction Submission](reliable-transaction-submission.html) diff --git a/content/concepts/issued-currencies/authorized-trust-lines.md b/content/concepts/issued-currencies/authorized-trust-lines.md index f2cda7f695..5df7c27669 100644 --- a/content/concepts/issued-currencies/authorized-trust-lines.md +++ b/content/concepts/issued-currencies/authorized-trust-lines.md @@ -98,6 +98,22 @@ To see whether a trust line has been authorized, use the [account_lines method][ In the response's `result.lines` array, find the object whose `currency` field indicates that it represents a trust line for the currency you want. If that object has a `peer_authorized` field with the value `true`, then the issuer (the address you used as the request's `peer` field) has authorized the trust line. + +## See Also + +- **Concepts:** + - [Deposit Authorization](depositauth.html) + - [Freezing Issued Currencies](freezes.html) +- **Tutorials:** + - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) +- **References:** + - [account_lines method][] + - [account_info method][] + - [AccountSet transaction][] + - [TrustSet transaction][] + - [AccountRoot Flags](accountroot.html#accountroot-flags) + - [RippleState (trust line) Flags](ripplestate.html#ripplestate-flags) + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/issued-currencies/freezes.md b/content/concepts/issued-currencies/freezes.md index 803b9184ab..2b216813ae 100644 --- a/content/concepts/issued-currencies/freezes.md +++ b/content/concepts/issued-currencies/freezes.md @@ -420,8 +420,15 @@ Example JavaScript (ECMAScript 6) code to check whether an address has Global Fr # See Also -* [GB-2014-02 New Feature: Balance Freeze](https://ripple.com/files/GB-2014-02.pdf) -* [Freeze Code Samples](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/freeze) +- [GB-2014-02 New Feature: Balance Freeze](https://ripple.com/files/GB-2014-02.pdf) +- [Freeze Code Samples](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/freeze) +- **References:** + - [account_lines method][] + - [account_info method][] + - [AccountSet transaction][] + - [TrustSet transaction][] + - [AccountRoot Flags](accountroot.html#accountroot-flags) + - [RippleState (trust line) Flags](ripplestate.html#ripplestate-flags) {% include '_snippets/rippled-api-links.md' %} diff --git a/content/concepts/issued-currencies/issuing-and-operational-addresses.md b/content/concepts/issued-currencies/issuing-and-operational-addresses.md index 383b605973..32deb4269a 100644 --- a/content/concepts/issued-currencies/issuing-and-operational-addresses.md +++ b/content/concepts/issued-currencies/issuing-and-operational-addresses.md @@ -50,3 +50,17 @@ As with operational addresses, a standby address must have an accounting relatio ### Standby Address Compromise If a standby address is compromised, the consequences are like an operational address being compromised. A malicious actor can steal any balances possessed by the standby address, and the financial institution can change to a new standby address with no action from customers and partners. + +## See Also + +- **Concepts:** + - [Accounts](accounts.html) + - [Cryptographic Keys](cryptographic-keys.html) +- **Tutorials:** + - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) + - [Assign a Regular Key Pair](assign-a-regular-key-pair.html) + - [Change or Remove a Regular Key Pair](change-or-remove-a-regular-key-pair.html) +- **References:** + - [account_info method][] + - [SetRegularKey transaction][] + - [AccountRoot object](accountroot.html) diff --git a/content/concepts/issued-currencies/paths.md b/content/concepts/issued-currencies/paths.md index 08a65bbee7..9827bc7fc7 100644 --- a/content/concepts/issued-currencies/paths.md +++ b/content/concepts/issued-currencies/paths.md @@ -93,6 +93,19 @@ The `type` field, used for the binary serialization of a path set, is actually c | 0x10 | 16 | A change of currency: the `currency` field is present. | | 0x20 | 32 | A change of issuer: the `issuer` field is present. | + +## See Also + +- **Concepts:** + - [Cross-Currency Payments](cross-currency-payments.html) + - [Decentralized Exchange](decentralized-exchange.html) + - [Partial Payments](partial-payments.html) +- **References:** + - [Payment transaction][] + - [path_find method][] (WebSocket only) + - [ripple_path_find method][] + + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/issued-currencies/rippling.md b/content/concepts/issued-currencies/rippling.md index ea2fca09a0..2270375949 100644 --- a/content/concepts/issued-currencies/rippling.md +++ b/content/concepts/issued-currencies/rippling.md @@ -2,7 +2,7 @@ In the XRP Ledger, "rippling" describes a process of atomic net settlement between multiple connected parties who have [trust lines](trust-lines-and-issuing.html) for the same currency. Rippling is an essential part of issued currencies, because it allows users who trust the same issuer to send issued balances to each other with the issuer as a passive intermediary. In a sense, rippling is like a passive, two-way [currency exchange order](offers.html) with no limit and a 1:1 exchange rate for two currencies with the same currency code but different issuers. -Rippling only occurs along the [paths](paths.html) of a payment. +Rippling only occurs along the [paths](paths.html) of a payment. [Direct XRP-to-XRP payments](direct-xrp-payments.html) do not involve rippling. For non-issuing accounts, rippling can be undesirable because it lets other users shift obligations between issuers of the same currency. Thus, the [NoRipple Flag](#the-noripple-flag) disables rippling on incoming trust lines by default, unless the account enables rippling by default by enabling the [DefaultRipple flag](#the-defaultripple-flag). @@ -80,6 +80,21 @@ In the [`rippled` APIs](rippled-api.html), you can use the [account_lines method In [RippleAPI](rippleapi-reference.html), you can use the [getTrustlines](rippleapi-reference.html#gettrustlines) method to look up the trust lines associated with an address. For each trust line, the `ripplingDisabled` field shows whether the current address has enabled the NoRipple flag on that trust line, and the `counterparty.ripplingDisabled` field shows whether the counterparty has enabled the NoRipple flag. + +## See Also + +- **Concepts:** + - [Paths](paths.html) +- **Tutorials:** + - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) +- **References:** + - [account_lines method][] + - [account_info method][] + - [AccountSet transaction][] + - [TrustSet transaction][] + - [AccountRoot Flags](accountroot.html#accountroot-flags) + - [RippleState (trust line) Flags](ripplestate.html#ripplestate-flags) + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/issued-currencies/transfer-fees.md b/content/concepts/issued-currencies/transfer-fees.md index e030f2bd56..fe814f2de5 100644 --- a/content/concepts/issued-currencies/transfer-fees.md +++ b/content/concepts/issued-currencies/transfer-fees.md @@ -49,6 +49,22 @@ A financial institution can submit an [AccountSet transaction][] from its [issui You can check an account's `TransferRate` with the [account_info method][]. If the `TransferRate` is omitted, then that indicates no fee. + +## See Also + +- **Concepts:** + - [Fees (Disambiguation)](fees.html) + - [Transaction Cost](transaction-cost.html) + - [Paths](paths.html) +- **Tutorials:** + - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) +- **References:** + - [account_lines method][] + - [account_info method][] + - [AccountSet transaction][] + - [AccountRoot Flags](accountroot.html#accountroot-flags) + + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/issued-currencies/trust-lines-and-issuing.md b/content/concepts/issued-currencies/trust-lines-and-issuing.md index 747d3f2400..b94a684248 100644 --- a/content/concepts/issued-currencies/trust-lines-and-issuing.md +++ b/content/concepts/issued-currencies/trust-lines-and-issuing.md @@ -18,6 +18,19 @@ A trust line with settings in the default state is equivalent to no trust line. The default state of all trust line flags is off, except for the [NoRipple flag](rippling.html), whose default state depends on the DefaultRipple flag. +## See Also + +- **Concepts:** + - [Decentralized Exchange](decentralized-exchange.html) + - [Rippling](rippling.html) +- **Tutorials:** + - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) +- **References:** + - [account_lines method][] + - [gateway_balances method][] + - [RippleState (trust line) object](ripplestate.html) + - [TrustSet transaction][] + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/payment-types/checks.md b/content/concepts/payment-types/checks.md index b82fce480a..690efe1a79 100644 --- a/content/concepts/payment-types/checks.md +++ b/content/concepts/payment-types/checks.md @@ -81,7 +81,7 @@ Checks require `rippled` v0.90.0 or later. As of 2018-10-11, the Checks amendmen To check the status of an amendment on a test net or private XRP Ledger network, use the [feature method][]. -## Further Reading +## See Also For more information about Checks in the XRP Ledger, see: diff --git a/content/concepts/payment-types/complex-payment-types.md b/content/concepts/payment-types/complex-payment-types.md deleted file mode 100644 index 5318f5d904..0000000000 --- a/content/concepts/payment-types/complex-payment-types.md +++ /dev/null @@ -1,3 +0,0 @@ -# Complex Payment Types - -In addition to simple point-to-point XRP Payments, the XRP Ledger supports a number of complex payment types for a variety of use cases and situations. diff --git a/content/concepts/payment-types/cross-currency-payments.md b/content/concepts/payment-types/cross-currency-payments.md index c641044112..93655fa1a8 100644 --- a/content/concepts/payment-types/cross-currency-payments.md +++ b/content/concepts/payment-types/cross-currency-payments.md @@ -21,10 +21,15 @@ For more information, see [Autobridging](autobridging.html). ## See Also -- [Issued Currencies](issued-currencies.html) -- [Decentralized Exchange](decentralized-exchange.html) -- [Payment transaction type][Payment transaction] -- [Paths](paths.html) +- **Concepts:** + - [Issued Currencies](issued-currencies.html) + - [Decentralized Exchange](decentralized-exchange.html) + - [Paths](paths.html) +- **References:** + - [Payment transaction type][Payment transaction] + - [path_find method][] + - [ripple_path_find method][] + - [Interpreting Metadata of Issued Currency Payments](look-up-transaction-results.html#issued-currency-payments) {% include '_snippets/rippled-api-links.md' %} diff --git a/content/concepts/payment-types/direct-xrp-payments.md b/content/concepts/payment-types/direct-xrp-payments.md index 047d9437bf..f9d574d1e2 100644 --- a/content/concepts/payment-types/direct-xrp-payments.md +++ b/content/concepts/payment-types/direct-xrp-payments.md @@ -73,10 +73,15 @@ From a relatively high level, the XRP Ledger's transaction processing engine app ## See Also -- [Payment System Basics](payment-system-basics.html) -- [Payment transaction type][Payment transaction] -- [Transaction Results](transaction-results.html) -- [Send XRP (Interactive Tutorial)](send-xrp.html) +- **Concepts:** + - [Payment System Basics](payment-system-basics.html) +- **Tutorials:** + - [Send XRP (Interactive Tutorial)](send-xrp.html) + - [Monitor Incoming Payments with WebSocket](Monitor Incoming Payments with WebSocket) +- **References:** + - [Payment transaction][] + - [Transaction Results](transaction-results.html) + - [account_info method][] - for checking XRP balances diff --git a/content/concepts/payment-types/escrow.md b/content/concepts/payment-types/escrow.md index 37a161246b..eafd03fc8e 100644 --- a/content/concepts/payment-types/escrow.md +++ b/content/concepts/payment-types/escrow.md @@ -116,7 +116,7 @@ The most fundamental principle of inter-ledger payments is _conditional transfer **Solution:** The Escrow feature makes the XRP Ledger ideal for bridging multi-hop payments using the Interledger Protocol, because it natively supports transfers that deliver XRP based on PREIMAGE-SHA-256 crypto-conditions, and it executes those transfers within seconds of being presented with the matching fulfillment. -## Further Reading +## See Also For more information about Escrow in the XRP Ledger, see the following: diff --git a/content/concepts/payment-types/payment-channels.md b/content/concepts/payment-types/payment-channels.md index f10ef8c7a4..f080764c30 100644 --- a/content/concepts/payment-types/payment-channels.md +++ b/content/concepts/payment-types/payment-channels.md @@ -27,9 +27,19 @@ The following diagram summarizes the lifecycle of a payment channel: ## See Also -- [Use Payment Channels](use-payment-channels.html), a tutorial stepping through the process of using a payment channel. +- **Related Concepts:** + - [Escrow](escrow.html), a similar feature for higher-value, lower-speed conditional XRP payments. +- **Tutorials and Use Cases:** + - [Use Payment Channels](use-payment-channels.html), a tutorial stepping through the process of using a payment channel. + - [Open a Payment Channel to Enable an Inter-Exchange Network](open-a-payment-channel-to-enable-an-inter-exchange-network.html) +- **References:** + - [channel_authorize method][] + - [channel_verify method][] + - [PayChannel object](paychannel.html) + - [PaymentChannelClaim transaction][] + - [PaymentChannelCreate transaction][] + - [PaymentChannelFund transaction][] -- [Escrow](escrow.html), a similar feature for higher-value, lower-speed conditional XRP payments. {% include '_snippets/rippled-api-links.md' %}