ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

changed file names, reverted to hot/warm/cold wallet terminology

Browse Source
This commit is contained in:
Ryan Young
2017-06-09 10:42:28 -07:00
parent aa0654bb01
commit 6bef8d6cc5
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/tutorial-listing-xrp.md
View File

@@ -22,7 +22,7 @@ Alpha Exchange wants to list BTC/XRP and XRP/USD trading pairs partially because
* Withdraw XRP _from_ Alpha Exchange _to_ the RCL * Withdraw XRP _from_ Alpha Exchange _to_ the RCL
* Trade XRP with other currencies, such as BTC, USD, amongst others * Trade XRP with other currencies, such as BTC, USD, among others
## Prerequisites for Supporting XRP ## Prerequisites for Supporting XRP
@@ -46,17 +46,17 @@ See also:
XRP is held in _accounts_ (also referred to as _wallets_ or _addresses_ ) on the Ripple Consensus Ledger (RCL). Accounts on the RCL are different than accounts on other blockchain ledgers, such as Bitcoin, where accounts incur little to no overhead. To submit transactions (for example, [OfferCreate](https://ripple.com/build/transactions/#offercreate) and others used for trading), RCL accounts require XRP [reserves](https://ripple.com/build/reserves/) to protect the ledger against spam and malicious usage. On other blockchains, balances are derived from the previous block. On the RCL, [account objects](https://ripple.com/build/ledger-format/#accountroot) describe several other properties of the account in addition to balances, so accounts are represented in each ledger and can never be destroyed or removed. Exchanges do not need to create accounts for each customer that holds XRP; they can store all of their customers’ XRP in just a few RCL accounts. For more information about RCL accounts, see the [Accounts](https://ripple.com/build/accounts/) article. XRP is held in _accounts_ (also referred to as _wallets_ or _addresses_ ) on the Ripple Consensus Ledger (RCL). Accounts on the RCL are different than accounts on other blockchain ledgers, such as Bitcoin, where accounts incur little to no overhead. To submit transactions (for example, [OfferCreate](https://ripple.com/build/transactions/#offercreate) and others used for trading), RCL accounts require XRP [reserves](https://ripple.com/build/reserves/) to protect the ledger against spam and malicious usage. On other blockchains, balances are derived from the previous block. On the RCL, [account objects](https://ripple.com/build/ledger-format/#accountroot) describe several other properties of the account in addition to balances, so accounts are represented in each ledger and can never be destroyed or removed. Exchanges do not need to create accounts for each customer that holds XRP; they can store all of their customers’ XRP in just a few RCL accounts. For more information about RCL accounts, see the [Accounts](https://ripple.com/build/accounts/) article.
To comply with Ripple's recommend best practices, Alpha Exchange should create at least two new [accounts](https://ripple.com/build/accounts/) on the RCL. To minimize the risks associated with a compromised secret key, Ripple recommends creating [_cold_, _hot_, and _warm_ accounts](https://ripple.com/build/issuing-operational-addresses/) (these are sometimes referred to, respectively, as cold, hot, and warm wallets). The hot/warm/cold model is intended to balance security and convenience. Exchanges listing XRP should create the following accounts: To comply with Ripple's recommended best practices, Alpha Exchange should create at least two new [accounts](https://ripple.com/build/accounts/) on the RCL. To minimize the risks associated with a compromised secret key, Ripple recommends creating [_cold_, _hot_, and _warm_ accounts](https://ripple.com/build/issuing-operational-addresses/) (these are sometimes referred to, respectively, as cold, hot, and warm wallets). The hot/warm/cold model is intended to balance security and convenience. Exchanges listing XRP should create the following accounts:
* A [_cold wallet_](https://ripple.com/build/issuing-operational-addresses/#issuing-address) to securely hold the majority of XRP and customers' funds. To provide optimal security, this account should be offline. * A [_cold wallet_](https://ripple.com/build/issuing-operational-addresses/#issuing-address) to securely hold the majority of XRP and customers' funds. To provide optimal security, this account should be offline.
For more information about the possible consequences of a compromised cold wallet, see [Issuing Account Compromise](https://ripple.com/build/issuing-operational-addresses/#issuing-address-compromise). For more information about the possible consequences of a compromised cold wallet, see [Issuing Account Compromise](https://ripple.com/build/issuing-operational-addresses/#issuing-address-compromise).
* One or more [_hot wallets_](https://ripple.com/build/issuing-operational-addresses/#operational-addresses) to conduct the day-to-day business of managing customers' XRP withdrawals and deposits. For example, with an opertaitional wallet, exchanges can securely support these types of automated XRP transfers. Hot wallets need to be online to service instant withdrawal requests. * One or more [_hot wallets_](https://ripple.com/build/issuing-operational-addresses/#operational-addresses) to conduct the day-to-day business of managing customers' XRP withdrawals and deposits. For example, with a hot wallet, exchanges can securely support these types of automated XRP transfers. Hot wallets need to be online to service instant withdrawal requests.
For more information about the possible consequences of a compromised hot wallet, see [Operational Account Compromise](https://ripple.com/build/issuing-operational-addresses/#operational-address-compromise). For more information about the possible consequences of a compromised hot wallet, see [Operational Account Compromise](https://ripple.com/build/issuing-operational-addresses/#operational-address-compromise).
* Optionally, one or more warm wallets to provide an additional layer of security between the cold and hot wallets. Unlike a hot wallet, the secret key of a warm wallet does not need to be online. Additionally, you can distribute the secret keys for the warm wallet to several different people and implement [multisigning](https://ripple.com/build/how-to-multi-sign/) to increase security. * Optionally, one or more warm wallets to provide an additional layer of security between the cold and hot wallets. Unlike a hot wallet, the secret key of a warm wallet does not need to be online. Additionally, you can distribute the secret keys for the warm wallet to several different people and implement [multisigning](https://ripple.com/build/how-to-multi-sign/) to increase security.
For more information about the possible consequences of a compromised warm wallet, see [Standby Account Compromise](https://ripple.com/build/issuing-operational-addresses/#standby-address-compromise). For more information about the possible consequences of a compromised warm wallet, see [Standby Account Compromise](https://ripple.com/build/issuing-operational-addresses/#standby-address-compromise).
@@ -159,7 +159,7 @@ XRP Balances</i></b></td>
#### XRP Amounts #### XRP Amounts
Amounts of XRP are represented on the RCL as an unsigned integer count of *drops*, where one XRP == 1,000,000 drops. Ripple recommends that software store XRP balances as integer amounts of drops, and perform integer arithmetic on these values. However, user interfaces should present balances in units of XRP. Amounts of XRP are represented on the RCL as an unsigned integer count of *drops*, where one XRP = 1,000,000 drops. Ripple recommends that software store XRP balances as integer amounts of drops, and perform integer arithmetic on these values. However, user interfaces should present balances in units of XRP.
One drop (.000001 XRP) cannot be further subdivided. Bear this in mind when calculating and displaying FX rates between XRP and other assets. One drop (.000001 XRP) cannot be further subdivided. Bear this in mind when calculating and displaying FX rates between XRP and other assets.
@@ -276,7 +276,7 @@ XRP Balances</i></b></td>
### Deposit XRP into Exchange ### Deposit XRP into Exchange
To track [off-ledger XRP balances](#on-ledger-and-off-ledger) exchanges need to create new [balance sheets](#balance-sheets) (or similar accounting systems). The following table illustrates the balance changes that take place on Alpha Exchange's new balance sheet as users begin to deposit XRP. To track [off-ledger XRP balances](#on-ledger-and-off-ledger), exchanges need to create new [balance sheets](#balance-sheets) (or similar accounting systems). The following table illustrates the balance changes that take place on Alpha Exchange's new balance sheet as users begin to deposit XRP.
A user named Charlie wants to deposit 50,000 XRP to Alpha Exchange. Doing this involves the following steps: A user named Charlie wants to deposit 50,000 XRP to Alpha Exchange. Doing this involves the following steps:
@@ -390,7 +390,7 @@ For more information about trading _on_ the RCL, see [Lifecycle of an Offer](htt
Exchanges can adjust the balances between their hot and cold wallets at any time. Each balance adjustment consumes a [transaction fee](https://ripple.com/build/fees-disambiguation/), but does not otherwise affect the aggregate balance of all the accounts. The aggregate, on-ledger balance should always exceed the total balance available for trade on the exchange. (The excess should be sufficient to cover the RCL's [transaction fees](https://ripple.com/build/transaction-cost/).) Exchanges can adjust the balances between their hot and cold wallets at any time. Each balance adjustment consumes a [transaction fee](https://ripple.com/build/fees-disambiguation/), but does not otherwise affect the aggregate balance of all the accounts. The aggregate, on-ledger balance should always exceed the total balance available for trade on the exchange. (The excess should be sufficient to cover the RCL's [transaction fees](https://ripple.com/build/transaction-cost/).)
The following table demonstrates a balance adjustment of 80,000 XRP (via a [_payment_](https://ripple.com/build/transactions/#payment) on the RCL) between Alpha Exchange's cold wallet and its hot wallet, where the cold wallet was debited and the hot wallet was credited. If the payment were reversed (debit the hot wallet and credit the cold wallet), the hot wallet balance would decrease. Balance adjustments like these allow an exchange to limit the risks associated with holding XRP in online hot wallets. The following table demonstrates a balance adjustment of 80,000 XRP (via a [_payment_](https://ripple.com/build/transactions/#payment) on the RCL) between Alpha Exchange's cold wallet and its hot wallet, where the cold wallet was debited and the hot wallet was credited. If the payment were reversed (debiting the hot wallet and crediting the cold wallet), the hot wallet balance would decrease. Balance adjustments like these allow an exchange to limit the risks associated with holding XRP in online hot wallets.
<table> <table>

4
tool/dactyl-config.yml
View File

@@ -206,8 +206,8 @@ pages:
# Listing XRP as an Exchange # Listing XRP as an Exchange
- category: Tutorials - category: Tutorials
html: xrp-listing-guide.html html: tutorial-listing-xrp.html
md: exchange-guide.md md: tutorial-listing-xrp.md
targets: targets:
- local - local
- ripple.com - ripple.com

14
tutorial-listing-xrp.html
View File

@@ -186,7 +186,7 @@
<p>Withdraw XRP <em>from</em> Alpha Exchange <em>to</em> the RCL</p> <p>Withdraw XRP <em>from</em> Alpha Exchange <em>to</em> the RCL</p>
</li> </li>
<li> <li>
<p>Trade XRP with other currencies, such as BTC, USD, amongst others</p> <p>Trade XRP with other currencies, such as BTC, USD, among others</p>
</li> </li>
</ul> </ul>
<h2 id="prerequisites-for-supporting-xrp">Prerequisites for Supporting XRP</h2> <h2 id="prerequisites-for-supporting-xrp">Prerequisites for Supporting XRP</h2>
@@ -216,18 +216,18 @@
</ul> </ul>
<h3 id="accounts">Accounts</h3> <h3 id="accounts">Accounts</h3>
<p>XRP is held in <em>accounts</em> (also referred to as <em>wallets</em> or <em>addresses</em> ) on the Ripple Consensus Ledger (RCL). Accounts on the RCL are different than accounts on other blockchain ledgers, such as Bitcoin, where accounts incur little to no overhead. To submit transactions (for example, <a href="https://ripple.com/build/transactions/#offercreate">OfferCreate</a> and others used for trading), RCL accounts require XRP <a href="https://ripple.com/build/reserves/">reserves</a> to protect the ledger against spam and malicious usage. On other blockchains, balances are derived from the previous block. On the RCL, <a href="https://ripple.com/build/ledger-format/#accountroot">account objects</a> describe several other properties of the account in addition to balances, so accounts are represented in each ledger and can never be destroyed or removed. Exchanges do not need to create accounts for each customer that holds XRP; they can store all of their customers’ XRP in just a few RCL accounts. For more information about RCL accounts, see the <a href="https://ripple.com/build/accounts/">Accounts</a> article.</p> <p>XRP is held in <em>accounts</em> (also referred to as <em>wallets</em> or <em>addresses</em> ) on the Ripple Consensus Ledger (RCL). Accounts on the RCL are different than accounts on other blockchain ledgers, such as Bitcoin, where accounts incur little to no overhead. To submit transactions (for example, <a href="https://ripple.com/build/transactions/#offercreate">OfferCreate</a> and others used for trading), RCL accounts require XRP <a href="https://ripple.com/build/reserves/">reserves</a> to protect the ledger against spam and malicious usage. On other blockchains, balances are derived from the previous block. On the RCL, <a href="https://ripple.com/build/ledger-format/#accountroot">account objects</a> describe several other properties of the account in addition to balances, so accounts are represented in each ledger and can never be destroyed or removed. Exchanges do not need to create accounts for each customer that holds XRP; they can store all of their customers’ XRP in just a few RCL accounts. For more information about RCL accounts, see the <a href="https://ripple.com/build/accounts/">Accounts</a> article.</p>
<p>To comply with Ripple's recommend best practices, Alpha Exchange should create at least two new <a href="https://ripple.com/build/accounts/">accounts</a> on the RCL. To minimize the risks associated with a compromised secret key, Ripple recommends creating <a href="https://ripple.com/build/issuing-operational-addresses/"><em>cold</em>, <em>hot</em>, and <em>warm</em> accounts</a> (these are sometimes referred to, respectively, as cold, hot, and warm wallets). The hot/warm/cold model is intended to balance security and convenience. Exchanges listing XRP should create the following accounts:</p> <p>To comply with Ripple's recommended best practices, Alpha Exchange should create at least two new <a href="https://ripple.com/build/accounts/">accounts</a> on the RCL. To minimize the risks associated with a compromised secret key, Ripple recommends creating <a href="https://ripple.com/build/issuing-operational-addresses/"><em>cold</em>, <em>hot</em>, and <em>warm</em> accounts</a> (these are sometimes referred to, respectively, as cold, hot, and warm wallets). The hot/warm/cold model is intended to balance security and convenience. Exchanges listing XRP should create the following accounts:</p>
<ul> <ul>
<li> <li>
<p>A <a href="https://ripple.com/build/issuing-operational-addresses/#issuing-address"><em>cold wallet</em></a> to securely hold the majority of XRP and customers' funds. To provide optimal security, this account should be offline.</p> <p>A <a href="https://ripple.com/build/issuing-operational-addresses/#issuing-address"><em>cold wallet</em></a> to securely hold the majority of XRP and customers' funds. To provide optimal security, this account should be offline.</p>
<p>For more information about the possible consequences of a compromised cold wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#issuing-address-compromise">Issuing Account Compromise</a>.</p> <p>For more information about the possible consequences of a compromised cold wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#issuing-address-compromise">Issuing Account Compromise</a>.</p>
</li> </li>
<li> <li>
<p>One or more <a href="https://ripple.com/build/issuing-operational-addresses/#operational-addresses"><em>hot wallets</em></a> to conduct the day-to-day business of managing customers' XRP withdrawals and deposits. For example, with an opertaitional wallet, exchanges can securely support these types of automated XRP transfers. Hot wallets need to be online to service instant withdrawal requests.</p> <p>One or more <a href="https://ripple.com/build/issuing-operational-addresses/#operational-addresses"><em>hot wallets</em></a> to conduct the day-to-day business of managing customers' XRP withdrawals and deposits. For example, with a hot wallet, exchanges can securely support these types of automated XRP transfers. Hot wallets need to be online to service instant withdrawal requests.</p>
<p>For more information about the possible consequences of a compromised hot wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#operational-address-compromise">Operational Account Compromise</a>.</p> <p>For more information about the possible consequences of a compromised hot wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#operational-address-compromise">Operational Account Compromise</a>.</p>
</li> </li>
<li> <li>
<p>Optionally, one or more warm wallets to provide an additional layer of security between the cold and hot wallets. Unlike a hot wallet, the secret key of a warm wallet does not need to be online. Additionally, you can distribute the secret keys for the warm wallet to several different people and implement <a href="https://ripple.com/build/how-to-multi-sign/">multisigning</a> to increase security.</p> <p>Optionally, one or more warm wallets to provide an additional layer of security between the cold and hot wallets. Unlike a hot wallet, the secret key of a warm wallet does not need to be online. Additionally, you can distribute the secret keys for the warm wallet to several different people and implement <a href="https://ripple.com/build/how-to-multi-sign/">multisigning</a> to increase security.</p>
<p>For more information about the possible consequences of a compromised warm wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#standby-address-compromise">Standby Account Compromise</a>.</p> <p>For more information about the possible consequences of a compromised warm wallet, see <a href="https://ripple.com/build/issuing-operational-addresses/#standby-address-compromise">Standby Account Compromise</a>.</p>
</li> </li>
</ul> </ul>
@@ -327,7 +327,7 @@ XRP Balances</i></b></td>
</tr> </tr>
</table> </table>
<h4 id="xrp-amounts">XRP Amounts</h4> <h4 id="xrp-amounts">XRP Amounts</h4>
<p>Amounts of XRP are represented on the RCL as an unsigned integer count of <em>drops</em>, where one XRP == 1,000,000 drops. Ripple recommends that software store XRP balances as integer amounts of drops, and perform integer arithmetic on these values. However, user interfaces should present balances in units of XRP.</p> <p>Amounts of XRP are represented on the RCL as an unsigned integer count of <em>drops</em>, where one XRP = 1,000,000 drops. Ripple recommends that software store XRP balances as integer amounts of drops, and perform integer arithmetic on these values. However, user interfaces should present balances in units of XRP.</p>
<p>One drop (.000001 XRP) cannot be further subdivided. Bear this in mind when calculating and displaying FX rates between XRP and other assets.</p> <p>One drop (.000001 XRP) cannot be further subdivided. Bear this in mind when calculating and displaying FX rates between XRP and other assets.</p>
<p>For more informtion, see <a href="https://ripple.com/build/rippled-apis/#specifying-currency-amounts">Specifying Currency Amounts</a>.</p> <p>For more informtion, see <a href="https://ripple.com/build/rippled-apis/#specifying-currency-amounts">Specifying Currency Amounts</a>.</p>
<h4 id="on-ledger-and-off-ledger">On-Ledger and Off-Ledger</h4> <h4 id="on-ledger-and-off-ledger">On-Ledger and Off-Ledger</h4>
@@ -437,7 +437,7 @@ XRP Balances</i></b></td>
</tr> </tr>
</table> </table>
<h3 id="deposit-xrp-into-exchange">Deposit XRP into Exchange</h3> <h3 id="deposit-xrp-into-exchange">Deposit XRP into Exchange</h3>
<p>To track <a href="#on-ledger-and-off-ledger">off-ledger XRP balances</a> exchanges need to create new <a href="#balance-sheets">balance sheets</a> (or similar accounting systems). The following table illustrates the balance changes that take place on Alpha Exchange's new balance sheet as users begin to deposit XRP.</p> <p>To track <a href="#on-ledger-and-off-ledger">off-ledger XRP balances</a>, exchanges need to create new <a href="#balance-sheets">balance sheets</a> (or similar accounting systems). The following table illustrates the balance changes that take place on Alpha Exchange's new balance sheet as users begin to deposit XRP.</p>
<p>A user named Charlie wants to deposit 50,000 XRP to Alpha Exchange. Doing this involves the following steps:</p> <p>A user named Charlie wants to deposit 50,000 XRP to Alpha Exchange. Doing this involves the following steps:</p>
<ol> <ol>
<li> <li>
@@ -544,7 +544,7 @@ XRP Balances</i></b></td>
<p>For more information about trading <em>on</em> the RCL, see <a href="https://ripple.com/build/transactions/#lifecycle-of-an-offer">Lifecycle of an Offer</a>.</p> <p>For more information about trading <em>on</em> the RCL, see <a href="https://ripple.com/build/transactions/#lifecycle-of-an-offer">Lifecycle of an Offer</a>.</p>
<h3 id="rebalance-xrp-holdings">Rebalance XRP Holdings</h3> <h3 id="rebalance-xrp-holdings">Rebalance XRP Holdings</h3>
<p>Exchanges can adjust the balances between their hot and cold wallets at any time. Each balance adjustment consumes a <a href="https://ripple.com/build/fees-disambiguation/">transaction fee</a>, but does not otherwise affect the aggregate balance of all the accounts. The aggregate, on-ledger balance should always exceed the total balance available for trade on the exchange. (The excess should be sufficient to cover the RCL's <a href="https://ripple.com/build/transaction-cost/">transaction fees</a>.)</p> <p>Exchanges can adjust the balances between their hot and cold wallets at any time. Each balance adjustment consumes a <a href="https://ripple.com/build/fees-disambiguation/">transaction fee</a>, but does not otherwise affect the aggregate balance of all the accounts. The aggregate, on-ledger balance should always exceed the total balance available for trade on the exchange. (The excess should be sufficient to cover the RCL's <a href="https://ripple.com/build/transaction-cost/">transaction fees</a>.)</p>
<p>The following table demonstrates a balance adjustment of 80,000 XRP (via a <a href="https://ripple.com/build/transactions/#payment"><em>payment</em></a> on the RCL) between Alpha Exchange's cold wallet and its hot wallet, where the cold wallet was debited and the hot wallet was credited. If the payment were reversed (debit the hot wallet and credit the cold wallet), the hot wallet balance would decrease. Balance adjustments like these allow an exchange to limit the risks associated with holding XRP in online hot wallets.</p> <p>The following table demonstrates a balance adjustment of 80,000 XRP (via a <a href="https://ripple.com/build/transactions/#payment"><em>payment</em></a> on the RCL) between Alpha Exchange's cold wallet and its hot wallet, where the cold wallet was debited and the hot wallet was credited. If the payment were reversed (debiting the hot wallet and crediting the cold wallet), the hot wallet balance would decrease. Balance adjustments like these allow an exchange to limit the risks associated with holding XRP in online hot wallets.</p>
<table> <table>
<tr> <tr>
<td><b><i>Alpha Exchange XRP <td><b><i>Alpha Exchange XRP