Merge pull request #1484 from xchainjs/hippo/replace-bcjaddrjs-dependency

Replace bchaddrjs dependency

Author: hippocampus-web3

.changeset/slick-roses-wonder.md

@@ -0,0 +1,5 @@
+---
+'@xchainjs/xchain-bitcoincash': patch
+---
+
+Remove bchaddr dependency

examples/do-swap/package.json

@@ -38,7 +38,6 @@
     "@xchainjs/xchain-wallet": "workspace:*",
     "axios": "1.8.4",
     "axios-retry": "^3.3.1",
-    "bchaddrjs": "^0.5.2",
     "bech32-buffer": "^0.2.0",
     "bitcoinjs-lib": "^6.1.7",
     "dotenv": "^16.0.0",

packages/xchain-bitcoincash/__tests__/utils.test.ts

@@ -1,6 +1,5 @@
 import { Network } from '@xchainjs/xchain-client'
-import * as bchaddr from 'bchaddrjs'
-
+import * as bchaddr from '../src/bchaddrjs'
 import mockHaskoinApi from '../__mocks__/haskoin'
 import * as Utils from '../src/utils'
 
@@ -14,14 +13,15 @@ describe('Bitcoin Cash Utils Test', () => {
 
   const testnet_address = 'bchtest:qpd7jmj0hltgxux06v9d9u6933vq7zd0kyjlapya0g'
   const mainnet_address = 'bitcoincash:qp4kjpk684c3d9qjk5a37vl2xn86wxl0f5j2ru0daj'
+  const legacy_mainnet = '1Anw7uzLwXxBykMLeKb2BPAyTKsSfVDA8A'
 
   describe('stripPrefix', () => {
     it('should strip out the prefix from the testnet address', () => {
       const strip_address = Utils.stripPrefix(testnet_address)
       expect(strip_address).toEqual('qpd7jmj0hltgxux06v9d9u6933vq7zd0kyjlapya0g')
     })
 
-    it('should strip out the prefix from the testnet address', () => {
+    it('should strip out the prefix from the mainnet address', () => {
       const strip_address = Utils.stripPrefix(mainnet_address)
       expect(strip_address).toEqual('qp4kjpk684c3d9qjk5a37vl2xn86wxl0f5j2ru0daj')
     })
@@ -40,4 +40,45 @@ describe('Bitcoin Cash Utils Test', () => {
       expect(Utils.toBCHAddressNetwork(Network.Testnet)).toEqual(bchaddr.Network.Testnet)
     })
   })
+
+  describe('toLegacyAddress', () => {
+    it('converts cashaddr to legacy', () => {
+      const legacy = Utils.toLegacyAddress(mainnet_address)
+      expect(legacy).toEqual(legacy_mainnet)
+    })
+  })
+  describe('toCashAddress', () => {
+    it('converts legacy to cashaddr', () => {
+      const cashaddr = Utils.toCashAddress(legacy_mainnet)
+      expect(cashaddr).toEqual(mainnet_address)
+    })
+  })
+
+  describe('isCashAddress', () => {
+    it('returns true for a valid cash address', () => {
+      expect(Utils.isCashAddress(mainnet_address)).toBe(true)
+    })
+
+    it('returns false for a legacy address', () => {
+      expect(Utils.isCashAddress(legacy_mainnet)).toBe(false)
+    })
+  })
+
+  describe('validateAddress', () => {
+    it('returns true for a valid testnet address and testnet network', () => {
+      expect(Utils.validateAddress(testnet_address, Network.Testnet)).toBe(true)
+    })
+
+    it('returns true for a valid mainnet address and mainnet network', () => {
+      expect(Utils.validateAddress(mainnet_address, Network.Mainnet)).toBe(true)
+    })
+
+    it('returns false if address network doesn’t match given network', () => {
+      expect(Utils.validateAddress(mainnet_address, Network.Testnet)).toBe(false)
+    })
+
+    it('throws error for invalid address', () => {
+      expect(() => Utils.validateAddress('invalid-address', Network.Mainnet)).toThrow()
+    })
+  })
 })

packages/xchain-bitcoincash/package.json

@@ -41,14 +41,15 @@
     "@xchainjs/xchain-util": "workspace:*",
     "@xchainjs/xchain-utxo": "workspace:*",
     "@xchainjs/xchain-utxo-providers": "workspace:*",
-    "bchaddrjs": "0.5.2",
     "bitcore-lib-cash": "11.0.0",
+    "bs58check": "^4.0.0",
+    "cashaddrjs": "^0.4.4",
     "coinselect": "3.1.12"
   },
   "devDependencies": {
     "@ledgerhq/hw-transport-node-hid": "^6.28.6",
-    "@types/bchaddrjs": "0.4.0",
     "@types/bitcore-lib-cash": "^8.23.8",
+    "@types/cashaddrjs": "^0",
     "axios": "^1.8.4",
     "axios-mock-adapter": "^2.1.0"
   },

packages/xchain-bitcoincash/src/bchaddrjs/README.md

@@ -0,0 +1,3 @@
+### 📦 Note on BCH Address Utilities
+
+This project replaces the original [`bchaddrjs`](https://www.npmjs.com/package/bchaddrjs) [`code`](https://github.com/ealmansi/bchaddrjs) dependency with a direct copy of its source code included in the repository. The decision was made to avoid unnecessary bundle size inflation caused by the original package's inclusion of outdated polyfills. Functionality remains unchanged, and only the delivery method has been optimized for modern environments.