@aptos-labs/wallet-adapter-core 0.2.3 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @aptos-labs/wallet-adapter-core
 
+## 2.0.0
+
+### Major Changes
+
+- 06a2e0d: Add support to submit BCS transaction
+
+## 1.0.0
+
+### Major Changes
+
+- e10ea7b: Add ANS support
+
 ## 0.2.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Types } from 'aptos';
 import EventEmitter from 'eventemitter3';
+import { Types, TxnBuilderTypes } from 'aptos';
 
 declare enum WalletReadyState {
     /**
@@ -38,6 +38,7 @@ declare type AccountInfo = {
     address: string;
     publicKey: string | string[];
     minKeysRequired?: number;
+    ansName?: string | null;
 };
 interface AptosWalletErrorResult {
     code: number;
@@ -62,6 +63,7 @@ interface AdapterPluginEvents {
     onNetworkChange(callback: any): Promise<any>;
     onAccountChange(callback: any): Promise<any>;
 }
+declare type TransactionPayload = Types.TransactionPayload | TxnBuilderTypes.TransactionPayload;
 interface AdapterPluginProps<Name extends string = string> {
     name: WalletName<Name>;
     url: string;
@@ -71,7 +73,7 @@ interface AdapterPluginProps<Name extends string = string> {
     connect(): Promise<any>;
     disconnect: () => Promise<any>;
     network: () => Promise<any>;
-    signAndSubmitTransaction<T extends Types.TransactionPayload, V>(transaction: T, options?: V): Promise<{
+    signAndSubmitTransaction<T extends TransactionPayload, V>(transaction: T, options?: V): Promise<{
         hash: Types.HexEncodedBytes;
     }>;
     signMessage<T extends SignMessagePayload>(message: T): Promise<SignMessageResponse>;
@@ -122,6 +124,7 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private scopePollingDetectionStrategy;
     private doesWalletExist;
     private clearData;
+    private setAnsName;
     setWallet(wallet: Wallet | null): void;
     setAccount(account: AccountInfo | null): void;
     setNetwork(network: NetworkInfo | null): void;
@@ -169,14 +172,14 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     @return response from the wallet's signAndSubmitTransaction function
     @throws WalletSignAndSubmitMessageError
     */
-    signAndSubmitTransaction(transaction: Types.TransactionPayload): Promise<any>;
+    signAndSubmitTransaction(transaction: TransactionPayload): Promise<any>;
     /**
     Sign transaction (doesnt submit to chain).
     @param transaction
     @return response from the wallet's signTransaction function
     @throws WalletSignTransactionError
     */
-    signTransaction(transaction: Types.TransactionPayload): Promise<Uint8Array | null>;
+    signTransaction(transaction: TransactionPayload): Promise<Uint8Array | null>;
     /**
     Sign message (doesnt submit to chain).
     @param message
@@ -199,4 +202,4 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     signMessageAndVerify(message: SignMessagePayload): Promise<boolean>;
 }
 
-export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, PluginProvider, SignMessagePayload, SignMessageResponse, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState };
+export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, PluginProvider, SignMessagePayload, SignMessageResponse, TransactionPayload, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState };

package/dist/index.js

@@ -184,6 +184,26 @@ function removeLocalStorage() {
   localStorage.removeItem(LOCAL_STORAGE_ITEM_KEY);
 }
 
+// src/ans.ts
+var ChainIdToAnsContractAddressMap = {
+  "1": "mainnet",
+  "2": "testnet"
+};
+var getNameByAddress = async (chainId, address) => {
+  try {
+    if (!ChainIdToAnsContractAddressMap[chainId])
+      return null;
+    const response = await fetch(
+      `https://www.aptosnames.com/api/${ChainIdToAnsContractAddressMap[chainId]}/v1/name/${address}`
+    );
+    const data = await response.json();
+    return data.name;
+  } catch (e) {
+    console.log("error", e);
+    return null;
+  }
+};
+
 // src/WalletCore.ts
 var WalletCore = class extends import_eventemitter3.default {
   constructor(plugins) {
@@ -231,6 +251,16 @@ var WalletCore = class extends import_eventemitter3.default {
     this.setNetwork(null);
     removeLocalStorage();
   }
+  async setAnsName() {
+    var _a;
+    if (((_a = this._network) == null ? void 0 : _a.chainId) && this._account) {
+      const name = await getNameByAddress(
+        this._network.chainId,
+        this._account.address
+      );
+      this._account.ansName = name;
+    }
+  }
   setWallet(wallet) {
     this._wallet = wallet;
   }
@@ -291,6 +321,7 @@ var WalletCore = class extends import_eventemitter3.default {
       this.setAccount({ ...account });
       const network = await selectedWallet.network();
       this.setNetwork({ ...network });
+      await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
       this.emit("connect", account);
@@ -358,8 +389,9 @@ var WalletCore = class extends import_eventemitter3.default {
     var _a;
     try {
       this.doesWalletExist();
-      await ((_a = this._wallet) == null ? void 0 : _a.onAccountChange((data) => {
+      await ((_a = this._wallet) == null ? void 0 : _a.onAccountChange(async (data) => {
         this.setAccount({ ...data });
+        await this.setAnsName();
         this.emit("accountChange", this._account);
       }));
     } catch (error) {
@@ -371,8 +403,9 @@ var WalletCore = class extends import_eventemitter3.default {
     var _a;
     try {
       this.doesWalletExist();
-      await ((_a = this._wallet) == null ? void 0 : _a.onNetworkChange((data) => {
+      await ((_a = this._wallet) == null ? void 0 : _a.onNetworkChange(async (data) => {
         this.setNetwork({ ...data });
+        await this.setAnsName();
         this.emit("networkChange", this._network);
       }));
     } catch (error) {

package/dist/index.mjs

@@ -150,6 +150,26 @@ function removeLocalStorage() {
   localStorage.removeItem(LOCAL_STORAGE_ITEM_KEY);
 }
 
+// src/ans.ts
+var ChainIdToAnsContractAddressMap = {
+  "1": "mainnet",
+  "2": "testnet"
+};
+var getNameByAddress = async (chainId, address) => {
+  try {
+    if (!ChainIdToAnsContractAddressMap[chainId])
+      return null;
+    const response = await fetch(
+      `https://www.aptosnames.com/api/${ChainIdToAnsContractAddressMap[chainId]}/v1/name/${address}`
+    );
+    const data = await response.json();
+    return data.name;
+  } catch (e) {
+    console.log("error", e);
+    return null;
+  }
+};
+
 // src/WalletCore.ts
 var WalletCore = class extends EventEmitter {
   constructor(plugins) {
@@ -197,6 +217,16 @@ var WalletCore = class extends EventEmitter {
     this.setNetwork(null);
     removeLocalStorage();
   }
+  async setAnsName() {
+    var _a;
+    if (((_a = this._network) == null ? void 0 : _a.chainId) && this._account) {
+      const name = await getNameByAddress(
+        this._network.chainId,
+        this._account.address
+      );
+      this._account.ansName = name;
+    }
+  }
   setWallet(wallet) {
     this._wallet = wallet;
   }
@@ -257,6 +287,7 @@ var WalletCore = class extends EventEmitter {
       this.setAccount({ ...account });
       const network = await selectedWallet.network();
       this.setNetwork({ ...network });
+      await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
       this.emit("connect", account);
@@ -324,8 +355,9 @@ var WalletCore = class extends EventEmitter {
     var _a;
     try {
       this.doesWalletExist();
-      await ((_a = this._wallet) == null ? void 0 : _a.onAccountChange((data) => {
+      await ((_a = this._wallet) == null ? void 0 : _a.onAccountChange(async (data) => {
         this.setAccount({ ...data });
+        await this.setAnsName();
         this.emit("accountChange", this._account);
       }));
     } catch (error) {
@@ -337,8 +369,9 @@ var WalletCore = class extends EventEmitter {
     var _a;
     try {
       this.doesWalletExist();
-      await ((_a = this._wallet) == null ? void 0 : _a.onNetworkChange((data) => {
+      await ((_a = this._wallet) == null ? void 0 : _a.onNetworkChange(async (data) => {
         this.setNetwork({ ...data });
+        await this.setAnsName();
         this.emit("networkChange", this._network);
       }));
     } catch (error) {

package/package.json

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

package/src/WalletCore.ts

@@ -1,4 +1,4 @@
-import { HexString, Types } from "aptos";
+import { HexString } from "aptos";
 import EventEmitter from "eventemitter3";
 import nacl from "tweetnacl";
 import { Buffer } from "buffer";
@@ -29,12 +29,14 @@ import {
   Wallet,
   WalletInfo,
   WalletCoreEvents,
+  TransactionPayload,
 } from "./types";
 import {
   removeLocalStorage,
   setLocalStorage,
   scopePollingDetectionStrategy,
 } from "./utils";
+import { getNameByAddress } from "./ans";
 
 export class WalletCore extends EventEmitter<WalletCoreEvents> {
   private _wallets: Wallet[] = [];
@@ -95,6 +97,16 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     removeLocalStorage();
   }
 
+  private async setAnsName() {
+    if (this._network?.chainId && this._account) {
+      const name = await getNameByAddress(
+        this._network.chainId,
+        this._account.address
+      );
+      this._account.ansName = name;
+    }
+  }
+
   setWallet(wallet: Wallet | null) {
     this._wallet = wallet;
   }
@@ -192,6 +204,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       this.setAccount({ ...account });
       const network = await selectedWallet.network();
       this.setNetwork({ ...network });
+      await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
       this.emit("connect", account);
@@ -227,7 +240,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   @throws WalletSignAndSubmitMessageError
   */
   async signAndSubmitTransaction(
-    transaction: Types.TransactionPayload
+    transaction: TransactionPayload
   ): Promise<any> {
     try {
       this.doesWalletExist();
@@ -249,7 +262,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   @throws WalletSignTransactionError
   */
   async signTransaction(
-    transaction: Types.TransactionPayload
+    transaction: TransactionPayload
   ): Promise<Uint8Array | null> {
     if (this._wallet && !("signTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -297,8 +310,9 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   async onAccountChange(): Promise<void> {
     try {
       this.doesWalletExist();
-      await this._wallet?.onAccountChange((data: AccountInfo) => {
+      await this._wallet?.onAccountChange(async (data: AccountInfo) => {
         this.setAccount({ ...data });
+        await this.setAnsName();
         this.emit("accountChange", this._account);
       });
     } catch (error: any) {
@@ -316,8 +330,9 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   async onNetworkChange(): Promise<void> {
     try {
       this.doesWalletExist();
-      await this._wallet?.onNetworkChange((data: NetworkInfo) => {
+      await this._wallet?.onNetworkChange(async (data: NetworkInfo) => {
         this.setNetwork({ ...data });
+        await this.setAnsName();
         this.emit("networkChange", this._network);
       });
     } catch (error: any) {

package/src/__tests__/WalletCore.test.ts

@@ -1,4 +1,5 @@
 import { AptosAccount } from "aptos";
+import { getNameByAddress } from "../ans";
 import {
   SignMessagePayload,
   SignMessageResponse,
@@ -104,3 +105,13 @@ describe("signMessageAndVerify", () => {
     expect(verified).toBeFalsy();
   });
 });
+
+describe("ans", () => {
+  it("should fetch the correct name", async () => {
+    const name = await getNameByAddress(
+      "2",
+      "0x54fac6e5d52953c75e749a8ad260bc450cad0b8ed2f06c1e98707879e13956d1"
+    );
+    expect(name).toBe("adapter");
+  });
+});

package/src/ans.ts

@@ -0,0 +1,21 @@
+const ChainIdToAnsContractAddressMap: Record<string, string> = {
+  "1": "mainnet", // mainnet
+  "2": "testnet", // testnet
+};
+
+export const getNameByAddress = async (
+  chainId: string,
+  address: string
+): Promise<string | null> => {
+  try {
+    if (!ChainIdToAnsContractAddressMap[chainId]) return null;
+    const response = await fetch(
+      `https://www.aptosnames.com/api/${ChainIdToAnsContractAddressMap[chainId]}/v1/name/${address}`
+    );
+    const data = await response.json();
+    return data.name;
+  } catch (e) {
+    console.log("error", e);
+    return null;
+  }
+};

package/src/types.ts

@@ -1,4 +1,4 @@
-import { Types } from "aptos";
+import { TxnBuilderTypes, Types } from "aptos";
 import { NetworkName, WalletReadyState } from "./constants";
 
 // WalletName is a nominal type that wallet adapters should use, e.g. `'MyCryptoWallet' as WalletName<'MyCryptoWallet'>`
@@ -14,7 +14,8 @@ export type NetworkInfo = {
 export type AccountInfo = {
   address: string;
   publicKey: string | string[];
-  minKeysRequired?: number
+  minKeysRequired?: number;
+  ansName?: string | null;
 };
 
 export interface AptosWalletErrorResult {
@@ -22,7 +23,6 @@ export interface AptosWalletErrorResult {
   name: string;
   message: string;
 }
-
 export interface PluginProvider {
   connect: () => Promise<AccountInfo>;
   account: () => Promise<AccountInfo>;
@@ -46,16 +46,20 @@ export interface AdapterPluginEvents {
   onAccountChange(callback: any): Promise<any>;
 }
 
+export type TransactionPayload =
+  | Types.TransactionPayload
+  | TxnBuilderTypes.TransactionPayload;
+
 export interface AdapterPluginProps<Name extends string = string> {
   name: WalletName<Name>;
   url: string;
   icon: `data:image/${"svg+xml" | "webp" | "png" | "gif"};base64,${string}`;
-  providerName?: string
+  providerName?: string;
   provider: any;
   connect(): Promise<any>;
   disconnect: () => Promise<any>;
   network: () => Promise<any>;
-  signAndSubmitTransaction<T extends Types.TransactionPayload, V>(
+  signAndSubmitTransaction<T extends TransactionPayload, V>(
     transaction: T,
     options?: V
   ): Promise<{ hash: Types.HexEncodedBytes }>;