Output
"); - // TODO: make "Response" translatable - const cm_resp = CodeMirror(resp.get(0), { - mode: 'javascript', - json: false, - readOnly: true, - gutters: ["CodeMirror-lint-markers"] - }); - - const oldconsole = console; - console = { - log: (...args) => { - oldconsole.log(...args); - cm_resp.setValue(args.map(x => JSON.stringify(x, null, 2)).join(" ")); - }, - warn: (...args) => { - oldconsole.warn(...args); - cm_resp.setValue(args.map(x => JSON.stringify(x, null, 2)).join(" ")); - }, - error: (...args) => { - oldconsole.error(...args); - cm_resp.setValue(args.map((x) => { - if (x instanceof Error) return x.toString(); - return JSON.stringify(x, null, 2); - }).join(" ")); - } - } - try { - Function(cm.getValue())(); - } catch(error) { - console.error(error); - } - - }); - - js_interactives[interactive_id] = {} - code_blocks.slice(1).each((i, el) => { - // Turn each additional code block into a function that fills in the - // editor with the provided text example. - // Example: js_interactives.some_unique_id.ex_1() - const code_ex = $(el); - const ex_text = code_ex.text().trim(); - js_interactives[interactive_id]["ex_"+(i+1)] = function() { - // - cm.setValue(ex_text); - $("html").animate({scrollTop: wrapper.offset().top}, 500); - } - code_ex.parent().hide(); - }); - }) -}); diff --git a/content/_code-samples/escrow/js/cancel-escrow-v2.js b/content/_code-samples/escrow/js/cancel-escrow-v2.js new file mode 100644 index 0000000000..b1e2f7bea3 --- /dev/null +++ b/content/_code-samples/escrow/js/cancel-escrow-v2.js @@ -0,0 +1,42 @@ +// Code in progress. + +const xrpl = require("xrpl") + +async function main() { + + // Create a client and connect to the network. + const client = new xrpl.Client("wss://xrplcluster.com/") + await client.connect() + + // Query the most recently validated ledger for info. + const ledger = await client.request({ + "command": "ledger", + "ledger_index": "validated", + }) + const ledgerCloseTime = ledger["result"]["ledger"]["close_time"] + + // Check the `CancelAfter` time of the escrow. + // For this example, we have the identifying hash of the `EscrowCreate` transaction. + const escrowInfo = await client.request({ + "command": "tx", + "transaction": "3DC728E4DB4120AD26DD41997C42FF5AD46C0073D8692AFB8F59660D058D87A3", + }) + const escrowAccountSender = escrowInfo["result"]["Account"] + const escrowCancelAfter = escrowInfo["result"]["CancelAfter"] + const escrowSequence = escrowInfo["result"]["Sequence"] + + // Submit an `EscrowCancel` transaction if the cancel after time is smaller than the ledger close time. + // Any valid account can submit an escrow cancel transaction. + if (escrowCancelAfter < ledgerCloseTime) { + client.submitAndWait({ + "Account": escrowAccountSender, + "TransactionType": "EscrowCancel", + "Owner": escrowAccountSender, + "OfferSequence": escrowSequence + }) + } + + client.disconnect() +} + +main() diff --git a/content/_code-samples/secure-signing/README.md b/content/_code-samples/secure-signing/README.md index 9672644d9c..505c72756e 100644 --- a/content/_code-samples/secure-signing/README.md +++ b/content/_code-samples/secure-signing/README.md @@ -2,4 +2,4 @@ Sign transactions from the security of your own machine. -For more information and more options, see [Set Up Secure Signing](https://xrpl.org/set-up-secure-signing.html). +For more information and more options, see [Set Up Secure Signing](https://xrpl.org/secure-signing.html). diff --git a/content/_snippets/checkcash-prereqs.ja.md b/content/_snippets/checkcash-prereqs.ja.md index 829de66f2a..cc94d48018 100644 --- a/content/_snippets/checkcash-prereqs.ja.md +++ b/content/_snippets/checkcash-prereqs.ja.md @@ -5,5 +5,5 @@ Checkを換金するための前提条件は、正確な金額を換金する場 - Checkに記載されている受取人の**アドレス**と**秘密鍵**。このアドレスは、Checkオブジェクトの`Destination`アドレスと一致している必要があります。 - 発行済み通貨用のCheckの場合は、ご自身（受取人）にイシュアーに対するトラストラインがある必要があります。このトラストライン上のご自身の限度額は、受け取る金額を追加するための残高より十分高くなければなりません。 - トラストラインと限度額について詳しくは、[発行済み通貨](issued-currencies.html)および[トラストラインと発行](trust-lines-and-issuing.html)を参照してください。 -- [トランザクションに安全に署名できる手段](set-up-secure-signing.html)。 +- [トランザクションに安全に署名できる手段](secure-signing.html)。 - XRP Ledgerに接続できる[クライアントライブラリ](client-libraries.html)か、それとも[HTTPライブラリ、WebSocketライブラリなど](get-started-using-http-websocket-apis.html)。 diff --git a/content/_snippets/checkcash-prereqs.md b/content/_snippets/checkcash-prereqs.md index e7d9f4e111..e29521dacd 100644 --- a/content/_snippets/checkcash-prereqs.md +++ b/content/_snippets/checkcash-prereqs.md @@ -4,5 +4,5 @@ The prerequisites for cashing a check are the same whether you are cashing it fo - For example, the ID of one Check in these examples is `838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334`, although you must use a different ID to go through these steps yourself. - The **address** and **secret key** of the Check's stated recipient. The address must match the `Destination` address in the Check object. - If the Check is for a [token](tokens.html), you (the recipient) must have a [trust line](trust-lines-and-issuing.html) to the issuer. Your limit on that trust line must be high enough to hold your previous balance plus the amount you would receive. -- A [secure way to sign transactions](set-up-secure-signing.html). +- A [secure way to sign transactions](secure-signing.html). - A [client library](client-libraries.html) that can connect to the XRP Ledger, or [any HTTP or WebSocket client](get-started-using-http-websocket-apis.html). diff --git a/content/_snippets/data_types/account_sequence.ja.md b/content/_snippets/data_types/account_sequence.ja.md index 7e349f67dd..f7d98a2dd7 100644 --- a/content/_snippets/data_types/account_sequence.ja.md +++ b/content/_snippets/data_types/account_sequence.ja.md @@ -1,6 +1,6 @@ シーケンス番号とは、32ビットの符号なし整数であり、指定された送金元からのトランザクションが正しい順序で1回だけ実行されるようにするために使用されます。 -すべての[XRP Ledgerアカウント](accounts.html)には、`Sequence`フィールドに1つのシーケンス番号があり、アカウントがトランザクションを送信し、そのトランザクションが[検証済みレジャー](ledgers.html)に記録されるたびに、1ずつ増加します。シーケンス番号は各[トランザクション](transaction-basics.html)の`Sequence`フィールドにもあり、そのトランザクションが実行される際にアカウントの現在のシーケンス番号と一致している必要があります。各アカウントで、各シーケンス番号は番号順に一度だけ使用できます。 +すべての[XRP Ledgerアカウント](accounts.html)には、`Sequence`フィールドに1つのシーケンス番号があり、アカウントがトランザクションを送信し、そのトランザクションが[検証済みレジャー](ledgers.html)に記録されるたびに、1ずつ増加します。シーケンス番号は各[トランザクション](transactions.html)の`Sequence`フィールドにもあり、そのトランザクションが実行される際にアカウントの現在のシーケンス番号と一致している必要があります。各アカウントで、各シーケンス番号は番号順に一度だけ使用できます。 [DeletableAccounts Amendment](known-amendments.html#deletableaccounts) を適用する場合、アカウントの`Sequence`番号の始まりが、アカウントが作成されたレジャーバージョンの[レジャーインデックス][]と一致します。DeletableAccountsを適用しない場合、どのアカウントの`Sequence`番号も1で始まります。 diff --git a/content/_snippets/data_types/account_sequence.md b/content/_snippets/data_types/account_sequence.md index d2db518246..1284b2efb0 100644 --- a/content/_snippets/data_types/account_sequence.md +++ b/content/_snippets/data_types/account_sequence.md @@ -1,6 +1,6 @@ A sequence number is a 32-bit unsigned integer that is used to make sure transactions from a given sender execute only once each, and in the correct order. -Every [account in the XRP Ledger](accounts.html) has a sequence number in its `Sequence` field, which increases by 1 whenever that account sends a transaction and that transaction gets included in a [validated ledger](ledgers.html). Each [transaction](transaction-basics.html) also has a sequence number in its `Sequence` field, which must match the account's current sequence number when the transaction executes. For each account, each sequence number can only be used once, in numerical order. +Every [account in the XRP Ledger](accounts.html) has a sequence number in its `Sequence` field, which increases by 1 whenever that account sends a transaction and that transaction gets included in a [validated ledger](ledgers.html). Each [transaction](transactions.html) also has a sequence number in its `Sequence` field, which must match the account's current sequence number when the transaction executes. For each account, each sequence number can only be used once, in numerical order. [Tickets](tickets.html) make some exceptions from these rules so that it is possible to send transactions out of the normal order. Tickets represent sequence numbers reserved for later use; a transaction can use a Ticket instead of a normal sequence number. diff --git a/content/_snippets/data_types/address.ja.md b/content/_snippets/data_types/address.ja.md index c2b727a29a..4e2c09533a 100644 --- a/content/_snippets/data_types/address.ja.md +++ b/content/_snippets/data_types/address.ja.md @@ -3,7 +3,7 @@ XRP Ledgerのアカウントは、XRP Ledgerの[base58][]フォーマットの * 長さは25から35文字です * 文字`r`で始まります - **注記:** XRPコミュニティは、取引所およびウォレットで[宛先タグ](https://xrpl.org/source-and-destination-tags.html)の代わりに使用できる新しいフォーマット、**X**アドレスを[提案](https://github.com/XRPLF/XRPL-Standards/issues/6)（これをサポートする[コーデック](https://github.com/xrp-community/xrpl-tagged-address-codec)も開発）しました。これらの「パック化」したアドレスは、`r`ではなく`X`で開始します。詳細は、[𝗫-address format](https://xrpaddress.info/)のサイトを参照してください。 + **注記:** XRPコミュニティは、取引所およびウォレットで[宛先タグ](source-and-destination-tags.html)の代わりに使用できる新しいフォーマット、**X**アドレスを[提案](https://github.com/XRPLF/XRPL-Standards/issues/6)（これをサポートする[コーデック](https://github.com/xrp-community/xrpl-tagged-address-codec)も開発）しました。これらの「パック化」したアドレスは、`r`ではなく`X`で開始します。詳細は、[𝗫-address format](https://xrpaddress.info/)のサイトを参照してください。 * 英数字を使用します（数字「`0`」、大文字「`O`」、大文字「`I`」、小文字「`l`」を除く） * 大/小文字を区別します diff --git a/content/_snippets/data_types/address.md b/content/_snippets/data_types/address.md index f6d099ee31..2edc68cc88 100644 --- a/content/_snippets/data_types/address.md +++ b/content/_snippets/data_types/address.md @@ -6,7 +6,7 @@ Accounts in the XRP Ledger are identified by an address in the XRP Ledger's [bas * Case-sensitive * Includes a 4-byte checksum so that the probability of generating a valid address from random characters is approximately 1 in 232 -> **Note:** The XRP community has [proposed](https://github.com/XRPLF/XRPL-Standards/issues/6) an **X**-address format that "packs" a [destination tag](source-and-destination-tags.html) into the address. These addresses start with an `X` (for the mainnet) or a `T` (for the [testnet](parallel-networks.html)). Exchanges and wallets can use X-addresses to represent all the data a customer needs to know in one value. For more information, see the [X-address format site](https://xrpaddress.info/) and [codec](https://github.com/xrp-community/xrpl-tagged-address-codec). +> **Note:** There is also an **X**-address format that "packs" a [destination tag](source-and-destination-tags.html) into the address. These addresses start with an `X` (for Mainnet) or a `T` (for [test networks](parallel-networks.html)). Exchanges and wallets can use X-addresses to represent all the data a customer needs to know in one value. For more information, see the [X-address format site](https://xrpaddress.info/) and [codec](https://github.com/xrp-community/xrpl-tagged-address-codec). > > The XRP Ledger protocol only supports "classic" addresses natively, but many [client libraries](client-libraries.html) support X-addresses too. diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index 7f6f15fd6c..9917247100 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -15,8 +15,8 @@ [XRPのdrop数]: basic-data-types.html#通貨額の指定 [Hash]: basic-data-types.html#hashes [ハッシュ]: basic-data-types.html#ハッシュ -[identifying hash]: transaction-basics.html#identifying-transactions -[識別用ハッシュ]: transaction-basics.html#トランザクションの識別 +[identifying hash]: transactions.html#identifying-transactions +[識別用ハッシュ]: transactions.html#トランザクションの識別 [Internal Type]: serialization.html [内部の型]: serialization.html [Ledger Index]: basic-data-types.html#ledger-index diff --git a/content/_snippets/string-number-formatting.md b/content/_snippets/string-number-formatting.md index 07f0fd5c71..eb3230ba60 100644 --- a/content/_snippets/string-number-formatting.md +++ b/content/_snippets/string-number-formatting.md @@ -1,4 +1,4 @@ -XRP Ledger APIs generally use strings, rather than native JSON numbers, to represent numeric amounts of currency for both [XRP](xrp.html) and [tokens](tokens.html). This protects against a loss of precision when using JSON parsers, which may automatically try to represent all JSON numbers in a floating-point format. Within the String value, the numbers are serialized in the same way as native JSON numbers: +XRP Ledger APIs generally use strings, rather than native JSON numbers, to represent numeric amounts of currency for both [XRP](what-is-xrp.html) and [tokens](tokens.html). This protects against a loss of precision when using JSON parsers, which may automatically try to represent all JSON numbers in a floating-point format. Within the String value, the numbers are serialized in the same way as native JSON numbers: * Base-10. * Non-zero-prefaced. diff --git a/content/_snippets/tutorial-sign-step.md b/content/_snippets/tutorial-sign-step.md index 4adf3e23cc..9a0497b592 100644 --- a/content/_snippets/tutorial-sign-step.md +++ b/content/_snippets/tutorial-sign-step.md @@ -1,3 +1,3 @@ -The most secure way to sign a transaction is to [sign locally with a client library](set-up-secure-signing.html#local-signing-example). Alternatively, if you run your own `rippled` node you can sign the transaction using the [sign method](sign.html), but this must be done through a trusted and encrypted connection, or through a local (same-machine) connection. +The most secure way to sign a transaction is to [sign locally with a client library](secure-signing.html#local-signing-example). Alternatively, if you run your own `rippled` node you can sign the transaction using the [sign method](sign.html), but this must be done through a trusted and encrypted connection, or through a local (same-machine) connection. In all cases, note the signed transaction's identifying hash for later. diff --git a/content/_snippets/tx-metadata-field-table.md b/content/_snippets/tx-metadata-field-table.md index 82a18169de..81028a920e 100644 --- a/content/_snippets/tx-metadata-field-table.md +++ b/content/_snippets/tx-metadata-field-table.md @@ -1,7 +1,7 @@ | Field | Value | Description | |:----------------------------------------|:--------------------|:-------------| -| `AffectedNodes` | Array | List of [ledger objects](ledger-object-types.html) that were created, deleted, or modified by this transaction, and specific changes to each. | +| `AffectedNodes` | Array | List of [ledger entries](ledger-object-types.html) that were created, deleted, or modified by this transaction, and specific changes to each. | | `DeliveredAmount` | [Currency Amount][] | _(May be omitted)_ For a [partial payment](partial-payments.html), this field records the amount of currency actually delivered to the destination. To avoid errors when reading transactions, instead use the `delivered_amount` field, which is provided for all Payment transactions, partial or not. | | `TransactionIndex` | Unsigned Integer | The transaction's position within the ledger that included it. This is zero-indexed. (For example, the value `2` means it was the 3rd transaction in that ledger.) | | `TransactionResult` | String | A [result code](transaction-results.html) indicating whether the transaction succeeded or how it failed. | -| [`delivered_amount`](transaction-metadata.html#delivered_amount) | [Currency Amount][] | _(Omitted for non-Payment transactions)_ The [Currency Amount][] actually received by the `Destination` account. Use this field to determine how much was delivered, regardless of whether the transaction is a [partial payment](partial-payments.html). See [this description](transaction-metadata.html#delivered_amount) for details. [New in: rippled 0.27.0][] | +| [`delivered_amount`](transaction-metadata.html#delivered_amount) | [Currency Amount][] | _(Omitted for non-Payment transactions)_ The [Currency Amount][] actually received by the `Destination` account. Use this field to determine how much was delivered, regardless of whether the transaction is a [partial payment](partial-payments.html). See [this description](transaction-metadata.html#delivered_amount) for details. | diff --git a/content/concepts/tokens/issuing-and-operational-addresses.ja.md b/content/concepts/accounts/account-types.ja.md similarity index 98% rename from content/concepts/tokens/issuing-and-operational-addresses.ja.md rename to content/concepts/accounts/account-types.ja.md index ee04830a37..0e5e908289 100644 --- a/content/concepts/tokens/issuing-and-operational-addresses.ja.md +++ b/content/concepts/accounts/account-types.ja.md @@ -1,6 +1,6 @@ --- -html: issuing-and-operational-addresses.html -parent: tokens.html +html: account-types.html +parent: accounts.html blurb: XRP Ledgerで自動的にトランザクションを送信するビジネスは、リスクを最小限に抑えるために目的ごとに別のアドレスを設定することをおすすめします。 labels: - トークン @@ -63,7 +63,7 @@ XRP LedgerのXRP以外の残高はすべて、2つのXRP Ledgerアドレス間 - [アカウント](accounts.html) - [暗号鍵](cryptographic-keys.html) - **チュートリアル:** - - [XRP Ledgerゲートウェイの開設](become-an-xrp-ledger-gateway.html) + - [XRP Ledgerゲートウェイの開設](stablecoin-issuer.html) - [レギュラーキーペアの割り当て](assign-a-regular-key-pair.html) - [レギュラーキーペアの変更または削除](change-or-remove-a-regular-key-pair.html) - **リファレンス:** diff --git a/content/concepts/tokens/issuing-and-operational-addresses.md b/content/concepts/accounts/account-types.md similarity index 97% rename from content/concepts/tokens/issuing-and-operational-addresses.md rename to content/concepts/accounts/account-types.md index ddc1069fee..abbf27be0b 100644 --- a/content/concepts/tokens/issuing-and-operational-addresses.md +++ b/content/concepts/accounts/account-types.md @@ -1,12 +1,12 @@ --- -html: issuing-and-operational-addresses.html -parent: tokens.html +html: account-types.html +parent: accounts.html blurb: Businesses sending transactions on the XRP Ledger automatically should set up separate addresses for different purposes to minimize risk. labels: - Tokens - Security --- -# Issuing and Operational Addresses +# Account Types {% include '_snippets/issuing-and-operational-addresses-intro.md' %} @@ -73,7 +73,6 @@ If a standby address is compromised, the consequences are like an operational ad - [Accounts](accounts.html) - [Cryptographic Keys](cryptographic-keys.html) - **Tutorials:** - - [Become an XRP Ledger Gateway](become-an-xrp-ledger-gateway.html) - [Assign a Regular Key Pair](assign-a-regular-key-pair.html) - [Change or Remove a Regular Key Pair](change-or-remove-a-regular-key-pair.html) - **References:** diff --git a/content/concepts/payment-system-basics/accounts/accounts.ja.md b/content/concepts/accounts/accounts.ja.md similarity index 95% rename from content/concepts/payment-system-basics/accounts/accounts.ja.md rename to content/concepts/accounts/accounts.ja.md index c71c3c761f..8feed9de74 100644 --- a/content/concepts/payment-system-basics/accounts/accounts.ja.md +++ b/content/concepts/accounts/accounts.ja.md @@ -1,6 +1,6 @@ --- html: accounts.html -parent: payment-system-basics.html +parent: concepts.html blurb: XRP Ledgerのアカウントについて説明します。アカウントはトランザクションを送信でき、XRPを保有できます。 labels: - アカウント @@ -12,12 +12,12 @@ XRP Ledgerの「アカウント」は、XRPの所有者と[トランザクショ - 識別用の**アドレス**。例えば、`rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn` - **注記:** XRPコミュニティは、取引所およびウォレットで[宛先タグ](https://xrpl.org/source-and-destination-tags.html)の代わりに使用できる新しいフォーマット、**X**アドレスを[提案](https://github.com/XRPLF/XRPL-Standards/issues/6)（これをサポートする[コーデック](https://github.com/xrp-community/xrpl-tagged-address-codec)も開発）しました。これらの「パック化」したアドレスは、`r`ではなく`X`で開始します。詳細は、[XRPL 𝗫-address format](https://xrpaddress.info/)のサイトを参照してください。 + **注記:** XRPコミュニティは、取引所およびウォレットで[宛先タグ](source-and-destination-tags.html)の代わりに使用できる新しいフォーマット、**X**アドレスを[提案](https://github.com/XRPLF/XRPL-Standards/issues/6)（これをサポートする[コーデック](https://github.com/xrp-community/xrpl-tagged-address-codec)も開発）しました。これらの「パック化」したアドレスは、`r`ではなく`X`で開始します。詳細は、[XRPL 𝗫-address format](https://xrpaddress.info/)のサイトを参照してください。 - **XRPの残高**。このXRPの一部は、[準備金](reserves.html)用に確保されています。 - **シーケンス番号**。このアカウントから送信されるトランザクションがすべて、正しい順序で、それぞれ1回のみ適用されるようにします。トランザクションを実行するには、トランザクションのシーケンス番号と送金元のシーケンス番号が一致する必要があります。その後も、トランザクションが適用されている限り、アカウントのシーケンス番号は1ずつ増加します。（関連項目: [基本的なデータタイプ: アカウントシーケンス](basic-data-types.html#アカウントシーケンス)） - このアカウントと残高に影響を及ぼした**取引の履歴**。 -- [トランザクションの承認](transaction-basics.html#トランザクションの承認)方法。以下に例を示します。 +- [トランザクションの承認](transactions.html#トランザクションの承認)方法。以下に例を示します。 - アカウント固有のマスターキーのペア。（[無効](accountset.html)にできますが、変更はできません。） - [ローテーションで使用](setregularkey.html)できる「レギュラー」キーペア。 - [マルチシグ](multi-signing.html)の署名者のリスト。（アカウントのコアデータとは別に保存されます。） @@ -169,7 +169,7 @@ XRP Ledgerのアドレスは、[base58][]_形式のディクショナリ_`rpshna - **コンセプト:** - [準備金](reserves.html) - [暗号鍵](cryptographic-keys.html) - - [発行アドレスと運用アドレス](issuing-and-operational-addresses.html) + - [発行アドレスと運用アドレス](account-types.html) - **リファレンス:** - [account_infoメソッド][] - [wallet_proposeメソッド][] diff --git a/content/concepts/accounts/accounts.md b/content/concepts/accounts/accounts.md new file mode 100644 index 0000000000..e714896a34 --- /dev/null +++ b/content/concepts/accounts/accounts.md @@ -0,0 +1,71 @@ +--- +html: accounts.html +parent: concepts.html +blurb: Learn about accounts in the XRP Ledger. Accounts can send transactions and hold XRP. +labels: + - Accounts + - Payments +--- +# Accounts + +An "Account" in the XRP Ledger represents a holder of XRP and a sender of [transactions](transaction-formats.html). + +An account consists of an address, an XRP balance, a sequence number, and a history of its transactions. To be able to send transactions, the owner also needs one or more cryptographic key pairs associated with the account. + + +## Account Structure + + The core elements of an account are: + +- An identifying **address**, such as `rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn`. +- An **XRP balance**. Some of this XRP is set aside for the [Reserve](reserves.html). +- A **sequence number**, which helps make sure any transactions this account sends are applied in the correct order and only once. To execute a transaction, the transaction's sequence number and its sender's sequence number must match. Then, as part of applying the transaction, the account's sequence number increases by 1. (See also: [Basic Data Types: Account Sequence](basic-data-types.html#account-sequence).) +- A **history of transactions** that affected this account and its balances. +- One or more ways to [authorize transactions](transactions.html#authorizing-transactions), possibly including: + - A master key pair intrinsic to the account. (This can be disabled but not changed.) + - A "regular" key pair that can be rotated. + - A signer list for [multi-signing](multi-signing.html). (Stored separately from the account's core data.) + +An account's core data is stored in an [AccountRoot](accountroot.html) ledger entry. An account can also be the owner (or partial owner) of several other types of ledger entry. + +**Tip:** An "Account" in the XRP Ledger is somewhere between the financial usage (like "bank account") and the computing usage (like "UNIX account"). Non-XRP currencies and assets aren't stored in an XRP Ledger Account itself; each such asset is stored in an accounting relationship called a "Trust Line" that connects two parties. + + +## Creating Accounts + +There is not a dedicated "create account" transaction. The [Payment transaction][] automatically creates a new account if the payment sends enough XRP to a mathematically-valid address that does not already have an account. This is called _funding_ an account, and creates an [AccountRoot entry](accountroot.html) in the ledger. No other transaction can create an account. + +**Caution:** Funding an account **does not** give you any special privileges over that account. Whoever has the secret key corresponding to the account's address has full control over the account and all XRP it contains. For some addresses, it's possible that no one has the secret key, in which case the account is a [black hole](addresses.html#special-addresses) and the XRP is lost forever. + +The typical way to get an account in the XRP Ledger is as follows: + +1. Generate a key pair from a strong source of randomness and calculate the address of that key pair. + +2. Have someone who already has an account in the XRP Ledger send XRP to the address you generated. + + - For example, you can buy XRP in a private exchange, then withdraw XRP from the exchange to the address you specified. + + **Caution:** The first time you receive XRP at your own XRP Ledger address, you must pay the [account reserve](reserves.html) (currently 10 XRP), which locks up that amount of XRP indefinitely. In contrast, private exchanges usually hold all their customers' XRP in a few shared XRP Ledger accounts, so customers don't have to pay the reserve for individual accounts at the exchange. Before withdrawing, consider whether having your own account directly on the XRP Ledger is worth the price. + + + +## See Also + +- **Concepts:** + - [Reserves](reserves.html) + - [Cryptographic Keys](cryptographic-keys.html) + - [Issuing and Operational Addresses](account-types.html) +- **References:** + - [account_info method][] + - [wallet_propose method][] + - [AccountSet transaction][] + - [Payment transaction][] + - [AccountRoot object](accountroot.html) +- **Tutorials:** + - [Manage Account Settings (Category)](manage-account-settings.html) + - [Monitor Incoming Payments with WebSocket](monitor-incoming-payments-with-websocket.html) + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/accounts/addresses.md b/content/concepts/accounts/addresses.md new file mode 100644 index 0000000000..dcf78d0829 --- /dev/null +++ b/content/concepts/accounts/addresses.md @@ -0,0 +1,89 @@ +--- +html: addresses.html +parent: accounts.html +blurb: Addresses uniquely identify XRP Ledger accounts, using base58 format. +labels: + - Accounts +--- +# Addresses + +{% include '_snippets/data_types/address.md' %} + +Any valid address can [become an account in the XRP Ledger](accounts.html#creating-accounts) by being funded. You can also use an address that has not been funded to represent a [regular key](cryptographic-keys.html) or a member of a [signer list](multi-signing.html). Only a funded account can be the sender of a transaction. + +Creating a valid address is a strictly mathematical task starting with a key pair. You can generate a key pair and calculate its address entirely offline without communicating to the XRP Ledger or any other party. The conversion from a public key to an address involves a one-way hash function, so it is possible to confirm that a public key matches an address but it is impossible to derive the public key from the address alone. (This is part of the reason why signed transactions include the public key _and_ the address of the sender.) + + +## Special Addresses + +Some addresses have special meaning, or historical uses, in the XRP Ledger. In many cases, these are "black hole" addresses, meaning the address is not derived from a known secret key. Since it is effectively impossible to guess a secret key from only an address, any XRP possessed by black hole addresses is lost forever. + + +| Address | Name | Meaning | Black Hole? | +|-------------------------------|------|---------|-------------| +| `rrrrrrrrrrrrrrrrrrrrrhoLvTp` | ACCOUNT\_ZERO | An address that is the XRP Ledger's [base58][] encoding of the value `0`. In peer-to-peer communications, `rippled` uses this address as the issuer for XRP. | Yes | +| `rrrrrrrrrrrrrrrrrrrrBZbvji` | ACCOUNT\_ONE | An address that is the XRP Ledger's [base58][] encoding of the value `1`. In the ledger, [RippleState entries](ripplestate.html) use this address as a placeholder for the issuer of a trust line balance. | Yes | +| `rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh` | The genesis account | When `rippled` starts a new genesis ledger from scratch (for example, in stand-alone mode), this account holds all the XRP. This address is generated from the seed value `masterpassphrase` which is [hard-coded](https://github.com/ripple/rippled/blob/94ed5b3a53077d815ad0dd65d490c8d37a147361/src/ripple/app/ledger/Ledger.cpp#L184). | No | +| `rrrrrrrrrrrrrrrrrNAMEtxvNvQ` | Ripple Name reservation black-hole | In the past, Ripple asked users to send XRP to this account to reserve Ripple Names.| Yes | +| `rrrrrrrrrrrrrrrrrrrn5RM1rHd` | NaN Address | Previous versions of [ripple-lib](https://github.com/XRPLF/xrpl.js) generated this address when encoding the value [NaN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN) using the XRP Ledger's [base58][] string encoding format. | Yes | + + +## Address Encoding + +**Tip:** These technical details are only relevant for people building low-level library software for XRP Ledger compatibility! + +[[Source]](https://github.com/ripple/rippled/blob/35fa20a110e3d43ffc1e9e664fc9017b6f2747ae/src/ripple/protocol/impl/AccountID.cpp#L109-L140 "Source") + +XRP Ledger addresses are encoded using [base58][] with the _dictionary_ `rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz`. Since the XRP Ledger encodes several types of keys with base58, it prefixes the encoded data with a one-byte "type prefix" (also called a "version prefix") to distinguish them. The type prefix causes addresses to usually start with different letters in base58 format. + +The following diagram shows the relationship between keys and addresses: + +{{ include_svg("img/address-encoding.svg", "Master Public Key + Type Prefix → Account ID + Checksum → Address") }} + +The formula for calculating an XRP Ledger address from a public key is as follows. For the complete example code, see [`encode_address.js`](https://github.com/XRPLF/xrpl-dev-portal/blob/master/content/_code-samples/address_encoding/js/encode_address.js). For the process of deriving a public key from a passphrase or seed value, see [Key Derivation](cryptographic-keys.html#key-derivation). + +1. Import required algorithms: SHA-256, RIPEMD160, and base58. Set the dictionary for base58. + + 'use strict'; + const assert = require('assert'); + const crypto = require('crypto'); + const R_B58_DICT = 'rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz'; + const base58 = require('base-x')(R_B58_DICT); + + assert(crypto.getHashes().includes('sha256')); + assert(crypto.getHashes().includes('ripemd160')); + +2. Start with a 33-byte ECDSA secp256k1 public key, or a 32-byte Ed25519 public key. For Ed25519 keys, prefix the key with the byte `0xED`. + + const pubkey_hex = + 'ED9434799226374926EDA3B54B1B461B4ABF7237962EAE18528FEA67595397FA32'; + const pubkey = Buffer.from(pubkey_hex, 'hex'); + assert(pubkey.length == 33); + +3. Calculate the [RIPEMD160](https://en.wikipedia.org/wiki/RIPEMD) hash of the SHA-256 hash of the public key. This value is the "Account ID". + + const pubkey_inner_hash = crypto.createHash('sha256').update(pubkey); + const pubkey_outer_hash = crypto.createHash('ripemd160'); + pubkey_outer_hash.update(pubkey_inner_hash.digest()); + const account_id = pubkey_outer_hash.digest(); + +4. Calculate the SHA-256 hash of the SHA-256 hash of the Account ID; take the first 4 bytes. This value is the "checksum". + + const address_type_prefix = Buffer.from([0x00]); + const payload = Buffer.concat([address_type_prefix, account_id]); + const chksum_hash1 = crypto.createHash('sha256').update(payload).digest(); + const chksum_hash2 = crypto.createHash('sha256').update(chksum_hash1).digest(); + const checksum = chksum_hash2.slice(0,4); + +5. Concatenate the payload and the checksum. Calculate the base58 value of the concatenated buffer. The result is the address. + + const dataToEncode = Buffer.concat([payload, checksum]); + const address = base58.encode(dataToEncode); + console.log(address); + // rDTXLQ7ZKZVKz33zJbHjgVShjsBnqMBhmN + + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/payment-system-basics/accounts/cryptographic-keys.ja.md b/content/concepts/accounts/cryptographic-keys.ja.md similarity index 96% rename from content/concepts/payment-system-basics/accounts/cryptographic-keys.ja.md rename to content/concepts/accounts/cryptographic-keys.ja.md index 2e71627b16..a6368b67c1 100644 --- a/content/concepts/payment-system-basics/accounts/cryptographic-keys.ja.md +++ b/content/concepts/accounts/cryptographic-keys.ja.md @@ -8,7 +8,7 @@ labels: --- # 暗号鍵 -XRP Ledgerでは、[トランザクション](transaction-basics.html)による一連の具体的なアクションの実行が承認されていることを、デジタル署名によって証明します。署名されたトランザクションのみがネットワークに送信され、検証済みレジャーに含まれます。 +XRP Ledgerでは、[トランザクション](transactions.html)による一連の具体的なアクションの実行が承認されていることを、デジタル署名によって証明します。署名されたトランザクションのみがネットワークに送信され、検証済みレジャーに含まれます。 すべてのデジタル署名は、トランザクションの送信側アカウントに関連付けられている暗号鍵ペアに基づいています。キーペアはXRP Ledgerでサポートされている[暗号化署名アルゴリズム](#署名アルゴリズム)を使用して生成できます。キーペアの生成に使用されたアルゴリズムの種類にかかわらず、キーペアは[マスターキーペア](#マスターキーペア)、[レギュラーキーペア](#レギュラーキーペア)、または[署名者リスト](multi-signing.html)のメンバーとして使用できます。 @@ -42,7 +42,7 @@ _図: 暗号鍵の値の関係を簡略化した図_ ### シード -_シード_ 値は、アカウントの実際の秘密鍵と公開鍵を[導出](#鍵導出)するために使用される、コンパクトな値です。[wallet_proposeメソッド][]のレスポンスでは、`master_key`, `master_seed`, `master_seed_hex` はすべて同一のシード値を様々な形式で表現します。これらの形式はいずれも、[`rippled` API](http-websocket-apis.html) やいくつかの [他のXRP Ledgerソフトウェア](software-ecosystem.html) で [トランザクションの署名] (transaction-basics.html#signing-and-submitting-transactions) に使用することができます。`master_`という接頭辞がついていますが、このシードが表す鍵は必ずしもアカウントのマスターキーではありません。この鍵ペアはレギュラーキーとして、あるいはマルチシグリストのメンバーとして使用することもできます。 +_シード_ 値は、アカウントの実際の秘密鍵と公開鍵を[導出](#鍵導出)するために使用される、コンパクトな値です。[wallet_proposeメソッド][]のレスポンスでは、`master_key`, `master_seed`, `master_seed_hex` はすべて同一のシード値を様々な形式で表現します。これらの形式はいずれも、[`rippled` API](http-websocket-apis.html) やいくつかの [他のXRP Ledgerソフトウェア](software-ecosystem.html) で [トランザクションの署名] (transactions.html#signing-and-submitting-transactions) に使用することができます。`master_`という接頭辞がついていますが、このシードが表す鍵は必ずしもアカウントのマスターキーではありません。この鍵ペアはレギュラーキーとして、あるいはマルチシグリストのメンバーとして使用することもできます。 シード値は秘密情報であるため、非常に厳重に保管する必要があります。あるアドレスのシード値を知っている人は、そのアドレスを実質的に完全にコントロールすることができます。 @@ -82,7 +82,7 @@ XRP Ledgerは、複数の[暗号署名アルゴリズム](#署名アルゴリズ マスターキーペアは、秘密鍵と公開鍵で構成されています。アカウントのアドレスは、そのアカウントのマスターキーペアから得られるので、両者は[本質的な関係](accounts.html#アドレスのエンコード)となります。マスターキーペアの変更・削除はできませんが、無効にすることはできます。 -[wallet_proposeメソッド][]は、マスターキーペアを生成する方法の1つです。このメソッドからの応答には、アカウントのシード、アドレス、マスター公開鍵が一緒に表示されます。マスターキーペアを設定する他の方法については、[安全な署名の設定](set-up-secure-signing.html) を参照してください。 +[wallet_proposeメソッド][]は、マスターキーペアを生成する方法の1つです。このメソッドからの応答には、アカウントのシード、アドレス、マスター公開鍵が一緒に表示されます。マスターキーペアを設定する他の方法については、[安全な署名の設定](secure-signing.html) を参照してください。 **注意:** 悪意のある行為者があなたのマスター秘密鍵（またはシード）を知った場合、マスター鍵ペアが無効化されていない限り、彼らはあなたのアカウントを完全にコントロールすることができます。彼らはあなたのアカウントが保持している全ての資金を盗み、その他の回復不能な損害を与えることができます。秘密鍵は慎重に扱ってください！ @@ -94,7 +94,7 @@ XRP Ledgerは、複数の[暗号署名アルゴリズム](#署名アルゴリズ **マスターキーペア**のみが、ある特定の処理を行うトランザクションを承認することができます。 -- アカウントの最初のトランザクションを送信する。アカウントはその他の方法で[トランザクションを承認](transaction-basics.html#authorizing-transactions)して初期化することができないからです。 +- アカウントの最初のトランザクションを送信する。アカウントはその他の方法で[トランザクションを承認](transactions.html#トランザクションの承認)して初期化することができないからです。 - マスターキーペアを無効化する。 @@ -241,7 +241,7 @@ XRP Ledgerアカウントキーでのsecp256k1鍵導出に、Ed25519鍵導出よ ## 関連項目 - **コンセプト:** - - [発行アドレスと運用アドレス](issuing-and-operational-addresses.html) + - [発行アドレスと運用アドレス](account-types.html) - **チュートリアル:** - [レギュラーキーペアの割り当て](assign-a-regular-key-pair.html) - [レギュラーキーペアの変更または削除](change-or-remove-a-regular-key-pair.html) diff --git a/content/concepts/payment-system-basics/accounts/cryptographic-keys.md b/content/concepts/accounts/cryptographic-keys.md similarity index 94% rename from content/concepts/payment-system-basics/accounts/cryptographic-keys.md rename to content/concepts/accounts/cryptographic-keys.md index 8952dacb2d..0a8e7c6494 100644 --- a/content/concepts/payment-system-basics/accounts/cryptographic-keys.md +++ b/content/concepts/accounts/cryptographic-keys.md @@ -8,7 +8,7 @@ labels: --- # Cryptographic Keys -In the XRP Ledger, a digital signature _authorizes_ a [transaction](transaction-basics.html) to do a specific set of actions. Only signed transactions can be submitted to the network and included in a validated ledger. +In the XRP Ledger, a digital signature _authorizes_ a [transaction](transactions.html) to do a specific set of actions. Only signed transactions can be submitted to the network and included in a validated ledger. To make a digital signature, you use a cryptographic key pair associated with the transaction's sending account. A key pair may be generated using any of the XRP Ledger's supported [cryptographic signing algorithms](#signing-algorithms). A key pair can be used as a [master key pair](#master-key-pair), [regular key pair](#regular-key-pair) or a member of a [signer list](multi-signing.html), regardless of what algorithm was used to generate it. @@ -42,7 +42,7 @@ The passphrase is secret information, so you must protect it very carefully. Any ### Seed -A _seed_ value is a compact value that is used to [derive](#key-derivation) the actual private and public keys for an account. In a [wallet_propose method][] response, the `master_key`, `master_seed`, and `master_seed_hex` all represent the same seed value, in various formats. Any of these formats can be used to [sign transactions](transaction-basics.html#signing-and-submitting-transactions) in the [`rippled` APIs](http-websocket-apis.html) and some [other XRP Ledger software](software-ecosystem.html). Despite being prefixed with `master_`, the keys this seed represents are not necessarily the master keys for an account; you can use a key pair as a regular key or a member of a multi-signing list as well. +A _seed_ value is a compact value that is used to [derive](#key-derivation) the actual private and public keys for an account. In a [wallet_propose method][] response, the `master_key`, `master_seed`, and `master_seed_hex` all represent the same seed value, in various formats. Any of these formats can be used to sign transactions. Despite being prefixed with `master_`, the keys this seed represents are not necessarily the master keys for an account; you can use a key pair as a regular key or a member of a multi-signing list as well. The seed value is secret information, so you must protect it very carefully. Anyone who knows an address's seed value has effectively full control over that address. @@ -81,9 +81,9 @@ The `key_type` field in the [wallet_propose method][] refers to the cryptographi ## Master Key Pair -The master key pair consists of a private key and a public key. The address of an account is derived from the account's master key pair, so they are [intrinsically related](accounts.html#address-encoding). You cannot change or remove the master key pair, but you can disable it. +The master key pair consists of a private key and a public key. The address of an account is derived from the account's master key pair, so they are intrinsically related. You cannot change or remove the master key pair, but you can disable it. -The [wallet_propose method][] is one way of generating a master key pair. The response from this method shows the account's seed, address, and master public key together. For some other ways of setting up master key pairs, see [Set Up Secure Signing](set-up-secure-signing.html). +The [wallet_propose method][] is one way of generating a master key pair. The response from this method shows the account's seed, address, and master public key together. For some other ways of setting up master key pairs, see [Secure Signing](secure-signing.html). **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! @@ -97,7 +97,7 @@ Keeping your master key pair offline means not putting the secret information (p **Only** the master key pair can authorize transactions to do certain things: -- Send an account's very first transaction, because accounts cannot be initialized with another way of [authorizing transactions](transaction-basics.html#authorizing-transactions). +- Send an account's very first transaction, because accounts cannot be initialized with another way of [authorizing transactions](transactions.html#authorizing-transactions). - Disable the master key pair. @@ -105,7 +105,7 @@ Keeping your master key pair offline means not putting the secret information (p - Send a special [key reset transaction](transaction-cost.html#key-reset-transaction) with a transaction cost of 0 XRP. -A regular key or [multi-signature](multi-signing.html) can do anything else the same as the master key pair. Notably, after you have disabled the master key pair, you can re-enable it using a regular key pair or multi-signature. You can also [delete an account](accounts.html#deletion-of-accounts) if it meets the requirements for deletion. +A regular key or [multi-signature](multi-signing.html) can do anything else the same as the master key pair. Notably, after you have disabled the master key pair, you can re-enable it using a regular key pair or multi-signature. You can also [delete an account](deleting-accounts.html) if it meets the requirements for deletion. ## Regular Key Pair @@ -134,7 +134,7 @@ The XRP Ledger supports the following cryptographic signing algorithms: When you generate a key pair with the [wallet_propose method][], you can specify the `key_type` to choose which cryptographic signing algorithm to use to derive the keys. If you generated a key type other than the default, you must also specify the `key_type` when signing transactions. -The supported types of key pairs can be used interchangeably throughout the XRP Ledger as master key pairs, regular key pairs, and members of signer lists. The process of [deriving an address](accounts.html#address-encoding) is the same for secp256k1 and Ed25519 key pairs. +The supported types of key pairs can be used interchangeably throughout the XRP Ledger as master key pairs, regular key pairs, and members of signer lists. The process of [deriving an address](addresses.html#address-encoding) is the same for secp256k1 and Ed25519 key pairs. ### Future Algorithms @@ -237,13 +237,13 @@ The steps to derive the XRP Ledger's secp256k1 account key pair from a seed valu 6. When serializing an account's public key to its [base58][] format, use the account public key prefix, `0x23`. - See [Address Encoding](accounts.html#address-encoding) for information and sample code to convert from an account's public key to its address. + See [Address Encoding](addresses.html#address-encoding) for information and sample code to convert from an account's public key to its address. ## See Also - **Concepts:** - - [Issuing and Operational Addresses](issuing-and-operational-addresses.html) + - [Issuing and Operational Addresses](account-types.html) - **Tutorials:** - [Assign a Regular Key Pair](assign-a-regular-key-pair.html) - [Change or Remove a Regular Key Pair](change-or-remove-a-regular-key-pair.html) diff --git a/content/concepts/accounts/deleting-accounts.md b/content/concepts/accounts/deleting-accounts.md new file mode 100644 index 0000000000..d2d95cbc52 --- /dev/null +++ b/content/concepts/accounts/deleting-accounts.md @@ -0,0 +1,40 @@ +--- +html: deleting-accounts.html +parent: accounts.html +blurb: About deleting an XRP Ledger account. +labels: + - Accounts +--- +## Deleting Accounts + +The owner of an account can send an [AccountDelete transaction][] to deletes the account and related entries from the ledger, sending most of the account's remaining XRP balance to another account. To discourage wasteful creation and deletion of accounts, deleting an account requires burning a higher than usual amount of XRP as the [transaction cost](transaction-cost.html). + +Some types of associated ledger entries block an account from being deleted. For example, the issuer of a fungible token can't be deleted while anyone holds a nonzero balance of that token. + +After an account has been deleted, it can be re-created in the ledger through the normal method of [creating accounts](accounts.html#creating-accounts). An account that has been deleted and re-created is no different than an account that has been created for the first time. + +## Requirements + +To be deleted, an account must meet the following requirements: + +- The account's `Sequence` number plus 256 must be less than the current [Ledger Index][]. +- The account must not be linked to any of the following types of [ledger objects](ledger-object-types.html) (as a sender or receiver): + - `Escrow` + - `PayChannel` + - `RippleState` + - `Check` +- The account must own fewer than 1000 objects in the ledger. +- The transaction must pay a special [transaction cost][] equal to at least the [owner reserve](reserves.html) for one item (currently 2 XRP). + +## Cost of Deleting + +**Warning:** The [AccountDelete transaction][]'s transaction cost always applies when the transaction is included in a validated ledger, even if the transaction failed because the account does not meet the requirements to be deleted. To greatly reduce the chances of paying the high transaction cost if the account cannot be deleted, use the `fail_hard` option when submitting an AccountDelete transaction. + +Unlike Bitcoin and many other cryptocurrencies, each new version of the XRP Ledger's public ledger chain contains the full state of the ledger, which increases in size with each new account. For that reason, you should not create new XRP Ledger accounts unless necessary. You can recover some of an account's 10 XRP [reserve](reserves.html) by deleting the account, but you must still destroy at least 2 XRP to do so. + +Institutions who send and receive value on behalf of many users can use [**Source Tags** and **Destination Tags**](source-and-destination-tags.html) to distinguish payments from and to their customers while only using one (or a handful) of accounts in the XRP Ledger. + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/payment-system-basics/accounts/depositauth.ja.md b/content/concepts/accounts/depositauth.ja.md similarity index 96% rename from content/concepts/payment-system-basics/accounts/depositauth.ja.md rename to content/concepts/accounts/depositauth.ja.md index 7408e6c080..9a52f5ea16 100644 --- a/content/concepts/payment-system-basics/accounts/depositauth.ja.md +++ b/content/concepts/accounts/depositauth.ja.md @@ -105,7 +105,7 @@ DepositPreauthトランザクションの処理が完了すると、承認済み - [`rippled` API](http-websocket-apis.html)の[deposit_authorizedメソッド][]。 - [Authorized Trust Lines](authorized-trust-lines.html)機能（`RequireAuth`フラグ）により、アカウントが発行したXRP以外の通貨を保有できる取引相手が制限されます。 - `DisallowXRP`フラグは、アカウントがXRPを受領してはならないことを示します。これはDeposit Authorizationよりもソフトな保護機能であり、XRP Ledgerにより強制されません。（クライアントアプリケーションはこのフラグに従うか、または少なくともこのフラグについて警告します。） -- 送信トランザクションが[Destinationタグ](become-an-xrp-ledger-gateway.html#source-and-destination-tags)を指定している場合には、`RequireDest`フラグは、アカウントが通貨額のみを受領できることを示します。これにより、ユーザーが支払の目的を指定し忘れることがなくなりますが、恣意的な送金先タグを作成できる不明な送金元から受取人が保護されるわけではありません。 +- 送信トランザクションが[Destinationタグ](source-and-destination-tags.html)を指定している場合には、`RequireDest`フラグは、アカウントが通貨額のみを受領できることを示します。これにより、ユーザーが支払の目的を指定し忘れることがなくなりますが、恣意的な送金先タグを作成できる不明な送金元から受取人が保護されるわけではありません。 - [Partial Payment](partial-payments.html)により、アカウントは不要な支払を返金できます。この際、[送金手数料](transfer-fees.html)と為替レートは送金額には追加されず、送金された金額から差し引かれます。 diff --git a/content/concepts/payment-system-basics/accounts/depositauth.md b/content/concepts/accounts/depositauth.md similarity index 97% rename from content/concepts/payment-system-basics/accounts/depositauth.md rename to content/concepts/accounts/depositauth.md index 2d7644436d..8ba24916de 100644 --- a/content/concepts/payment-system-basics/accounts/depositauth.md +++ b/content/concepts/accounts/depositauth.md @@ -108,7 +108,7 @@ You can use the [deposit_authorized method][] to see if an account is authorized - The [deposit_authorized method][] of the [`rippled` API](http-websocket-apis.html). - The [Authorized Trust Lines](authorized-trust-lines.html) feature (`RequireAuth` flag) limits which counterparties can hold non-XRP currencies issued by an account. - The `DisallowXRP` flag indicates that an account should not receive XRP. This is a softer protection than Deposit Authorization, and is not enforced by the XRP Ledger. (Client applications should honor this flag or at least warn about it.) -- The `RequireDest` flag indicates that an account can only receive currency amounts if the sending transaction specifies a [Destination Tag](become-an-xrp-ledger-gateway.html#source-and-destination-tags). This protects users from forgetting to indicate the purpose of a payment, but does not protect recipients from unknown senders, who can make up arbitrary destination tags. +- The `RequireDest` flag indicates that an account can only receive currency amounts if the sending transaction specifies a [Destination Tag](source-and-destination-tags.html). This protects users from forgetting to indicate the purpose of a payment, but does not protect recipients from unknown senders, who can make up arbitrary destination tags. - [Partial Payments](partial-payments.html) provide a way for accounts to return unwanted payments while subtracting [transfer fees](transfer-fees.html) and exchange rates from the amount delivered instead of adding them to the amount sent. diff --git a/content/concepts/payment-system-basics/accounts/reserves.ja.md b/content/concepts/accounts/reserves.ja.md similarity index 100% rename from content/concepts/payment-system-basics/accounts/reserves.ja.md rename to content/concepts/accounts/reserves.ja.md diff --git a/content/concepts/payment-system-basics/accounts/reserves.md b/content/concepts/accounts/reserves.md similarity index 96% rename from content/concepts/payment-system-basics/accounts/reserves.md rename to content/concepts/accounts/reserves.md index 5aaa575329..0752b1eb8e 100644 --- a/content/concepts/payment-system-basics/accounts/reserves.md +++ b/content/concepts/accounts/reserves.md @@ -11,7 +11,7 @@ top_nav_grouping: Popular Pages The XRP Ledger applies _reserve requirements_, in XRP, to protect the shared global ledger from growing excessively large as the result of spam or malicious usage. The goal is to constrain the growth of the ledger to match improvements in technology so that a current commodity-level machine can always fit the current ledger in RAM. -To have an account, an address must hold a minimum amount of XRP in the shared global ledger. To fund a new address, you must receive enough XRP at that address to meet the reserve requirement. You cannot send the reserved XRP to others, but you can recover some of the XRP by [deleting the account](accounts.html#deletion-of-accounts). +To have an account, an address must hold a minimum amount of XRP in the shared global ledger. To fund a new address, you must receive enough XRP at that address to meet the reserve requirement. You cannot send the reserved XRP to others, but you can recover some of the XRP by [deleting the account](deleting-accounts.html). The reserve requirement changes from time to time due to the [Fee Voting](fee-voting.html) process, where validators can agree to new reserve settings. @@ -60,7 +60,7 @@ To calculate an address's total reserve requirement, multiply `OwnerCount` by `r During transaction processing, the [transaction cost](transaction-cost.html) destroys some of the sending address's XRP balance. This can cause an address's XRP to go below the reserve requirement. You can even destroy _all_ of your XRP this way. -When your account holds less XRP than its current reserve requirement, you cannot send XRP to others, or create new objects that would increase your account's reserve requirement. Even so, the account continues to exist in the ledger and you can still send transactions that don't do these things, as long as you have enough XRP to pay the transaction cost. You can go back above the reserve requirement by receiving enough XRP, or if the [reserve requirement decreases](#changing-the-reserve-requirements) below the amount you have. +When your account holds less XRP than its current reserve requirement, you cannot send XRP to others, or create new objects that would increase your account's reserve requirement. Even so, the account continues to exist in the ledger and you can still send transactions that don't do these things, as long as you have enough XRP to pay the transaction cost. You can go back above the reserve requirement by receiving enough XRP, or if the reserve requirement decreases below the amount you have. **Tip:** If your address is below the reserve requirement, you can send an [OfferCreate transactions][] to acquire more XRP and get back above the reserve requirement. However, since you cannot create an [Offer entry in the ledger](offer.html) while you are below the reserve, this transaction can only consume Offers that are already in the order books. diff --git a/content/concepts/consensus-network/consensus-principles-and-rules.ja.md b/content/concepts/consensus-protocol/consensus-principles-and-rules.ja.md similarity index 99% rename from content/concepts/consensus-network/consensus-principles-and-rules.ja.md rename to content/concepts/consensus-protocol/consensus-principles-and-rules.ja.md index 7a7a20d00d..4df52e6630 100644 --- a/content/concepts/consensus-network/consensus-principles-and-rules.ja.md +++ b/content/concepts/consensus-protocol/consensus-principles-and-rules.ja.md @@ -1,6 +1,6 @@ --- html: consensus-principles-and-rules.html -parent: consensus-network.html +parent: consensus.html blurb: XRP Ledgerは世界規模の決済システムで、ユーザーはメールを送るときのようにスムーズに国境を越えて送金することができます。 labels: - ブロックチェーン diff --git a/content/concepts/consensus-network/consensus-principles-and-rules.md b/content/concepts/consensus-protocol/consensus-principles-and-rules.md similarity index 99% rename from content/concepts/consensus-network/consensus-principles-and-rules.md rename to content/concepts/consensus-protocol/consensus-principles-and-rules.md index 4eb50796b2..1440414662 100644 --- a/content/concepts/consensus-network/consensus-principles-and-rules.md +++ b/content/concepts/consensus-protocol/consensus-principles-and-rules.md @@ -1,6 +1,6 @@ --- html: consensus-principles-and-rules.html -parent: consensus-network.html +parent: consensus.html blurb: The rules and principles of the consensus algorithm that allow users to transfer funds (including fiat currencies, digital currencies and other forms of value) across national boundaries as seamlessly as sending an email. labels: - Blockchain @@ -113,7 +113,7 @@ The XRP Ledger's consensus algorithm provides a robust alternative to proof of w ## See Also - **Concepts:** - - [Introduction to Consensus](intro-to-consensus.html) + - [Consensus](consensus.html) - [Consensus Research](consensus-research.html) - [XRPL Consensus Mechanism Video](https://www.youtube.com/watch?v=k6VqEkqRTmk&list=PLJQ55Tj1hIVZtJ_JdTvSum2qMTsedWkNi&index=2) - **Tutorials:** diff --git a/content/concepts/consensus-network/consensus-protections.ja.md b/content/concepts/consensus-protocol/consensus-protections.ja.md similarity index 94% rename from content/concepts/consensus-network/consensus-protections.ja.md rename to content/concepts/consensus-protocol/consensus-protections.ja.md index d8dbdf748f..9ca7e42ad1 100644 --- a/content/concepts/consensus-network/consensus-protections.ja.md +++ b/content/concepts/consensus-protocol/consensus-protections.ja.md @@ -1,6 +1,6 @@ --- html: consensus-protections.html -parent: consensus-network.html +parent: consensus.html blurb: Learn how the XRP Ledger Consensus Protocol is protected against various problems and attacks that may occur in a decentralized financial system. #TODO: translate labels: - ブロックチェーン @@ -9,7 +9,7 @@ labels: XRP Ledgerコンセンサスプロトコルは、 _ビザンチンフォールトトレラント性_ のあるコンセンサスメカニズムです。つまり、あらゆる不適切な状況（参加者が信頼できないオープンネットワークを利用して通信している場合や、不正使用者が常にシステムを乗っ取ろうとしているかまたは中断しようとしている場合など）が発生しても動作するように設計されています。さらに、XRP Ledgerコンセンサスプロトコルの参加者が事前に判明していない場合や、時間の経過とともに変わる場合があります。 -[ネットワークに求められる特性](intro-to-consensus.html#コンセンサスプロトコルの特性)を維持しつつ、トランザクションをタイミングよく承認する作業は複雑であり、また完璧なシステムを構築することは不可能です。XRP Ledgerコンセンサスプロトコルは、ほとんどの状況で機能し、機能できない状況では可能な限り安全に失敗するように設計されています。 +[ネットワークに求められる特性](consensus.html#コンセンサスプロトコルの特性)を維持しつつ、トランザクションをタイミングよく承認する作業は複雑であり、また完璧なシステムを構築することは不可能です。XRP Ledgerコンセンサスプロトコルは、ほとんどの状況で機能し、機能できない状況では可能な限り安全に失敗するように設計されています。 このページでは、XRP Ledgerコンセンサスプロトコルのいくつかの課題のタイプとその対処について説明します。 @@ -68,7 +68,7 @@ XRP Ledgerのすべての参加者が何を検証済みとみなすかについ ## 関連項目 -- コンセンサスの**入門レベルの概要**については、[コンセンサスについて](intro-to-consensus.html)を参照してください。 +- コンセンサスの**入門レベルの概要**については、[コンセンサスについて](consensus.html)を参照してください。 - コンセンサスプロトコルの**詳細な説明**については、[コンセンサス](consensus.html)を参照してください。 - コンセンサスプロトコルの**設計に関する決定と背景**については、[コンセンサスの原理とルール](consensus-principles-and-rules.html)を参照してください。 - コンセンサスプロトコルの特性と制約に関する**学術研究**については、[コンセンサスの研究](consensus-research.html)を参照してください。 diff --git a/content/concepts/consensus-network/consensus-protections.md b/content/concepts/consensus-protocol/consensus-protections.md similarity index 93% rename from content/concepts/consensus-network/consensus-protections.md rename to content/concepts/consensus-protocol/consensus-protections.md index 7635822a4d..d0b3db54e1 100644 --- a/content/concepts/consensus-network/consensus-protections.md +++ b/content/concepts/consensus-protocol/consensus-protections.md @@ -1,6 +1,6 @@ --- html: consensus-protections.html -parent: consensus-network.html +parent: consensus.html blurb: Learn how the XRP Ledger Consensus Protocol is protected against various problems and attacks that may occur in a decentralized financial system. labels: - Blockchain @@ -9,7 +9,7 @@ labels: The XRP Ledger Consensus Protocol is a _byzantine fault tolerant_ consensus mechanism, which means it's designed to work even if all kinds of things can go wrong: participants depend on an unreliable open network to communicate, and malicious actors may be attempting to control or interrupt the system at any given time. On top of that, the set of participants in the XRP Ledger Consensus Protocol isn't known in advance and can change over time. -Confirming transactions quickly while maintaining [the desired properties of the network](intro-to-consensus.html#consensus-protocol-properties) is a complex challenge, and it's impossible to build a perfect system. The XRP Ledger Consensus Protocol is designed to work as well as it can in most situations, and to fail as gracefully as possible in the situations where it can't. +Confirming transactions quickly while maintaining the desired properties of the network is a complex challenge, and it's impossible to build a perfect system. The XRP Ledger Consensus Protocol is designed to work as well as it can in most situations, and to fail as gracefully as possible in the situations where it can't. This page describes some of the types of challenges that the XRP Ledger Consensus Protocol faces and how it handles them. @@ -68,7 +68,6 @@ Research is ongoing to design an improved consensus protocol that allows more he ## See Also -- For an **intro-level overview** of consensus, see [Intro to Consensus](intro-to-consensus.html). - For a **detailed description** of the consensus protocol, see [Consensus](consensus.html). - For an explanation of the **design decisions and background** behind the consensus protocol, see [Consensus Principles and Rules](consensus-principles-and-rules.html). - For **academic research** exploring the properties and limitations of the protocol, see [Consensus Research](consensus-research.html). diff --git a/content/concepts/consensus-network/consensus-research.ja.md b/content/concepts/consensus-protocol/consensus-research.ja.md similarity index 97% rename from content/concepts/consensus-network/consensus-research.ja.md rename to content/concepts/consensus-protocol/consensus-research.ja.md index 9b79859bbb..122ca47d79 100644 --- a/content/concepts/consensus-network/consensus-research.ja.md +++ b/content/concepts/consensus-protocol/consensus-research.ja.md @@ -1,6 +1,6 @@ --- html: consensus-research.html -parent: consensus-network.html +parent: consensus.html blurb: コンセンサスアルゴリズムに関する学術論文と関連研究。 labels: - ブロックチェーン diff --git a/content/concepts/consensus-network/consensus-research.md b/content/concepts/consensus-protocol/consensus-research.md similarity index 97% rename from content/concepts/consensus-network/consensus-research.md rename to content/concepts/consensus-protocol/consensus-research.md index 6c88d440ea..83cdb60c24 100644 --- a/content/concepts/consensus-network/consensus-research.md +++ b/content/concepts/consensus-protocol/consensus-research.md @@ -1,6 +1,6 @@ --- html: consensus-research.html -parent: consensus-network.html +parent: consensus.html blurb: Scholarly articles on consensus algorithms and related research. labels: - Blockchain diff --git a/content/concepts/consensus-network/consensus.ja.md b/content/concepts/consensus-protocol/consensus-structure.ja.md similarity index 99% rename from content/concepts/consensus-network/consensus.ja.md rename to content/concepts/consensus-protocol/consensus-structure.ja.md index cb83c4f4d4..e0dbc1f7db 100644 --- a/content/concepts/consensus-network/consensus.ja.md +++ b/content/concepts/consensus-protocol/consensus-structure.ja.md @@ -1,6 +1,6 @@ --- -html: consensus.html -parent: consensus-network.html +html: consensus-structure.html +parent: consensus.html blurb: XRP Ledgerにおけるコンセンサスの役割について理解を深めましょう。 labels: - ブロックチェーン @@ -170,7 +170,7 @@ XRP Ledgerに送信されたトランザクションはすぐには処理され ## 関連項目 - **コンセプト:** - - [コンセンサスについて](intro-to-consensus.html) + - [コンセンサスについて](consensus.html) - [コンセンサスの研究](consensus-research.html) - [Rippleコンセンサスの動画](https://www.youtube.com/watch?v=pj1QVb1vlC0) - **チュートリアル:** diff --git a/content/concepts/consensus-network/consensus.md b/content/concepts/consensus-protocol/consensus-structure.md similarity index 99% rename from content/concepts/consensus-network/consensus.md rename to content/concepts/consensus-protocol/consensus-structure.md index b6365f308a..7b63bd7c01 100644 --- a/content/concepts/consensus-network/consensus.md +++ b/content/concepts/consensus-protocol/consensus-structure.md @@ -1,11 +1,11 @@ --- -html: consensus.html -parent: consensus-network.html +html: consensus-structure.html +parent: consensus.html blurb: Understand the role of consensus in the XRP Ledger. labels: - Blockchain --- -# Consensus +# Consensus Structure _Written by Dave Cohen, David Schwartz, and Arthur Britto._ @@ -173,7 +173,6 @@ Best practices for applications submitting transactions include: ## See Also - **Concepts:** - - [Introduction to Consensus](intro-to-consensus.html) - [Consensus Research](consensus-research.html) - [The Consensus Mechanism (YouTube)](https://www.youtube.com/watch?v=k6VqEkqRTmk&list=PLJQ55Tj1hIVZtJ_JdTvSum2qMTsedWkNi&index=2) - **Tutorials:** diff --git a/content/concepts/introduction/intro-to-consensus.ja.md b/content/concepts/consensus-protocol/consensus.ja.md similarity index 92% rename from content/concepts/introduction/intro-to-consensus.ja.md rename to content/concepts/consensus-protocol/consensus.ja.md index ab7545a9f4..f6afb3ca96 100644 --- a/content/concepts/introduction/intro-to-consensus.ja.md +++ b/content/concepts/consensus-protocol/consensus.ja.md @@ -1,12 +1,12 @@ --- -html: intro-to-consensus.html -parent: introduction.html +html: consensus.html +parent: concepts.html blurb: XRP Ledgerのコンセンサスメカニズムについて基本的な理解を深めましょう。 labels: - ブロックチェーン top_nav_grouping: 人気ページ --- -# コンセンサスについて +# コンセンサスプロトコル _コンセンサス_ は、分散型決済システムの最も重要な特性です。従来の中央集権型決済システムでは、権限のある1人の管理者が決済の方法とタイミングについて最終的な決定権を持ちます。分散型システムでは、その名が示すとおり、そのような管理者は存在しません。その代わりに、XRP Ledgerのような分散型システムでは、参加者は定められた一連のルールに従うことになっているため、同じ一連のイベントとその結果についていつでも合意することができます。この一連のルールは、 _コンセンサスプロトコル_ と呼ばれます。 @@ -58,15 +58,6 @@ XRP Ledgerのコンセンサスメカニズムは、小さな信頼が大きな XRP Ledger コンセンサスプロトコルで、さまざまな課題や攻撃、失敗の事例にどのように対応するかについての詳細な説明については、[攻撃と失敗モードに対するコンセンサスの保護](consensus-protections.html)を参照してください。 - -## 関連項目 - -- XRP Ledger コンセンサスプロトコルの仕組みの詳細に関する記事は、[コンセンサスネットワークの概念](consensus-network.html)を参照してください。 -- 独自のバリデータを実行する手順については、[バリデータとしての`rippled`の実行](run-rippled-as-a-validator.html)を参照してください。 -- XRP Ledgerの分散化に関するRippleの目標および計画については、[分散化戦略についてのアップデート (Ripple Dev Blog)](https://ripple.com/dev-blog/decentralization-strategy-update/)を参照してください。 - - - ---- ## 脚注 diff --git a/content/concepts/introduction/intro-to-consensus.md b/content/concepts/consensus-protocol/consensus.md similarity index 84% rename from content/concepts/introduction/intro-to-consensus.md rename to content/concepts/consensus-protocol/consensus.md index 78c580c8e6..4379dd4cb9 100644 --- a/content/concepts/introduction/intro-to-consensus.md +++ b/content/concepts/consensus-protocol/consensus.md @@ -1,14 +1,16 @@ --- -html: intro-to-consensus.html -parent: introduction.html -blurb: Develop a basic understanding of the XRP Ledger's consensus mechanism. +html: consensus.html +parent: concepts.html +blurb: Consensus is how new blocks of transactions get confirmed by the XRP Ledger blockchain. labels: - Blockchain top_nav_grouping: Popular Pages --- -# Introduction to Consensus +# Consensus Protocol -_Consensus_ is the most important property of any decentralized payment system. In traditional centralized payment systems, one authoritative administrator gets the final say in how and when payments occur. Decentralized systems, by definition, don't have an administrator to do that. Instead, decentralized systems like the XRP Ledger define a set of rules all participants follow, so every participant can agree on the exact same series of events and their outcome at any point in time. We call this set of rules a _consensus protocol_. +This topic explains how the decentralized XRP Ledger confirms new transactions and ledger versions, forming a blockchain. + +Consensus is the most important property of any decentralized payment system. In traditional centralized payment systems, one authoritative administrator gets the final say in how and when payments occur. Decentralized systems, by definition, don't have an administrator to do that. Instead, decentralized systems like the XRP Ledger define a set of rules all participants follow, so every participant can agree on the exact same series of events and their outcome at any point in time. We call this set of rules a _consensus protocol_. ## Consensus Protocol Properties @@ -58,14 +60,6 @@ It's OK if a small proportion of validators don't work properly all the time. As For a longer exploration of how the XRP Ledger Consensus Protocol responds to various challenges, attacks, and failure cases, see [Consensus Protections Against Attacks and Failure Modes](consensus-protections.html). -## See Also - -- [Consensus Network Concepts](consensus-network.html) for several articles describing the mechanics of the XRP Ledger Consensus Protocol in greater depth. -- [Run `rippled` as a Validator](run-rippled-as-a-validator.html) for instructions on running your own validator. -- [Decentralization Strategy Update (Ripple Dev Blog)](https://xrpl.org/blog/2017/decent-strategy-update.html) for a description of Ripple's goals and plans for decentralizing the XRP Ledger. - - - ---- ## Footnotes diff --git a/content/concepts/consensus-network/fee-voting.ja.md b/content/concepts/consensus-protocol/fee-voting.ja.md similarity index 99% rename from content/concepts/consensus-network/fee-voting.ja.md rename to content/concepts/consensus-protocol/fee-voting.ja.md index 6561f41ecf..11da6a3c8e 100644 --- a/content/concepts/consensus-network/fee-voting.ja.md +++ b/content/concepts/consensus-protocol/fee-voting.ja.md @@ -1,6 +1,6 @@ --- html: fee-voting.html -parent: consensus-network.html +parent: consensus.html blurb: トランザクションコストと必要準備金の変更投票について。 labels: - 手数料 diff --git a/content/concepts/consensus-network/fee-voting.md b/content/concepts/consensus-protocol/fee-voting.md similarity index 99% rename from content/concepts/consensus-network/fee-voting.md rename to content/concepts/consensus-protocol/fee-voting.md index 213f355169..7c1bdfc271 100644 --- a/content/concepts/consensus-network/fee-voting.md +++ b/content/concepts/consensus-protocol/fee-voting.md @@ -1,6 +1,6 @@ --- html: fee-voting.html -parent: consensus-network.html +parent: consensus.html blurb: How validators vote on fees (transaction cost and reserve requirements). labels: - Fees diff --git a/content/concepts/consensus-network/invariant-checking.ja.md b/content/concepts/consensus-protocol/invariant-checking.ja.md similarity index 99% rename from content/concepts/consensus-network/invariant-checking.ja.md rename to content/concepts/consensus-protocol/invariant-checking.ja.md index 73edfe6b1e..9d2a2979d9 100644 --- a/content/concepts/consensus-network/invariant-checking.ja.md +++ b/content/concepts/consensus-protocol/invariant-checking.ja.md @@ -1,6 +1,6 @@ --- html: invariant-checking.html -parent: consensus-network.html +parent: consensus.html blurb: 不変性チェックとは何か、なぜ存在するのか、どのように機能するのか、どのような不変性チェックが有効なのかを理解することができます。 labels: - ブロックチェーン @@ -146,7 +146,6 @@ XRP Ledgerは、各トランザクションについて、以下のすべての - **その他:** - [Authorized Trust Lines](authorized-trust-lines.html) - - [XRPの特性](xrp.html#xrpの特性) - [トランザクションの残高変化の計算](https://xrpl.org/blog/2015/calculating-balance-changes-for-a-transaction.html#calculating-balance-changes-for-a-transaction) diff --git a/content/concepts/consensus-network/invariant-checking.md b/content/concepts/consensus-protocol/invariant-checking.md similarity index 99% rename from content/concepts/consensus-network/invariant-checking.md rename to content/concepts/consensus-protocol/invariant-checking.md index 26b732b176..47aa449351 100644 --- a/content/concepts/consensus-network/invariant-checking.md +++ b/content/concepts/consensus-protocol/invariant-checking.md @@ -1,6 +1,6 @@ --- html: invariant-checking.html -parent: consensus-network.html +parent: consensus.html blurb: Understand what invariant checking is, why it exists, how it works, and what invariant checks are active. labels: - Blockchain @@ -166,7 +166,6 @@ The XRP Ledger checks all the following invariants on each transaction: - **Other:** - [Authorized Trust Lines](authorized-trust-lines.html) - - [XRP Properties](xrp.html#xrp-properties) - [Calculating Balance Changes for a Transaction](https://xrpl.org/blog/2015/calculating-balance-changes-for-a-transaction.html#calculating-balance-changes-for-a-transaction) diff --git a/content/concepts/consensus-network/negative-unl.ja.md b/content/concepts/consensus-protocol/negative-unl.ja.md similarity index 95% rename from content/concepts/consensus-network/negative-unl.ja.md rename to content/concepts/consensus-protocol/negative-unl.ja.md index dcc8ca8479..a3b81f72c5 100644 --- a/content/concepts/consensus-network/negative-unl.ja.md +++ b/content/concepts/consensus-protocol/negative-unl.ja.md @@ -1,6 +1,6 @@ --- html: negative-unl.html -parent: consensus-network.html +parent: consensus.html blurb: ネガティブUNLが部分的な停止時に台帳の耐障害性を向上させることを理解する。 labels: - ブロックチェーン @@ -72,7 +72,7 @@ Vaは、サーバー側のコンセンサス見解と一致した過 1. 前のフラグレジャーで予定されていたネガティブUNLの変更は、次のレジャーバージョンから有効となる。このフラグレジャーの検証のための合意プロセスそのものは、予定されていた変更を利用しない。 - **注記:** これは、[トランザクション](transaction-basics.html)や[疑似トランザクション](pseudo-transaction-types.html)を行わずにレジャーの状態データを変更する唯一の機会です。 + **注記:** これは、[トランザクション](transactions.html)や[疑似トランザクション](pseudo-transaction-types.html)を行わずにレジャーの状態データを変更する唯一の機会です。 2. ネガティブUNLが満杯でない場合、各サーバーは信頼度50%未満のバリデータの中から、**最大1つ**のバリデータをネガティブUNLに追加することを提案する。 3. ネガティブUNLが空でない場合、各サーバーはネガティブUNLから**最大1つ**のバリデータを削除することを提案する。サーバーがバリデータをネガティブUNLから削除することを提案できる理由は2つある。 @@ -110,7 +110,7 @@ Vaは、サーバー側のコンセンサス見解と一致した過 ### 検証のフィルタリング -[コンセンサスプロセスの検証ステップ](consensus.html#検証)では、親レジャーのネガティブUNLのバリデータを無効化します。各サーバーは無効化されたバリデータを取り除いた設定済みUNLからなる"有効UNL"を計算し、定足数を再計算します。(定足数は常に有効UNLの80%以上、かつ設定UNLの60%以上です)。無効化されたバリデータが検証票を送信した場合、サーバーは無効化されたバリデータの信頼性を計算するためにその票を追跡するが、あるバージョンのレジャーが合意に達したかどうかを判断するためにその票を使うことはありません。 +[コンセンサスプロセスの検証ステップ](consensus-structure.html#検証)では、親レジャーのネガティブUNLのバリデータを無効化します。各サーバーは無効化されたバリデータを取り除いた設定済みUNLからなる"有効UNL"を計算し、定足数を再計算します。(定足数は常に有効UNLの80%以上、かつ設定UNLの60%以上です)。無効化されたバリデータが検証票を送信した場合、サーバーは無効化されたバリデータの信頼性を計算するためにその票を追跡するが、あるバージョンのレジャーが合意に達したかどうかを判断するためにその票を使うことはありません。 **注記:** ネガティブUNLは、定足数を直接計算するのではなく、定足数の計算元となる信頼できるバリデータの合計を調整するものです。定足数はパーセンテージですが、投票数は整数であるため、信頼できるバリデータの合計を減らしても、定足数に達するために必要な投票数が変わるとは限りません。たとえば、総バリデータが15人である場合、80%はちょうど12人のバリデータである。これを14人に減らすと、80%は11.2人となり、定足数に達するには依然として12人の有効投票者が必要である。 diff --git a/content/concepts/consensus-network/negative-unl.md b/content/concepts/consensus-protocol/negative-unl.md similarity index 95% rename from content/concepts/consensus-network/negative-unl.md rename to content/concepts/consensus-protocol/negative-unl.md index 5fd532c698..a0b9c6282c 100644 --- a/content/concepts/consensus-network/negative-unl.md +++ b/content/concepts/consensus-protocol/negative-unl.md @@ -1,6 +1,6 @@ --- html: negative-unl.html -parent: consensus-network.html +parent: consensus.html blurb: Understand how Negative UNL improves the ledger's resilience during partial outages. labels: - Blockchain @@ -73,7 +73,7 @@ Each flag ledger, all of the following changes apply: 1. Changes to the Negative UNL that were scheduled in the previous flag ledger go into effect for the following ledger version. The consensus process for validating this flag ledger itself does not use the scheduled change. - **Note:** This is one of the only times a ledger's state data is modified without a [transaction](transaction-basics.html) or [pseudo-transaction](pseudo-transaction-types.html). + **Note:** This is one of the only times a ledger's state data is modified without a [transaction](transactions.html) or [pseudo-transaction](pseudo-transaction-types.html). 2. If the Negative UNL is not full, each server proposes adding **up to 1** validator to the Negative UNL from among its trusted validators with less than 50% reliability. 3. If the Negative UNL is not empty, each server proposes removing **up to 1** validator from the Negative UNL. A server can propose removing a validator from the Negative UNL for two reasons: @@ -111,7 +111,7 @@ This mechanism has several useful properties: ### Filtering Validations -During [the validation step of the consensus process](consensus.html#validation), validators in the parent ledger's Negative UNL are disabled. Each server calculates an "effective UNL" consisting of its configured UNL with the disabled validators removed, and recalculates its quorum. (The quorum is always at least 80% of the effective UNL and at least 60% of the configured UNL.) If a disabled validator sends validation votes, servers track those votes for purposes of calculating the disabled validator's reliability measurement, but they do not use those votes towards determining whether a ledger version has achieved a consensus. +During [the validation step of the consensus process](consensus-structure.html#validation), validators in the parent ledger's Negative UNL are disabled. Each server calculates an "effective UNL" consisting of its configured UNL with the disabled validators removed, and recalculates its quorum. (The quorum is always at least 80% of the effective UNL and at least 60% of the configured UNL.) If a disabled validator sends validation votes, servers track those votes for purposes of calculating the disabled validator's reliability measurement, but they do not use those votes towards determining whether a ledger version has achieved a consensus. **Note:** The Negative UNL adjusts the _total_ trusted validators that the quorum is calculated from, not the quorum directly. The quorum is a percentage but the number of votes is a whole number, so reducing the total trusted validators does not always change the number of votes required to reach a quorum. For example, if there are 15 total validators, 80% is 12 validators exactly. If you reduce the total to 14 validators, 80% is 11.2 validators, which means that it still requires 12 validators to reach a quorum. diff --git a/content/concepts/decentralized-exchange/autobridging.md b/content/concepts/decentralized-exchange/autobridging.md deleted file mode 100644 index 519c72f2fa..0000000000 --- a/content/concepts/decentralized-exchange/autobridging.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -html: autobridging.html -parent: decentralized-exchange.html -blurb: Autobriding automatically connects order books using XRP as an intermediary when it reduces costs. -labels: - - XRP - - Decentralized Exchange ---- -# Auto-Bridging - -Any [Offer](offers.html) in the XRP Ledger's [decentralized exchange](decentralized-exchange.html) that would exchange two non-XRP currencies could potentially use [XRP](xrp.html) as an intermediary currency in a synthetic order book. This is because of _auto-bridging_, which serves to improve liquidity across all currency pairs by using XRP when doing so is cheaper than trading those currencies directly. This works because of XRP's nature as a native cryptocurrency to the XRP Ledger. Offer execution can use a combination of direct and auto-bridged offers to achieve the best total exchange rate. - -Example: _Anita places an offer to sell GBP and buy BRL. She might find that this uncommon currency market has few offers. There is one offer with a good rate, but it has insufficient quantity to satisfy Anita's trade. However, both GBP and BRL have active, competitive markets to XRP. The XRP Ledger's auto-bridging system finds a way to complete Anita's offer by purchasing XRP with GBP from one trader, then selling the XRP to another trader to buy BRL. Anita automatically gets the best rate possible by combining the small offer in the direct GBP:BRL market with the better composite rates created by pairing GBP:XRP and XRP:BRL offers._ - -Auto-bridging happens automatically on any [OfferCreate transaction][]. [Payment transactions](payment.html) _do not_ use auto-bridging by default, but path-finding can find [paths](paths.html) that have the same effect. - -## See Also - -- [Dev Blog: Introducing Autobridging](https://xrpl.org/blog/2014/introducing-offer-autobridging.html) - -- [Offer Preference](offers.html#offer-preference) - -- [Payment Paths](paths.html) - - - -{% include '_snippets/rippled-api-links.md' %} -{% include '_snippets/tx-type-links.md' %} -{% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/introduction/crypto-wallets.md b/content/concepts/introduction/crypto-wallets.md new file mode 100644 index 0000000000..6d0f608f68 --- /dev/null +++ b/content/concepts/introduction/crypto-wallets.md @@ -0,0 +1,48 @@ +--- +html: crypto-wallets.html +parent: intro-to-xrpl.html +blurb: Wallets provide a convenient way of managing your XRP on the XRP Ledger. +labels: + - Blockchain +--- +# Crypto Wallets + +Crypto wallets provide a way to manage your account and funds on the XRP Ledger. There are many wallets to choose from. Choosing the right wallet ultimately comes down to your needs and comfort working with XRP. + + +## Custodial vs Non-custodial Wallets + +A major factor when choosing a wallet is if you want a custodial or non-custodial wallet. + +A custodial wallet means a third party holds your funds, typically on an account they manage on the XRP Ledger. A custodial wallet can be thought of like a bank, where you're trusting another entity to keep your money secure. Many centralized exchanges offer custodial wallets, so when you create an account with them and use their app, you don't technically have an account on the ledger. + +For day-to-day payments, this may be preferable, since these types of wallets are user-friendly: if you forget your password, you can typically have it reset. Also, if you don't have an individual XRP Ledger account, the ledger's reserve requirement doesn't apply to you. The custodian acts a buffer to any issues you run into on the XRP Ledger, and may offer support or assistance if you're not sure how to do something. + + + +A non-custodial wallet, such as [XUMM](https://xumm.app/), is one where you have the secret keys to your account. This means you're ultimately responsible for managing the security of your account. + +**Caution:** If you lose your keys, you are locked out of your XRP Ledger account and there are no recovery options. + +Non-custodial wallets allow more freedom. Since you're interacting directly with the XRP Ledger yourself, you can handle any type of transaction you want without anyone restricting your options. If the ledger allows it, you can do it. Non-custodial wallets also don't require you to trust an institution with your money, which can insulate you from market factors outside your control. + +Users of both custodial and non-custodial wallets have to protect themselves from malicious users who might try to steal their funds. With a custodial wallet, you have to manage your login and password to the app or site; with a non-custodial wallet, you have to manage your secret keys to your on-ledger account. In both cases, the wallet provider's own security practices are also important to protect you from vulnerabilities like supply-chain attacks, where an attacker loads malicious code into the wallet through software updates or dependencies. However, custodial wallets can be a bigger target for attackers since they have immediate access to multiple customers' funds. + + +## Hardware vs Software Wallets + +Another deciding factor when choosing a wallet is picking between a hardware or software wallet. + +Hardware wallets are physical devices that store your private/secret keys. The main benefit of using hardware wallets is that you can secure your information by disconnecting it from the internet when it's not in use; hardware wallets totally isolate your keys from easier-to-hack computers or smartphones. + + + +Software wallets on the other hand, are entirely digital. While this makes them easier to use, it also makes them the less secure method of the two, but they usually come with additional features to enhance your experience. Ultimately, the decision between the two will come down to your comfort level and how important ease-of-use is to you. + + +## Creating Your Own Wallet + +The XRP Ledger is an opensource project with publicly available client libraries and API methods. While you can technically interact with the ledger using HTTP/WebSocket tools, it isn't practical for day-to-day use. You can create your own wallet to interact with the ledger, but you'll need to understand exactly how accounts, transactions, and the ledger work together before committing to this option. + + +Next: [Transactions and Requests](txn-and-requests.html) diff --git a/content/concepts/introduction/software-ecosystem.ja.md b/content/concepts/introduction/software-ecosystem.ja.md index fc6b1b9b66..b33f782319 100644 --- a/content/concepts/introduction/software-ecosystem.ja.md +++ b/content/concepts/introduction/software-ecosystem.ja.md @@ -11,7 +11,7 @@ XRP Ledgerは、「価値のインターネット」を推進および実現可 [](img/ecosystem.ja.png) -- [XRP Ledgerの基盤](#rippled-コアサーバー)は、トランザクションを共有し、[コンセンサスプロセス](consensus.html)に関与し、[トランザクション](transaction-basics.html)を処理する常時接続のサーバーのピアツーピアネットワークです。XRP Ledgerエコシステム内の他のすべてのものが、最終的にこのピアツーピアネットワーク上に直接、または間接的に構築されます。 +- [XRP Ledgerの基盤](#rippled-コアサーバー)は、トランザクションを共有し、[コンセンサスプロセス](consensus.html)に関与し、[トランザクション](transactions.html)を処理する常時接続のサーバーのピアツーピアネットワークです。XRP Ledgerエコシステム内の他のすべてのものが、最終的にこのピアツーピアネットワーク上に直接、または間接的に構築されます。 - [_プログラミングライブラリー_](#プログラミングライブラリー)は、さらに上位のソフトウェアに存在し、プログラムコードに直接インポートされます。また、XRP Ledgerにアクセスするためのルーチンの実装があらかじめ作成され、組み込まれています。 @@ -47,7 +47,7 @@ XRP Ledger上のミドルウェアサービスの例として、[Data API](data- ### アプリとサービス -最上層は、最もエキサイティングなことが起こる場所です。アプリとサービスは、XRP Ledgerに接続するための手段をユーザーとデバイスに提供します。この層では、[取引所がXRPを上場](list-xrp-as-an-exchange.html)したり、分散型取引所で使用するために[ゲートウェイが他の通貨を発行](become-an-xrp-ledger-gateway.html)したり、あるいはXRPを購入、売却、または単に