Tx format: correctly list PaymentChannelCreate CancelAfter as optional

This commit is contained in:
mDuo13
2017-06-06 18:36:14 -07:00
parent 93170c2e22
commit d585c3f3d4
2 changed files with 66 additions and 66 deletions

View File

@@ -220,16 +220,16 @@ Every transaction type has the same set of fundamental fields. Field names are c
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:-----------------------|:-----------------|:------------------|:-------------| |:-----------------------|:-----------------|:------------------|:-------------|
| Account | String | Account | The unique address of the account that initiated the transaction. | | Account | String | Account | The unique address of the account that initiated the transaction. |
| [AccountTxnID][] | String | Hash256 | (Optional) Hash value identifying another transaction. This transaction is only valid if the sending account's previously-sent transaction matches the provided hash. | | [AccountTxnID][] | String | Hash256 | _(Optional)_ Hash value identifying another transaction. This transaction is only valid if the sending account's previously-sent transaction matches the provided hash. |
| [Fee][] | String | Amount | (Required, but [auto-fillable](#auto-fillable-fields)) Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. | | [Fee][] | String | Amount | (Required, but [auto-fillable](#auto-fillable-fields)) Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. |
| [Flags][] | Unsigned Integer | UInt32 | (Optional) Set of bit-flags for this transaction. | | [Flags][] | Unsigned Integer | UInt32 | _(Optional)_ Set of bit-flags for this transaction. |
| [LastLedgerSequence][] | Number | UInt32 | (Optional, but strongly recommended) Highest ledger sequence number that a transaction can appear in. | | [LastLedgerSequence][] | Number | UInt32 | (Optional, but strongly recommended) Highest ledger sequence number that a transaction can appear in. |
| [Memos][] | Array of Objects | Array | (Optional) Additional arbitrary information used to identify this transaction. | | [Memos][] | Array of Objects | Array | _(Optional)_ Additional arbitrary information used to identify this transaction. |
| PreviousTxnID | String | Hash256 | [Removed in: rippled 0.28.0][] Use `AccountTxnID` instead. | | PreviousTxnID | String | Hash256 | [Removed in: rippled 0.28.0][] Use `AccountTxnID` instead. |
| [Sequence][] | Unsigned Integer | UInt32 | (Required, but [auto-fillable](#auto-fillable-fields)) The sequence number, relative to the initiating account, of this transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the last-valided transaction from the same account. | | [Sequence][] | Unsigned Integer | UInt32 | (Required, but [auto-fillable](#auto-fillable-fields)) The sequence number, relative to the initiating account, of this transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the last-valided transaction from the same account. |
| SigningPubKey | String | PubKey | (Automatically added when signing) Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the `Signers` field instead. | | SigningPubKey | String | PubKey | (Automatically added when signing) Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the `Signers` field instead. |
| [Signers][] | Array | Array | (Optional) Array of objects that represent a [multi-signature](#multi-signing) which authorizes this transaction. | | [Signers][] | Array | Array | _(Optional)_ Array of objects that represent a [multi-signature](#multi-signing) which authorizes this transaction. |
| SourceTag | Unsigned Integer | UInt32 | (Optional) Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's `SourceTag` as the refund payment's `DestinationTag`. | | SourceTag | Unsigned Integer | UInt32 | _(Optional)_ Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's `SourceTag` as the refund payment's `DestinationTag`. |
| TransactionType | String | UInt16 | The type of transaction. Valid types include: `Payment`, `OfferCreate`, `OfferCancel`, `TrustSet`, `AccountSet`, `SetRegularKey`, `SignerListSet`, `EscrowCreate`, `EscrowFinish`, `EscrowCancel`, `PaymentChannelCreate`, `PaymentChannelFund`, and `PaymentChannelClaim`. | | TransactionType | String | UInt16 | The type of transaction. Valid types include: `Payment`, `OfferCreate`, `OfferCancel`, `TrustSet`, `AccountSet`, `SetRegularKey`, `SignerListSet`, `EscrowCreate`, `EscrowFinish`, `EscrowCancel`, `PaymentChannelCreate`, `PaymentChannelFund`, and `PaymentChannelClaim`. |
| TxnSignature | String | VariableLength | (Automatically added when signing) The signature that verifies this transaction as originating from the account it says it is from. | | TxnSignature | String | VariableLength | (Automatically added when signing) The signature that verifies this transaction as originating from the account it says it is from. |
@@ -403,15 +403,15 @@ Example AccountSet:
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:-------------------------------|:-----------------|:------------------|:-----| |:-------------------------------|:-----------------|:------------------|:-----|
| [ClearFlag](#accountset-flags) | Unsigned Integer | UInt32 | (Optional) Unique identifier of a flag to disable for this account. | | [ClearFlag](#accountset-flags) | Unsigned Integer | UInt32 | _(Optional)_ Unique identifier of a flag to disable for this account. |
| [Domain](#domain) | String | VariableLength | (Optional) The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase. | | [Domain](#domain) | String | VariableLength | _(Optional)_ The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase. |
| EmailHash | String | Hash128 | (Optional) Hash of an email address to be used for generating an avatar image. Conventionally, clients use [Gravatar](http://en.gravatar.com/site/implement/hash/) to display this image. | | EmailHash | String | Hash128 | _(Optional)_ Hash of an email address to be used for generating an avatar image. Conventionally, clients use [Gravatar](http://en.gravatar.com/site/implement/hash/) to display this image. |
| MessageKey | String | PubKey | (Optional) Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple. | | MessageKey | String | PubKey | _(Optional)_ Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple. |
| [SetFlag](#accountset-flags) | Unsigned Integer | UInt32 | (Optional) Integer flag to enable for this account. | | [SetFlag](#accountset-flags) | Unsigned Integer | UInt32 | _(Optional)_ Integer flag to enable for this account. |
| [TransferRate](#transferrate) | Unsigned Integer | UInt32 | (Optional) The fee to charge when users transfer this account's issuances, represented as billionths of a unit. Use `0` to set no fee. | | [TransferRate](#transferrate) | Unsigned Integer | UInt32 | _(Optional)_ The fee to charge when users transfer this account's issuances, represented as billionths of a unit. Use `0` to set no fee. |
| [TickSize](#ticksize) | Unsigned Integer | UInt8 | (Optional) Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. _(Requires the [TickSize amendment](concept-amendments.html#ticksize).)_ | | [TickSize](#ticksize) | Unsigned Integer | UInt8 | _(Optional)_ Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. _(Requires the [TickSize amendment](concept-amendments.html#ticksize).)_ |
| WalletLocator | String | Hash256 | (Optional) Not used. | | WalletLocator | String | Hash256 | _(Optional)_ Not used. |
| WalletSize | Unsigned Integer | UInt32 | (Optional) Not used. | | WalletSize | Unsigned Integer | UInt32 | _(Optional)_ Not used. |
If none of these options are provided, then the AccountSet transaction has no effect (beyond destroying the transaction cost). See [Canceling or Skipping a Transaction](#canceling-or-skipping-a-transaction) for more details. If none of these options are provided, then the AccountSet transaction has no effect (beyond destroying the transaction cost). See [Canceling or Skipping a Transaction](#canceling-or-skipping-a-transaction) for more details.
@@ -538,11 +538,11 @@ Example EscrowCreate:
|:-----------------|:----------|:------------------|:--------------------------| |:-----------------|:----------|:------------------|:--------------------------|
| `Amount` | String | Amount | Amount of [XRP, in drops][Currency Amount], to deduct from the sender's balance and escrow. Once escrowed, the XRP can either go to the `Destination` address (after the `FinishAfter` time) or returned to the sender (after the `CancelAfter` time). | | `Amount` | String | Amount | Amount of [XRP, in drops][Currency Amount], to deduct from the sender's balance and escrow. Once escrowed, the XRP can either go to the `Destination` address (after the `FinishAfter` time) or returned to the sender (after the `CancelAfter` time). |
| `Destination` | String | AccountID | Address to receive escrowed XRP. | | `Destination` | String | AccountID | Address to receive escrowed XRP. |
| `CancelAfter` | Number | UInt32 | (Optional) The time, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time), when this escrow expires. This value is immutable; the funds can only be returned the sender after this time. | | `CancelAfter` | Number | UInt32 | _(Optional)_ The time, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time), when this escrow expires. This value is immutable; the funds can only be returned the sender after this time. |
| `FinishAfter` | Number | UInt32 | (Optional) The time, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time), when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move until this time is reached. | | `FinishAfter` | Number | UInt32 | _(Optional)_ The time, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time), when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move until this time is reached. |
| `Condition` | String | VariableLength | (Optional) Hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). The funds can only be delivered to the recipient if this condition is fulfilled. | | `Condition` | String | VariableLength | _(Optional)_ Hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). The funds can only be delivered to the recipient if this condition is fulfilled. |
| `DestinationTag` | Number | UInt32 | (Optional) Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address. | | `DestinationTag` | Number | UInt32 | _(Optional)_ Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address. |
| `SourceTag` | Number | UInt32 | (Optional) Arbitrary tag to further specify the source for this escrowed payment, such as a hosted sender at the source address. | | `SourceTag` | Number | UInt32 | _(Optional)_ Arbitrary tag to further specify the source for this escrowed payment, such as a hosted sender at the source address. |
Either `CancelAfter` or `FinishAfter` must be specified. If both are included, the `FinishAfter` time must precede that of `CancelAfter`. Either `CancelAfter` or `FinishAfter` must be specified. If both are included, the `FinishAfter` time must precede that of `CancelAfter`.
@@ -573,8 +573,8 @@ Example EscrowFinish:
|:----------------|:-----------------|:------------------|:--------------------------| |:----------------|:-----------------|:------------------|:--------------------------|
| `Owner` | String | AccountID | Address of the source account that funded the held payment. | `Owner` | String | AccountID | Address of the source account that funded the held payment.
| `OfferSequence` | Unsigned Integer | UInt32 | Transaction sequence of [EscrowCreate transaction][] that created the held payment to finish. | `OfferSequence` | Unsigned Integer | UInt32 | Transaction sequence of [EscrowCreate transaction][] that created the held payment to finish.
| `Condition` | String | VariableLength | (Optional) Hex value matching the previously-supplied [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1) of the held payment. | | `Condition` | String | VariableLength | _(Optional)_ Hex value matching the previously-supplied [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1) of the held payment. |
| `Fulfillment` | String | VariableLength | (Optional) Hex value of the [PREIMAGE-SHA-256 crypto-condition fulfillment](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1.4) matching the held payment's `Condition`. | | `Fulfillment` | String | VariableLength | _(Optional)_ Hex value of the [PREIMAGE-SHA-256 crypto-condition fulfillment](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1.4) matching the held payment's `Condition`. |
Any account may submit an EscrowFinish transaction. Any account may submit an EscrowFinish transaction.
@@ -639,8 +639,8 @@ An OfferCreate transaction is effectively a [limit order](http://en.wikipedia.or
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:--------------------------|:--------------------|:------------------|:-------| |:--------------------------|:--------------------|:------------------|:-------|
| [Expiration](#expiration) | Unsigned Integer | UInt32 | (Optional) Time after which the offer is no longer active, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time). | | [Expiration](#expiration) | Unsigned Integer | UInt32 | _(Optional)_ Time after which the offer is no longer active, in [seconds since the Ripple Epoch](reference-rippled.html#specifying-time). |
| OfferSequence | Unsigned Integer | UInt32 | (Optional) An offer to delete first, specified in the same way as [OfferCancel][]. | | OfferSequence | Unsigned Integer | UInt32 | _(Optional)_ An offer to delete first, specified in the same way as [OfferCancel][]. |
| TakerGets | [Currency Amount][] | Amount | The amount and type of currency being provided by the offer creator. | | TakerGets | [Currency Amount][] | Amount | The amount and type of currency being provided by the offer creator. |
| TakerPays | [Currency Amount][] | Amount | The amount and type of currency being requested by the offer creator. | | TakerPays | [Currency Amount][] | Amount | The amount and type of currency being requested by the offer creator. |
@@ -769,11 +769,11 @@ Example payment:
|:---------------|:---------------------|:------------------|:-----------------| |:---------------|:---------------------|:------------------|:-----------------|
| Amount | [Currency Amount][] | Amount | The amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the [**tfPartialPayment** flag](#payment-flags) is set, deliver _up to_ this amount instead. | | Amount | [Currency Amount][] | Amount | The amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the [**tfPartialPayment** flag](#payment-flags) is set, deliver _up to_ this amount instead. |
| Destination | String | Account | The unique address of the account receiving the payment. | | Destination | String | Account | The unique address of the account receiving the payment. |
| DestinationTag | Unsigned Integer | UInt32 | (Optional) Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay. | | DestinationTag | Unsigned Integer | UInt32 | _(Optional)_ Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay. |
| InvoiceID | String | Hash256 | (Optional) Arbitrary 256-bit hash representing a specific reason or identifier for this payment. | | InvoiceID | String | Hash256 | _(Optional)_ Arbitrary 256-bit hash representing a specific reason or identifier for this payment. |
| Paths | Array of path arrays | PathSet | (Optional, auto-fillable) Array of [payment paths](concept-paths.html) to be used for this transaction. Must be omitted for XRP-to-XRP transactions. | | Paths | Array of path arrays | PathSet | (Optional, auto-fillable) Array of [payment paths](concept-paths.html) to be used for this transaction. Must be omitted for XRP-to-XRP transactions. |
| SendMax | [Currency Amount][] | Amount | (Optional) Highest amount of source currency this transaction is allowed to cost, including [transfer fees](concept-transfer-fees.html), exchange rates, and [slippage](http://en.wikipedia.org/wiki/Slippage_%28finance%29). Does not include the [XRP destroyed as a cost for submitting the transaction](#transaction-cost). For non-XRP amounts, the nested field names MUST be lower-case. Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments. | | SendMax | [Currency Amount][] | Amount | _(Optional)_ Highest amount of source currency this transaction is allowed to cost, including [transfer fees](concept-transfer-fees.html), exchange rates, and [slippage](http://en.wikipedia.org/wiki/Slippage_%28finance%29). Does not include the [XRP destroyed as a cost for submitting the transaction](#transaction-cost). For non-XRP amounts, the nested field names MUST be lower-case. Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments. |
| DeliverMin | [Currency Amount][] | Amount | (Optional) Minimum amount of destination currency this transaction should deliver. Only valid if this is a [partial payment](#partial-payments). For non-XRP amounts, the nested field names are lower-case. | | DeliverMin | [Currency Amount][] | Amount | _(Optional)_ Minimum amount of destination currency this transaction should deliver. Only valid if this is a [partial payment](#partial-payments). For non-XRP amounts, the nested field names are lower-case. |
### Special issuer Values for SendMax and Amount ### ### Special issuer Values for SendMax and Amount ###
@@ -935,9 +935,9 @@ Example PaymentChannelCreate:
| `Destination` | String | AccountID | Address to receive XRP claims against this channel. This is also known as the "destination address" for the channel. | | `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. | | `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. | | `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 earlier than this time but cannot remain open after this time. | | `CancelAfter` | Number | UInt32 | _(Optional)_ 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 earlier than this time but cannot remain open after this time. |
| `DestinationTag` | Number | UInt32 | (Optional) Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address. | | `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. | | `SourceTag` | Number | UInt32 | _(Optional)_ Arbitrary tag to further specify the source for this payment channel, such as a hosted sender at the source address. |
@@ -988,7 +988,7 @@ A SetRegularKey transaction changes the regular key associated with an address.
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:-----------|:----------|:------------------|:--------------------------------| |:-----------|:----------|:------------------|:--------------------------------|
| RegularKey | String | AccountID | (Optional) A base-58-encoded [Ripple address](reference-rippled.html#addresses) to use as the regular key. If omitted, removes the existing regular key. | | RegularKey | String | AccountID | _(Optional)_ A base-58-encoded [Ripple address](reference-rippled.html#addresses) to use as the regular key. If omitted, removes the existing regular key. |
In addition to the master key, which is mathematically-related to an address, you can associate **at most 1 additional key pair** with an address using this type of transaction. The additional key pair is called a _regular key_. If your address has a regular key pair defined, you can use the secret key of the regular key pair to [authorize transactions](#authorizing-transactions). In addition to the master key, which is mathematically-related to an address, you can associate **at most 1 additional key pair** with an address using this type of transaction. The additional key pair is called a _regular key_. If your address has a regular key pair defined, you can use the secret key of the regular key pair to [authorize transactions](#authorizing-transactions).
@@ -1080,8 +1080,8 @@ Create or modify a trust line linking two accounts.
| LimitAmount.currency | String | (Amount.currency) | The currency to this trust line applies to, as a three-letter [ISO 4217 Currency Code](http://www.xe.com/iso4217.php) or a 160-bit hex value according to [currency format](https://wiki.ripple.com/Currency_format). "XRP" is invalid. | | LimitAmount.currency | String | (Amount.currency) | The currency to this trust line applies to, as a three-letter [ISO 4217 Currency Code](http://www.xe.com/iso4217.php) or a 160-bit hex value according to [currency format](https://wiki.ripple.com/Currency_format). "XRP" is invalid. |
| LimitAmount.value | String | (Amount.value) | Quoted decimal representation of the limit to set on this trust line. | | LimitAmount.value | String | (Amount.value) | Quoted decimal representation of the limit to set on this trust line. |
| LimitAmount.issuer | String | (Amount.issuer) | The address of the account to extend trust to. | | LimitAmount.issuer | String | (Amount.issuer) | The address of the account to extend trust to. |
| QualityIn | Unsigned Integer | UInt32 | (Optional) Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. | | QualityIn | Unsigned Integer | UInt32 | _(Optional)_ Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. |
| QualityOut | Unsigned Integer | UInt32 | (Optional) Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. | | QualityOut | Unsigned Integer | UInt32 | _(Optional)_ Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. |
### Trust Limits ### ### Trust Limits ###

View File

@@ -422,7 +422,7 @@
<td align="left"><a href="#accounttxnid">AccountTxnID</a></td> <td align="left"><a href="#accounttxnid">AccountTxnID</a></td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">Hash256</td> <td align="left">Hash256</td>
<td align="left">(Optional) Hash value identifying another transaction. This transaction is only valid if the sending account's previously-sent transaction matches the provided hash.</td> <td align="left"><em>(Optional)</em> Hash value identifying another transaction. This transaction is only valid if the sending account's previously-sent transaction matches the provided hash.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#transaction-cost">Fee</a></td> <td align="left"><a href="#transaction-cost">Fee</a></td>
@@ -434,7 +434,7 @@
<td align="left"><a href="#flags">Flags</a></td> <td align="left"><a href="#flags">Flags</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Set of bit-flags for this transaction.</td> <td align="left"><em>(Optional)</em> Set of bit-flags for this transaction.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#lastledgersequence">LastLedgerSequence</a></td> <td align="left"><a href="#lastledgersequence">LastLedgerSequence</a></td>
@@ -446,7 +446,7 @@
<td align="left"><a href="#memos">Memos</a></td> <td align="left"><a href="#memos">Memos</a></td>
<td align="left">Array of Objects</td> <td align="left">Array of Objects</td>
<td align="left">Array</td> <td align="left">Array</td>
<td align="left">(Optional) Additional arbitrary information used to identify this transaction.</td> <td align="left"><em>(Optional)</em> Additional arbitrary information used to identify this transaction.</td>
</tr> </tr>
<tr> <tr>
<td align="left">PreviousTxnID</td> <td align="left">PreviousTxnID</td>
@@ -470,13 +470,13 @@
<td align="left"><a href="#signers-field">Signers</a></td> <td align="left"><a href="#signers-field">Signers</a></td>
<td align="left">Array</td> <td align="left">Array</td>
<td align="left">Array</td> <td align="left">Array</td>
<td align="left">(Optional) Array of objects that represent a <a href="#multi-signing">multi-signature</a> which authorizes this transaction.</td> <td align="left"><em>(Optional)</em> Array of objects that represent a <a href="#multi-signing">multi-signature</a> which authorizes this transaction.</td>
</tr> </tr>
<tr> <tr>
<td align="left">SourceTag</td> <td align="left">SourceTag</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's <code>SourceTag</code> as the refund payment's <code>DestinationTag</code>.</td> <td align="left"><em>(Optional)</em> Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's <code>SourceTag</code> as the refund payment's <code>DestinationTag</code>.</td>
</tr> </tr>
<tr> <tr>
<td align="left">TransactionType</td> <td align="left">TransactionType</td>
@@ -678,55 +678,55 @@
<td align="left"><a href="#accountset-flags">ClearFlag</a></td> <td align="left"><a href="#accountset-flags">ClearFlag</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Unique identifier of a flag to disable for this account.</td> <td align="left"><em>(Optional)</em> Unique identifier of a flag to disable for this account.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#domain">Domain</a></td> <td align="left"><a href="#domain">Domain</a></td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">VariableLength</td> <td align="left">VariableLength</td>
<td align="left">(Optional) The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase.</td> <td align="left"><em>(Optional)</em> The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase.</td>
</tr> </tr>
<tr> <tr>
<td align="left">EmailHash</td> <td align="left">EmailHash</td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">Hash128</td> <td align="left">Hash128</td>
<td align="left">(Optional) Hash of an email address to be used for generating an avatar image. Conventionally, clients use <a href="http://en.gravatar.com/site/implement/hash/">Gravatar</a> to display this image.</td> <td align="left"><em>(Optional)</em> Hash of an email address to be used for generating an avatar image. Conventionally, clients use <a href="http://en.gravatar.com/site/implement/hash/">Gravatar</a> to display this image.</td>
</tr> </tr>
<tr> <tr>
<td align="left">MessageKey</td> <td align="left">MessageKey</td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">PubKey</td> <td align="left">PubKey</td>
<td align="left">(Optional) Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple.</td> <td align="left"><em>(Optional)</em> Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#accountset-flags">SetFlag</a></td> <td align="left"><a href="#accountset-flags">SetFlag</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Integer flag to enable for this account.</td> <td align="left"><em>(Optional)</em> Integer flag to enable for this account.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#transferrate">TransferRate</a></td> <td align="left"><a href="#transferrate">TransferRate</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) The fee to charge when users transfer this account's issuances, represented as billionths of a unit. Use <code>0</code> to set no fee.</td> <td align="left"><em>(Optional)</em> The fee to charge when users transfer this account's issuances, represented as billionths of a unit. Use <code>0</code> to set no fee.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><a href="#ticksize">TickSize</a></td> <td align="left"><a href="#ticksize">TickSize</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt8</td> <td align="left">UInt8</td>
<td align="left">(Optional) Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are <code>3</code> to <code>15</code> inclusive, or <code>0</code> to disable. <em>(Requires the <a href="concept-amendments.html#ticksize">TickSize amendment</a>.)</em></td> <td align="left"><em>(Optional)</em> Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are <code>3</code> to <code>15</code> inclusive, or <code>0</code> to disable. <em>(Requires the <a href="concept-amendments.html#ticksize">TickSize amendment</a>.)</em></td>
</tr> </tr>
<tr> <tr>
<td align="left">WalletLocator</td> <td align="left">WalletLocator</td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">Hash256</td> <td align="left">Hash256</td>
<td align="left">(Optional) Not used.</td> <td align="left"><em>(Optional)</em> Not used.</td>
</tr> </tr>
<tr> <tr>
<td align="left">WalletSize</td> <td align="left">WalletSize</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Not used.</td> <td align="left"><em>(Optional)</em> Not used.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -946,31 +946,31 @@
<td align="left"><code>CancelAfter</code></td> <td align="left"><code>CancelAfter</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) The time, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>, when this escrow expires. This value is immutable; the funds can only be returned the sender after this time.</td> <td align="left"><em>(Optional)</em> The time, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>, when this escrow expires. This value is immutable; the funds can only be returned the sender after this time.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>FinishAfter</code></td> <td align="left"><code>FinishAfter</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) The time, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>, when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move until this time is reached.</td> <td align="left"><em>(Optional)</em> The time, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>, when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move until this time is reached.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>Condition</code></td> <td align="left"><code>Condition</code></td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">VariableLength</td> <td align="left">VariableLength</td>
<td align="left">(Optional) Hex value representing a <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1">PREIMAGE-SHA-256 crypto-condition</a>. The funds can only be delivered to the recipient if this condition is fulfilled.</td> <td align="left"><em>(Optional)</em> Hex value representing a <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1">PREIMAGE-SHA-256 crypto-condition</a>. The funds can only be delivered to the recipient if this condition is fulfilled.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>DestinationTag</code></td> <td align="left"><code>DestinationTag</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address.</td> <td align="left"><em>(Optional)</em> Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>SourceTag</code></td> <td align="left"><code>SourceTag</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary tag to further specify the source for this escrowed payment, such as a hosted sender at the source address.</td> <td align="left"><em>(Optional)</em> Arbitrary tag to further specify the source for this escrowed payment, such as a hosted sender at the source address.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -1015,13 +1015,13 @@
<td align="left"><code>Condition</code></td> <td align="left"><code>Condition</code></td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">VariableLength</td> <td align="left">VariableLength</td>
<td align="left">(Optional) Hex value matching the previously-supplied <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1">PREIMAGE-SHA-256 crypto-condition</a> of the held payment.</td> <td align="left"><em>(Optional)</em> Hex value matching the previously-supplied <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1">PREIMAGE-SHA-256 crypto-condition</a> of the held payment.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>Fulfillment</code></td> <td align="left"><code>Fulfillment</code></td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">VariableLength</td> <td align="left">VariableLength</td>
<td align="left">(Optional) Hex value of the <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1.4">PREIMAGE-SHA-256 crypto-condition fulfillment</a> matching the held payment's <code>Condition</code>.</td> <td align="left"><em>(Optional)</em> Hex value of the <a href="https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1.4">PREIMAGE-SHA-256 crypto-condition fulfillment</a> matching the held payment's <code>Condition</code>.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -1097,13 +1097,13 @@
<td align="left"><a href="#expiration">Expiration</a></td> <td align="left"><a href="#expiration">Expiration</a></td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Time after which the offer is no longer active, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>.</td> <td align="left"><em>(Optional)</em> Time after which the offer is no longer active, in <a href="reference-rippled.html#specifying-time">seconds since the Ripple Epoch</a>.</td>
</tr> </tr>
<tr> <tr>
<td align="left">OfferSequence</td> <td align="left">OfferSequence</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) An offer to delete first, specified in the same way as <a href="#offercancel">OfferCancel</a>.</td> <td align="left"><em>(Optional)</em> An offer to delete first, specified in the same way as <a href="#offercancel">OfferCancel</a>.</td>
</tr> </tr>
<tr> <tr>
<td align="left">TakerGets</td> <td align="left">TakerGets</td>
@@ -1261,13 +1261,13 @@
<td align="left">DestinationTag</td> <td align="left">DestinationTag</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay.</td> <td align="left"><em>(Optional)</em> Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay.</td>
</tr> </tr>
<tr> <tr>
<td align="left">InvoiceID</td> <td align="left">InvoiceID</td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">Hash256</td> <td align="left">Hash256</td>
<td align="left">(Optional) Arbitrary 256-bit hash representing a specific reason or identifier for this payment.</td> <td align="left"><em>(Optional)</em> Arbitrary 256-bit hash representing a specific reason or identifier for this payment.</td>
</tr> </tr>
<tr> <tr>
<td align="left">Paths</td> <td align="left">Paths</td>
@@ -1279,13 +1279,13 @@
<td align="left">SendMax</td> <td align="left">SendMax</td>
<td align="left"><a href="reference-rippled.html#specifying-currency-amounts">Currency Amount</a></td> <td align="left"><a href="reference-rippled.html#specifying-currency-amounts">Currency Amount</a></td>
<td align="left">Amount</td> <td align="left">Amount</td>
<td align="left">(Optional) Highest amount of source currency this transaction is allowed to cost, including <a href="concept-transfer-fees.html">transfer fees</a>, exchange rates, and <a href="http://en.wikipedia.org/wiki/Slippage_%28finance%29">slippage</a>. Does not include the <a href="#transaction-cost">XRP destroyed as a cost for submitting the transaction</a>. For non-XRP amounts, the nested field names MUST be lower-case. Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments.</td> <td align="left"><em>(Optional)</em> Highest amount of source currency this transaction is allowed to cost, including <a href="concept-transfer-fees.html">transfer fees</a>, exchange rates, and <a href="http://en.wikipedia.org/wiki/Slippage_%28finance%29">slippage</a>. Does not include the <a href="#transaction-cost">XRP destroyed as a cost for submitting the transaction</a>. For non-XRP amounts, the nested field names MUST be lower-case. Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments.</td>
</tr> </tr>
<tr> <tr>
<td align="left">DeliverMin</td> <td align="left">DeliverMin</td>
<td align="left"><a href="reference-rippled.html#specifying-currency-amounts">Currency Amount</a></td> <td align="left"><a href="reference-rippled.html#specifying-currency-amounts">Currency Amount</a></td>
<td align="left">Amount</td> <td align="left">Amount</td>
<td align="left">(Optional) Minimum amount of destination currency this transaction should deliver. Only valid if this is a <a href="#partial-payments">partial payment</a>. For non-XRP amounts, the nested field names are lower-case.</td> <td align="left"><em>(Optional)</em> Minimum amount of destination currency this transaction should deliver. Only valid if this is a <a href="#partial-payments">partial payment</a>. For non-XRP amounts, the nested field names are lower-case.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -1510,19 +1510,19 @@
<td align="left"><code>CancelAfter</code></td> <td align="left"><code>CancelAfter</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</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 earlier than this time but cannot remain open after this time.</td> <td align="left"><em>(Optional)</em> 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 earlier than this time but cannot remain open after this time.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>DestinationTag</code></td> <td align="left"><code>DestinationTag</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</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> <td align="left"><em>(Optional)</em> Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.</td>
</tr> </tr>
<tr> <tr>
<td align="left"><code>SourceTag</code></td> <td align="left"><code>SourceTag</code></td>
<td align="left">Number</td> <td align="left">Number</td>
<td align="left">UInt32</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> <td align="left"><em>(Optional)</em> Arbitrary tag to further specify the source for this payment channel, such as a hosted sender at the source address.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -1595,7 +1595,7 @@
<td align="left">RegularKey</td> <td align="left">RegularKey</td>
<td align="left">String</td> <td align="left">String</td>
<td align="left">AccountID</td> <td align="left">AccountID</td>
<td align="left">(Optional) A base-58-encoded <a href="reference-rippled.html#addresses">Ripple address</a> to use as the regular key. If omitted, removes the existing regular key.</td> <td align="left"><em>(Optional)</em> A base-58-encoded <a href="reference-rippled.html#addresses">Ripple address</a> to use as the regular key. If omitted, removes the existing regular key.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -1718,13 +1718,13 @@
<td align="left">QualityIn</td> <td align="left">QualityIn</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of <code>0</code> is shorthand for treating balances at face value.</td> <td align="left"><em>(Optional)</em> Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of <code>0</code> is shorthand for treating balances at face value.</td>
</tr> </tr>
<tr> <tr>
<td align="left">QualityOut</td> <td align="left">QualityOut</td>
<td align="left">Unsigned Integer</td> <td align="left">Unsigned Integer</td>
<td align="left">UInt32</td> <td align="left">UInt32</td>
<td align="left">(Optional) Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of <code>0</code> is shorthand for treating balances at face value.</td> <td align="left"><em>(Optional)</em> Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of <code>0</code> is shorthand for treating balances at face value.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>