UPC — Universal Private ComplianceSDK Reference

SDK Overview

UPC SDK module structure, subpath exports, and installation.

UPC SDK

@permissionless-technologies/upc-sdk is a TypeScript SDK for building, operating, and integrating with ASPs. Built on viem with optional React support.

Installation

npm install @permissionless-technologies/upc-sdk

Subpath Exports

Import pathContents
@permissionless-technologies/upc-sdkMain entry — re-exports createASPClient and core types
@permissionless-technologies/upc-sdk/coreASPClient, Merkle tree, proof generation, identity derivation
@permissionless-technologies/upc-sdk/providersMemoryProvider, LocalStorageProvider, RESTProvider
@permissionless-technologies/upc-sdk/operatorASP operator tools (tree management, root publishing)
@permissionless-technologies/upc-sdk/aspIEventSource, IMembershipGate, API schema
@permissionless-technologies/upc-sdk/reactReact hooks for ASP status

Quick Example

import { createASPClient } from '@permissionless-technologies/upc-sdk'
import { MemoryProvider } from '@permissionless-technologies/upc-sdk/providers'

const asp = createASPClient({
  publicClient,
  walletClient,
  registryAddress: '0x...',
  provider: new MemoryProvider(),
})

await asp.addMember('0xApprovedAddress')
await asp.publishRoot({ walletClient })

const proof = await asp.generateProof({ identity: '0xMyAddress', aspId: 1n })
const valid = await asp.verifyProof({ proof, aspId: 1n })

Module Pages

AttestationHub & IAttestationVerifier

On-chain registry of ASPs and the IAttestationVerifier interface for plugging in any attestation backend.

Client API

createASPClient — the main entry point for managing ASPs, adding members, and generating proofs.

On this page

UPC SDKInstallationSubpath ExportsQuick ExampleModule Pages