Include cashaddr prefix for ecash addresses

Author: samholmes

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- changed: Added cashaddr prefixes to ecash.
 - changed: Added ecash to bitcoincash forks.
 
 ## 3.8.0 (2025-05-19)

src/common/plugin/types.ts

@@ -189,6 +189,14 @@ export interface CoinInfo {
    */
   coinType: number
 
+  /**
+   * Whether the currency should include its cashaddr prefix in the formatted
+   * addresses.
+   *
+   * Defaults to `false`.
+   */
+  includeCashaddrPrefix?: boolean
+
   /**
    * Optional sighash value to be passed to AltcoinJS as the sighashType field
    * on inputs. This is primarily used by currencies that leverage it as

src/common/utxobased/engine/UtxoWalletTools.ts

@@ -190,7 +190,8 @@ export function makeUtxoWalletTools(
       return scriptPubkeyToAddress({
         scriptPubkey: args.scriptPubkey,
         addressType,
-        coin
+        coin,
+        includeCashaddrPrefix: pluginInfo.coinInfo.includeCashaddrPrefix
       })
     },
 

src/common/utxobased/info/ecash.ts

@@ -65,9 +65,10 @@ const engineInfo: EngineInfo = {
   },
   asBlockbookAddress: asCodec(
     raw => {
-      return asString(raw).split(':')[1]
+      const address = asString(raw)
+      return address.startsWith('ecash:') ? address.split(':')[1] : address
     },
-    address => `ecash:${address}`
+    address => (address.startsWith('ecash:') ? address : `ecash:${address}`)
   )
 }
 
@@ -76,6 +77,7 @@ export const coinInfo: CoinInfo = {
   segwit: false,
   sighash: Psbt.BCH_SIGHASH_ALL,
   coinType: 899,
+  includeCashaddrPrefix: true,
 
   prefixes: {
     messagePrefix: ['\x18Bitcoin Signed Message::\n'],

src/common/utxobased/keymanager/keymanager.ts

@@ -156,6 +156,7 @@ export interface ScriptPubkeyToAddressArgs {
   addressType: AddressTypeEnum
   coin: string
   redeemScript?: string
+  includeCashaddrPrefix?: boolean
 }
 
 export interface ScriptPubkeyToAddressReturn {
@@ -612,7 +613,8 @@ export function scriptPubkeyToAddress(
             coin: args.coin
           }),
           CashaddrTypeEnum.pubkeyhash,
-          standardPrefixes.cashaddr
+          standardPrefixes.cashaddr,
+          args.includeCashaddrPrefix
         )
       }
       if (legacyPrefixes.cashaddr != null) {
@@ -623,7 +625,8 @@ export function scriptPubkeyToAddress(
             coin: args.coin
           }),
           CashaddrTypeEnum.pubkeyhash,
-          legacyPrefixes.cashaddr
+          legacyPrefixes.cashaddr,
+          args.includeCashaddrPrefix
         )
       }
       payment = payments.p2pkh
@@ -637,7 +640,8 @@ export function scriptPubkeyToAddress(
             coin: args.coin
           }),
           CashaddrTypeEnum.scripthash,
-          standardPrefixes.cashaddr
+          standardPrefixes.cashaddr,
+          args.includeCashaddrPrefix
         )
       }
       if (legacyPrefixes.cashaddr != null) {
@@ -648,7 +652,8 @@ export function scriptPubkeyToAddress(
             coin: args.coin
           }),
           CashaddrTypeEnum.scripthash,
-          legacyPrefixes.cashaddr
+          legacyPrefixes.cashaddr,
+          args.includeCashaddrPrefix
         )
       }
       payment = payments.p2sh