@phantom/sdk-types

Common TypeScript types and interfaces used across the Phantom Wallet SDK packages.

Overview

This package provides centralized type definitions that are shared across multiple Phantom SDK packages, ensuring consistency and reducing duplication.

Installation

npm install @phantom/sdk-types

Types

`Stamper`

Interface for creating X-Phantom-Stamp header values for API authentication.

interface Stamper {
  stamp(params: { data: Buffer }): Promise<string>;
  type?: "PKI" | "OIDC"; // Optional, defaults to "PKI"
  idToken?: string; // Required for OIDC type, optional for PKI
  salt?: string; // Required for OIDC type, optional for PKI
  algorithm?: Algorithm; // Optional, defaults to Algorithm.ed25519
}

Usage:

import type { Stamper } from "@phantom/sdk-types";

class MyStamper implements Stamper {
  type = "PKI"; // or "OIDC"
  async stamp(params: { data: Buffer }): Promise<string> {
    // Implementation for PKI stamping
    return "stamp-value";
  }
}

`StamperKeyInfo`

Key information structure returned by stampers.

interface StamperKeyInfo {
  keyId: string;
  publicKey: string;
}

`StamperWithKeyManagement`

Extended stamper interface for stampers that manage their own cryptographic keys.

interface StamperWithKeyManagement extends Stamper {
  init(): Promise<StamperKeyInfo>;
  getKeyInfo(): StamperKeyInfo | null;
  resetKeyPair?(): Promise<StamperKeyInfo>;
  clear?(): Promise<void>;
}

Usage:

import type { StamperWithKeyManagement } from "@phantom/sdk-types";

class MyKeyManagedStamper implements StamperWithKeyManagement {
  async init(): Promise<StamperKeyInfo> {
    // Initialize and return key info
    return { keyId: "key-id", publicKey: "public-key" };
  }

  getKeyInfo(): StamperKeyInfo | null {
    // Return current key info or null if not initialized
    return { keyId: "key-id", publicKey: "public-key" };
  }

  async stamp(params: { data: Buffer }): Promise<string> {
    // Implementation
    return "stamp-value";
  }
}

Package Usage

This package is used by:

@phantom/client - For the base Stamper interface
@phantom/embedded-provider-core - For StamperWithKeyManagement interface
@phantom/api-key-stamper - Implements Stamper interface
@phantom/indexed-db-stamper - Implements StamperWithKeyManagement interface
@phantom/react-native-sdk - For embedded stampers

License

MIT