docs / overview

SDKs

Eight packages. Two languages. MIT / CC-BY-4.0. Drop in the one that matches your stack.

TypeScript / Node

PackagePurpose
@orangecheck/sdkCore protocol. check(), verify(), createAttestation().
@orangecheck/gateHTTP middleware. Express, Next, Fastify, Hono, Workers.
@orangecheck/react<OcBadge>, <OcGate>, <OcChallengeButton>.
@orangecheck/wallet-adapterNormalize UniSat, Xverse, Leather, Alby behind one sign API.
@orangecheck/clioc command-line tool for ops + scripting.
@orangecheck/relay-filterSybil filter for Nostr relays. Strfry plugin included.
@orangecheck/airdrop-gateFilter candidate lists into sybil-resistant allowlists.

Python

PackagePurpose
orangecheckSync + async Python SDK. Django, Flask, FastAPI.

Which one do I want?

Install strategy

Every Node package is published under @orangecheck/* on npm. Install exactly the ones you need:

yarn add @orangecheck/sdk                  # always
yarn add @orangecheck/gate                 # route-gating
yarn add @orangecheck/react                # React UIs
yarn add @orangecheck/wallet-adapter       # browser signing
yarn global add @orangecheck/cli               # shell tool
yarn add @orangecheck/relay-filter         # Nostr relay plugin
yarn add @orangecheck/airdrop-gate         # airdrop filtering

pip install orangecheck                        # Python SDK

Versioning

All packages are pre-1.0. Minor versions may introduce breaking changes documented in the release notes. For stable API surface, pin to exact versions in production until v1.

License

MIT for code. CC-BY-4.0 for the protocol spec. Both are open forever.