@modulr/sdk

Official TypeScript SDK for the Modulr API.

Install

npm install @modulr/sdk

Setup

import { Modulr } from '@modulr/sdk'

const modulr = new Modulr({
  apiKey: 'your-api-key',
  timeoutMs: 30000, // optional, default 30s
  maxRetries: 3,    // optional, default 3
})

---

Wallet Risk

Analyze a Solana wallet address and get a full risk report. Address is validated client-side before the request is sent.

const report = await modulr.walletRisk.analyze('9apA5U8...')

console.log(report.riskLevel)      // "Low Risk" | "Medium Risk" | "High Risk"
console.log(report.riskScore)      // 0–100
console.log(report.walletType)     // "DeFi Trader" | "Whale" | ...
console.log(report.warningSignals) // string[]
console.log(report.positiveSignals)// string[]

---

Token Launch Checklist

Generate a launch readiness report for a token project.

const report = await modulr.tokenLaunch.check({
  projectName: 'MyToken',
  tokenTicker: 'MTK',
  chain: 'Solana',
  launchStage: 'Pre-launch',
  tokenomicsStatus: 'Complete',
  contractAuditStatus: 'In Progress',
  liquidityStatus: 'Not Started',
  dexListingStatus: 'Not Started',
  websiteStatus: 'Complete',
  socialsStatus: 'Complete',
})

console.log(report.readinessScore) // 0–100
console.log(report.readinessLevel) // "Not Ready" | "Needs Work" | "Almost Ready" | "Launch Ready"
console.log(report.riskFlags)      // string[]
console.log(report.nextSteps)      // string[]

Only projectName is required. All other fields default to sensible values.

---

Smart Contract Audit

Run a static analysis audit on contract code.

const report = await modulr.audit.scan({
  contractText: `// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n...`,
  language: 'Solidity',           // "Solidity" | "Rust / Anchor" | "Move" | "Other / Notes"
  reviewDepth: 'Standard Review', // "Quick Review" | "Standard Review" | "Deep Review"
  projectContext: 'ERC-20 token with staking',
})

console.log(report.riskLevel)            // "Low Risk" | "Medium Risk" | "High Risk" | "Critical Risk"
console.log(report.riskScore)            // 0–100
console.log(report.findings)             // AuditFinding[]
console.log(report.deployRecommendation) // "Deploy" | "Deploy with caution" | ...

Only contractText is required.

---

AI Agent Generator

Coming soon. The module is available now and types are exported — it will be active once the Agent Generator ships.

const agent = await modulr.agent.generate({
  agentType: 'Trading Bot',
  agentName: 'SOL Price Bot',
  description: 'Monitor SOL price and alert when it drops below $100',
  targetChain: 'Solana',
  framework: 'Vanilla TypeScript',
})

console.log(agent.scriptContent)      // complete .ts file
console.log(agent.setupInstructions)  // string[]
console.log(agent.requiredEnvVars)    // string[]

---

Error handling

Requests automatically retry up to 3 times on 503/529 responses. On timeout or final failure a ModulrError is thrown.

import { Modulr, ModulrError } from '@modulr/sdk'

try {
  const report = await modulr.walletRisk.analyze('invalid-address')
} catch (err) {
  if (err instanceof ModulrError) {
    console.error(err.message) // API error message
    console.error(err.status)  // HTTP status code (408 = timeout)
  }
}

---

Types

All input and output types are exported directly from the package.

import type {
  WalletAnalysisReport,
  LaunchChecklistReport,
  AuditReport,
  AgentOutput,
} from '@modulr/sdk'