EthereumWalletAdapter

SIP Protocol API Reference / EthereumWalletAdapter

Class: EthereumWalletAdapter

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13501

Ethereum wallet adapter implementation

Example

const adapter = new EthereumWalletAdapter({
  wallet: 'metamask',
  chainId: 1,
})

await adapter.connect()
const balance = await adapter.getBalance()

Extends

BaseWalletAdapter

Constructors

Constructor

new EthereumWalletAdapter(config?): EthereumWalletAdapter

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13511

Parameters

config?

EthereumAdapterConfig

Returns

EthereumWalletAdapter

Overrides

BaseWalletAdapter.constructor

Properties

chain

readonly chain: "ethereum"

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13502

Chain this adapter connects to

Overrides

BaseWalletAdapter.chain

name

readonly name: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13503

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

Overrides

BaseWalletAdapter.name

Accessors

address

Get Signature

get address(): string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:12528

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-DXh2IGkz.d.ts:12529

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-DXh2IGkz.d.ts:12530

Current connection state

Returns

WalletConnectionState

Current connection state

Inherited from

BaseWalletAdapter.connectionState

Methods

on()

on<T>(event, handler): void

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:12535

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-DXh2IGkz.d.ts:12541

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-DXh2IGkz.d.ts:12571

Check if wallet is connected

Returns

boolean

Inherited from

BaseWalletAdapter.isConnected

getChainId()

getChainId(): number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13515

Get current chain ID

Returns

number

getRpcEndpoint()

getRpcEndpoint(): string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13519

Get RPC endpoint URL

Returns

string

setRpcEndpoint()

setRpcEndpoint(endpoint): void

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13523

Set RPC endpoint URL

Parameters

endpoint

string

Returns

void

connect()

connect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13527

Connect to Ethereum wallet

Returns

Promise<void>

Overrides

BaseWalletAdapter.connect

disconnect()

disconnect(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13531

Disconnect from wallet

Returns

Promise<void>

Overrides

BaseWalletAdapter.disconnect

signMessage()

signMessage(message): Promise<Signature>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13535

Sign a message

Parameters

message

Uint8Array

Returns

Promise<Signature>

Overrides

BaseWalletAdapter.signMessage

signTypedData()

signTypedData(typedData): Promise<Signature>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13539

Sign typed data (EIP-712)

Parameters

typedData

EIP712TypedData

Returns

Promise<Signature>

signTransaction()

signTransaction(tx): Promise<SignedTransaction>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13543

Sign a transaction without sending

Parameters

signAndSendTransaction()

signAndSendTransaction(tx): Promise<TransactionReceipt>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13547

Sign and send a transaction

Parameters

tx

UnsignedTransaction

Returns

Promise<TransactionReceipt>

Overrides

BaseWalletAdapter.signAndSendTransaction

getBalance()

getBalance(): Promise<bigint>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13551

Get ETH balance

Returns

Promise<bigint>

Overrides

BaseWalletAdapter.getBalance

getTokenBalance()

getTokenBalance(asset): Promise<bigint>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13555

Get ERC-20 token balance

Parameters

asset

Asset

Returns

Promise<bigint>

Overrides

BaseWalletAdapter.getTokenBalance

switchChain()

switchChain(chainId): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13559

Switch to a different chain

Parameters

chainId

number

Returns

Promise<void>

waitForTransaction()

waitForTransaction(txHash, confirmations?): Promise<EthereumTransactionReceipt>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:13563

Wait for transaction confirmation

Parameters

txHash

string

confirmations?

number

Returns

Promise<EthereumTransactionReceipt>