Client

​

getUmbraClientFromSigner

async function getUmbraClientFromSigner(
  args: GetUmbraClientFromSignerArgs,
  deps?: GetUmbraClientFromSignerDeps,
): Promise<IUmbraClient>

​

GetUmbraClientFromSignerArgs

• signer: IUmbraSigner - Connected wallet. Must implement signMessage and signTransaction.
• network: Network - "mainnet" | "devnet" | "localnet".
• rpcUrl: string - HTTPS RPC endpoint URL for the Solana cluster.
• rpcSubscriptionsUrl: string - WebSocket RPC endpoint URL for transaction confirmation.
• indexerApiEndpoint?: string - Base URL for the Umbra indexer (e.g. "https://acqzie0a1h.execute-api.eu-central-1.amazonaws.com"). Required for mixer operations (getFetchClaimableUtxosFunction).
• commitment?: "processed" | "confirmed" | "finalized" - Commitment level for RPC calls. Defaults to "confirmed".
• deferMasterSeedSignature?: boolean - Skip the master seed signature prompt at construction time. Defaults to false.
• versions? - Override version specifiers. Leave unset to use SDK defaults.
  • protocol?: ProtocolVersionSpecifierFunction
  • algorithm?: AlgorithmVersionSpecifierFunction
  • scheme?: SchemeVersionSpecifierFunction
• offsets? - Per-key derivation path offsets (U512). Used for key rotation - leave unset unless rotating.
  • masterViewingKey?: U512
  • poseidonPrivateKey?: U512
  • x25519UserAccountPrivateKey?: U512
  • x25519MasterViewingKeyEncryptingPrivateKey?: U512
  • mintX25519PrivateKey?: U512
  • rescueCommitmentBlindingFactor?: U512
  • randomCommitmentFactor?: U512

​

GetUmbraClientFromSignerDeps

• accountInfoProvider?: AccountInfoProviderFunction - Override the default RPC-based account fetcher.
• blockhashProvider?: GetLatestBlockhash - Override the default blockhash fetcher.
• transactionForwarder?: TransactionForwarder - Override transaction broadcasting (e.g. for Jito bundles or custom retry logic).
• epochInfoProvider?: GetEpochInfo - Override the epoch info fetcher (used for Token-2022 fee schedules).
• masterSeedStorage? - Override master seed persistence.
  • load?: MasterSeedLoaderFunction - Load the cached master seed (e.g. from encrypted local storage).
  • store?: MasterSeedStorerFunction - Persist the master seed after derivation.
  • generate?: MasterSeedGeneratorFunction - Derive the master seed from a wallet signature (override the default KMAC256-based derivation).

​

Returns

​

Example

import { getUmbraClientFromSigner } from "@umbra-privacy/sdk";

const client = await getUmbraClientFromSigner({
  signer: walletAdapter,
  network: "mainnet",
  rpcUrl: "https://api.mainnet-beta.solana.com",
  rpcSubscriptionsUrl: "wss://api.mainnet-beta.solana.com",
  indexerApiEndpoint: "https://acqzie0a1h.execute-api.eu-central-1.amazonaws.com",
});

​

IUmbraClient

• signer: IUmbraSigner - The connected wallet.
• network: Network - The configured network.
• networkConfig: NetworkConfig - On-chain program IDs and addresses for the configured network.
• versions: ResolvedVersions - Resolved protocol, algorithm, and scheme version identifiers.
• offsets: ResolvedOffsets - Resolved key derivation offsets.
• commitment: "processed" | "confirmed" | "finalized" - Configured commitment level.
• accountInfoProvider: AccountInfoProviderFunction - Account data fetcher (RPC-based or overridden).
• blockhashProvider: GetLatestBlockhash - Blockhash fetcher (RPC-based or overridden).
• transactionForwarder: TransactionForwarder - Transaction broadcaster (WebSocket-based or overridden).
• epochInfoProvider: GetEpochInfo - Epoch info fetcher (RPC-based or overridden).
• fetchMerkleProof?: FetchMerkleProofFunction - Indexer-based Merkle proof fetcher. Present only when indexerApiEndpoint is set.
• fetchUtxoData?: FetchUtxoDataFunction - Indexer-based UTXO discovery fetcher. Present only when indexerApiEndpoint is set.
• masterSeed: { load, store, generate, getMasterSeed } - Master seed storage operations. load attempts to load an existing seed, store persists it, generate derives a new seed via signature, and getMasterSeed is a convenience method combining load and generate.

​

IUmbraSigner

interface IUmbraSigner {
  readonly address: Address;
  signTransaction(transaction: SignableTransaction): Promise<SignedTransaction>;
  signTransactions(transactions: readonly SignableTransaction[]): Promise<SignedTransaction[]>;
  signMessage(message: Uint8Array): Promise<SignedMessage>;
}

​

address

• address: Address - Read-only public address.

​

signTransaction

• transaction: SignableTransaction - The versioned transaction to sign.
• Returns: Promise<SignedTransaction> - The signed transaction ready for network submission.

​

signTransactions

• transactions: readonly SignableTransaction[] - Array of transactions to sign.
• Returns: Promise<SignedTransaction[]> - The signed transactions in the same order as input.

​

signMessage

• message: Uint8Array - The bytes to sign. The SDK passes a deterministic human-readable message encoding the derivation intent.
• Returns: Promise<SignedMessage> - Contains the original message bytes, the 64-byte Ed25519 signature, and the signer’s address.

​

Network

type Network = "mainnet" | "devnet" | "localnet";