@stacks-passkey/core

TypeScript SDK for wallet-less passkey smart accounts on Stacks.

Install

npm install @stacks-passkey/core @stacks/network

Includes the spk CLI (npx spk help).

Documentation

| Guide | Audience | |-------|----------| | docs/GUIDE.md | Frontend dApp devs — SDK only | | docs/DEVELOPER_GUIDE.md | Full stack — deploy + relay | | docs/SDK.md | API reference |

Quick start

import { PasskeyClient } from '@stacks-passkey/core';
import { STACKS_TESTNET } from '@stacks/network';

const client = new PasskeyClient({
  network: STACKS_TESTNET,
  relayUrl: 'http://localhost:8787',
  relayApiKey: 'spk_...',
  deployerAddress: 'ST3XHHZ1CXVCNYXK3FQ1FDGJ9NK6YBJBJK3FVY5KQ',
  rpId: 'localhost',
  rpName: 'My App',
  origin: 'http://localhost:3000',
});

await client.register('user-id', 'Alice');
const session = await client.signIn();
await client.invoke('STxxx.my-app', 'set-score', { arg0: 42n, arg2: client.getOriginAddress() });

Shared testnet deployment IDs are in config/testnet.json.

CLI

spk init [dir]              # scaffold passkey.manifest.json
spk ensure STxxx.my-app     # POST /v1/catalog/ensure (needs SPK_RELAY_API_KEY)

License

MIT