feat: add SUI support to hdwallet-ledger

packages/hdwallet-ledger-webhid/src/transport.ts

@@ -5,6 +5,7 @@ import Solana from "@ledgerhq/hw-app-solana";
 import Trx from "@ledgerhq/hw-app-trx";
 import Transport from "@ledgerhq/hw-transport";
 import TransportWebHID from "@ledgerhq/hw-transport-webhid";
+import Sui from "@mysten/ledgerjs-hw-app-sui";
 import * as core from "@shapeshiftoss/hdwallet-core";
 import * as ledger from "@shapeshiftoss/hdwallet-ledger";
 import type {
@@ -85,6 +86,11 @@ export function translateCoinAndMethod<T extends LedgerTransportCoinType, U exte
       const methodInstance = solana[method as LedgerTransportMethodName<"Solana">].bind(solana);
       return methodInstance as LedgerTransportMethod<T, U>;
     }
+    case "Sui": {
+      const sui = new Sui(transport as Transport);
+      const methodInstance = sui[method as LedgerTransportMethodName<"Sui">].bind(sui);
+      return methodInstance as LedgerTransportMethod<T, U>;
+    }
     case "Tron": {
       const trx = new Trx(transport as Transport);
       const methodInstance = trx[method as LedgerTransportMethodName<"Tron">].bind(trx);

packages/hdwallet-ledger-webusb/src/transport.ts

@@ -5,6 +5,7 @@ import Solana from "@ledgerhq/hw-app-solana";
 import Trx from "@ledgerhq/hw-app-trx";
 import Transport from "@ledgerhq/hw-transport";
 import TransportWebUSB from "@ledgerhq/hw-transport-webusb";
+import Sui from "@mysten/ledgerjs-hw-app-sui";
 import * as core from "@shapeshiftoss/hdwallet-core";
 import { getAppAndVersion, getDeviceInfo, LedgerTransport, openApp, Thorchain } from "@shapeshiftoss/hdwallet-ledger";
 import type {
@@ -105,6 +106,11 @@ export async function translateCoinAndMethod<T extends LedgerTransportCoinType,
       const methodInstance = solana[method as LedgerTransportMethodName<"Solana">].bind(solana);
       return methodInstance as LedgerTransportMethod<T, U>;
     }
+    case "Sui": {
+      const sui = new Sui(transport as Transport);
+      const methodInstance = sui[method as LedgerTransportMethodName<"Sui">].bind(sui);
+      return methodInstance as LedgerTransportMethod<T, U>;
+    }
     case "Tron": {
       const trx = new Trx(transport as Transport);
       const methodInstance = trx[method as LedgerTransportMethodName<"Tron">].bind(trx);

packages/hdwallet-ledger/package.json

@@ -25,6 +25,7 @@
     "@ledgerhq/hw-app-trx": "^6.31.9",
     "@ledgerhq/hw-transport": "6.31.8",
     "@ledgerhq/logs": "6.13.0",
+    "@mysten/ledgerjs-hw-app-sui": "^0.7.0",
     "@shapeshiftoss/bitcoinjs-lib": "7.0.0-shapeshift.0",
     "@shapeshiftoss/hdwallet-core": "^1.62.19",
     "@solana/web3.js": "1.95.8",

packages/hdwallet-ledger/src/ledger.ts

@@ -6,6 +6,7 @@ import * as cosmos from "./cosmos";
 import * as eth from "./ethereum";
 import * as mayachain from "./mayachain";
 import * as solana from "./solana";
+import * as sui from "./sui";
 import * as thorchain from "./thorchain";
 import { LedgerTransport } from "./transport";
 import * as tron from "./tron";
@@ -148,6 +149,7 @@ export class LedgerHDWalletInfo
     core.MayachainWalletInfo,
     core.CosmosWalletInfo,
     core.SolanaWalletInfo,
+    core.SuiWalletInfo,
     core.TronWalletInfo
 {
   readonly _supportsBTCInfo = true;
@@ -156,6 +158,7 @@ export class LedgerHDWalletInfo
   readonly _supportsMayachainInfo = true;
   readonly _supportsCosmosInfo = true;
   readonly _supportsSolanaInfo = true;
+  readonly _supportsSuiInfo = true;
   readonly _supportsTronInfo = true;
 
   public getVendor(): string {
@@ -241,6 +244,14 @@ export class LedgerHDWalletInfo
     throw new Error("Method not implemented");
   }
 
+  public suiGetAccountPaths(msg: core.SuiGetAccountPaths): Array<core.SuiAccountPath> {
+    return sui.suiGetAccountPaths(msg);
+  }
+
+  public suiNextAccountPath(msg: core.SuiAccountPath): core.SuiAccountPath | undefined {
+    return sui.suiNextAccountPath(msg);
+  }
+
   public tronGetAccountPaths(msg: core.TronGetAccountPaths): Array<core.TronAccountPath> {
     return tron.tronGetAccountPaths(msg);
   }
@@ -294,6 +305,8 @@ export class LedgerHDWalletInfo
         return core.mayachainDescribePath(msg.path);
       case "Solana":
         return core.solanaDescribePath(msg.path);
+      case "Sui":
+        return core.suiDescribePath(msg.path);
       case "Tron":
         return core.tronDescribePath(msg.path);
       default:
@@ -373,6 +386,7 @@ export class LedgerHDWallet
     core.MayachainWallet,
     core.CosmosWallet,
     core.SolanaWallet,
+    core.SuiWallet,
     core.TronWallet
 {
   readonly _supportsBTC = true;
@@ -391,6 +405,7 @@ export class LedgerHDWallet
   readonly _supportsMayachain = true;
   readonly _supportsCosmos = true;
   readonly _supportsSolana = true;
+  readonly _supportsSui = true;
   readonly _supportsTron = true;
 
   _isLedger = true;
@@ -634,6 +649,16 @@ export class LedgerHDWallet
     return solana.solanaSignTx(this.transport, msg);
   }
 
+  public async suiGetAddress(msg: core.SuiGetAddress): Promise<string> {
+    await this.validateCurrentApp("Sui");
+    return sui.suiGetAddress(this.transport, msg);
+  }
+
+  public async suiSignTx(msg: core.SuiSignTx): Promise<core.SuiSignedTx | null> {
+    await this.validateCurrentApp("Sui");
+    return sui.suiSignTx(this.transport, msg);
+  }
+
   public async tronGetAddress(msg: core.TronGetAddress): Promise<string> {
     await this.validateCurrentApp("Tron");
     return tron.tronGetAddress(this.transport, msg);

packages/hdwallet-ledger/src/sui.ts

@@ -0,0 +1,97 @@
+import * as core from "@shapeshiftoss/hdwallet-core";
+
+import { LedgerTransport } from "./transport";
+import { handleError } from "./utils";
+
+// Ledger expects m/ prefix to be stripped AND all segments to be hardened for Ed25519
+function addressNListToBIP32Path(addressNList: core.BIP32Path): string {
+  // Use addressNListToHardenedBIP32 to ensure all segments are hardened, then strip m/
+  return core.addressNListToHardenedBIP32(addressNList).slice(2);
+}
+
+export async function suiGetAddress(transport: LedgerTransport, msg: core.SuiGetAddress): Promise<string> {
+  const bip32path = addressNListToBIP32Path(msg.addressNList);
+
+  try {
+    const res = await transport.call("Sui", "getPublicKey", bip32path, !!msg.showDisplay);
+    handleError(res, transport, "Unable to obtain Sui address from device.");
+
+    // Convert Uint8Array to hex string with 0x prefix
+    const addressBytes =
+      res.payload.address instanceof Uint8Array ? res.payload.address : new Uint8Array(res.payload.address);
+
+    const address = "0x" + Buffer.from(addressBytes).toString("hex");
+    return address;
+  } catch (error) {
+    console.error("[Sui Ledger] suiGetAddress error:", error);
+    throw error;
+  }
+}
+
+async function suiGetPublicKey(transport: LedgerTransport, addressNList: core.BIP32Path): Promise<string> {
+  const bip32path = addressNListToBIP32Path(addressNList);
+
+  try {
+    const res = await transport.call("Sui", "getPublicKey", bip32path, false);
+    handleError(res, transport, "Unable to obtain Sui public key from device.");
+
+    // Convert Uint8Array public key to hex string
+    const publicKeyBytes =
+      res.payload.publicKey instanceof Uint8Array ? res.payload.publicKey : new Uint8Array(res.payload.publicKey);
+
+    const publicKey = Buffer.from(publicKeyBytes).toString("hex");
+    return publicKey;
+  } catch (error) {
+    console.error("[Sui Ledger] suiGetPublicKey error:", error);
+    throw error;
+  }
+}
+
+export async function suiSignTx(transport: LedgerTransport, msg: core.SuiSignTx): Promise<core.SuiSignedTx> {
+  const bip32path = addressNListToBIP32Path(msg.addressNList);
+
+  try {
+    const res = await transport.call("Sui", "signTransaction", bip32path, Buffer.from(msg.intentMessageBytes));
+    handleError(res, transport, "Unable to sign Sui transaction.");
+
+    // Convert Uint8Array signature to hex string
+    const signatureBytes =
+      res.payload.signature instanceof Uint8Array ? res.payload.signature : new Uint8Array(res.payload.signature);
+    const signature = Buffer.from(signatureBytes).toString("hex");
+
+    const publicKey = await suiGetPublicKey(transport, msg.addressNList);
+
+    return {
+      signature,
+      publicKey,
+    };
+  } catch (error) {
+    console.error("[Sui Ledger] suiSignTx error:", error);
+    throw error;
+  }
+}
+
+export function suiGetAccountPaths(msg: core.SuiGetAccountPaths): Array<core.SuiAccountPath> {
+  return core.suiGetAccountPaths(msg);
+}
+
+export function suiNextAccountPath(msg: core.SuiAccountPath): core.SuiAccountPath | undefined {
+  const addressNList = msg.addressNList;
+  if (
+    addressNList[0] === 0x80000000 + 44 &&
+    addressNList[1] === 0x80000000 + core.slip44ByCoin("Sui") &&
+    addressNList[3] === 0x80000000 + 0 &&
+    addressNList[4] === 0x80000000 + 0
+  ) {
+    return {
+      addressNList: [
+        0x80000000 + 44,
+        0x80000000 + core.slip44ByCoin("Sui"),
+        addressNList[2] + 1,
+        0x80000000 + 0,
+        0x80000000 + 0,
+      ],
+    };
+  }
+  return undefined;
+}

packages/hdwallet-ledger/src/transport.ts

@@ -4,6 +4,7 @@ import type Eth from "@ledgerhq/hw-app-eth";
 import Solana from "@ledgerhq/hw-app-solana";
 import type Trx from "@ledgerhq/hw-app-trx";
 import type Transport from "@ledgerhq/hw-transport";
+import type Sui from "@mysten/ledgerjs-hw-app-sui";
 import * as core from "@shapeshiftoss/hdwallet-core";
 
 import type { getAppAndVersion } from "./hw/getAppAndVersion";
@@ -17,7 +18,7 @@ type MethodsOnly<T> = {
 type UnwrapPromise<T> = T extends Promise<infer R> ? R : T;
 type DefinitelyCallable<T> = T extends (...args: any) => any ? T : never;
 
-export type LedgerTransportCoinType = null | "Btc" | "Eth" | "Thorchain" | "Cosmos" | "Solana" | "Tron";
+export type LedgerTransportCoinType = null | "Btc" | "Eth" | "Thorchain" | "Cosmos" | "Solana" | "Sui" | "Tron";
 type CurriedWithTransport<T extends (transport: Transport, ...args: any) => any> = T extends (
   transport: Transport,
   ...args: infer R
@@ -44,6 +45,8 @@ type LedgerTransportMethodMap<T extends LedgerTransportCoinType> = T extends nul
   ? MethodsOnly<Cosmos>
   : T extends "Solana"
   ? MethodsOnly<Solana>
+  : T extends "Sui"
+  ? MethodsOnly<Sui>
   : T extends "Tron"
   ? MethodsOnly<Trx>
   : never;

packages/hdwallet-ledger/src/utils.ts

@@ -601,6 +601,7 @@ const appNameBySlip44: Record<number, string> = {
   145: "Bitcoin Cash",
   195: "Tron",
   501: "Solana",
+  784: "Sui",
   931: "THORChain",
 };