Guides Overview

import { ZKScoreSDK } from '@zkscore/sdk';

const sdk = new ZKScoreSDK({ apiKey: 'your-key' });

async function checkAccess(userAddress: string, minScore: number) {
  const score = await sdk.scores.getScore(userAddress);
  return score.overall >= minScore;
}

// Gate premium features
if (await checkAccess(userAddress, 700)) {
  showPremiumContent();
} else {
  showUpgradePrompt();
}

// Track user progress
const progress = await sdk.achievements.getProgress(userAddress, 'defi-expert');

// Show progress bar
<ProgressBar 
  current={progress.requirements.defiTransactions.current}
  total={progress.requirements.defiTransactions.required}
  label="DeFi Transactions"
/>

// Claim when eligible
if (progress.completed) {
  await sdk.achievements.claim({ achievementId: 'defi-expert' });
}

// Generate proof without revealing exact score
const proof = await sdk.zkProofs.generate({
  address: userAddress,
  type: 'score-threshold',
  threshold: 700,
  hideExactScore: true,
});

// Verify on server
const isValid = await sdk.zkProofs.verify(proof);

// Create KYC attestation
await sdk.trustLayer.createAttestation({
  subject: userAddress,
  schema: 'kyc-verification',
  data: {
    verified: true,
    level: 'tier-2',
    provider: 'Synaps',
  },
});

// Check trust requirements
const evaluation = await sdk.trustLayer.evaluatePolicy(userAddress, {
  rules: [
    {
      schema: 'kyc-verification',
      required: true,
      conditions: { 'data.verified': true },
    },
  ],
});

const sdk = new ZKScoreSDK({
  apiKey: 'your-key',
  debug: true, // Enable debug logging
});

// Debug logs will show:
// - API requests and responses
// - Cache hits and misses
// - Error details
// - Performance metrics