MoonKeyDocumentation
Start

Getting started

Understand the permanent tenancy, identity, scope, and authorization model before integrating MoonKey.

Contract designed
Pre-alpha documentation boundary

Examples describe accepted contracts unless explicitly marked implemented. They do not imply a deployed API, SDK, signer, or production environment.

Examples
Code example format

Before you begin#

The repository contains a read-only TypeScript SDK and authenticated GET /v1/session and GET /v1/wallets routes. The SDK is a private workspace package; public read API activation and consumer onboarding remain gated. The authenticated operator console uses a separate session and control-plane API.

  • Node.js 24 for this repository
  • A registered organization and environment
  • An approved application origin
  • Application wallet scope, or both ecosystem entitlements

The integration shape#

A browser or native client authenticates against MoonKey's authorization origin using code + PKCE. The resulting app-bound context determines tenancy and authority. A requested wallet scope is checked on the server before identity resolution.

TypeScript · workspace read client
import { MoonKeyClient } from "@moonkey/sdk";

export async function readApplicationWallets(
  baseUrl: string,
  applicationId: string,
  getAccessToken: () => Promise<string>,
) {
  const moonkey = new MoonKeyClient({
    baseUrl,
    applicationId,
    getAccessToken,
  });
  const session = await moonkey.getSession();
  const wallets = await moonkey.listWallets();
  return { session, wallets };
}
Requires the private workspace SDK, activated read API, registered application, and verified app-bound token with read scopes. An operator cookie cannot replace that token.

First safe milestone#

Your first integration milestone is not a funded wallet. It is a verified application configuration with exact origins, explicit wallet scope, configured authentication, and a sandbox identity that resolves without exposing signing material.

  • Create organization
  • Create environment
  • Register application
  • Choose wallet scope
  • Configure authentication
  • Verify domain
  • Use the private workspace read SDK after activation
  • Resolve the first sandbox wallet identity
Implementation status

Review the engineering-readiness snapshot for current service boundaries. Contact the team before integrating a capability that remains gated.

Engineering status

Command center

Search page titles and navigate to a console page or documentation article.