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

PayChan - transaction types 1st draft

Browse Source
This commit is contained in:
mDuo13
2016-12-02 16:45:17 -08:00
parent 6e84cda8f5
commit c6c9adfd3b
2 changed files with 343 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
content/reference-transaction-format.md
View File

@@ -362,9 +362,12 @@ All transactions have certain fields in common:
Each transaction type has additional fields relevant to the type of action it causes:
* [AccountSet - Set options on an account](#accountset)
* [OfferCreate - Submit an order to exchange currency](#offercreate)
* [OfferCancel - Withdraw a currency-exchange order](#offercancel)
* [OfferCreate - Submit an order to exchange currency](#offercreate)
* [Payment - Send funds from one account to another](#payment)
* [PaymentChannelClaim - Claim money from a payment channel](#paymentchannelclaim)
* [PaymentChannelCreate - Open a new payment channel](#paymentchannelcreate)
* [PaymentChannelFund - Add more XRP to a payment channel](#paymentchannelfund)
* [SetRegularKey - Set an account's regular key](#setregularkey)
* [SignerListSet - Set multi-signing settings](#signerlistset)
* [TrustSet - Add or modify a trust line](#trustset)
@@ -677,8 +680,6 @@ The `Paths` field must not be an empty array, nor an array whose members are all
For more information, see [Paths](concept-paths.html).
### Payment Flags ###
Transactions of the Payment type support additional values in the [`Flags` field](#flags), as follows:
@@ -724,6 +725,125 @@ In the above example with a ¥95/$15 offer and a ¥5/$2 offer, the situation is
## PaymentChannelClaim
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp "Source")
_Requires the [PayChan Amendment](concept-amendments.html#paychan)._
Claim XRP from a payment channel, adjust its expiration, or both. This transaction can be used differently depending on the transaction sender's role in the specified channel:
The **source address** of a channel can:
- Send XRP from the channel to the destination with _or without_ a signed Claim.
- Set the channel to expire as soon as the channel's `SettleDelay` has passed.
- Clear a pending `Expiration` time.
- Close a channel immediately if it has no XRP remaining in it.
The **destination address** of a channel can:
- Receive XRP from the channel using a signed Claim.
- Close the channel immediately after processing a Claim, refunding any unclaimed XRP to the channel's source.
**Any address** sending this transaction can:
- Cause a channel to be closed if its `Expiration` or `CancelAfter` time is older than the previous ledger's close time. Any validly-formed PaymentChannelClaim transaction has this effect regardless of the contents of the transaction.
Example PaymentChannelClaim:
```json
{
"Channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198",
"Balance": "1000000",
"Amount": "1000000",
"Signature": "1A9049CD627F919FAB6651CA11D871E324D911949E9FDF72AAB34F184D0B7D0C67E03FFE347735DBFBCFADB280244BB2A3FF3572C0EC1EB214D39494EE424B7E",
"PublicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A"
}
```
<!--{# TODO: replace the above example with a working one with a real pubkey and signature #}-->
| Field | JSON Type | [Internal Type][] | Description |
|:------------|:----------|:------------------|:-------------------------------|
| `Channel` | String | Hash256 | The unique ID of the channel, as a 64-character hexadecimal string. |
| `Balance` | String | Amount | _(Optional)_ Total amount of XRP, in drops, delivered by this channel after processing this claim. Required in order to deliver XRP. Must be more than the total amount delivered by the channel so far, but not greater than the `Amount` of the signed claim. Must be provided except when closing the channel. |
| `Amount` | String | Amount | _(Optional)_ The amount of XRP, in drops, authorized by the `Signature`. This must match the amount in the signed message. |
| `Signature` | String | VariableLength | _(Optional)_ The signature of this claim, as hexadecimal. The signed message contains the channel ID and the amount of the claim. Required unless the sender of the transaction is the source address of the channel. |
| `PublicKey` | String | PubKey | _(Optional)_ The public key used for the signature, as hexadecimal. This must match the `PublicKey` stored in the ledger for the channel. Required unless the sender of the transaction is the source address of the channel and the `Signature` field is omitted. (The transaction includes the PubKey so that `rippled` can check the validity of the signature before trying to apply the transaction to the ledger.) |
### PaymentChannelClaim Flags
Transactions of the PaymentChannelClaim type support additional values in the [`Flags` field](#flags), as follows:
| Flag Name | Hex Value | Decimal Value | Description |
|:----------|:-----------|:--------------|:------------------------------------|
| `tfRenew` | 0x00010000 | 65536 | Clear the channel's `Expiration` time. (`Expiration` is different from the channel's immutable `CancelAfter` time.) Only the source address of the payment channel can use this flag. |
| `tfClose` | 0x00020000 | 131072 | Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the destination address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close after `SettleDelay` seconds have passed. (Specifically, this sets the sets the `Expiration` of the channel to the close time of the previous ledger plus the channel's `SettleDelay` time, unless the channel already has a sooner `Expiration` time.) |
## PaymentChannelCreate
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp "Source")
_Requires the [PayChan Amendment](concept-amendments.html#paychan)._
Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.
Example PaymentChannelCreate:
```json
{
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"TransactionType": "PaymentChannelCreate",
"Amount": "10000",
"Destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
"SettleDelay": 86400,
"PublicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A",
"CancelAfter": 533171558,
"DestinationTag": 23480,
"SourceTag": 11747
}
```
| Field | JSON Type | [Internal Type][] | Description |
|:-----------------|:----------|:------------------|:--------------------------|
| `Amount` | String | Amount | Amount of XRP to deduct from the sender's balance and set aside in this channel. While the channel is open, the XRP can only go to the `Destination` address. When the channel closes, any unclaimed XRP is returned to the source address's balance. |
| `Destination` | String | AccountID | Address to receive XRP claims against this channel. This is also known as the "destination address" for the channel. |
| `SettleDelay` | Number | UInt32 | Amount of time the source address must wait before closing the channel if it has unclaimed XRP. |
| `PublicKey` | String | PubKey | The public key of the key pair the source will use to sign claims against this channel, in hexadecimal. This can be any secp256k1 or Ed25519 public key. |
| `CancelAfter` | Number | UInt32 | The time, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time), when this channel expires. Any transaction that would modify the channel after this time closes the channel without otherwise affecting it. This value is immutable; the channel can be closed sooner than this time but not later. |
| `DestinationTag` | Number | UInt32 | (Optional) Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address. |
| `SourceTag` | Number | UInt32 | (Optional) Arbitrary tag to further specify the source for this payment channel, such as a hosted sender at the source address. |
## PaymentChannelFund
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp "Source")
_Requires the [PayChan Amendment](concept-amendments.html#paychan)._
Add additional XRP to an open payment channel, update the expiration time of the channel, or both. Only the source address of the channel can use this transaction. (Transactions from other addresses fail with the error `tecNO_PERMISSION`.)
Example PaymentChannelFund:
```json
{
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"TransactionType": "PaymentChannelFund",
"Channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198",
"Amount": "200000",
"Expiration": 543171558
}
```
| Field | JSON Type | [Internal Type][] | Description |
|:-------------|:----------|:------------------|:------------------------------|
| `Channel` | String | Hash256 | The unique ID of the channel to fund, as a 64-character hexadecimal string. |
| `Amount` | String | Amount | How many [drops of XRP][Currency Amount] to add to the channel. To set the expiration for a channel without adding more XRP, set this to `"0"`. |
| `Expiration` | Number | UInt32 | _(Optional)_ New `Expiration` time to set for the channel, in seconds since the Ripple Epoch. This cannot be sooner than the close time of the previous ledger plus the `SettleDelay` of the channel. After the `Expiration` time, the channel closes automatically and returns any unspent XRP to the sender. (`Expiration` is separate from the channel's immutable `CancelAfter` time.) |
## SetRegularKey ##
[[Source]<br>](https://github.com/ripple/rippled/blob/4239880acb5e559446d2067f00dabb31cf102a23/src/ripple/app/transactors/SetRegularKey.cpp "Source")

221
reference-transaction-format.html
View File

@@ -170,6 +170,10 @@
<li class="level-3"><a href="#payment-flags">Payment Flags</a></li>
<li class="level-3"><a href="#partial-payments">Partial Payments</a></li>
<li class="level-3"><a href="#limit-quality">Limit Quality</a></li>
<li class="level-2"><a href="#paymentchannelclaim">PaymentChannelClaim</a></li>
<li class="level-3"><a href="#paymentchannelclaim-flags">PaymentChannelClaim Flags</a></li>
<li class="level-2"><a href="#paymentchannelcreate">PaymentChannelCreate</a></li>
<li class="level-2"><a href="#paymentchannelfund">PaymentChannelFund</a></li>
<li class="level-2"><a href="#setregularkey">SetRegularKey</a></li>
<li class="level-2"><a href="#signerlistset">SignerListSet</a></li>
<li class="level-2"><a href="#trustset">TrustSet</a></li>
@@ -623,9 +627,12 @@
<p>Each transaction type has additional fields relevant to the type of action it causes:</p>
<ul>
<li><a href="#accountset">AccountSet - Set options on an account</a></li>
<li><a href="#offercreate">OfferCreate - Submit an order to exchange currency</a></li>
<li><a href="#offercancel">OfferCancel - Withdraw a currency-exchange order</a></li>
<li><a href="#offercreate">OfferCreate - Submit an order to exchange currency</a></li>
<li><a href="#payment">Payment - Send funds from one account to another</a></li>
<li><a href="#paymentchannelclaim">PaymentChannelClaim - Claim money from a payment channel</a></li>
<li><a href="#paymentchannelcreate">PaymentChannelCreate - Open a new payment channel</a></li>
<li><a href="#paymentchannelfund">PaymentChannelFund - Add more XRP to a payment channel</a></li>
<li><a href="#setregularkey">SetRegularKey - Set an account's regular key</a></li>
<li><a href="#signerlistset">SignerListSet - Set multi-signing settings</a></li>
<li><a href="#trustset">TrustSet - Add or modify a trust line</a></li>
@@ -1154,6 +1161,218 @@
<p>Without the tfLimitQuality flag set, this transaction would succeed, because the $17 it costs me is within my specified <code>SendMax</code>. However, with the tfLimitQuality flag enabled, the transaction would fail instead, because the path to take the second offer has a quality of <code>2.5</code>, which is worse than the limit quality of <code>5</code>.</p>
<p>The tfLimitQuality flag is most useful when combined with <a href="#partial-payments">partial payments</a>. When both <em>tfPartialPayment</em> and <em>tfLimitQuality</em> are set on a transaction, then the transaction delivers as much of the destination <code>Amount</code> as it can, without using any conversions that are worse than the limit quality.</p>
<p>In the above example with a ¥95/$15 offer and a ¥5/$2 offer, the situation is different if my transaction has both tfPartialPayment and tfLimitQuality enabled. If we keep my <code>SendMax</code> of 20 USD and a destination <code>Amount</code> of 100 CNY, then the limit quality is still <code>5</code>. However, because I am doing a partial payment, the transaction sends as much as it can instead of failing if the full destination amount cannot be sent. This means that my transaction consumes the ¥95/$15 offer, whose quality is about <code>6.3</code>, but it rejects the ¥5/$2 offer because that offer's quality of <code>2.5</code> is worse than the quality limit of <code>5</code>. In the end, my transaction only delivers ¥95 instead of the full ¥100, but it avoids wasting money on poor exchange rates.</p>
<h2 id="paymentchannelclaim">PaymentChannelClaim</h2>
<p><a href="https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp" title="Source">[Source]<br/></a></p>
<p><em>Requires the <a href="concept-amendments.html#paychan">PayChan Amendment</a>.</em></p>
<p>Claim XRP from a payment channel, adjust its expiration, or both. This transaction can be used differently depending on the transaction sender's role in the specified channel:</p>
<p>The <strong>source address</strong> of a channel can:</p>
<ul>
<li>Send XRP from the channel to the destination with <em>or without</em> a signed Claim.</li>
<li>Set the channel to expire as soon as the channel's <code>SettleDelay</code> has passed.</li>
<li>Clear a pending <code>Expiration</code> time.</li>
<li>Close a channel immediately if it has no XRP remaining in it.</li>
</ul>
<p>The <strong>destination address</strong> of a channel can:</p>
<ul>
<li>Receive XRP from the channel using a signed Claim.</li>
<li>Close the channel immediately after processing a Claim, refunding any unclaimed XRP to the channel's source.</li>
</ul>
<p><strong>Any address</strong> sending this transaction can:</p>
<ul>
<li>Cause a channel to be closed if its <code>Expiration</code> or <code>CancelAfter</code> time is older than the previous ledger's close time. Any validly-formed PaymentChannelClaim transaction has this effect regardless of the contents of the transaction.</li>
</ul>
<p>Example PaymentChannelClaim:</p>
<pre><code class="json">{
"Channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198",
"Balance": "1000000",
"Amount": "1000000",
"Signature": "1A9049CD627F919FAB6651CA11D871E324D911949E9FDF72AAB34F184D0B7D0C67E03FFE347735DBFBCFADB280244BB2A3FF3572C0EC1EB214D39494EE424B7E",
"PublicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A"
}
</code></pre>
<!-- -->
<table>
<thead>
<tr>
<th align="left">Field</th>
<th align="left">JSON Type</th>
<th align="left"><a href="https://github.com/ripple/rippled/blob/master/src/ripple/protocol/impl/SField.cpp">Internal Type</a></th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Channel</code></td>
<td align="left">String</td>
<td align="left">Hash256</td>
<td align="left">The unique ID of the channel, as a 64-character hexadecimal string.</td>
</tr>
<tr>
<td align="left"><code>Balance</code></td>
<td align="left">String</td>
<td align="left">Amount</td>
<td align="left"><em>(Optional)</em> Total amount of XRP, in drops, delivered by this channel after processing this claim. Required in order to deliver XRP. Must be more than the total amount delivered by the channel so far, but not greater than the <code>Amount</code> of the signed claim. Must be provided except when closing the channel.</td>
</tr>
<tr>
<td align="left"><code>Amount</code></td>
<td align="left">String</td>
<td align="left">Amount</td>
<td align="left"><em>(Optional)</em> The amount of XRP, in drops, authorized by the <code>Signature</code>. This must match the amount in the signed message.</td>
</tr>
<tr>
<td align="left"><code>Signature</code></td>
<td align="left">String</td>
<td align="left">VariableLength</td>
<td align="left"><em>(Optional)</em> The signature of this claim, as hexadecimal. The signed message contains the channel ID and the amount of the claim. Required unless the sender of the transaction is the source address of the channel.</td>
</tr>
<tr>
<td align="left"><code>PublicKey</code></td>
<td align="left">String</td>
<td align="left">PubKey</td>
<td align="left"><em>(Optional)</em> The public key used for the signature, as hexadecimal. This must match the <code>PublicKey</code> stored in the ledger for the channel. Required unless the sender of the transaction is the source address of the channel and the <code>Signature</code> field is omitted. (The transaction includes the PubKey so that <code>rippled</code> can check the validity of the signature before trying to apply the transaction to the ledger.)</td>
</tr>
</tbody>
</table>
<h3 id="paymentchannelclaim-flags">PaymentChannelClaim Flags</h3>
<p>Transactions of the PaymentChannelClaim type support additional values in the <a href="#flags"><code>Flags</code> field</a>, as follows:</p>
<table>
<thead>
<tr>
<th align="left">Flag Name</th>
<th align="left">Hex Value</th>
<th align="left">Decimal Value</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>tfRenew</code></td>
<td align="left">0x00010000</td>
<td align="left">65536</td>
<td align="left">Clear the channel's <code>Expiration</code> time. (<code>Expiration</code> is different from the channel's immutable <code>CancelAfter</code> time.) Only the source address of the payment channel can use this flag.</td>
</tr>
<tr>
<td align="left"><code>tfClose</code></td>
<td align="left">0x00020000</td>
<td align="left">131072</td>
<td align="left">Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the destination address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close after <code>SettleDelay</code> seconds have passed. (Specifically, this sets the sets the <code>Expiration</code> of the channel to the close time of the previous ledger plus the channel's <code>SettleDelay</code> time, unless the channel already has a sooner <code>Expiration</code> time.)</td>
</tr>
</tbody>
</table>
<h2 id="paymentchannelcreate">PaymentChannelCreate</h2>
<p><a href="https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp" title="Source">[Source]<br/></a></p>
<p><em>Requires the <a href="concept-amendments.html#paychan">PayChan Amendment</a>.</em></p>
<p>Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.</p>
<p>Example PaymentChannelCreate:</p>
<pre><code class="json">{
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"TransactionType": "PaymentChannelCreate",
"Amount": "10000",
"Destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
"SettleDelay": 86400,
"PublicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A",
"CancelAfter": 533171558,
"DestinationTag": 23480,
"SourceTag": 11747
}
</code></pre>
<table>
<thead>
<tr>
<th align="left">Field</th>
<th align="left">JSON Type</th>
<th align="left"><a href="https://github.com/ripple/rippled/blob/master/src/ripple/protocol/impl/SField.cpp">Internal Type</a></th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Amount</code></td>
<td align="left">String</td>
<td align="left">Amount</td>
<td align="left">Amount of XRP to deduct from the sender's balance and set aside in this channel. While the channel is open, the XRP can only go to the <code>Destination</code> address. When the channel closes, any unclaimed XRP is returned to the source address's balance.</td>
</tr>
<tr>
<td align="left"><code>Destination</code></td>
<td align="left">String</td>
<td align="left">AccountID</td>
<td align="left">Address to receive XRP claims against this channel. This is also known as the "destination address" for the channel.</td>
</tr>
<tr>
<td align="left"><code>SettleDelay</code></td>
<td align="left">Number</td>
<td align="left">UInt32</td>
<td align="left">Amount of time the source address must wait before closing the channel if it has unclaimed XRP.</td>
</tr>
<tr>
<td align="left"><code>PublicKey</code></td>
<td align="left">String</td>
<td align="left">PubKey</td>
<td align="left">The public key of the key pair the source will use to sign claims against this channel, in hexadecimal. This can be any secp256k1 or Ed25519 public key.</td>
</tr>
<tr>
<td align="left"><code>CancelAfter</code></td>
<td align="left">Number</td>
<td align="left">UInt32</td>
<td align="left">The time, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>, when this channel expires. Any transaction that would modify the channel after this time closes the channel without otherwise affecting it. This value is immutable; the channel can be closed sooner than this time but not later.</td>
</tr>
<tr>
<td align="left"><code>DestinationTag</code></td>
<td align="left">Number</td>
<td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.</td>
</tr>
<tr>
<td align="left"><code>SourceTag</code></td>
<td align="left">Number</td>
<td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary tag to further specify the source for this payment channel, such as a hosted sender at the source address.</td>
</tr>
</tbody>
</table>
<h2 id="paymentchannelfund">PaymentChannelFund</h2>
<p><a href="https://github.com/ripple/rippled/blob/develop/src/ripple/app/tx/impl/PayChan.cpp" title="Source">[Source]<br/></a></p>
<p><em>Requires the <a href="concept-amendments.html#paychan">PayChan Amendment</a>.</em></p>
<p>Add additional XRP to an open payment channel, update the expiration time of the channel, or both. Only the source address of the channel can use this transaction. (Transactions from other addresses fail with the error <code>tecNO_PERMISSION</code>.)</p>
<p>Example PaymentChannelFund:</p>
<pre><code class="json">{
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"TransactionType": "PaymentChannelFund",
"Channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198",
"Amount": "200000",
"Expiration": 543171558
}
</code></pre>
<table>
<thead>
<tr>
<th align="left">Field</th>
<th align="left">JSON Type</th>
<th align="left"><a href="https://github.com/ripple/rippled/blob/master/src/ripple/protocol/impl/SField.cpp">Internal Type</a></th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Channel</code></td>
<td align="left">String</td>
<td align="left">Hash256</td>
<td align="left">The unique ID of the channel to fund, as a 64-character hexadecimal string.</td>
</tr>
<tr>
<td align="left"><code>Amount</code></td>
<td align="left">String</td>
<td align="left">Amount</td>
<td align="left">How many <a href="reference-rippled.html#specifying-currency-amounts">drops of XRP</a> to add to the channel. To set the expiration for a channel without adding more XRP, set this to <code>"0"</code>.</td>
</tr>
<tr>
<td align="left"><code>Expiration</code></td>
<td align="left">Number</td>
<td align="left">UInt32</td>
<td align="left"><em>(Optional)</em> New <code>Expiration</code> time to set for the channel, in seconds since the Ripple Epoch. This cannot be sooner than the close time of the previous ledger plus the <code>SettleDelay</code> of the channel. After the <code>Expiration</code> time, the channel closes automatically and returns any unspent XRP to the sender. (<code>Expiration</code> is separate from the channel's immutable <code>CancelAfter</code> time.)</td>
</tr>
</tbody>
</table>
<h2 id="setregularkey">SetRegularKey</h2>
<p><a href="https://github.com/ripple/rippled/blob/4239880acb5e559446d2067f00dabb31cf102a23/src/ripple/app/transactors/SetRegularKey.cpp" title="Source">[Source]<br/></a></p>
<p>A SetRegularKey transaction changes the regular key associated with an address.</p>