IWalletAdapter

SIP Protocol API Reference / IWalletAdapter

Interface: IWalletAdapter

Defined in: @sip-protocol/types/dist/index.d.ts:2955

Core wallet adapter interface

Chain-agnostic interface that all wallet implementations must support. Provides basic wallet operations: connection, signing, and balance queries.

Example

class SolanaWalletAdapter implements WalletAdapter {
  readonly chain = 'solana'

  async connect(): Promise<void> {
    // Connect to Phantom, Solflare, etc.
  }

  async signMessage(message: Uint8Array): Promise<Signature> {
    // Sign using connected wallet
  }
}

Extended by

PrivateWalletAdapter

Properties

chain

readonly chain: ChainId

Defined in: @sip-protocol/types/dist/index.d.ts:2957

Chain this adapter connects to

name

readonly name: string

Defined in: @sip-protocol/types/dist/index.d.ts:2959

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

address

readonly address: string

Defined in: @sip-protocol/types/dist/index.d.ts:2961

Current address (empty string if not connected)

publicKey

readonly publicKey: "" | `0x${string}`

Defined in: @sip-protocol/types/dist/index.d.ts:2963

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

connectionState

readonly connectionState: WalletConnectionState

Defined in: @sip-protocol/types/dist/index.d.ts:2967

Current connection state

Methods

connect()

connect(): Promise<void>

Defined in: @sip-protocol/types/dist/index.d.ts:2973

Connect to the wallet

Returns

Promise<void>

Throws

If connection fails

disconnect()

disconnect(): Promise<void>

Defined in: @sip-protocol/types/dist/index.d.ts:2977

Disconnect from the wallet

Returns

Promise<void>

isConnected()

isConnected(): boolean

Defined in: @sip-protocol/types/dist/index.d.ts:2981

Check if wallet is connected

Returns

boolean

signMessage()

signMessage(message): Promise<Signature>

Defined in: @sip-protocol/types/dist/index.d.ts:2989

Sign an arbitrary message

Parameters

message

Uint8Array

The message bytes to sign

Returns

Promise<Signature>

The signature

Throws

If signing fails or wallet not connected

signTransaction()

signTransaction(tx): Promise<SignedTransaction>

Defined in: @sip-protocol/types/dist/index.d.ts:2997

Sign a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<SignedTransaction>

The signed transaction

Throws

If signing fails or wallet not connected

signAndSendTransaction()

signAndSendTransaction(tx): Promise<TransactionReceipt>

Defined in: @sip-protocol/types/dist/index.d.ts:3005

Sign and broadcast a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<TransactionReceipt>

The transaction receipt

Throws

If signing or broadcast fails

getBalance()

getBalance(): Promise<bigint>

Defined in: @sip-protocol/types/dist/index.d.ts:3012

Get native token balance

Returns

Promise<bigint>

Balance in smallest unit (lamports, wei, etc.)

Throws

If query fails

getTokenBalance()

getTokenBalance(asset): Promise<bigint>

Defined in: @sip-protocol/types/dist/index.d.ts:3020

Get token balance for a specific asset

Parameters

asset

Asset

The asset to query balance for

Returns

Promise<bigint>

Balance in smallest unit

Throws

If query fails or asset not supported

on()

on<T>(event, handler): void

Defined in: @sip-protocol/types/dist/index.d.ts:3027

Subscribe to wallet events

Type Parameters

T

T extends WalletEventType

Parameters

event

T

Event type to subscribe to

handler

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

Event handler function

Returns

void

off()

off<T>(event, handler): void

Defined in: @sip-protocol/types/dist/index.d.ts:3036

Unsubscribe from wallet events

Type Parameters

T

T extends WalletEventType

Parameters

event

T

Event type to unsubscribe from

handler

Event handler to remove

Returns

void