mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-27 15:45:48 +00:00
update docstrings
This commit is contained in:
@@ -21,7 +21,7 @@ export default interface Escrow extends BaseLedgerEntry {
|
|||||||
* successful.
|
* successful.
|
||||||
*/
|
*/
|
||||||
Destination: string
|
Destination: string
|
||||||
/** The amount of XRP/FT, as drops/Amount, to be delivered by the held payment. */
|
/** The amount to be delivered by the held payment. */
|
||||||
Amount: Amount
|
Amount: Amount
|
||||||
/**
|
/**
|
||||||
* A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
|
* A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
|
||||||
|
|||||||
@@ -17,25 +17,24 @@ export default interface PayChannel extends BaseLedgerEntry {
|
|||||||
*/
|
*/
|
||||||
Account: string
|
Account: string
|
||||||
/**
|
/**
|
||||||
* Total XRP/FT, as drops/Amount, that has been allocated to this channel.
|
* The destination address for this payment channel. While the payment
|
||||||
* This includes XRP/FT that has been paid to the destination address.
|
* channel is open, this address is the only one that can receive XRP from the
|
||||||
* This is initially set by the transaction that created the channel and can
|
* channel. This comes from the Destination field of the transaction that
|
||||||
* be increased if the source address sends a PaymentChannelFund transaction.
|
* created the channel.
|
||||||
*/
|
*/
|
||||||
Destination: string
|
Destination: string
|
||||||
/**
|
/**
|
||||||
* Total XRP, in drops, that has been allocated to this channel. This
|
* Total that has been allocated to this channel. This includes amounts that
|
||||||
* includes XRP that has been paid to the destination address. This is
|
* has been paid to the destination address. This is initially set by the
|
||||||
* initially set by the transaction that created the channel and can be
|
* transaction that created the channel and can be increased if the source
|
||||||
* increased if the source address sends a PaymentChannelFund transaction.
|
* address sends a PaymentChannelFund transaction.
|
||||||
*/
|
*/
|
||||||
Amount: string
|
Amount: string
|
||||||
/**
|
/**
|
||||||
* Total XRP/FT, as drops/Amount, already paid out by the channel. The
|
* Total already paid out by the channel. The difference between this value and
|
||||||
* difference between this value and the Amount field is how much XRP/FT
|
* the Amount field is how much can still be paid to the destination address
|
||||||
* can still be paid to the destination address with PaymentChannelClaim
|
* with PaymentChannelClaim transactions. If the channel closes, the remaining
|
||||||
* transactions. If the channel closes, the remaining difference is returned
|
* difference is returned to the source address.
|
||||||
* to the source address.
|
|
||||||
*/
|
*/
|
||||||
Balance: string
|
Balance: string
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import { BaseRequest, BaseResponse } from './baseMethod'
|
|||||||
*/
|
*/
|
||||||
export interface ChannelVerifyRequest extends BaseRequest {
|
export interface ChannelVerifyRequest extends BaseRequest {
|
||||||
command: 'channel_verify'
|
command: 'channel_verify'
|
||||||
/** The amount of XRP, in drops, the provided signature authorizes. */
|
/** The amount the provided signature authorizes. */
|
||||||
amount: string
|
amount: string
|
||||||
/**
|
/**
|
||||||
* The Channel ID of the channel that provides the XRP. This is a
|
* The Channel ID of the channel that provides the XRP. This is a
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ import { BaseTransaction, validateBaseTransaction } from './common'
|
|||||||
export interface EscrowCreate extends BaseTransaction {
|
export interface EscrowCreate extends BaseTransaction {
|
||||||
TransactionType: 'EscrowCreate'
|
TransactionType: 'EscrowCreate'
|
||||||
/**
|
/**
|
||||||
* Amount of XRP, in drops, to deduct from the sender's balance and escrow.
|
* Amount to deduct from the sender's balance and escrow. Once escrowed, the
|
||||||
* Once escrowed, the XRP can either go to the Destination address (after the.
|
* amount can either go to the Destination address (after the FinishAfter time)
|
||||||
* FinishAfter time) or returned to the sender (after the CancelAfter time).
|
* or returned to the sender (after the CancelAfter time).
|
||||||
*/
|
*/
|
||||||
Amount: Amount
|
Amount: Amount
|
||||||
/** Address to receive escrowed XRP. */
|
/** Address to receive escrowed XRP. */
|
||||||
|
|||||||
@@ -109,16 +109,16 @@ export interface PaymentChannelClaim extends BaseTransaction {
|
|||||||
/** The unique ID of the channel as a 64-character hexadecimal string. */
|
/** The unique ID of the channel as a 64-character hexadecimal string. */
|
||||||
Channel: string
|
Channel: string
|
||||||
/**
|
/**
|
||||||
* Total amount of XRP, in drops, delivered by this channel after processing
|
* Total amount delivered by this channel after processing this claim. Required
|
||||||
* this claim. Required to deliver XRP. Must be more than the total amount
|
* to deliver amount. Must be more than the total amount delivered by the channel
|
||||||
* delivered by the channel so far, but not greater than the Amount of the
|
* so far, but not greater than the Amount of the signed claim. Must be provided
|
||||||
* signed claim. Must be provided except when closing the channel.
|
* except when closing the channel.
|
||||||
*/
|
*/
|
||||||
Balance?: Amount
|
Balance?: Amount
|
||||||
/**
|
/**
|
||||||
* The amount of XRP, in drops, authorized by the Signature. This must match
|
* The amount authorized by the Signature. This must match the amount in the
|
||||||
* the amount in the signed message. This is the cumulative amount of XRP that
|
* signed message. This is the cumulative amount that can be dispensed by the
|
||||||
* can be dispensed by the channel, including XRP previously redeemed.
|
* channel, including amounts previously redeemed.
|
||||||
*/
|
*/
|
||||||
Amount?: Amount
|
Amount?: Amount
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
|
|||||||
export interface PaymentChannelCreate extends BaseTransaction {
|
export interface PaymentChannelCreate extends BaseTransaction {
|
||||||
TransactionType: 'PaymentChannelCreate'
|
TransactionType: 'PaymentChannelCreate'
|
||||||
/**
|
/**
|
||||||
* Amount of XRP, in drops, to deduct from the sender's balance and set aside
|
* Amount to deduct from the sender's balance and set aside in this channel.
|
||||||
* in this channel. While the channel is open, the XRP can only go to the
|
* While the channel is open, the amount can only go to the Destination
|
||||||
* Destination address. When the channel closes, any unclaimed XRP is returned
|
* address. When the channel closes, any unclaimed amount is returned to
|
||||||
* to the source address's balance.
|
* the source address's balance.
|
||||||
*/
|
*/
|
||||||
Amount: Amount
|
Amount: Amount
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user