@zero-lync/passkey-core

Core utilities and types for Zerolync Passkey SDK - cross-chain passkey authentication.

Overview

This package provides the core functionality shared across all Zerolync passkey SDKs, including storage utilities, type definitions, and common interfaces for cross-chain passkey authentication.

Features

• Cross-chain storage: Unified storage for passkey credentials across multiple blockchains
• Type-safe: Full TypeScript support with comprehensive type definitions
• Browser-based: Works entirely in the browser using localStorage
• Zero dependencies: Lightweight package with no external dependencies

Installation

npm install @zero-lync/passkey-core
# or
pnpm add @zero-lync/passkey-core
# or
yarn add @zero-lync/passkey-core

Usage

PasskeyStorage

The PasskeyStorage utility provides methods to manage wallet information across chains:

import { PasskeyStorage, type WalletInfo } from '@zero-lync/passkey-core';

// Save wallet info
const walletInfo: WalletInfo = {
  solana: {
    address: '5xot9PAtQRTN...',
    credentialId: 'credential123'
  },
  sui: {
    address: '0x1234...',
    credentialId: 'credential123'
  },
  passkey: {
    credentialId: 'credential123',
    publicKey: 'base64-encoded-public-key'
  }
};

PasskeyStorage.saveWallet(walletInfo);

// Get wallet info
const wallet = PasskeyStorage.getWallet();

// Clear wallet info
PasskeyStorage.clearWallet();

API Reference

Types

WalletInfo

interface WalletInfo {
  solana?: {
    address: string;
    credentialId: string;
  };
  sui?: {
    address: string;
    credentialId: string;
  };
  passkey?: {
    credentialId: string;
    publicKey: string;
  };
}

PasskeyStorage

saveWallet(wallet: WalletInfo): void

Saves wallet information to localStorage.

getWallet(): WalletInfo | null

Retrieves wallet information from localStorage. Returns null if no wallet is stored.

clearWallet(): void

Removes wallet information from localStorage.

Related Packages

• @zero-lync/passkey-solana - Solana passkey authentication
• @zero-lync/passkey-sui - Sui passkey authentication

License

MIT