Query

​

getQueryUserAccountFunction

function getQueryUserAccountFunction(
  args: GetQueryUserAccountFunctionArgs,
  deps?: GetQueryUserAccountFunctionDeps,
): QueryUserAccountFunction

​

GetQueryUserAccountFunctionArgs

• client: IUmbraClient

​

GetQueryUserAccountFunctionDeps

• accountInfoProvider?: AccountInfoProviderFunction

​

Returns

type QueryUserAccountFunction = (
  userAddress: Address,
) => Promise<QueryUserAccountResult>

​

QueryUserAccountResult

• { state: "exists"; data: EncryptedUserAccount } - The user is registered and the account was decoded.
• { state: "non_existent" } - No user account exists at this address.

​

EncryptedUserAccount

• versionByte: U8 - Schema version.
• canonicalBump: U8 - PDA canonical bump.
• isInitialised: boolean - Whether the account has been initialised.
• isActiveForAnonymousUsage: boolean - Whether anonymous (mixer) usage is enabled.
• isUserCommitmentRegistered: boolean - Whether the Poseidon commitment has been registered.
• isUserAccountX25519KeyRegistered: boolean - Whether the X25519 public key has been registered.
• x25519PublicKey: X25519PublicKey - The user’s X25519 public key (used for UTXO encryption).
• userCommitment: PoseidonHash - The user’s on-chain Poseidon commitment.
• generationIndex: U128 - Current generation index used in key derivation.
• randomGenerationSeed: U256LeBytes - Current random generation seed.

​

Errors

​

Example

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

const queryUserAccount = getQueryUserAccountFunction({ client });
const result = await queryUserAccount(userAddress);

if (result.state === "exists") {
  console.log("X25519 key:", result.data.x25519PublicKey);
  console.log("Registered for anonymous usage:", result.data.isActiveForAnonymousUsage);
} else {
  console.log("User not registered.");
}

​

getQueryEncryptedBalanceFunction

function getQueryEncryptedBalanceFunction(
  args: GetQueryEncryptedBalanceFunctionArgs,
  deps?: GetQueryEncryptedBalanceFunctionDeps,
): QueryEncryptedBalanceFunction

​

GetQueryEncryptedBalanceFunctionArgs

• client: IUmbraClient

​

GetQueryEncryptedBalanceFunctionDeps

• accountInfoProvider?: AccountInfoProviderFunction
• rcDecryptor?: RcDecryptorFunction - Override the Rescue cipher decryptor used for shared-mode balance decryption.

​

Returns

type QueryEncryptedBalanceFunction = (
  mints: readonly Address[],
) => Promise<Map<Address, QueryEncryptedBalanceResult>>

​

QueryEncryptedBalanceResult

• { state: "shared"; balance: U64 } - Shared-mode account. balance is the decrypted token amount in base units.
• { state: "mxe" } - MXE-mode account. Balance is encrypted for the Arcium network and cannot be read client-side.
• { state: "uninitialized" } - The encrypted token account exists but has not been initialised for this mint.
• { state: "non_existent" } - No encrypted token account exists for this mint.

​

Errors

​

Example

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

const queryBalances = getQueryEncryptedBalanceFunction({ client });
const balances = await queryBalances([usdcMint, solMint]);

for (const [mint, result] of balances) {
  if (result.state === "shared") {
    console.log(`${mint}: ${result.balance} base units`);
  } else if (result.state === "mxe") {
    console.log(`${mint}: MXE-encrypted, balance not readable client-side`);
  } else {
    console.log(`${mint}: ${result.state}`);
  }
}

​

QueryError

• "key-derivation" and "decryption" are only reachable from getQueryEncryptedBalanceFunction (shared-mode decryption path).