rectify the flag name tfNoRippleDirect (#2647)

* rectify the flag name tfNoRippleDirect

* Update th History.md file

* use "Breaking Changes" heading in the API Changelog

* Update HISTORY.md

---------
This commit is contained in:
Chenna Keshava B S
2024-04-02 11:54:02 -07:00
committed by GitHub
parent 445a05e6ef
commit dbdb35abb5
3 changed files with 5 additions and 3 deletions

View File

@@ -3,6 +3,8 @@
Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements. We recommend that xrpl.js (ripple-lib) users stay up-to-date with the latest stable release. Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements. We recommend that xrpl.js (ripple-lib) users stay up-to-date with the latest stable release.
## Unreleased ## Unreleased
### BREAKING CHANGES
* Small fix in the API to use a new flag name `tfNoDirectRipple` instead of the existing flag name `tfNoRippleDirect`
### Fixed ### Fixed
* Typo in `Channel` type `source_tab` -> `source_tag` * Typo in `Channel` type `source_tab` -> `source_tag`

View File

@@ -26,7 +26,7 @@ export enum PaymentFlags {
* This is intended to force the transaction to take arbitrage opportunities. * This is intended to force the transaction to take arbitrage opportunities.
* Most clients do not need this. * Most clients do not need this.
*/ */
tfNoDirectRipple = 0x00010000, tfNoRippleDirect = 0x00010000,
/** /**
* If the specified Amount cannot be sent without spending more than SendMax, * If the specified Amount cannot be sent without spending more than SendMax,
* reduce the received amount instead of failing outright. See Partial. * reduce the received amount instead of failing outright. See Partial.
@@ -88,7 +88,7 @@ export interface PaymentFlagsInterface extends GlobalFlags {
* This is intended to force the transaction to take arbitrage opportunities. * This is intended to force the transaction to take arbitrage opportunities.
* Most clients do not need this. * Most clients do not need this.
*/ */
tfNoDirectRipple?: boolean tfNoRippleDirect?: boolean
/** /**
* If the specified Amount cannot be sent without spending more than SendMax, * If the specified Amount cannot be sent without spending more than SendMax,
* reduce the received amount instead of failing outright. See Partial. * reduce the received amount instead of failing outright. See Partial.

View File

@@ -100,7 +100,7 @@ describe('Models Utils', function () {
Amount: '1234', Amount: '1234',
Destination: 'rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy', Destination: 'rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy',
Flags: { Flags: {
tfNoDirectRipple: false, tfNoRippleDirect: false,
tfPartialPayment: true, tfPartialPayment: true,
tfLimitQuality: true, tfLimitQuality: true,
}, },