LedgerWalletAdapter

SIP Protocol API Reference v0.7.2

SIP Protocol API Reference / LedgerWalletAdapter

Class: LedgerWalletAdapter

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11042

Ledger wallet adapter

Supports Ethereum and Solana chains via Ledger device apps.

Extends

BaseWalletAdapter

Constructors

Constructor

new LedgerWalletAdapter(config): LedgerWalletAdapter

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11051

Parameters

config

LedgerConfig

Returns

LedgerWalletAdapter

Overrides

BaseWalletAdapter.constructor

Properties

chain

readonly chain: ChainId

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11043

Chain this adapter connects to

Overrides

BaseWalletAdapter.chain

name

readonly name: string

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11044

Wallet name/identifier (e.g., ‘phantom’, ‘metamask’)

Overrides

BaseWalletAdapter.name

Accessors

address

Get Signature

get address(): string

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:8993

Current address (empty string if not connected)

Returns

string

Current address (empty string if not connected)

Inherited from

BaseWalletAdapter.address

publicKey

Get Signature

get publicKey(): "" | `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:8994

Public key (hex encoded, empty string if not connected)

Returns

"" | `0x${string}`

Public key (hex encoded, empty string if not connected)

Inherited from

BaseWalletAdapter.publicKey

connectionState

Get Signature

get connectionState(): WalletConnectionState

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:8995

Current connection state

Returns

WalletConnectionState

Current connection state

Inherited from

BaseWalletAdapter.connectionState

deviceInfo

Get Signature

get deviceInfo(): HardwareDeviceInfo | null

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11055

Get device information

Returns

HardwareDeviceInfo | null

derivationPath

Get Signature

get derivationPath(): string

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11059

Get current derivation path

Returns

string

account

Get Signature

get account(): HardwareAccount | null

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11063

Get current account

Returns

HardwareAccount | null

Methods

on()

on<T>(event, handler): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:9000

Subscribe to wallet events

Type Parameters

T

T extends WalletEventType

Parameters

event

T

handler

WalletEventHandler<Extract<WalletConnectEvent, { type: T; }> | Extract<WalletDisconnectEvent, { type: T; }> | Extract<WalletAccountChangedEvent, { type: T; }> | Extract<WalletChainChangedEvent, { type: T; }> | Extract<WalletErrorEvent, { type: T; }>>

Returns

void

Inherited from

BaseWalletAdapter.on

off()

off<T>(event, handler): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:9006

Unsubscribe from wallet events

Type Parameters

T

T extends WalletEventType

Parameters

event

T

handler

Returns

void

Inherited from

BaseWalletAdapter.off

isConnected()

isConnected(): boolean

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:9036

Check if wallet is connected

Returns

boolean

Inherited from

BaseWalletAdapter.isConnected

connect()

connect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11067

Connect to Ledger device

Returns

Promise<void>

Overrides

BaseWalletAdapter.connect

disconnect()

disconnect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11071

Disconnect from Ledger device

Returns

Promise<void>

Overrides

BaseWalletAdapter.disconnect

signMessage()

signMessage(message): Promise<Signature>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11075

Sign a message

Parameters

message

Uint8Array

Returns

Promise<Signature>

Overrides

BaseWalletAdapter.signMessage

signTransaction()

signTransaction(tx): Promise<SignedTransaction>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11079

Sign a transaction

Parameters

signAndSendTransaction()

signAndSendTransaction(tx): Promise<TransactionReceipt>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11086

Sign and send transaction

Note: Hardware wallets can only sign, not send. This returns a signed transaction that must be broadcast separately.

Parameters

tx

UnsignedTransaction

Returns

Promise<TransactionReceipt>

Overrides

BaseWalletAdapter.signAndSendTransaction

getBalance()

getBalance(): Promise<bigint>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11092

Get native token balance

Note: Hardware wallets don’t track balances - this requires RPC.

Returns

Promise<bigint>

Overrides

BaseWalletAdapter.getBalance

getTokenBalance()

getTokenBalance(_asset): Promise<bigint>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11098

Get token balance

Note: Hardware wallets don’t track balances - this requires RPC.

Parameters

_asset

Asset

Returns

Promise<bigint>

Overrides

BaseWalletAdapter.getTokenBalance

getAccounts()

getAccounts(startIndex?, count?): Promise<HardwareAccount[]>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11102

Get multiple accounts from device

Parameters

startIndex?

number

count?

number

Returns

Promise<HardwareAccount[]>

switchAccount()

switchAccount(accountIndex): Promise<HardwareAccount>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:11106

Switch to different account index

Parameters

accountIndex

number

Returns

Promise<HardwareAccount>