Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PaymentChannelClaimFlagsInterface

Map of flags to boolean values representing PaymentChannelClaim transaction flags.

example
const paymentChannelClaim: PaymentChannelClaim = {
Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj,
TransactionType: 'PaymentChannelClaim',
Channel: hashes.hashPaymentChannel(
'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
'rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5',
21970712,
),
Amount: '100',
Flags: {
tfClose: true
}
}

// Autofill the tx to see how flags actually look compared to the interface usage.
const autofilledTx = await client.autofill(paymentChannelClaim)
console.log(autofilledTx)
// {
// Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
// TransactionType: 'PaymentChannelClaim',
// Channel: 'FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF',
// Amount: '100',
// Flags: 131072,
// Sequence: 21970713,
// Fee: '12',
// LastLedgerSequence: 21970658
// }

Hierarchy

  • GlobalFlags
    • PaymentChannelClaimFlagsInterface

Index

Properties

Properties

tfClose?: boolean

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 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 the source address.

tfRenew?: boolean

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.

Generated using TypeDoc