@aptos-labs/wallet-adapter-core 3.4.0 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @aptos-labs/wallet-adapter-core
 
+## 3.5.0
+
+### Minor Changes
+
+- 4ca4201: Export PluginProvider type
+
 ## 3.4.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -97,7 +97,7 @@ interface AdapterPluginProps<Name extends string = string> {
     connect(): Promise<any>;
     disconnect: () => Promise<any>;
     network: () => Promise<any>;
-    signAndSubmitTransaction<V>(transaction: Types.TransactionPayload | InputGenerateTransactionData, options?: InputGenerateTransactionOptions): Promise<{
+    signAndSubmitTransaction(transaction: Types.TransactionPayload | InputGenerateTransactionData, options?: InputGenerateTransactionOptions): Promise<{
         hash: Types.HexEncodedBytes;
         output?: any;
     } | PendingTransactionResponse>;
@@ -117,6 +117,18 @@ type InputTransactionData = {
     data: InputGenerateTransactionPayloadData;
     options?: InputGenerateTransactionOptions;
 };
+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<NetworkInfo>;
+    onAccountChange: (listener: (newAddress: AccountInfo) => Promise<void>) => Promise<void>;
+    onNetworkChange: OnNetworkChange;
+}
 
 declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private _wallets;
@@ -239,4 +251,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, SignMessagePayload, SignMessageResponse, TransactionOptions, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, areBCSArguments, generalizedErrorMessage, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };
+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 };

package/dist/index.js

@@ -309,6 +309,11 @@ var WalletCoreV1 = class extends import_eventemitter3.default {
     }
   }
   async signAndSubmitBCSTransaction(transaction, wallet, options) {
+    if (!("signAndSubmitBCSTransaction" in wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${wallet.name}`
+      ).message;
+    }
     try {
       const response = await wallet.signAndSubmitBCSTransaction(
         transaction,

package/dist/index.mjs

@@ -275,6 +275,11 @@ var WalletCoreV1 = class extends EventEmitter {
     }
   }
   async signAndSubmitBCSTransaction(transaction, wallet, options) {
+    if (!("signAndSubmitBCSTransaction" in wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${wallet.name}`
+      ).message;
+    }
     try {
       const response = await wallet.signAndSubmitBCSTransaction(
         transaction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-core",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/WalletCoreV1.ts

@@ -2,6 +2,7 @@ import { TxnBuilderTypes, Types } from "aptos";
 import EventEmitter from "eventemitter3";
 
 import {
+  WalletNotSupportedMethod,
   WalletSignAndSubmitMessageError,
   WalletSignTransactionError,
 } from "./error";
@@ -45,6 +46,11 @@ export class WalletCoreV1 extends EventEmitter<WalletCoreEvents> {
     wallet: Wallet,
     options?: TransactionOptions
   ): Promise<any> {
+    if (!("signAndSubmitBCSTransaction" in wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${wallet.name}`
+      ).message;
+    }
     try {
       const response = await (wallet as any).signAndSubmitBCSTransaction(
         transaction,

package/src/types.ts

@@ -103,7 +103,7 @@ export interface AdapterPluginProps<Name extends string = string> {
   connect(): Promise<any>;
   disconnect: () => Promise<any>;
   network: () => Promise<any>;
-  signAndSubmitTransaction<V>(
+  signAndSubmitTransaction(
     transaction: Types.TransactionPayload | InputGenerateTransactionData,
     options?: InputGenerateTransactionOptions
   ): Promise<
@@ -134,3 +134,20 @@ export type InputTransactionData = {
   data: InputGenerateTransactionPayloadData;
   options?: InputGenerateTransactionOptions;
 };
+
+// To be used by a wallet plugin
+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<NetworkInfo>;
+  onAccountChange: (
+    listener: (newAddress: AccountInfo) => Promise<void>
+  ) => Promise<void>;
+  onNetworkChange: OnNetworkChange;
+}