From 147f7be7f66f7b357db04e2a1d9ffe52485338f7 Mon Sep 17 00:00:00 2001 From: Denis Angell Date: Tue, 14 Feb 2023 19:40:18 -0500 Subject: [PATCH] remove `XRP` references to amount --- .../xrpl/src/models/transactions/escrowCancel.ts | 2 +- .../xrpl/src/models/transactions/escrowCreate.ts | 6 +++--- .../xrpl/src/models/transactions/escrowFinish.ts | 2 +- .../src/models/transactions/paymentChannelClaim.ts | 12 ++++++------ .../src/models/transactions/paymentChannelCreate.ts | 6 +++--- .../src/models/transactions/paymentChannelFund.ts | 7 +++---- 6 files changed, 17 insertions(+), 18 deletions(-) diff --git a/packages/xrpl/src/models/transactions/escrowCancel.ts b/packages/xrpl/src/models/transactions/escrowCancel.ts index 573d504f..91863913 100644 --- a/packages/xrpl/src/models/transactions/escrowCancel.ts +++ b/packages/xrpl/src/models/transactions/escrowCancel.ts @@ -3,7 +3,7 @@ import { ValidationError } from '../../errors' import { BaseTransaction, validateBaseTransaction } from './common' /** - * Return escrowed XRP to the sender. + * Return escrowed amount to the sender. * * @category Transaction Models */ diff --git a/packages/xrpl/src/models/transactions/escrowCreate.ts b/packages/xrpl/src/models/transactions/escrowCreate.ts index 60971d46..90801c75 100644 --- a/packages/xrpl/src/models/transactions/escrowCreate.ts +++ b/packages/xrpl/src/models/transactions/escrowCreate.ts @@ -5,7 +5,7 @@ import { Amount } from '../common' import { BaseTransaction, validateBaseTransaction } from './common' /** - * Sequester XRP until the escrow process either finishes or is canceled. + * Sequester amount until the escrow process either finishes or is canceled. * * @category Transaction Models */ @@ -17,7 +17,7 @@ export interface EscrowCreate extends BaseTransaction { * or returned to the sender (after the CancelAfter time). */ Amount: Amount - /** Address to receive escrowed XRP. */ + /** Address to receive escrowed amount. */ Destination: string /** * The time, in seconds since the Ripple Epoch, when this escrow expires. @@ -26,7 +26,7 @@ export interface EscrowCreate extends BaseTransaction { */ CancelAfter?: number /** - * The time, in seconds since the Ripple Epoch, when the escrowed XRP can be + * The time, in seconds since the Ripple Epoch, when the escrowed amount can be * released to the recipient. This value is immutable; the funds cannot move. * until this time is reached. */ diff --git a/packages/xrpl/src/models/transactions/escrowFinish.ts b/packages/xrpl/src/models/transactions/escrowFinish.ts index 7a362018..1382402c 100644 --- a/packages/xrpl/src/models/transactions/escrowFinish.ts +++ b/packages/xrpl/src/models/transactions/escrowFinish.ts @@ -3,7 +3,7 @@ import { ValidationError } from '../../errors' import { BaseTransaction, validateBaseTransaction } from './common' /** - * Deliver XRP from a held payment to the recipient. + * Deliver amount from a held payment to the recipient. * * @category Transaction Models */ diff --git a/packages/xrpl/src/models/transactions/paymentChannelClaim.ts b/packages/xrpl/src/models/transactions/paymentChannelClaim.ts index c456d5ef..6b25a967 100644 --- a/packages/xrpl/src/models/transactions/paymentChannelClaim.ts +++ b/packages/xrpl/src/models/transactions/paymentChannelClaim.ts @@ -24,14 +24,14 @@ export enum PaymentChannelClaimFlags { /** * 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 + * has no more funds 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 + * the channel still holds an amount, this schedules the channel to close after * SettleDelay seconds have passed. (Specifically, this 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 an earlier Expiration * time.) If the destination address uses this flag when the channel still - * holds XRP, any XRP that remains after processing the claim is returned to + * holds an amount, any amount that remains after processing the claim is returned to * the source address. */ tfClose = 0x00020000, @@ -84,14 +84,14 @@ export interface PaymentChannelClaimFlagsInterface extends GlobalFlags { /** * 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 + * has no more funds 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 + * the channel still holds an amount, this schedules the channel to close after * SettleDelay seconds have passed. (Specifically, this 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 an earlier Expiration * time.) If the destination address uses this flag when the channel still - * holds XRP, any XRP that remains after processing the claim is returned to + * holds an amount, any amount that remains after processing the claim is returned to * the source address. */ tfClose?: boolean diff --git a/packages/xrpl/src/models/transactions/paymentChannelCreate.ts b/packages/xrpl/src/models/transactions/paymentChannelCreate.ts index 6625236a..c4f2070f 100644 --- a/packages/xrpl/src/models/transactions/paymentChannelCreate.ts +++ b/packages/xrpl/src/models/transactions/paymentChannelCreate.ts @@ -5,7 +5,7 @@ import { Amount } from '../common' import { BaseTransaction, validateBaseTransaction, isAmount } from './common' /** - * Create a unidirectional channel and fund it with XRP. The address sending + * Create a unidirectional channel and fund it. The address sending * this transaction becomes the "source address" of the payment channel. * * @category Transaction Models @@ -20,13 +20,13 @@ export interface PaymentChannelCreate extends BaseTransaction { */ Amount: Amount /** - * Address to receive XRP claims against this channel. This is also known as + * Address to receive claims against this channel. This is also known as * the "destination address" for the channel. */ Destination: string /** * Amount of time the source address must wait before closing the channel if - * it has unclaimed XRP. + * it has unclaimed amount. */ SettleDelay: number /** diff --git a/packages/xrpl/src/models/transactions/paymentChannelFund.ts b/packages/xrpl/src/models/transactions/paymentChannelFund.ts index aa6ca31d..1f835c46 100644 --- a/packages/xrpl/src/models/transactions/paymentChannelFund.ts +++ b/packages/xrpl/src/models/transactions/paymentChannelFund.ts @@ -4,7 +4,7 @@ import { Amount } from '../common' import { BaseTransaction, validateBaseTransaction, isAmount } from './common' /** - * Add additional XRP to an open payment channel, and optionally update the + * Add additional amount to an open payment channel, and optionally update the * expiration time of the channel. Only the source address of the channel can * use this transaction. * @@ -18,8 +18,7 @@ export interface PaymentChannelFund extends BaseTransaction { */ Channel: string /** - * Amount of XRP in drops to add to the channel. Must be a positive amount - * of XRP. + * Amount to add to the channel. Must be a positive amount */ Amount: Amount /** @@ -27,7 +26,7 @@ export interface PaymentChannelFund extends BaseTransaction { * Epoch. This must be later than either the current time plus the SettleDelay * of the channel, or the existing Expiration of the channel. After the * Expiration time, any transaction that would access the channel closes the - * channel without taking its normal action. Any unspent XRP is returned to + * channel without taking its normal action. Any unspent amount is returned to * the source address when the channel closes. (Expiration is separate from * the channel's immutable CancelAfter time.) For more information, see the * PayChannel ledger object type.