LedgerWalletAdapter
SIP Protocol API Reference v0.15.1
SIP Protocol API Reference / LedgerWalletAdapter
Class: LedgerWalletAdapter
Section titled “Class: LedgerWalletAdapter”Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14761
Ledger wallet adapter
Supports Ethereum and Solana chains via Ledger device apps.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LedgerWalletAdapter(
config):LedgerWalletAdapter
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14770
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”LedgerWalletAdapter
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlychain:ChainId
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14762
Chain this adapter connects to
Overrides
Section titled “Overrides”
readonlyname:string
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14763
Wallet name/identifier (e.g., ‘phantom’, ‘metamask’)
Overrides
Section titled “Overrides”Accessors
Section titled “Accessors”address
Section titled “address”Get Signature
Section titled “Get Signature”get address():
string
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12601
Current address (empty string if not connected)
Returns
Section titled “Returns”string
Current address (empty string if not connected)
Inherited from
Section titled “Inherited from”publicKey
Section titled “publicKey”Get Signature
Section titled “Get Signature”get publicKey():
""|`0x${string}`
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12602
Public key (hex encoded, empty string if not connected)
Returns
Section titled “Returns”"" | `0x${string}`
Public key (hex encoded, empty string if not connected)
Inherited from
Section titled “Inherited from”connectionState
Section titled “connectionState”Get Signature
Section titled “Get Signature”get connectionState():
WalletConnectionState
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12603
Current connection state
Returns
Section titled “Returns”Current connection state
Inherited from
Section titled “Inherited from”BaseWalletAdapter.connectionState
deviceInfo
Section titled “deviceInfo”Get Signature
Section titled “Get Signature”get deviceInfo():
HardwareDeviceInfo|null
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14774
Get device information
Returns
Section titled “Returns”HardwareDeviceInfo | null
derivationPath
Section titled “derivationPath”Get Signature
Section titled “Get Signature”get derivationPath():
string
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14778
Get current derivation path
Returns
Section titled “Returns”string
account
Section titled “account”Get Signature
Section titled “Get Signature”get account():
HardwareAccount|null
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14782
Get current account
Returns
Section titled “Returns”HardwareAccount | null
Methods
Section titled “Methods”on<
T>(event,handler):void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12608
Subscribe to wallet events
Type Parameters
Section titled “Type Parameters”T extends WalletEventType
Parameters
Section titled “Parameters”T
handler
Section titled “handler”WalletEventHandler<Extract<WalletConnectEvent, { type: T; }> | Extract<WalletDisconnectEvent, { type: T; }> | Extract<WalletAccountChangedEvent, { type: T; }> | Extract<WalletChainChangedEvent, { type: T; }> | Extract<WalletErrorEvent, { type: T; }>>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”off<
T>(event,handler):void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12614
Unsubscribe from wallet events
Type Parameters
Section titled “Type Parameters”T extends WalletEventType
Parameters
Section titled “Parameters”T
handler
Section titled “handler”WalletEventHandler<Extract<WalletConnectEvent, { type: T; }> | Extract<WalletDisconnectEvent, { type: T; }> | Extract<WalletAccountChangedEvent, { type: T; }> | Extract<WalletChainChangedEvent, { type: T; }> | Extract<WalletErrorEvent, { type: T; }>>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”isConnected()
Section titled “isConnected()”isConnected():
boolean
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:12644
Check if wallet is connected
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”connect()
Section titled “connect()”connect():
Promise<void>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14786
Connect to Ledger device
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14790
Disconnect from Ledger device
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”signMessage()
Section titled “signMessage()”signMessage(
message):Promise<Signature>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14794
Sign a message
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”Promise<Signature>
Overrides
Section titled “Overrides”signTransaction()
Section titled “signTransaction()”signTransaction(
tx):Promise<SignedTransaction>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14798
Sign a transaction
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SignedTransaction>
Overrides
Section titled “Overrides”BaseWalletAdapter.signTransaction
signAndSendTransaction()
Section titled “signAndSendTransaction()”signAndSendTransaction(
tx):Promise<TransactionReceipt>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14805
Sign and send transaction
Note: Hardware wallets can only sign, not send. This returns a signed transaction that must be broadcast separately.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<TransactionReceipt>
Overrides
Section titled “Overrides”BaseWalletAdapter.signAndSendTransaction
getBalance()
Section titled “getBalance()”getBalance():
Promise<bigint>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14811
Get native token balance
Note: Hardware wallets don’t track balances - this requires RPC.
Returns
Section titled “Returns”Promise<bigint>
Overrides
Section titled “Overrides”getTokenBalance()
Section titled “getTokenBalance()”getTokenBalance(
_asset):Promise<bigint>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14817
Get token balance
Note: Hardware wallets don’t track balances - this requires RPC.
Parameters
Section titled “Parameters”_asset
Section titled “_asset”Returns
Section titled “Returns”Promise<bigint>
Overrides
Section titled “Overrides”BaseWalletAdapter.getTokenBalance
getAccounts()
Section titled “getAccounts()”getAccounts(
startIndex?,count?):Promise<HardwareAccount[]>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14821
Get multiple accounts from device
Parameters
Section titled “Parameters”startIndex?
Section titled “startIndex?”number
count?
Section titled “count?”number
Returns
Section titled “Returns”Promise<HardwareAccount[]>
switchAccount()
Section titled “switchAccount()”switchAccount(
accountIndex):Promise<HardwareAccount>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:14825
Switch to different account index
Parameters
Section titled “Parameters”accountIndex
Section titled “accountIndex”number
Returns
Section titled “Returns”Promise<HardwareAccount>