generateStealthMetaAddress()

SIP Protocol API Reference / generateStealthMetaAddress

Function: generateStealthMetaAddress()

generateStealthMetaAddress(chain, label?): object

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

Generate a new stealth meta-address keypair for receiving private payments

Creates a reusable meta-address that senders can use to derive one-time stealth addresses. The recipient publishes the meta-address publicly, and senders generate unique payment addresses from it.

Security: Private keys must be stored securely and never shared. The meta-address (containing only public keys) can be safely published.

Algorithm: Uses secp256k1 elliptic curve (EIP-5564 style) for:

Ethereum, Polygon, Arbitrum, Optimism, Base, Bitcoin, Zcash

For Solana/NEAR/Aptos/Sui chains, use generateEd25519StealthMetaAddress instead.

Parameters

chain

ChainId

Target blockchain network (determines address format)

label?

string

Optional human-readable label for identification

Returns

object

Object containing:

metaAddress: Public keys to share with senders
spendingPrivateKey: Secret key for claiming funds (keep secure!)
viewingPrivateKey: Secret key for scanning incoming payments (keep secure!)

metaAddress

metaAddress: StealthMetaAddress

spendingPrivateKey

spendingPrivateKey: `0x${string}`

viewingPrivateKey

viewingPrivateKey: `0x${string}`

Throws

If chain is invalid or not supported

Examples

import { generateStealthMetaAddress, encodeStealthMetaAddress } from '@sip-protocol/sdk'

// Generate keys
const { metaAddress, spendingPrivateKey, viewingPrivateKey } =
  generateStealthMetaAddress('ethereum', 'My Privacy Wallet')

// Encode for sharing (QR code, website, etc.)
const encoded = encodeStealthMetaAddress(metaAddress)
console.log('Share this:', encoded)
// Output: "sip:ethereum:0x02abc...123:0x03def...456"

// Store private keys securely (e.g., encrypted keystore)
secureStorage.save({
  spendingPrivateKey,
  viewingPrivateKey,
})

// Generate different stealth keys for each chain
const ethKeys = generateStealthMetaAddress('ethereum', 'ETH Privacy')
const zkKeys = generateStealthMetaAddress('zcash', 'ZEC Privacy')

// Publish meta-addresses
publishToProfile({
  ethereum: encodeStealthMetaAddress(ethKeys.metaAddress),
  zcash: encodeStealthMetaAddress(zkKeys.metaAddress),
})

See

generateStealthAddress to generate payment addresses as a sender
encodeStealthMetaAddress to encode for sharing
deriveStealthPrivateKey to claim funds as a recipient
generateEd25519StealthMetaAddress for Solana/NEAR chains