credgate-sdk 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,8 @@
 # credgate-sdk
 
-On-chain credit scoring for DeFi lending protocols, powered by CreditCoin ZK proofs.
+On-chain credit scoring for onchain-protocols, powered by CreditCoin ZK proofs.
 
-Any lending protocol can use this SDK to:
+Any onchain protocol can use this SDK to:
 - Analyze a wallet's on-chain credit score
 - Determine max loan size and interest tier
 - Poll CreditCoin ZK proof status
@@ -18,6 +18,8 @@ npm install credgate-sdk
 
 ---
 
+## STEP By STEP GUIDE to integrate over a lending protocol.
+
 ## Architecture
 
 ```
@@ -35,6 +37,7 @@ Your Lending Protocol
         ├── Stablecoin treasury analysis
         ├── CrossChain maturity
         ├── DEX activity
+        ├── Wallet activity and age
         │
         ▼
   CreditScoreRegistry (Sepolia)
@@ -224,40 +227,121 @@ const result = await client.analyzeWallet("0x...", {
 **Response shape:**
 ```typescript
 {
-  score: {
-    address: "0x...",
-    creditScore: 87,          // 0–100
-    tier: "PRIME",
-    riskScore: 42,
-    riskLevel: "MEDIUM",
-    loanProfile: {
-      recommendedLTV: 70,
-      interestTier: "PRIME",
-      maxLoanSizeUSD: 25000,
+  "status": "DONE",
+  "result": {
+    "address": "0xa81a12e0c285b234a9c801b2bd215eabb3dda461",
+    "basic": {
+      "ethBalance": "0.0",
+      "txCount": 0,
+      "walletAgeBlocks": null
+    },
+    "aave": {
+      "borrows": [],
+      "repays": [],
+      "liquidations": []
     },
-    scoreBreakdown: {
-      lending: 28.5,
-      stable: 22.0,
-      crossChain: 12.0,
-      dex: 8.0,
-      ageBonus: 5.5,
-      riskPenalty: 8.0,
+    "meta": {
+      "analyzedAt": 1772742968948
     },
-    analyzedAt: 1709123456789,
-  },
-  onchain: {
-    status: "UPDATED",        // "NOT_SUBMITTED" | "UPDATED" | "COOLDOWN_ACTIVE" | "FAILED"
-    txHash: "0x...",
-    reportHash: "0x...",
-    remainingSeconds: 0,
-  },
-  proof: {
-    status: "waiting_attestation",
-    jobId: "job_0xabc123_1709...",
-    currentAttestedBlock: 7450000,
-    targetBlock: 7450123,
-    blocksRemaining: 123,
-    estimatedWaitSeconds: 1476,
+    "intelligence": {
+      "metrics": {
+        "totalBorrows": 0,
+        "totalRepays": 0,
+        "totalLiquidations": 0,
+        "repayRatio": 0,
+        "liquidationRate": 0,
+        "borrowRepayCycles": 0
+      },
+      "risk": {
+        "riskScore": 60,
+        "riskLevel": "MEDIUM"
+      },
+      "creditScore": 0,
+      "scoreBreakdown": {
+        "lending": 0,
+        "stable": 0,
+        "crossChain": 0,
+        "dex": 0,
+        "ageBonus": 0,
+        "riskPenalty": 12
+      },
+      "stable": {
+        "totalInflow": 0,
+        "totalOutflow": 0,
+        "netFlow": 0,
+        "transferCount": 0,
+        "inflowCount": 0,
+        "outflowCount": 0,
+        "avgMonthlyNetFlow": 0,
+        "netFlowVolatility": 0,
+        "retentionRatio": 0,
+        "recentActivityScore": 0,
+        "activeMonths": 0,
+        "avgHoldingDays": 0,
+        "largestInflowSourceShare": 0,
+        "churnRatio": 0,
+        "stableScore": 0,
+        "stableLevel": "WEAK"
+      },
+      "crossChain": {
+        "chainsUsedCount": 0,
+        "activeChains": [],
+        "totalTxAcrossChains": 0,
+        "chainDetails": [
+          {
+            "chain": "ethereum",
+            "txCount": 0,
+            "firstTxBlock": null,
+            "walletAgeDays": null
+          },
+          {
+            "chain": "arbitrum",
+            "txCount": 0,
+            "firstTxBlock": null,
+            "walletAgeDays": null
+          },
+          {
+            "chain": "optimism",
+            "txCount": 0,
+            "firstTxBlock": null,
+            "walletAgeDays": null
+          },
+          {
+            "chain": "base",
+            "txCount": 0,
+            "firstTxBlock": null,
+            "walletAgeDays": null
+          },
+          {
+            "chain": "polygon",
+            "txCount": 0,
+            "firstTxBlock": null,
+            "walletAgeDays": null
+          }
+        ],
+        "crossChainMaturityScore": 0,
+        "crossChainRiskImpact": 10
+      },
+      "dex": {
+        "totalSwaps": 0,
+        "totalVolumeUSD": 0,
+        "uniqueTokensTraded": 0,
+        "avgSwapSizeUSD": 0,
+        "swapFrequencyPerMonth": 0,
+        "dexMaturityScore": 0,
+        "dexRiskImpact": 0
+      },
+      "loanProfile": {
+        "recommendedLTV": 0,
+        "interestTier": "REJECT",
+        "maxLoanSizeUSD": 0
+      }
+    },
+    "onchain": {
+      "status": "UPDATED",
+      "txHash": "0x8f4b45d041e6d4a502407f8dd5fda49e73d882136db7e2d25096e1269cb211fd",
+      "reportHash": "0xf44b9f3a31ac3bb921289f6823b523ad01f3df9f543d01a573aab3c0bdb9386b"
+    }
   }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "credgate-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "On-chain credit scoring SDK — integrate undercollateralized lending into any DeFi protocol",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,4 +48,4 @@
     "@types/react": "^18.3.28",
     "typescript": "^5.9.3"
   }
-}
+}