XRP -> XAH

This commit is contained in:
Denis Angell
2023-10-31 14:22:03 +01:00
parent 3b234ec8ec
commit 60c97901d2
20 changed files with 41 additions and 40 deletions

View File

@@ -12,7 +12,7 @@ const STANDARD_FORMAT_HEX_REGEX = /^0{24}[\x00-\x7F]{6}0{10}$/
*/ */
function isoToBytes(iso: string): Buffer { function isoToBytes(iso: string): Buffer {
const bytes = Buffer.alloc(20) const bytes = Buffer.alloc(20)
if (iso !== 'XRP') { if (iso !== 'XAH') {
const isoBytes = iso.split('').map((c) => c.charCodeAt(0)) const isoBytes = iso.split('').map((c) => c.charCodeAt(0))
bytes.set(isoBytes, 12) bytes.set(isoBytes, 12)
} }
@@ -28,7 +28,7 @@ function isIsoCode(iso: string): boolean {
function isoCodeFromHex(code: Buffer): string | null { function isoCodeFromHex(code: Buffer): string | null {
const iso = code.toString() const iso = code.toString()
if (iso === 'XRP') { if (iso === 'XAH') {
return null return null
} }
if (isIsoCode(iso)) { if (isIsoCode(iso)) {
@@ -89,7 +89,7 @@ class Currency extends Hash160 {
const hex = this.bytes.toString('hex') const hex = this.bytes.toString('hex')
if (XRP_HEX_REGEX.test(hex)) { if (XRP_HEX_REGEX.test(hex)) {
this._iso = 'XRP' this._iso = 'XAH'
} else if (STANDARD_FORMAT_HEX_REGEX.test(hex)) { } else if (STANDARD_FORMAT_HEX_REGEX.test(hex)) {
this._iso = isoCodeFromHex(this.bytes.slice(12, 15)) this._iso = isoCodeFromHex(this.bytes.slice(12, 15))
} else { } else {

View File

@@ -369,7 +369,7 @@ function pathSetBinaryTests() {
currency: 'BTC', currency: 'BTC',
issuer: 'r3AWbdp2jQLXLywJypdoNwVSvr81xs3uhn', issuer: 'r3AWbdp2jQLXLywJypdoNwVSvr81xs3uhn',
}, },
{ currency: 'XRP' }, { currency: 'XAH' },
{ {
currency: 'USD', currency: 'USD',
issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B',

View File

@@ -2904,7 +2904,7 @@
"type_id": 6, "type_id": 6,
"is_native": true, "is_native": true,
"type": "Amount", "type": "Amount",
"error": "1000000000000 absolute XRP is bigger than max native value 100000000000.0", "error": "1000000000000 absolute XAH is bigger than max native value 100000000000.0",
"is_negative": false "is_negative": false
}, },
{ {
@@ -2912,7 +2912,7 @@
"type_id": 6, "type_id": 6,
"is_native": true, "is_native": true,
"type": "Amount", "type": "Amount",
"error": "10000000000000000000 absolute XRP is bigger than max native value 100000000000.0", "error": "10000000000000000000 absolute XAH is bigger than max native value 100000000000.0",
"is_negative": true "is_negative": true
} }
] ]

View File

@@ -77,7 +77,7 @@ describe('Hash256', function () {
describe('Currency', function () { describe('Currency', function () {
test('Decoding allows dodgy XRP without throwing', function () { test('Decoding allows dodgy XRP without throwing', function () {
const currencyCode = '0000000000000000000000005852500000000000' const currencyCode = '0000000000000000000000005841480000000000'
expect(Currency.from(currencyCode).toJSON()).toBe(currencyCode) expect(Currency.from(currencyCode).toJSON()).toBe(currencyCode)
}) })
test('Currency code with lowercase letters decodes to ISO code', () => { test('Currency code with lowercase letters decodes to ISO code', () => {
@@ -113,7 +113,7 @@ describe('Currency', function () {
test('can be constructed from a Buffer', function () { test('can be constructed from a Buffer', function () {
const xrp = new Currency(Buffer.alloc(20)) const xrp = new Currency(Buffer.alloc(20))
expect(xrp.iso()).toBe('XRP') expect(xrp.iso()).toBe('XAH')
}) })
test('Can handle non-standard currency codes', () => { test('Can handle non-standard currency codes', () => {
const currency = '015841551A748AD2C1F76FF6ECB0CCCD00000000' const currency = '015841551A748AD2C1F76FF6ECB0CCCD00000000'

View File

@@ -58,7 +58,7 @@ describe('encoding and decoding tx_json', function () {
Sequence: 19, Sequence: 19,
LimitAmount: { LimitAmount: {
value: '200', value: '200',
currency: '0000000000000000000000005852500000000000', currency: '0000000000000000000000005841480000000000',
issuer: 'r9hEDb4xBGRfBCcX3E4FirDWQBAYtpxC8K', issuer: 'r9hEDb4xBGRfBCcX3E4FirDWQBAYtpxC8K',
}, },
Fee: '10', Fee: '10',

View File

@@ -1698,7 +1698,7 @@ __OTHER CHANGES__
parseBinary: false parseBinary: false
} }
``` ```
+ Added full currency name support, e.g. `Currency.from_json('XRP').to_human({full_name:'Ripples'})` will return `XRP - Ripples` + Added full currency name support, e.g. `Currency.from_json('XAH').to_human({full_name:'Ripples'})` will return `XAH - Ripples`
+ Improved interest bearing currency support, e.g. `Currency.from_human('USD - US Dollar (2.5%pa)')` + Improved interest bearing currency support, e.g. `Currency.from_human('USD - US Dollar (2.5%pa)')`
+ Improve test coverage + Improve test coverage
+ Added blob vault client. The vault client facilitates interaction with ripple's namespace and blob vault or 3rd party blob vaults using ripple's blob vault software (https://github.com/ripple/ripple-blobvault). A list of the available functions can be found at [docs/VAULTCLIENT.md](docs/VAULTCLIENT.md) + Added blob vault client. The vault client facilitates interaction with ripple's namespace and blob vault or 3rd party blob vaults using ripple's blob vault software (https://github.com/ripple/ripple-blobvault). A list of the available functions can be found at [docs/VAULTCLIENT.md](docs/VAULTCLIENT.md)

View File

@@ -80,5 +80,6 @@
"readmeFilename": "README.md", "readmeFilename": "README.md",
"engines": { "engines": {
"node": ">=10.13.0" "node": ">=10.13.0"
} },
"gitHead": "3b234ec8ec1c677e0f3f534fd2985c985871c87e"
} }

View File

@@ -18,7 +18,7 @@ async function createTxWithPaths(): Promise<void> {
source_account: wallet.classicAddress, source_account: wallet.classicAddress,
source_currencies: [ source_currencies: [
{ {
currency: 'XRP', currency: 'XAH',
}, },
], ],
destination_account, destination_account,

View File

@@ -485,10 +485,10 @@ class Wallet {
if ( if (
txCurrency.length === standard_currency_code_len && txCurrency.length === standard_currency_code_len &&
txCurrency.toUpperCase() === 'XRP' txCurrency.toUpperCase() === 'XAH'
) { ) {
throw new XrplError( throw new XrplError(
`Trying to sign an issued currency with a similar standard code to XRP (received '${txCurrency}'). XRP is not an issued currency.`, `Trying to sign an issued currency with a similar standard code to XAH (received '${txCurrency}'). XAH is not an issued currency.`,
) )
} }
@@ -575,7 +575,7 @@ function removeTrailingZeros(tx: Transaction): void {
/* eslint-disable @typescript-eslint/no-magic-numbers -- Magic numbers are from rippleds of currency code encoding */ /* eslint-disable @typescript-eslint/no-magic-numbers -- Magic numbers are from rippleds of currency code encoding */
function isoToHex(iso: string): string { function isoToHex(iso: string): string {
const bytes = Buffer.alloc(20) const bytes = Buffer.alloc(20)
if (iso !== 'XRP') { if (iso !== 'XAH') {
const isoBytes = iso.split('').map((chr) => chr.charCodeAt(0)) const isoBytes = iso.split('').map((chr) => chr.charCodeAt(0))
bytes.set(isoBytes, 12) bytes.set(isoBytes, 12)
} }

View File

@@ -1,7 +1,7 @@
export type LedgerIndex = number | ('validated' | 'closed' | 'current') export type LedgerIndex = number | ('validated' | 'closed' | 'current')
interface XRP { interface XRP {
currency: 'XRP' currency: 'XAH'
} }
interface IssuedCurrency { interface IssuedCurrency {

View File

@@ -115,7 +115,7 @@ async function getBalances(
formatBalances(response.result.lines), formatBalances(response.result.lines),
) )
if (xrpBalance !== '') { if (xrpBalance !== '') {
balances.push({ currency: 'XRP', value: xrpBalance }) balances.push({ currency: 'XAH', value: xrpBalance })
} }
balances.push(...accountLinesBalance) balances.push(...accountLinesBalance)
}, },

View File

@@ -105,7 +105,7 @@ function getXRPQuantity(
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- okay here // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- okay here
account: (node.FinalFields?.Account ?? node.NewFields?.Account) as string, account: (node.FinalFields?.Account ?? node.NewFields?.Account) as string,
balance: { balance: {
currency: 'XRP', currency: 'XAH',
value: dropsToXrp(value).toString(), value: dropsToXrp(value).toString(),
}, },
} }

View File

@@ -4,6 +4,6 @@
"issuer": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw" "issuer": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw"
}, },
"takerGets": { "takerGets": {
"currency": "XRP" "currency": "XAH"
} }
} }

View File

@@ -1,7 +1,7 @@
[ [
{ {
"value": "922.913243", "value": "922.913243",
"currency": "XRP" "currency": "XAH"
}, },
{ {
"value": "0", "value": "0",

File diff suppressed because one or more lines are too long

View File

@@ -25,7 +25,7 @@ describe('book_offers', function () {
const bookOffer: BookOffersRequest = { const bookOffer: BookOffersRequest = {
command: 'book_offers', command: 'book_offers',
taker_gets: { taker_gets: {
currency: 'XRP', currency: 'XAH',
}, },
taker_pays: { taker_pays: {
currency: 'USD', currency: 'USD',

View File

@@ -16,7 +16,7 @@ describe('TrustSet', function () {
TransactionType: 'TrustSet', TransactionType: 'TrustSet',
Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo', Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo',
LimitAmount: { LimitAmount: {
currency: 'XRP', currency: 'XAH',
issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX', issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX',
value: '4329.23', value: '4329.23',
}, },

View File

@@ -118,7 +118,7 @@ describe('Models Utils', function () {
TransactionType: 'TrustSet', TransactionType: 'TrustSet',
Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo', Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo',
LimitAmount: { LimitAmount: {
currency: 'XRP', currency: 'XAH',
issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX', issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX',
value: '4329.23', value: '4329.23',
}, },

View File

@@ -15,16 +15,16 @@ import trustlineSetLimit2 from '../fixtures/utils/trustlineSetLimit2.json'
import trustlineSetLimitZero from '../fixtures/utils/trustlineSetLimitZero.json' import trustlineSetLimitZero from '../fixtures/utils/trustlineSetLimitZero.json'
describe('getBalanceChanges', function () { describe('getBalanceChanges', function () {
it('XRP create account', function () { it('XAH create account', function () {
const result = getBalanceChanges(paymentXrpCreateAccount.metadata) const result = getBalanceChanges(paymentXrpCreateAccount.metadata)
const expected = [ const expected = [
{ {
account: 'rLDYrujdKUfVx28T9vRDAbyJ7G2WVXKo4K', account: 'rLDYrujdKUfVx28T9vRDAbyJ7G2WVXKo4K',
balances: [{ currency: 'XRP', value: '100' }], balances: [{ currency: 'XAH', value: '100' }],
}, },
{ {
account: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc', account: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc',
balances: [{ currency: 'XRP', value: '-100.012' }], balances: [{ currency: 'XAH', value: '-100.012' }],
}, },
] ]
assert.deepStrictEqual(result, expected) assert.deepStrictEqual(result, expected)
@@ -43,7 +43,7 @@ describe('getBalanceChanges', function () {
}, },
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -114,7 +114,7 @@ describe('getBalanceChanges', function () {
}, },
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -136,7 +136,7 @@ describe('getBalanceChanges', function () {
}, },
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -177,7 +177,7 @@ describe('getBalanceChanges', function () {
balances: [ balances: [
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -197,7 +197,7 @@ describe('getBalanceChanges', function () {
value: '10', value: '10',
}, },
{ {
currency: 'XRP', currency: 'XAH',
value: '-0.012', value: '-0.012',
}, },
], ],
@@ -224,7 +224,7 @@ describe('getBalanceChanges', function () {
balances: [ balances: [
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -239,7 +239,7 @@ describe('getBalanceChanges', function () {
account: 'rsApBGKJmMfExxZBrGnzxEXyq7TMhMRg4e', account: 'rsApBGKJmMfExxZBrGnzxEXyq7TMhMRg4e',
balances: [ balances: [
{ {
currency: 'XRP', currency: 'XAH',
value: '-0.00001', value: '-0.00001',
}, },
], ],
@@ -286,7 +286,7 @@ describe('getBalanceChanges', function () {
}, },
{ {
value: '-0.012', value: '-0.012',
currency: 'XRP', currency: 'XAH',
}, },
], ],
}, },
@@ -316,7 +316,7 @@ describe('getBalanceChanges', function () {
value: '-100', value: '-100',
}, },
{ {
currency: 'XRP', currency: 'XAH',
value: '-0.00001', value: '-0.00001',
}, },
], ],
@@ -347,7 +347,7 @@ describe('getBalanceChanges', function () {
value: '-200', value: '-200',
}, },
{ {
currency: 'XRP', currency: 'XAH',
value: '-0.00001', value: '-0.00001',
}, },
], ],
@@ -383,7 +383,7 @@ describe('getBalanceChanges', function () {
value: '-100', value: '-100',
}, },
{ {
currency: 'XRP', currency: 'XAH',
value: '-0.00001', value: '-0.00001',
}, },
{ {

View File

@@ -757,13 +757,13 @@ describe('Wallet', function () {
it('sign throws when a payment contains an issued currency like XRP', async function () { it('sign throws when a payment contains an issued currency like XRP', async function () {
const payment: Payment = { ...issuedCurrencyPayment } const payment: Payment = { ...issuedCurrencyPayment }
payment.Amount = { payment.Amount = {
currency: 'xrp', currency: 'xah',
issuer: 'rnURbz5HLbvqEq69b1B4TX6cUTNMmcrBqi', issuer: 'rnURbz5HLbvqEq69b1B4TX6cUTNMmcrBqi',
value: '123.40', value: '123.40',
} }
assert.throws(() => { assert.throws(() => {
wallet.sign(payment) wallet.sign(payment)
}, /^Trying to sign an issued currency with a similar standard code to XRP \(received 'xrp'\)\. XRP is not an issued currency\./u) }, /^Trying to sign an issued currency with a similar standard code to XAH \(received 'xah'\)\. XAH is not an issued currency\./u)
}) })
it('sign does NOT throw when a payment contains an issued currency like xrp in hex string format', async function () { it('sign does NOT throw when a payment contains an issued currency like xrp in hex string format', async function () {