UPD — Universal Private DollarSDK Reference
SDK Overview
UPD SDK module structure, subpath exports, and installation.
UPD SDK
@permissionless-technologies/upd-sdk is a TypeScript SDK for integrating with the UPD stablecoin. Built on viem with optional React support.
Installation
npm install @permissionless-technologies/upd-sdkSubpath Exports
| Import path | Contents |
|---|---|
@permissionless-technologies/upd-sdk | Main entry — re-exports createUPDClient and types |
@permissionless-technologies/upd-sdk/core | UPDClient, quote functions, oracle helpers |
@permissionless-technologies/upd-sdk/contracts | Contract ABIs and deployment addresses |
@permissionless-technologies/upd-sdk/react | UPDProvider, useUPD, useCollateral, useStabilizer |
Quick Example
import { createUPDClient, quoteMintUPD } from '@permissionless-technologies/upd-sdk'
import { parseEther, formatUnits } from 'viem'
const upd = createUPDClient({ publicClient, walletClient, chainId: 1 })
// Get mint quote
const quote = await upd.quoteMint({ ethAmount: parseEther('1') })
console.log('Will receive:', formatUnits(quote.updAmount, 18), 'UPD')
// Mint
const { txHash } = await upd.mint({ ethAmount: parseEther('1') })Module Pages
- Client API —
createUPDClientand all methods - React Hooks —
useUPD,useCollateral,useStabilizer