Reorganize page order and categories per XRP Ledger doc plan

This commit is contained in:
mDuo13
2018-02-20 17:32:44 -08:00
parent 89dc2cae65
commit 8fd555c12a
8 changed files with 313 additions and 363 deletions

View File

@@ -1,5 +1,4 @@
Freeze Features
===============
# Freezing Issued Currencies
The XRP Ledger gives addresses the ability to freeze non-XRP balances, which can be useful to meet regulatory requirements, or while investigating suspicious activity. There are three settings related to freezes:
@@ -12,8 +11,7 @@ Because no party has a privileged place in the XRP Ledger, the freeze feature ca
All freeze settings can be enacted regardless of whether the balance(s) to be frozen are positive or negative. Either the currency issuer or the currency holder can freeze a trust line; however, the effect of a currency holder freezing an issuer is minimal.
Individual Freeze
-----------------
## Individual Freeze
The **Individual Freeze** feature is a setting on a trust line. When an issuing address enables the Individual Freeze setting, the following rules apply:
@@ -31,8 +29,7 @@ The Individual Freeze applies to a single currency only. To freeze multiple curr
An address cannot enable the Individual Freeze setting if it has enabled the [No Freeze](#no-freeze) setting.
Global Freeze
-------------
## Global Freeze
The **Global Freeze** feature is a setting on an address. When an issuing address enables the Global Freeze feature, the following rules apply:
@@ -49,8 +46,7 @@ Global Freeze applies to _all_ currencies issued and held by the address. You ca
An address can always enable the Global Freeze setting. However, if the address has enabled the [No Freeze](#no-freeze) setting, it can never _disable_ Global Freeze.
No Freeze
---------
## No Freeze
The **No Freeze** feature is a setting on an address that permanently gives up the ability to freeze counterparties. A business can use this feature to treat its issued funds as "more like physical money" in the sense that the business cannot interfere with customers trading it among themselves. The NoFreeze setting has two effects:
@@ -64,11 +60,11 @@ The No Freeze setting applies to all currencies issued to and from an address. I
You can only enable the No Freeze setting with a transaction signed by your address's master key secret. You cannot use a [Regular Key](reference-transaction-format.html#setregularkey) or a [multi-signed transaction](reference-transaction-format.html#multi-signing) to enable No Freeze.
# Technical Details #
# Technical Details
## Enabling or Disabling Individual Freeze ##
## Enabling or Disabling Individual Freeze
### Using `rippled` ###
### Using `rippled`
To enable or disable Individual Freeze on a specific trust line, send a `TrustSet` transaction. Use the [`tfSetFreeze` flag](reference-transaction-format.html#trustset-flags) to enable a freeze, and the `tfClearFreeze` flag to disable it. The fields of the transaction should be as follows:
@@ -112,7 +108,7 @@ Example of submitting a TrustSet transaction to enable an individual freeze usin
**Caution:** Never send your secret key to an untrusted server or over an insecure channel.
### Using RippleAPI ###
### Using RippleAPI
To enable or disable Individual Freeze on a specific trust line, prepare a *Trustline* transaction using the [prepareTrustline](reference-rippleapi.html#preparetrustline) method. The fields of the `trustline` parameter should be set as follows:
@@ -132,9 +128,9 @@ Example JavaScript (ECMAScript 6) code to enable Individual Freeze on a trust li
```
## Enabling or Disabling Global Freeze ##
## Enabling or Disabling Global Freeze
### Using `rippled` ###
### Using `rippled`
To enable Global Freeze on an address, send an `AccountSet` transaction with the [asfGlobalFreeze flag value](reference-transaction-format.html#accountset-flags) in the `SetFlag` field. To disable Global Freeze, put the asfGlobalFreeze flag value in the `ClearFlag` field instead.
@@ -162,7 +158,7 @@ Example of submitting an AccountSet transaction to enable Global Freeze using th
**Caution:** Never send your secret key to an untrusted server or over an insecure channel.
### Using RippleAPI ###
### Using RippleAPI
To enable or disable Global Freeze on an address, prepare a **Settings** transaction using the [prepareSettings](reference-rippleapi.html#preparesettings) method. The `settings` parameter should be an object set as follows:
@@ -180,9 +176,9 @@ Example JavaScript (ECMAScript 6) code to enable Global Freeze on an address:
## Enabling No Freeze ##
## Enabling No Freeze
### Using `rippled` ###
### Using `rippled`
To enable No Freeze on an address, send an `AccountSet` transaction with the [asfNoFreeze flag value](reference-transaction-format.html#accountset-flags) in the `SetFlag` field. You must sign this transaction using the master key. Once enabled, you cannot disable No Freeze.
@@ -211,7 +207,7 @@ WebSocket request:
**Caution:** Never send your secret key to an untrusted server or over an insecure channel.
### Using RippleAPI ###
### Using RippleAPI
To enable No Freeze on an address, prepare a **Settings** transaction using the [prepareSettings](reference-rippleapi.html#preparesettings) method. Once enabled, you cannot disable No Freeze. The `settings` parameter should be an object set as follows:
@@ -228,9 +224,9 @@ Example JavaScript (ECMAScript 6) code to enable No Freeze on an address:
```
## Checking for Individual Freeze ##
## Checking for Individual Freeze
### Using `rippled` ###
### Using `rippled`
To see if a trust line has an Individual Freeze enabled, use the [`account_lines` method](reference-rippled.html#account-lines) with the following parameters:
@@ -288,7 +284,7 @@ Example WebSocket response:
The field `"freeze": true` indicates that rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn has enabled Individual Freeze on the USD trust line to rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW. The lack of a field `"freeze_peer": true` indicates that the counterparty has _not_ frozen the trust line.
### Using RippleAPI ###
### Using RippleAPI
To see if a trust line has an Individual Freeze enabled, use the [`getTrustlines` method](reference-rippleapi.html#gettrustlines) with the following parameters:
@@ -311,9 +307,9 @@ Example JavaScript (ECMAScript 6) code to check whether a trust line is frozen:
```
## Checking for Global Freeze and No Freeze ##
## Checking for Global Freeze and No Freeze
### Using `rippled` ###
### Using `rippled`
To see if an address has enabled Global Freeze, No Freeze, or both, use the [`account_info` method](reference-rippled.html#account-lines) with the following parameters:
@@ -385,7 +381,7 @@ console.log(currentFlags & lsfNoFreeze); //0
//therefore, No Freeze is not enabled
```
### Using RippleAPI ###
### Using RippleAPI
To see if an address has enabled Global Freeze, No Freeze, or both, use the [`getSettings` method](reference-rippleapi.html#getsettings) with the following parameters:
@@ -406,7 +402,7 @@ Example JavaScript (ECMAScript 6) code to check whether an address has Global Fr
{% include 'code_samples/freeze/check-global-freeze-no-freeze.js' %}
```
# See Also #
# See Also
* [GB-2014-02 New Feature: Balance Freeze](https://ripple.com/files/GB-2014-02.pdf)
* [Freeze Code Samples](https://github.com/ripple/ripple-dev-portal/tree/master/content/code_samples/freeze)

View File

@@ -4,7 +4,7 @@
***TODO: Question: Added this concept section based on fantastic source material from Rome -- thought we should publish it. Useful? May be good to associate it with a flow diagram - like the one for address encoding: https://ripple.com/build/accounts/#address-encoding. Address both single and multi-sign flows.***
In the XRP Ledger, a digital signature proves that a transaction is authorized to do a specific set of actions. A digital signature is created based on a [key pair](cryptographic-keys.html) associated with the transaction's sending account.
In the XRP Ledger, a digital signature proves that a transaction is authorized to do a specific set of actions. A digital signature is created based on a [key pair](concept-cryptographic-keys.html) associated with the transaction's sending account.
Here's an overview of some of the more common signature-related fields used in the XRP Ledger.
@@ -20,7 +20,7 @@ To verify whether a single-signed transaction is valid, a `rippled` server check
1. This key hashes to an address that's authorized by the transaction's sender.
The default is that only the address of an account is authorized to send all transactions for that account. That address is [derived from](concept-accounts.html#address-encoding) the public key from the master key pair that was generated during address creation. Regular keys add a different address (derived from a different key pair) that's authorized to send most transactions. And of course, you can also disable the [master key](cryptographic-keys.html) or add a [multi-signing list](reference-transaction-format.html#multi-signing). ***TODO: address from Ryan: "And of course" - Nit: this seems a little informal. Maybe just drop it and go into the next sentence? JHA take a closer look at what this sentence is trying to say.***
The default is that only the address of an account is authorized to send all transactions for that account. That address is [derived from](concept-accounts.html#address-encoding) the public key from the master key pair that was generated during address creation. Regular keys add a different address (derived from a different key pair) that's authorized to send most transactions. And of course, you can also disable the [master key](concept-cryptographic-keys.html) or add a [multi-signing list](reference-transaction-format.html#multi-signing). ***TODO: address from Ryan: "And of course" - Nit: this seems a little informal. Maybe just drop it and go into the next sentence? JHA take a closer look at what this sentence is trying to say.***
2. This key matches the signature on the transaction.

View File

@@ -25,7 +25,7 @@ Any signature type can authorize any type of transaction, with the following exc
* Only the master private key can [permanently give up the ability to freeze](concept-freeze.html#no-freeze).
* You can never remove the last method of signing transactions from an address.
For more information about master and regular key pairs, see [Cryptographic Keys](cryptographic-keys.html).
For more information about master and regular key pairs, see [Cryptographic Keys](concept-cryptographic-keys.html).
<!--{# Add this reference after signatures concept doc is published. For more information about signatures, see [Understanding Signatures](concept-signatures.html). #}-->
@@ -175,7 +175,7 @@ Example response from the `tx` command:
### Multi-Signing
Multi-signing in the XRP Ledger is the act of [authorizing transactions](#authorizing-transactions) for the XRP Ledger by using a combination of multiple secret keys. You can have any combination of authorization methods enabled for your address, including multi-signing, a [master key pair](cryptographic-keys.html#master-key-pair), and a [regular key pair](cryptographic-keys.html#regular-key-pair). (The only requirement is that _at least one_ method must be enabled.)
Multi-signing in the XRP Ledger is the act of [authorizing transactions](#authorizing-transactions) for the XRP Ledger by using a combination of multiple secret keys. You can have any combination of authorization methods enabled for your address, including multi-signing, a [master key pair](concept-cryptographic-keys.html#master-key-pair), and a [regular key pair](concept-cryptographic-keys.html#regular-key-pair). (The only requirement is that _at least one_ method must be enabled.)
The [SignerListSet transaction][] defines which addresses can authorize transactions from your address. You can include up to 8 addresses in a SignerList. You can control how many signatures are needed, in which combinations, by using the quorum and weight values of the SignerList.

View File

@@ -180,7 +180,7 @@ You can also use this method to generate a key pair to use as a regular key pair
In addition to using it as a regular key pair, you can also use it as a member of a multi-signing list (SignerList).
For more information about master and regular key pairs, see [Cryptographic Keys](cryptographic-keys.html)
For more information about master and regular key pairs, see [Cryptographic Keys](concept-cryptographic-keys.html)
For more information about multi-signing and signer lists, see [Multi-Signing](reference-transaction-format.html#multi-signing).

View File

@@ -6,7 +6,7 @@ A `SetRegularKey` transaction assigns, changes, or removes the regular key pair
You can protect your account by assigning a regular key pair to it and using it instead of the master key pair to sign transactions whenever possible. If your regular key pair is compromised, but your master key pair is not, you can use a `SetRegularKey` transaction to regain control of your account.
For more information about regular and master key pairs, see [Cryptographic Keys](cryptographic-keys.html).
For more information about regular and master key pairs, see [Cryptographic Keys](concept-cryptographic-keys.html).
For a tutorial on assigning a regular key pair to an account, see [Working with a Regular Key Pair](working-regular-key-pair.html).

View File

@@ -2,7 +2,7 @@
The XRP Ledger allows an account to authorize a secondary key pair, called a _regular key pair_, to sign future transactions. If the private key of a regular key pair is compromised, you can remove or replace it without changing the rest of your account and re-establishing its relationships to other accounts. You can also rotate a regular key pair proactively. (Neither of those things is possible for the master key pair of an account, which is intrinsically linked to the account's address.)
For more information about master and regular key pairs, see [Cryptographic Keys](cryptographic-keys.html).
For more information about master and regular key pairs, see [Cryptographic Keys](concept-cryptographic-keys.html).
This article provides the following tutorials:
@@ -684,7 +684,7 @@ If your account's regular key pair is compromised, or if you just want to period
The steps to change your existing regular key pair are almost the same as the steps to [assign a regular key](#assigning-a-regular-key-pair) for the first time. You generate the key pair and assign it to your account as a regular key pair, overwriting the existing regular key pair. However, the main difference is that when changing the existing regular key pair, you can use the existing regular private key to replace itself, whereas when assigning a regular key pair to an account for the first time, you have to use the account's master private key to do it.
For more information about master and regular key pairs, see [Cryptographic Keys](cryptographic-keys.html).
For more information about master and regular key pairs, see [Cryptographic Keys](concept-cryptographic-keys.html).
### Removing a Regular Key Pair