Conversion

Documentation Index

Fetch the complete documentation index at: https://sdk.umbraprivacy.com/llms.txt

Use this file to discover all available pages before exploring further.

​

getNetworkEncryptionToSharedEncryptionConverterFunction

function getNetworkEncryptionToSharedEncryptionConverterFunction(
  args: GetNetworkEncryptionToSharedEncryptionConverterFunctionArgs,
  deps?: GetNetworkEncryptionToSharedEncryptionConverterFunctionDeps,
): NetworkEncryptionToSharedEncryptionConverterFunction

​

GetNetworkEncryptionToSharedEncryptionConverterFunctionArgs

• client: IUmbraClient

​

GetNetworkEncryptionToSharedEncryptionConverterFunctionDeps

• accountInfoProvider?: AccountInfoProviderFunction
• getLatestBlockhash?: GetLatestBlockhash
• transactionForwarder?: TransactionForwarder

​

Returns

type NetworkEncryptionToSharedEncryptionConverterFunction = (
  mints: readonly Address[],
  optionalData?: OptionalData32,
  callbacks?: TransactionCallbacks,
) => Promise<ConvertToSharedEncryptionResult>

• mints: readonly Address[] - Token mints to convert. Processed sequentially - each successful conversion is independent.

​

ConvertToSharedEncryptionResult

interface ConvertToSharedEncryptionResult {
  converted: Map<Address, TransactionSignature>;
  skipped: Map<Address, ConvertToSharedEncryptionSkipReason>;
}

• converted - Mints successfully converted. Value is the transaction signature.
• skipped - Mints not converted. Value is the reason.

​

ConvertToSharedEncryptionSkipReason

• "non_existent" - No encrypted token account exists for this mint.
• "not_initialised" - The encrypted token account has not been initialised.
• "already_shared" - This mint is already in shared mode.
• "balance_not_initialised" - The balance state is not yet initialised (e.g. no deposits have occurred).

​

Errors

​

Example

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

const convert = getNetworkEncryptionToSharedEncryptionConverterFunction({ client });
const result = await convert([usdcMint, solMint]);

for (const [mint, sig] of result.converted) {
  console.log(`Converted ${mint}:`, sig);
}
for (const [mint, reason] of result.skipped) {
  console.log(`Skipped ${mint}: ${reason}`);
}

​

getMintEncryptionKeyRotatorFunction

function getMintEncryptionKeyRotatorFunction(
  args: GetMintEncryptionKeyRotatorFunctionArgs,
  deps?: GetMintEncryptionKeyRotatorFunctionDeps,
): MintEncryptionKeyRotatorFunction

​

GetMintEncryptionKeyRotatorFunctionArgs

• client: IUmbraClient

​

GetMintEncryptionKeyRotatorFunctionDeps

• accountInfoProvider?: AccountInfoProviderFunction
• getLatestBlockhash?: GetLatestBlockhash
• transactionForwarder?: TransactionForwarder
• mintX25519KeypairGenerator?: MintX25519KeypairGeneratorFunction - Override the per-mint X25519 keypair derivation.

​

Returns

type MintEncryptionKeyRotatorFunction = (
  mint: Address,
  optionalData?: OptionalData32,
  callbacks?: TransactionCallbacks,
) => Promise<TransactionSignature>

• mint: Address - The token mint whose X25519 key to rotate.

​

Errors

​

Example

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

const rotateMintKey = getMintEncryptionKeyRotatorFunction({ client });
const signature = await rotateMintKey(usdcMint);

​

ConversionError