@aptos-labs/wallet-adapter-core 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @aptos-labs/wallet-adapter-core
 
+## 2.6.0
+
+### Minor Changes
+
+- 7acfa69: Adding support for the new Typescript SDK in the package `@aptos-labs/ts-sdk`. The wallet adapter now supports submitting a basic transaction with the new SDK types.
+
+### Patch Changes
+
+- dd6e1ed: Moves dependencies to peer dependencies as needed
+
+## 2.5.1
+
+### Patch Changes
+
+- 7e314e5: Update aptos dependency
+
 ## 2.5.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 import { Types, TxnBuilderTypes } from 'aptos';
+export { TxnBuilderTypes, Types } from 'aptos';
+import { InputGenerateTransactionData } from '@aptos-labs/ts-sdk';
+export { InputGenerateTransactionData } from '@aptos-labs/ts-sdk';
 import EventEmitter from 'eventemitter3';
 
 declare enum WalletReadyState {
@@ -26,15 +29,15 @@ declare enum NetworkName {
     Devnet = "devnet"
 }
 
-declare type WalletName<T extends string = string> = T & {
+type WalletName<T extends string = string> = T & {
     __brand__: "WalletName";
 };
-declare type NetworkInfo = {
+type NetworkInfo = {
     name: NetworkName;
     chainId?: string;
     url?: string;
 };
-declare type AccountInfo = {
+type AccountInfo = {
     address: string;
     publicKey: string | string[];
     minKeysRequired?: number;
@@ -45,7 +48,7 @@ interface AptosWalletErrorResult {
     name: string;
     message: string;
 }
-declare type OnNetworkChange = (callBack: (networkInfo: NetworkInfo) => Promise<void>) => Promise<void>;
+type OnNetworkChange = (callBack: (networkInfo: NetworkInfo) => Promise<void>) => Promise<void>;
 interface PluginProvider {
     connect: () => Promise<AccountInfo>;
     account: () => Promise<AccountInfo>;
@@ -57,6 +60,7 @@ interface PluginProvider {
     network: () => Promise<NetworkName>;
     onAccountChange: (listener: (newAddress: AccountInfo) => Promise<void>) => Promise<void>;
     onNetworkChange: OnNetworkChange;
+    signMultiAgentTransaction: (rawTxn: TxnBuilderTypes.MultiAgentRawTransaction | TxnBuilderTypes.FeePayerRawTransaction) => Promise<string>;
 }
 interface AdapterPluginEvents {
     onNetworkChange: OnNetworkChange;
@@ -79,11 +83,11 @@ interface AdapterPluginProps<Name extends string = string> {
     }>;
     signMessage<T extends SignMessagePayload>(message: T): Promise<SignMessageResponse>;
 }
-declare type AdapterPlugin<Name extends string = string> = AdapterPluginProps<Name> & AdapterPluginEvents;
-declare type Wallet<Name extends string = string> = AdapterPlugin<Name> & {
+type AdapterPlugin<Name extends string = string> = AdapterPluginProps<Name> & AdapterPluginEvents;
+type Wallet<Name extends string = string> = AdapterPlugin<Name> & {
     readyState?: WalletReadyState;
 };
-declare type WalletInfo = {
+type WalletInfo = {
     name: WalletName;
     icon: string;
     url: string;
@@ -185,28 +189,42 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     */
     signAndSubmitTransaction(transaction: Types.TransactionPayload, options?: TransactionOptions): Promise<any>;
     /**
-    Sign and submit a bsc serialized transaction type to chain.
-    @param transaction a bcs serialized transaction
-    @param options max_gas_amount and gas_unit_limit
-    @return response from the wallet's signAndSubmitBCSTransaction function
-    @throws WalletSignAndSubmitMessageError
-    */
+     Sign and submit a bsc serialized transaction type to chain.
+     @param transaction a bcs serialized transaction
+     @param options max_gas_amount and gas_unit_limit
+     @return response from the wallet's signAndSubmitBCSTransaction function
+     @throws WalletSignAndSubmitMessageError
+     */
     signAndSubmitBCSTransaction(transaction: TxnBuilderTypes.TransactionPayload, options?: TransactionOptions): Promise<any>;
     /**
-    Sign transaction (doesnt submit to chain).
-    @param transaction
-    @param options max_gas_amount and gas_unit_limit
-    @return response from the wallet's signTransaction function
-    @throws WalletSignTransactionError
-    */
+     Sign transaction (doesnt submit to chain).
+     @param transaction
+     @param options max_gas_amount and gas_unit_limit
+     @return response from the wallet's signTransaction function
+     @throws WalletSignTransactionError
+     */
     signTransaction(transaction: Types.TransactionPayload, options?: TransactionOptions): Promise<Uint8Array | null>;
     /**
-    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 | null>;
+    /**
+     * This function is for signing and submitting a transaction using the `@aptos-labs/ts-sdk` (aka the v2 SDK)
+     * input types. It's internally converting the input types to the old SDK input types and then calling
+     * the v1 SDK's `signAndSubmitBCSTransaction` with it.
+     *
+     * @param transactionInput the transaction input
+     * @param options max_gas_amount and gas_unit_limit
+     * @returns the response from the wallet's signAndSubmitBCSTransaction function
+     */
+    submitTransaction(transactionInput: InputGenerateTransactionData, options?: TransactionOptions): Promise<{
+        hash: string;
+        output?: any;
+    }>;
+    signMultiAgentTransaction(transaction: TxnBuilderTypes.MultiAgentRawTransaction | TxnBuilderTypes.FeePayerRawTransaction): Promise<string | null>;
     /**
     Event for when account has changed on the wallet
     @return the new account info

package/dist/index.js

@@ -27,6 +27,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   NetworkName: () => NetworkName,
+  TxnBuilderTypes: () => import_aptos3.TxnBuilderTypes,
+  Types: () => import_aptos3.Types,
   WalletCore: () => WalletCore,
   WalletReadyState: () => WalletReadyState,
   getLocalStorage: () => getLocalStorage,
@@ -40,7 +42,8 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/WalletCore.ts
-var import_aptos = require("aptos");
+var import_aptos2 = require("aptos");
+var import_ts_sdk2 = require("@aptos-labs/ts-sdk");
 var import_eventemitter3 = __toESM(require("eventemitter3"));
 var import_tweetnacl = __toESM(require("tweetnacl"));
 var import_buffer = require("buffer");
@@ -235,6 +238,26 @@ var getNameByAddress = async (chainId, address) => {
   }
 };
 
+// src/conversion.ts
+var import_ts_sdk = require("@aptos-labs/ts-sdk");
+var import_aptos = require("aptos");
+function convertNetwork(networkInfo) {
+  switch (networkInfo == null ? void 0 : networkInfo.name.toLowerCase()) {
+    case "mainnet":
+      return import_ts_sdk.Network.MAINNET;
+    case "testnet":
+      return import_ts_sdk.Network.TESTNET;
+    case "devnet":
+      return import_ts_sdk.Network.DEVNET;
+    default:
+      throw new Error("Invalid network name");
+  }
+}
+function convertToBCSPayload(payload) {
+  const deserializer = new import_aptos.BCS.Deserializer(payload.bcsToBytes());
+  return import_aptos.TxnBuilderTypes.TransactionPayload.deserialize(deserializer);
+}
+
 // src/WalletCore.ts
 var WalletCore = class extends import_eventemitter3.default {
   constructor(plugins) {
@@ -456,6 +479,33 @@ var WalletCore = class extends import_eventemitter3.default {
       throw new WalletSignMessageError(errMsg).message;
     }
   }
+  async submitTransaction(transactionInput, options) {
+    const payloadData = transactionInput.data;
+    const aptosConfig = new import_ts_sdk2.AptosConfig({ network: convertNetwork(this._network) });
+    const newPayload = await (0, import_ts_sdk2.generateTransactionPayload)({ ...payloadData, aptosConfig });
+    const oldTransactionPayload = convertToBCSPayload(newPayload);
+    const response = await this.signAndSubmitBCSTransaction(oldTransactionPayload, options);
+    const { hash, ...output } = response;
+    return { hash, output };
+  }
+  async signMultiAgentTransaction(transaction) {
+    var _a;
+    if (this._wallet && !("signMultiAgentTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Multi-agent & sponsored transactions are not supported by ${(_a = this.wallet) == null ? void 0 : _a.name}`
+      ).message;
+    }
+    try {
+      this.doesWalletExist();
+      const response = await this._wallet.signMultiAgentTransaction(
+        transaction
+      );
+      return response;
+    } catch (error) {
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignTransactionError(errMsg).message;
+    }
+  }
   async onAccountChange() {
     var _a;
     try {
@@ -526,10 +576,10 @@ var WalletCore = class extends import_eventemitter3.default {
           throw new WalletSignMessageAndVerifyError("Failed to get a bitmap").message;
         }
       } else {
-        const currentAccountPublicKey = new import_aptos.HexString(
+        const currentAccountPublicKey = new import_aptos2.HexString(
           this._account.publicKey
         );
-        const signature = new import_aptos.HexString(response.signature);
+        const signature = new import_aptos2.HexString(response.signature);
         verified = import_tweetnacl.default.sign.detached.verify(
           import_buffer.Buffer.from(response.fullMessage),
           import_buffer.Buffer.from(signature.noPrefix(), "hex"),
@@ -543,9 +593,14 @@ var WalletCore = class extends import_eventemitter3.default {
     }
   }
 };
+
+// src/types.ts
+var import_aptos3 = require("aptos");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NetworkName,
+  TxnBuilderTypes,
+  Types,
   WalletCore,
   WalletReadyState,
   getLocalStorage,

package/dist/index.mjs

@@ -1,5 +1,6 @@
 // src/WalletCore.ts
 import { HexString } from "aptos";
+import { AptosConfig, generateTransactionPayload } from "@aptos-labs/ts-sdk";
 import EventEmitter from "eventemitter3";
 import nacl from "tweetnacl";
 import { Buffer } from "buffer";
@@ -194,6 +195,26 @@ var getNameByAddress = async (chainId, address) => {
   }
 };
 
+// src/conversion.ts
+import { Network } from "@aptos-labs/ts-sdk";
+import { BCS, TxnBuilderTypes } from "aptos";
+function convertNetwork(networkInfo) {
+  switch (networkInfo == null ? void 0 : networkInfo.name.toLowerCase()) {
+    case "mainnet":
+      return Network.MAINNET;
+    case "testnet":
+      return Network.TESTNET;
+    case "devnet":
+      return Network.DEVNET;
+    default:
+      throw new Error("Invalid network name");
+  }
+}
+function convertToBCSPayload(payload) {
+  const deserializer = new BCS.Deserializer(payload.bcsToBytes());
+  return TxnBuilderTypes.TransactionPayload.deserialize(deserializer);
+}
+
 // src/WalletCore.ts
 var WalletCore = class extends EventEmitter {
   constructor(plugins) {
@@ -415,6 +436,33 @@ var WalletCore = class extends EventEmitter {
       throw new WalletSignMessageError(errMsg).message;
     }
   }
+  async submitTransaction(transactionInput, options) {
+    const payloadData = transactionInput.data;
+    const aptosConfig = new AptosConfig({ network: convertNetwork(this._network) });
+    const newPayload = await generateTransactionPayload({ ...payloadData, aptosConfig });
+    const oldTransactionPayload = convertToBCSPayload(newPayload);
+    const response = await this.signAndSubmitBCSTransaction(oldTransactionPayload, options);
+    const { hash, ...output } = response;
+    return { hash, output };
+  }
+  async signMultiAgentTransaction(transaction) {
+    var _a;
+    if (this._wallet && !("signMultiAgentTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Multi-agent & sponsored transactions are not supported by ${(_a = this.wallet) == null ? void 0 : _a.name}`
+      ).message;
+    }
+    try {
+      this.doesWalletExist();
+      const response = await this._wallet.signMultiAgentTransaction(
+        transaction
+      );
+      return response;
+    } catch (error) {
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignTransactionError(errMsg).message;
+    }
+  }
   async onAccountChange() {
     var _a;
     try {
@@ -502,8 +550,13 @@ var WalletCore = class extends EventEmitter {
     }
   }
 };
+
+// src/types.ts
+import { TxnBuilderTypes as TxnBuilderTypes3, Types as Types2 } from "aptos";
 export {
   NetworkName,
+  TxnBuilderTypes3 as TxnBuilderTypes,
+  Types2 as Types,
   WalletCore,
   WalletReadyState,
   getLocalStorage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-core",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -38,11 +38,14 @@
     "@aptos-labs/wallet-adapter-tsconfig": "0.0.0"
   },
   "dependencies": {
-    "aptos": "^1.3.17",
+    "@aptos-labs/ts-sdk": "^0.0.3",
     "buffer": "^6.0.3",
     "eventemitter3": "^4.0.7",
     "tweetnacl": "^1.0.3"
   },
+  "peerDependencies": {
+    "aptos": "^1.19.0"
+  },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
     "dev": "tsup src/index.ts --format esm,cjs --watch --dts",

package/src/WalletCore.ts

@@ -1,4 +1,5 @@
 import { HexString, TxnBuilderTypes, Types } from "aptos";
+import { AptosConfig, InputGenerateTransactionData, generateTransactionPayload } from "@aptos-labs/ts-sdk";
 import EventEmitter from "eventemitter3";
 import nacl from "tweetnacl";
 import { Buffer } from "buffer";
@@ -38,6 +39,8 @@ import {
   isRedirectable,
 } from "./utils";
 import { getNameByAddress } from "./ans";
+import { AccountAuthenticator } from "@aptos-labs/ts-sdk";
+import { convertNetwork, convertToBCSPayload } from "./conversion";
 
 export class WalletCore extends EventEmitter<WalletCoreEvents> {
   private _wallets: ReadonlyArray<Wallet> = [];
@@ -244,8 +247,8 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
-  Disconnect the exisitng wallet. On success, we clear the 
+  /**
+  Disconnect the exisitng wallet. On success, we clear the
   current account, current network and LocalStorage data.
   @emit emits "disconnect" event
   @throws WalletDisconnectionError
@@ -263,7 +266,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
+  /**
   Sign and submit an entry (not bcs serialized) transaction type to chain.
   @param transaction a non-bcs serialized transaction
   @param options max_gas_amount and gas_unit_limit
@@ -288,13 +291,13 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
-  Sign and submit a bsc serialized transaction type to chain.
-  @param transaction a bcs serialized transaction
-  @param options max_gas_amount and gas_unit_limit
-  @return response from the wallet's signAndSubmitBCSTransaction function
-  @throws WalletSignAndSubmitMessageError
-  */
+  /**
+   Sign and submit a bsc serialized transaction type to chain.
+   @param transaction a bcs serialized transaction
+   @param options max_gas_amount and gas_unit_limit
+   @return response from the wallet's signAndSubmitBCSTransaction function
+   @throws WalletSignAndSubmitMessageError
+   */
   async signAndSubmitBCSTransaction(
     transaction: TxnBuilderTypes.TransactionPayload,
     options?: TransactionOptions
@@ -319,13 +322,13 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
-  Sign transaction (doesnt submit to chain).
-  @param transaction
-  @param options max_gas_amount and gas_unit_limit
-  @return response from the wallet's signTransaction function
-  @throws WalletSignTransactionError
-  */
+  /**
+   Sign transaction (doesnt submit to chain).
+   @param transaction
+   @param options max_gas_amount and gas_unit_limit
+   @return response from the wallet's signTransaction function
+   @throws WalletSignTransactionError
+   */
   async signTransaction(
     transaction: Types.TransactionPayload,
     options?: TransactionOptions
@@ -350,12 +353,12 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
-  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
+   */
   async signMessage(
     message: SignMessagePayload
   ): Promise<SignMessageResponse | null> {
@@ -371,7 +374,51 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
+  /**
+   * This function is for signing and submitting a transaction using the `@aptos-labs/ts-sdk` (aka the v2 SDK)
+   * input types. It's internally converting the input types to the old SDK input types and then calling
+   * the v1 SDK's `signAndSubmitBCSTransaction` with it.
+   * 
+   * @param transactionInput the transaction input
+   * @param options max_gas_amount and gas_unit_limit
+   * @returns the response from the wallet's signAndSubmitBCSTransaction function
+   */
+  async submitTransaction(
+    transactionInput: InputGenerateTransactionData,
+    options?: TransactionOptions,
+  ): Promise<{ hash: string, output?: any }> {
+    const payloadData = transactionInput.data;
+    const aptosConfig = new AptosConfig({network: convertNetwork(this._network)});
+    // TODO: Refactor this any, and remove the need for it by fixing the if ("bytecode" in data) stuff in `generateTransaction` in the v2 SDK
+    const newPayload = await generateTransactionPayload({ ...payloadData as any, aptosConfig: aptosConfig });
+    const oldTransactionPayload = convertToBCSPayload(newPayload);
+    const response = await this.signAndSubmitBCSTransaction(oldTransactionPayload, options);
+    const { hash, ...output } = response;
+    return { hash, output };
+  }
+
+  async signMultiAgentTransaction(
+    transaction: TxnBuilderTypes.MultiAgentRawTransaction | TxnBuilderTypes.FeePayerRawTransaction
+  ): Promise<string | null> {
+    if (this._wallet && !("signMultiAgentTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Multi-agent & sponsored transactions are not supported by ${this.wallet?.name}`
+      ).message;
+    }
+    try {
+      this.doesWalletExist();
+      const response = await (this._wallet as any).signMultiAgentTransaction(
+        transaction
+      );
+      return response;
+    } catch (error: any) {
+      const errMsg =
+        typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignTransactionError(errMsg).message;
+    }
+  }
+
+  /**
   Event for when account has changed on the wallet
   @return the new account info
   @throws WalletAccountChangeError
@@ -391,7 +438,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
+  /**
   Event for when network has changed on the wallet
   @return the new network info
   @throws WalletNetworkChangeError

package/src/conversion.ts

@@ -0,0 +1,24 @@
+import { Network, AnyTransactionPayloadInstance } from "@aptos-labs/ts-sdk"
+import { BCS, TxnBuilderTypes } from "aptos"
+import { NetworkInfo } from "./types";
+import { NetworkName } from "./constants";
+
+// old => new
+export function convertNetwork(networkInfo: NetworkInfo | null): Network {
+    switch(networkInfo?.name.toLowerCase()) {
+        case "mainnet" as NetworkName:
+            return Network.MAINNET;
+        case "testnet" as NetworkName:
+            return Network.TESTNET;
+        case "devnet" as NetworkName:
+            return Network.DEVNET;
+        default:
+            throw new Error("Invalid network name")
+    }
+}
+
+// new => old
+export function convertToBCSPayload(payload: AnyTransactionPayloadInstance): TxnBuilderTypes.TransactionPayload {
+    const deserializer = new BCS.Deserializer(payload.bcsToBytes());
+    return TxnBuilderTypes.TransactionPayload.deserialize(deserializer);
+}

package/src/types.ts

@@ -1,6 +1,8 @@
-import { Types } from "aptos";
+import { TxnBuilderTypes, Types } from "aptos";
 import { NetworkName, WalletReadyState } from "./constants";
 
+export { TxnBuilderTypes, Types } from "aptos";
+export type { InputGenerateTransactionData } 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";
@@ -42,6 +44,9 @@ export interface PluginProvider {
     listener: (newAddress: AccountInfo) => Promise<void>
   ) => Promise<void>;
   onNetworkChange: OnNetworkChange;
+  signMultiAgentTransaction: (
+      rawTxn: TxnBuilderTypes.MultiAgentRawTransaction | TxnBuilderTypes.FeePayerRawTransaction
+  ) => Promise<string>;
 }
 
 export interface AdapterPluginEvents {