ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docstring: replace XRP with amounts

Browse Source
This commit is contained in:
Denis Angell
2023-02-15 15:26:05 -05:00
parent 00d4840501
commit 2d6ab38d33
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/xrpl/src/models/ledger/Escrow.ts
View File

@@ -3,7 +3,7 @@ import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry'
/**
* The Escrow object type represents a held payment of XRP waiting to be
* The Escrow object type represents a held payment waiting to be
* executed or canceled.
*
* @category Ledger Entries
@@ -12,12 +12,12 @@ export default interface Escrow extends BaseLedgerEntry {
LedgerEntryType: 'Escrow'
/**
* The address of the owner (sender) of this held payment. This is the
* account that provided the XRP, and gets it back if the held payment is
* account that provided the amounts, and gets it back if the held payment is
* canceled.
*/
Account: string
/**
* The destination address where the XRP is paid if the held payment is
* The destination address where the amounts are paid if the held payment is
* successful.
*/
Destination: string

10
packages/xrpl/src/models/ledger/PayChannel.ts
View File

@@ -2,8 +2,8 @@ import BaseLedgerEntry from './BaseLedgerEntry'
/**
* The PayChannel object type represents a payment channel. Payment channels
* enable small, rapid off-ledger payments of XRP that can be later reconciled
* with the consensus ledger. A payment channel holds a balance of XRP that can
* enable small, rapid off-ledger payments that can be later reconciled
* with the consensus ledger. A payment channel holds a balance that can
* only be paid out to a specific destination address until the channel is
* closed.
*
@@ -18,7 +18,7 @@ export default interface PayChannel extends BaseLedgerEntry {
Account: string
/**
* The destination address for this payment channel. While the payment
* channel is open, this address is the only one that can receive XRP from the
* channel is open, this address is the only one that can receive amounts from the
* channel. This comes from the Destination field of the transaction that
* created the channel.
*/
@@ -42,13 +42,13 @@ export default interface PayChannel extends BaseLedgerEntry {
* claims against this channel. This can be any valid secp256k1 or Ed25519
* public key. This is set by the transaction that created the channel and
* must match the public key used in claims against the channel. The channel
* source address can also send XRP from this channel to the destination
* source address can also send amounts from this channel to the destination
* without signed claims.
*/
PublicKey: string
/**
* Number of seconds the source address must wait to close the channel if
* it still has any XRP in it. Smaller values mean that the destination
* it still has any amount in it. Smaller values mean that the destination
* address has less time to redeem any outstanding claims after the source
* address requests to close the channel. Can be any value that fits in a
* 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that

2
packages/xrpl/src/models/transactions/paymentChannelClaim.ts
View File

@@ -98,7 +98,7 @@ export interface PaymentChannelClaimFlagsInterface extends GlobalFlags {
}
/**
* Claim XRP from a payment channel, adjust the payment channel's expiration,
* Claim amount from a payment channel, adjust the payment channel's expiration,
* or both.
*
* @category Transaction Models