ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-19 19:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: use chai instead of assert-diff (#1570)

Browse Source 
* assert-diff -> chai

* fix tests

* remove package

* fix rebase
This commit is contained in:
Mayukha Vadari
2021-08-27 00:12:08 -04:00
parent 8b95ee5fab
commit 759e075e54
34 changed files with 106 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
package.json
View File

@@ -42,7 +42,6 @@
"@typescript-eslint/parser": "^3.7.0",
"@xrplf/eslint-config": "^1.1.0",
"assert": "^2.0.0",
"assert-diff": "^3.0.0",
"buffer": "^6.0.2",
"chai": "^4.3.4",
"crypto-browserify": "^3.12.0",

8
test/backoff.ts
View File

@@ -1,13 +1,13 @@
import assert from "assert-diff";
import { assert } from "chai";
import { ExponentialBackoff } from "../src/client/backoff";
describe("ExponentialBackoff", function () {
it("duration() return value starts with the min value", function () {
// default: 100ms
assert(new ExponentialBackoff().duration(), 100);
assert(new ExponentialBackoff({ min: 100 }).duration(), 100);
assert(new ExponentialBackoff({ min: 123 }).duration(), 123);
assert.equal(new ExponentialBackoff().duration(), 100);
assert.equal(new ExponentialBackoff({ min: 100 }).duration(), 100);
assert.equal(new ExponentialBackoff({ min: 123 }).duration(), 123);
});
it("duration() return value increases when called multiple times", function () {

2
test/broadcastClient.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import _ from "lodash";
import responses from "./fixtures/responses";

2
test/client/combine.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import binary from "ripple-binary-codec";
import requests from "../fixtures/requests";

2
test/client/constructor.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { Client } from "xrpl-local";

2
test/client/deriveXAddress.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { Client } from "../../src";
import { TestSuite } from "../testUtils";

2
test/client/errors.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { TestSuite } from "../testUtils";

2
test/client/formatBidsAndAsks.ts
View File

@@ -1,5 +1,5 @@
// import BigNumber from 'bignumber.js'
// import assert from 'assert-diff'
// import {assert} from 'chai'
// import {Client} from 'xrpl-local'
// import requests from '../fixtures/requests'
// import responses from '../fixtures/responses'

2
test/client/getFee.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import rippled from "../fixtures/rippled";
import { TestSuite } from "../testUtils";

8
test/client/getOrderbook.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { BookOffersRequest } from "../../src";
import requests from "../fixtures/requests";
@@ -68,8 +68,7 @@ function normalRippledResponse(request: BookOffersRequest): object {
) {
return rippled.book_offers.fabric.requestBookOffersAsksResponse(request);
}
return {};
throw new Error("unexpected end");
}
function xrpRippledResponse(request: BookOffersRequest): object {
@@ -79,8 +78,7 @@ function xrpRippledResponse(request: BookOffersRequest): object {
if (request.taker_gets.issuer === "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw") {
return rippled.book_offers.usd_xrp;
}
return {};
throw new Error("unexpected end");
}
/**

2
test/client/getPaths.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import addresses from "../fixtures/addresses.json";
import requests from "../fixtures/requests";

2
test/client/hasNextPage.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import rippled from "../fixtures/rippled";
import { TestSuite } from "../testUtils";

2
test/client/isConnected.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { TestSuite } from "../testUtils";

2
test/client/isValidAddress.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import addresses from "../fixtures/addresses.json";
import { TestSuite } from "../testUtils";

2
test/client/isValidSecret.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { TestSuite } from "../testUtils";

117
test/client/preparePayment.ts
View File

@@ -1,8 +1,13 @@
import { ValidationError } from "../../src/common/errors";
import { assert } from "chai";
import binary from "ripple-binary-codec";
import { ValidationError } from "xrpl-local/common/errors";
import * as schemaValidator from "xrpl-local/common/schema-validator";
import requests from "../fixtures/requests";
import responses from "../fixtures/responses";
import rippled from "../fixtures/rippled";
import { assertRejects, assertResultMatch, TestSuite } from "../testUtils";
import { assertResultMatch, TestSuite, assertRejects } from "../testUtils";
const instructionsWithMaxLedgerVersionOffset = { maxLedgerVersionOffset: 100 };
const { preparePayment: REQUEST_FIXTURES } = requests;
@@ -501,58 +506,68 @@ export default <TestSuite>{
assertResultMatch(response, RESPONSE_FIXTURES.noCounterparty, "prepare");
},
// 'preparePayment with source.amount/destination.minAmount can be signed':
// async (client, address, mockRippled) => {
// mockRippled.addResponse(
// {command: 'server_info'},
// rippled.server_info.normal
// )
// mockRippled.addResponse({command: 'fee'}, rippled.fee)
// mockRippled.addResponse(
// {command: 'ledger_current'},
// rippled.ledger_current
// )
// mockRippled.addResponse(
// {command: 'account_info'},
// rippled.account_info.normal
// )
// // See also: 'sign succeeds with source.amount/destination.minAmount'
"preparePayment with source.amount/destination.minAmount can be signed":
async (client, address, mockRippled) => {
mockRippled.addResponse(
{ command: "server_info" },
rippled.server_info.normal
);
mockRippled.addResponse({ command: "fee" }, rippled.fee);
mockRippled.addResponse(
{ command: "ledger_current" },
rippled.ledger_current
);
mockRippled.addResponse(
{ command: "account_info" },
rippled.account_info.normal
);
// See also: 'sign succeeds with source.amount/destination.minAmount'
// const localInstructions = {
// ...instructionsWithMaxLedgerVersionOffset,
// sequence: 23
// }
const localInstructions = {
...instructionsWithMaxLedgerVersionOffset,
sequence: 23,
};
const response = await client.preparePayment(
address,
{
source: {
address,
amount: {
currency: "GBP",
value: "0.1",
counterparty: "rpat5TmYjDsnFSStmgTumFgXCM9eqsWPro",
},
},
destination: {
address: "rEX4LtGJubaUcMWCJULcy4NVxGT9ZEMVRq",
minAmount: {
currency: "USD",
value: "0.1248548562296331",
counterparty: "rMaa8VLBTjwTJWA2kSme4Sqgphhr6Lr6FH",
},
},
},
localInstructions
);
// const response = await client.preparePayment(address, {
// source: {
// address,
// amount: {
// currency: 'GBP',
// value: '0.1',
// counterparty: 'rpat5TmYjDsnFSStmgTumFgXCM9eqsWPro'
// }
// },
// localInstructions
// })
// Important: check that the prepared transaction can actually be signed
// https://github.com/ripple/ripple-lib/issues/1237#issuecomment-631670946
// // Important: check that the prepared transaction can actually be signed
// // https://github.com/ripple/ripple-lib/issues/1237#issuecomment-631670946
// const secret = 'shotKgaEotpcYsshSE39vmSnBDRim'
// const result = client.sign(response.txJSON, secret)
// const expectedResult = {
// signedTransaction:
// '12000022800200002400000017201B0086955361EC6386F26FC0FFFF0000000000000000000000005553440000000000DC596C88BCDE4E818D416FCDEEBF2C8656BADC9A68400000000000000C69D4438D7EA4C6800000000000000000000000000047425000000000000C155FFE99C8C91F67083CEFFDB69EBFE76348CA6AD4446F8C5D8A5E0B0000000000000000000000005553440000000000DC596C88BCDE4E818D416FCDEEBF2C8656BADC9A7321022B05847086686F9D0499B13136B94AD4323EE1B67D4C429ECC987AB35ACFA34574473045022100D9634523D8E232D4A7807A71856023D82AC928FA29848571B820867898413B5F022041AC00EC1F81A26A6504EBF844A38CC3204694EF2CC1A97A87632721631F93DA81145E7B112523F68D2F5E879DB4EAC51C6698A6930483149F500E50C2F016CA01945E5A1E5846B61EF2D376',
// id: '1C558AA9B926C24FB6BBD6950B2DB1350A83F9F12E4385208867907019761A2D'
// }
// const decoded = decode(result.signedTransaction)
// assert(
// decoded.Flags === 2147614720,
// `Flags = ${decoded.Flags}, should be 2147614720`
// )
// assert.deepEqual(result, expectedResult)
// schemaValidator.schemaValidate('sign', result)
// },
const secret = "shotKgaEotpcYsshSE39vmSnBDRim";
const result = client.sign(response.txJSON, secret);
const expectedResult = {
signedTransaction:
"12000022800200002400000017201B0086955361EC6386F26FC0FFFF0000000000000000000000005553440000000000DC596C88BCDE4E818D416FCDEEBF2C8656BADC9A68400000000000000C69D4438D7EA4C6800000000000000000000000000047425000000000000C155FFE99C8C91F67083CEFFDB69EBFE76348CA6AD4446F8C5D8A5E0B0000000000000000000000005553440000000000DC596C88BCDE4E818D416FCDEEBF2C8656BADC9A7321022B05847086686F9D0499B13136B94AD4323EE1B67D4C429ECC987AB35ACFA34574473045022100D9634523D8E232D4A7807A71856023D82AC928FA29848571B820867898413B5F022041AC00EC1F81A26A6504EBF844A38CC3204694EF2CC1A97A87632721631F93DA81145E7B112523F68D2F5E879DB4EAC51C6698A6930483149F500E50C2F016CA01945E5A1E5846B61EF2D376",
id: "1C558AA9B926C24FB6BBD6950B2DB1350A83F9F12E4385208867907019761A2D",
};
const decoded = binary.decode(result.signedTransaction);
assert(
decoded.Flags === 2147614720,
`Flags = ${decoded.Flags}, should be 2147614720`
);
assert.deepEqual(result, expectedResult);
schemaValidator.schemaValidate("sign", result);
},
"destination.minAmount": async (client, address, mockRippled) => {
mockRippled.addResponse(

2
test/client/preparePaymentChannelClaim.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import requests from "../fixtures/requests";
import responses from "../fixtures/responses";

4
test/client/prepareSettings.ts
View File

@@ -1,6 +1,6 @@
import assert from "assert-diff";
import { assert } from "chai";
import { FormattedSettings } from "../../src/common/types/objects";
import requests from "../fixtures/requests";
import responses from "../fixtures/responses";
import rippled from "../fixtures/rippled";

2
test/client/prepareTicket.ts
View File

@@ -4,7 +4,7 @@ import { assertResultMatch, TestSuite } from "../testUtils";
// import requests from '../fixtures/requests'
// import {ValidationError} from 'xrpl-local/common/errors'
// import binary from 'ripple-binary-codec'
// import assert from 'assert-diff'
// import {assert} from 'chai'
// import {Client} from 'xrpl-local'
// import * as schemaValidator from 'xrpl-local/common/schema-validator'

2
test/client/requestNextPage.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import rippled from "../fixtures/rippled";
import { assertRejects, TestSuite } from "../testUtils";

8
test/client/sign.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import binary from "ripple-binary-codec";
import * as schemaValidator from "xrpl-local/common/schema-validator";
@@ -304,7 +304,7 @@ export default <TestSuite>{
const secret = "shsWGZcmZz6YsWWmcnpfr6fLTdtFV";
assert.throws(() => {
client.sign(payment.txJSON, secret);
}, /^Error: 1\.1234567 is an illegal amount/);
}, /^1.1234567 is an illegal amount/);
},
"throws when encoded tx does not match decoded tx - prepared order": async (
@@ -375,7 +375,7 @@ export default <TestSuite>{
assert.throws(() => {
client.sign(request.txJSON, secret);
}, /Error: 1\.2 is an illegal amount/);
}, /1\.2 is an illegal amount/);
},
"throws when encoded tx does not match decoded tx - higher fee": async (
@@ -395,7 +395,7 @@ export default <TestSuite>{
assert.throws(() => {
client.sign(request.txJSON, secret);
}, /Error: 1123456\.7 is an illegal amount/);
}, /1123456\.7 is an illegal amount/);
},
"throws when Fee exceeds maxFeeXRP (in drops)": async (client, address) => {

3
test/connection.ts
View File

@@ -1,6 +1,6 @@
import net from "net";
import assert from "assert-diff";
import { assert } from "chai";
import _ from "lodash";
import { Client } from "xrpl-local";
@@ -197,7 +197,6 @@ describe("Connection", function () {
assert(false, "Should throw DisconnectedError");
})
.catch((error) => {
console.log(error);
assert(error instanceof this.client.errors.DisconnectedError);
assert.strictEqual(error.message, "not connected");
});

3
test/rippleClientPrivate.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import _ from "lodash";
import { Client } from "xrpl-local";
@@ -18,7 +18,6 @@ import setupClient from "./setupClient";
import { assertRejects } from "./testUtils";
const address = addresses.ACCOUNT;
assert.options.strict = true;
// how long before each test case times out
const TIMEOUT = 20000;

2
test/testUtils.ts
View File

@@ -2,7 +2,7 @@ import fs from "fs";
import net from "net";
import path from "path";
import assert from "assert-diff";
import { assert } from "chai";
import _ from "lodash";
import { Client } from "xrpl-local";

2
test/utils/computeLedgerHash.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { ValidationError } from "../../src/common/errors";
import { computeLedgerHeaderHash } from "../../src/utils";

2
test/utils/dropsToXrp.ts
View File

@@ -1,5 +1,5 @@
import assert from "assert-diff";
import BigNumber from "bignumber.js";
import { assert } from "chai";
import { dropsToXrp } from "../../src/utils";

2
test/utils/generateAddress.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import ECDSA from "../../src/common/ecdsa";
import { UnexpectedError } from "../../src/common/errors";

2
test/utils/xrpToDrops.ts
View File

@@ -1,5 +1,5 @@
import assert from "assert-diff";
import BigNumber from "bignumber.js";
import { assert } from "chai";
import { xrpToDrops } from "../../src/utils";

2
test/wallet/fromEntropy.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import ECDSA from "../../src/common/ecdsa";
import Wallet from "../../src/Wallet";

2
test/wallet/fromMnemonic.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import Wallet from "../../src/Wallet";
import { TestSuite } from "../testUtils";

2
test/wallet/fromSeed.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import ECDSA from "../../src/common/ecdsa";
import Wallet from "../../src/Wallet";

2
test/wallet/verifyTransaction.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import Wallet from "xrpl-local/Wallet";

2
test/walletGeneration.ts
View File

@@ -1,4 +1,4 @@
import assert from "assert-diff";
import { assert } from "chai";
import { getFaucetUrl, FaucetNetwork } from "../src/wallet/wallet-generation";

58
yarn.lock
View File

@@ -805,19 +805,6 @@ asn1.js@^5.2.0:
minimalistic-assert "^1.0.0"
safer-buffer "^2.1.0"
assert-diff@^3.0.0:
version "3.0.2"
resolved "https://registry.yarnpkg.com/assert-diff/-/assert-diff-3.0.2.tgz#3e92ae3f9663fdc46abe163e2aa209f371a318bc"
integrity sha512-3FaXH0uQeMcFpVTcFjOsd6GQdiGgDoy7BYu/HEj/YZ+bjgZLC/i8nSIgerlUbY+iyoCKdEdjzYyNO9BUPcwUmA==
dependencies:
assert-plus "1.0.0"
json-diff "0.5.4"
assert-plus@1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525"
integrity sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=
assert@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/assert/-/assert-2.0.0.tgz#95fc1c616d48713510680f2eaf2d10dd22e02d32"
@@ -1214,13 +1201,6 @@ clean-stack@^2.0.0:
resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b"
integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==
cli-color@~0.1.6:
version "0.1.7"
resolved "https://registry.yarnpkg.com/cli-color/-/cli-color-0.1.7.tgz#adc3200fa471cc211b0da7f566b71e98b9d67347"
integrity sha1-rcMgD6RxzCEbDaf1ZrcemLnWc0c=
dependencies:
es5-ext "0.8.x"
cliui@^6.0.0:
version "6.0.0"
resolved "https://registry.yarnpkg.com/cliui/-/cliui-6.0.0.tgz#511d702c0c4e41ca156d7d0e96021f23e13225b1"
@@ -1487,13 +1467,6 @@ diffie-hellman@^5.0.0:
miller-rabin "^4.0.0"
randombytes "^2.0.0"
difflib@~0.2.1:
version "0.2.4"
resolved "https://registry.yarnpkg.com/difflib/-/difflib-0.2.4.tgz#b5e30361a6db023176d562892db85940a718f47e"
integrity sha1-teMDYabbAjF21WKJLbhZQKcY9H4=
dependencies:
heap ">= 0.2.0"
doctoc@^2.0.0:
version "2.0.1"
resolved "https://registry.yarnpkg.com/doctoc/-/doctoc-2.0.1.tgz#d5aee2bce65a438ff8717d9e51df3d540caa3b78"
@@ -1557,13 +1530,6 @@ domutils@^2.0.0:
domelementtype "^2.2.0"
domhandler "^4.2.0"
dreamopt@~0.6.0:
version "0.6.0"
resolved "https://registry.yarnpkg.com/dreamopt/-/dreamopt-0.6.0.tgz#d813ccdac8d39d8ad526775514a13dda664d6b4b"
integrity sha1-2BPM2sjTnYrVJndVFKE92mZNa0s=
dependencies:
wordwrap ">=0.0.2"
duplexer@^0.1.2:
version "0.1.2"
resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6"
@@ -1681,11 +1647,6 @@ es-to-primitive@^1.2.1:
is-date-object "^1.0.1"
is-symbol "^1.0.2"
es5-ext@0.8.x:
version "0.8.2"
resolved "https://registry.yarnpkg.com/es5-ext/-/es5-ext-0.8.2.tgz#aba8d9e1943a895ac96837a62a39b3f55ecd94ab"
integrity sha1-q6jZ4ZQ6iVrJaDemKjmz9V7NlKs=
es6-error@^4.0.1:
version "4.1.1"
resolved "https://registry.yarnpkg.com/es6-error/-/es6-error-4.1.1.tgz#9e3af407459deed47e9a91f9b885a84eb05c561d"
@@ -2339,11 +2300,6 @@ he@1.2.0:
resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f"
integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==
"heap@>= 0.2.0":
version "0.2.6"
resolved "https://registry.yarnpkg.com/heap/-/heap-0.2.6.tgz#087e1f10b046932fc8594dd9e6d378afc9d1e5ac"
integrity sha1-CH4fELBGky/IWU3Z5tN4r8nR5aw=
hmac-drbg@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/hmac-drbg/-/hmac-drbg-1.0.1.tgz#d2745701025a6c775a6c545793ed502fc0c649a1"
@@ -2800,15 +2756,6 @@ jsesc@^2.5.1:
resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4"
integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==
json-diff@0.5.4:
version "0.5.4"
resolved "https://registry.yarnpkg.com/json-diff/-/json-diff-0.5.4.tgz#7bc8198c441756632aab66c7d9189d365a7a035a"
integrity sha512-q5Xmx9QXNOzOzIlMoYtLrLiu4Jl/Ce2bn0CNcv54PhyH89CI4GWlGVDye8ei2Ijt9R3U+vsWPsXpLUNob8bs8Q==
dependencies:
cli-color "~0.1.6"
difflib "~0.2.1"
dreamopt "~0.6.0"
json-parse-better-errors@^1.0.1, json-parse-better-errors@^1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9"
@@ -4580,11 +4527,6 @@ word-wrap@^1.2.3:
resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
wordwrap@>=0.0.2:
version "1.0.0"
resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb"
integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=
workerpool@6.1.5:
version "6.1.5"
resolved "https://registry.yarnpkg.com/workerpool/-/workerpool-6.1.5.tgz#0f7cf076b6215fd7e1da903ff6f22ddd1886b581"