Getting Started

npm install @zkscore/sdk

yarn add @zkscore/sdk

pnpm add @zkscore/sdk

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

const client = new ZKScoreClient({
  apiKey: 'your_api_key_here',
  environment: 'mainnet'
});

// Get user score
const score = await client.getScore('alice.zks');
console.log('Score:', score.total);

// Get score breakdown
const breakdown = await client.getScoreBreakdown('alice.zks');
console.log('DeFi score:', breakdown.defi);

from zkscore import ZKScoreClient

client = ZKScoreClient(
    api_key='your_api_key_here',
    environment='mainnet'
)

# Get user score
score = await client.get_score('alice.zks')
print(f'Score: {score["total"]}')

# Get score breakdown
breakdown = await client.get_score_breakdown('alice.zks')
print(f'DeFi score: {breakdown["defi"]}')

// Check if ZKS ID is available
const isAvailable = await client.checkZKSIdAvailability('alice.zks');
console.log('Available:', isAvailable);

// Mint identity (requires wallet connection)
const result = await client.mintIdentity({
  zksId: 'alice.zks',
  displayName: 'Alice Smith',
  avatarUrl: 'https://example.com/avatar.jpg'
});
console.log('Identity minted:', result.transactionHash);

// Activate identity to enable full functionality
const result = await client.activateIdentity();
console.log('Identity activated:', result.transactionHash);

// Get total score
const score = await client.getScore('alice.zks');
console.log('Total score:', score.total);

// Get detailed breakdown
const breakdown = await client.getScoreBreakdown('alice.zks');
console.log('Category scores:', breakdown);

// Get score history
const history = await client.getScoreHistory('alice.zks');
console.log('Score history:', history);

const breakdown = await client.getScoreBreakdown('alice.zks');

console.log('DeFi Score:', breakdown.defi);
console.log('NFT Score:', breakdown.nft);
console.log('Social Score:', breakdown.social);
console.log('Trading Score:', breakdown.trading);
console.log('Governance Score:', breakdown.governance);
console.log('Gaming Score:', breakdown.gaming);
console.log('Identity Score:', breakdown.identity);
console.log('Trust Score:', breakdown.trust);

// Get user achievements
const achievements = await client.getAchievements('alice.zks');
console.log('Achievements:', achievements);

// Get available achievements
const available = await client.listAchievements();
console.log('Available achievements:', available);

// Check if user can claim achievement
const canClaim = await client.canClaimAchievement('alice.zks', 'achievement-id');
if (canClaim) {
  const result = await client.claimAchievement('alice.zks', 'achievement-id');
  console.log('Achievement claimed:', result.transactionHash);
}

// Get trading stats
const stats = await client.getTradingStats('alice.zks');
console.log('Total volume:', stats.totalVolume);
console.log('Win rate:', stats.winRate);

// Get trading history
const history = await client.getTradingHistory('alice.zks');
console.log('Trading history:', history);

// Get trading leaderboard
const leaderboard = await client.getTradingLeaderboard({
  period: '30d',
  limit: 100
});
console.log('Top traders:', leaderboard);

// Get user attestations
const attestations = await client.getAttestations('alice.zks');
console.log('Attestations:', attestations);

// Create attestation
const result = await client.createAttestation({
  recipient: 'bob.zks',
  schema: 'skill-verification',
  data: {
    skill: 'Solidity Development',
    level: 5
  }
});
console.log('Attestation created:', result.transactionHash);

try {
  const score = await client.getScore('alice.zks');
  console.log('Score:', score.total);
} catch (error) {
  if (error.code === 'IDENTITY_NOT_FOUND') {
    console.error('User has no identity');
  } else if (error.code === 'SCORE_NOT_FOUND') {
    console.error('User has no score yet');
  } else {
    console.error('Error:', error.message);
  }
}