Skip to main content

Packages & public exports

Stable entry-point exports for each published package (see the version in that package’s package.json, e.g. 0.2.x). For the recommended app path, see ZkpClient and ZkpWallet.

@zk-privacy/web​

ExportKind
createWebClientasync (config?: ZkpClientConfig) => Promise<ZkpClient>
IndexedDBStorage, LocalStorageStorage adapters
IndexedDBStealthStoreIStealthStore for stealth metadata
TypesZkpClientConfig, ConnectedWalletConfig, StorageAdapter, ZkpClient, ZkpWallet (re-exported from core)

@zk-privacy/node​

ExportKind
createNodeClientasync (config?: ZkpClientConfig) => Promise<ZkpClient>
FileStorageFilesystem StorageAdapter
TypesZkpClientConfig, ConnectedWalletConfig, StorageAdapter, ZkpClient, ZkpWallet (re-exported from core)

@zk-privacy/core/types​

Interfaces-only entry for custom backends (no heavy runtime):

  • ISolverBackend, IProverBackend, IProverService, CircuitLoader, SolverInitInfo, SolveResult, ProveRequest, ProveResult, ProveCircuit
  • StorageAdapter
  • Stealth: IStealthStore, StealthAddress, SerializedStealthAddress, CreateStealthOptions, StealthKeys
  • Client config types: ZkpClientConfig, ConnectedWalletConfig, Recipient, TokenConfig, HistoryItem, HistoryOptions

@zk-privacy/core (main)​

Grumpkin​

Types: Point.

Values: grumpkin, POINT_ZERO, GRUMPKIN_FIELD_ORDER, GRUMPKIN_CURVE_ORDER, scalarMulBase, scalarMul, pointAdd, pointSub, pointNegate, pointEquals, isZeroPoint, isOnCurve, randomScalar, mod, bigintToBytes32, bytes32ToBigint, pointToHex.

ElGamal​

Types: ElGamalCiphertext.

Values: ZERO_CIPHERTEXT, encrypt, decryptToPoint, homomorphicAdd, homomorphicSub, homomorphicScalarMul, rerandomize, verifyEncryption, verifyDecryption, isZeroCiphertext, ciphertextEquals, ciphertextToArray, arrayToCiphertext, serializeCiphertext, deserializeCiphertext.

Discrete-log solver​

Types: SolverInfo, SolveResult, DlogSolverConfig.

Values: DlogSolver, getDefaultSolver, solveDlog, initDlogSolver.

Environment​

Types: Environment, EnvironmentCapabilities, StorageAdapter.

Values: detectEnvironment, isNode, isBrowser, isReactNative, detectCapabilities, shimBrowserGlobals, MemoryStorage.

Keys & addresses​

Types: ZkpKeys, SerializedKeys, ParsedAddress.

Values: validateMnemonic, generateMnemonic, keysFromMnemonic, keysFromSpendingKey, keysFromSignature, generateKeys, deriveKeys, serializeKeys, deserializeKeys, compressBpk, compressBpkHex, decompressBpk, bpkToAddress, addressToBpk, bpkToZk1Address, zk1AddressToBpk, isValidAddress, parseAddress, ZK_ADDRESS_HRP, ZK1_VERSION.

Keyring / wallet helpers​

Types: ZkpKeyringConfig, ConcealParams, TransferParams, TransferWitness, WithdrawToPublicParams.

Values: ZkpKeyring, createRandomWallet, importKeyring, importKeyringFromKey.

Prover (circuit-facing)​

Types: CompiledCircuit, ProverConfig, TransferProofParams, ToPublicProofParams, ProofResult.

Values: ZkpProver, createProver.

Client & wallet​

Types: ZkpClientConfig, ConnectedWalletConfig, Recipient, TokenConfig, HistoryItem, HistoryOptions, ISolverBackend, IProverBackend, CircuitLoader, ProveCircuit, ProveRequest, ProveResult, PublicToConcealedParams, ZkpWalletPublicModuleDeps, ZkpWalletPublicTransactions.

Values: ZkpClient, DlogSolverBackend, WasmProverBackend, resolveRecipient, DEFAULT_CHAIN_CONFIG, ZkpWallet, ZkpWalletPublicModule, and URL-based circuit loading helpers from the client module.

Services​

  • DecryptService (class)
  • ProofService, ProofServiceInterface (types)

Relayer​

Types: RelayerConfig.
Values: RelayerClient.

Stealth​

Types: StealthAddress, SerializedStealthAddress, CreateStealthOptions, StealthKeys, IStealthStore, StealthManagerConfig, StealthBalance.

Values: deriveStealthEvmKey, deriveStealthZkpKey, deriveStealthKeys, getStealthBpkHash, verifyStealthEvmAddress, MemoryStealthStore, StealthManager.