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

package/dist/index.mjs

@@ -0,0 +1,386 @@
+// src/ShieldWalletAdapter.ts
+import {
+  Network
+} from "@provablehq/aleo-types";
+import {
+  WalletDecryptPermission,
+  WalletReadyState
+} from "@provablehq/aleo-wallet-standard";
+import {
+  BaseAleoWalletAdapter,
+  WalletConnectionError,
+  WalletDisconnectionError,
+  WalletError,
+  WalletNotConnectedError,
+  WalletSwitchNetworkError,
+  WalletSignMessageError,
+  WalletTransactionError,
+  WalletDecryptionError,
+  WalletDecryptionNotAllowedError,
+  scopePollingDetectionStrategy
+} from "@provablehq/aleo-wallet-adaptor-core";
+var ShieldWalletAdapter = class extends BaseAleoWalletAdapter {
+  /**
+   * Create a new Shield wallet adapter
+   * @param config Adapter configuration
+   */
+  constructor(config) {
+    super();
+    /**
+     * The wallet name
+     */
+    this.name = "Shield Wallet";
+    /**
+     * The wallet URL
+     */
+    this.url = "https://provable.com/";
+    /**
+     * The wallet icon (base64-encoded SVG)
+     */
+    this.icon = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgMTAyNCAxMDI0IiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cmVjdCB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiBmaWxsPSIjMDkwNzA3Ii8+CjxwYXRoIGQ9Ik01MTIgODcxQzcxMC4yNyA4NzEgODcxIDcxMC4yNyA4NzEgNTEyQzg3MSA1MDUuMTI0IDg3MC44MDcgNDk4LjI5MyA4NzAuNDI1IDQ5MS41MTJDNzQ2LjQzIDYyNy4wNTggNDYxLjk5NCA3NjIuNDcgMzE0LjM5OSA4MTAuNjY0TDMxMi42ODQgODEwLjYzM0MzNjkuNzA0IDg0OC43NjUgNDM4LjI1NSA4NzEgNTEyIDg3MVoiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGQ9Ik0yNTAuNDA4IDc1Ny44NjhDMTkwLjAwNiA2OTMuNjI4IDE1MyA2MDcuMTM2IDE1MyA1MTJDMTUzIDMxMy43MyAzMTMuNzMgMTUzIDUxMiAxNTNDNjkyLjk5MyAxNTMgODQyLjcwMyAyODYuOTM4IDg2Ny40MiA0NjEuMTA1QzYxMS4yMTIgNjM4LjgyMyAzNzcuNjU5IDcxOC42OCAyNTEuMDQ2IDc1Ny44NjhIMjUwLjQwOFoiIGZpbGw9IndoaXRlIi8+Cjwvc3ZnPgo=";
+    /**
+     * The wallet's decrypt permission
+     */
+    this.decryptPermission = WalletDecryptPermission.NoDecrypt;
+    /**
+     * Public key
+     */
+    this._publicKey = "";
+    this._readyState = typeof window === "undefined" || typeof document === "undefined" ? WalletReadyState.UNSUPPORTED : WalletReadyState.NOT_DETECTED;
+    /**
+     * EVENTS HANDLING
+     */
+    // Network change listener
+    this._onNetworkChange = (network) => {
+      console.debug("Shield Wallet network changed to: ", network);
+      this.network = network;
+      this.emit("networkChange", network);
+    };
+    // Account change listener
+    this._onAccountChange = () => {
+      console.debug("Shield Wallet account change detected \u2013 reauthorization required");
+      this._publicKey = "";
+      this.account = void 0;
+      this.emit("accountChange");
+    };
+    // Disconnect listener
+    this._onDisconnect = () => {
+      console.debug("Shield Wallet disconnected");
+      this._cleanupListeners();
+      this._publicKey = "";
+      this.account = void 0;
+      this.emit("disconnect");
+    };
+    console.debug("ShieldWalletAdapter constructor", config);
+    this.network = Network.TESTNET3;
+    if (this._readyState !== WalletReadyState.UNSUPPORTED) {
+      scopePollingDetectionStrategy(() => this._checkAvailability());
+    }
+  }
+  /**
+   * Check if Shield wallet is available
+   */
+  _checkAvailability() {
+    this._window = window;
+    if (this._window.shield) {
+      this.readyState = WalletReadyState.INSTALLED;
+      this._shieldWallet = this._window?.shield;
+      return true;
+    } else {
+      const isMobile = /iPhone|iPad|iPod|Android/i.test(navigator.userAgent);
+      if (isMobile) {
+        this.readyState = WalletReadyState.LOADABLE;
+        return true;
+      }
+      return false;
+    }
+  }
+  /**
+   * Connect to Shield wallet
+   * @returns The connected account
+   */
+  async connect(network, decryptPermission, programs) {
+    try {
+      if (this.readyState !== WalletReadyState.INSTALLED) {
+        throw new WalletConnectionError("Shield Wallet is not available");
+      }
+      try {
+        const connectResult = await this._shieldWallet?.connect(
+          network,
+          decryptPermission,
+          programs
+        );
+        this._publicKey = connectResult?.address || "";
+        this._onNetworkChange(network);
+      } catch (error) {
+        throw new WalletConnectionError(
+          error instanceof Error ? error.message : "Connection failed"
+        );
+      }
+      if (!this._publicKey) {
+        throw new WalletConnectionError("No address returned from wallet");
+      }
+      this._setupListeners();
+      const account = {
+        address: this._publicKey
+      };
+      this.account = account;
+      this.decryptPermission = decryptPermission;
+      this.emit("connect", account);
+      return account;
+    } catch (err) {
+      this.emit("error", err instanceof Error ? err : new Error(String(err)));
+      throw new WalletConnectionError(err instanceof Error ? err.message : "Connection failed");
+    }
+  }
+  /**
+   * Disconnect from Shield wallet
+   */
+  async disconnect() {
+    try {
+      this._cleanupListeners();
+      await this._shieldWallet?.disconnect();
+      this._onDisconnect();
+    } catch (err) {
+      this.emit("error", err instanceof Error ? err : new Error(String(err)));
+      throw new WalletDisconnectionError(
+        err instanceof Error ? err.message : "Disconnection failed"
+      );
+    }
+  }
+  /**
+   * Sign a transaction with Shield wallet
+   * @param message The message to sign
+   * @returns The signed message
+   */
+  async signMessage(message) {
+    if (!this._publicKey || !this.account) {
+      throw new WalletNotConnectedError();
+    }
+    try {
+      const signature = await this._shieldWallet?.signMessage(message);
+      if (!signature) {
+        throw new WalletSignMessageError("Failed to sign message");
+      }
+      return signature;
+    } catch (error) {
+      throw new WalletSignMessageError(
+        error instanceof Error ? error.message : "Failed to sign message"
+      );
+    }
+  }
+  async decrypt(cipherText) {
+    if (!this._shieldWallet || !this._publicKey) {
+      throw new WalletNotConnectedError();
+    }
+    switch (this.decryptPermission) {
+      case WalletDecryptPermission.NoDecrypt:
+        throw new WalletDecryptionNotAllowedError();
+      case WalletDecryptPermission.UponRequest:
+      case WalletDecryptPermission.AutoDecrypt:
+      case WalletDecryptPermission.OnChainHistory: {
+        try {
+          return await this._shieldWallet.decrypt(cipherText);
+        } catch (error) {
+          throw new WalletDecryptionError(
+            error instanceof Error ? error.message : "Failed to decrypt"
+          );
+        }
+      }
+      default:
+        throw new WalletDecryptionError();
+    }
+  }
+  /**
+   * Execute a transaction with Shield wallet
+   * @param options Transaction options
+   * @returns The executed temporary transaction ID
+   */
+  async executeTransaction(options) {
+    if (!this._publicKey || !this.account) {
+      throw new WalletNotConnectedError();
+    }
+    try {
+      const result = await this._shieldWallet?.executeTransaction({
+        ...options,
+        network: this.network
+      });
+      if (!result?.transactionId) {
+        throw new WalletTransactionError("Could not create transaction");
+      }
+      return {
+        transactionId: result.transactionId
+      };
+    } catch (error) {
+      console.error("ShieldWalletAdapter executeTransaction error", error);
+      if (error instanceof WalletError) {
+        throw error;
+      }
+      throw new WalletTransactionError(
+        error instanceof Error ? error.message : "Failed to execute transaction"
+      );
+    }
+  }
+  /**
+   * Get transaction status
+   * @param transactionId The transaction ID
+   * @returns The transaction status
+   */
+  async transactionStatus(transactionId) {
+    if (!this._publicKey || !this.account) {
+      throw new WalletNotConnectedError();
+    }
+    try {
+      const result = await this._shieldWallet?.transactionStatus(transactionId);
+      if (!result?.status) {
+        throw new WalletTransactionError("Could not get transaction status");
+      }
+      return result;
+    } catch (error) {
+      throw new WalletTransactionError(
+        error instanceof Error ? error.message : "Failed to get transaction status"
+      );
+    }
+  }
+  /**
+   * Switch the network
+   * @param network The network to switch to
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async switchNetwork(_network) {
+    if (!this._publicKey || !this.account) {
+      throw new WalletNotConnectedError();
+    }
+    try {
+      await this._shieldWallet?.switchNetwork(_network);
+      this._onNetworkChange(_network);
+    } catch (error) {
+      throw new WalletSwitchNetworkError(
+        error instanceof Error ? error.message : "Failed to switch network"
+      );
+    }
+  }
+  /**
+   * 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
+   */
+  async requestRecords(program, includePlaintext) {
+    if (!this._publicKey || !this.account) {
+      throw new WalletNotConnectedError();
+    }
+    try {
+      const result = await this._shieldWallet?.requestRecords(program, includePlaintext);
+      return result || [];
+    } catch (error) {
+      throw new WalletError(error instanceof Error ? error.message : "Failed to request records");
+    }
+  }
+  /**
+   * Execute a deployment
+   * @param deployment The deployment to execute
+   * @returns The executed transaction ID
+   */
+  async executeDeployment(deployment) {
+    try {
+      if (!this._publicKey || !this.account) {
+        throw new WalletNotConnectedError();
+      }
+      try {
+        const result = await this._shieldWallet?.executeDeployment({
+          ...deployment,
+          network: this.network
+        });
+        if (!result?.transactionId) {
+          throw new WalletTransactionError("Could not create deployment");
+        }
+        return {
+          transactionId: result.transactionId
+        };
+      } catch (error) {
+        throw new WalletTransactionError(
+          error instanceof Error ? error.message : "Failed to execute deployment"
+        );
+      }
+    } catch (error) {
+      this.emit("error", error instanceof Error ? error : new Error(String(error)));
+      throw error;
+    }
+  }
+  /**
+   * get transition view keys(tvk) for a transaction
+   * @param transactionId The transaction ID
+   * @returns The tvk array
+   */
+  async transitionViewKeys(transactionId) {
+    try {
+      if (!this._publicKey || !this.account) {
+        throw new WalletNotConnectedError();
+      }
+      try {
+        const result = await this._shieldWallet?.transitionViewKeys(transactionId);
+        if (!Array.isArray(result)) {
+          throw new WalletTransactionError("Could not get transitionViewKeys");
+        }
+        return result;
+      } catch (error) {
+        throw new WalletTransactionError(
+          error instanceof Error ? error.message : "Failed to get transitionViewKeys"
+        );
+      }
+    } catch (error) {
+      this.emit("error", error instanceof Error ? error : new Error(String(error)));
+      throw error;
+    }
+  }
+  /**
+   * get transaction of specific program
+   * @param program The program ID
+   * @returns array of transactionId
+   */
+  async requestTransactionHistory(program) {
+    try {
+      if (!this._publicKey || !this.account) {
+        throw new WalletNotConnectedError();
+      }
+      try {
+        const result = await this._shieldWallet?.requestTransactionHistory(program);
+        if (!result?.transactions || !Array.isArray(result.transactions)) {
+          throw new WalletTransactionError("Could not get TransactionHistory");
+        }
+        return result;
+      } catch (error) {
+        throw new WalletTransactionError(
+          error instanceof Error ? error.message : "Failed to get transitionViewKeys"
+        );
+      }
+    } catch (error) {
+      this.emit("error", error instanceof Error ? error : new Error(String(error)));
+      throw error;
+    }
+  }
+  /**
+   * Set up event listeners with structured approach
+   */
+  _setupListeners() {
+    if (!this._shieldWallet)
+      return;
+    this._shieldWallet.on("networkChanged", this._onNetworkChange);
+    this._shieldWallet.on("disconnect", this._onDisconnect);
+    this._shieldWallet.on("accountChanged", this._onAccountChange);
+  }
+  /**
+   * Clean up all event listeners
+   */
+  _cleanupListeners() {
+    if (!this._shieldWallet)
+      return;
+    this._shieldWallet.off("networkChanged", this._onNetworkChange);
+    this._shieldWallet.off("disconnect", this._onDisconnect);
+    this._shieldWallet.off("accountChanged", this._onAccountChange);
+  }
+};
+export {
+  ShieldWalletAdapter
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@provablehq/aleo-wallet-adaptor-shield",
+  "version": "0.3.0-alpha.0",
+  "description": "Shield wallet adapter for Aleo",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "license": "GPL-3.0-or-later",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@provablehq/aleo-types": "0.3.0-alpha.0",
+    "@provablehq/aleo-wallet-standard": "0.3.0-alpha.0",
+    "@provablehq/aleo-wallet-adaptor-core": "0.3.0-alpha.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ProvableHQ/aleo-dev-toolkit.git",
+    "directory": "packages/aleo-wallet-adaptor/wallets/shield"
+  },
+  "homepage": "https://provable.com/",
+  "keywords": [
+    "aleo",
+    "wallet",
+    "adapter",
+    "prove",
+    "alpha"
+  ],
+  "author": "Provable Labs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.5",
+    "tsup": "^7.0.0",
+    "typescript": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist",
+    "dev": "tsup --watch"
+  }
+}