@treza/sdk - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

README.md

+# @treza/sdk
+
+[![npm version](https://badge.fury.io/js/%40treza%2Fsdk.svg)](https://www.npmjs.com/package/@treza/sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)](https://www.typescriptlang.org/)
+
+Core SDK for the **Treza Platform** - privacy-preserving KYC verification and secure enclave management.
+
+## Features
+
+### KYC Verification
+- **Zero-Knowledge KYC** - Verify identity claims without exposing personal data
+- **Dual Verification** - API-based (fast) or blockchain-based (trustless)
+- **Convenience Methods** - Simple APIs for common checks (age, country, document validity)
+- **Multi-Chain Support** - Ethereum, Sepolia, and compatible networks
+
+### Enclave Platform
+- **Secure Enclave Deployment** - Deploy and manage AWS Nitro Enclaves
+- **Cryptographic Attestation** - Hardware-backed proof of enclave integrity
+- **Lifecycle Management** - Deploy, pause, resume, terminate enclaves
+- **Task Scheduling** - Automated task execution within enclaves
+
+## Installation
+
+```bash
+npm install @treza/sdk ethers
+```
+
+## Quick Start
+
+### KYC Verification
+
+```typescript
+import { TrezaKYCClient } from '@treza/sdk/kyc';
+
+const client = new TrezaKYCClient({
+  apiUrl: 'https://api.trezalabs.com/api',
+  blockchain: {
+    rpcUrl: 'https://rpc.sepolia.org',
+    contractAddress: '0xB1D98F688Fac29471D91234d9f8EbB37238Df6FA',
+  },
+});
+
+// Check if user is an adult
+const isAdult = await client.isAdult(proofId);
+
+// Get country
+const country = await client.getCountry(proofId);
+
+// Verify multiple requirements
+const result = await client.meetsRequirements(proofId, {
+  mustBeAdult: true,
+  allowedCountries: ['US', 'CA', 'GB'],
+  mustHaveValidDocument: true,
+});
+
+if (result.meets) {
+  console.log('User meets all requirements');
+}
+```
+
+### Enclave Management
+
+```typescript
+import { TrezaClient } from '@treza/sdk';
+
+const client = new TrezaClient({
+  baseUrl: 'https://app.trezalabs.com'
+});
+
+// Create an enclave
+const enclave = await client.createEnclave({
+  name: 'My Secure Enclave',
+  description: 'Privacy-preserving computation',
+  region: 'us-east-1',
+  walletAddress: '0x...',
+  providerId: 'aws-nitro',
+  providerConfig: {
+    dockerImage: 'my-app:latest',
+    cpuCount: '2',
+    memoryMiB: '2048'
+  }
+});
+
+// Get attestation
+const attestation = await client.getAttestation(enclave.id);
+console.log('Trust Level:', attestation.verification.trustLevel);
+console.log('PCR Measurements:', attestation.attestationDocument.pcrs);
+
+// Verify attestation
+const verification = await client.verifyAttestation(enclave.id);
+console.log('Is Valid:', verification.isValid);
+console.log('Compliance:', verification.complianceChecks);
+```
+
+## API Reference
+
+### TrezaKYCClient
+
+KYC verification client.
+
+| Method | Description |
+|--------|-------------|
+| `isAdult(proofId, useBlockchain?)` | Check if user is 18+ |
+| `getCountry(proofId, useBlockchain?)` | Get user's nationality |
+| `hasValidDocument(proofId, useBlockchain?)` | Check document validity |
+| `getClaims(proofId, useBlockchain?)` | Get all public claims |
+| `meetsRequirements(proofId, requirements, useBlockchain?)` | Verify multiple requirements |
+| `hasValidKYC(userAddress)` | Check on-chain KYC status |
+
+### TrezaClient
+
+Enclave management client.
+
+| Method | Description |
+|--------|-------------|
+| `getEnclaves(walletAddress)` | List all enclaves |
+| `createEnclave(request)` | Create new enclave |
+| `getAttestation(enclaveId)` | Get attestation document |
+| `verifyAttestation(enclaveId, options?)` | Comprehensive verification |
+| `pauseEnclave(enclaveId, walletAddress)` | Pause enclave |
+| `resumeEnclave(enclaveId, walletAddress)` | Resume enclave |
+| `terminateEnclave(enclaveId, walletAddress)` | Terminate enclave |
+| `getEnclaveLogs(enclaveId, logType?, limit?)` | Get enclave logs |
+
+## Environment Variables
+
+```bash
+# API Configuration
+TREZA_API_URL=https://api.trezalabs.com/api
+TREZA_PLATFORM_URL=https://app.trezalabs.com
+
+# Blockchain (for KYC)
+SEPOLIA_RPC_URL=https://rpc.sepolia.org
+SEPOLIA_KYC_VERIFIER_ADDRESS=0xB1D98F688Fac29471D91234d9f8EbB37238Df6FA
+
+# For write operations
+PRIVATE_KEY=0x...
+```
+
+## Related Packages
+
+- **[@treza/react](https://www.npmjs.com/package/@treza/react)** - React components and hooks
+
+## Links
+
+- **Website**: [trezalabs.com](https://trezalabs.com)
+- **Documentation**: [docs.trezalabs.com](https://docs.trezalabs.com)
+- **GitHub**: [github.com/treza-labs/treza-sdk](https://github.com/treza-labs/treza-sdk)
+- **Smart Contracts**: [github.com/treza-labs/treza-contracts](https://github.com/treza-labs/treza-contracts)
+
+## License
+
+MIT

package.json

 {
   "name": "@treza/sdk",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Core TREZA SDK for privacy-first DeFi development",
@@ -5,0 +5,0 @@ "keywords": [

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

8086

138.17%

Number of package files

7

16.67%

Number of medium quality alerts

1

-50%

Number of lines in readme file

155

Infinity%

No dependency changes