fix: request model fields related to AMM (#2473)

* fix AuthAccount model

* fix AuctionSlot.Price field to be IssuedCurrencyAmount

* fix AMMBid BidMin & BidMan to IssuedCurrencyAmount

* update HISTORY
This commit is contained in:
Omar Khan
2023-09-11 17:18:03 -04:00
committed by GitHub
parent c1cf96ae43
commit f6f5f6b09a
6 changed files with 22 additions and 11 deletions

View File

@@ -3,6 +3,9 @@
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
## Fixed
* Fix request model fields related to AMM
## 2.11.0 (2023-08-24) ## 2.11.0 (2023-08-24)
### Added ### Added

View File

@@ -145,6 +145,6 @@ export interface NFToken {
export interface AuthAccount { export interface AuthAccount {
AuthAccount: { AuthAccount: {
account: string Account: string
} }
} }

View File

@@ -1,4 +1,4 @@
import { AuthAccount, Currency } from '../common' import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry' import BaseLedgerEntry from './BaseLedgerEntry'
@@ -53,7 +53,7 @@ export default interface AMM extends BaseLedgerEntry {
/** /**
* The amount the auction owner paid to win this slot, in LP Tokens. * The amount the auction owner paid to win this slot, in LP Tokens.
*/ */
Price: Currency Price: IssuedCurrencyAmount
} }
/** /**
* The total outstanding balance of liquidity provider tokens from this AMM instance. * The total outstanding balance of liquidity provider tokens from this AMM instance.

View File

@@ -98,7 +98,7 @@ export interface AMMInfoResponse extends BaseResponse {
* The amount, in LP Tokens, that the auction slot holder paid to win the auction slot. * The amount, in LP Tokens, that the auction slot holder paid to win the auction slot.
* This affects the price to outbid the current slot holder. * This affects the price to outbid the current slot holder.
*/ */
price: Amount price: IssuedCurrencyAmount
/** /**
* The current 72-minute time interval this auction slot is in, from 0 to 19. * The current 72-minute time interval this auction slot is in, from 0 to 19.

View File

@@ -1,6 +1,6 @@
/* eslint-disable complexity -- required for validateAMMBid */ /* eslint-disable complexity -- required for validateAMMBid */
import { ValidationError } from '../../errors' import { ValidationError } from '../../errors'
import { Amount, AuthAccount, Currency } from '../common' import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
import { import {
BaseTransaction, BaseTransaction,
@@ -33,18 +33,18 @@ export interface AMMBid extends BaseTransaction {
Asset2: Currency Asset2: Currency
/** /**
* Pay at least this amount for the slot. * Pay at least this LPToken amount for the slot.
* Setting this value higher makes it harder for others to outbid you. * Setting this value higher makes it harder for others to outbid you.
* If omitted, pay the minimum necessary to win the bid. * If omitted, pay the minimum necessary to win the bid.
*/ */
BidMin?: Amount BidMin?: IssuedCurrencyAmount
/** /**
* Pay at most this amount for the slot. * Pay at most this LPToken amount for the slot.
* If the cost to win the bid is higher than this amount, the transaction fails. * If the cost to win the bid is higher than this amount, the transaction fails.
* If omitted, pay as much as necessary to win the bid. * If omitted, pay as much as necessary to win the bid.
*/ */
BidMax?: Amount BidMax?: IssuedCurrencyAmount
/** /**
* A list of up to 4 additional accounts that you allow to trade at the discounted fee. * A list of up to 4 additional accounts that you allow to trade at the discounted fee.

View File

@@ -22,8 +22,16 @@ describe('AMMBid', function () {
currency: 'ETH', currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd', issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
}, },
BidMin: '5', BidMin: {
BidMax: '10', currency: '039C99CD9AB0B70B32ECDA51EAAE471625608EA2',
issuer: 'rE54zDvgnghAoPopCgvtiqWNq3dU5y836S',
value: '50',
},
BidMax: {
currency: '039C99CD9AB0B70B32ECDA51EAAE471625608EA2',
issuer: 'rE54zDvgnghAoPopCgvtiqWNq3dU5y836S',
value: '100',
},
AuthAccounts: [ AuthAccounts: [
{ {
AuthAccount: { AuthAccount: {