@awarizon/web3 1.1.0 → 1.1.1

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { Chain, WalletClient, Address, Abi, PublicClient, Hex } from 'viem';
 export { Abi, Address, Chain, Hash, TransactionReceipt, WalletClient } from 'viem';
-import { WalletEngine, CreatedWallet, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, ExternalWalletClient } from '@awarizon/wallet-engine';
-export { ChainSwitchError, InvalidMnemonicError, InvalidPrivateKeyError, WalletEngine, WalletNotConnectedError } from '@awarizon/wallet-engine';
+import { WalletEngine, CreatedWallet, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, ConnectorInfo, ExternalWalletClient, EIP1193Provider, SignTypedDataParams, WalletChangeEvent, ChainChangeEvent } from '@awarizon/wallet-engine';
+export { ChainChangeEvent, ChainMismatchError, ChainSwitchError, ConnectorInfo, CreatedWallet, EIP1193Provider, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, InvalidMnemonicError, InvalidPrivateKeyError, SignTypedDataParams, WalletChangeEvent, WalletEngine, WalletNotConnectedError } from '@awarizon/wallet-engine';
 import { TransactionResult } from '@awarizon/tx-engine';
 export { ContractExecutionError, GasEstimationError, SimulationError, TransactionEngine, TransactionResult, TransactionTimeoutError } from '@awarizon/tx-engine';
 export { DuplicateFunctionError, InvalidABIError, UnsupportedABIItemError, generateAllMethodSignatures, generateMethodSignature, isPayableFunction, isWriteFunction, parseABI } from '@awarizon/abi-engine';
@@ -34,6 +34,12 @@ interface AwarizonConfig {
      * Override for local development or staging environments.
      */
     baseUrl?: string;
+    /**
+     * When true, the SDK automatically requests a chain switch on the external
+     * wallet before every write if the wallet is on the wrong network.
+     * Only affects external wallets (wagmi, RainbowKit, EIP-1193).
+     */
+    autoSwitchChain?: boolean;
 }
 interface ContractConfig<TAbi extends Abi = Abi> {
     /** The deployed contract address */
@@ -76,6 +82,8 @@ interface SDKWalletInfo {
     address: Address;
     chain: Chain;
     isExternal: boolean;
+    /** Name of the connector if an external wallet is active, e.g. "MetaMask" */
+    connectorName?: string;
 }
 interface ContractRegistryEntry {
     address: Address;
@@ -661,10 +669,26 @@ declare class WalletProxy {
     isConnected(): boolean;
     hasExternalWallet(): boolean;
     hasInternalWallet(): boolean;
-    connectExternal(c: ExternalWalletClient): void;
+    getConnectorInfo(): ConnectorInfo;
+    connectExternal(c: ExternalWalletClient, info?: {
+        name?: string;
+        icon?: string;
+    }): void;
     disconnectExternal(): void;
     disconnect(): void;
     switchChain(chain: Chain): Promise<void>;
+    connectEIP1193(provider: EIP1193Provider, info?: {
+        name?: string;
+        icon?: string;
+    }): Promise<void>;
+    signMessage(message: string | {
+        raw: Hex | Uint8Array;
+    }): Promise<Hex>;
+    signTypedData(params: SignTypedDataParams): Promise<Hex>;
+    getChainId(): Promise<number>;
+    isChainMismatch(): Promise<boolean>;
+    onWalletChange(cb: (event: WalletChangeEvent) => void): () => void;
+    onChainChange(cb: (event: ChainChangeEvent) => void): () => void;
 }
 /**
  * Primary entry point for the Awarizon Web3 SDK.
@@ -694,10 +718,89 @@ declare class AwarizonWeb3 {
     private _contractCache;
     private _registry;
     constructor(config: AwarizonConfig);
-    connectWallet(walletClient: WalletClient): this;
+    /**
+     * Connect any viem WalletClient (wagmi, RainbowKit, custom).
+     * Optionally pass connector metadata to display in the UI.
+     *
+     * @example
+     * awarizon.connectWallet(walletClient, { name: "MetaMask" })
+     */
+    connectWallet(walletClient: WalletClient, connectorInfo?: {
+        name?: string;
+        icon?: string;
+    }): this;
+    /**
+     * Connect directly from a raw EIP-1193 provider without needing wagmi.
+     * Works with window.ethereum, WalletConnect v2, and any EIP-1193 object.
+     *
+     * @example
+     * await awarizon.connectEIP1193Provider(window.ethereum, { name: "MetaMask" })
+     */
+    connectEIP1193Provider(provider: EIP1193Provider, connectorInfo?: {
+        name?: string;
+        icon?: string;
+    }): Promise<this>;
     disconnectWallet(): this;
     switchChain(chain: Chain | string): Promise<this>;
     getWalletInfo(): SDKWalletInfo;
+    /**
+     * Sign a plain text or raw-bytes message.
+     * Use for Sign-In with Ethereum (SIWE) and off-chain authorization.
+     *
+     * @example
+     * const sig = await awarizon.signMessage("Hello, Awarizon!")
+     */
+    signMessage(message: string | {
+        raw: Hex | Uint8Array;
+    }): Promise<Hex>;
+    /**
+     * Sign EIP-712 typed structured data (permit2, SIWE, Seaport orders, etc.).
+     *
+     * @example
+     * const sig = await awarizon.signTypedData({
+     *   domain: { name: "MyApp", version: "1", chainId: 8453 },
+     *   types:  { Transfer: [{ name: "to", type: "address" }, { name: "amount", type: "uint256" }] },
+     *   primaryType: "Transfer",
+     *   message: { to: "0x...", amount: "1000000" },
+     * })
+     */
+    signTypedData(params: SignTypedDataParams): Promise<Hex>;
+    /**
+     * Returns the chain ID the active wallet is currently on.
+     * For external wallets this may differ from the SDK's configured chain.
+     */
+    getChainId(): Promise<number>;
+    /**
+     * Returns true when the external wallet is on a different chain than the SDK.
+     * Use this to show a "wrong network" banner in your UI.
+     *
+     * @example
+     * if (await awarizon.isChainMismatch()) {
+     *   alert("Please switch to Base in your wallet")
+     * }
+     */
+    isChainMismatch(): Promise<boolean>;
+    /**
+     * Returns metadata about the currently active connector.
+     * Useful for displaying "Connected via MetaMask" in the UI.
+     */
+    getConnectorInfo(): ConnectorInfo;
+    /**
+     * Subscribe to wallet changes (connect, disconnect, account switch).
+     * Returns an unsubscribe function — call it on cleanup.
+     *
+     * @example
+     * const unsub = awarizon.onWalletChange(({ address, type, name }) => {
+     *   console.log("Wallet changed:", address, type, name)
+     * })
+     * unsub() // stop listening
+     */
+    onWalletChange(cb: (event: WalletChangeEvent) => void): () => void;
+    /**
+     * Subscribe to chain changes (switchChain calls).
+     * Returns an unsubscribe function.
+     */
+    onChainChange(cb: (event: ChainChangeEvent) => void): () => void;
     /**
      * Load a deployed contract and return a fully typed, ABI-powered instance.
      * Validates the API key on the first call — subsequent calls are instant.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Chain, WalletClient, Address, Abi, PublicClient, Hex } from 'viem';
 export { Abi, Address, Chain, Hash, TransactionReceipt, WalletClient } from 'viem';
-import { WalletEngine, CreatedWallet, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, ExternalWalletClient } from '@awarizon/wallet-engine';
-export { ChainSwitchError, InvalidMnemonicError, InvalidPrivateKeyError, WalletEngine, WalletNotConnectedError } from '@awarizon/wallet-engine';
+import { WalletEngine, CreatedWallet, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, ConnectorInfo, ExternalWalletClient, EIP1193Provider, SignTypedDataParams, WalletChangeEvent, ChainChangeEvent } from '@awarizon/wallet-engine';
+export { ChainChangeEvent, ChainMismatchError, ChainSwitchError, ConnectorInfo, CreatedWallet, EIP1193Provider, ImportedWalletFromMnemonic, ImportedWalletFromPrivateKey, InvalidMnemonicError, InvalidPrivateKeyError, SignTypedDataParams, WalletChangeEvent, WalletEngine, WalletNotConnectedError } from '@awarizon/wallet-engine';
 import { TransactionResult } from '@awarizon/tx-engine';
 export { ContractExecutionError, GasEstimationError, SimulationError, TransactionEngine, TransactionResult, TransactionTimeoutError } from '@awarizon/tx-engine';
 export { DuplicateFunctionError, InvalidABIError, UnsupportedABIItemError, generateAllMethodSignatures, generateMethodSignature, isPayableFunction, isWriteFunction, parseABI } from '@awarizon/abi-engine';
@@ -34,6 +34,12 @@ interface AwarizonConfig {
      * Override for local development or staging environments.
      */
     baseUrl?: string;
+    /**
+     * When true, the SDK automatically requests a chain switch on the external
+     * wallet before every write if the wallet is on the wrong network.
+     * Only affects external wallets (wagmi, RainbowKit, EIP-1193).
+     */
+    autoSwitchChain?: boolean;
 }
 interface ContractConfig<TAbi extends Abi = Abi> {
     /** The deployed contract address */
@@ -76,6 +82,8 @@ interface SDKWalletInfo {
     address: Address;
     chain: Chain;
     isExternal: boolean;
+    /** Name of the connector if an external wallet is active, e.g. "MetaMask" */
+    connectorName?: string;
 }
 interface ContractRegistryEntry {
     address: Address;
@@ -661,10 +669,26 @@ declare class WalletProxy {
     isConnected(): boolean;
     hasExternalWallet(): boolean;
     hasInternalWallet(): boolean;
-    connectExternal(c: ExternalWalletClient): void;
+    getConnectorInfo(): ConnectorInfo;
+    connectExternal(c: ExternalWalletClient, info?: {
+        name?: string;
+        icon?: string;
+    }): void;
     disconnectExternal(): void;
     disconnect(): void;
     switchChain(chain: Chain): Promise<void>;
+    connectEIP1193(provider: EIP1193Provider, info?: {
+        name?: string;
+        icon?: string;
+    }): Promise<void>;
+    signMessage(message: string | {
+        raw: Hex | Uint8Array;
+    }): Promise<Hex>;
+    signTypedData(params: SignTypedDataParams): Promise<Hex>;
+    getChainId(): Promise<number>;
+    isChainMismatch(): Promise<boolean>;
+    onWalletChange(cb: (event: WalletChangeEvent) => void): () => void;
+    onChainChange(cb: (event: ChainChangeEvent) => void): () => void;
 }
 /**
  * Primary entry point for the Awarizon Web3 SDK.
@@ -694,10 +718,89 @@ declare class AwarizonWeb3 {
     private _contractCache;
     private _registry;
     constructor(config: AwarizonConfig);
-    connectWallet(walletClient: WalletClient): this;
+    /**
+     * Connect any viem WalletClient (wagmi, RainbowKit, custom).
+     * Optionally pass connector metadata to display in the UI.
+     *
+     * @example
+     * awarizon.connectWallet(walletClient, { name: "MetaMask" })
+     */
+    connectWallet(walletClient: WalletClient, connectorInfo?: {
+        name?: string;
+        icon?: string;
+    }): this;
+    /**
+     * Connect directly from a raw EIP-1193 provider without needing wagmi.
+     * Works with window.ethereum, WalletConnect v2, and any EIP-1193 object.
+     *
+     * @example
+     * await awarizon.connectEIP1193Provider(window.ethereum, { name: "MetaMask" })
+     */
+    connectEIP1193Provider(provider: EIP1193Provider, connectorInfo?: {
+        name?: string;
+        icon?: string;
+    }): Promise<this>;
     disconnectWallet(): this;
     switchChain(chain: Chain | string): Promise<this>;
     getWalletInfo(): SDKWalletInfo;
+    /**
+     * Sign a plain text or raw-bytes message.
+     * Use for Sign-In with Ethereum (SIWE) and off-chain authorization.
+     *
+     * @example
+     * const sig = await awarizon.signMessage("Hello, Awarizon!")
+     */
+    signMessage(message: string | {
+        raw: Hex | Uint8Array;
+    }): Promise<Hex>;
+    /**
+     * Sign EIP-712 typed structured data (permit2, SIWE, Seaport orders, etc.).
+     *
+     * @example
+     * const sig = await awarizon.signTypedData({
+     *   domain: { name: "MyApp", version: "1", chainId: 8453 },
+     *   types:  { Transfer: [{ name: "to", type: "address" }, { name: "amount", type: "uint256" }] },
+     *   primaryType: "Transfer",
+     *   message: { to: "0x...", amount: "1000000" },
+     * })
+     */
+    signTypedData(params: SignTypedDataParams): Promise<Hex>;
+    /**
+     * Returns the chain ID the active wallet is currently on.
+     * For external wallets this may differ from the SDK's configured chain.
+     */
+    getChainId(): Promise<number>;
+    /**
+     * Returns true when the external wallet is on a different chain than the SDK.
+     * Use this to show a "wrong network" banner in your UI.
+     *
+     * @example
+     * if (await awarizon.isChainMismatch()) {
+     *   alert("Please switch to Base in your wallet")
+     * }
+     */
+    isChainMismatch(): Promise<boolean>;
+    /**
+     * Returns metadata about the currently active connector.
+     * Useful for displaying "Connected via MetaMask" in the UI.
+     */
+    getConnectorInfo(): ConnectorInfo;
+    /**
+     * Subscribe to wallet changes (connect, disconnect, account switch).
+     * Returns an unsubscribe function — call it on cleanup.
+     *
+     * @example
+     * const unsub = awarizon.onWalletChange(({ address, type, name }) => {
+     *   console.log("Wallet changed:", address, type, name)
+     * })
+     * unsub() // stop listening
+     */
+    onWalletChange(cb: (event: WalletChangeEvent) => void): () => void;
+    /**
+     * Subscribe to chain changes (switchChain calls).
+     * Returns an unsubscribe function.
+     */
+    onChainChange(cb: (event: ChainChangeEvent) => void): () => void;
     /**
      * Load a deployed contract and return a fully typed, ABI-powered instance.
      * Validates the API key on the first call — subsequent calls are instant.

package/dist/index.js

@@ -428,8 +428,11 @@ var WalletProxy = class {
   hasInternalWallet() {
     return this.engine.hasInternalWallet();
   }
-  connectExternal(c) {
-    this.engine.connectExternal(c);
+  getConnectorInfo() {
+    return this.engine.getConnectorInfo();
+  }
+  connectExternal(c, info) {
+    this.engine.connectExternal(c, info);
   }
   disconnectExternal() {
     this.engine.disconnectExternal();
@@ -440,6 +443,32 @@ var WalletProxy = class {
   async switchChain(chain) {
     return this.engine.switchChain(chain);
   }
+  // ── Gated async — EIP-1193, signing, chain awareness ───────────────────────
+  async connectEIP1193(provider, info) {
+    await this.ensureReady();
+    return this.engine.connectEIP1193(provider, info);
+  }
+  async signMessage(message) {
+    await this.ensureReady();
+    return this.engine.signMessage(message);
+  }
+  async signTypedData(params) {
+    await this.ensureReady();
+    return this.engine.signTypedData(params);
+  }
+  async getChainId() {
+    return this.engine.getChainId();
+  }
+  async isChainMismatch() {
+    return this.engine.isChainMismatch();
+  }
+  // ── Event subscriptions ────────────────────────────────────────────────────
+  onWalletChange(cb) {
+    return this.engine.onWalletChange(cb);
+  }
+  onChainChange(cb) {
+    return this.engine.onChainChange(cb);
+  }
 };
 var AwarizonWeb3 = class {
   constructor(config) {
@@ -473,8 +502,27 @@ var AwarizonWeb3 = class {
     }
   }
   // ─── Wallet API surface ─────────────────────────────────────────────────────
-  connectWallet(walletClient) {
-    this._engine.connectExternal(walletClient);
+  /**
+   * Connect any viem WalletClient (wagmi, RainbowKit, custom).
+   * Optionally pass connector metadata to display in the UI.
+   *
+   * @example
+   * awarizon.connectWallet(walletClient, { name: "MetaMask" })
+   */
+  connectWallet(walletClient, connectorInfo) {
+    this._engine.connectExternal(walletClient, connectorInfo);
+    return this;
+  }
+  /**
+   * Connect directly from a raw EIP-1193 provider without needing wagmi.
+   * Works with window.ethereum, WalletConnect v2, and any EIP-1193 object.
+   *
+   * @example
+   * await awarizon.connectEIP1193Provider(window.ethereum, { name: "MetaMask" })
+   */
+  async connectEIP1193Provider(provider, connectorInfo) {
+    await this._telemetry.ensureValidated();
+    await this._engine.connectEIP1193(provider, connectorInfo);
     return this;
   }
   disconnectWallet() {
@@ -489,12 +537,86 @@ var AwarizonWeb3 = class {
     return this;
   }
   getWalletInfo() {
+    const info = this._engine.getConnectorInfo();
     return {
       address: this._engine.address(),
       chain: this.chain,
-      isExternal: this._engine.hasExternalWallet()
+      isExternal: this._engine.hasExternalWallet(),
+      connectorName: info.name
     };
   }
+  /**
+   * Sign a plain text or raw-bytes message.
+   * Use for Sign-In with Ethereum (SIWE) and off-chain authorization.
+   *
+   * @example
+   * const sig = await awarizon.signMessage("Hello, Awarizon!")
+   */
+  async signMessage(message) {
+    await this._telemetry.ensureValidated();
+    return this._engine.signMessage(message);
+  }
+  /**
+   * Sign EIP-712 typed structured data (permit2, SIWE, Seaport orders, etc.).
+   *
+   * @example
+   * const sig = await awarizon.signTypedData({
+   *   domain: { name: "MyApp", version: "1", chainId: 8453 },
+   *   types:  { Transfer: [{ name: "to", type: "address" }, { name: "amount", type: "uint256" }] },
+   *   primaryType: "Transfer",
+   *   message: { to: "0x...", amount: "1000000" },
+   * })
+   */
+  async signTypedData(params) {
+    await this._telemetry.ensureValidated();
+    return this._engine.signTypedData(params);
+  }
+  /**
+   * Returns the chain ID the active wallet is currently on.
+   * For external wallets this may differ from the SDK's configured chain.
+   */
+  async getChainId() {
+    return this._engine.getChainId();
+  }
+  /**
+   * Returns true when the external wallet is on a different chain than the SDK.
+   * Use this to show a "wrong network" banner in your UI.
+   *
+   * @example
+   * if (await awarizon.isChainMismatch()) {
+   *   alert("Please switch to Base in your wallet")
+   * }
+   */
+  async isChainMismatch() {
+    return this._engine.isChainMismatch();
+  }
+  /**
+   * Returns metadata about the currently active connector.
+   * Useful for displaying "Connected via MetaMask" in the UI.
+   */
+  getConnectorInfo() {
+    return this._engine.getConnectorInfo();
+  }
+  /**
+   * Subscribe to wallet changes (connect, disconnect, account switch).
+   * Returns an unsubscribe function — call it on cleanup.
+   *
+   * @example
+   * const unsub = awarizon.onWalletChange(({ address, type, name }) => {
+   *   console.log("Wallet changed:", address, type, name)
+   * })
+   * unsub() // stop listening
+   */
+  onWalletChange(cb) {
+    return this._engine.onWalletChange(cb);
+  }
+  /**
+   * Subscribe to chain changes (switchChain calls).
+   * Returns an unsubscribe function.
+   */
+  onChainChange(cb) {
+    return this._engine.onChainChange(cb);
+  }
   // ─── Contract API ───────────────────────────────────────────────────────────
   /**
    * Load a deployed contract and return a fully typed, ABI-powered instance.
@@ -785,6 +907,10 @@ Currently registered: ${registered}`
   }
 };
 
+Object.defineProperty(exports, "ChainMismatchError", {
+  enumerable: true,
+  get: function () { return walletEngine.ChainMismatchError; }
+});
 Object.defineProperty(exports, "ChainSwitchError", {
   enumerable: true,
   get: function () { return walletEngine.ChainSwitchError; }