ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-14 17:45:48 +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

1
packages/xrpl/HISTORY.md
View File

@@ -12,6 +12,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
* `Client.prepareTransaction`
* `getSignedTx`
* `isAccountDelete`
* `dropsToXRP` and `Client.getXrpBalance` now return a `number` instead of a `string`
## 3.0.0 Beta 1 (2023-10-19)

4
packages/xrpl/snippets/src/bridgeTransfer.ts
View File

@@ -79,7 +79,7 @@ async function bridgeTransfer(): Promise<void> {
'Waiting for the attestation to go through... (usually 8-12 seconds)',
)
let ledgersWaited = 0
let initialBalance = '0'
let initialBalance = 0
while (ledgersWaited < MAX_LEDGERS_WAITED) {
await sleep(LEDGER_CLOSE_TIME)
try {
@@ -151,7 +151,7 @@ async function bridgeTransfer(): Promise<void> {
wallet2.classicAddress,
)
console.log(initialBalance, currentBalance)
if (parseFloat(currentBalance) > parseFloat(initialBalance)) {
if (currentBalance > initialBalance) {
console.log('Transfer is complete')
console.log(
`New balance of ${wallet2.classicAddress} is ${currentBalance} XRP`,

10
packages/xrpl/src/client/index.ts
View File

@@ -831,7 +831,7 @@ class Client extends EventEmitter<EventTypes> {
* @param [options] - Additional options for fetching the balance (optional).
* @param [options.ledger_hash] - The hash of the ledger to retrieve the balance from (optional).
* @param [options.ledger_index] - The index of the ledger to retrieve the balance from (optional).
* @returns A promise that resolves with the XRP balance as a string.
* @returns A promise that resolves with the XRP balance as a number.
*/
public async getXrpBalance(
address: string,
@@ -839,7 +839,7 @@ class Client extends EventEmitter<EventTypes> {
ledger_hash?: string
ledger_index?: LedgerIndex
} = {},
): Promise<string> {
): Promise<number> {
const xrpRequest: AccountInfoRequest = {
command: 'account_info',
account: address,
@@ -913,7 +913,7 @@ class Client extends EventEmitter<EventTypes> {
const balances: Balance[] = []
// get XRP balance
let xrpPromise: Promise<string> = Promise.resolve('')
let xrpPromise: Promise<number> = Promise.resolve(0)
if (!options.peer) {
xrpPromise = this.getXrpBalance(address, {
ledger_hash: options.ledger_hash,
@@ -938,8 +938,8 @@ class Client extends EventEmitter<EventTypes> {
const accountLinesBalance = linesResponses.flatMap((response) =>
formatBalances(response.result.lines),
)
if (xrpBalance !== '') {
balances.push({ currency: 'XRP', value: xrpBalance })
if (xrpBalance !== 0) {
balances.push({ currency: 'XRP', value: xrpBalance.toString() })
}
balances.push(...accountLinesBalance)
},

4
packages/xrpl/src/utils/xrpConversion.ts
View File

@@ -15,7 +15,7 @@ const SANITY_CHECK = /^-?[0-9.]+$/u
* @throws When drops amount is invalid.
* @category Utilities
*/
export function dropsToXrp(dropsToConvert: BigNumber.Value): string {
export function dropsToXrp(dropsToConvert: BigNumber.Value): number {
/*
* Converting to BigNumber and then back to string should remove any
* decimal point followed by zeros, e.g. '1.00'.
@@ -50,7 +50,7 @@ export function dropsToXrp(dropsToConvert: BigNumber.Value): string {
)
}
return new BigNumber(drops).dividedBy(DROPS_PER_XRP).toString(BASE_TEN)
return new BigNumber(drops).dividedBy(DROPS_PER_XRP).toNumber()
}
/**

2
packages/xrpl/test/client/getXrpBalance.test.ts
View File

@@ -30,7 +30,7 @@ describe('client.getXrpBalance', function () {
)
testContext.mockRippled!.addResponse('ledger', rippled.ledger.normal)
const result = await testContext.client.getXrpBalance(testcase.address)
assert.equal(result, '922.913243')
assert.equal(result, 922.913243)
})
})
})

17
packages/xrpl/test/integration/fundWallet.test.ts
View File

@@ -31,7 +31,7 @@ async function generate_faucet_wallet_and_fund_again(
account: wallet.classicAddress,
})
assert.equal(dropsToXrp(info.result.account_data.Balance), balance.toString())
assert.equal(dropsToXrp(info.result.account_data.Balance), balance)
const { balance: newBalance } = await api.fundWallet(wallet, {
faucetHost,
@@ -45,10 +45,7 @@ async function generate_faucet_wallet_and_fund_again(
})
assert(newBalance > balance)
assert.equal(
dropsToXrp(afterSent.result.account_data.Balance),
newBalance.toString(),
)
assert.equal(dropsToXrp(afterSent.result.account_data.Balance), newBalance)
await api.disconnect()
}
@@ -106,10 +103,7 @@ describe('fundWallet', function () {
account: wallet.classicAddress,
})
assert.equal(
dropsToXrp(info.result.account_data.Balance),
balance.toString(),
)
assert.equal(dropsToXrp(info.result.account_data.Balance), balance)
assert.equal(balance, 10000)
/*
@@ -142,10 +136,7 @@ describe('fundWallet', function () {
command: 'account_info',
account: wallet.classicAddress,
})
assert.equal(
dropsToXrp(info.result.account_data.Balance),
balance.toString(),
)
assert.equal(dropsToXrp(info.result.account_data.Balance), balance)
await api.disconnect()
},
TIMEOUT,

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)
})