ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: getXrpBalance and dropsToXRP return number (#2574)

Browse Source 
BREAKING CHANGE: `dropsToXRP` and `Client.getXrpBalance` now return a `number` instead of a `string`
This commit is contained in:
Caleb Kniffen
2023-11-13 15:22:42 -06:00
parent 960182ecc3
commit 4c7f46c111
7 changed files with 37 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
packages/xrpl/test/utils/dropsToXrp.test.ts
View File

@@ -6,72 +6,72 @@ import { dropsToXrp } from '../../src/utils'
describe('dropsToXrp', function () {
it('works with a typical amount', function () {
const xrp = dropsToXrp('2000000')
assert.strictEqual(xrp, '2', '2 million drops equals 2 XRP')
assert.strictEqual(xrp, 2, '2 million drops equals 2 XRP')
})
it('works with fractions', function () {
let xrp = dropsToXrp('3456789')
assert.strictEqual(xrp, '3.456789', '3,456,789 drops equals 3.456789 XRP')
assert.strictEqual(xrp, 3.456789, '3,456,789 drops equals 3.456789 XRP')
xrp = dropsToXrp('3400000')
assert.strictEqual(xrp, '3.4', '3,400,000 drops equals 3.4 XRP')
assert.strictEqual(xrp, 3.4, '3,400,000 drops equals 3.4 XRP')
xrp = dropsToXrp('1')
assert.strictEqual(xrp, '0.000001', '1 drop equals 0.000001 XRP')
assert.strictEqual(xrp, 0.000001, '1 drop equals 0.000001 XRP')
xrp = dropsToXrp('1.0')
assert.strictEqual(xrp, '0.000001', '1.0 drops equals 0.000001 XRP')
assert.strictEqual(xrp, 0.000001, '1.0 drops equals 0.000001 XRP')
xrp = dropsToXrp('1.00')
assert.strictEqual(xrp, '0.000001', '1.00 drops equals 0.000001 XRP')
assert.strictEqual(xrp, 0.000001, '1.00 drops equals 0.000001 XRP')
})
it('works with zero', function () {
let xrp = dropsToXrp('0')
assert.strictEqual(xrp, '0', '0 drops equals 0 XRP')
assert.strictEqual(xrp, 0, '0 drops equals 0 XRP')
// negative zero is equivalent to zero
xrp = dropsToXrp('-0')
assert.strictEqual(xrp, '0', '-0 drops equals 0 XRP')
assert.strictEqual(xrp, 0, '-0 drops equals 0 XRP')
xrp = dropsToXrp('0.00')
assert.strictEqual(xrp, '0', '0.00 drops equals 0 XRP')
assert.strictEqual(xrp, 0, '0.00 drops equals 0 XRP')
xrp = dropsToXrp('000000000')
assert.strictEqual(xrp, '0', '000000000 drops equals 0 XRP')
assert.strictEqual(xrp, 0, '000000000 drops equals 0 XRP')
})
it('works with a negative value', function () {
const xrp = dropsToXrp('-2000000')
assert.strictEqual(xrp, '-2', '-2 million drops equals -2 XRP')
assert.strictEqual(xrp, -2, '-2 million drops equals -2 XRP')
})
it('works with a value ending with a decimal point', function () {
let xrp = dropsToXrp('2000000.')
assert.strictEqual(xrp, '2', '2000000. drops equals 2 XRP')
assert.strictEqual(xrp, 2, '2000000. drops equals 2 XRP')
xrp = dropsToXrp('-2000000.')
assert.strictEqual(xrp, '-2', '-2000000. drops equals -2 XRP')
assert.strictEqual(xrp, -2, '-2000000. drops equals -2 XRP')
})
it('works with BigNumber objects', function () {
let xrp = dropsToXrp(new BigNumber(2000000))
assert.strictEqual(xrp, '2', '(BigNumber) 2 million drops equals 2 XRP')
assert.strictEqual(xrp, 2, '(BigNumber) 2 million drops equals 2 XRP')
xrp = dropsToXrp(new BigNumber(-2000000))
assert.strictEqual(xrp, '-2', '(BigNumber) -2 million drops equals -2 XRP')
assert.strictEqual(xrp, -2, '(BigNumber) -2 million drops equals -2 XRP')
xrp = dropsToXrp(new BigNumber(2345678))
assert.strictEqual(
xrp,
'2.345678',
2.345678,
'(BigNumber) 2,345,678 drops equals 2.345678 XRP',
)
xrp = dropsToXrp(new BigNumber(-2345678))
assert.strictEqual(
xrp,
'-2.345678',
-2.345678,
'(BigNumber) -2,345,678 drops equals -2.345678 XRP',
)
})
@@ -79,27 +79,27 @@ describe('dropsToXrp', function () {
it('works with a number', function () {
// This is not recommended. Use strings or BigNumber objects to avoid precision errors.
let xrp = dropsToXrp(2000000)
assert.strictEqual(xrp, '2', '(number) 2 million drops equals 2 XRP')
assert.strictEqual(xrp, 2, '(number) 2 million drops equals 2 XRP')
xrp = dropsToXrp(-2000000)
assert.strictEqual(xrp, '-2', '(number) -2 million drops equals -2 XRP')
assert.strictEqual(xrp, -2, '(number) -2 million drops equals -2 XRP')
})
it('works with scientific notation', function () {
const xrp = dropsToXrp('1e6')
assert.strictEqual(
xrp,
'1',
1,
'(scientific notation string) 1e6 drops equals 1 XRP',
)
})
it('throws with an amount with too many decimal places', function () {
assert.throws(() => {
dropsToXrp('1.2')
dropsToXrp(1.2)
}, /has too many decimal places/u)
assert.throws(() => {
dropsToXrp('0.10')
dropsToXrp(0.1)
}, /has too many decimal places/u)
})