mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-01 09:35:48 +00:00
refactor: Reimplement sugar functions and clean up (#1559)
* refactor: Reimplement sugar functions and clean up
This commit is contained in:
Mukul Jangid
committed by
Mayukha Vadari
Mayukha Vadari
parent
603b7ae85c
commit
fd78d1edcd
@@ -1,18 +1,18 @@
|
||||
import { assert } from 'chai'
|
||||
// import BigNumber from "bignumber.js";
|
||||
// import { assert } from "chai";
|
||||
|
||||
import { BookOffersRequest } from '../../src'
|
||||
import requests from '../fixtures/requests'
|
||||
import responses from '../fixtures/responses'
|
||||
import rippled from '../fixtures/rippled'
|
||||
import { setupClient, teardownClient } from '../setupClient'
|
||||
import { addressTests, assertResultMatch, assertRejects } from '../testUtils'
|
||||
// import BigNumber from 'bignumber.js'
|
||||
import { addressTests, assertResultMatch } from '../testUtils'
|
||||
|
||||
// function checkSortingOfOrders(orders) {
|
||||
// let previousRate = '0'
|
||||
// for (var i = 0; i < orders.length; i++) {
|
||||
// const order = orders[i]
|
||||
// let rate
|
||||
// let previousRate = "0";
|
||||
// for (let i = 0; i < orders.length; i++) {
|
||||
// const order = orders[i];
|
||||
// let rate;
|
||||
|
||||
// // We calculate the quality of output/input here as a test.
|
||||
// // This won't hold in general because when output and input amounts get tiny,
|
||||
@@ -21,25 +21,22 @@ import { addressTests, assertResultMatch, assertRejects } from '../testUtils'
|
||||
// // to check the quality from the offer book, but for the test data set,
|
||||
// // this calculation holds.
|
||||
|
||||
// if (order.specification.direction === 'buy') {
|
||||
// if (order.specification.direction === "buy") {
|
||||
// rate = new BigNumber(order.specification.quantity.value)
|
||||
// .dividedBy(order.specification.totalPrice.value)
|
||||
// .toString()
|
||||
// .toString();
|
||||
// } else {
|
||||
// rate = new BigNumber(order.specification.totalPrice.value)
|
||||
// .dividedBy(order.specification.quantity.value)
|
||||
// .toString()
|
||||
// .toString();
|
||||
// }
|
||||
// assert(
|
||||
// new BigNumber(rate).isGreaterThanOrEqualTo(previousRate),
|
||||
// 'Rates must be sorted from least to greatest: ' +
|
||||
// rate +
|
||||
// ' should be >= ' +
|
||||
// previousRate
|
||||
// )
|
||||
// previousRate = rate
|
||||
// `Rates must be sorted from least to greatest: ${rate} should be >= ${previousRate}`
|
||||
// );
|
||||
// previousRate = rate;
|
||||
// }
|
||||
// return true
|
||||
// return true;
|
||||
// }
|
||||
|
||||
function isUSD(currency: string) {
|
||||
@@ -72,15 +69,15 @@ function normalRippledResponse(request: BookOffersRequest): object {
|
||||
throw new Error('unexpected end')
|
||||
}
|
||||
|
||||
function xrpRippledResponse(request: BookOffersRequest): object {
|
||||
if (request.taker_pays.issuer === 'rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw') {
|
||||
return rippled.book_offers.xrp_usd
|
||||
}
|
||||
if (request.taker_gets.issuer === 'rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw') {
|
||||
return rippled.book_offers.usd_xrp
|
||||
}
|
||||
throw new Error('unexpected end')
|
||||
}
|
||||
// function xrpRippledResponse(request: BookOffersRequest): object {
|
||||
// if (request.taker_pays.issuer === "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw") {
|
||||
// return rippled.book_offers.xrp_usd;
|
||||
// }
|
||||
// if (request.taker_gets.issuer === "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw") {
|
||||
// return rippled.book_offers.usd_xrp;
|
||||
// }
|
||||
// throw new Error("unexpected end");
|
||||
// }
|
||||
|
||||
describe('client.getOrderbook', function () {
|
||||
beforeEach(setupClient)
|
||||
@@ -91,9 +88,11 @@ describe('client.getOrderbook', function () {
|
||||
it('normal', async function () {
|
||||
this.mockRippled.addResponse('book_offers', normalRippledResponse)
|
||||
const response = await this.client.getOrderbook(
|
||||
test.address,
|
||||
requests.getOrderbook.normal,
|
||||
{ limit: 20 },
|
||||
requests.getOrderbook.normal.taker_pays,
|
||||
requests.getOrderbook.normal.taker_gets,
|
||||
{
|
||||
limit: 1,
|
||||
},
|
||||
)
|
||||
assertResultMatch(
|
||||
response,
|
||||
@@ -102,28 +101,28 @@ describe('client.getOrderbook', function () {
|
||||
)
|
||||
})
|
||||
|
||||
it('invalid options', async function () {
|
||||
this.mockRippled.addResponse('book_offers', normalRippledResponse)
|
||||
assertRejects(
|
||||
this.client.getOrderbook(test.address, requests.getOrderbook.normal, {
|
||||
invalid: 'options',
|
||||
}),
|
||||
this.client.errors.ValidationError,
|
||||
)
|
||||
})
|
||||
// it("invalid options", async function () {
|
||||
// this.mockRippled.addResponse("book_offers", normalRippledResponse);
|
||||
// assertRejects(
|
||||
// this.client.getOrderbook(test.address, requests.getOrderbook.normal, {
|
||||
// invalid: "options",
|
||||
// }),
|
||||
// this.client.errors.ValidationError
|
||||
// );
|
||||
// });
|
||||
|
||||
it('with XRP', async function () {
|
||||
this.mockRippled.addResponse('book_offers', xrpRippledResponse)
|
||||
const response = await this.client.getOrderbook(
|
||||
test.address,
|
||||
requests.getOrderbook.withXRP,
|
||||
)
|
||||
assertResultMatch(
|
||||
response,
|
||||
responses.getOrderbook.withXRP,
|
||||
'getOrderbook',
|
||||
)
|
||||
})
|
||||
// it("with XRP", async function () {
|
||||
// this.mockRippled.addResponse("book_offers", xrpRippledResponse);
|
||||
// const response = await this.client.getOrderbook(
|
||||
// test.address,
|
||||
// requests.getOrderbook.withXRP
|
||||
// );
|
||||
// assertResultMatch(
|
||||
// response,
|
||||
// responses.getOrderbook.withXRP,
|
||||
// "getOrderbook"
|
||||
// );
|
||||
// });
|
||||
|
||||
// 'sample XRP/JPY book has orders sorted correctly', async function () {
|
||||
// const orderbookInfo = {
|
||||
@@ -157,61 +156,61 @@ describe('client.getOrderbook', function () {
|
||||
// },
|
||||
|
||||
// WARNING: This test fails to catch the sorting bug, issue #766
|
||||
it('sorted so that best deals come first [bad test]', async function () {
|
||||
this.mockRippled.addResponse('book_offers', normalRippledResponse)
|
||||
const response = await this.client.getOrderbook(
|
||||
test.address,
|
||||
requests.getOrderbook.normal,
|
||||
)
|
||||
const bidRates = response.bids.map(
|
||||
(bid) => bid.properties.makerExchangeRate,
|
||||
)
|
||||
const askRates = response.asks.map(
|
||||
(ask) => ask.properties.makerExchangeRate,
|
||||
)
|
||||
// makerExchangeRate = quality = takerPays.value/takerGets.value
|
||||
// so the best deal for the taker is the lowest makerExchangeRate
|
||||
// bids and asks should be sorted so that the best deals come first
|
||||
assert.deepEqual(
|
||||
bidRates.sort((x) => Number(x)),
|
||||
bidRates,
|
||||
)
|
||||
assert.deepEqual(
|
||||
askRates.sort((x) => Number(x)),
|
||||
askRates,
|
||||
)
|
||||
})
|
||||
// it("sorted so that best deals come first [bad test]", async function () {
|
||||
// this.mockRippled.addResponse("book_offers", normalRippledResponse);
|
||||
// const response = await this.client.getOrderbook(
|
||||
// test.address,
|
||||
// requests.getOrderbook.normal
|
||||
// );
|
||||
// const bidRates = response.bids.map(
|
||||
// (bid) => bid.properties.makerExchangeRate
|
||||
// );
|
||||
// const askRates = response.asks.map(
|
||||
// (ask) => ask.properties.makerExchangeRate
|
||||
// );
|
||||
// // makerExchangeRate = quality = takerPays.value/takerGets.value
|
||||
// // so the best deal for the taker is the lowest makerExchangeRate
|
||||
// // bids and asks should be sorted so that the best deals come first
|
||||
// assert.deepEqual(
|
||||
// bidRates.sort((x) => Number(x)),
|
||||
// bidRates
|
||||
// );
|
||||
// assert.deepEqual(
|
||||
// askRates.sort((x) => Number(x)),
|
||||
// askRates
|
||||
// );
|
||||
// });
|
||||
|
||||
it('currency & counterparty are correct', async function () {
|
||||
this.mockRippled.addResponse('book_offers', normalRippledResponse)
|
||||
const response = await this.client.getOrderbook(
|
||||
test.address,
|
||||
requests.getOrderbook.normal,
|
||||
)
|
||||
;[...response.bids, ...response.asks].forEach((order) => {
|
||||
const quantity = order.specification.quantity
|
||||
const totalPrice = order.specification.totalPrice
|
||||
const { base, counter } = requests.getOrderbook.normal
|
||||
assert.strictEqual(quantity.currency, base.currency)
|
||||
assert.strictEqual(quantity.counterparty, base.counterparty)
|
||||
assert.strictEqual(totalPrice.currency, counter.currency)
|
||||
assert.strictEqual(totalPrice.counterparty, counter.counterparty)
|
||||
})
|
||||
})
|
||||
// it("currency & counterparty are correct", async function () {
|
||||
// this.mockRippled.addResponse("book_offers", normalRippledResponse);
|
||||
// const response = await this.client.getOrderbook(
|
||||
// test.address,
|
||||
// requests.getOrderbook.normal
|
||||
// );
|
||||
// [...response.bids, ...response.asks].forEach((order) => {
|
||||
// const quantity = order.specification.quantity;
|
||||
// const totalPrice = order.specification.totalPrice;
|
||||
// const { base, counter } = requests.getOrderbook.normal;
|
||||
// assert.strictEqual(quantity.currency, base.currency);
|
||||
// assert.strictEqual(quantity.counterparty, base.counterparty);
|
||||
// assert.strictEqual(totalPrice.currency, counter.currency);
|
||||
// assert.strictEqual(totalPrice.counterparty, counter.counterparty);
|
||||
// });
|
||||
// });
|
||||
|
||||
it('direction is correct for bids and asks', async function () {
|
||||
this.mockRippled.addResponse('book_offers', normalRippledResponse)
|
||||
const response = await this.client.getOrderbook(
|
||||
test.address,
|
||||
requests.getOrderbook.normal,
|
||||
)
|
||||
assert(
|
||||
response.bids.every((bid) => bid.specification.direction === 'buy'),
|
||||
)
|
||||
assert(
|
||||
response.asks.every((ask) => ask.specification.direction === 'sell'),
|
||||
)
|
||||
})
|
||||
// it("direction is correct for bids and asks", async function () {
|
||||
// this.mockRippled.addResponse("book_offers", normalRippledResponse);
|
||||
// const response = await this.client.getOrderbook(
|
||||
// test.address,
|
||||
// requests.getOrderbook.normal
|
||||
// );
|
||||
// assert(
|
||||
// response.bids.every((bid) => bid.specification.direction === "buy")
|
||||
// );
|
||||
// assert(
|
||||
// response.asks.every((ask) => ask.specification.direction === "sell")
|
||||
// );
|
||||
// });
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user