MockLedgerAdapter
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / MockLedgerAdapter
Class: MockLedgerAdapter
Section titled “Class: MockLedgerAdapter”Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11267
Mock Ledger adapter for testing
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MockLedgerAdapter(
config):MockLedgerAdapter
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11275
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”MockLedgerAdapter
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlychain:ChainId
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11268
Chain this adapter connects to
Overrides
Section titled “Overrides”
readonlyname:string
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11269
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-BYZbDjal.d.ts:8930
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-BYZbDjal.d.ts:8931
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-BYZbDjal.d.ts:8932
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-BYZbDjal.d.ts:11279
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-BYZbDjal.d.ts:11283
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-BYZbDjal.d.ts:11287
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-BYZbDjal.d.ts:8937
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-BYZbDjal.d.ts:8943
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-BYZbDjal.d.ts:8973
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-BYZbDjal.d.ts:11291
Connect to mock 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-BYZbDjal.d.ts:11295
Disconnect from mock 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-BYZbDjal.d.ts:11299
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-BYZbDjal.d.ts:11303
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-BYZbDjal.d.ts:11307
Sign and send transaction
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-BYZbDjal.d.ts:11311
Get balance (not supported by hardware wallets)
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-BYZbDjal.d.ts:11315
Get token balance (not supported by hardware wallets)
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-BYZbDjal.d.ts:11319
Get multiple accounts
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-BYZbDjal.d.ts:11323
Switch account
Parameters
Section titled “Parameters”accountIndex
Section titled “accountIndex”number
Returns
Section titled “Returns”Promise<HardwareAccount>
setShouldReject()
Section titled “setShouldReject()”setShouldReject(
shouldReject):void
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11327
Set whether device should reject signing
Parameters
Section titled “Parameters”shouldReject
Section titled “shouldReject”boolean
Returns
Section titled “Returns”void
setSigningDelay()
Section titled “setSigningDelay()”setSigningDelay(
delay):void
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11331
Set signing delay
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
simulateLock()
Section titled “simulateLock()”simulateLock():
void
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11335
Simulate device lock
Returns
Section titled “Returns”void
simulateUnlock()
Section titled “simulateUnlock()”simulateUnlock():
void
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:11339
Simulate device unlock
Returns
Section titled “Returns”void