@provablehq/aleo-wallet-adaptor-core 0.1.1-alpha.0

package/README.md

@@ -0,0 +1,33 @@
+# @provablehq/aleo-wallet-adaptor-core
+
+Foundation utilities and base classes for implementing Aleo-compatible wallet adapters.
+
+## When to use it
+
+- Author a first-party or partner wallet adapter that plugs into the Aleo wallet ecosystem.
+- Share common adapter behaviour (events, feature checks, network switching) across multiple wallet implementations.
+- Build higher-level tooling (React hooks, UI kits) on a consistent adapter contract.
+
+## Installation
+
+```bash
+pnpm add @provablehq/aleo-wallet-adaptor-core
+```
+
+## Usage
+
+```ts
+import { BaseAleoWalletAdapter } from '@provablehq/aleo-wallet-adaptor-core';
+
+class MyWalletAdapter extends BaseAleoWalletAdapter {
+  // extend the base adapter with wallet-specific logic
+}
+```
+
+## Related packages
+
+- `@provablehq/aleo-wallet-adaptor-react` – React provider and hooks built on this core.
+- `@provablehq/aleo-wallet-adaptor-react-ui` – Pre-built React components for any adapter that extends the core.
+- `@provablehq/aleo-wallet-standard` – Shared feature definitions and event interfaces consumed by the base adapter.
+
+Live demo: https://aleo-dev-toolkit-react-app.vercel.app/

package/dist/index.d.mts

@@ -0,0 +1,187 @@
+import { Account, Network, TransactionOptions, TransactionStatusResponse, AccountOptions } from '@provablehq/aleo-types';
+import { EventEmitter, WalletEvents, WalletAdapter, WalletName, WalletReadyState, WalletDecryptPermission, StandardWallet, AleoChain, AleoDeployment } from '@provablehq/aleo-wallet-standard';
+export { WalletDecryptPermission as DecryptPermission } from '@provablehq/aleo-wallet-standard';
+
+/**
+ * Base class for Aleo wallet adapters
+ */
+declare abstract class BaseAleoWalletAdapter extends EventEmitter<WalletEvents> implements WalletAdapter {
+    /**
+     * The wallet name
+     */
+    abstract name: WalletName<string>;
+    /**
+     * The wallet URL
+     */
+    abstract url?: string;
+    /**
+     * The wallet icon
+     */
+    abstract icon?: string;
+    /**
+     * The wallet's ready state
+     */
+    abstract _readyState: WalletReadyState;
+    get readyState(): WalletReadyState;
+    protected set readyState(state: WalletReadyState);
+    /**
+     * The connected account, if any
+     */
+    account?: Account;
+    /**
+     * The wallet's network
+     */
+    abstract network: Network;
+    /**
+     * The wallet's decrypt permission
+     */
+    abstract decryptPermission: WalletDecryptPermission;
+    /**
+     * The wallet's standard interface, if available
+     */
+    protected _wallet?: StandardWallet;
+    /**
+     * The supported chains
+     */
+    get chains(): AleoChain[];
+    /**
+     * The wallet's connected state
+     */
+    get connected(): boolean;
+    /**
+     * Connect to the wallet
+     * @param network The network to connect to
+     * @param decryptPermission The decrypt permission
+     * @param programs The programs to connect to
+     * @returns The connected account
+     */
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<Account>;
+    /**
+     * Disconnect from the wallet
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Sign a message
+     * @param options Transaction options
+     * @returns The signed transaction
+     */
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Execute a transaction
+     * @param options Transaction options
+     * @returns The executed temporary transaction ID
+     */
+    executeTransaction(options: TransactionOptions): Promise<{
+        transactionId: string;
+    }>;
+    /**
+     * Get transaction status
+     * @param transactionId The transaction ID
+     * @returns The transaction status
+     */
+    transactionStatus(transactionId: string): Promise<TransactionStatusResponse>;
+    switchNetwork(network: Network): Promise<void>;
+    decrypt(cipherText: string, tpk?: string, programId?: string, functionName?: string, index?: number): Promise<string>;
+    requestRecords(program: string, includePlaintext: boolean): Promise<unknown[]>;
+    executeDeployment(deployment: AleoDeployment): Promise<{
+        transactionId: string;
+    }>;
+}
+
+/**
+ * Get the short address representation (for display)
+ * @param address The full address
+ * @param prefixLength The number of characters to keep at the beginning
+ * @param suffixLength The number of characters to keep at the end
+ * @returns The short address representation
+ */
+declare function getShortAddress(address: string, prefixLength?: number, suffixLength?: number): string;
+/**
+ * Create a new account with the given options
+ * @param options Account options
+ * @returns The created account
+ */
+declare function createAccount(options?: AccountOptions): Account;
+
+/**
+ * Base wallet error
+ */
+declare class WalletError extends Error {
+    name: string;
+}
+/**
+ * Error thrown when a wallet is not connected
+ */
+declare class WalletNotConnectedError extends WalletError {
+    name: string;
+    constructor();
+}
+/**
+ * Error thrown when the wallet connection is rejected
+ */
+declare class WalletConnectionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+/**
+ * Error thrown when a required wallet feature is not available
+ */
+declare class WalletFeatureNotAvailableError extends WalletError {
+    name: string;
+    constructor(feature: string);
+}
+/**
+ * Error thrown when a wallet transaction fails
+ */
+declare class WalletTransactionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+/**
+ * Error thrown when a user rejects a transaction
+ */
+declare class WalletTransactionRejectedError extends WalletTransactionError {
+    name: string;
+    constructor();
+}
+/**
+ * Error thrown when a transaction times out
+ */
+declare class WalletTransactionTimeoutError extends WalletTransactionError {
+    name: string;
+    constructor();
+}
+declare class WalletNotSelectedError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDisconnectionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletSignMessageError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletSwitchNetworkError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletNotReadyError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDecryptionNotAllowedError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDecryptionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class MethodNotImplementedError extends WalletError {
+    name: string;
+    constructor(method: string);
+}
+
+export { BaseAleoWalletAdapter, MethodNotImplementedError, WalletConnectionError, WalletDecryptionError, WalletDecryptionNotAllowedError, WalletDisconnectionError, WalletError, WalletFeatureNotAvailableError, WalletNotConnectedError, WalletNotReadyError, WalletNotSelectedError, WalletSignMessageError, WalletSwitchNetworkError, WalletTransactionError, WalletTransactionRejectedError, WalletTransactionTimeoutError, createAccount, getShortAddress };

package/dist/index.d.ts

@@ -0,0 +1,187 @@
+import { Account, Network, TransactionOptions, TransactionStatusResponse, AccountOptions } from '@provablehq/aleo-types';
+import { EventEmitter, WalletEvents, WalletAdapter, WalletName, WalletReadyState, WalletDecryptPermission, StandardWallet, AleoChain, AleoDeployment } from '@provablehq/aleo-wallet-standard';
+export { WalletDecryptPermission as DecryptPermission } from '@provablehq/aleo-wallet-standard';
+
+/**
+ * Base class for Aleo wallet adapters
+ */
+declare abstract class BaseAleoWalletAdapter extends EventEmitter<WalletEvents> implements WalletAdapter {
+    /**
+     * The wallet name
+     */
+    abstract name: WalletName<string>;
+    /**
+     * The wallet URL
+     */
+    abstract url?: string;
+    /**
+     * The wallet icon
+     */
+    abstract icon?: string;
+    /**
+     * The wallet's ready state
+     */
+    abstract _readyState: WalletReadyState;
+    get readyState(): WalletReadyState;
+    protected set readyState(state: WalletReadyState);
+    /**
+     * The connected account, if any
+     */
+    account?: Account;
+    /**
+     * The wallet's network
+     */
+    abstract network: Network;
+    /**
+     * The wallet's decrypt permission
+     */
+    abstract decryptPermission: WalletDecryptPermission;
+    /**
+     * The wallet's standard interface, if available
+     */
+    protected _wallet?: StandardWallet;
+    /**
+     * The supported chains
+     */
+    get chains(): AleoChain[];
+    /**
+     * The wallet's connected state
+     */
+    get connected(): boolean;
+    /**
+     * Connect to the wallet
+     * @param network The network to connect to
+     * @param decryptPermission The decrypt permission
+     * @param programs The programs to connect to
+     * @returns The connected account
+     */
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<Account>;
+    /**
+     * Disconnect from the wallet
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Sign a message
+     * @param options Transaction options
+     * @returns The signed transaction
+     */
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Execute a transaction
+     * @param options Transaction options
+     * @returns The executed temporary transaction ID
+     */
+    executeTransaction(options: TransactionOptions): Promise<{
+        transactionId: string;
+    }>;
+    /**
+     * Get transaction status
+     * @param transactionId The transaction ID
+     * @returns The transaction status
+     */
+    transactionStatus(transactionId: string): Promise<TransactionStatusResponse>;
+    switchNetwork(network: Network): Promise<void>;
+    decrypt(cipherText: string, tpk?: string, programId?: string, functionName?: string, index?: number): Promise<string>;
+    requestRecords(program: string, includePlaintext: boolean): Promise<unknown[]>;
+    executeDeployment(deployment: AleoDeployment): Promise<{
+        transactionId: string;
+    }>;
+}
+
+/**
+ * Get the short address representation (for display)
+ * @param address The full address
+ * @param prefixLength The number of characters to keep at the beginning
+ * @param suffixLength The number of characters to keep at the end
+ * @returns The short address representation
+ */
+declare function getShortAddress(address: string, prefixLength?: number, suffixLength?: number): string;
+/**
+ * Create a new account with the given options
+ * @param options Account options
+ * @returns The created account
+ */
+declare function createAccount(options?: AccountOptions): Account;
+
+/**
+ * Base wallet error
+ */
+declare class WalletError extends Error {
+    name: string;
+}
+/**
+ * Error thrown when a wallet is not connected
+ */
+declare class WalletNotConnectedError extends WalletError {
+    name: string;
+    constructor();
+}
+/**
+ * Error thrown when the wallet connection is rejected
+ */
+declare class WalletConnectionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+/**
+ * Error thrown when a required wallet feature is not available
+ */
+declare class WalletFeatureNotAvailableError extends WalletError {
+    name: string;
+    constructor(feature: string);
+}
+/**
+ * Error thrown when a wallet transaction fails
+ */
+declare class WalletTransactionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+/**
+ * Error thrown when a user rejects a transaction
+ */
+declare class WalletTransactionRejectedError extends WalletTransactionError {
+    name: string;
+    constructor();
+}
+/**
+ * Error thrown when a transaction times out
+ */
+declare class WalletTransactionTimeoutError extends WalletTransactionError {
+    name: string;
+    constructor();
+}
+declare class WalletNotSelectedError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDisconnectionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletSignMessageError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletSwitchNetworkError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class WalletNotReadyError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDecryptionNotAllowedError extends WalletError {
+    name: string;
+    constructor();
+}
+declare class WalletDecryptionError extends WalletError {
+    name: string;
+    constructor(message?: string);
+}
+declare class MethodNotImplementedError extends WalletError {
+    name: string;
+    constructor(method: string);
+}
+
+export { BaseAleoWalletAdapter, MethodNotImplementedError, WalletConnectionError, WalletDecryptionError, WalletDecryptionNotAllowedError, WalletDisconnectionError, WalletError, WalletFeatureNotAvailableError, WalletNotConnectedError, WalletNotReadyError, WalletNotSelectedError, WalletSignMessageError, WalletSwitchNetworkError, WalletTransactionError, WalletTransactionRejectedError, WalletTransactionTimeoutError, createAccount, getShortAddress };