neus-integrate

Integrate NEUS

Add proof-based access control to an app in four steps. The developer needs a gateId from neus.network and their framework name. Everything else is handled here.

Ask once

Before writing code, ask the developer:

1. What framework? (Next.js, Vite/React, Express, other)
2. Do you have a gate ID? If not, point them to neus.network → profile → Listings → Publish, then copy the gateId.

Do not ask about NEUS architecture, verifier types, proof schemas, wallet setup, or credential choices. The gate handles all of that.

Install

npm install @neus/sdk

If the app uses React, also ensure react and react-dom are installed (peer deps).

Browser: gate the content

React (Next.js, Vite, CRA)

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

function ProtectedPage() {
  return (
    <VerifyGate gateId="gate_your-app-name">
      <ProtectedContent />
    </VerifyGate>
  );
}

VerifyGate checks for an existing proof, opens hosted sign-in on neus.network when a new one is needed, then renders the children. Wallet, passkey, and OAuth all happen on NEUS, not inside the app.

Optional: show proof status anywhere with <ProofBadge qHash={proof.qHash} />.

Non-React (redirect flow)

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

window.location.assign(
  getHostedCheckoutUrl({
    gateId: 'gate_your-app-name',
    returnUrl: 'https://myapp.com/auth/callback',
  }),
);

Read the proof ID (qHash) from the callback URL query string, then store it.

Server: confirm access

Before granting access or paying out, confirm the visitor still satisfies the gate. Every NEUS account has an address (passkey and OAuth included, no separate wallet required).

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

const client = new NeusClient();
const result = await client.gateCheck({
  gateId: 'gate_your-app-name',
  address: user.accountAddress,
});

if (!result.data?.gate?.allRequiredSatisfied) {
  // send the user back to VerifyGate or NEUS sign-in
}