@aptos-labs/wallet-adapter-core 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @aptos-labs/wallet-adapter-core
 
+## 3.7.0
+
+### Minor Changes
+
+- 4d6e2f6: Add AIP-62 wallet standard support
+
 ## 3.6.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import { Types } from 'aptos';
 export { TxnBuilderTypes, Types } from 'aptos';
-import { Network, InputGenerateTransactionData, InputGenerateTransactionOptions, PendingTransactionResponse, InputSubmitTransactionData, AccountAddressInput, InputGenerateTransactionPayloadData, AnyRawTransaction, AccountAuthenticator, EntryFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes } from '@aptos-labs/ts-sdk';
+import { Network, Signature, AnyRawTransaction, InputGenerateTransactionOptions, PendingTransactionResponse, InputSubmitTransactionData, AccountAddressInput, InputGenerateTransactionPayloadData, Aptos, AccountAuthenticator, EntryFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes } from '@aptos-labs/ts-sdk';
 export { AccountAuthenticator, AnyRawTransaction, InputGenerateTransactionData, InputGenerateTransactionOptions, InputSubmitTransactionData, PendingTransactionResponse } from '@aptos-labs/ts-sdk';
 import EventEmitter from 'eventemitter3';
+import { NetworkInfo as NetworkInfo$1, AccountInfo as AccountInfo$1, UserResponse, AptosSignAndSubmitTransactionOutput, AptosSignMessageOutput, AptosWallet, AptosSignTransactionOutput, AptosSignMessageInput } from '@aptos-labs/wallet-standard';
 
 declare enum WalletReadyState {
     /**
@@ -28,6 +29,7 @@ declare enum NetworkName {
     Testnet = "testnet",
     Devnet = "devnet"
 }
+declare const ChainIdToAnsSupportedNetworkMap: Record<string, string>;
 
 type WalletName<T extends string = string> = T & {
     __brand__: "WalletName";
@@ -57,6 +59,7 @@ declare interface WalletCoreEvents {
     connect(account: AccountInfo | null): void;
     disconnect(): void;
     readyStateChange(wallet: Wallet): void;
+    standardWalletsAdded(wallets: Wallet): void;
     networkChange(network: NetworkInfo | null): void;
     accountChange(account: AccountInfo | null): void;
 }
@@ -75,11 +78,11 @@ interface SignMessageResponse {
     message: string;
     nonce: string;
     prefix: "APTOS";
-    signature: string | string[];
+    signature: string | string[] | Signature;
     bitmap?: Uint8Array;
 }
-type OnNetworkChange = (callBack: (networkInfo: NetworkInfo) => Promise<void>) => Promise<void>;
-type OnAccountChange = (callBack: (accountInfo: AccountInfo) => Promise<any>) => Promise<void>;
+type OnNetworkChange = (callBack: (networkInfo: NetworkInfo | NetworkInfo$1) => Promise<void>) => Promise<void>;
+type OnAccountChange = (callBack: (accountInfo: AccountInfo | AccountInfo$1) => Promise<any>) => Promise<void>;
 interface AdapterPluginEvents {
     onNetworkChange: OnNetworkChange;
     onAccountChange: OnAccountChange;
@@ -88,25 +91,29 @@ interface AdapterPluginProps<Name extends string = string> {
     name: WalletName<Name>;
     url: string;
     icon: `data:image/${"svg+xml" | "webp" | "png" | "gif"};base64,${string}`;
-    version?: "v1" | "v2";
     providerName?: string;
     provider: any;
     deeplinkProvider?: (data: {
         url: string;
     }) => string;
+    openInMobileApp?: () => void;
     connect(): Promise<any>;
     disconnect: () => Promise<any>;
     network: () => Promise<any>;
-    signAndSubmitTransaction(transaction: Types.TransactionPayload | InputGenerateTransactionData, options?: InputGenerateTransactionOptions): Promise<{
+    signAndSubmitTransaction?(transaction: Types.TransactionPayload | InputTransactionData | AnyRawTransaction, options?: InputGenerateTransactionOptions): Promise<{
         hash: Types.HexEncodedBytes;
         output?: any;
-    } | PendingTransactionResponse>;
+    } | PendingTransactionResponse | UserResponse<AptosSignAndSubmitTransactionOutput>>;
     submitTransaction?(transaction: InputSubmitTransactionData): Promise<PendingTransactionResponse>;
-    signMessage<T extends SignMessagePayload>(message: T): Promise<SignMessageResponse>;
+    signMessage<T extends SignMessagePayload>(message: T): Promise<SignMessageResponse | UserResponse<AptosSignMessageOutput>>;
+    signTransaction?(// `any` type for backwards compatibility, especially for identity connect
+    transactionOrPayload: any, optionsOrAsFeePayer?: any): Promise<any>;
+    account?: () => Promise<AccountInfo | AccountInfo$1>;
 }
 type AdapterPlugin<Name extends string = string> = AdapterPluginProps<Name> & AdapterPluginEvents;
 type Wallet<Name extends string = string> = AdapterPlugin<Name> & {
     readyState?: WalletReadyState;
+    isAIP62Standard?: boolean;
 };
 interface TransactionOptions {
     max_gas_amount?: bigint;
@@ -130,46 +137,171 @@ interface PluginProvider {
     onNetworkChange: OnNetworkChange;
 }
 
+type AptosStandardWallet = AptosWallet & {
+    readyState?: WalletReadyState;
+};
+declare class WalletStandardCore {
+    /**
+     * Signs and submits a transaction to chain
+     *
+     * @param transactionInput InputTransactionData
+     * @returns PendingTransactionResponse
+     */
+    signAndSubmitTransaction(transactionInput: InputTransactionData, aptos: Aptos, account: AccountInfo, wallet: Wallet): Promise<PendingTransactionResponse>;
+    /**
+     * Signs a transaction
+     *
+     * To support both existing wallet adapter V1 and V2, we support 2 input types
+     *
+     * @param transactionOrPayload AnyRawTransaction
+     * @param options asFeePayer. To sign a transaction as the fee payer sponsor
+     *
+     * @returns AptosSignTransactionOutput
+     */
+    signTransaction(transaction: AnyRawTransaction, wallet: Wallet, asFeePayer?: boolean): Promise<AptosSignTransactionOutput>;
+    /**
+     * Sign message
+     *
+     * @param message AptosSignMessageInput
+     * @return AptosSignMessageOutput
+     * @throws WalletSignMessageError
+     */
+    signMessage(message: AptosSignMessageInput, wallet: Wallet): Promise<AptosSignMessageOutput>;
+    /**
+     * Signs a message and verifies the signer
+     * @param message AptosSignMessageInput
+     * @returns boolean
+     */
+    signMessageAndVerify(message: AptosSignMessageInput, wallet: Wallet): Promise<boolean>;
+}
+
 declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private _wallets;
+    private _standard_wallets;
+    private _all_wallets;
     private _wallet;
     private _account;
     private _network;
-    private readonly waletCoreV1;
+    private readonly walletCoreV1;
+    private readonly walletStandardCore;
     private _connecting;
     private _connected;
+    /**
+     * Core functionality constructor.
+     * For legacy wallet adapter v1 support we expect the dapp to pass in wallet plugins,
+     * since AIP-62 standard support this is optional for dapps.
+     *
+     * @param plugins legacy wallet adapter v1 wallet plugins
+     */
     constructor(plugins: ReadonlyArray<Wallet>);
     private scopePollingDetectionStrategy;
+    private fetchAptosWallets;
+    private setWallets;
+    /**
+     * To maintain support for both plugins and AIP-62 standard wallets,
+     * without introducing dapps breaking changes, we convert
+     * AIP-62 standard compatible wallets to the legacy adapter wallet plugin type.
+     *
+     * @param standardWallet An AIP-62 standard compatible wallet
+     */
+    private standardizeStandardWalletToPluginWalletType;
+    /**
+     * Helper function to ensure wallet exists
+     *
+     * @param wallet A wallet
+     */
+    private ensureWalletExists;
+    /**
+     * Helper function to ensure account exists
+     *
+     * @param account An account
+     */
+    private ensureAccountExists;
+    /**
+     * @deprecated use ensureWalletExists
+     */
     private doesWalletExist;
+    /**
+     * Function to cleat wallet adapter data.
+     *
+     * - Removes current connected wallet state
+     * - Removes current connected account state
+     * - Removes current connected network state
+     * - Removes autoconnect local storage value
+     */
     private clearData;
+    /**
+     * Queries and sets ANS name for the current connected wallet account
+     */
     private setAnsName;
+    /**
+     * Sets the connected wallet
+     *
+     * @param wallet A wallet
+     */
     setWallet(wallet: Wallet | null): void;
-    setAccount(account: AccountInfo | null): void;
-    setNetwork(network: NetworkInfo | null): void;
+    /**
+     * Sets the connected account
+     *
+     * `AccountInfo` type comes from a legacy wallet adapter plugin
+     * `StandardAccountInfo` type comes from AIP-62 standard compatible wallet when onAccountChange event is called
+     * `UserResponse<StandardAccountInfo>` type comes from AIP-62 standard compatible wallet on wallet connect
+     *
+     * @param account An account
+     */
+    setAccount(account: AccountInfo | AccountInfo$1 | UserResponse<AccountInfo$1> | null): void;
+    /**
+     * Sets the connected network
+     *
+     * `NetworkInfo` type comes from a legacy wallet adapter plugin
+     * `StandardNetworkInfo` type comes from AIP-62 standard compatible wallet
+     *
+     * @param network A network
+     */
+    setNetwork(network: NetworkInfo | NetworkInfo$1 | null): void;
+    /**
+     * Helper function to detect whether a wallet is connected
+     *
+     * @returns boolean
+     */
     isConnected(): boolean;
+    /**
+     * Getter to fetch all detected wallets
+     */
     get wallets(): ReadonlyArray<Wallet>;
+    /**
+     * Getter to fetch all detected plugin wallets
+     */
+    get pluginWallets(): ReadonlyArray<Wallet>;
+    /**
+     * Getter to fetch all detected AIP-62 standard compatible wallets
+     */
+    get standardWallets(): ReadonlyArray<AptosStandardWallet>;
     /**
      * Getter for the current connected wallet
+     *
      * @return wallet info
      * @throws WalletNotSelectedError
      */
     get wallet(): WalletInfo | null;
     /**
      * Getter for the current connected account
+     *
      * @return account info
      * @throws WalletAccountError
      */
     get account(): AccountInfo | null;
     /**
      * Getter for the current wallet network
+     *
      * @return network info
      * @throws WalletGetNetworkError
      */
     get network(): NetworkInfo | null;
     /**
-     * We first make sure we can connect a dapp to a wallet.
-     * If all good, we connect the wallet by calling `this.connectWallet`
-     * @param walletName. The wallet name we want to connect.
+     * Helper function to run some checks before we connect with a wallet.
+     *
+     * @param walletName. The wallet name we want to connect with.
      */
     connect(walletName: string): Promise<void | string>;
     /**
@@ -183,11 +315,12 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
      */
     connectWallet(selectedWallet: Wallet): Promise<void>;
     /**
-    Disconnect the exisitng wallet. On success, we clear the
-    current account, current network and LocalStorage data.
-    @emit emits "disconnect" event
-    @throws WalletDisconnectionError
-    */
+     * Disconnect the current connected wallet. On success, we clear the
+     * current account, current network and LocalStorage data.
+     *
+     * @emit emits "disconnect" event
+     * @throws WalletDisconnectionError
+     */
     disconnect(): Promise<void>;
     /**
      * Signs and submits a transaction to chain
@@ -212,12 +345,19 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
      */
     signTransaction(transactionOrPayload: AnyRawTransaction | Types.TransactionPayload, asFeePayer?: boolean, options?: InputGenerateTransactionOptions): Promise<AccountAuthenticator>;
     /**
-     Sign message (doesnt submit to chain).
-     @param message
-     @return response from the wallet's signMessage function
-     @throws WalletSignMessageError
+     * Sign message (doesnt submit to chain).
+     *
+     * @param message
+     * @return response from the wallet's signMessage function
+     * @throws WalletSignMessageError
      */
     signMessage(message: SignMessagePayload): Promise<SignMessageResponse>;
+    /**
+     * Submits transaction to chain
+     *
+     * @param transaction
+     * @returns PendingTransactionResponse
+     */
     submitTransaction(transaction: InputSubmitTransactionData): Promise<PendingTransactionResponse>;
     /**
     Event for when account has changed on the wallet
@@ -251,4 +391,4 @@ declare function isRedirectable(): boolean;
 declare function generalizedErrorMessage(error: any): string;
 declare const areBCSArguments: (args: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>) => boolean;
 
-export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, InputTransactionData, NetworkInfo, NetworkName, OnAccountChange, OnNetworkChange, PluginProvider, SignMessagePayload, SignMessageResponse, TransactionOptions, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, areBCSArguments, generalizedErrorMessage, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };
+export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosStandardWallet, AptosWalletErrorResult, ChainIdToAnsSupportedNetworkMap, InputTransactionData, NetworkInfo, NetworkName, OnAccountChange, OnNetworkChange, PluginProvider, SignMessagePayload, SignMessageResponse, TransactionOptions, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, WalletStandardCore, areBCSArguments, generalizedErrorMessage, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };