Quickstart

Pick your path

SDK proof (this page)

Create a proof via wallet signature and poll status.

VerifyGate widget

Drop-in React gating with freshness controls.

HTTP examples

Minimal curl / Node.js examples for server integrations.

1. Install SDK

npm install @neus/sdk

2. Create a Client

Initialize the client in your app. Public verifiers do not require API keys.

import { NeusClient } from '@neus/sdk';

const client = new NeusClient();

3. Verify Something

Create a content authorship proof using ownership-basic. This prompts the user’s wallet to sign a request-bound message.

const proof = await client.verify({
  verifier: 'ownership-basic',
  content: 'Hello NEUS',
  wallet: window.ethereum,
});

const qHash = proof.qHash; // Proof ID (qHash)

Production defaults (recommended)

• Privacy: Default to options: { privacyLevel: 'private', publicDisplay: false } unless you explicitly need public discovery.

• Storage: Keep storeOriginalContent: false unless you intentionally need raw content stored.

• Proof ID: Treat qHash as an opaque identifier. Use timestamps/status fields to reason about freshness.

3b. Poll status (when verifiers run async)

Some verifiers complete instantly; others return 202 and finish asynchronously. Poll until terminal status:

const final = await client.pollProofStatus(qHash, { interval: 3000, timeout: 60000 });
console.log(final.status);

4. Gate Your UI

Use the React component to show content only to verified users.

import { VerifyGate } from '@neus/sdk/widgets';

export default function ProtectedPage() {
  return (
    <VerifyGate
      requiredVerifiers={['nft-ownership']}
      verifierData={{
        'nft-ownership': {
          contractAddress: '0x...',
          tokenId: '1',
          chainId: 1,
        },
      }}
    >
      <div>Access granted.</div>
    </VerifyGate>
  );
}

5. Server-side gating (minimal eligibility)

For backend/server checks, prefer a gate check (minimal yes/no, no full proof payloads):

const result = await client.gateCheck({
  address: '0x...',
  verifierIds: ['token-holding'],
  contractAddress: '0x...',
  minBalance: '100',
  chainId: 1,
  // Optional: recency requirement for point-in-time verifiers (example: last hour)
  since: Date.now() - 60 * 60 * 1000,
});

Freshness note: for point-in-time verifiers (balances, ownership, risk), always enforce a recency window (since / sinceDays) for high-stakes actions, or create a fresh proof and use the final status.

What's Next?

• Guides — Use-case walkthroughs.

• View Verifier Catalog — Verifier IDs, tiers, and input schemas.

• Read API Docs — Deep dive into the HTTP endpoints.

• SDK — Client usage, configuration, and widgets.

• Examples — Minimal working examples.