From 21b74ce25d0687067161a2024cf74f3e03cd16da Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 26 Feb 2019 19:19:08 -0800 Subject: [PATCH] Use :enabled: and :not_enabled: for amendments --- content/_snippets/rippled-api-links.md | 42 +++++++++++++++++++ .../concepts/complex-payment-types/checks.md | 6 ++- .../concepts/decentralized-exchange/offers.md | 2 +- .../decentralized-exchange/ticksize.md | 2 +- .../authorized-trust-lines.md | 2 +- .../accounts/depositauth.md | 14 +++---- .../accounts/reserves.md | 2 +- .../transaction-basics/transaction-cost.md | 6 +-- .../ledger-object-types/accountroot.md | 2 +- .../ledger-object-types/check.md | 2 +- .../ledger-object-types/escrow.md | 4 +- .../ledger-object-types/paychannel.md | 2 +- .../ledger-object-types/signerlist.md | 10 ++--- .../account-methods/account_channels.md | 2 +- .../account-methods/account_info.md | 4 +- .../ledger-methods/ledger.md | 2 +- .../channel_authorize.md | 2 +- .../payment-channel-methods/channel_verify.md | 2 +- .../server-info-methods/fee.md | 2 +- .../transaction-methods/sign_for.md | 2 +- .../transaction-methods/submit_multisigned.md | 2 +- .../transaction-common-fields.md | 2 +- .../transaction-results/tec-codes.md | 4 +- .../transaction-results/tef-codes.md | 2 +- .../transaction-types/accountset.md | 4 +- .../transaction-types/checkcancel.md | 2 +- .../transaction-types/checkcash.md | 2 +- .../transaction-types/checkcreate.md | 2 +- .../transaction-types/depositpreauth.md | 2 +- .../transaction-types/escrowcancel.md | 2 +- .../transaction-types/escrowcreate.md | 4 +- .../transaction-types/escrowfinish.md | 2 +- .../transaction-types/offercreate.md | 2 +- .../transaction-types/paymentchannelclaim.md | 2 +- .../transaction-types/paymentchannelcreate.md | 2 +- .../transaction-types/paymentchannelfund.md | 2 +- .../transaction-types/signerlistset.md | 4 +- .../transaction-types/trustset.md | 2 +- .../set-up-multi-signing.md | 6 +-- .../use-checks/cancel-a-check.md | 2 +- .../cash-a-check-for-a-flexible-amount.md | 2 +- .../cash-a-check-for-an-exact-amount.md | 2 +- .../use-checks/look-up-checks-by-recipient.md | 2 +- .../use-checks/look-up-checks-by-sender.md | 2 +- .../use-checks/send-a-check.md | 2 +- .../use-checks/use-checks.md | 2 +- .../use-escrows/look-up-escrows.md | 2 +- dactyl-config.yml | 1 + tool/filter_status_badges.py | 4 +- 49 files changed, 114 insertions(+), 69 deletions(-) diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index ff0de01018..ef5cff4c9e 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -95,3 +95,45 @@ [{{method}} method]: {{method|lower}}.html [{{method}} command]: {{method|lower}}.html {% endfor %} + + +{% set amendment_names = [ + "Checks", + "CryptoConditions", + "CryptoConditionsSuite", + "DepositAuth", + "DepositPreauth", + "EnforceInvariants", + "Escrow", + "FeeEscalation", + "fix1201", + "fix1368", + "fix1373", + "fix1512", + "fix1513", + "fix1515", + "fix1523", + "fix1528", + "fix1543", + "fix1571", + "fix1578", + "fix1623", + "fixTakerDryOfferRemoval", + "Flow", + "FlowCross", + "FlowV2", + "MultiSign", + "MultiSignReserve", + "OwnerPaysFee", + "PayChan", + "SHAMapV2", + "SortedDirectories", + "SusPay", + "Tickets", + "TickSize", + "TrustSetAuth" +] %} + +{% for amd in amendment_names %} +[{{amd}} amendment]: known-amendments.html#{{amd|lower}} +{% endfor %} diff --git a/content/concepts/complex-payment-types/checks.md b/content/concepts/complex-payment-types/checks.md index c74f109ec1..b82fce480a 100644 --- a/content/concepts/complex-payment-types/checks.md +++ b/content/concepts/complex-payment-types/checks.md @@ -1,5 +1,7 @@ # Checks +_(Requires the [Checks amendment][] :not_enabled:.)_ + The Checks feature in the XRP Ledger allows users to create deferred payments that can be canceled or cashed by the intended recipients. Like personal paper checks, XRP Ledger Checks start with the sender of the funds creating a Check that specifies an amount and receiver. The receiver cashes the check to pull the funds from the sender's account into the receiver's account. No money moves until the receiver cashes the Check. Because funds are not put on hold when the Check is created, cashing a Check can fail if the sender doesn't have enough funds when the receiver tries to cash it, just like traditional checks. If there's a failure cashing the check, the sender can retry until the check expires. XRP Ledger Checks have expiration times after which they may no longer be cashed. If the receiver doesn't successfully cash the Check before it expires, the Check object remains in the XRP Ledger until someone cancels it. Anyone may cancel the Check after it expires. Only the sender and receiver can cancel the Check before it expires or is cashed. The Check object is removed from the Ledger when the sender successfully cashes the check or someone cancels it. @@ -13,7 +15,7 @@ Checks are similar to [Escrow](escrow.html) and [Payment Channels](use-payment-c * You can send XRP to yourself through Escrow. You cannot use Checks or Payment Channels to send XRP (or, in the case of Checks, issued currencies) to yourself. -**Note:** The [Checks amendment](known-amendments.html#checks) changes the expiration behavior of the [OfferCreate][] transaction. For more information, see [Offer Expiration](offers.html#offer-expiration). +**Note:** The [Checks amendment][]:not_enabled: changes the expiration behavior of the [OfferCreate][] transaction. For more information, see [Offer Expiration](offers.html#offer-expiration). ## Why Checks? @@ -94,7 +96,7 @@ For more information about Checks in the XRP Ledger, see: - [Cash a Check for an exact amount](cash-a-check-for-an-exact-amount.html) - [Cash a Check for a flexible amount](cash-a-check-for-a-flexible-amount.html) - [Cancel a Check](cancel-a-check.html) -- [Checks amendment](known-amendments.html#checks) +- [Checks amendment][] For more information about related features, see: diff --git a/content/concepts/decentralized-exchange/offers.md b/content/concepts/decentralized-exchange/offers.md index 0af0084c74..c9d196c720 100644 --- a/content/concepts/decentralized-exchange/offers.md +++ b/content/concepts/decentralized-exchange/offers.md @@ -66,7 +66,7 @@ You can determine the final disposition of an offer with an `Expiration` as soon **Note:** Since only new transactions can modify the ledger, an expired offer can stay on the ledger after it becomes inactive. The offer is treated as unfunded and has no effect, but it can continue to appear in results (for example, from the [ledger_entry](ledger_entry.html) command). Later on, the expired offer can get finally deleted as a result of another transaction (such as another OfferCreate) if the server finds it while processing. -If an OfferCreate transaction has an `Expiration` time that has already passed when the transaction first gets included in a ledger, the transaction does not execute the offer. The result code of such a transaction depends on whether the [Checks amendment](known-amendments.html#checks) is enabled. With the Checks amendment enabled, the transaction has the `tecEXPIRED` result code. Otherwise, the transaction has the `tesSUCCESS` transaction code. In either case, the transaction has no effect except to destroy the XRP paid as a [transaction cost](transaction-cost.html). +If an OfferCreate transaction has an `Expiration` time that has already passed when the transaction first gets included in a ledger, the transaction does not execute the offer. The result code of such a transaction depends on whether the [Checks amendment][]:not_enabled: is enabled. With the Checks amendment enabled, the transaction has the `tecEXPIRED` result code. Otherwise, the transaction has the `tesSUCCESS` transaction code. In either case, the transaction has no effect except to destroy the XRP paid as a [transaction cost](transaction-cost.html). diff --git a/content/concepts/decentralized-exchange/ticksize.md b/content/concepts/decentralized-exchange/ticksize.md index 826572d868..a16ff625b9 100644 --- a/content/concepts/decentralized-exchange/ticksize.md +++ b/content/concepts/decentralized-exchange/ticksize.md @@ -1,6 +1,6 @@ # Tick Size -_((ENABLED_ICON) Requires the [TickSize amendment](known-amendments.html#ticksize).)_ +_(Requires the [TickSize amendment][] :enabled:.)_ When an Offer is placed into an order book, its exchange rate is truncated based on the `TickSize` values set by the issuers of the currencies involved in the Offer. When a trader offers to exchange XRP and an issued currency, the `TickSize` from the issuer of the currency applies. When a trader offers to exchange two issued currencies, the offer uses the smaller `TickSize` value (that is, the one with fewer significant digits). If neither currency has a `TickSize` set, the default behavior applies. diff --git a/content/concepts/issued-currencies/authorized-trust-lines.md b/content/concepts/issued-currencies/authorized-trust-lines.md index f043c93512..d5eb148207 100644 --- a/content/concepts/issued-currencies/authorized-trust-lines.md +++ b/content/concepts/issued-currencies/authorized-trust-lines.md @@ -10,7 +10,7 @@ The transaction to authorize a trust line must be signed by the issuing address, 2. A customer sends a [TrustSet transaction][] to create a trust line from her XRP Ledger address to the gateway's issuing address. This indicates that she is willing to hold a specific currency issued by the gateway, up to a specific numeric limit. 3. The gateway's issuing address sends a TrustSet transaction authorizing the customer's trust line. -**Tip:** An issuing gateway can authorize a trust line preemptively (step 3), before the customer has created it. This creates a trust line with zero limit, so that the customer's TrustSet transaction (step 2) sets the limit on the pre-authorized trust line. _((ENABLED_ICON) Requires the [TrustSetAuth amendment](known-amendments.html#trustsetauth).)_ +**Tip:** An issuing gateway can authorize a trust line preemptively (step 3), before the customer has created it. This creates a trust line with zero limit, so that the customer's TrustSet transaction (step 2) sets the limit on the pre-authorized trust line. _(Requires the [TrustSetAuth amendment][] :enabled:.)_ ## RequireAuth Setting diff --git a/content/concepts/payment-system-basics/accounts/depositauth.md b/content/concepts/payment-system-basics/accounts/depositauth.md index 01afcf1d13..257a861722 100644 --- a/content/concepts/payment-system-basics/accounts/depositauth.md +++ b/content/concepts/payment-system-basics/accounts/depositauth.md @@ -1,6 +1,6 @@ # Deposit Authorization -_((ENABLED_ICON) Requires the [DepositAuth amendment](known-amendments.html#depositauth).)_ +_(Requires the [DepositAuth amendment][] :enabled:.)_ Deposit Authorization is an optional feature of an [account](accounts.html) in the XRP Ledger. With Deposit Authorization enabled, transactions cannot send value of any kind to the account unless the sender of those transactions is the account itself. This includes transfers of XRP and issued currencies. @@ -14,7 +14,7 @@ The Deposit Authorization flag introduces an option for those using the XRP Ledg When you have Deposit Authorization enabled, you can receive money from [Checks](known-amendments.html#checks), [Escrow](escrow.html), and [Payment Channels](known-amendments.html#paychan). In these transactions' "two-step" model, first the source sends a transaction to authorize sending funds, then the destination sends a transaction to authorize receiving those funds. -To receive money from [Payment transactions][] when you have Deposit Authorization enabled, you must [preauthorize](#preauthorization) the senders of those Payments. _((ENABLED_ICON) Requires the [DepositPreauth amendment][])_ +To receive money from [Payment transactions][] when you have Deposit Authorization enabled, you must [preauthorize](#preauthorization) the senders of those Payments. _(Requires the [DepositPreauth amendment][] :enabled:.)_ ## Recommended Usage @@ -29,15 +29,15 @@ To get the full effect of Deposit Authorization, Ripple recommends also doing th An account with Deposit Authorization enabled: - **Cannot** be the destination of [Payment transactions][], with **the following exceptions**: - - If the destination has [preauthorized](#preauthorization) the sender of the Payment. _((ENABLED_ICON) Requires the [DepositPreauth amendment][])_ + - If the destination has [preauthorized](#preauthorization) the sender of the Payment. _(Requires the [DepositPreauth amendment][] :enabled:)_ - If the account's XRP balance is equal to or below the minimum account [reserve requirement](reserves.html), it can be the destination of an XRP Payment whose `Amount` is equal or less than the minimum account reserve (currently 20 XRP). This is to prevent an account from becoming "stuck" by being unable to send transactions but also unable to receive XRP. The account's owner reserve does not matter for this case. - Can receive XRP from [PaymentChannelClaim transactions][] **only in the following cases**: - The sender of the PaymentChannelClaim transaction is the destination of the payment channel. - - The destination of the PaymentChannelClaim transaction has [preauthorized](#preauthorization) the sender of the PaymentChannelClaim. _((ENABLED_ICON) Requires the [DepositPreauth amendment][])_ + - The destination of the PaymentChannelClaim transaction has [preauthorized](#preauthorization) the sender of the PaymentChannelClaim. _(Requires the [DepositPreauth amendment][] :enabled:)_ - Can receive XRP from [EscrowFinish transactions][] **only in the following cases**: - The sender of the EscrowFinish transaction is the destination of the escrow. - - The destination of the EscrowFinish transaction has [preauthorized](#preauthorization) the sender of the EscrowFinish. _((ENABLED_ICON) Requires the [DepositPreauth amendment][])_ -- **Can** receive XRP or issued currencies by sending a [CheckCash][] transaction. _((NOT_ENABLED_ICON) Requires the [Checks amendment](known-amendments.html#checks).)_ + - The destination of the EscrowFinish transaction has [preauthorized](#preauthorization) the sender of the EscrowFinish. _(Requires the [DepositPreauth amendment][] :enabled:)_ +- **Can** receive XRP or issued currencies by sending a [CheckCash][] transaction. _(Requires the [Checks amendment][] :not_enabled:.)_ - **Can** receive XRP or issued currencies by sending [OfferCreate transactions][]. - If the account sends an OfferCreate transaction that is not fully executed immediately, it **can** receive the remainder of the ordered XRP or issued currency later when the offer is consumed by other accounts' [Payment][] and [OfferCreate][] transactions. - If the account has created any trust lines without the [NoRipple flag](rippling.html) enabled, or has enabled the DefaultRipple flag and issued any currency, the account **can** receive the issued currencies of those trust lines in [Payment transactions][] as a result of rippling. It cannot be the destination of those transactions. @@ -64,7 +64,7 @@ If the result of the `Flags` value bitwise-AND the `lsfDepositAuth` flag value ( ## Preauthorization -_((ENABLED_ICON) Requires the [DepositPreauth amendment][])_ +_(Requires the [DepositPreauth amendment][] :enabled:.)_ Accounts with DepositAuth enabled can _preauthorize_ certain senders, to allow payments from those senders to succeed even with DepositAuth enabled. This allows specific senders to send funds directly without the receiver taking action on each transaction individually. Preauthorization is not required to use DepositAuth, but can make certain operations more convenient. diff --git a/content/concepts/payment-system-basics/accounts/reserves.md b/content/concepts/payment-system-basics/accounts/reserves.md index 1a7899cebe..92f96a4715 100644 --- a/content/concepts/payment-system-basics/accounts/reserves.md +++ b/content/concepts/payment-system-basics/accounts/reserves.md @@ -21,7 +21,7 @@ Many objects in the ledger are owned by a particular address, and count toward t - [Offers](offer.html) are owned by the address that placed them. Transaction processing automatically removes Offers that are fully consumed or found to be unfunded. Alternatively, the owner can cancel an Offer by sending an [OfferCancel transaction][], or by sending an [OfferCreate transaction][] that contains an `OfferSequence` parameter. - [Trust lines](ripplestate.html) are shared between two addresses. The owner reserve can apply to one or both of the addresses, depending on whether the fields that address controls are in their default state. See [Contributing to the Owner Reserve](ripplestate.html#contributing-to-the-owner-reserve) for details. -- Without the [MultiSignReserve amendment](known-amendments.html#multisignreserve), a single [SignerList](signerlist.html) counts as 3 to 10 objects for purposes of the owner reserve, depending on how many members it has. With the [MultiSignReserve amendment](known-amendments.html#multisignreserve) enabled, a single SignerList counts as 1 object for purposes of the owner reserve, regardless of the number of members it has. See also: [SignerLists and Reserves](signerlist.html#signerlists-and-reserves). +- Without the [MultiSignReserve amendment][], a single [SignerList](signerlist.html) counts as 3 to 10 objects for purposes of the owner reserve, depending on how many members it has. With the [MultiSignReserve amendment][] enabled, a single SignerList counts as 1 object for purposes of the owner reserve, regardless of the number of members it has. See also: [SignerLists and Reserves](signerlist.html#signerlists-and-reserves). - [Held Payments (Escrow)](escrow-object.html) are owned by the address that placed them. - [Payment Channels](use-payment-channels.html) are owned by the address that created them. - [Owner directories](directorynode.html) list all the ledger objects that contribute to an address's owner reserve. However, the owner directory itself does not count towards the reserve. diff --git a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md index 73d0ce96d2..3ba4be0014 100644 --- a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md +++ b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md @@ -30,7 +30,7 @@ The transaction cost is not paid to any party: the XRP is irrevocably destroyed. ## Load Cost and Open Ledger Cost -When the [FeeEscalation amendment](known-amendments.html#feeescalation) is enabled, there are two thresholds for the transaction cost: +When the [FeeEscalation amendment][] is enabled, there are two thresholds for the transaction cost: * If the transaction cost does not meet a `rippled` server's [load-based transaction cost threshold](#local-load-cost), the server ignores the transaction completely. (This logic is essentially unchanged with or without the amendment.) * If the transaction cost does not meet a `rippled` server's [open ledger cost threshold](#open-ledger-cost), the server queues the transaction for a later ledger. @@ -82,7 +82,7 @@ _Fee levels_ represent the proportional difference between the minimum cost and The `rippled` APIs have two ways to query the local load-based transaction cost: the `server_info` command (intended for humans) and the `server_state` command (intended for machines). -If the [FeeEscalation amendment](known-amendments.html#feeescalation) is enabled, you can use the [fee method][] to check the open ledger cost. +If the [FeeEscalation amendment][] is enabled, you can use the [fee method][] to check the open ledger cost. ### server_info @@ -144,7 +144,7 @@ This feature is designed to allow you to recover an account if the regular key i The [lsfPasswordSpent flag](accountroot.html) starts out disabled. It gets enabled when you send a SetRegularKey transaction signed by the master key pair. It gets disabled again when the account receives a [Payment](payment.html) of XRP. -When the [FeeEscalation amendment](known-amendments.html#feeescalation) is enabled, `rippled` prioritizes key reset transactions above other transactions even though the nominal transaction cost of a key reset transaction is zero. +When the [FeeEscalation amendment][] is enabled, `rippled` prioritizes key reset transactions above other transactions even though the nominal transaction cost of a key reset transaction is zero. ## Changing the Transaction Cost diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md index 0ccb0ae3f1..075a9f8121 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md @@ -43,7 +43,7 @@ The `AccountRoot` object has the following fields: | `EmailHash` | String | Hash128 | _(Optional)_ The md5 hash of an email address. Clients can use this to look up an avatar through services such as [Gravatar](https://en.gravatar.com/). | | `MessageKey` | String | VariableLength | _(Optional)_ A public key that may be used to send encrypted messages to this account. In JSON, uses hexadecimal. No more than 33 bytes. | | `RegularKey` | String | AccountID | _(Optional)_ The address of a keypair that can be used to sign transactions for this account instead of the master key. Use a [SetRegularKey transaction][] to change this value. | -| `TickSize` | Number | UInt8 | _(Optional)_ How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are `3` to `15`, inclusive. _((ENABLED_ICON) Requires the [TickSize amendment](known-amendments.html#ticksize).)_ | +| `TickSize` | Number | UInt8 | _(Optional)_ How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are `3` to `15`, inclusive. _(Requires the [TickSize amendment][] :enabled:.)_ | | `TransferRate` | Number | UInt32 | _(Optional)_ A [transfer fee](https://ripple.com/knowledge_center/transfer-fees/) to charge other users for sending currency issued by this account to each other. | | `WalletLocator` | String | Hash256 | _(Optional)_ **DEPRECATED**. Do not use. | | `WalletSize` | Number | UInt32 | _(Optional)_ **DEPRECATED**. Do not use. | diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md index 79aca585ad..0f2eca4330 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md @@ -1,7 +1,7 @@ # Check [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L157-L170 "Source") -_((NOT_ENABLED_ICON) Requires the [Checks Amendment](known-amendments.html#checks).)_ +_(Requires the [Checks amendment][] :not_enabled:.)_ A `Check` object describes a check, similar to a paper personal check, which can be cashed by its destination to get money from its sender. (The potential payment has already been approved by its sender, but no money moves until it is cashed. Unlike an [Escrow](escrow.html), the money for a Check is not set aside, so cashing the Check could fail due to lack of funds.) diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md index 19de03128f..4aba5a5903 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md @@ -1,7 +1,7 @@ # Escrow [[Source]
](https://github.com/ripple/rippled/blob/c6b6d82a754fe449cc533e18659df483c10a5c98/src/ripple/protocol/impl/LedgerFormats.cpp#L90-L101 "Source") -_((ENABLED_ICON) Requires the [Escrow Amendment](known-amendments.html#escrow).)_ +_(Requires the [Escrow amendment][] :enabled:.)_ The `Escrow` object type represents a held payment of XRP waiting to be executed or canceled. An [EscrowCreate transaction][] creates an `Escrow` object in the ledger. A successful [EscrowFinish][] or [EscrowCancel][] transaction deletes the object. If the ``Escrow`` object has a [_crypto-condition_](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02), the payment can only succeed if an EscrowFinish transaction provides the corresponding _fulfillment_ that satisfies the condition. (The only supported crypto-condition type is [PREIMAGE-SHA-256](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1).) If the `Escrow` object has a `FinishAfter` time, the held payment can only execute after that time. @@ -49,7 +49,7 @@ An `Escrow` object has the following fields: | `SourceTag` | Number | UInt32 | _(Optional)_ An arbitrary tag to further specify the source for this held payment, such as a hosted recipient at the owner's address. | | `DestinationTag` | Number | UInt32 | _(Optional)_ An arbitrary tag to further specify the destination for this held payment, such as a hosted recipient at the destination address. | | `OwnerNode` | String | UInt64 | A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages. **Note:** The object does not contain a direct link to the owner directory containing it, since that value can be derived from the `Account`. | -| `DestinationNode` | String | UInt64 | _(Optional)_ A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages. Omitted on escrows created before enabling the [fix1523 amendment](known-amendments.html#fix1523). | +| `DestinationNode` | String | UInt64 | _(Optional)_ A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages. Omitted on escrows created before enabling the [fix1523 amendment][]. | | `PreviousTxnID` | String | Hash256 | The identifying hash of the transaction that most recently modified this object. | | `PreviousTxnLgrSeq` | Number | UInt32 | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. | diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md index 8040fb9878..82a644bf36 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md @@ -1,7 +1,7 @@ # PayChannel [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L141-L155 "Source") -_((ENABLED_ICON) Requires the [PayChan Amendment](known-amendments.html#paychan).)_ +_(Requires the [PayChan amendment][] :enabled:.)_ The `PayChannel` object type represents a payment channel. Payment channels enable small, rapid off-ledger payments of XRP that can be later reconciled with the consensus ledger. A payment channel holds a balance of XRP that can only be paid out to a specific destination address until the channel is closed. Any unspent XRP is returned to the channel's owner (the source address that created and funded it) when the channel closes. diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md index 7e0b376679..9e38b1270c 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md @@ -1,7 +1,7 @@ # SignerList [[Source]
](https://github.com/ripple/rippled/blob/6d2e3da30696bd10e3bb11a5ff6d45d2c4dae90f/src/ripple/protocol/impl/LedgerFormats.cpp#L127 "Source") -_((ENABLED_ICON) Requires the [MultiSign amendment](known-amendments.html#multisign).)_ +_(Requires the [MultiSign amendment][] :enabled:.)_ The `SignerList` object type represents a list of parties that, as a group, are authorized to sign a transaction in place of an individual account. You can create, replace, or remove a SignerList using a [SignerListSet transaction][]. @@ -71,21 +71,21 @@ When processing a multi-signed transaction, the server dereferences the `Account ## {{currentpage.name}} Flags -_((NOT_ENABLED_ICON) Requires the [MultiSignReserve Amendment](known-amendments.html#multisignreserve).)_ +_((NOT_ENABLED_ICON) Requires the [MultiSignReserve amendment][].)_ SignerList objects can have the following flag value: | Flag Name | Hex Value | Decimal Value | Description | |:-----------------|:-----------|:--------------|:-------------------------------| -| lsfOneOwnerCount | 0x00010000 | 65536 | If this flag is enabled, this SignerList counts as one item for purposes of the [owner reserve](reserves.html#owner-reserves). Otherwise, this list counts as N+2 items, where N is the number of signers it contains. This flag is automatically enabled if you add or update a signer list after the [MultiSignReserve amendment](known-amendments.html#multisignreserve) is enabled. | +| lsfOneOwnerCount | 0x00010000 | 65536 | If this flag is enabled, this SignerList counts as one item for purposes of the [owner reserve](reserves.html#owner-reserves). Otherwise, this list counts as N+2 items, where N is the number of signers it contains. This flag is automatically enabled if you add or update a signer list after the [MultiSignReserve amendment][] is enabled. | ## SignerLists and Reserves A SignerList contributes to its owner's [reserve requirement](reserves.html). -Without the [MultiSignReserve Amendment](known-amendments.html#multisignreserve), the SignerList itself counts as two objects, and each member of the list counts as one. As a result, the total owner reserve associated with a SignerList is anywhere from 3 times to 10 times the reserve required by a single trust line ([RippleState](ripplestate.html)) or [Offer](offer.html) object in the ledger. +Without the [MultiSignReserve amendment][], the SignerList itself counts as two objects, and each member of the list counts as one. As a result, the total owner reserve associated with a SignerList is anywhere from 3 times to 10 times the reserve required by a single trust line ([RippleState](ripplestate.html)) or [Offer](offer.html) object in the ledger. -(NOT_ENABLED_ICON) With the [MultiSignReserve Amendment](known-amendments.html#multisignreserve) enabled, the SignerList counts as one object, regardless of how many members it has. As a result, the owner reserve associated with a SignerList is 5 XRP, regardless of how many members it has. +(NOT_ENABLED_ICON) With the [MultiSignReserve amendment][] enabled, the SignerList counts as one object, regardless of how many members it has. As a result, the owner reserve associated with a SignerList is 5 XRP, regardless of how many members it has. The reserve requirement does not change for SignerLists created before the MultiSignReserve amendment. To take advantage of the new reserve, update the SignerList by sending a [SignerListSet transaction][]. diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md index 28e8dda045..aaffedc2db 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md @@ -1,7 +1,7 @@ # account_channels [[Source]
](https://github.com/ripple/rippled/blob/release/src/ripple/rpc/handlers/AccountChannels.cpp "Source") -_(Requires the [PayChan amendment](known-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ +_(Requires the [PayChan amendment][] to be enabled. [New in: rippled 0.33.0][])_ The `account_channels` method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger. diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md index 5d66d977fc..a23ba6aecc 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md @@ -57,8 +57,8 @@ The request contains the following parameters: | `strict` | Boolean | (Optional, defaults to False) If set to True, then the `account` field only accepts a public key or XRP Ledger address. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | -| `queue` | Boolean | _(Optional)_ If `true`, and the [FeeEscalation amendment](known-amendments.html#feeescalation) is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] | -| `signer_lists` | Boolean | _(Optional)_ If `true`, and the [MultiSign amendment](known-amendments.html#multisign) is enabled, also returns any [SignerList objects](signerlist.html) associated with this account. [New in: rippled 0.31.0][] | +| `queue` | Boolean | _(Optional)_ If `true`, and the [FeeEscalation amendment][] is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] | +| `signer_lists` | Boolean | _(Optional)_ If `true`, and the [MultiSign amendment][] is enabled, also returns any [SignerList objects](signerlist.html) associated with this account. [New in: rippled 0.31.0][] | The following fields are deprecated and should not be provided: `ident`, `ledger`. diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md index 0588a0b805..d87905f9a8 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md @@ -164,7 +164,7 @@ The response follows the [standard format][], with a successful result containin | `ledger.transactions` | Array | (Omitted unless requested) Transactions applied in this ledger version. By default, members are the transactions' identifying [Hash][] strings. If the request specified `expand` as true, members are full representations of the transactions instead, in either JSON or binary depending on whether the request specified `binary` as true. | | `ledger_hash` | String | Unique identifying hash of the entire ledger. | | `ledger_index` | Number | The [Ledger Index][] of this ledger. | -| `queue_data` | Array | (Omitted unless requested with the `queue` parameter) Array of objects describing queued transactions, in the same order as the queue. If the request specified `expand` as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified `binary` as true. Requires the [FeeEscalation amendment](known-amendments.html#feeescalation). [New in: rippled 0.70.0][] | +| `queue_data` | Array | (Omitted unless requested with the `queue` parameter) Array of objects describing queued transactions, in the same order as the queue. If the request specified `expand` as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified `binary` as true. Requires the [FeeEscalation amendment][]. [New in: rippled 0.70.0][] | The following fields are deprecated and may be removed without further notice: `accepted`, `hash` (use `ledger_hash` instead), `seqNum` (use `ledger_index` instead), `totalCoins` (use `total_coins` instead). diff --git a/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md index 9e065b16d6..52f0868411 100644 --- a/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md +++ b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md @@ -1,7 +1,7 @@ # channel_authorize [[Source]
](https://github.com/ripple/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L41 "Source") -_(Requires the [PayChan amendment](known-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ +_(Requires the [PayChan amendment][] to be enabled. [New in: rippled 0.33.0][])_ The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP from a payment channel. diff --git a/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md index b8edcfcff6..e37d5f5a57 100644 --- a/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md +++ b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md @@ -1,7 +1,7 @@ # channel_verify [[Source]
](https://github.com/ripple/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L89 "Source") -_(Requires the [PayChan amendment](known-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ +_(Requires the [PayChan amendment][] to be enabled. [New in: rippled 0.33.0][])_ The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. diff --git a/content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md b/content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md index e7c8a7d8d8..4e9061e4b0 100644 --- a/content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md +++ b/content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md @@ -1,7 +1,7 @@ # fee [[Source]
](https://github.com/ripple/rippled/blob/release/src/ripple/rpc/handlers/Fee1.cpp "Source") -The `fee` command reports the current state of the open-ledger requirements for the [transaction cost](transaction-cost.html). This requires the [FeeEscalation amendment](known-amendments.html#feeescalation) to be enabled. [New in: rippled 0.31.0][] +The `fee` command reports the current state of the open-ledger requirements for the [transaction cost](transaction-cost.html). This requires the [FeeEscalation amendment][] to be enabled. [New in: rippled 0.31.0][] This is a public command available to unprivileged users. [Updated in: rippled 0.32.0][New in: rippled 0.32.0] diff --git a/content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md index 9eb19bb83d..6e2ea72f7f 100644 --- a/content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md +++ b/content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md @@ -6,7 +6,7 @@ The `sign_for` command provides one signature for a [multi-signed transaction](m {% include '_snippets/public-signing-note.md' %} -This command requires the [MultiSign amendment](known-amendments.html#multisign) to be enabled. [New in: rippled 0.31.0][] +This command requires the [MultiSign amendment][] to be enabled. [New in: rippled 0.31.0][] ## Request Format An example of the request format: diff --git a/content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md index 339c5ba0d0..da60ca26c0 100644 --- a/content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md +++ b/content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md @@ -3,7 +3,7 @@ The `submit_multisigned` command applies a [multi-signed](multi-signing.html) transaction and sends it to the network to be included in future ledgers. (You can also submit multi-signed transactions in binary form using the [`submit` command in submit-only mode](submit.html#submit-only-mode).) -This command requires the [MultiSign amendment](known-amendments.html#multisign) to be enabled. [New in: rippled 0.31.0][] +This command requires the [MultiSign amendment][] to be enabled. [New in: rippled 0.31.0][] ## Request Format An example of the request format: diff --git a/content/references/rippled-api/transaction-formats/transaction-common-fields.md b/content/references/rippled-api/transaction-formats/transaction-common-fields.md index fffef8b4cd..65325b192a 100644 --- a/content/references/rippled-api/transaction-formats/transaction-common-fields.md +++ b/content/references/rippled-api/transaction-formats/transaction-common-fields.md @@ -56,7 +56,7 @@ To check whether a transaction has a given flag enabled, use the bitwise-and ope Most flags only have meaning for a specific transaction type. The same bitwise value may be reused for flags on different transaction types, so it is important to pay attention to the `TransactionType` field when setting and reading flags. -Bits that are not defined as flags MUST be 0. (The [fix1543 amendment](known-amendments.html#fix1543) enforces this rule on some transaction types. Most transaction types enforce this rule by default.) +Bits that are not defined as flags MUST be 0. (The [fix1543 amendment][] enforces this rule on some transaction types. Most transaction types enforce this rule by default.) ### Global Flags diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md b/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md index e0d12c9187..03061f6d06 100644 --- a/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md +++ b/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md @@ -19,7 +19,7 @@ For the most part, transactions with `tec` codes take no action other than to de | `tecINSUF_RESERVE_OFFER` | 123 | The transaction failed because the sending account does not have enough XRP to create a new Offer. (See: [Reserves](reserves.html)) | | `tecINSUFFICIENT_RESERVE` | 141 | The transaction would increase the [reserve requirement](reserves.html) higher than the sending account's balance. [SignerListSet][], [PaymentChannelCreate][], [PaymentChannelFund][], and [EscrowCreate][] can return this error code. See [SignerLists and Reserves](signerlist.html#signerlists-and-reserves) for more information. | | `tecINTERNAL` | 144 | Unspecified internal error, with transaction cost applied. This error code should not normally be returned. If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues). | -| `tecINVARIANT_FAILED` | 147 | An invariant check failed when trying to execute this transaction. Requires the [EnforceInvariants amendment](known-amendments.html#enforceinvariants). If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues). | +| `tecINVARIANT_FAILED` | 147 | An invariant check failed when trying to execute this transaction. Requires the [EnforceInvariants amendment][]. If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues). | | `tecNEED_MASTER_KEY` | 142 | This transaction tried to cause changes that require the master key, such as [disabling the master key or giving up the ability to freeze balances](accountset.html#accountset-flags). [New in: rippled 0.28.0][] | | `tecNO_ALTERNATIVE_KEY` | 130 | The transaction tried to remove the only available method of [authorizing transactions](transaction-basics.html#authorizing-transactions). This could be a [SetRegularKey transaction][] to remove the regular key, a [SignerListSet transaction][] to delete a SignerList, or an [AccountSet transaction][] to disable the master key. (Prior to `rippled` 0.30.0, this was called `tecMASTER_DISABLED`.) | | `tecNO_AUTH` | 134 | The transaction failed because it needs to add a balance on a trust line to an account with the `lsfRequireAuth` flag enabled, and that trust line has not been authorized. If the trust line does not exist at all, `tecNO_LINE` occurs instead. | @@ -27,7 +27,7 @@ For the most part, transactions with `tec` codes take no action other than to de | `tecNO_DST_INSUF_XRP` | 125 | The account on the receiving end of the transaction does not exist, and the transaction is not sending enough XRP to create it. | | `tecNO_ENTRY` | 140 | Reserved for future use. | | `tecNO_ISSUER` | 133 | The account specified in the `issuer` field of a currency amount does not exist. | -| `tecKILLED` | 150 | The [OfferCreate transaction][] specified the tfFillOrKill flag and could not be filled, so it was killed. _(Requires the [fix1578 amendment](known-amendments.html#fix1578).)_ | +| `tecKILLED` | 150 | The [OfferCreate transaction][] specified the tfFillOrKill flag and could not be filled, so it was killed. _(Requires the [fix1578 amendment][].)_ | | `tecNO_LINE` | 135 | The `TakerPays` field of the [OfferCreate transaction][] specifies an asset whose issuer has `lsfRequireAuth` enabled, and the account making the offer does not have a trust line for that asset. (Normally, making an offer implicitly creates a trust line if necessary, but in this case it does not bother because you cannot hold the asset without authorization.) If the trust line exists, but is not authorized, `tecNO_AUTH` occurs instead. | | `tecNO_LINE_INSUF_RESERVE` | 126 | The transaction failed because the sending account does not have enough XRP to create a new trust line. (See: [Reserves](reserves.html)) This error occurs when the counterparty does not have a trust line to this account for the same currency. (See `tecINSUF_RESERVE_LINE` for the other case.) | | `tecNO_LINE_REDUNDANT` | 127 | The transaction failed because it tried to set a trust line to its default state, but the trust line did not exist. | diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md b/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md index 6fcb8321a6..52824afab6 100644 --- a/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md +++ b/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md @@ -17,7 +17,7 @@ These codes indicate that the transaction failed and was not included in a ledge | `tefEXCEPTION` | While processing the transaction, the server entered an unexpected state. This may be caused by unexpected inputs, for example if the binary data for the transaction is grossly malformed. If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues) to get it fixed. | | `tefFAILURE` | Unspecified failure in applying the transaction. | | `tefINTERNAL` | When trying to apply the transaction, the server entered an unexpected state. If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues) to get it fixed. | -| `tefINVARIANT_FAILED` | An invariant check failed when trying to claim the [transaction cost](transaction-cost.html). Requires the [EnforceInvariants amendment](known-amendments.html#enforceinvariants). If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues). | +| `tefINVARIANT_FAILED` | An invariant check failed when trying to claim the [transaction cost](transaction-cost.html). Requires the [EnforceInvariants amendment][]. If you can reproduce this error, please [report an issue](https://github.com/ripple/rippled/issues). | | `tefMASTER_DISABLED` | The transaction was signed with the account's master key, but the account has the `lsfDisableMaster` field set. | | `tefMAX_LEDGER` | The transaction included a [`LastLedgerSequence`](reliable-transaction-submission.html#lastledgersequence) parameter, but the current ledger's sequence number is already higher than the specified value. | | `tefNO_AUTH_REQUIRED` | The [TrustSet transaction][] tried to mark a trustline as authorized, but the `lsfRequireAuth` flag is not enabled for the corresponding account, so authorization is not necessary. | diff --git a/content/references/rippled-api/transaction-formats/transaction-types/accountset.md b/content/references/rippled-api/transaction-formats/transaction-types/accountset.md index 56eeb8b86d..60a2cae9dd 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/accountset.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/accountset.md @@ -30,7 +30,7 @@ An AccountSet transaction modifies the properties of an [account in the XRP Ledg | MessageKey | String | Blob | _(Optional)_ Public key for sending encrypted messages to this account. | | [SetFlag][] | Number | UInt32 | _(Optional)_ Integer flag to enable for this account. | | [TransferRate][] | Unsigned Integer | UInt32 | _(Optional)_ The fee to charge when users transfer this account's issued currencies, represented as billionths of a unit. Cannot be more than `2000000000` or less than `1000000000`, except for the special case `0` meaning no fee. | -| [TickSize][] | Unsigned Integer | UInt8 | _(Optional)_ Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. _(Requires the [TickSize amendment](known-amendments.html#ticksize).)_ | +| [TickSize][] | Unsigned Integer | UInt8 | _(Optional)_ Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. _(Requires the [TickSize amendment][].)_ | | WalletLocator | String | Hash256 | _(Optional)_ Not used. | | WalletSize | Number | UInt32 | _(Optional)_ Not used. | @@ -72,7 +72,7 @@ The available AccountSet flags are: |:-----------------|:--------------|:--------------------------|:--------------| | asfAccountTxnID | 5 | (None) | Track the ID of this account's most recent transaction. Required for [AccountTxnID](transaction-common-fields.html#accounttxnid) | | asfDefaultRipple | 8 | lsfDefaultRipple | Enable [rippling](rippling.html) on this account's trust lines by default. [New in: rippled 0.27.3][] | -| asfDepositAuth | 9 | lsfDepositAuth | Enable [Deposit Authorization](depositauth.html) on this account. _(Requires the [DepositAuth amendment](known-amendments.html#depositauth).)_ | +| asfDepositAuth | 9 | lsfDepositAuth | Enable [Deposit Authorization](depositauth.html) on this account. _(Requires the [DepositAuth amendment][].)_ | | asfDisableMaster | 4 | lsfDisableMaster | Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions, such as a [Regular Key](cryptographic-keys.html) or a [Signer List](multi-signing.html). | | asfDisallowXRP | 3 | lsfDisallowXRP | XRP should not be sent to this account. (Enforced by client applications, not by `rippled`) | | asfGlobalFreeze | 7 | lsfGlobalFreeze | [Freeze](freezes.html) all assets issued by this account. | diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md index 167cb75091..59f3d19733 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md @@ -1,7 +1,7 @@ # CheckCancel [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/CancelCheck.cpp "Source") -_(NOT_ENABLED_ICON) Requires the [Checks Amendment](known-amendments.html#checks)._ +_(NOT_ENABLED_ICON) Requires the [Checks amendment][]._ Cancels an unredeemed Check, removing it from the ledger without sending any money. The source or the destination of the check can cancel a Check at any time using this transaction type. If the Check has expired, any address can cancel it. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md index df2b1f896d..c5a10ccd8d 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md @@ -1,7 +1,7 @@ # CheckCash [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/CashCheck.cpp "Source") -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding [CheckCreate transaction][]. Only the `Destination` address of a Check can cash it with a CheckCash transaction. Cashing a check this way is similar to executing a [Payment][] initiated by the destination. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md index 232d863170..8d3769d164 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md @@ -1,7 +1,7 @@ # CheckCreate [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/CreateCheck.cpp "Source") -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the Check. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md b/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md index 9ba384badc..8684f8d512 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md @@ -1,7 +1,7 @@ # DepositPreauth [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/DepositPreauth.cpp "Source") -_Requires the [DepositPreauth amendment](known-amendments.html#depositpreauth)._ +_Requires the [DepositPreauth amendment][]._ A DepositPreauth transaction gives another account pre-approval to deliver payments to the sender of this transaction. This is only useful if the sender of this transaction is using (or plans to use) [Deposit Authorization](depositauth.html). diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md index 213cd93434..427fdf9cf3 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md @@ -2,7 +2,7 @@ [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/Escrow.cpp "Source") -_Requires the [Escrow Amendment](known-amendments.html#escrow)._ +_Requires the [Escrow amendment][]._ Return escrowed XRP to the sender. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md index 9440c352d2..62201a9854 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md @@ -2,7 +2,7 @@ [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/Escrow.cpp "Source") -_Requires the [Escrow Amendment](known-amendments.html#escrow)._ +_Requires the [Escrow amendment][]._ Sequester XRP until the escrow process either finishes or is canceled. @@ -37,7 +37,7 @@ Sequester XRP until the escrow process either finishes or is canceled. Either `CancelAfter` or `FinishAfter` must be specified. If both are included, the `FinishAfter` time must be before the `CancelAfter` time. -With the [fix1571 amendment](known-amendments.html#fix1571) enabled, you must supply `FinishAfter`, `Condition`, or both. [New in: rippled 1.0.0][] +With the [fix1571 amendment][] enabled, you must supply `FinishAfter`, `Condition`, or both. [New in: rippled 1.0.0][] {% include '_snippets/rippled-api-links.md' %} diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md index aa9fff382c..53f42f9d07 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md @@ -2,7 +2,7 @@ [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/Escrow.cpp "Source") -_Requires the [Escrow Amendment](known-amendments.html#escrow)._ +_Requires the [Escrow amendment][]._ Deliver XRP from a held payment to the recipient. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md b/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md index 24fa3fb27e..d4ba120879 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md @@ -46,7 +46,7 @@ Transactions of the OfferCreate type support additional values in the [`Flags` f |:--------------------|:-----------|:--------------|:--------------------------| | tfPassive | 0x00010000 | 65536 | If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers that cross it. | | tfImmediateOrCancel | 0x00020000 | 131072 | Treat the offer as an [Immediate or Cancel order](http://en.wikipedia.org/wiki/Immediate_or_cancel). If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger. If the offer cannot match any offers immediately, it executes "successfully" without trading any currency. In this case, the transaction has the [result code](transaction-results.html) `tesSUCCESS`, but creates no [Offer objects](offer.html) in the ledger. | -| tfFillOrKill | 0x00040000 | 262144 | Treat the offer as a [Fill or Kill order](http://en.wikipedia.org/wiki/Fill_or_kill). Only try to match existing offers in the ledger, and only do so if the entire `TakerPays` quantity can be obtained. If the [fix1578 amendment](known-amendments.html#fix1578) is enabled and the offer cannot be executed when placed, the transaction has the [result code](transaction-results.html) `tecKILLED`; otherwise, the transaction uses the result code `tesSUCCESS` even when it was killed without trading any currency. | +| tfFillOrKill | 0x00040000 | 262144 | Treat the offer as a [Fill or Kill order](http://en.wikipedia.org/wiki/Fill_or_kill). Only try to match existing offers in the ledger, and only do so if the entire `TakerPays` quantity can be obtained. If the [fix1578 amendment][] is enabled and the offer cannot be executed when placed, the transaction has the [result code](transaction-results.html) `tecKILLED`; otherwise, the transaction uses the result code `tesSUCCESS` even when it was killed without trading any currency. | | tfSell | 0x00080000 | 524288 | Exchange the entire `TakerGets` amount, even if it means obtaining more than the `TakerPays` amount in exchange. | The following invalid flag combination prompts a `temINVALID_FLAG` error: diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md index 18cd8371af..3503f800e3 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md @@ -1,7 +1,7 @@ # PaymentChannelClaim [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/PayChan.cpp "Source") -_Requires the [PayChan Amendment](known-amendments.html#paychan)._ +_Requires the [PayChan amendment][]._ Claim XRP from a payment channel, adjust the payment channel's expiration, or both. This transaction can be used differently depending on the transaction sender's role in the specified channel: diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md index 3103c0d7d3..2489ea676d 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md @@ -1,7 +1,7 @@ # PaymentChannelCreate [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/PayChan.cpp "Source") -_Requires the [PayChan Amendment](known-amendments.html#paychan)._ +_Requires the [PayChan amendment][]._ Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel. diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md index 7e93d5b7bb..eadb6d767c 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md @@ -1,7 +1,7 @@ # PaymentChannelFund [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/PayChan.cpp "Source") -_Requires the [PayChan Amendment](known-amendments.html#paychan)._ +_Requires the [PayChan amendment][]._ Add additional XRP to an open payment channel, update the expiration time of the channel, or both. Only the source address of the channel can use this transaction. (Transactions from other addresses fail with the error `tecNO_PERMISSION`.) diff --git a/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md b/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md index ae219ed830..704b34c36f 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md @@ -1,7 +1,7 @@ # SignerListSet [[Source]
](https://github.com/ripple/rippled/blob/ef511282709a6a0721b504c6b7703f9de3eecf38/src/ripple/app/tx/impl/SetSignerList.cpp "Source") -The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to [multi-sign](multi-signing.html) a transaction. This transaction type was introduced by the [MultiSign amendment](known-amendments.html#multisign). [New in: rippled 0.31.0][] +The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to [multi-sign](multi-signing.html) a transaction. This transaction type was introduced by the [MultiSign amendment][]. [New in: rippled 0.31.0][] ## Example {{currentpage.name}} JSON @@ -51,7 +51,7 @@ You can create, update, or remove a SignerList using the master key, regular key You cannot remove the last method of signing transactions from an account. If an account's master key is disabled (it has the [`lsfDisableMaster` flag](accountroot.html#accountroot-flags) enabled) and the account does not have a [Regular Key](cryptographic-keys.html) configured, then you cannot delete the SignerList from the account. Instead, the transaction fails with the error [`tecNO_ALTERNATIVE_KEY`](tec-codes.html). -With the [MultiSignReserve Amendment](known-amendments.html#multisignreserve) enabled, creating or replacing a SignerList enables the lsfOneOwnerCount flag on the SignerList object. When this flag is enabled, the XRP Ledger is able to lower the [`OwnerCount`](accountroot.html#accountroot-fields) and [owner reserve](reserves.html#owner-reserves) for a SignerList as provided by the MultiSignReserve amendment. For more information, see [SignerList Flag](signerlist.html#signerlist-flags). +With the [MultiSignReserve amendment][] enabled, creating or replacing a SignerList enables the lsfOneOwnerCount flag on the SignerList object. When this flag is enabled, the XRP Ledger is able to lower the [`OwnerCount`](accountroot.html#accountroot-fields) and [owner reserve](reserves.html#owner-reserves) for a SignerList as provided by the MultiSignReserve amendment. For more information, see [SignerList Flag](signerlist.html#signerlist-flags). {% include '_snippets/rippled-api-links.md' %} diff --git a/content/references/rippled-api/transaction-formats/transaction-types/trustset.md b/content/references/rippled-api/transaction-formats/transaction-types/trustset.md index 6d039965eb..e9ff100620 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/trustset.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/trustset.md @@ -42,7 +42,7 @@ Transactions of the TrustSet type support additional values in the [`Flags` fiel | Flag Name | Hex Value | Decimal Value | Description | |:----------------|:-----------|:--------------|:------------------------------| | tfSetfAuth | 0x00010000 | 65536 | Authorize the other party to hold issuances from this account. (No effect unless using the [*asfRequireAuth* AccountSet flag](accountset.html#accountset-flags).) Cannot be unset. | -| tfSetNoRipple | 0x00020000 | 131072 | Blocks rippling between two trustlines of the same currency, if this flag is set on both. (See [No Ripple](rippling.html) for details.) If the [fix1578 amendment](known-amendments.html#fix1578) is enabled, a transaction that uses this flag and cannot enable NoRipple fails with the result code `tecNO_PERMISSION`. If the amendment is not enabled, the transaction can result in `tesSUCCESS` (making any other changes it can) even if it cannot enable NoRipple on the trust line. | +| tfSetNoRipple | 0x00020000 | 131072 | Blocks rippling between two trustlines of the same currency, if this flag is set on both. (See [No Ripple](rippling.html) for details.) If the [fix1578 amendment][] is enabled, a transaction that uses this flag and cannot enable NoRipple fails with the result code `tecNO_PERMISSION`. If the amendment is not enabled, the transaction can result in `tesSUCCESS` (making any other changes it can) even if it cannot enable NoRipple on the trust line. | | tfClearNoRipple | 0x00040000 | 262144 | Clears the No-Rippling flag. (See [NoRipple](rippling.html) for details.) | | tfSetFreeze | 0x00100000 | 1048576 | [Freeze](freezes.html) the trustline. | | tfClearFreeze | 0x00200000 | 2097152 | [Unfreeze](freezes.html) the trustline. | diff --git a/content/tutorials/manage-account-settings/set-up-multi-signing.md b/content/tutorials/manage-account-settings/set-up-multi-signing.md index 5b706a5959..bceb8d67d5 100644 --- a/content/tutorials/manage-account-settings/set-up-multi-signing.md +++ b/content/tutorials/manage-account-settings/set-up-multi-signing.md @@ -18,9 +18,9 @@ This tutorial demonstrates how to enable multi-signing for an address. You need an XRP Ledger address that can send transactions, and has enough XRP available. -Without the [MultiSignReserve Amendment](known-amendments.html#multisignreserve), multi-signing requires more than the usual amount of XRP for the [account reserve](reserves.html) and [transaction cost](transaction-cost.html), increasing with the number of signers and signatures you use. +Without the [MultiSignReserve amendment][], multi-signing requires more than the usual amount of XRP for the [account reserve](reserves.html) and [transaction cost](transaction-cost.html), increasing with the number of signers and signatures you use. -With the [MultiSignReserve Amendment](known-amendments.html#multisignreserve) enabled, multi-signing requires 5 XRP for the account reserve, regardless of the number of signers and signatures you use. The [transaction cost](transaction-cost.html) of a multi-signed transaction is unaffected by this amendment and still increases with the number of signers and signatures you use. +With the [MultiSignReserve amendment][] enabled, multi-signing requires 5 XRP for the account reserve, regardless of the number of signers and signatures you use. The [transaction cost](transaction-cost.html) of a multi-signed transaction is unaffected by this amendment and still increases with the number of signers and signatures you use. If you started `rippled` in [stand-alone mode](rippled-server-modes.html#reasons-to-run-a-rippled-server-in-stand-alone-mode) with a new genesis ledger, you must: @@ -133,7 +133,7 @@ In this example, the SignerList has 3 members, with the weights and quorum set u Make sure that the [Transaction Result](transaction-results.html) is [**tesSUCCESS**](tes-success.html). Otherwise, the transaction failed. If you have a problem in stand-alone mode or a non-production network, check that [multi-sign is enabled](start-a-new-genesis-ledger-in-stand-alone-mode.html#settings-in-new-genesis-ledgers). -**Note:** Without the [MultiSignReserve Amendment](known-amendments.html#multisignreserve), the more members in the SignerList, the more XRP your address must have for purposes of the [owner reserve](reserves.html#owner-reserves). If your address does not have enough XRP, the transaction fails with [tecINSUFFICIENT_RESERVE](tec-codes.html). With the [MultiSignReserve Amendment](known-amendments.html#multisignreserve) enabled, the XRP your address must have for purposes of the [owner reserve](reserves.html#owner-reserves) is 5 XRP, regardless of the number of members in the SignerList. See also: [SignerLists and Reserves](signerlist.html#signerlists-and-reserves). +**Note:** Without the [MultiSignReserve amendment][], the more members in the SignerList, the more XRP your address must have for purposes of the [owner reserve](reserves.html#owner-reserves). If your address does not have enough XRP, the transaction fails with [tecINSUFFICIENT_RESERVE](tec-codes.html). With the [MultiSignReserve amendment][] enabled, the XRP your address must have for purposes of the [owner reserve](reserves.html#owner-reserves) is 5 XRP, regardless of the number of members in the SignerList. See also: [SignerLists and Reserves](signerlist.html#signerlists-and-reserves). ## 4. Close the ledger diff --git a/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md b/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md index ed98c422b1..ef6536d1a5 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md +++ b/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md @@ -1,6 +1,6 @@ # Cancel a Check -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ This tutorial shows how to cancel a [Check](checks.html), which removes the [Check object from the ledger](check.html) without sending money. diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md b/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md index 680e68d1aa..3db0b484df 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md +++ b/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md @@ -1,6 +1,6 @@ # Cash a Check for a Flexible Amount -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ As long as the Check is in the ledger and not expired, the specified recipient can cash it to receive a flexible amount by sending a [CheckCash transaction][] with a `DeliverMin` field. When cashing a Check in this way, the receiver gets as much as is possible to deliver, debiting the Check's sender for the Check's full `SendMax` amount or as much as is available. Cashing fails if it doesn't deliver at least the `DeliverMin` amount to the Check's recipient. diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md b/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md index 980bf0cd1c..0a547fbcc3 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md +++ b/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md @@ -1,6 +1,6 @@ # Cash a Check for an Exact Amount -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ As long as the Check is in the ledger and not expired, the specified recipient can cash it to receive any exact amount up to the amount specified in the Check by sending a [CheckCash transaction][] with an `Amount` field. You would cash a Check this way if you want to receive a specific amount, for example to pay off an invoice or bill exactly. diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md b/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md index e989e96c8a..bcbd8bea35 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md +++ b/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md @@ -1,6 +1,6 @@ # Look Up Checks by Recipient -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ This tutorial shows how to look up [Checks](checks.html) by their recipient. You may also want to [look up Checks by sender](look-up-checks-by-sender.html). diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md b/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md index dde9a7a601..b1b5c46c0d 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md +++ b/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md @@ -1,6 +1,6 @@ # Look Up Checks by Sender -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ This tutorial shows how to look up [Checks](checks.html) by their sender. You may also want to [look up Checks by recipient](look-up-checks-by-recipient.html). diff --git a/content/tutorials/use-complex-payment-types/use-checks/send-a-check.md b/content/tutorials/use-complex-payment-types/use-checks/send-a-check.md index 669d0feb5a..7fe07051d0 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/send-a-check.md +++ b/content/tutorials/use-complex-payment-types/use-checks/send-a-check.md @@ -1,6 +1,6 @@ # Send a Check -_Requires the [Checks Amendment](known-amendments.html#checks)._ +_Requires the [Checks amendment][]._ Sending a Check is like writing permission for an intended recipient to pull a payment from you. The outcome of this process is a [Check object in the ledger](check.html) which the recipient can cash later. diff --git a/content/tutorials/use-complex-payment-types/use-checks/use-checks.md b/content/tutorials/use-complex-payment-types/use-checks/use-checks.md index cd381231c2..b6870bb36a 100644 --- a/content/tutorials/use-complex-payment-types/use-checks/use-checks.md +++ b/content/tutorials/use-complex-payment-types/use-checks/use-checks.md @@ -2,4 +2,4 @@ Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work. -**Caution:** As of 2018-10-11, the [Checks amendment](known-amendments.html#checks) is not enabled on the XRP Ledger. You can use Checks on the [XRP Test Net](xrp-test-net-faucet.html) only. +**Caution:** As of 2018-10-11, the [Checks amendment][] is not enabled on the XRP Ledger. You can use Checks on the [XRP Test Net](xrp-test-net-faucet.html) only. diff --git a/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md b/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md index 40a95c999e..c40505f0dc 100644 --- a/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md +++ b/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md @@ -43,7 +43,7 @@ _Websocket_ You can use the [account_objects method][] to look up escrow objects by destination address. -**Note:** You can only look up pending escrow objects by destination address if those escrows were created after the [fix1523 amendment](known-amendments.html#fix1523) was enabled on 2017-11-14. +**Note:** You can only look up pending escrow objects by destination address if those escrows were created after the [fix1523 amendment][] was enabled on 2017-11-14. Let's say that you want to look up all pending escrow objects with a destination address of `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`. You can do this using the following example request, where the destination address is the `account` value. diff --git a/dactyl-config.yml b/dactyl-config.yml index faa1114d73..d0aafd4117 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2219,6 +2219,7 @@ pages: category: Ledger Data Formats subcategory: Ledger Object Types blurb: A check that can be redeemed for money by its destination. + status: not_enabled targets: - local diff --git a/tool/filter_status_badges.py b/tool/filter_status_badges.py index 2ae9417b8e..8406822655 100644 --- a/tool/filter_status_badges.py +++ b/tool/filter_status_badges.py @@ -11,8 +11,8 @@ import os.path STATUSES = { - "(NOT_ENABLED_ICON)": "template-status_not_enabled.html", - "(ENABLED_ICON)": "template-status_enabled.html", + ":not_enabled:": "template-status_not_enabled.html", + ":enabled:": "template-status_enabled.html", }