@provablehq/aleo-wallet-adaptor-shield 0.3.0-alpha.0

package/README.md

@@ -0,0 +1,32 @@
+# @provablehq/aleo-wallet-adaptor-shield
+
+Prove wallet connector (alpha) built on top of the Aleo wallet adaptor core.
+
+## When to use it
+
+- Integrate the Prove wallet (pre-release build) alongside other Aleo wallets.
+- Offer developers a preview experience before the final Prove branding and APIs are finalised.
+- Experiment with Prove-specific features while maintaining the shared adaptor contract.
+
+## Installation
+
+```bash
+pnpm add @provablehq/aleo-wallet-adaptor-shield
+```
+
+## Usage
+
+```tsx
+import { ShieldWalletAdapter } from '@provablehq/aleo-wallet-adaptor-shield';
+
+const wallets = [new ShieldWalletAdapter()];
+```
+
+> **Note:** The exported class is still named `ShieldWalletAdapter` for internal compatibility. The package name will change again once the final brand is announced.
+
+## Related packages
+
+- `@provablehq/aleo-wallet-adaptor-core` – required base implementation.
+- `@provablehq/aleo-wallet-adaptor-react` – provider that wires this adapter into React apps.
+
+Live demo: https://aleo-dev-toolkit-react-app.vercel.app/

package/dist/index.d.mts

@@ -0,0 +1,166 @@
+import { TransactionOptions, Network, TransactionStatusResponse, TxHistoryResult, Account } from '@provablehq/aleo-types';
+import { AleoDeployment, EventEmitter, WalletDecryptPermission, WalletName, WalletReadyState } from '@provablehq/aleo-wallet-standard';
+import { BaseAleoWalletAdapter } from '@provablehq/aleo-wallet-adaptor-core';
+
+interface ShieldWalletAdapterConfig {
+}
+interface ShieldTransaction extends TransactionOptions {
+    network: Network;
+}
+interface ShieldDeployment extends AleoDeployment {
+    network: Network;
+}
+interface ShieldWalletEvents {
+    networkChanged(network: Network): void;
+    disconnect(): void;
+    accountChanged(): void;
+}
+interface ShieldWallet extends EventEmitter<ShieldWalletEvents> {
+    publicKey?: string;
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<{
+        address: string;
+    }>;
+    disconnect(): Promise<void>;
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    decrypt(cipherText: string): Promise<string>;
+    executeTransaction(transactionOptions: ShieldTransaction): Promise<{
+        transactionId?: string;
+    }>;
+    transactionStatus(transactionId: string): Promise<TransactionStatusResponse>;
+    switchNetwork(network: Network): Promise<void>;
+    requestRecords(program: string, includePlaintext?: boolean): Promise<unknown[]>;
+    executeDeployment(deployment: ShieldDeployment): Promise<{
+        transactionId: string;
+    }>;
+    transitionViewKeys: (transactionId: string) => Promise<string[]>;
+    requestTransactionHistory: (program: string) => Promise<TxHistoryResult>;
+}
+interface ShieldWindow extends Window {
+    shield?: ShieldWallet;
+}
+
+/**
+ * Shield wallet adapter
+ */
+declare class ShieldWalletAdapter extends BaseAleoWalletAdapter {
+    /**
+     * The wallet name
+     */
+    readonly name: WalletName<"Shield Wallet">;
+    /**
+     * The wallet URL
+     */
+    url: string;
+    /**
+     * The wallet icon (base64-encoded SVG)
+     */
+    readonly icon = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgMTAyNCAxMDI0IiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cmVjdCB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiBmaWxsPSIjMDkwNzA3Ii8+CjxwYXRoIGQ9Ik01MTIgODcxQzcxMC4yNyA4NzEgODcxIDcxMC4yNyA4NzEgNTEyQzg3MSA1MDUuMTI0IDg3MC44MDcgNDk4LjI5MyA4NzAuNDI1IDQ5MS41MTJDNzQ2LjQzIDYyNy4wNTggNDYxLjk5NCA3NjIuNDcgMzE0LjM5OSA4MTAuNjY0TDMxMi42ODQgODEwLjYzM0MzNjkuNzA0IDg0OC43NjUgNDM4LjI1NSA4NzEgNTEyIDg3MVoiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGQ9Ik0yNTAuNDA4IDc1Ny44NjhDMTkwLjAwNiA2OTMuNjI4IDE1MyA2MDcuMTM2IDE1MyA1MTJDMTUzIDMxMy43MyAzMTMuNzMgMTUzIDUxMiAxNTNDNjkyLjk5MyAxNTMgODQyLjcwMyAyODYuOTM4IDg2Ny40MiA0NjEuMTA1QzYxMS4yMTIgNjM4LjgyMyAzNzcuNjU5IDcxOC42OCAyNTEuMDQ2IDc1Ny44NjhIMjUwLjQwOFoiIGZpbGw9IndoaXRlIi8+Cjwvc3ZnPgo=";
+    /**
+     * The window object
+     */
+    private _window;
+    /**
+     * Current network
+     */
+    network: Network;
+    /**
+     * The wallet's decrypt permission
+     */
+    decryptPermission: WalletDecryptPermission;
+    /**
+     * Public key
+     */
+    private _publicKey;
+    _readyState: WalletReadyState;
+    /**
+     * Shield wallet instance
+     */
+    private _shieldWallet;
+    /**
+     * Create a new Shield wallet adapter
+     * @param config Adapter configuration
+     */
+    constructor(config?: ShieldWalletAdapterConfig);
+    /**
+     * Check if Shield wallet is available
+     */
+    private _checkAvailability;
+    /**
+     * Connect to Shield wallet
+     * @returns The connected account
+     */
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<Account>;
+    /**
+     * Disconnect from Shield wallet
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Sign a transaction with Shield wallet
+     * @param message The message to sign
+     * @returns The signed message
+     */
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    decrypt(cipherText: string): Promise<string>;
+    /**
+     * Execute a transaction with Shield wallet
+     * @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>;
+    /**
+     * Switch the network
+     * @param network The network to switch to
+     */
+    switchNetwork(_network: Network): Promise<void>;
+    /**
+     * Request records from Shield wallet
+     * @param program The program to request records from
+     * @param includePlaintext Whether to include plaintext on each record
+     * @returns The records
+     */
+    requestRecords(program: string, includePlaintext: boolean): Promise<unknown[]>;
+    /**
+     * Execute a deployment
+     * @param deployment The deployment to execute
+     * @returns The executed transaction ID
+     */
+    executeDeployment(deployment: AleoDeployment): Promise<{
+        transactionId: string;
+    }>;
+    /**
+     * get transition view keys(tvk) for a transaction
+     * @param transactionId The transaction ID
+     * @returns The tvk array
+     */
+    transitionViewKeys(transactionId: string): Promise<string[]>;
+    /**
+     * get transaction of specific program
+     * @param program The program ID
+     * @returns array of transactionId
+     */
+    requestTransactionHistory(program: string): Promise<TxHistoryResult>;
+    /**
+     * EVENTS HANDLING
+     */
+    _onNetworkChange: (network: Network) => void;
+    _onAccountChange: () => void;
+    _onDisconnect: () => void;
+    /**
+     * Set up event listeners with structured approach
+     */
+    private _setupListeners;
+    /**
+     * Clean up all event listeners
+     */
+    private _cleanupListeners;
+}
+
+export { type ShieldDeployment, type ShieldTransaction, type ShieldWallet, ShieldWalletAdapter, type ShieldWalletAdapterConfig, type ShieldWalletEvents, type ShieldWindow };

package/dist/index.d.ts

@@ -0,0 +1,166 @@
+import { TransactionOptions, Network, TransactionStatusResponse, TxHistoryResult, Account } from '@provablehq/aleo-types';
+import { AleoDeployment, EventEmitter, WalletDecryptPermission, WalletName, WalletReadyState } from '@provablehq/aleo-wallet-standard';
+import { BaseAleoWalletAdapter } from '@provablehq/aleo-wallet-adaptor-core';
+
+interface ShieldWalletAdapterConfig {
+}
+interface ShieldTransaction extends TransactionOptions {
+    network: Network;
+}
+interface ShieldDeployment extends AleoDeployment {
+    network: Network;
+}
+interface ShieldWalletEvents {
+    networkChanged(network: Network): void;
+    disconnect(): void;
+    accountChanged(): void;
+}
+interface ShieldWallet extends EventEmitter<ShieldWalletEvents> {
+    publicKey?: string;
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<{
+        address: string;
+    }>;
+    disconnect(): Promise<void>;
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    decrypt(cipherText: string): Promise<string>;
+    executeTransaction(transactionOptions: ShieldTransaction): Promise<{
+        transactionId?: string;
+    }>;
+    transactionStatus(transactionId: string): Promise<TransactionStatusResponse>;
+    switchNetwork(network: Network): Promise<void>;
+    requestRecords(program: string, includePlaintext?: boolean): Promise<unknown[]>;
+    executeDeployment(deployment: ShieldDeployment): Promise<{
+        transactionId: string;
+    }>;
+    transitionViewKeys: (transactionId: string) => Promise<string[]>;
+    requestTransactionHistory: (program: string) => Promise<TxHistoryResult>;
+}
+interface ShieldWindow extends Window {
+    shield?: ShieldWallet;
+}
+
+/**
+ * Shield wallet adapter
+ */
+declare class ShieldWalletAdapter extends BaseAleoWalletAdapter {
+    /**
+     * The wallet name
+     */
+    readonly name: WalletName<"Shield Wallet">;
+    /**
+     * The wallet URL
+     */
+    url: string;
+    /**
+     * The wallet icon (base64-encoded SVG)
+     */
+    readonly icon = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgMTAyNCAxMDI0IiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cmVjdCB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiBmaWxsPSIjMDkwNzA3Ii8+CjxwYXRoIGQ9Ik01MTIgODcxQzcxMC4yNyA4NzEgODcxIDcxMC4yNyA4NzEgNTEyQzg3MSA1MDUuMTI0IDg3MC44MDcgNDk4LjI5MyA4NzAuNDI1IDQ5MS41MTJDNzQ2LjQzIDYyNy4wNTggNDYxLjk5NCA3NjIuNDcgMzE0LjM5OSA4MTAuNjY0TDMxMi42ODQgODEwLjYzM0MzNjkuNzA0IDg0OC43NjUgNDM4LjI1NSA4NzEgNTEyIDg3MVoiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGQ9Ik0yNTAuNDA4IDc1Ny44NjhDMTkwLjAwNiA2OTMuNjI4IDE1MyA2MDcuMTM2IDE1MyA1MTJDMTUzIDMxMy43MyAzMTMuNzMgMTUzIDUxMiAxNTNDNjkyLjk5MyAxNTMgODQyLjcwMyAyODYuOTM4IDg2Ny40MiA0NjEuMTA1QzYxMS4yMTIgNjM4LjgyMyAzNzcuNjU5IDcxOC42OCAyNTEuMDQ2IDc1Ny44NjhIMjUwLjQwOFoiIGZpbGw9IndoaXRlIi8+Cjwvc3ZnPgo=";
+    /**
+     * The window object
+     */
+    private _window;
+    /**
+     * Current network
+     */
+    network: Network;
+    /**
+     * The wallet's decrypt permission
+     */
+    decryptPermission: WalletDecryptPermission;
+    /**
+     * Public key
+     */
+    private _publicKey;
+    _readyState: WalletReadyState;
+    /**
+     * Shield wallet instance
+     */
+    private _shieldWallet;
+    /**
+     * Create a new Shield wallet adapter
+     * @param config Adapter configuration
+     */
+    constructor(config?: ShieldWalletAdapterConfig);
+    /**
+     * Check if Shield wallet is available
+     */
+    private _checkAvailability;
+    /**
+     * Connect to Shield wallet
+     * @returns The connected account
+     */
+    connect(network: Network, decryptPermission: WalletDecryptPermission, programs?: string[]): Promise<Account>;
+    /**
+     * Disconnect from Shield wallet
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Sign a transaction with Shield wallet
+     * @param message The message to sign
+     * @returns The signed message
+     */
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    decrypt(cipherText: string): Promise<string>;
+    /**
+     * Execute a transaction with Shield wallet
+     * @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>;
+    /**
+     * Switch the network
+     * @param network The network to switch to
+     */
+    switchNetwork(_network: Network): Promise<void>;
+    /**
+     * Request records from Shield wallet
+     * @param program The program to request records from
+     * @param includePlaintext Whether to include plaintext on each record
+     * @returns The records
+     */
+    requestRecords(program: string, includePlaintext: boolean): Promise<unknown[]>;
+    /**
+     * Execute a deployment
+     * @param deployment The deployment to execute
+     * @returns The executed transaction ID
+     */
+    executeDeployment(deployment: AleoDeployment): Promise<{
+        transactionId: string;
+    }>;
+    /**
+     * get transition view keys(tvk) for a transaction
+     * @param transactionId The transaction ID
+     * @returns The tvk array
+     */
+    transitionViewKeys(transactionId: string): Promise<string[]>;
+    /**
+     * get transaction of specific program
+     * @param program The program ID
+     * @returns array of transactionId
+     */
+    requestTransactionHistory(program: string): Promise<TxHistoryResult>;
+    /**
+     * EVENTS HANDLING
+     */
+    _onNetworkChange: (network: Network) => void;
+    _onAccountChange: () => void;
+    _onDisconnect: () => void;
+    /**
+     * Set up event listeners with structured approach
+     */
+    private _setupListeners;
+    /**
+     * Clean up all event listeners
+     */
+    private _cleanupListeners;
+}
+
+export { type ShieldDeployment, type ShieldTransaction, type ShieldWallet, ShieldWalletAdapter, type ShieldWalletAdapterConfig, type ShieldWalletEvents, type ShieldWindow };