DOCUMENTATION

Getting Started

Forensiq inspects and flags irregularities in token supply dynamics and holder concentrations. It reveals potential supply shocks and abnormal wallet behaviors instantly.

npm install @forensiq/client

Core Concepts

Risk Analysis Streams

Real-time feeds of analyzed token supply data. Each stream emits insights at block-level granularity. Subscribers receive alerts about potential vulnerabilities in market structures.

• Latency: 200-800ms from block finalization

• Insight size: 2-8 KB per event

• Retention: 90 days (historical queries supported)

Analyzed Wallet States

Fragmented on-chain data aggregated into verified snapshots. States include merkle proofs, ZK attestations, and analysis metadata. Every state is independently verifiable.

• Verification method: SNARK-based proof aggregation

• Confidence threshold: 3+ validator confirmations

• Failure mode: Reject on proof mismatch

API Endpoints

GET/v1/proofs/:chain/:block

Retrieve verified insights for specific block on target chain.

POST/v1/streams/subscribe

Subscribe to real-time analysis stream for specified chain and filter criteria.

GET/v1/state/:chain/:address

Query analyzed wallet state for contract address with proof attestation.

POST/v1/verify

Submit proof for independent verification against integrity mesh.

Integration Guide

Basic Connection

import { ForensiqClient } from '@forensiq/client'

const client = new ForensiqClient({
  apiKey: process.env.FORE_API_KEY,
  network: 'mainnet'
})

// Query single insight
const insight = await client.getProof('ethereum', 19234567)
console.log(insight.verified) // true

Stream Subscription

// Subscribe to analysis stream
const stream = client.subscribeToStream({
  chain: 'ethereum',
  filter: { contract: '0x...' }
})

stream.on('proof', (insight) => {
  console.log('New verified state:', insight.data)
  console.log('Validator signatures:', insight.attestations)
})

stream.on('error', (err) => {
  console.error('Stream error:', err)
})

Developer Notes

Rate Limits

Free tier: 100 queries/minute. Staked tier (10K+ $FORE): 1000 queries/minute. Enterprise: Unlimited (custom $FORE stake required).

Proof Verification

All proofs include SNARK verification parameters. Client SDK verifies locally by default. Disable with verifyLocal: false to trust network consensus.

Error Handling

Network rejects invalid queries immediately. Failed proofs return verified: false with detailed rejection reason. Never trust unverified data.