PrivateWalletAdapter

SIP Protocol API Reference / PrivateWalletAdapter

Interface: PrivateWalletAdapter

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

Privacy-enhanced wallet adapter

Extends WalletAdapter with privacy features:

Stealth address generation and scanning
Viewing key export for compliance
Shielded transaction support

Example

class ZcashPrivateWallet implements PrivateWalletAdapter {
  // ... WalletAdapter methods ...

  getStealthMetaAddress(): StealthMetaAddress {
    return this.stealthMeta
  }

  async shieldedSend(params: ShieldedSendParams): Promise<ShieldedSendResult> {
    // Use Zcash shielded pool
  }
}

Extends

IWalletAdapter

Properties

chain

readonly chain: ChainId

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

Chain this adapter connects to

Inherited from

IWalletAdapter.chain

name

readonly name: string

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

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

Inherited from

IWalletAdapter.name

address

readonly address: string

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

Current address (empty string if not connected)

Inherited from

IWalletAdapter.address

publicKey

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

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

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

Inherited from

IWalletAdapter.publicKey

connectionState

readonly connectionState: WalletConnectionState

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

Current connection state

Inherited from

IWalletAdapter.connectionState

Methods

connect()

connect(): Promise<void>

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

Connect to the wallet

Returns

Promise<void>

Throws

If connection fails

Inherited from

IWalletAdapter.connect

disconnect()

disconnect(): Promise<void>

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

Disconnect from the wallet

Returns

Promise<void>

Inherited from

IWalletAdapter.disconnect

isConnected()

isConnected(): boolean

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

Check if wallet is connected

Returns

boolean

Inherited from

IWalletAdapter.isConnected

signMessage()

signMessage(message): Promise<Signature>

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

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

Inherited from

IWalletAdapter.signMessage

signTransaction()

signTransaction(tx): Promise<SignedTransaction>

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

Sign a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<SignedTransaction>

The signed transaction

Throws

If signing fails or wallet not connected

Inherited from

IWalletAdapter.signTransaction

signAndSendTransaction()

signAndSendTransaction(tx): Promise<TransactionReceipt>

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

Sign and broadcast a transaction

Parameters

tx

UnsignedTransaction

The unsigned transaction

Returns

Promise<TransactionReceipt>

The transaction receipt

Throws

If signing or broadcast fails

Inherited from

IWalletAdapter.signAndSendTransaction

getBalance()

getBalance(): Promise<bigint>

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

Get native token balance

Returns

Promise<bigint>

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

Throws

If query fails

Inherited from

IWalletAdapter.getBalance

getTokenBalance()

getTokenBalance(asset): Promise<bigint>

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

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

Inherited from

IWalletAdapter.getTokenBalance

on()

on<T>(event, handler): void

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

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

Inherited from

IWalletAdapter.on

off()

off<T>(event, handler): void

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

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

Inherited from

IWalletAdapter.off

supportsStealthAddresses()

supportsStealthAddresses(): boolean

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

Check if wallet supports stealth addresses

Returns

boolean

getStealthMetaAddress()

getStealthMetaAddress(): StealthMetaAddress

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

Get the stealth meta-address for receiving private payments

The meta-address contains spending and viewing public keys that senders use to derive one-time stealth addresses.

Returns

StealthMetaAddress

The stealth meta-address

Throws

If stealth addresses not supported

deriveStealthAddress()

deriveStealthAddress(ephemeralPubKey): StealthAddress

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

Generate a one-time stealth address from an ephemeral public key

Used by senders to derive a unique receiving address.

Parameters

ephemeralPubKey

`0x${string}`

Sender’s ephemeral public key

Returns

StealthAddress

The derived stealth address

checkStealthAddress()

checkStealthAddress(stealthAddress, ephemeralPubKey): boolean

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

Check if a stealth address belongs to this wallet

Parameters

stealthAddress

`0x${string}`

The address to check

ephemeralPubKey

`0x${string}`

The ephemeral public key used

Returns

boolean

True if this wallet can spend from the address

scanStealthPayments()

scanStealthPayments(fromBlock?, toBlock?): Promise<object[]>

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

Scan for received stealth payments

Scans announcements/transactions to find payments to this wallet’s stealth addresses.

Parameters

fromBlock?

bigint

Optional starting block

toBlock?

bigint

Optional ending block

Returns

Promise<object[]>

Array of detected stealth addresses with amounts

supportsViewingKeys()

supportsViewingKeys(): boolean

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

Check if wallet supports viewing key export

Returns

boolean

exportViewingKey()

exportViewingKey(): ViewingKey

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

Export viewing key for selective disclosure

Allows third parties (auditors, regulators) to view transaction details without spending capability.

Returns

ViewingKey

The viewing key

Throws

If viewing keys not supported

supportsShieldedTransactions()

supportsShieldedTransactions(): boolean

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

Check if wallet supports shielded transactions

Returns

boolean

getShieldedBalance()

getShieldedBalance(): Promise<bigint>

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

Get shielded balance (in shielded pools, if applicable)

Returns

Promise<bigint>

Shielded balance in smallest unit

shieldedSend()

shieldedSend(params): Promise<WalletShieldedSendResult>

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

Send tokens with maximum privacy

Uses shielded pools and/or stealth addresses depending on the target chain’s capabilities.

Parameters

params

WalletShieldedSendParams

Shielded send parameters

Returns

Promise<WalletShieldedSendResult>

The transaction result

Throws

If shielded send fails