Abstract Class: BaseWalletAdapter

SIP Protocol API Reference v0.7.0

---

SIP Protocol API Reference / BaseWalletAdapter

Abstract Class: BaseWalletAdapter

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8924

Abstract base class for wallet adapters

Provides:

• Event emitter infrastructure
• Connection state management
• Common validation logic

Subclasses must implement:

• connect() / disconnect()
• signMessage() / signTransaction() / signAndSendTransaction()
• getBalance() / getTokenBalance()

Example

class MyWalletAdapter extends BaseWalletAdapter {
  readonly chain = 'solana'
  readonly name = 'my-wallet'

  async connect(): Promise<void> {
    // Implementation
  }

  // ... other required methods
}

Extended by

• EthereumWalletAdapter
• LedgerWalletAdapter
• MockEthereumAdapter
• MockLedgerAdapter
• MockSolanaAdapter
• MockTrezorAdapter
• MockWalletAdapter
• SolanaWalletAdapter
• TrezorWalletAdapter

Implements

• IWalletAdapter

Constructors

Constructor

new BaseWalletAdapter(): BaseWalletAdapter

Returns

BaseWalletAdapter

Properties

chain

abstract readonly chain: ChainId

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8925

Chain this adapter connects to

Implementation of

IWalletAdapter.chain

---

name

abstract readonly name: string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8926

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

Implementation of

IWalletAdapter.name

Accessors

address

Get Signature

get address(): string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8930

Current address (empty string if not connected)

Returns

string

Current address (empty string if not connected)

Implementation of

IWalletAdapter.address

---

publicKey

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

"" | `0x${string}`

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

Implementation of

IWalletAdapter.publicKey

---

connectionState

Get Signature

get connectionState(): WalletConnectionState

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8932

Current connection state

Returns

WalletConnectionState

Current connection state

Implementation of

IWalletAdapter.connectionState

Methods

on()

on<T>(event, handler): void

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8937

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

Implementation of

IWalletAdapter.on

---

off()

off<T>(event, handler): void

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8943

Unsubscribe from 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

Implementation of

IWalletAdapter.off

---

isConnected()

isConnected(): boolean

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8973

Check if wallet is connected

Returns

boolean

Implementation of

IWalletAdapter.isConnected

---

connect()

abstract connect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8990

Connect to the wallet

Returns

Promise<void>

Throws

If connection fails

Implementation of

IWalletAdapter.connect

---

disconnect()

abstract disconnect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8991

Disconnect from the wallet

Returns

Promise<void>

Implementation of

IWalletAdapter.disconnect

---

signMessage()

abstract signMessage(message): Promise<Signature>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8992

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

Implementation of

IWalletAdapter.signMessage

---

signTransaction()

abstract signTransaction(tx): Promise<SignedTransaction>

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

Sign a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<SignedTransaction>

The signed transaction

Throws

If signing fails or wallet not connected

Implementation of

IWalletAdapter.signTransaction

---

signAndSendTransaction()

abstract signAndSendTransaction(tx): Promise<TransactionReceipt>

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

Sign and broadcast a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<TransactionReceipt>

The transaction receipt

Throws

If signing or broadcast fails

Implementation of

IWalletAdapter.signAndSendTransaction

---

getBalance()

abstract getBalance(): Promise<bigint>

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

Get native token balance

Returns

Promise<bigint>

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

Throws

If query fails

Implementation of

IWalletAdapter.getBalance

---

getTokenBalance()

abstract getTokenBalance(asset): Promise<bigint>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:8996

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

Implementation of

IWalletAdapter.getTokenBalance