Install

Pre-public release

The SDK is currently distributed as a versioned tarball from this docs site. It will move to the public npm registry as @sigilkeys/sdk once the API stabilizes. Pin to the version you install — the URL is versioned and immutable.

pnpm

pnpm add https://developers.sigilkeys.com/sdk/sigilkeys-sdk-0.3.0.tgz

npm

npm install https://developers.sigilkeys.com/sdk/sigilkeys-sdk-0.3.0.tgz

yarn

yarn add https://developers.sigilkeys.com/sdk/sigilkeys-sdk-0.3.0.tgz

Your imports look the same as if you had installed from npm:

import { Sigil } from '@sigilkeys/sdk';
import { SigilProvider, useWallet } from '@sigilkeys/sdk/react';

The tarball name is @sigilkeys/sdk@0.3.0; your package.json will record it under that name, and your code imports use the package name, not the URL.

The package ships two entrypoints:

Import	Use it for
@sigilkeys/sdk	Vanilla TS / JS. Framework-agnostic.
@sigilkeys/sdk/react	React. <SigilProvider> + hooks.

Both are pure ESM with CJS fallback, fully typed, and tree-shakeable. Bundle target is < 30 KB gzipped (current actual: ~15 KB without React).

Peer dependencies

react ≥ 18 is a peer dep, marked optional. If you only use the vanilla entrypoint you don’t need React installed.

Versioning

Semantic versioning. Anything in @sigilkeys/sdk v1.x will keep its public API stable. Internal types prefixed with _ may change.

What’s next

• Vanilla JS / TS — the Sigil class.
• React — hooks-first integration.
• Configuration — every option explained.