m2m-sentinel-sdk 1.0.4 → 1.1.0

package/README.md

@@ -1,59 +1,71 @@
-# M2M Sentinel SDKs
-
-Base URL: `https://m2msentinel.vercel.app`.
-
-## Support status
-
-Supported in this repository:
-- JavaScript/Node: `public/sdk/index.js` (`m2m_sentinel_sdk.js` re-exports it)
-- TypeScript source: `public/sdk/typescript/index.ts`
-- Python source: `public/sdk/m2m_sentinel/` and `public/sdk/python/m2m_sentinel/`
-- MCP stdio server: `public/sdk/mcp_server.js`
-
-Community preview only: Go, Rust, Java, Kotlin, Swift, C#, PHP, Ruby, CLI, Eliza plugin, and agent adapter. They include current route/header examples but are not covered by the supported-SDK guarantee; verify against `/openapi.json` before production use.
-
-## Installation
-
-Install from source (recommended for current `v1.0.4` build):
-
-```bash
-# JavaScript / Node.js (local path)
-node -e "const { M2MSentinelClient } = require('./public/sdk')"
-
-# Python (local path)
-python -m pip install ./public/sdk/python
-```
-
-*Note on Registry Packages (`v1.0.4`)*:
-Once published to npm and PyPI (via `npm publish` and `twine upload`), install directly via the package manager:
-- **npm registry**: `m2m-sentinel-sdk`
-- **PyPI registry**: `m2m-sentinel`
-
-## Authentication
-
-API keys must be sent only in headers:
-
-```text
-x-api-key: <key>
-```
-
-`Authorization: Bearer <key>` is accepted by the API, but the supported SDKs use `x-api-key`. Never place credentials in URLs or query strings; the server rejects them with HTTP 401.
-
-## x402 / 402 behavior
-
-Paid endpoints accept either `x-api-key` or a settled x402 v2 payment. Without credentials they return HTTP 402 and a `PAYMENT-REQUIRED` header containing a JSON challenge. Supported SDKs raise/return a payment-required error that exposes the parsed challenge. After settlement, retry with `PAYMENT-SIGNATURE`; successful paid responses may include `PAYMENT-RESPONSE` and include `provenance` in the JSON body.
-
-## Free-tier signup
-
-1. `POST /v1/subscribe/free/challenge` with `{ "userWallet": "0x..." }`.
-2. Sign `intent.messageToSign` with that wallet.
-3. `POST /v1/subscribe/free/claim` with `{ "intentId": "...", "signature": "..." }`.
-4. Store the returned `apiKey`; it cannot be recovered later.
-
-## Current routes
-
-Public: `GET /v1/status`, `GET /v1/plans`, free signup, and subscription intent/claim routes.
-
-Protected/paid: `GET /v1/audit/:address`, `GET /v1/security/score/:address`, `GET /v1/gas/fees`, `GET /v1/dex/metrics`, `GET /v1/token/price/:symbol`, `GET /v1/whales/signals`, `GET /v1/keys/self`, `POST /v1/keys/revoke`.
-
-SDKs preserve response bodies, including `provenance`. They surface 401, 402, 405, 429 (`Retry-After`), and 503 `DATA_SOURCE_UNAVAILABLE` without inventing fallback values.
+# M2M Sentinel SDKs
+
+Base URL: `https://m2msentinel.vercel.app`.
+
+M2M Sentinel reports selected static bytecode capabilities, common proxy
+structures, evidence quality, and sourced Base market observations. It does not
+classify a contract as safe, malicious, or exploitable. Transaction middleware
+therefore requires a caller-defined policy and has no built-in allow threshold.
+
+## Support status
+
+Supported here: JavaScript/Node (`index.js`), TypeScript source, Python source,
+and the MCP stdio server. Other language folders are community previews and
+must be checked against `/openapi.json` before production use.
+
+## Install this source build
+
+```bash
+node -e "const { M2MSentinelClient } = require('./public/sdk')"
+python -m pip install ./public/sdk/python
+```
+
+Registry publishing is intentionally separate from the production API.
+The repository does not claim that these source-installable packages are available from every language registry.
+
+## Authentication and x402
+
+Send API keys only in `x-api-key` (or `Authorization: Bearer`). Query-string
+credentials are rejected. Payable routes also support x402 v2. An unpaid call
+returns a base64 `PAYMENT-REQUIRED` challenge when the facilitator is ready; a
+successful settlement returns `PAYMENT-RESPONSE`.
+
+## Public routes
+
+- `GET /v1/status`
+- `GET /v1/stats` (public counter-free privacy envelope; exact aggregate
+  commercial counters are operator-only)
+- `GET /v1/plans`
+- `GET /v1/demo/audit/:address` for the published sample allowlist
+- free-key and subscription onboarding routes
+
+The JavaScript, TypeScript, and Python clients expose multi-period
+purchase/renewal and wallet recovery without requiring callers to hand-build
+requests:
+
+```js
+await client.createSubscriptionIntent('GROWTH', wallet, {
+  durationDays: 90,
+  renewExistingKey: true,
+  apiKey: existingPaidKey
+});
+const challenge = await client.createRecoveryChallenge(wallet, { txHash });
+await client.claimRecoveredKey(challenge.intent.id, walletSignature);
+```
+
+`getPublicStats()` returns the counter-free privacy envelope. Operator-only
+detail has a deliberately separate `getOperatorAggregateStats(days, token)`
+method and sends the operator token only as `Authorization: Bearer`. This is
+for private server/operator tooling only: never embed or bundle the operator
+token in browser, mobile, SDK-distribution, or customer code.
+
+## Protected routes
+
+- `GET /v1/audit/:address`
+- `GET /v1/security/score/:address` (legacy URL; returns a capability coverage index)
+- Base gas, DEX, token-price, and large-transfer observation routes
+- key self-service routes
+
+All live-data responses preserve provenance. Capability responses include
+`notASafetyGuarantee: true`, a limitations array, `capabilityRating`, and an
+evidence-grade flag. Do not replace `UNVERIFIED` or `null` with a default.

package/agent_adapter.js

@@ -4,8 +4,8 @@ const { M2MSentinelClient } = require('./index.js');
 
 class M2MSentinelAgentTool {
   constructor(options = {}) {
-    this.name = 'm2m_sentinel_security_audit';
-    this.description = 'Audits EVM smart contracts on Base for security risks, proxies, and bytecode findings.';
+    this.name = 'm2m_sentinel_capability_analysis';
+    this.description = 'Reports selected static bytecode capabilities, common proxy structures, provenance, and limitations for Base contracts.';
     this.client = new M2MSentinelClient({
       apiKey: options.apiKey || process.env.M2M_SENTINEL_API_KEY,
       baseUrl: options.baseUrl

package/eliza_plugin.js

@@ -20,7 +20,7 @@ const m2mSentinelPlugin = {
   actions: [
     {
       name: 'AUDIT_CONTRACT',
-      description: 'Audits an EVM contract on Base Mainnet.',
+      description: 'Reports selected static capability and proxy observations for a Base contract.',
       handler: async (runtime, message) => {
         const address = message.content.text.match(/0x[a-fA-F0-9]{40}/)?.[0];
         if (!address) return { text: 'Please provide a valid 42-character EVM contract address.' };
@@ -28,20 +28,20 @@ const m2mSentinelPlugin = {
           const data = await clientFor(runtime).auditContract(address);
           const audit = data.audit || {};
           const proxy = audit.proxyResolution || {};
-          return { text: `M2M Sentinel audit for ${address}: ${audit.securityRating || 'UNKNOWN'}; proxy=${proxy.isProxy ? proxy.proxyType : 'NO'}; provenance=${JSON.stringify(audit.provenance || data.provenance || null)}` };
+          return { text: `M2M Sentinel capability analysis for ${address}: ${audit.capabilityRating || 'UNVERIFIED'}; proxy=${proxy.isProxy ? proxy.proxyType : 'NO'}; notASafetyGuarantee=true; provenance=${JSON.stringify(audit.provenance || data.provenance || null)}` };
         } catch (err) { return { text: errorText(err) }; }
       }
     },
     {
-      name: 'GET_SECURITY_SCORE',
-      description: 'Returns the security score for a Base contract address.',
+      name: 'GET_CAPABILITY_SCORE',
+      description: 'Returns the static capability coverage index for a Base contract. The index is not a safety score.',
       handler: async (runtime, message) => {
         const address = message.content.text.match(/0x[a-fA-F0-9]{40}/)?.[0];
         if (!address) return { text: 'Please provide a valid EVM contract address.' };
         try {
-          const data = await clientFor(runtime).getSecurityScore(address);
-          const score = data.securityScore === null ? 'not decision-grade' : `${data.securityScore}/100`;
-          return { text: `M2M Sentinel security score for ${address}: ${score}. Provenance: ${JSON.stringify(data.provenance || null)}` };
+          const data = await clientFor(runtime).getCapabilityScore(address);
+          const score = data.capabilityScore === null ? 'unverified' : `${data.capabilityScore}/100 capability coverage`;
+          return { text: `M2M Sentinel static index for ${address}: ${score}; not a safety score. Provenance: ${JSON.stringify(data.provenance || null)}` };
         } catch (err) { return { text: errorText(err) }; }
       }
     },

package/index.d.ts

@@ -0,0 +1,94 @@
+export interface M2MSentinelClientOptions {
+  apiKey?: string;
+  baseUrl?: string;
+  timeoutMs?: number;
+  paymentSignature?: string;
+}
+
+export interface CreateSubscriptionIntentOptions extends M2MSentinelClientOptions {
+  durationDays?: 31 | 90 | 365;
+  renewExistingKey?: boolean;
+}
+
+export interface RecoveryChallengeOptions {
+  txHash?: string;
+}
+
+export interface M2MSentinelErrorOptions {
+  status?: number;
+  body?: unknown;
+  retryAfter?: string | null;
+  paymentRequired?: unknown;
+  paymentResponse?: unknown;
+}
+
+export class M2MSentinelError extends Error {
+  readonly status?: number;
+  readonly body?: unknown;
+  readonly retryAfter?: string | null;
+  readonly paymentRequired?: unknown;
+  readonly paymentResponse?: unknown;
+  constructor(message: string, options?: M2MSentinelErrorOptions);
+}
+
+export class PaymentRequiredError extends M2MSentinelError {}
+export class RateLimitedError extends M2MSentinelError {}
+export class DataSourceUnavailableError extends M2MSentinelError {}
+
+export class M2MSentinelClient {
+  constructor(options?: M2MSentinelClientOptions);
+  constructor(apiKey?: string, baseUrl?: string);
+  request(method: string, path: string, body?: unknown, options?: M2MSentinelClientOptions): Promise<any>;
+  getStatus(): Promise<any>;
+  getPublicStats(days?: number): Promise<any>;
+  /** Backward-compatible alias for getPublicStats; customer keys never reveal operator counters. */
+  getAggregateStats(days?: number): Promise<any>;
+  getOperatorAggregateStats(days: number, operatorToken: string): Promise<any>;
+  getPlans(): Promise<any>;
+  demoAudit(address: string): Promise<any>;
+  createFreeChallenge(userWallet: string): Promise<any>;
+  claimFreeTier(intentId: string, signature: string): Promise<any>;
+  createSubscriptionIntent(tier: string, userWallet: string, options?: CreateSubscriptionIntentOptions): Promise<any>;
+  claimSubscription(intentId: string, signature: string, txHash: string): Promise<any>;
+  createRecoveryChallenge(userWallet: string, options?: RecoveryChallengeOptions): Promise<any>;
+  claimRecoveredKey(intentId: string, signature: string): Promise<any>;
+  auditContract(address: string, options?: M2MSentinelClientOptions): Promise<any>;
+  getCapabilityScore(address: string, options?: M2MSentinelClientOptions): Promise<any>;
+  /** Legacy alias. The response is a capability coverage index, not a safety score. */
+  getSecurityScore(address: string, options?: M2MSentinelClientOptions): Promise<any>;
+  getGasFees(options?: M2MSentinelClientOptions): Promise<any>;
+  getDexMetrics(options?: M2MSentinelClientOptions): Promise<any>;
+  getTokenPrice(symbol: string, options?: M2MSentinelClientOptions): Promise<any>;
+  getWhaleSignals(options?: M2MSentinelClientOptions): Promise<any>;
+  getKeySelf(): Promise<any>;
+  revokeKey(confirm?: boolean): Promise<any>;
+}
+
+export type SentinelPolicy = (
+  analysis: any,
+  context: { targetAddress: string; integration: string }
+) => boolean | { allow: boolean; reason?: string } | Promise<boolean | { allow: boolean; reason?: string }>;
+
+export function enforceCallerPolicy(
+  policy: SentinelPolicy | undefined,
+  analysis: any,
+  context: { targetAddress: string; integration: string }
+): Promise<void>;
+
+export function createEthersSentinelMiddleware(
+  apiKey?: string,
+  baseUrl?: string,
+  policy?: SentinelPolicy
+): {
+  client: M2MSentinelClient;
+  verifyContractBeforeTx(targetAddress: string, policyOverride?: SentinelPolicy): Promise<any>;
+};
+
+export function createViemSentinelInterceptor(
+  apiKey?: string,
+  baseUrl?: string,
+  policy?: SentinelPolicy
+): {
+  client: M2MSentinelClient;
+  inspectSwapTarget(address: string, policyOverride?: SentinelPolicy): Promise<any>;
+};

package/index.js

@@ -1,143 +1,183 @@
-const DEFAULT_BASE_URL = 'https://m2msentinel.vercel.app';
-const DEFAULT_TIMEOUT_MS = 30000;
-
-class M2MSentinelError extends Error {
-  constructor(message, options = {}) {
-    super(message);
-    this.name = this.constructor.name;
-    this.status = options.status;
-    this.body = options.body;
-    this.retryAfter = options.retryAfter || null;
-    this.paymentRequired = options.paymentRequired || null;
-    this.paymentResponse = options.paymentResponse || null;
-  }
-}
-
-class PaymentRequiredError extends M2MSentinelError {}
-class RateLimitedError extends M2MSentinelError {}
-class DataSourceUnavailableError extends M2MSentinelError {}
-
-function parseHeaderJson(value) {
-  if (!value) return null;
-  try { return JSON.parse(value); } catch (_) { return null; }
-}
-
-function normalizeOptions(optionsOrApiKey, baseUrl) {
-  if (optionsOrApiKey && typeof optionsOrApiKey === 'object') return { ...optionsOrApiKey };
-  return { apiKey: optionsOrApiKey || undefined, baseUrl: baseUrl || DEFAULT_BASE_URL };
-}
-
-class M2MSentinelClient {
-  constructor(optionsOrApiKey, baseUrl) {
-    const options = normalizeOptions(optionsOrApiKey, baseUrl);
-    this.baseUrl = (options.baseUrl || DEFAULT_BASE_URL).replace(/\/+$/, '');
-    this.apiKey = options.apiKey || undefined;
-    this.timeoutMs = options.timeoutMs || DEFAULT_TIMEOUT_MS;
-    this.paymentSignature = options.paymentSignature || undefined;
-  }
-
-  async request(method, path, body, options = {}) {
-    const headers = {
+const DEFAULT_BASE_URL = 'https://m2msentinel.vercel.app';
+const DEFAULT_TIMEOUT_MS = 30000;
+
+class M2MSentinelError extends Error {
+  constructor(message, options = {}) {
+    super(message);
+    this.name = this.constructor.name;
+    this.status = options.status;
+    this.body = options.body;
+    this.retryAfter = options.retryAfter || null;
+    this.paymentRequired = options.paymentRequired || null;
+    this.paymentResponse = options.paymentResponse || null;
+  }
+}
+
+class PaymentRequiredError extends M2MSentinelError {}
+class RateLimitedError extends M2MSentinelError {}
+class DataSourceUnavailableError extends M2MSentinelError {}
+
+function parseX402Header(value) {
+  if (!value) return null;
+  // x402 v2 transports protocol objects as base64 JSON. Retain raw-JSON
+  // compatibility for older M2M Sentinel deployments during upgrades.
+  try { return JSON.parse(value); } catch (_) { /* try v2 encoding */ }
+  try {
+    const normalized = String(value).replace(/-/g, '+').replace(/_/g, '/');
+    const padded = normalized + '='.repeat((4 - normalized.length % 4) % 4);
+    return JSON.parse(Buffer.from(padded, 'base64').toString('utf8'));
+  } catch (_) {
+    return null;
+  }
+}
+
+function normalizeOptions(optionsOrApiKey, baseUrl) {
+  if (optionsOrApiKey && typeof optionsOrApiKey === 'object') return { ...optionsOrApiKey };
+  return { apiKey: optionsOrApiKey || undefined, baseUrl: baseUrl || DEFAULT_BASE_URL };
+}
+
+class M2MSentinelClient {
+  constructor(optionsOrApiKey, baseUrl) {
+    const options = normalizeOptions(optionsOrApiKey, baseUrl);
+    this.baseUrl = (options.baseUrl || DEFAULT_BASE_URL).replace(/\/+$/, '');
+    this.apiKey = options.apiKey || undefined;
+    this.timeoutMs = options.timeoutMs || DEFAULT_TIMEOUT_MS;
+    this.paymentSignature = options.paymentSignature || undefined;
+  }
+
+  async request(method, path, body, options = {}) {
+    const headers = {
       'Accept': 'application/json'
-    };
-    if (body !== undefined) headers['Content-Type'] = 'application/json';
-    const apiKey = options.apiKey || this.apiKey;
-    if (apiKey) headers['x-api-key'] = apiKey;
-    const paymentSignature = options.paymentSignature || this.paymentSignature;
-    if (paymentSignature) headers['PAYMENT-SIGNATURE'] = paymentSignature;
-
-    const controller = new AbortController();
-    const timeout = setTimeout(() => controller.abort(), options.timeoutMs || this.timeoutMs);
-    let response;
-    try {
-      response = await fetch(this.baseUrl + path, {
-        method,
-        headers,
-        body: body === undefined ? undefined : JSON.stringify(body),
-        signal: controller.signal
-      });
-    } catch (err) {
-      if (err && err.name === 'AbortError') throw new M2MSentinelError('M2M Sentinel request timed out', { status: 0 });
-      throw err;
-    } finally {
-      clearTimeout(timeout);
-    }
-
-    const text = await response.text();
-    let data = null;
-    if (text) {
-      try { data = JSON.parse(text); } catch (_) { data = { raw: text }; }
-    }
-
-    const paymentRequired = parseHeaderJson(response.headers.get('PAYMENT-REQUIRED'));
-    const paymentResponse = parseHeaderJson(response.headers.get('PAYMENT-RESPONSE')) || response.headers.get('PAYMENT-RESPONSE');
-    if (response.ok) return data;
-
-    const details = {
-      status: response.status,
-      body: data,
-      retryAfter: response.headers.get('Retry-After'),
-      paymentRequired,
-      paymentResponse
-    };
-    const message = data && data.message ? data.message : 'M2M Sentinel HTTP ' + response.status;
-    if (response.status === 402) throw new PaymentRequiredError(message, details);
-    if (response.status === 429) throw new RateLimitedError(message, details);
-    if (response.status === 503 && data && data.error === 'DATA_SOURCE_UNAVAILABLE') throw new DataSourceUnavailableError(message, details);
-    throw new M2MSentinelError(message, details);
-  }
-
-  getStatus() { return this.request('GET', '/v1/status'); }
-  getPlans() { return this.request('GET', '/v1/plans'); }
-  createFreeChallenge(userWallet) { return this.request('POST', '/v1/subscribe/free/challenge', { userWallet }); }
-  claimFreeTier(intentId, signature) { return this.request('POST', '/v1/subscribe/free/claim', { intentId, signature }); }
-  createSubscriptionIntent(tier, userWallet) { return this.request('POST', '/v1/subscribe/intents', { tier, userWallet }); }
-  claimSubscription(intentId, signature, txHash) { return this.request('POST', '/v1/subscribe/crypto', { intentId, signature, txHash }); }
-  auditContract(address, options) { return this.request('GET', '/v1/audit/' + encodeURIComponent(address), undefined, options); }
-  getSecurityScore(address, options) { return this.request('GET', '/v1/security/score/' + encodeURIComponent(address), undefined, options); }
-  getGasFees(options) { return this.request('GET', '/v1/gas/fees', undefined, options); }
-  getDexMetrics(options) { return this.request('GET', '/v1/dex/metrics', undefined, options); }
-  getTokenPrice(symbol, options) { return this.request('GET', '/v1/token/price/' + encodeURIComponent(symbol), undefined, options); }
-  getWhaleSignals(options) { return this.request('GET', '/v1/whales/signals', undefined, options); }
-  getKeySelf() { return this.request('GET', '/v1/keys/self'); }
-  revokeKey(confirm = true) { return this.request('POST', '/v1/keys/revoke', { confirm }); }
-}
-
-function createEthersSentinelMiddleware(apiKey, baseUrl) {
-  const client = new M2MSentinelClient({ apiKey, baseUrl });
-  return {
-    client,
-    verifyContractBeforeTx: async (targetAddress) => {
-      const audit = await client.auditContract(targetAddress);
-      const verdict = audit && audit.audit && audit.audit.verdict;
-      if (verdict && verdict.securityRating === 'HIGH_RISK') {
-        throw new Error('[M2M Sentinel] Transaction blocked: ' + targetAddress + ' flagged HIGH_RISK.');
-      }
-      return audit;
-    }
-  };
-}
-
-function createViemSentinelInterceptor(apiKey, baseUrl) {
-  const client = new M2MSentinelClient({ apiKey, baseUrl });
-  return {
-    client,
-    inspectSwapTarget: async (address) => {
-      const score = await client.getSecurityScore(address);
-      if (score && score.decisionGrade && typeof score.securityScore === 'number' && score.securityScore < 50) {
-        throw new Error('[M2M Sentinel] Security score too low (' + score.securityScore + '/100) for ' + address);
-      }
-      return score;
-    }
-  };
-}
-
-module.exports = {
-  M2MSentinelClient,
-  M2MSentinelError,
-  PaymentRequiredError,
-  RateLimitedError,
-  DataSourceUnavailableError,
-  createEthersSentinelMiddleware,
-  createViemSentinelInterceptor
+    };
+    if (body !== undefined) headers['Content-Type'] = 'application/json';
+    const apiKey = options.apiKey || this.apiKey;
+    if (apiKey) headers['x-api-key'] = apiKey;
+    if (options.operatorToken) headers.Authorization = 'Bearer ' + options.operatorToken;
+    const paymentSignature = options.paymentSignature || this.paymentSignature;
+    if (paymentSignature) headers['PAYMENT-SIGNATURE'] = paymentSignature;
+
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), options.timeoutMs || this.timeoutMs);
+    let response;
+    try {
+      response = await fetch(this.baseUrl + path, {
+        method,
+        headers,
+        body: body === undefined ? undefined : JSON.stringify(body),
+        signal: controller.signal
+      });
+    } catch (err) {
+      if (err && err.name === 'AbortError') throw new M2MSentinelError('M2M Sentinel request timed out', { status: 0 });
+      throw err;
+    } finally {
+      clearTimeout(timeout);
+    }
+
+    const text = await response.text();
+    let data = null;
+    if (text) {
+      try { data = JSON.parse(text); } catch (_) { data = { raw: text }; }
+    }
+
+    const paymentRequired = parseX402Header(response.headers.get('PAYMENT-REQUIRED'));
+    const paymentResponse = parseX402Header(response.headers.get('PAYMENT-RESPONSE')) || response.headers.get('PAYMENT-RESPONSE');
+    if (response.ok) return data;
+
+    const details = {
+      status: response.status,
+      body: data,
+      retryAfter: response.headers.get('Retry-After'),
+      paymentRequired,
+      paymentResponse
+    };
+    const message = data && data.message ? data.message : 'M2M Sentinel HTTP ' + response.status;
+    if (response.status === 402) throw new PaymentRequiredError(message, details);
+    if (response.status === 429) throw new RateLimitedError(message, details);
+    if (response.status === 503 && data && data.error === 'DATA_SOURCE_UNAVAILABLE') throw new DataSourceUnavailableError(message, details);
+    throw new M2MSentinelError(message, details);
+  }
+
+  getStatus() { return this.request('GET', '/v1/status'); }
+  getPublicStats(days = 30) { return this.request('GET', '/v1/stats?days=' + encodeURIComponent(days)); }
+  // Backward-compatible alias. Ordinary/customer credentials still receive
+  // only the counter-free public privacy envelope.
+  getAggregateStats(days = 30) { return this.getPublicStats(days); }
+  getOperatorAggregateStats(days, operatorToken) {
+    return this.request('GET', '/v1/stats?days=' + encodeURIComponent(days || 30), undefined, { operatorToken });
+  }
+  getPlans() { return this.request('GET', '/v1/plans'); }
+  demoAudit(address) { return this.request('GET', '/v1/demo/audit/' + encodeURIComponent(address)); }
+  createFreeChallenge(userWallet) { return this.request('POST', '/v1/subscribe/free/challenge', { userWallet }); }
+  claimFreeTier(intentId, signature) { return this.request('POST', '/v1/subscribe/free/claim', { intentId, signature }); }
+  createSubscriptionIntent(tier, userWallet, options = {}) {
+    const body = { tier, userWallet };
+    if (options.durationDays !== undefined) body.durationDays = options.durationDays;
+    if (options.renewExistingKey !== undefined) body.renewExistingKey = options.renewExistingKey;
+    return this.request('POST', '/v1/subscribe/intents', body, options);
+  }
+  claimSubscription(intentId, signature, txHash) { return this.request('POST', '/v1/subscribe/crypto', { intentId, signature, txHash }); }
+  createRecoveryChallenge(userWallet, options = {}) {
+    const body = { userWallet };
+    if (options.txHash !== undefined) body.txHash = options.txHash;
+    return this.request('POST', '/v1/keys/recovery/challenge', body);
+  }
+  claimRecoveredKey(intentId, signature) {
+    return this.request('POST', '/v1/keys/recovery/claim', { intentId, signature });
+  }
+  auditContract(address, options) { return this.request('GET', '/v1/audit/' + encodeURIComponent(address), undefined, options); }
+  getCapabilityScore(address, options) { return this.request('GET', '/v1/security/score/' + encodeURIComponent(address), undefined, options); }
+  // Legacy method name; the response is a capability coverage index, not a safety score.
+  getSecurityScore(address, options) { return this.request('GET', '/v1/security/score/' + encodeURIComponent(address), undefined, options); }
+  getGasFees(options) { return this.request('GET', '/v1/gas/fees', undefined, options); }
+  getDexMetrics(options) { return this.request('GET', '/v1/dex/metrics', undefined, options); }
+  getTokenPrice(symbol, options) { return this.request('GET', '/v1/token/price/' + encodeURIComponent(symbol), undefined, options); }
+  getWhaleSignals(options) { return this.request('GET', '/v1/whales/signals', undefined, options); }
+  getKeySelf() { return this.request('GET', '/v1/keys/self'); }
+  revokeKey(confirm = true) { return this.request('POST', '/v1/keys/revoke', { confirm }); }
+}
+
+async function enforceCallerPolicy(policy, analysis, context) {
+  if (typeof policy !== 'function') {
+    throw new Error('[M2M Sentinel] A caller-defined policy function is required. Static capability observations are not a safety decision.');
+  }
+  const result = await policy(analysis, context);
+  if (result === false || (result && result.allow === false)) {
+    const reason = result && result.reason ? result.reason : 'caller-defined policy rejected the transaction';
+    throw new Error('[M2M Sentinel] Transaction blocked: ' + reason + '.');
+  }
+}
+
+function createEthersSentinelMiddleware(apiKey, baseUrl, policy) {
+  const client = new M2MSentinelClient({ apiKey, baseUrl });
+  return {
+    client,
+    verifyContractBeforeTx: async (targetAddress, policyOverride) => {
+      const audit = await client.auditContract(targetAddress);
+      await enforceCallerPolicy(policyOverride || policy, audit, { targetAddress, integration: 'ethers' });
+      return audit;
+    }
+  };
+}
+
+function createViemSentinelInterceptor(apiKey, baseUrl, policy) {
+  const client = new M2MSentinelClient({ apiKey, baseUrl });
+  return {
+    client,
+    inspectSwapTarget: async (address, policyOverride) => {
+      const analysis = await client.getCapabilityScore(address);
+      await enforceCallerPolicy(policyOverride || policy, analysis, { targetAddress: address, integration: 'viem' });
+      return analysis;
+    }
+  };
+}
+
+module.exports = {
+  M2MSentinelClient,
+  M2MSentinelError,
+  PaymentRequiredError,
+  RateLimitedError,
+  DataSourceUnavailableError,
+  enforceCallerPolicy,
+  createEthersSentinelMiddleware,
+  createViemSentinelInterceptor
 };