@exodus/hw-common

ensureDeviceReady(params) Ensures the device is ready for operations on a specific asset. - For Ledger: ensures the correct application is open - For Trezor: ensures the correct wallet context (passphrase) is active

SignMessageParams

SignTransactionParams

TokenAccountInfo

EnsureDeviceReadyParams

HardwareWalletAssetHandler

HardwareWalletDescriptor

HardwareWalletDevice

HardwareWalletDiscovery

SignTransactionParams

signTransaction(...)

TokenAccountInfo

Token account info for Solana hardware wallet signing (Trezor).

Type Aliases

Bytes

EnsureApplicationIsOpenedParams

HardwareWalletSupportEntry

HardwareWalletSupportMatrix

InternalDescriptor

LedgerDescriptorBLE

LedgerDescriptorTCP

LedgerDescriptorWebUSB

EnsureApplicationIsOpenedParams

ensureApplicationIsOpened(assetName)

HardwareWalletSupportEntry

HardwareWalletSupportMatrix

HardwareWalletSupportMatrix This is a map of supported hardware wallets, where the key is the manufacturer and the value is an object with the supported models. An object of this type MAY be exposed on asset.baseAsset.api.features.hardwareWallets?.supportMatrix to indicate the supported hardware wallets and models for the asset.

LedgerDescriptorWebUSB

LedgerManufacturer

LedgerModels

SignableTransactions are the transactions in serialized format to be signed.

SignableTransaction

AssetUnsupportedError

class

Constructor

constructor

AssetUnsupportedError(assetName: string): AssetUnsupportedError

Parameters:

assetName: string

Returns:

AssetUnsupportedError

Properties

assetName

string

name

string

DeviceConnectionError

class

Constructor

constructor

DeviceConnectionError(cause: Error): DeviceConnectionError

Parameters:

cause: Error

Returns:

DeviceConnectionError

Properties

name

string

DeviceLockedError

class

Constructor

constructor

DeviceLockedError(): DeviceLockedError

Returns:

DeviceLockedError

Properties

name

string

DeviceUninitializedError

class

Constructor

constructor

DeviceUninitializedError(): DeviceUninitializedError

Returns:

DeviceUninitializedError

Properties

name

string

HardwareWalletError

class

Constructor

constructor

HardwareWalletError(message?: string): HardwareWalletError

Parameters:

message (optional): string

Returns:

HardwareWalletError(message?: string, options?: ErrorOptions): HardwareWalletError

Parameters:

message (optional): string

options (optional): ErrorOptions

Returns:

HardwareWalletManufacturerMismatchError

Properties

name

string

HardwareWalletManufacturerMismatchError

class

Constructor

constructor

HardwareWalletManufacturerMismatchError(__namedParameters: any): HardwareWalletManufacturerMismatchError

Parameters:

__namedParameters: any

Returns:

Properties

actual

string

expected

string

name

string

NoDeviceFoundError

class

Constructor

constructor

NoDeviceFoundError(): NoDeviceFoundError

Returns:

NoDeviceFoundError

Properties

name

string

PassphraseProtectionEnableFailedError

class

Constructor

constructor

PassphraseProtectionEnableFailedError(): PassphraseProtectionEnableFailedError

Returns:

PassphraseProtectionEnableFailedError

Properties

name

string

SignMessageUnsupportedError

class

Constructor

constructor

SignMessageUnsupportedError(): SignMessageUnsupportedError

Returns:

SignMessageUnsupportedError

Properties

name

string

UserRefusedError

class

Constructor

constructor

UserRefusedError(onDevice: boolean): UserRefusedError

Parameters:

onDevice: boolean

Returns:

UserRefusedError

Properties

name

string

onDevice

boolean

WrongWalletSelectedError

class

Constructor

constructor

WrongWalletSelectedError(): WrongWalletSelectedError

Returns:

WrongWalletSelectedError

Properties

name

string

XPubUnsupportedError

class

Constructor

constructor

XPubUnsupportedError(): XPubUnsupportedError

Returns:

XPubUnsupportedError

Properties

name

string

EnsureDeviceReadyParams

interface

Properties

baseAssetName

string

walletAccount

any

GetAddressParams

interface

Properties

assetName

string

derivationPath

string

displayOnDevice?

boolean

multisigData?

GetPublicKeyParams

interface

Properties

assetName

string

derivationPath

string

GetXPubParams

interface

Properties

assetName

string

derivationPath

string

HardwareWalletAssetHandler

interface

Properties

getAddress

any

getPublicKey

any

getXPub

any

signMessage

any

signTransaction

any

HardwareWalletDescriptor

interface

Properties

get

any

internalDescriptor

InternalDescriptor

manufacturer

model

name

string

transport

TransportTypes

HardwareWalletDevice

interface

Properties

cancelAction

any

ensureApplicationIsOpened?

any

ensureDeviceReady

any

getAddress

any

getPublicKey

any

getWalletId?

any

getXPub

any

listInstalledAssetNames

any

listSupportedAssetNames

any

listUseableAssetNames

any

signMessage

any

signTransaction

any

Accessors

descriptor

HardwareWalletDiscovery

interface

Properties

list

any

scan

any

stopScan

any

Message

interface

Properties

rawMessage?

Readonly

MultisigData

interface

Properties

internalXpub

string

threshold

number

xpubs

string[]

SignMessageParams

interface

Properties

assetName

string

derivationPath

string

message

IMessage

SignTransactionParams

interface

Properties

assetName

string

derivationPaths

any

derivationPathsMap?

Record

isNft?

boolean

multisigData?

signableTransaction

SignableTransaction

tokenAccountsInfos?

TokenAccountInfo[]

TokenAccountInfo

interface

Properties

baseAddress

string

tokenAccount

string

tokenMint

string

tokenProgram

string

Bytes

type

EnsureApplicationIsOpenedParams

type

HardwareWalletDeviceModels

type

HardwareWalletManufacturer

type

HardwareWalletSupportEntry

type

Properties

models

LedgerModels | TrezorModels[]

HardwareWalletSupportMatrix

type

InternalDescriptor

type

LedgerDescriptorBLE

type

Properties

localName

string

serviceUUIDs

any

LedgerDescriptorTCP

type

Properties

apduPort

number

LedgerDescriptorWebUSB

type

LedgerManufacturer

type

LedgerModels

type

SignableTransaction

type

Signatures

type

TransportTypes

type

TrezorManufacturer

type

TrezorModels

type

AssetUnsupportedError

class

Constructor

constructor

AssetUnsupportedError(assetName: string): AssetUnsupportedError

Parameters:

assetName: string

Returns:

AssetUnsupportedError

Properties

assetName

string

name

string

DeviceConnectionError

class

Constructor

constructor

DeviceConnectionError(cause: Error): DeviceConnectionError

Parameters:

cause: Error

Returns:

DeviceConnectionError

Properties

name

string

DeviceLockedError

class

Constructor

constructor

DeviceLockedError(): DeviceLockedError

Returns:

DeviceLockedError

Properties

name

string

DeviceUninitializedError

class

Constructor

constructor

DeviceUninitializedError(): DeviceUninitializedError

Returns:

DeviceUninitializedError

Properties

name

string

HardwareWalletError

class

Constructor

constructor

HardwareWalletError(message?: string): HardwareWalletError

Parameters:

message (optional): string

Returns:

HardwareWalletError(message?: string, options?: ErrorOptions): HardwareWalletError

Parameters:

message (optional): string

options (optional): ErrorOptions

Returns:

HardwareWalletManufacturerMismatchError

Properties

name

string

HardwareWalletManufacturerMismatchError

class

Constructor

constructor

HardwareWalletManufacturerMismatchError(__namedParameters: any): HardwareWalletManufacturerMismatchError

Parameters:

__namedParameters: any

Returns:

Properties

actual

string

expected

string

name

string

NoDeviceFoundError

class

Constructor

constructor

NoDeviceFoundError(): NoDeviceFoundError

Returns:

NoDeviceFoundError

Properties

name

string

PassphraseProtectionEnableFailedError

class

Constructor

constructor

PassphraseProtectionEnableFailedError(): PassphraseProtectionEnableFailedError

Returns:

PassphraseProtectionEnableFailedError

Properties

name

string

SignMessageUnsupportedError

class

Constructor

constructor

SignMessageUnsupportedError(): SignMessageUnsupportedError

Returns:

SignMessageUnsupportedError

Properties

name

string

UserRefusedError

class

Constructor

constructor

UserRefusedError(onDevice: boolean): UserRefusedError

Parameters:

onDevice: boolean

Returns:

UserRefusedError

Properties

name

string

onDevice

boolean

WrongWalletSelectedError

class

Constructor

constructor

WrongWalletSelectedError(): WrongWalletSelectedError

Returns:

WrongWalletSelectedError

Properties

name

string

XPubUnsupportedError

class

Constructor

constructor

XPubUnsupportedError(): XPubUnsupportedError

Returns:

XPubUnsupportedError

Properties

name

string

EnsureDeviceReadyParams

interface

Properties

baseAssetName

string

walletAccount

any

GetAddressParams

interface

getAddress(...)

Properties

assetName

string

derivationPath

string

displayOnDevice?

boolean

multisigData?

GetPublicKeyParams

interface

getPublicKey(...)

Properties

assetName

string

derivationPath

string

GetXPubParams

interface

getXPub(...)

Properties

assetName

string

derivationPath

string

HardwareWalletAssetHandler

interface

HardwareWalletAssetHandler

Properties

getAddress

any

getPublicKey

any

getXPub

any

signMessage

any

signTransaction

any

HardwareWalletDescriptor

interface

HardwareWalletDescriptor

Properties

get

any

internalDescriptor

InternalDescriptor

manufacturer

model

name

string

transport

TransportTypes

HardwareWalletDevice

interface

HardwareWalletDevice

Properties

cancelAction

any

ensureApplicationIsOpened?

any

ensureDeviceReady

any

getAddress

any

getPublicKey

any

getWalletId?

any

getXPub

any

listInstalledAssetNames

any

listSupportedAssetNames

any

listUseableAssetNames

any

signMessage

any

signTransaction

any

Accessors

descriptor

HardwareWalletDiscovery

interface

HardwareWalletDiscovery

Properties

list

any

scan

any

stopScan

any

Message

interface

Properties

rawMessage?

Readonly

MultisigData

interface

Properties

internalXpub

string

threshold

number

xpubs

string[]

SignMessageParams

interface

signMessage(...)

Properties

assetName

string

derivationPath

string

message

IMessage

SignTransactionParams

interface

signTransaction(...)

Properties

assetName

string

derivationPaths

any

derivationPathsMap?

Record

isNft?

Token-standard hint for hardware clear-signing (EVM). true = NFT (ERC-721/ERC-1155) interaction, false = fungible/ERC-20, undefined = unknown (device default). Derived upstream from an on-chain supportsInterface check; lets the device disambiguate the shared `approve`/`transferFrom` selectors instead of guessing from calldata.

boolean

multisigData?