feat: util and txBuilder changes for byron address support

TICKET: WIN-4056

Author: manas-at-bitgo

modules/sdk-coin-ada/package.json

@@ -47,8 +47,6 @@
     "@emurgo/cardano-serialization-lib-nodejs": "^12.0.1",
     "bech32": "^2.0.0",
     "bignumber.js": "^9.0.2",
-    "bs58": "^4.0.1",
-    "cbor": "^9.0.1",
     "lodash": "^4.17.21",
     "superagent": "^9.0.1",
     "tweetnacl": "^1.0.3"

modules/sdk-coin-ada/src/lib/transaction.ts

@@ -148,7 +148,7 @@ export class Transaction extends BaseTransaction {
     for (let i = 0; i < this._transaction.body().outputs().len(); i++) {
       const output = this._transaction.body().outputs().get(i);
       result.outputs.push({
-        address: output.address().to_bech32(),
+        address: adaUtils.getAddressString(output.address()),
         amount: output.amount().coin().to_str(),
         multiAssets: output.amount().multiasset() || undefined,
       });
@@ -237,7 +237,7 @@ export class Transaction extends BaseTransaction {
     for (let i = 0; i < tx_outputs.len(); i++) {
       const output = tx_outputs.get(i);
       outputs.push({
-        address: output.address().to_bech32(),
+        address: adaUtils.getAddressString(output.address()),
         value: output.amount().coin().to_str(),
       });
     }

modules/sdk-coin-ada/src/lib/transactionBuilder.ts

@@ -148,10 +148,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     this._transactionOutputs.forEach((output) => {
       const amount = CardanoWasm.BigNum.from_str(output.amount);
       outputs.add(
-        CardanoWasm.TransactionOutput.new(
-          CardanoWasm.Address.from_bech32(output.address),
-          CardanoWasm.Value.new(amount)
-        )
+        CardanoWasm.TransactionOutput.new(util.getWalletAddress(output.address), CardanoWasm.Value.new(amount))
       );
       totalAmountToSend = totalAmountToSend.checked_add(amount);
     });
@@ -160,7 +157,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
       // estimate fee
       // add extra output for the change
       if (this._changeAddress && this._senderBalance) {
-        const changeAddress = CardanoWasm.Address.from_bech32(this._changeAddress);
+        const changeAddress = util.getWalletAddress(this._changeAddress);
         const utxoBalance = CardanoWasm.BigNum.from_str(this._senderBalance);
 
         const adjustment = BigNum.from_str('2000000');
@@ -188,7 +185,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
               this._multiAssets.forEach((asset) => {
                 let txOutputBuilder = CardanoWasm.TransactionOutputBuilder.new();
                 // changeAddress is the root address, which is where we want the tokens assets to be sent to
-                const toAddress = CardanoWasm.Address.from_bech32(this._changeAddress);
+                const toAddress = util.getWalletAddress(this._changeAddress);
                 txOutputBuilder = txOutputBuilder.with_address(toAddress);
                 let txOutputAmountBuilder = txOutputBuilder.next();
                 const assetName = CardanoWasm.AssetName.new(Buffer.from(asset.asset_name, 'hex'));
@@ -301,7 +298,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
         const quantity = assets!.get(assetName);
         let txOutputBuilder = CardanoWasm.TransactionOutputBuilder.new();
         const outputAmount = CardanoWasm.BigNum.from_str(output.amount);
-        const toAddress = CardanoWasm.Address.from_bech32(output.address);
+        const toAddress = util.getWalletAddress(output.address);
         txOutputBuilder = txOutputBuilder.with_address(toAddress);
         let txOutputAmountBuilder = txOutputBuilder.next();
         const multiAsset = CardanoWasm.MultiAsset.new();
@@ -314,14 +311,14 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
       } else {
         outputs.add(
           CardanoWasm.TransactionOutput.new(
-            CardanoWasm.Address.from_bech32(output.address),
+            util.getWalletAddress(output.address),
             CardanoWasm.Value.new(CardanoWasm.BigNum.from_str(output.amount))
           )
         );
       }
     });
     if (this._changeAddress && this._senderBalance) {
-      const changeAddress = CardanoWasm.Address.from_bech32(this._changeAddress);
+      const changeAddress = util.getWalletAddress(this._changeAddress);
       const utxoBalance = CardanoWasm.BigNum.from_str(this._senderBalance);
 
       const adjustment = BigNum.from_str('2000000');
@@ -348,7 +345,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
             this._multiAssets.forEach((asset) => {
               let txOutputBuilder = CardanoWasm.TransactionOutputBuilder.new();
               // changeAddress is the root address, which is where we want the tokens assets to be sent to
-              const toAddress = CardanoWasm.Address.from_bech32(this._changeAddress);
+              const toAddress = util.getWalletAddress(this._changeAddress);
               txOutputBuilder = txOutputBuilder.with_address(toAddress);
               let txOutputAmountBuilder = txOutputBuilder.next();
               const assetName = CardanoWasm.AssetName.new(Buffer.from(asset.asset_name, 'hex'));

modules/sdk-coin-ada/src/lib/utils.ts

@@ -1,4 +1,4 @@
-import { AddressFormat, BaseUtils } from '@bitgo/sdk-core';
+import { AddressFormat, BaseUtils, InvalidAddressError } from '@bitgo/sdk-core';
 import {
   BaseAddress,
   PublicKey,
@@ -11,11 +11,13 @@ import {
   Ed25519KeyHash,
   ScriptHash,
   DRepKind,
+  ByronAddress,
+  Address,
+  EnterpriseAddress,
+  PointerAddress,
 } from '@emurgo/cardano-serialization-lib-nodejs';
 import { KeyPair } from './keyPair';
 import { bech32 } from 'bech32';
-import base58 from 'bs58';
-import cbor from 'cbor';
 
 export const MIN_ADA_FOR_ONE_ASSET = '1500000';
 export const VOTE_ALWAYS_ABSTAIN = 'always-abstain';
@@ -174,17 +176,12 @@ export class Utils implements BaseUtils {
       return true;
     }
 
-    //Check for Byron-era (Base58 + CBOR)
+    //Check for Byron-era address
     try {
-      const decodedBase58 = base58.decode(address);
-
-      const cborData = cbor.decodeFirstSync(decodedBase58);
-
-      if (Array.isArray(cborData) && cborData.length >= 3) {
-        return true;
-      }
+      return ByronAddress.is_valid(address);
     } catch (e) {
-      console.log(`Address: ${address} failed Base58 + CBOR test with error: ${e}`);
+      console.log(`Address: ${address} failed Byron test with error: ${e}`);
+      console.log(e.stack);
     }
 
     return false;
@@ -247,6 +244,62 @@ export class Utils implements BaseUtils {
       : Buffer.from(serializedTx, 'base64');
     return Buffer.from(CardanoTransaction.from_bytes(bufferRawTransaction).body().to_bytes()).toString('hex');
   }
+
+  /**
+   * Decode wallet address from string.
+   * Attempts to decode as Shelley (bech32) first, then Byron (base58).
+   * @param {string} address - Valid Byron or Shelley-era address.
+   * @returns {Address} - Valid address object.
+   * @throws {InvalidAddressError} If the address is neither valid Shelley nor Byron.
+   */
+  getWalletAddress(address: string): Address {
+    if (!address || typeof address !== 'string') {
+      throw new InvalidAddressError('Provided address is not a valid string');
+    }
+
+    // Try decoding as a Shelley (bech32) address first
+    try {
+      return Address.from_bech32(address);
+    } catch (e) {
+      console.error(`Could not decode shelly address from string '${address}'`);
+    }
+
+    // Try decoding as a Byron (base58) address later
+    try {
+      return ByronAddress.from_base58(address).to_address();
+    } catch (e) {
+      console.error(`Could not decode byron address from string '${address}'`);
+    }
+    throw new InvalidAddressError('Provided string is not a valid Shelley or Byron address');
+  }
+
+  /**
+   * Decode address string from Address object.
+   * Attempts to decode as Shelley (bech32) first, then Byron (base58).
+   * @param {Address} address - Valid Address object
+   * @returns {string} - Valid Byron or Shelley-era address string.
+   * @throws {InvalidAddressError} If the Address object is neither valid Shelley nor Byron.
+   */
+  getAddressString(address: Address): string {
+    // Check all Shelley address types
+    if (
+      BaseAddress.from_address(address) ||
+      EnterpriseAddress.from_address(address) ||
+      RewardAddress.from_address(address) ||
+      PointerAddress.from_address(address)
+    ) {
+      return address.to_bech32();
+    }
+
+    // If not Shelley, try Byron
+    const byronAddress = ByronAddress.from_address(address);
+    if (byronAddress) {
+      return byronAddress.to_base58();
+    }
+
+    // If neither, it's invalid
+    throw new InvalidAddressError('Provided Address is not a valid Shelley or Byron address');
+  }
 }
 
 const utils = new Utils();