@aptos-labs/wallet-adapter-core 2.5.1 → 3.0.0

package/src/types.ts

@@ -1,17 +1,40 @@
 import { Types } from "aptos";
-import { NetworkName, WalletReadyState } from "./constants";
+import {
+  Network,
+  InputGenerateTransactionData,
+  InputGenerateTransactionOptions,
+  InputSubmitTransactionData,
+  PendingTransactionResponse,
+} from "@aptos-labs/ts-sdk";
+import { WalletReadyState } from "./constants";
 
 export { TxnBuilderTypes, Types } from "aptos";
+export type {
+  InputGenerateTransactionData,
+  InputGenerateTransactionOptions,
+  AnyRawTransaction,
+  InputSubmitTransactionData,
+  PendingTransactionResponse,
+  AccountAuthenticator,
+} from "@aptos-labs/ts-sdk";
+
 // WalletName is a nominal type that wallet adapters should use, e.g. `'MyCryptoWallet' as WalletName<'MyCryptoWallet'>`
 export type WalletName<T extends string = string> = T & {
   __brand__: "WalletName";
 };
+
 export type NetworkInfo = {
-  name: NetworkName;
+  name: Network;
   chainId?: string;
   url?: string;
 };
 
+export type WalletInfo = {
+  name: WalletName;
+  icon: string;
+  url: string;
+};
+
 export type AccountInfo = {
   address: string;
   publicKey: string | string[];
@@ -25,45 +48,68 @@ export interface AptosWalletErrorResult {
   message: string;
 }
 
+export declare interface WalletCoreEvents {
+  connect(account: AccountInfo | null): void;
+  disconnect(): void;
+  readyStateChange(wallet: Wallet): void;
+  networkChange(network: NetworkInfo | null): void;
+  accountChange(account: AccountInfo | null): void;
+}
+
+export interface SignMessagePayload {
+  address?: boolean; // Should we include the address of the account in the message
+  application?: boolean; // Should we include the domain of the dapp
+  chainId?: boolean; // Should we include the current chain id the wallet is connected to
+  message: string; // The message to be signed and displayed to the user
+  nonce: string; // A nonce the dapp should generate
+}
+
+export interface SignMessageResponse {
+  address?: string;
+  application?: string;
+  chainId?: number;
+  fullMessage: string; // The message that was generated to sign
+  message: string; // The message passed in by the user
+  nonce: string;
+  prefix: "APTOS"; // Should always be APTOS
+  signature: string | string[]; // The signed full message
+  bitmap?: Uint8Array; // a 4-byte (32 bits) bit-vector of length N
+}
+
 export type OnNetworkChange = (
   callBack: (networkInfo: NetworkInfo) => Promise<void>
 ) => Promise<void>;
 
-export interface PluginProvider {
-  connect: () => Promise<AccountInfo>;
-  account: () => Promise<AccountInfo>;
-  disconnect: () => Promise<void>;
-  signAndSubmitTransaction: (
-    transaction: any,
-    options?: any
-  ) => Promise<{ hash: Types.HexEncodedBytes } | AptosWalletErrorResult>;
-  signMessage: (message: SignMessagePayload) => Promise<SignMessageResponse>;
-  network: () => Promise<NetworkName>;
-  onAccountChange: (
-    listener: (newAddress: AccountInfo) => Promise<void>
-  ) => Promise<void>;
-  onNetworkChange: OnNetworkChange;
-}
+export type OnAccountChange = (
+  callBack: (accountInfo: AccountInfo) => Promise<any>
+) => Promise<void>;
 
 export interface AdapterPluginEvents {
   onNetworkChange: OnNetworkChange;
-  onAccountChange(callback: any): Promise<any>;
+  onAccountChange: OnAccountChange;
 }
 
+// TODO add signTransaction()
 export 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;
   connect(): Promise<any>;
   disconnect: () => Promise<any>;
   network: () => Promise<any>;
-  signAndSubmitTransaction<T extends Types.TransactionPayload, V>(
-    transaction: T,
-    options?: V
-  ): Promise<{ hash: Types.HexEncodedBytes }>;
+  signAndSubmitTransaction<V>(
+    transaction: Types.TransactionPayload | InputGenerateTransactionData,
+    options?: InputGenerateTransactionOptions
+  ): Promise<
+    { hash: Types.HexEncodedBytes; output?: any } | PendingTransactionResponse
+  >;
+  submitTransaction?(
+    transaction: InputSubmitTransactionData
+  ): Promise<PendingTransactionResponse>;
   signMessage<T extends SignMessagePayload>(
     message: T
   ): Promise<SignMessageResponse>;
@@ -76,40 +122,6 @@ export type Wallet<Name extends string = string> = AdapterPlugin<Name> & {
   readyState?: WalletReadyState;
 };
 
-export type WalletInfo = {
-  name: WalletName;
-  icon: string;
-  url: string;
-};
-
-export declare interface WalletCoreEvents {
-  connect(account: AccountInfo | null): void;
-  disconnect(): void;
-  readyStateChange(wallet: Wallet): void;
-  networkChange(network: NetworkInfo | null): void;
-  accountChange(account: AccountInfo | null): void;
-}
-
-export interface SignMessagePayload {
-  address?: boolean; // Should we include the address of the account in the message
-  application?: boolean; // Should we include the domain of the dapp
-  chainId?: boolean; // Should we include the current chain id the wallet is connected to
-  message: string; // The message to be signed and displayed to the user
-  nonce: string; // A nonce the dapp should generate
-}
-
-export interface SignMessageResponse {
-  address?: string;
-  application?: string;
-  chainId?: number;
-  fullMessage: string; // The message that was generated to sign
-  message: string; // The message passed in by the user
-  nonce: string;
-  prefix: "APTOS"; // Should always be APTOS
-  signature: string | string[]; // The signed full message
-  bitmap?: Uint8Array; // a 4-byte (32 bits) bit-vector of length N
-}
-
 export interface TransactionOptions {
   max_gas_amount?: bigint;
   gas_unit_price?: bigint;

package/src/utils/helpers.ts

@@ -18,9 +18,15 @@ export function isInAppBrowser(): boolean {
 
 export function isRedirectable(): boolean {
   // SSR: return false
-  if (typeof navigator === 'undefined' || !navigator) return false;
+  if (typeof navigator === "undefined" || !navigator) return false;
 
   // if we are on mobile and NOT in a in-app browser we will redirect to a wallet app
 
   return isMobile() && !isInAppBrowser();
 }
+
+export function generalizedErrorMessage(error: any): string {
+  return typeof error === "object" && "message" in error
+    ? error.message
+    : error;
+}