mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-12-03 10:05:49 +00:00
tasks -> how-tos
This commit is contained in:
committed by
Amarantha Kulkarni
parent
5f5852a57e
commit
5c12a9b80a
@@ -74,8 +74,8 @@ If a standby address is compromised, the consequences are like an operational ad
|
||||
- [Accounts](index.md)
|
||||
- [Cryptographic Keys](cryptographic-keys.md)
|
||||
- **Tutorials:**
|
||||
- [Assign a Regular Key Pair](../../tutorials/tasks/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Change or Remove a Regular Key Pair](../../tutorials/tasks/manage-account-settings/change-or-remove-a-regular-key-pair.md)
|
||||
- [Assign a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Change or Remove a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/change-or-remove-a-regular-key-pair.md)
|
||||
- **References:**
|
||||
- [account_info method][]
|
||||
- [SetRegularKey transaction][]
|
||||
|
||||
@@ -88,7 +88,7 @@ The [wallet_propose method][] is one way of generating a master key pair. The re
|
||||
|
||||
**Warning:** If a malicious actor learns your master private key (or seed), they have full control over your account, unless your master key pair is disabled. They can take all the money your account holds and do other irreparable harm. Treat your secret values with care!
|
||||
|
||||
Because changing a master key pair is impossible, you should treat it with care proportionate to the value it holds. A good practice is to [keep your master key pair offline](../../tutorials/tasks/manage-account-settings/offline-account-setup.md) and set up a regular key pair to sign transactions from your account instead. By keeping the master key pair enabled but offline, you can be reasonably certain that no one can get access to it using the internet, but you can still go find it to use in an emergency.
|
||||
Because changing a master key pair is impossible, you should treat it with care proportionate to the value it holds. A good practice is to [keep your master key pair offline](../../tutorials/how-tos/manage-account-settings/offline-account-setup.md) and set up a regular key pair to sign transactions from your account instead. By keeping the master key pair enabled but offline, you can be reasonably certain that no one can get access to it using the internet, but you can still go find it to use in an emergency.
|
||||
|
||||
Keeping your master key pair offline means not putting the secret information (passphrase, seed, or private key) anywhere that malicious actors can get access to it. In general, this means it is not within reach of a computer program that interacts with the internet at large. For example, you could keep it on an air-gapped machine that never connects to the internet, on a piece of paper stored in a safe, or have it completely memorized. (Memorization has some drawbacks, though, including making it impossible to pass the key on after you are dead.)
|
||||
|
||||
@@ -119,7 +119,7 @@ A good security practice is to save your master private key somewhere offline, a
|
||||
|
||||
Regular key pairs have the same format as master key pairs. You generate them the same way (for example, using the [wallet_propose method][]). The only difference is that a regular key pair is not intrinsically tied to the account it signs transactions for. It is possible (but not a good idea) to use the master key pair from one account as the regular key pair for another account.
|
||||
|
||||
The [SetRegularKey transaction][] assigns or changes the regular key pair for an account. For a tutorial on assigning or changing a regular key pair, see [Assign a Regular Key Pair](../../tutorials/tasks/manage-account-settings/assign-a-regular-key-pair.md).
|
||||
The [SetRegularKey transaction][] assigns or changes the regular key pair for an account. For a tutorial on assigning or changing a regular key pair, see [Assign a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/assign-a-regular-key-pair.md).
|
||||
|
||||
|
||||
## Signing Algorithms
|
||||
@@ -248,8 +248,8 @@ The steps to derive the XRP Ledger's secp256k1 account key pair from a seed valu
|
||||
- **Concepts:**
|
||||
- [Issuing and Operational Addresses](account-types.md)
|
||||
- **Tutorials:**
|
||||
- [Assign a Regular Key Pair](../../tutorials/tasks/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Change or Remove a Regular Key Pair](../../tutorials/tasks/manage-account-settings/change-or-remove-a-regular-key-pair.md)
|
||||
- [Assign a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Change or Remove a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/change-or-remove-a-regular-key-pair.md)
|
||||
- **References:**
|
||||
- [SetRegularKey transaction][]
|
||||
- [AccountRoot ledger object](../../references/protocol/ledger-data/ledger-entry-types/accountroot.md)
|
||||
|
||||
@@ -63,7 +63,7 @@ The typical way to get an account in the XRP Ledger is as follows:
|
||||
- [Payment transaction][]
|
||||
- [AccountRoot object](../../references/protocol/ledger-data/ledger-entry-types/accountroot.md)
|
||||
- **Tutorials:**
|
||||
- [Manage Account Settings (Category)](../../tutorials/tasks/manage-account-settings/index.md)
|
||||
- [Manage Account Settings (Category)](../../tutorials/how-tos/manage-account-settings/index.md)
|
||||
- [Monitor Incoming Payments with WebSocket](../../tutorials/http-websocket-apis/build-apps/monitor-incoming-payments-with-websocket.md)
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -60,7 +60,7 @@ There might be a scenario where you create a multi-signing list as a "backup pla
|
||||
|
||||
To successfully submit a multi-signed transaction, you must do all of the following:
|
||||
|
||||
* The address sending the transaction (specified in the `Account` field) must have a [`SignerList` object in the ledger](../../references/protocol/ledger-data/ledger-entry-types/signerlist.md). For instructions on how to do this, see [Set Up Multi-Signing](../../tutorials/tasks/manage-account-settings/set-up-multi-signing.md).
|
||||
* The address sending the transaction (specified in the `Account` field) must have a [`SignerList` object in the ledger](../../references/protocol/ledger-data/ledger-entry-types/signerlist.md). For instructions on how to do this, see [Set Up Multi-Signing](../../tutorials/how-tos/manage-account-settings/set-up-multi-signing.md).
|
||||
* The transaction must include the `SigningPubKey` field as an empty string.
|
||||
* The transaction must include a [`Signers` field](../../references/protocol/transactions/common-fields.md#signers-field) containing an array of signatures.
|
||||
* The signatures present in the `Signers` array must match signers defined in the `SignerList`.
|
||||
@@ -72,8 +72,8 @@ To successfully submit a multi-signed transaction, you must do all of the follow
|
||||
## See Also
|
||||
|
||||
- **Tutorials:**
|
||||
- [Set Up Multi-Signing](../../tutorials/tasks/manage-account-settings/set-up-multi-signing.md)
|
||||
- [Send a Multi-Signed Transaction](../../tutorials/tasks/manage-account-settings/send-a-multi-signed-transaction.md)
|
||||
- [Set Up Multi-Signing](../../tutorials/how-tos/manage-account-settings/set-up-multi-signing.md)
|
||||
- [Send a Multi-Signed Transaction](../../tutorials/how-tos/manage-account-settings/send-a-multi-signed-transaction.md)
|
||||
- **Concepts:**
|
||||
- [Cryptographic Keys](cryptographic-keys.md)
|
||||
- [Special Transaction Cost for Multi-signed transactions](../transactions/transaction-cost.md#special-transaction-costs)
|
||||
|
||||
@@ -63,7 +63,7 @@ Any account can create and use Tickets on any type of transaction. However, some
|
||||
- **Concepts:**
|
||||
- [Multi-Signing](multi-signing.md)
|
||||
- **Tutorials:**
|
||||
- [Use Tickets](../../tutorials/tasks/manage-account-settings/use-tickets.md)
|
||||
- [Use Tickets](../../tutorials/how-tos/manage-account-settings/use-tickets.md)
|
||||
- **References:**
|
||||
- [TicketCreate transaction][]
|
||||
- [Transaction Common Fields](../../references/protocol/transactions/common-fields.md)
|
||||
|
||||
@@ -48,19 +48,19 @@ For more information about Checks in the XRP Ledger, see:
|
||||
- [CheckCreate][]
|
||||
- [CheckCash][]
|
||||
- [CheckCancel][]
|
||||
- [Checks Tutorials](../../tutorials/tasks/use-specialized-payment-types/use-checks/use-checks.md)
|
||||
- [Send a Check](../../tutorials/tasks/use-specialized-payment-types/use-checks/send-a-check.md)
|
||||
- [Look up Checks by sender address](../../tutorials/tasks/use-specialized-payment-types/use-checks/look-up-checks-by-sender.md)
|
||||
- [Look up Checks by recipient address](../../tutorials/tasks/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.md)
|
||||
- [Cash a Check for an exact amount](../../tutorials/tasks/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.md)
|
||||
- [Cash a Check for a flexible amount](../../tutorials/tasks/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md)
|
||||
- [Cancel a Check](../../tutorials/tasks/use-specialized-payment-types/use-checks/cancel-a-check.md)
|
||||
- [Checks Tutorials](../../tutorials/how-tos/use-specialized-payment-types/use-checks/use-checks.md)
|
||||
- [Send a Check](../../tutorials/how-tos/use-specialized-payment-types/use-checks/send-a-check.md)
|
||||
- [Look up Checks by sender address](../../tutorials/how-tos/use-specialized-payment-types/use-checks/look-up-checks-by-sender.md)
|
||||
- [Look up Checks by recipient address](../../tutorials/how-tos/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.md)
|
||||
- [Cash a Check for an exact amount](../../tutorials/how-tos/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.md)
|
||||
- [Cash a Check for a flexible amount](../../tutorials/how-tos/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md)
|
||||
- [Cancel a Check](../../tutorials/how-tos/use-specialized-payment-types/use-checks/cancel-a-check.md)
|
||||
- [Checks amendment][]
|
||||
|
||||
For more information about related features, see:
|
||||
|
||||
* [Deposit Authorization](../accounts/depositauth.md)
|
||||
* [Escrow](escrow.md)
|
||||
* [Payment Channels Tutorial](../../tutorials/tasks/use-specialized-payment-types/use-payment-channels/index.md)
|
||||
* [Payment Channels Tutorial](../../tutorials/how-tos/use-specialized-payment-types/use-payment-channels/index.md)
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -39,7 +39,7 @@ The basis of any financial system is transferring value. The quickest and simple
|
||||
## See Also
|
||||
|
||||
- **Tutorials:**
|
||||
- [Send XRP (Interactive Tutorial)](../../tutorials/tasks/send-xrp.md)
|
||||
- [Send XRP (Interactive Tutorial)](../../tutorials/how-tos/send-xrp.md)
|
||||
- [Monitor Incoming Payments with WebSocket](../../tutorials/http-websocket-apis/build-apps/monitor-incoming-payments-with-websocket.md)
|
||||
- **References:**
|
||||
- [Payment transaction][]
|
||||
|
||||
@@ -82,7 +82,7 @@ reference_fee * (signer_count + 33 + (fulfillment_bytes / 16))
|
||||
|
||||
For more information about Escrow in the XRP Ledger, see the following:
|
||||
|
||||
- [Escrow Tutorials](../../tutorials/tasks/use-specialized-payment-types/use-escrows/index.md)
|
||||
- [Escrow Tutorials](../../tutorials/how-tos/use-specialized-payment-types/use-escrows/index.md)
|
||||
- [Transaction Reference](../../references/protocol/transactions/index.md)
|
||||
- [EscrowCreate transaction][]
|
||||
- [EscrowFinish transaction][]
|
||||
|
||||
@@ -129,7 +129,7 @@ Using [the `delivered_amount` field](#the-delivered_amount-field) when processin
|
||||
- **Tutorials:**
|
||||
- [Look Up Transaction Results](../transactions/finality-of-results/look-up-transaction-results.md)
|
||||
- [Monitor Incoming Payments with WebSocket](../../tutorials/http-websocket-apis/build-apps/monitor-incoming-payments-with-websocket.md)
|
||||
- [Use Specialized Payment Types](../../tutorials/tasks/use-specialized-payment-types/index.md)
|
||||
- [Use Specialized Payment Types](../../tutorials/how-tos/use-specialized-payment-types/index.md)
|
||||
- [List XRP as an Exchange](../../use-cases/defi/list-xrp-as-an-exchange.md)
|
||||
- **References:**
|
||||
- [Payment transaction][]
|
||||
|
||||
@@ -39,8 +39,8 @@ The following diagram summarizes the lifecycle of a payment channel:
|
||||
- **Related Concepts:**
|
||||
- [Escrow](escrow.md), a similar feature for higher-value, lower-speed conditional XRP payments.
|
||||
- **Tutorials and Use Cases:**
|
||||
- [Use Payment Channels](../../tutorials/tasks/use-specialized-payment-types/use-payment-channels/index.md), a tutorial stepping through the process of using a payment channel.
|
||||
- [Open a Payment Channel to Enable an Inter-Exchange Network](../../tutorials/tasks/use-specialized-payment-types/use-payment-channels/open-a-payment-channel-to-enable-an-inter-exchange-network.md)
|
||||
- [Use Payment Channels](../../tutorials/how-tos/use-specialized-payment-types/use-payment-channels/index.md), a tutorial stepping through the process of using a payment channel.
|
||||
- [Open a Payment Channel to Enable an Inter-Exchange Network](../../tutorials/how-tos/use-specialized-payment-types/use-payment-channels/open-a-payment-channel-to-enable-an-inter-exchange-network.md)
|
||||
- **References:**
|
||||
- [channel_authorize method][]
|
||||
- [channel_verify method][]
|
||||
|
||||
@@ -19,6 +19,6 @@ Generally, when sending stablecoins, you use a [Payment transaction][]. Some of
|
||||
- Omit the `Paths` field. This field is unnecessary when sending directly from the issuer, or from a hot wallet as long as the tokens being sent and the tokens being received have the same currency code and issuer—that is, they're the same stablecoin. The `Paths` field is intended for [Cross-Currency Payments](cross-currency-payments.md) and longer multi-hop (rippling) payments. If you naively perform pathfinding and attach the paths to your transaction, your payment may take a more expensive indirect route rather than failing if the direct path is not available; malicious users can even set this up to.
|
||||
- If you get a `tecPATH_DRY` result code, this usually indicates that either the customer doesn't have the necessary trust line set up already, or your issuer's rippling settings aren't configured correctly.
|
||||
|
||||
For a detailed tutorial on issuing a token on the XRP Ledger, whether a stablecoin or otherwise, see [Issue a Fungible Token](../../tutorials/tasks/use-tokens/issue-a-fungible-token.md).
|
||||
For a detailed tutorial on issuing a token on the XRP Ledger, whether a stablecoin or otherwise, see [Issue a Fungible Token](../../tutorials/how-tos/use-tokens/issue-a-fungible-token.md).
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -12,7 +12,7 @@ targets:
|
||||
|
||||
The XRP Ledger has possibly the world's oldest _decentralized exchange_ (sometimes abbreviated "DEX"), operating continuously since the XRP Ledger's launch in 2012. The exchange allows users to buy and sell [tokens](../index.md) for XRP or other tokens, with minimal [fees](../../transactions/fees.md) charged to the network itself (not paid out to any party).
|
||||
|
||||
**Caution:** Anyone can [issue a token](../../../tutorials/tasks/use-tokens/issue-a-fungible-token.md) with any currency code or ticker symbol they want and sell it in the decentralized exchange. Always perform due diligence before buying a token, and pay attention to the issuer. Otherwise, you might give up something of value and receive worthless tokens in exchange.
|
||||
**Caution:** Anyone can [issue a token](../../../tutorials/how-tos/use-tokens/issue-a-fungible-token.md) with any currency code or ticker symbol they want and sell it in the decentralized exchange. Always perform due diligence before buying a token, and pay attention to the issuer. Otherwise, you might give up something of value and receive worthless tokens in exchange.
|
||||
|
||||
## Structure
|
||||
|
||||
|
||||
@@ -87,9 +87,9 @@ You can only enable the No Freeze setting with a transaction signed by your addr
|
||||
- **Concepts:**
|
||||
- [Trust Lines and Issuing](index.md)
|
||||
- **Tutorials:**
|
||||
- [Enable No Freeze](../../../tutorials/tasks/use-tokens/enable-no-freeze.md)
|
||||
- [Enact Global Freeze](../../../tutorials/tasks/use-tokens/enact-global-freeze.md)
|
||||
- [Freeze a Trust Line](../../../tutorials/tasks/use-tokens/freeze-a-trust-line.md)
|
||||
- [Enable No Freeze](../../../tutorials/how-tos/use-tokens/enable-no-freeze.md)
|
||||
- [Enact Global Freeze](../../../tutorials/how-tos/use-tokens/enact-global-freeze.md)
|
||||
- [Freeze a Trust Line](../../../tutorials/how-tos/use-tokens/freeze-a-trust-line.md)
|
||||
- **References:**
|
||||
- [account_lines method][]
|
||||
- [account_info method][]
|
||||
|
||||
@@ -8,7 +8,7 @@ labels:
|
||||
---
|
||||
# Stablecoin Configuration
|
||||
|
||||
There are some settings you must configure on your XRP Ledger account before you start issuing tokens. For examples of how to configure these settings, see [Issue a Fungible Token](../../../../tutorials/tasks/use-tokens/issue-a-fungible-token.md).
|
||||
There are some settings you must configure on your XRP Ledger account before you start issuing tokens. For examples of how to configure these settings, see [Issue a Fungible Token](../../../../tutorials/how-tos/use-tokens/issue-a-fungible-token.md).
|
||||
|
||||
Settings you might want to configure include:
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ To guarantee a fixed number of NFTs:
|
||||
1. Use `AccountSet` to assign your operational wallet as an authorized minter for the issuer. See [Authorizing Another Account to Mint Your NFTs](authorizing-another-minter.md).
|
||||
1. Use your operational account to mint the tokens using `NFTokenMint`. The operational wallet holds all of the tokens minted for the Issuer. See [Batch Minting](batch-minting.md).
|
||||
1. Use `AccountSet` to remove your operational wallet as an authorized minter for the Issuer.
|
||||
1. “Blackhole” the Issuer account. See [Disable Master Key Pair](../../../tutorials/tasks/manage-account-settings/disable-master-key-pair.md).
|
||||
1. “Blackhole” the Issuer account. See [Disable Master Key Pair](../../../tutorials/how-tos/manage-account-settings/disable-master-key-pair.md).
|
||||
|
||||
At this point, it is impossible for any new tokens to be minted with the issuer’s address as the issuing account.
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ Sending a transaction to the XRP Ledger involves several steps:
|
||||
5. The servers apply those transactions to the previous ledger in a canonical order and share their results.
|
||||
6. If enough [trusted validators](../networks-and-servers/rippled-server-modes.md#validators) created the exact same ledger, that ledger is declared _validated_ and the [results of the transactions](../../references/protocol/transactions/transaction-results/transaction-results.md) in that ledger are immutable.
|
||||
|
||||
See [Send XRP](../../tutorials/tasks/send-xrp.md) for an interactive tutorial in sending XRP payments.
|
||||
See [Send XRP](../../tutorials/how-tos/send-xrp.md) for an interactive tutorial in sending XRP payments.
|
||||
|
||||
|
||||
### Example Unsigned Transaction
|
||||
@@ -207,7 +207,7 @@ Example response from the `tx` command:
|
||||
- [Payment Types](../payment-types/index.md)
|
||||
- **Tutorials:**
|
||||
- [Set Up Secure Signing](secure-signing.md)
|
||||
- [Send XRP](../../tutorials/tasks/send-xrp.md)
|
||||
- [Send XRP](../../tutorials/how-tos/send-xrp.md)
|
||||
- [Look Up Transaction Results](finality-of-results/look-up-transaction-results.md)
|
||||
- [Monitor Incoming Payments with WebSocket](../../tutorials/http-websocket-apis/build-apps/monitor-incoming-payments-with-websocket.md)
|
||||
- [Cancel or Skip a Transaction](finality-of-results/canceling-a-transaction.md)
|
||||
|
||||
@@ -170,7 +170,7 @@ The difference between the two transaction failure cases (labeled (1) and (2) in
|
||||
|
||||
**Tip:** The [`AccountTxnID` field](../../references/protocol/transactions/common-fields.md#accounttxnid) can help prevent redundant transactions from succeeding in this situation.
|
||||
|
||||
- A malicious actor may have used your secret key to send a transaction. If this is the case, [rotate your key pair](../../tutorials/tasks/manage-account-settings/change-or-remove-a-regular-key-pair.md) if you can, and check for other transactions sent. You should also audit your network to determine if the secret key was part of a larger intrusion or security leak. When you successfully rotate your key pair and are certain that the malicious actor no longer has access to your accounts and systems, you can resume normal activities.
|
||||
- A malicious actor may have used your secret key to send a transaction. If this is the case, [rotate your key pair](../../tutorials/how-tos/manage-account-settings/change-or-remove-a-regular-key-pair.md) if you can, and check for other transactions sent. You should also audit your network to determine if the secret key was part of a larger intrusion or security leak. When you successfully rotate your key pair and are certain that the malicious actor no longer has access to your accounts and systems, you can resume normal activities.
|
||||
|
||||
|
||||
#### Ledger Gaps
|
||||
|
||||
@@ -140,7 +140,7 @@ To use this configuration, follow the steps for [running `rippled` on a private
|
||||
- [Multi-Signing](../accounts/multi-signing.md)
|
||||
- **Tutorials:**
|
||||
- [Install rippled](../../infrastructure/installation/index.md)
|
||||
- [Assign a Regular Key Pair](../../tutorials/tasks/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Assign a Regular Key Pair](../../tutorials/how-tos/manage-account-settings/assign-a-regular-key-pair.md)
|
||||
- [Reliable Transaction Submission](reliable-transaction-submission.md)
|
||||
- [Enable Public Signing](../../infrastructure/configuration/enable-public-signing.md)
|
||||
- **References:**
|
||||
|
||||
@@ -42,12 +42,12 @@ Assigning tags in numerical order provides less privacy to customers. Since all
|
||||
|
||||
## Requiring Tags
|
||||
|
||||
For an XRP Ledger address that may receive payments intended for several customer accounts, receiving a payment _without_ a destination tag can be a problem: it is not immediately obvious which customer to credit, which can require a manual intervention and a discussion with the sender to figure out who was the intended recipient. To reduce cases like this, you can [enable the `RequireDest` setting](../../tutorials/tasks/manage-account-settings/require-destination-tags.md). That way, if a user forgets to include a destination tag in a payment, the XRP Ledger rejects their payment instead of giving you money you don't know what to do with. The user can then send the payment again, using the tag as they should have.
|
||||
For an XRP Ledger address that may receive payments intended for several customer accounts, receiving a payment _without_ a destination tag can be a problem: it is not immediately obvious which customer to credit, which can require a manual intervention and a discussion with the sender to figure out who was the intended recipient. To reduce cases like this, you can [enable the `RequireDest` setting](../../tutorials/how-tos/manage-account-settings/require-destination-tags.md). That way, if a user forgets to include a destination tag in a payment, the XRP Ledger rejects their payment instead of giving you money you don't know what to do with. The user can then send the payment again, using the tag as they should have.
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
- [Require Destination Tags](../../tutorials/tasks/manage-account-settings/require-destination-tags.md)
|
||||
- [Require Destination Tags](../../tutorials/how-tos/manage-account-settings/require-destination-tags.md)
|
||||
- [Payment Types](../payment-types/index.md)
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -333,7 +333,7 @@ export default function Docs() {
|
||||
</a>
|
||||
</div>
|
||||
<div className="col langs">
|
||||
<a href="/docs/tutorials/java/get-started/">
|
||||
<a href="/docs/tutorials/java/build-apps/get-started/">
|
||||
<img alt="Java Logo" src={require('../static/img/logos/java.svg')} className="circled-logo" />
|
||||
<h5 className="btn-arrow">{translate('Java')}</h5>
|
||||
</a>
|
||||
|
||||
@@ -227,7 +227,7 @@ The `account_flags` field contains the following nested fields:
|
||||
| `noFreeze` | Boolean | If `true`, the account has permanently given up the abilities to freeze individual trust lines or end a global freeze. See [No Freeze](../../../../concepts/tokens/fungible-tokens/freezes.md#no-freeze) for details. |
|
||||
| `passwordSpent` | Boolean | If `false`, the account can send a special [key reset transaction](../../../../concepts/transactions/transaction-cost.md#key-reset-transaction) with a transaction cost of 0. The protocol turns this flag on and off automatically; it is not controlled by a user-facing setting. |
|
||||
| `requireAuthorization` | Boolean | If `true`, the account is using [Authorized Trust Lines](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md) to limit who can hold the tokens it issues. |
|
||||
| `requireDestinationTag` | Boolean | If `true`, the account [requires a destination tag](../../../../tutorials/tasks/manage-account-settings/require-destination-tags.md) on all payments it receives. |
|
||||
| `requireDestinationTag` | Boolean | If `true`, the account [requires a destination tag](../../../../tutorials/how-tos/manage-account-settings/require-destination-tags.md) on all payments it receives. |
|
||||
|
||||
The `queue_data` field, if present, contains the following nested fields:
|
||||
|
||||
|
||||
@@ -75,6 +75,6 @@ The ID of a `Check` entry is the [SHA-512Half][] of the following values, concat
|
||||
* The `Sequence` number of the [CheckCreate transaction][] that created the `Check`.
|
||||
If the CheckCreate transaction used a [Ticket](../../../../concepts/accounts/tickets.md), use the `TicketSequence` value instead.
|
||||
|
||||
See the tutorial showing how to [Send a Check](../../../../tutorials/tasks/use-specialized-payment-types/use-checks/send-a-check.md).
|
||||
See the tutorial showing how to [Send a Check](../../../../tutorials/how-tos/use-specialized-payment-types/use-checks/send-a-check.md).
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -39,7 +39,7 @@ You can protect your account by assigning a regular key pair to it and using it
|
||||
|
||||
For more information about regular and master key pairs, see [Cryptographic Keys](../../../../concepts/accounts/cryptographic-keys.md).
|
||||
|
||||
For a tutorial on assigning a regular key pair to an account, see [Working with a Regular Key Pair](../../../../tutorials/tasks/manage-account-settings/assign-a-regular-key-pair.md).
|
||||
For a tutorial on assigning a regular key pair to an account, see [Working with a Regular Key Pair](../../../../tutorials/how-tos/manage-account-settings/assign-a-regular-key-pair.md).
|
||||
|
||||
For even greater security, you can use [multi-signing](../../../../concepts/accounts/multi-signing.md), but multi-signing requires additional XRP for the [transaction cost][] and [reserve](../../../../concepts/accounts/reserves.md).
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
html: tasks.html
|
||||
html: how-tos.html
|
||||
parent: tutorials.html
|
||||
top_nav_grouping: Article Types
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# Tasks
|
||||
# How To's
|
||||
|
||||
Common tasks on the XRP Ledger.
|
||||
These examples provide step-by-step instructions for administrative tasks.
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -477,11 +477,11 @@ $client = new JsonRpcClient("http://localhost:5005");
|
||||
|
||||
After completing this tutorial, you may want to try the following:
|
||||
|
||||
- [Issue a token](../tasks/use-tokens/issue-a-fungible-token.md) on the XRP Ledger Testnet.
|
||||
- [Trade in the Decentralized Exchange](../tasks/use-tokens/trade-in-the-decentralized-exchange.md).
|
||||
- [Issue a token](../how-tos/use-tokens/issue-a-fungible-token.md) on the XRP Ledger Testnet.
|
||||
- [Trade in the Decentralized Exchange](../how-tos/use-tokens/trade-in-the-decentralized-exchange.md).
|
||||
- Build [Reliable transaction submission](../../concepts/transactions/reliable-transaction-submission.md) for production systems.
|
||||
- Check your [client library](../../references/client-libraries.md)'s API reference for the full range of XRP Ledger functionality.
|
||||
- Customize your [Account Settings](../tasks/manage-account-settings/index.md).
|
||||
- Customize your [Account Settings](../how-tos/manage-account-settings/index.md).
|
||||
- Learn how [Transaction Metadata](../../references/protocol/transactions/metadata.md) describes the outcome of a transaction in detail.
|
||||
- Explore more [Payment Types](../../concepts/payment-types/index.md) such as Escrows and Payment Channels.
|
||||
|
||||
@@ -473,7 +473,7 @@ $("#tx_read").click((event) => {
|
||||
## Next Steps
|
||||
|
||||
- [Look Up Transaction Results](../../../concepts/transactions/finality-of-results/look-up-transaction-results.md) to see exactly what a transaction did, and build your software to react appropriately.
|
||||
- Try [Sending XRP](../../tasks/send-xrp.md) from your own address.
|
||||
- Try [Sending XRP](../../how-tos/send-xrp.md) from your own address.
|
||||
- Try monitoring for transactions of advanced types like [Escrows](../../../concepts/payment-types/escrow.md), [Checks](../../../concepts/payment-types/checks.md), or [Payment Channels](../../../concepts/payment-types/payment-channels.md), and responding to incoming notifications.
|
||||
<!--{# TODO: uncomment when it's ready. - To more robustly handle internet instability, [Follow a Transaction Chain](follow-a-transaction-chain.html) to detect if you missed a notification. #}-->
|
||||
|
||||
|
||||
@@ -27,10 +27,16 @@ These tutorials walk you through the basics of building a very simple XRP Ledger
|
||||
|
||||
{% /card-grid %}
|
||||
|
||||
## How-to's
|
||||
## How To's
|
||||
|
||||
These examples provide step-by-step instructions for administrative tasks.
|
||||
|
||||
{% card-grid %}
|
||||
|
||||
{% xrpl-card title="Tasks" body="How to perform common tasks on the XRPL." href="/docs/tutorials/tasks/" /%}
|
||||
{% xrpl-card title="Manage Account Settings" body="Set up your XRP Ledger account to send and receive payments the way you want it to." href="/docs/tutorials/how-tos/manage-account-settings/" /%}
|
||||
{% xrpl-card title="Use Specialized Payment Types" body="Use advanced features like Escrow and Payment Channels to build smart applications on the XRP Ledger." href="/docs/tutorials/how-tos/use-specialized-payment-types/" /%}
|
||||
{% xrpl-card title="Use Tokens" body="Create and trade tokens (fungible or otherwise) in the XRP Ledger." href="/docs/tutorials/how-tos/use-tokens/" /%}
|
||||
{% xrpl-card title="Use XRPL Sidechains" body="Bridge XRP and tokens from Mainnet to XRPL sidechains." href="/docs/tutorials/how-tos/use-xrpl-sidechains/" /%}
|
||||
|
||||
|
||||
{% /card-grid %}
|
||||
@@ -222,7 +222,7 @@ For a detailed description of every response field, see [account_info](../../../
|
||||
|
||||
Now that you know how to use `xrpl4j` to connect to the XRP Ledger, get an account, and look up information about it, you can also use `xrpl4j` to:
|
||||
|
||||
* [Send XRP](../../tasks/send-xrp.md).
|
||||
* [Send XRP](../../how-tos/send-xrp.md).
|
||||
* [Set up secure signing](../../../concepts/transactions/secure-signing.md) for your account.
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -151,8 +151,8 @@ You can set up handlers for various types of events in `xrpl.js`, such as whenev
|
||||
|
||||
Now that you know how to use `xrpl.js` to connect to the XRP Ledger, get an account, and look up information about it, you can also:
|
||||
|
||||
* [Send XRP](../../tasks/send-xrp.md).
|
||||
* [Issue a Fungible Token](../../tasks/use-tokens/issue-a-fungible-token.md)
|
||||
* [Send XRP](../../how-tos/send-xrp.md).
|
||||
* [Issue a Fungible Token](../../how-tos/use-tokens/issue-a-fungible-token.md)
|
||||
* [Set up secure signing](../../../concepts/transactions/secure-signing.md) for your account.
|
||||
|
||||
|
||||
@@ -162,7 +162,7 @@ Now that you know how to use `xrpl.js` to connect to the XRP Ledger, get an acco
|
||||
- [XRP Ledger Overview](/about/)
|
||||
- [Client Libraries](../../../references/client-libraries.md)
|
||||
- **Tutorials:**
|
||||
- [Send XRP](../../tasks/send-xrp.md)
|
||||
- [Send XRP](../../how-tos/send-xrp.md)
|
||||
- **References:**
|
||||
- [`xrpl.js` Reference](https://js.xrpl.org/)
|
||||
- [Public API Methods](../../../references/http-websocket-apis/public-api-methods/index.md)
|
||||
|
||||
@@ -232,7 +232,7 @@ For a detailed description of every response field, see [account_info](../../../
|
||||
|
||||
Now that you know how to use `XRPL_PHP` to connect to the XRP Ledger, get an account, and look up information about it, you can also use `XRPL_PHP` to:
|
||||
|
||||
* [Send XRP](../../tasks/send-xrp.md).
|
||||
* [Send XRP](../../how-tos/send-xrp.md).
|
||||
* [Set up secure signing](../../../concepts/transactions/secure-signing.md) for your account.
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -204,7 +204,7 @@ For a detailed description of every response field, see [account_info](../../../
|
||||
|
||||
Now that you know how to use `xrpl-py` to connect to the XRP Ledger, get an account, and look up information about it, you can also use `xrpl-py` to:
|
||||
|
||||
* [Send XRP](../../tasks/send-xrp.md).
|
||||
* [Send XRP](../../how-tos/send-xrp.md).
|
||||
* [Set up secure signing](../../../concepts/transactions/secure-signing.md) for your account.
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -72,7 +72,7 @@ The legal requirements for trading on a blockchain vary by jurisdiction. In many
|
||||
|
||||
### Placing Trades
|
||||
|
||||
Buying and selling _fungible_ tokens and XRP within the XRP Ledger's decentralized exchange typically involves sending [OfferCreate transactions](../../references/protocol/transactions/types/offercreate.md). For a detailed walkthrough of the code and technical steps to place a trade this way, see [Trade in the Decentralized Exchange](../../tutorials/tasks/use-tokens/trade-in-the-decentralized-exchange.md). It is also possible to exchange currencies using the [Payment transaction type](../../references/protocol/transactions/types/payment.md). You could send a [cross-currency payment](../../concepts/payment-types/cross-currency-payments.md) to another user or even send it back to yourself, using a long [path](../../concepts/tokens/fungible-tokens/paths.md) to link arbitrage opportunities together into a single operation.
|
||||
Buying and selling _fungible_ tokens and XRP within the XRP Ledger's decentralized exchange typically involves sending [OfferCreate transactions](../../references/protocol/transactions/types/offercreate.md). For a detailed walkthrough of the code and technical steps to place a trade this way, see [Trade in the Decentralized Exchange](../../tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md). It is also possible to exchange currencies using the [Payment transaction type](../../references/protocol/transactions/types/payment.md). You could send a [cross-currency payment](../../concepts/payment-types/cross-currency-payments.md) to another user or even send it back to yourself, using a long [path](../../concepts/tokens/fungible-tokens/paths.md) to link arbitrage opportunities together into a single operation.
|
||||
|
||||
Non-fungible tokens work differently; for the code and technical steps to trade NFTs, see [Transfer NFTokens Using JavaScript](../../tutorials/javascript/nfts/transfer-nfts.md).
|
||||
|
||||
|
||||
@@ -614,7 +614,7 @@ Off-Ledger Balances</td>
|
||||
- [Source and Destination Tags](../../concepts/transactions/source-and-destination-tags.md)
|
||||
- **Tutorials:**
|
||||
- [Install `rippled`](../../infrastructure/installation/index.md)
|
||||
- [Send XRP](../../tutorials/tasks/send-xrp.md)
|
||||
- [Send XRP](../../tutorials/how-tos/send-xrp.md)
|
||||
- [Set Up Secure Signing](../../concepts/transactions/secure-signing.md)
|
||||
- [Monitor Incoming Payments with WebSocket](../../tutorials/http-websocket-apis/build-apps/monitor-incoming-payments-with-websocket.md)
|
||||
- **References:**
|
||||
|
||||
@@ -42,14 +42,14 @@ Checks are a straightforward, familiar, and flexible way to transfer funds when
|
||||
|
||||
While this method is the simplest, it doesn't guarantee the funds. Checks are deferred payments, meaning funds aren't moved until the moment you try to cash the check. It's possible for the sending account to not have the necessary funds at the time the check is cashed, which can cause delays or other headaches, depending on your business.
|
||||
|
||||
See: [Use Checks](../../tutorials/tasks/use-specialized-payment-types/use-checks/use-checks.md).
|
||||
See: [Use Checks](../../tutorials/how-tos/use-specialized-payment-types/use-checks/use-checks.md).
|
||||
|
||||
|
||||
### Escrow
|
||||
|
||||
If you require a guarantee of funds at the time of deposit, another option is to have deposits made with an escrow. Like regular escrows, a sender sets aside funds on the ledger, effectively locking them up until certain conditions are met. This guarantees the funds will be available when you close the escrow to release the funds.
|
||||
|
||||
See: [Use Escrows](../../tutorials/tasks/use-specialized-payment-types/use-escrows/index.md).
|
||||
See: [Use Escrows](../../tutorials/how-tos/use-specialized-payment-types/use-escrows/index.md).
|
||||
|
||||
|
||||
<!-- Need a better understanding of Payment Channels use cases.
|
||||
|
||||
@@ -37,7 +37,7 @@ The oracle gives the condition hex value to the escrow creator, enabling them to
|
||||
|
||||
After the oracle's programming detects the conditions are met, it gives the fulfillment hex value to the escrow recipient. It does nothing else after this point, such as finishing the escrow. The recipient of the escrow would most likely finish the escrow.
|
||||
|
||||
See: [Generate a condition and fulfillment](../../tutorials/tasks/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md#1-generate-condition-and-fulfillment).
|
||||
See: [Generate a condition and fulfillment](../../tutorials/how-tos/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md#1-generate-condition-and-fulfillment).
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ The most straightforward payment for XRPL NFTs is XRP. For examples of selling a
|
||||
|
||||

|
||||
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/tasks/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
|
||||
## Indexing NFTs
|
||||
|
||||
|
||||
@@ -69,7 +69,7 @@ The most straightforward payment for XRPL NFTs is XRP. For examples of selling a
|
||||
|
||||

|
||||
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/tasks/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
|
||||
|
||||
## Indexing NFTs
|
||||
|
||||
@@ -113,7 +113,7 @@ The most straightforward payment for XRPL NFTs is XRP. For examples of selling a
|
||||
|
||||

|
||||
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/tasks/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
|
||||
<!--
|
||||
|
||||
|
||||
@@ -69,7 +69,7 @@ The most straightforward payment for XRPL NFTs is XRP. For examples of selling a
|
||||
|
||||

|
||||
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/tasks/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
For trade in other currencies, you can leverage the DEX to accept and convert issued currencies of all kinds. See [Trade in the Decentralized Exchange](../../tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md#trade-in-the-decentralized-exchange).
|
||||
|
||||
## Indexing NFTs
|
||||
|
||||
|
||||
@@ -114,7 +114,7 @@ For additional considerations, see:
|
||||
|
||||
- [Stablecoin Issuer - Precautions](../../concepts/tokens/fungible-tokens/stablecoins/precautions.md)
|
||||
- [Stablecoin Issuer - Compliance Guidelines](../../concepts/tokens/fungible-tokens/stablecoins/compliance-guidelines.md)
|
||||
- [Issue a Fungible Token](../../tutorials/tasks/use-tokens/issue-a-fungible-token.md)
|
||||
- [Issue a Fungible Token](../../tutorials/how-tos/use-tokens/issue-a-fungible-token.md)
|
||||
|
||||
### Create a Trust Line
|
||||
|
||||
@@ -154,7 +154,7 @@ If you see signs of suspicious activity, you can enact a global freeze on your a
|
||||
|
||||

|
||||
|
||||
See [Enact Global Freeze](../../tutorials/tasks/use-tokens/enact-global-freeze.md).
|
||||
See [Enact Global Freeze](../../tutorials/how-tos/use-tokens/enact-global-freeze.md).
|
||||
|
||||
|
||||
### Clawback
|
||||
@@ -183,7 +183,7 @@ To ensure a limited supply, you can "black hole" the issuer after issuing tokens
|
||||
|
||||
**Warning:** A black hole account has no way to send transactions of any kind, so you cannot update any settings or do any maintenance on the account afterwards!
|
||||
|
||||
See [Disable Master Key Pair](../../tutorials/tasks/manage-account-settings/disable-master-key-pair.md).
|
||||
See [Disable Master Key Pair](../../tutorials/how-tos/manage-account-settings/disable-master-key-pair.md).
|
||||
|
||||
### Reliable Transaction Submission
|
||||
|
||||
|
||||
Reference in New Issue
Block a user