@cryptforge/core 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,326 @@
+# @cryptforge/core
+
+Core TypeScript types and interfaces for the CryptForge SDK. This package provides shared type definitions used across all CryptForge packages.
+
+## Installation
+
+```bash
+npm install @cryptforge/core
+# or
+pnpm add @cryptforge/core
+# or
+yarn add @cryptforge/core
+```
+
+## Overview
+
+This package contains no runtime code - only TypeScript type definitions and interfaces. It's automatically installed as a dependency when you use any CryptForge package.
+
+## What's Included
+
+### Authentication Types (`types/auth.ts`)
+
+Core types for authentication and key management:
+
+- `Identity` - User identity metadata
+- `Keys` - Derived cryptographic keys
+- `Keystore` - Encrypted keystore structure
+- `AuthState` - Authentication state machine
+- `AuthChangeEvent` - Auth state change events
+- `CreateIdentityOptions` - Identity creation parameters
+- `UnlockOptions` - Wallet unlock parameters
+- `ExportOptions` - Identity export options
+
+### Blockchain Types (`types/blockchain.ts`)
+
+Types for blockchain adapters and operations:
+
+- `BlockchainAdapter` - Interface for implementing blockchain adapters
+- `KeyData` - Derived key information
+- `ChainData` - Blockchain metadata
+- `Transaction` - Transaction structure
+- `TokenBalance` - Token balance information
+- `TokenTransfer` - Token transfer details
+- `TransactionOptions` - Transaction query options
+
+### Client Types (`types/client.ts`)
+
+Types for client-side operations:
+
+- Client configuration types
+- Client state management types
+- Event types for client operations
+
+### Application Types (`types/app.ts`)
+
+Application-level types:
+
+- App configuration
+- App state management
+- Plugin interfaces
+
+### Secrets Types (`types/secrets.ts`)
+
+Types for secret management:
+
+- Secret storage interfaces
+- Encryption/decryption types
+- Secret metadata
+
+### Presence Types (`types/presence.ts`)
+
+Types for device presence and synchronization:
+
+- Device presence information
+- Peer discovery types
+- Sync state management
+
+## Usage
+
+This package is primarily used by library authors creating CryptForge-compatible packages. Most developers will use higher-level packages like `@cryptforge/auth` or `@cryptforge/blockchain-evm`.
+
+### Implementing a Custom Blockchain Adapter
+
+```typescript
+import type {
+  BlockchainAdapter,
+  KeyData,
+  ChainData,
+} from '@cryptforge/core';
+
+class MyCustomAdapter implements BlockchainAdapter {
+  readonly chainData: ChainData = {
+    name: 'My Chain',
+    symbol: 'MYC',
+    cmc_id: 12345,
+    chainId: 1,
+    decimals: 18,
+  };
+
+  async deriveKeys(mnemonic: string): Promise<KeyData> {
+    // Implement key derivation
+  }
+
+  async deriveKeysAtIndex(mnemonic: string, index: number): Promise<KeyData> {
+    // Implement indexed key derivation
+  }
+
+  async deriveKeysAtPath(mnemonic: string, path: string): Promise<KeyData> {
+    // Implement path-based key derivation
+  }
+
+  async getAddressAtIndex(
+    mnemonic: string,
+    index: number
+  ): Promise<{ address: string; publicKey: string; path: string }> {
+    // Implement address generation
+  }
+
+  async getAddresses(
+    mnemonic: string,
+    startIndex: number,
+    count: number
+  ): Promise<Array<{ address: string; path: string; index: number }>> {
+    // Implement multiple address generation
+  }
+
+  async signMessage(
+    privateKey: Uint8Array,
+    message: string | Uint8Array
+  ): Promise<{ signature: string }> {
+    // Implement message signing
+  }
+
+  async signTransaction(
+    privateKey: Uint8Array,
+    transaction: any
+  ): Promise<{ signedTransaction: any; signature: string }> {
+    // Implement transaction signing
+  }
+
+  async verifySignature(
+    message: string | Uint8Array,
+    signature: string,
+    publicKey: string
+  ): Promise<boolean> {
+    // Implement signature verification
+  }
+
+  // Implement blockchain data query methods...
+  async getNativeBalance(address: string): Promise<any> {
+    // Get native token balance
+  }
+
+  async getTokenBalances(address: string): Promise<any[]> {
+    // Get all token balances
+  }
+
+  async getTransactions(address: string, options?: any): Promise<any[]> {
+    // Get transaction history
+  }
+
+  // ... other required methods
+}
+```
+
+### Using Types in Your Application
+
+```typescript
+import type {
+  Identity,
+  Keys,
+  ChainData,
+  Transaction,
+} from '@cryptforge/core';
+
+// Type-safe identity handling
+const handleIdentity = (identity: Identity) => {
+  console.log('Identity ID:', identity.id);
+  console.log('Label:', identity.label);
+  console.log('Created:', identity.createdAt);
+};
+
+// Type-safe key handling
+const handleKeys = (keys: Keys) => {
+  console.log('Address:', keys.address);
+  console.log('Chain:', keys.chain.name);
+  console.log('Expires:', keys.expiresAt);
+};
+
+// Type-safe chain data
+const displayChainInfo = (chain: ChainData) => {
+  console.log(`${chain.name} (${chain.symbol})`);
+};
+```
+
+## Key Interfaces
+
+### BlockchainAdapter
+
+The `BlockchainAdapter` interface defines the contract that all blockchain adapters must implement:
+
+```typescript
+interface BlockchainAdapter {
+  // Chain metadata
+  readonly chainData: ChainData;
+
+  // Key derivation
+  deriveKeys(mnemonic: string): Promise<KeyData>;
+  deriveKeysAtIndex(mnemonic: string, index: number): Promise<KeyData>;
+  deriveKeysAtPath(mnemonic: string, path: string): Promise<KeyData>;
+
+  // Address generation
+  getAddressAtIndex(
+    mnemonic: string,
+    index: number
+  ): Promise<{ address: string; publicKey: string; path: string }>;
+  getAddresses(
+    mnemonic: string,
+    startIndex: number,
+    count: number
+  ): Promise<Array<{ address: string; path: string; index: number }>>;
+
+  // Cryptographic operations
+  signMessage(
+    privateKey: Uint8Array,
+    message: string | Uint8Array
+  ): Promise<{ signature: string }>;
+  signTransaction(
+    privateKey: Uint8Array,
+    transaction: any
+  ): Promise<{ signedTransaction: any; signature: string }>;
+  verifySignature(
+    message: string | Uint8Array,
+    signature: string,
+    publicKey: string
+  ): Promise<boolean>;
+
+  // Blockchain data queries
+  getNativeBalance(address: string): Promise<any>;
+  getTokenBalances(address: string): Promise<any[]>;
+  getTokenBalance(address: string, tokenAddress: string): Promise<string>;
+  getTransactions(address: string, options?: any): Promise<any[]>;
+  getTokenTransfers(address: string, options?: any): Promise<any[]>;
+
+  // Transaction operations
+  sendNativeToken(params: {
+    privateKey: Uint8Array;
+    to: string;
+    amount: string;
+  }): Promise<any>;
+  sendToken(params: {
+    privateKey: Uint8Array;
+    to: string;
+    tokenAddress: string;
+    amount: string;
+  }): Promise<any>;
+  getTransactionStatus(hash: string): Promise<any>;
+}
+```
+
+### ChainData
+
+```typescript
+interface ChainData {
+  name: string; // Display name (e.g., "Ethereum")
+  symbol: string; // Token symbol (e.g., "ETH")
+  cmc_id: number; // CoinMarketCap ID
+  chainId?: number; // Chain ID for EVM chains
+  decimals?: number; // Token decimals (default: 18)
+}
+```
+
+### KeyData
+
+```typescript
+interface KeyData {
+  mnemonic: string; // BIP39 mnemonic phrase
+  seed: Uint8Array; // BIP39 seed (512 bits)
+  privateKey: Uint8Array; // Private key bytes
+  privateKeyHex: string; // Private key as hex string
+  publicKey: Uint8Array; // Public key bytes
+  publicKeyHex: string; // Public key as hex string
+  address: string; // Blockchain address
+  path: string; // BIP44 derivation path
+}
+```
+
+## Related Packages
+
+- **[@cryptforge/auth](../auth)** - Authentication and key management using these types
+- **[@cryptforge/blockchain-evm](../blockchain-evm)** - EVM blockchain adapter implementation
+- **[@cryptforge/blockchain-btc](../blockchain-btc)** - Bitcoin blockchain adapter implementation
+- **[@cryptforge/key-exchange](../key-exchange)** - Device synchronization using presence types
+- **[@cryptforge/client-vue](../client-vue)** - Vue.js UI components using client types
+
+## TypeScript Configuration
+
+For best results, use these TypeScript compiler options:
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+  }
+}
+```
+
+## Contributing
+
+When adding new types to this package:
+
+1. Add types to the appropriate file in `src/types/`
+2. Export from `src/index.ts`
+3. Update this README with documentation
+4. Ensure all types are well-documented with JSDoc comments
+5. Keep types browser-compatible (no Node.js-specific types)
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -153,12 +153,6 @@ interface AuthAdapter {
         address: string;
         path: string;
     }>;
-    deriveBIP44DocumentID: (options: {
-        appId: number;
-        account?: number;
-        purpose?: number;
-        index?: number;
-    }) => Promise<string>;
     deriveDataEncryptionKey: (options: DeriveDataKeyOptions) => Promise<CryptoKey>;
     getAddressForChain: (chainId: string, index?: number) => Promise<{
         address: string;
@@ -438,248 +432,6 @@ interface BlockchainAdapter {
     getTransactionStatus: (hash: string) => Promise<TransactionStatusUpdate>;
 }
 
-/**
- * Base document type that developers work with.
- * Includes managed metadata fields (id, createdAt, updatedAt) that are automatically set by the library.
- * Users should extend this interface to define their document types.
- *
- * @example
- * ```typescript
- * interface UserDocument extends BaseDocument {
- *   type: 'user'
- *   name: string
- *   email: string
- *   // id, createdAt, updatedAt are automatically available
- * }
- * ```
- */
-interface BaseDocument {
-    /** The document type identifier (e.g., 'note', 'task', 'user') */
-    type: string;
-    /** The Automerge document URL - automatically set by the library */
-    id: string;
-    /** Timestamp when the document was created - automatically set by the library */
-    createdAt: number;
-    /** Timestamp of the last update - automatically set by the library */
-    updatedAt: number;
-    /** Additional fields can be added as needed */
-    [key: string]: any;
-}
-/**
- * Helper type to ensure user's document type doesn't include managed fields.
- * This prevents conflicts and ensures the library controls these fields.
- * Users cannot pass id, createdAt, or updatedAt when creating documents.
- */
-type ExternalDocument<T extends BaseDocument> = Omit<T, "id" | "createdAt" | "updatedAt">;
-/**
- * Internal encrypted document wrapper.
- * This structure is what's actually stored in Automerge.
- * The encryption/decryption is handled transparently by the store.
- *
- * @template T - The type of the decrypted document content (used for type safety, not stored in interface)
- */
-interface EncryptedDocument<_T> extends BaseDocument {
-    /** Always 'encrypted' to identify this as an encrypted wrapper */
-    type: "encrypted";
-    /** Base64-encoded encrypted data containing the actual document */
-    encryptedData: string;
-    /**
-     * Optional owner identifier (e.g., master public key from auth).
-     * Stored unencrypted for server-side ownership verification without decryption.
-     */
-    owner?: string;
-    /** Metadata about the encrypted document */
-    metadata: {
-        /** The original document type before encryption */
-        contentType: string;
-        /** Timestamp when the document was last encrypted */
-        encryptedAt: number;
-        /** User ID who encrypted the document */
-        encryptedBy: string;
-    };
-}
-/**
- * Configuration for subscribing to document changes.
- *
- * @template T - The type of document being subscribed to
- */
-interface SubscribeConfig<T extends BaseDocument> {
-    /** The Automerge document URL/ID to subscribe to */
-    id: string;
-    /**
-     * Unique context identifier for this subscription.
-     * Allows multiple subscriptions to the same document (e.g., 'sidebar', 'main-view').
-     */
-    context: string;
-    /**
-     * Callback invoked with the decrypted document whenever it changes.
-     * Receives null if the document doesn't exist or was deleted.
-     * The document includes id, createdAt, and updatedAt fields automatically.
-     */
-    onUpdate: (doc: T | null) => void;
-    /**
-     * Optional error handler for subscription failures.
-     * Called when decryption fails or other errors occur.
-     */
-    onError?: (error: Error) => void;
-}
-/**
- * Configuration for unsubscribing from document changes.
- */
-interface UnsubscribeConfig {
-    /** The document ID to unsubscribe from */
-    id: string;
-    /** The context identifier of the subscription to remove */
-    context: string;
-}
-/**
- * Generic interface for cryptographic operations.
- *
- * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
- */
-interface CryptoOperations<TKey = unknown> {
-    /**
-     * Encryption key for all document operations.
-     * All documents are encrypted at rest using this key.
-     * Browser implementations use CryptoKey, Node.js implementations use Buffer.
-     */
-    setEncryptionKey?: (key: TKey) => void;
-    /**
-     * Creates an encryption function that encrypts string data using AES-GCM encryption.
-     * Returns a curried function that uses the instance's encryption key from `getEncryptionKey`.
-     *
-     * The returned function signature:
-     * - `data`: The plaintext string to encrypt
-     * - Returns: A promise resolving to the encrypted data as a string
-     */
-    encrypt: () => (data: string) => Promise<string>;
-    /**
-     * Creates a decryption function that decrypts encrypted string data using AES-GCM decryption.
-     * Returns a curried function that uses the instance's encryption key from `getEncryptionKey`.
-     *
-     * The returned function signature:
-     * - `encryptedData`: The encrypted string data to decrypt
-     * - Returns: A promise resolving to the decrypted plaintext string
-     */
-    decrypt: () => (encryptedData: string) => Promise<string>;
-}
-/**
- * Interface for document store adapters.
- * Provides a standard interface for document storage, retrieval, modification, and subscription operations.
- *
- * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
- */
-interface StoreAdapter {
-    /**
-     * Optional: Gets the network adapter for stores that support network synchronization.
-     * Returns null if no network adapter is configured.
-     * This property is only available on stores that implement network synchronization.
-     * The type is `any` to avoid coupling core types to Automerge-specific types.
-     */
-    readonly networkAdapter?: any | null;
-    /**
-     * Sets the encryption key for the store. Store operations aren't possible until the encryption key is set.
-     *
-     * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
-     * @param key - The encryption key to set
-     */
-    setEncryptionKey<TKey = unknown>(key: TKey): void;
-    /**
-     * Sets the owner identifier for document ownership (e.g., auth.masterPublicKey).
-     * Stored unencrypted in EncryptedDocument for server-side verification.
-     * Should be chain-independent for multi-blockchain applications.
-     *
-     * @param publicKey - The owner's public key
-     */
-    setOwnerPublicKey(publicKey: string): void;
-    /**
-     * Creates a new document with automatic encryption.
-     *
-     * The document is encrypted before being stored.
-     * Returns the document URL which can be used to retrieve or subscribe to the document.
-     *
-     * @template T - The document type (must extend BaseDocument)
-     * @param doc - The document to create (must include a 'type' field)
-     * @param url - Optional Automerge URL for deterministic document IDs
-     * @returns Promise resolving to the document URL
-     * @throws {Error} If document is missing 'type' field or encryption fails
-     */
-    create<T extends BaseDocument>(doc: ExternalDocument<T>, url?: string): Promise<string>;
-    /**
-     * Retrieves and decrypts a document by ID.
-     *
-     * @template T - The expected document type
-     * @param id - The document URL/ID
-     * @returns Promise resolving to the decrypted document, or null if not found
-     * @throws {Error} If document ID is invalid or decryption fails
-     */
-    get<T extends BaseDocument>(id: string): Promise<T | null>;
-    /**
-     * Modifies a document with automatic re-encryption.
-     *
-     * The document is decrypted, modified via the callback, then re-encrypted.
-     * Changes are applied atomically.
-     * The document includes id, createdAt, and updatedAt fields automatically.
-     *
-     * **Protected Fields**: The fields `id`, `createdAt`, and `updatedAt` are managed
-     * by the library and cannot be modified. Any attempts to change these fields in
-     * the callback will be ignored and restored to their original values. The library
-     * automatically updates `updatedAt` when changes are made.
-     *
-     * @template T - The document type
-     * @param id - The document ID to modify
-     * @param callback - Function that receives the decrypted document to modify
-     * @returns Promise that resolves when the change is applied
-     * @throws {Error} If document not found or encryption fails
-     */
-    change<T extends BaseDocument>(id: string, callback: (doc: T) => void): Promise<void>;
-    /**
-     * Deletes a document and cleans up all associated subscriptions.
-     *
-     * This removes the document from storage and automatically
-     * unsubscribes all active listeners to prevent memory leaks.
-     *
-     * @param id - The document ID to delete
-     * @returns Promise that resolves when deletion is complete
-     */
-    delete(id: string): Promise<void>;
-    /**
-     * Subscribes to document changes with automatic decryption.
-     *
-     * The callback receives the decrypted document whenever it changes.
-     * Multiple subscriptions to the same document are supported via different contexts.
-     *
-     * @template T - The document type
-     * @param config - Subscription configuration
-     * @returns Unsubscribe function to stop receiving updates
-     */
-    subscribe<T extends BaseDocument>(config: SubscribeConfig<T>): () => void;
-    /**
-     * Unsubscribes from document changes using document ID and context.
-     *
-     * Alternative to calling the unsubscribe function returned by subscribe().
-     *
-     * @param config - Object containing document ID and context
-     * @returns true if subscription was found and removed, false otherwise
-     */
-    unsubscribe(config: UnsubscribeConfig): boolean;
-    /**
-     * Gets all active subscription contexts for a document.
-     * Useful for debugging subscription state.
-     *
-     * @param id - The document ID
-     * @returns Array of context identifiers currently subscribed to this document
-     */
-    getActiveSubscriptions(id: string): string[];
-    /**
-     * Gets all active subscriptions across all documents.
-     * Useful for debugging memory leaks or subscription issues.
-     *
-     * @returns Object mapping document IDs to arrays of context identifiers
-     */
-    getAllActiveSubscriptions(): Record<string, string[]>;
-}
-
 type ActionType = "primary" | "secondary";
 interface SlideAction {
     type: ActionType;
@@ -696,9 +448,9 @@ interface AppInfo {
     appId: number;
     icon: string;
     name: string;
-    secret: string;
     description: string;
     steps: WalkthroughStep[];
+    hideWalletUI?: boolean;
 }
 
 interface KeyTransportAdapter {
@@ -722,11 +474,13 @@ interface KeyTransportAdapter {
     getDeviceInfo: () => Promise<Record<string, any>>;
     getHostname: () => Promise<string>;
     connectPresence: (topic: string) => Promise<void>;
-    broadcastClientState: (id: string, state: ClientConnectionState) => Promise<void>;
+    broadcastClientState: (id: string, state: ClientConnectionState, name?: string, isHeartbeat?: boolean) => Promise<void>;
     onClientStateRequest: (callback: () => void) => Promise<void> | Promise<() => void>;
     onClientStateUpdate: (callback: (response: {
         id: string;
         state: ClientConnectionState;
+        name?: string;
+        isHeartbeat?: boolean;
     }) => void) => Promise<void> | Promise<() => void>;
     getPeerState: (id: string) => ClientConnectionState | undefined;
     getAllPeers: () => ReadonlyMap<string, ClientConnectionState>;
@@ -738,11 +492,13 @@ type OnSetupEventCallback = (options: {
 
 interface PresenceAdapter {
     connectPresence: (topic: string) => Promise<void>;
-    broadcastClientState: (id: string, state: ClientConnectionState) => Promise<void>;
+    broadcastClientState: (id: string, state: ClientConnectionState, name?: string, isHeartbeat?: boolean) => Promise<void>;
     onClientStateRequest: (callback: () => void) => Promise<void> | Promise<() => void>;
     onClientStateUpdate: (callback: (response: {
         id: string;
         state: ClientConnectionState;
+        name?: string;
+        isHeartbeat?: boolean;
     }) => void) => Promise<void> | Promise<() => void>;
     getPeerState: (id: string) => ClientConnectionState | undefined;
     getAllPeers: () => ReadonlyMap<string, ClientConnectionState>;
@@ -751,7 +507,6 @@ interface PresenceAdapter {
 interface CryptForgeClientOptions {
     secrets: KeyTransportAdapter;
     presence: PresenceAdapter;
-    data: StoreAdapter;
     appInfo: AppInfo;
     blockchain: BlockchainAdapter;
     auth: AuthAdapter;
@@ -759,7 +514,6 @@ interface CryptForgeClientOptions {
 interface CryptForgeClient {
     secrets: KeyTransportAdapter;
     presence: PresenceAdapter;
-    data: StoreAdapter;
     appInfo: AppInfo;
     blockchain: BlockchainAdapter;
     auth: AuthAdapter;
@@ -769,4 +523,4 @@ type ClientConnectionState = "unknown" | "connecting" | "connected" | "idle" | "
 
 declare const version = "0.1.0";
 
-export { type ActionType, type AppInfo, type AuthAdapter, type AuthChangeCallback, type AuthEvent, type AuthState, type BaseDocument, type BlockchainAdapter, type BlockchainType, type Chain, type ChainData, type ClientConnectionState, type CreateIdentityOptions, type CryptForgeClient, type CryptForgeClientOptions, type CryptoOperations, type DeriveDataKeyOptions, type DeriveKeyOptions, type EncryptedDocument, type ExternalDocument, type GenerateMnemonicOptions, type Identity, type KeyData, type KeyTransportAdapter, type Keys, type OnSetupEventCallback, type PresenceAdapter, type RestoreIdentityOptions, type SignMessageOptions, type SignTransactionOptions, type SlideAction, type StoreAdapter, type StoredIdentity, type SubscribeConfig, type TokenBalance, type TokenTransfer, type Transaction, type TransactionOptions, type TransactionReceipt, type TransactionStatusUpdate, type UnlockOptions, type UnsubscribeConfig, type WalkthroughStep, createCryptForgeClient, version };
+export { type ActionType, type AppInfo, type AuthAdapter, type AuthChangeCallback, type AuthEvent, type AuthState, type BlockchainAdapter, type BlockchainType, type Chain, type ChainData, type ClientConnectionState, type CreateIdentityOptions, type CryptForgeClient, type CryptForgeClientOptions, type DeriveDataKeyOptions, type DeriveKeyOptions, type GenerateMnemonicOptions, type Identity, type KeyData, type KeyTransportAdapter, type Keys, type OnSetupEventCallback, type PresenceAdapter, type RestoreIdentityOptions, type SignMessageOptions, type SignTransactionOptions, type SlideAction, type StoredIdentity, type TokenBalance, type TokenTransfer, type Transaction, type TransactionOptions, type TransactionReceipt, type TransactionStatusUpdate, type UnlockOptions, type WalkthroughStep, createCryptForgeClient, version };

package/dist/index.d.ts

@@ -153,12 +153,6 @@ interface AuthAdapter {
         address: string;
         path: string;
     }>;
-    deriveBIP44DocumentID: (options: {
-        appId: number;
-        account?: number;
-        purpose?: number;
-        index?: number;
-    }) => Promise<string>;
     deriveDataEncryptionKey: (options: DeriveDataKeyOptions) => Promise<CryptoKey>;
     getAddressForChain: (chainId: string, index?: number) => Promise<{
         address: string;
@@ -438,248 +432,6 @@ interface BlockchainAdapter {
     getTransactionStatus: (hash: string) => Promise<TransactionStatusUpdate>;
 }
 
-/**
- * Base document type that developers work with.
- * Includes managed metadata fields (id, createdAt, updatedAt) that are automatically set by the library.
- * Users should extend this interface to define their document types.
- *
- * @example
- * ```typescript
- * interface UserDocument extends BaseDocument {
- *   type: 'user'
- *   name: string
- *   email: string
- *   // id, createdAt, updatedAt are automatically available
- * }
- * ```
- */
-interface BaseDocument {
-    /** The document type identifier (e.g., 'note', 'task', 'user') */
-    type: string;
-    /** The Automerge document URL - automatically set by the library */
-    id: string;
-    /** Timestamp when the document was created - automatically set by the library */
-    createdAt: number;
-    /** Timestamp of the last update - automatically set by the library */
-    updatedAt: number;
-    /** Additional fields can be added as needed */
-    [key: string]: any;
-}
-/**
- * Helper type to ensure user's document type doesn't include managed fields.
- * This prevents conflicts and ensures the library controls these fields.
- * Users cannot pass id, createdAt, or updatedAt when creating documents.
- */
-type ExternalDocument<T extends BaseDocument> = Omit<T, "id" | "createdAt" | "updatedAt">;
-/**
- * Internal encrypted document wrapper.
- * This structure is what's actually stored in Automerge.
- * The encryption/decryption is handled transparently by the store.
- *
- * @template T - The type of the decrypted document content (used for type safety, not stored in interface)
- */
-interface EncryptedDocument<_T> extends BaseDocument {
-    /** Always 'encrypted' to identify this as an encrypted wrapper */
-    type: "encrypted";
-    /** Base64-encoded encrypted data containing the actual document */
-    encryptedData: string;
-    /**
-     * Optional owner identifier (e.g., master public key from auth).
-     * Stored unencrypted for server-side ownership verification without decryption.
-     */
-    owner?: string;
-    /** Metadata about the encrypted document */
-    metadata: {
-        /** The original document type before encryption */
-        contentType: string;
-        /** Timestamp when the document was last encrypted */
-        encryptedAt: number;
-        /** User ID who encrypted the document */
-        encryptedBy: string;
-    };
-}
-/**
- * Configuration for subscribing to document changes.
- *
- * @template T - The type of document being subscribed to
- */
-interface SubscribeConfig<T extends BaseDocument> {
-    /** The Automerge document URL/ID to subscribe to */
-    id: string;
-    /**
-     * Unique context identifier for this subscription.
-     * Allows multiple subscriptions to the same document (e.g., 'sidebar', 'main-view').
-     */
-    context: string;
-    /**
-     * Callback invoked with the decrypted document whenever it changes.
-     * Receives null if the document doesn't exist or was deleted.
-     * The document includes id, createdAt, and updatedAt fields automatically.
-     */
-    onUpdate: (doc: T | null) => void;
-    /**
-     * Optional error handler for subscription failures.
-     * Called when decryption fails or other errors occur.
-     */
-    onError?: (error: Error) => void;
-}
-/**
- * Configuration for unsubscribing from document changes.
- */
-interface UnsubscribeConfig {
-    /** The document ID to unsubscribe from */
-    id: string;
-    /** The context identifier of the subscription to remove */
-    context: string;
-}
-/**
- * Generic interface for cryptographic operations.
- *
- * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
- */
-interface CryptoOperations<TKey = unknown> {
-    /**
-     * Encryption key for all document operations.
-     * All documents are encrypted at rest using this key.
-     * Browser implementations use CryptoKey, Node.js implementations use Buffer.
-     */
-    setEncryptionKey?: (key: TKey) => void;
-    /**
-     * Creates an encryption function that encrypts string data using AES-GCM encryption.
-     * Returns a curried function that uses the instance's encryption key from `getEncryptionKey`.
-     *
-     * The returned function signature:
-     * - `data`: The plaintext string to encrypt
-     * - Returns: A promise resolving to the encrypted data as a string
-     */
-    encrypt: () => (data: string) => Promise<string>;
-    /**
-     * Creates a decryption function that decrypts encrypted string data using AES-GCM decryption.
-     * Returns a curried function that uses the instance's encryption key from `getEncryptionKey`.
-     *
-     * The returned function signature:
-     * - `encryptedData`: The encrypted string data to decrypt
-     * - Returns: A promise resolving to the decrypted plaintext string
-     */
-    decrypt: () => (encryptedData: string) => Promise<string>;
-}
-/**
- * Interface for document store adapters.
- * Provides a standard interface for document storage, retrieval, modification, and subscription operations.
- *
- * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
- */
-interface StoreAdapter {
-    /**
-     * Optional: Gets the network adapter for stores that support network synchronization.
-     * Returns null if no network adapter is configured.
-     * This property is only available on stores that implement network synchronization.
-     * The type is `any` to avoid coupling core types to Automerge-specific types.
-     */
-    readonly networkAdapter?: any | null;
-    /**
-     * Sets the encryption key for the store. Store operations aren't possible until the encryption key is set.
-     *
-     * @template TKey - The encryption key type (CryptoKey for browser, Buffer for Node.js)
-     * @param key - The encryption key to set
-     */
-    setEncryptionKey<TKey = unknown>(key: TKey): void;
-    /**
-     * Sets the owner identifier for document ownership (e.g., auth.masterPublicKey).
-     * Stored unencrypted in EncryptedDocument for server-side verification.
-     * Should be chain-independent for multi-blockchain applications.
-     *
-     * @param publicKey - The owner's public key
-     */
-    setOwnerPublicKey(publicKey: string): void;
-    /**
-     * Creates a new document with automatic encryption.
-     *
-     * The document is encrypted before being stored.
-     * Returns the document URL which can be used to retrieve or subscribe to the document.
-     *
-     * @template T - The document type (must extend BaseDocument)
-     * @param doc - The document to create (must include a 'type' field)
-     * @param url - Optional Automerge URL for deterministic document IDs
-     * @returns Promise resolving to the document URL
-     * @throws {Error} If document is missing 'type' field or encryption fails
-     */
-    create<T extends BaseDocument>(doc: ExternalDocument<T>, url?: string): Promise<string>;
-    /**
-     * Retrieves and decrypts a document by ID.
-     *
-     * @template T - The expected document type
-     * @param id - The document URL/ID
-     * @returns Promise resolving to the decrypted document, or null if not found
-     * @throws {Error} If document ID is invalid or decryption fails
-     */
-    get<T extends BaseDocument>(id: string): Promise<T | null>;
-    /**
-     * Modifies a document with automatic re-encryption.
-     *
-     * The document is decrypted, modified via the callback, then re-encrypted.
-     * Changes are applied atomically.
-     * The document includes id, createdAt, and updatedAt fields automatically.
-     *
-     * **Protected Fields**: The fields `id`, `createdAt`, and `updatedAt` are managed
-     * by the library and cannot be modified. Any attempts to change these fields in
-     * the callback will be ignored and restored to their original values. The library
-     * automatically updates `updatedAt` when changes are made.
-     *
-     * @template T - The document type
-     * @param id - The document ID to modify
-     * @param callback - Function that receives the decrypted document to modify
-     * @returns Promise that resolves when the change is applied
-     * @throws {Error} If document not found or encryption fails
-     */
-    change<T extends BaseDocument>(id: string, callback: (doc: T) => void): Promise<void>;
-    /**
-     * Deletes a document and cleans up all associated subscriptions.
-     *
-     * This removes the document from storage and automatically
-     * unsubscribes all active listeners to prevent memory leaks.
-     *
-     * @param id - The document ID to delete
-     * @returns Promise that resolves when deletion is complete
-     */
-    delete(id: string): Promise<void>;
-    /**
-     * Subscribes to document changes with automatic decryption.
-     *
-     * The callback receives the decrypted document whenever it changes.
-     * Multiple subscriptions to the same document are supported via different contexts.
-     *
-     * @template T - The document type
-     * @param config - Subscription configuration
-     * @returns Unsubscribe function to stop receiving updates
-     */
-    subscribe<T extends BaseDocument>(config: SubscribeConfig<T>): () => void;
-    /**
-     * Unsubscribes from document changes using document ID and context.
-     *
-     * Alternative to calling the unsubscribe function returned by subscribe().
-     *
-     * @param config - Object containing document ID and context
-     * @returns true if subscription was found and removed, false otherwise
-     */
-    unsubscribe(config: UnsubscribeConfig): boolean;
-    /**
-     * Gets all active subscription contexts for a document.
-     * Useful for debugging subscription state.
-     *
-     * @param id - The document ID
-     * @returns Array of context identifiers currently subscribed to this document
-     */
-    getActiveSubscriptions(id: string): string[];
-    /**
-     * Gets all active subscriptions across all documents.
-     * Useful for debugging memory leaks or subscription issues.
-     *
-     * @returns Object mapping document IDs to arrays of context identifiers
-     */
-    getAllActiveSubscriptions(): Record<string, string[]>;
-}
-
 type ActionType = "primary" | "secondary";
 interface SlideAction {
     type: ActionType;
@@ -696,9 +448,9 @@ interface AppInfo {
     appId: number;
     icon: string;
     name: string;
-    secret: string;
     description: string;
     steps: WalkthroughStep[];
+    hideWalletUI?: boolean;
 }
 
 interface KeyTransportAdapter {
@@ -722,11 +474,13 @@ interface KeyTransportAdapter {
     getDeviceInfo: () => Promise<Record<string, any>>;
     getHostname: () => Promise<string>;
     connectPresence: (topic: string) => Promise<void>;
-    broadcastClientState: (id: string, state: ClientConnectionState) => Promise<void>;
+    broadcastClientState: (id: string, state: ClientConnectionState, name?: string, isHeartbeat?: boolean) => Promise<void>;
     onClientStateRequest: (callback: () => void) => Promise<void> | Promise<() => void>;
     onClientStateUpdate: (callback: (response: {
         id: string;
         state: ClientConnectionState;
+        name?: string;
+        isHeartbeat?: boolean;
     }) => void) => Promise<void> | Promise<() => void>;
     getPeerState: (id: string) => ClientConnectionState | undefined;
     getAllPeers: () => ReadonlyMap<string, ClientConnectionState>;
@@ -738,11 +492,13 @@ type OnSetupEventCallback = (options: {
 
 interface PresenceAdapter {
     connectPresence: (topic: string) => Promise<void>;
-    broadcastClientState: (id: string, state: ClientConnectionState) => Promise<void>;
+    broadcastClientState: (id: string, state: ClientConnectionState, name?: string, isHeartbeat?: boolean) => Promise<void>;
     onClientStateRequest: (callback: () => void) => Promise<void> | Promise<() => void>;
     onClientStateUpdate: (callback: (response: {
         id: string;
         state: ClientConnectionState;
+        name?: string;
+        isHeartbeat?: boolean;
     }) => void) => Promise<void> | Promise<() => void>;
     getPeerState: (id: string) => ClientConnectionState | undefined;
     getAllPeers: () => ReadonlyMap<string, ClientConnectionState>;
@@ -751,7 +507,6 @@ interface PresenceAdapter {
 interface CryptForgeClientOptions {
     secrets: KeyTransportAdapter;
     presence: PresenceAdapter;
-    data: StoreAdapter;
     appInfo: AppInfo;
     blockchain: BlockchainAdapter;
     auth: AuthAdapter;
@@ -759,7 +514,6 @@ interface CryptForgeClientOptions {
 interface CryptForgeClient {
     secrets: KeyTransportAdapter;
     presence: PresenceAdapter;
-    data: StoreAdapter;
     appInfo: AppInfo;
     blockchain: BlockchainAdapter;
     auth: AuthAdapter;
@@ -769,4 +523,4 @@ type ClientConnectionState = "unknown" | "connecting" | "connected" | "idle" | "
 
 declare const version = "0.1.0";
 
-export { type ActionType, type AppInfo, type AuthAdapter, type AuthChangeCallback, type AuthEvent, type AuthState, type BaseDocument, type BlockchainAdapter, type BlockchainType, type Chain, type ChainData, type ClientConnectionState, type CreateIdentityOptions, type CryptForgeClient, type CryptForgeClientOptions, type CryptoOperations, type DeriveDataKeyOptions, type DeriveKeyOptions, type EncryptedDocument, type ExternalDocument, type GenerateMnemonicOptions, type Identity, type KeyData, type KeyTransportAdapter, type Keys, type OnSetupEventCallback, type PresenceAdapter, type RestoreIdentityOptions, type SignMessageOptions, type SignTransactionOptions, type SlideAction, type StoreAdapter, type StoredIdentity, type SubscribeConfig, type TokenBalance, type TokenTransfer, type Transaction, type TransactionOptions, type TransactionReceipt, type TransactionStatusUpdate, type UnlockOptions, type UnsubscribeConfig, type WalkthroughStep, createCryptForgeClient, version };
+export { type ActionType, type AppInfo, type AuthAdapter, type AuthChangeCallback, type AuthEvent, type AuthState, type BlockchainAdapter, type BlockchainType, type Chain, type ChainData, type ClientConnectionState, type CreateIdentityOptions, type CryptForgeClient, type CryptForgeClientOptions, type DeriveDataKeyOptions, type DeriveKeyOptions, type GenerateMnemonicOptions, type Identity, type KeyData, type KeyTransportAdapter, type Keys, type OnSetupEventCallback, type PresenceAdapter, type RestoreIdentityOptions, type SignMessageOptions, type SignTransactionOptions, type SlideAction, type StoredIdentity, type TokenBalance, type TokenTransfer, type Transaction, type TransactionOptions, type TransactionReceipt, type TransactionStatusUpdate, type UnlockOptions, type WalkthroughStep, createCryptForgeClient, version };

package/dist/index.js

@@ -30,7 +30,6 @@ function createCryptForgeClient(options) {
   return {
     secrets: options.secrets,
     presence: options.presence,
-    data: options.data,
     appInfo: options.appInfo,
     blockchain: options.blockchain,
     auth: options.auth

package/dist/index.mjs

@@ -3,7 +3,6 @@ function createCryptForgeClient(options) {
   return {
     secrets: options.secrets,
     presence: options.presence,
-    data: options.data,
     appInfo: options.appInfo,
     blockchain: options.blockchain,
     auth: options.auth

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cryptforge/core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Core types and interfaces for the CryptForge SDK",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",