@aeternity/aepp-sdk 12.0.0 → 12.1.0

package/src/AeSdkWallet.ts

@@ -1,75 +1,85 @@
-import { v4 as uuid } from '@aeternity/uuid'
-import AeSdk from './AeSdk'
-import { Account } from './AeSdkBase'
-import verifyTransaction from './tx/validator'
-import RpcClient from './aepp-wallet-communication/rpc/RpcClient'
+import { v4 as uuid } from '@aeternity/uuid';
+import AeSdk from './AeSdk';
+import { Account } from './AeSdkBase';
+import verifyTransaction from './tx/validator';
+import RpcClient from './aepp-wallet-communication/rpc/RpcClient';
 import {
   METHODS, RPC_STATUS, SUBSCRIPTION_TYPES, WALLET_TYPE,
   RpcBroadcastError, RpcInvalidTransactionError,
-  RpcNotAuthorizeError, RpcPermissionDenyError, RpcUnsupportedProtocolError
-} from './aepp-wallet-communication/schema'
-import { UnknownRpcClientError } from './utils/errors'
-import AccountBase from './account/Base'
-import BrowserConnection from './aepp-wallet-communication/connection/Browser'
+  RpcNotAuthorizeError, RpcPermissionDenyError, RpcUnsupportedProtocolError,
+} from './aepp-wallet-communication/schema';
+import { InternalError, UnknownRpcClientError } from './utils/errors';
+import AccountBase from './account/Base';
+import BrowserConnection from './aepp-wallet-communication/connection/Browser';
 import {
   Accounts,
   AeppApi,
   Network,
   RPC_VERSION,
   WalletApi,
-  WalletInfo
-} from './aepp-wallet-communication/rpc/types'
-import { EncodedData } from './utils/encoder'
-import jsonBig from './utils/json-big'
+  WalletInfo,
+} from './aepp-wallet-communication/rpc/types';
+import { Encoded } from './utils/encoder';
+import jsonBig from './utils/json-big';
 
-type RpcClientWallet = RpcClient<AeppApi, WalletApi>
+type RpcClientWallet = RpcClient<AeppApi, WalletApi>;
 
 type OnConnection = (
   clientId: string, params: Omit<Parameters<WalletApi[METHODS.connect]>[0], 'version'>, origin: string
-) => void
+) => void;
 
 type OnSubscription = (
   clientId: string, params: Parameters<WalletApi[METHODS.subscribeAddress]>[0], origin: string
-) => void
+) => void;
 
 type OnSign = (
   clientId: string, params: Parameters<WalletApi[METHODS.sign]>[0], origin: string
-) => Promise<{ tx?: EncodedData<'tx'>, onAccount?: Account } | undefined> | Promise<void>
+) => Promise<{ tx?: Encoded.Transaction; onAccount?: Account } | undefined> | Promise<void>;
 
 type OnDisconnect = (
   clientId: string, params: Parameters<WalletApi[METHODS.closeConnection]>[0]
-) => void
+) => void;
 
 type OnAskAccounts = (
   clientId: string, params: undefined, origin: string
-) => void
+) => void;
 
 type OnMessageSign = (
   clientId: string, params: Parameters<WalletApi[METHODS.signMessage]>[0], origin: string
-) => Promise<{ onAccount?: Account } | undefined> | Promise<void>
+) => Promise<{ onAccount?: Account } | undefined> | Promise<void>;
 
 interface RpcClientsInfo {
-  id: string
-  status: RPC_STATUS
-  connectNode: boolean
-  addressSubscription: Set<'connected' | 'current'>
-  rpc: RpcClientWallet
+  id: string;
+  status: RPC_STATUS;
+  connectNode: boolean;
+  addressSubscription: Set<'connected' | 'current'>;
+  rpc: RpcClientWallet;
 }
 
 /**
  * Contain functionality for aepp interaction and managing multiple aepps
+ * @category aepp wallet communication
  */
 export default class AeSdkWallet extends AeSdk {
-  id: string
-  _type: WALLET_TYPE
-  name: string
-  _clients: Map<string, RpcClientsInfo>
-  onConnection: OnConnection
-  onSubscription: OnSubscription
-  onSign: OnSign
-  onDisconnect: OnDisconnect
-  onAskAccounts: OnAskAccounts
-  onMessageSign: OnMessageSign
+  id: string;
+
+  _type: WALLET_TYPE;
+
+  name: string;
+
+  _clients: Map<string, RpcClientsInfo>;
+
+  onConnection: OnConnection;
+
+  onSubscription: OnSubscription;
+
+  onSign: OnSign;
+
+  onDisconnect: OnDisconnect;
+
+  onAskAccounts: OnAskAccounts;
+
+  onMessageSign: OnMessageSign;
 
   /**
    * @param options - Options
@@ -83,7 +93,7 @@ export default class AeSdkWallet extends AeSdk {
    * @param options.onMessageSign - Call-back function for incoming AEPP sign message request
    * @param options.onDisconnect - Call-back function for disconnect event
    */
-  constructor ({
+  constructor({
     name,
     id,
     type,
@@ -95,98 +105,98 @@ export default class AeSdkWallet extends AeSdk {
     onMessageSign,
     ...options
   }: {
-    id: string
-    type: WALLET_TYPE
-    name: string
-    onConnection: OnConnection
-    onSubscription: OnSubscription
-    onSign: OnSign
-    onDisconnect: OnDisconnect
-    onAskAccounts: OnAskAccounts
-    onMessageSign: OnMessageSign
+    id: string;
+    type: WALLET_TYPE;
+    name: string;
+    onConnection: OnConnection;
+    onSubscription: OnSubscription;
+    onSign: OnSign;
+    onDisconnect: OnDisconnect;
+    onAskAccounts: OnAskAccounts;
+    onMessageSign: OnMessageSign;
   } & ConstructorParameters<typeof AeSdk>[0]) {
-    super(options)
-    this.onConnection = onConnection
-    this.onSubscription = onSubscription
-    this.onSign = onSign
-    this.onDisconnect = onDisconnect
-    this.onAskAccounts = onAskAccounts
-    this.onMessageSign = onMessageSign
-    this._clients = new Map()
-    this.name = name
-    this.id = id
-    this._type = type
+    super(options);
+    this.onConnection = onConnection;
+    this.onSubscription = onSubscription;
+    this.onSign = onSign;
+    this.onDisconnect = onDisconnect;
+    this.onAskAccounts = onAskAccounts;
+    this.onMessageSign = onMessageSign;
+    this._clients = new Map();
+    this.name = name;
+    this.id = id;
+    this._type = type;
   }
 
-  _pushAccountsToApps (): void {
+  _pushAccountsToApps(): void {
     Array.from(this._clients.keys())
-      .filter(clientId => this._isRpcClientSubscribed(clientId))
-      .map(clientId => this._getClient(clientId).rpc)
-      .forEach(client => client.notify(METHODS.updateAddress, this.getAccounts()))
+      .filter((clientId) => this._isRpcClientSubscribed(clientId))
+      .map((clientId) => this._getClient(clientId).rpc)
+      .forEach((client) => client.notify(METHODS.updateAddress, this.getAccounts()));
   }
 
-  selectAccount (address: EncodedData<'ak'>): void {
-    super.selectAccount(address)
-    this._pushAccountsToApps()
+  selectAccount(address: Encoded.AccountAddress): void {
+    super.selectAccount(address);
+    this._pushAccountsToApps();
   }
 
-  async addAccount (
+  async addAccount(
     account: AccountBase,
-    options?: Parameters<AeSdk['addAccount']>[1]
+    options?: Parameters<AeSdk['addAccount']>[1],
   ): Promise<void> {
-    await super.addAccount(account, options)
-    this._pushAccountsToApps()
+    await super.addAccount(account, options);
+    this._pushAccountsToApps();
   }
 
-  _getNode (): { node: Network['node'] } {
-    this.ensureNodeConnected()
-    return { node: { url: this.api.url, name: this.selectedNodeName } }
+  _getNode(): { node: Network['node'] } {
+    this.ensureNodeConnected();
+    return { node: { url: this.api.url, name: this.selectedNodeName } };
   }
 
-  async selectNode (name: string): Promise<void> {
-    super.selectNode(name)
-    const networkId = await this.getNetworkId()
+  async selectNode(name: string): Promise<void> {
+    super.selectNode(name);
+    const networkId = await this.getNetworkId();
     Array.from(this._clients.keys())
-      .filter(clientId => this._isRpcClientConnected(clientId))
-      .map(clientId => this._getClient(clientId))
-      .forEach(client => {
+      .filter((clientId) => this._isRpcClientConnected(clientId))
+      .map((clientId) => this._getClient(clientId))
+      .forEach((client) => {
         client.rpc.notify(METHODS.updateNetwork, {
           networkId,
-          ...client.connectNode && this._getNode()
-        })
-      })
+          ...client.connectNode && this._getNode(),
+        });
+      });
   }
 
-  _getClient (clientId: string): RpcClientsInfo {
-    const client = this._clients.get(clientId)
-    if (client == null) throw new UnknownRpcClientError(clientId)
-    return client
+  _getClient(clientId: string): RpcClientsInfo {
+    const client = this._clients.get(clientId);
+    if (client == null) throw new UnknownRpcClientError(clientId);
+    return client;
   }
 
-  _isRpcClientSubscribed (clientId: string): boolean {
-    return this._isRpcClientConnected(clientId) &&
-      this._getClient(clientId).addressSubscription.size !== 0
+  _isRpcClientSubscribed(clientId: string): boolean {
+    return this._isRpcClientConnected(clientId)
+      && this._getClient(clientId).addressSubscription.size !== 0;
   }
 
-  _isRpcClientConnected (clientId: string): boolean {
-    return RPC_STATUS.CONNECTED === this._getClient(clientId).status &&
-      this._getClient(clientId).rpc.connection.isConnected()
+  _isRpcClientConnected(clientId: string): boolean {
+    return RPC_STATUS.CONNECTED === this._getClient(clientId).status
+      && this._getClient(clientId).rpc.connection.isConnected();
   }
 
-  _disconnectRpcClient (clientId: string): void {
-    const client = this._getClient(clientId)
-    client.rpc.connection.disconnect()
-    client.status = RPC_STATUS.DISCONNECTED
-    client.addressSubscription = new Set()
+  _disconnectRpcClient(clientId: string): void {
+    const client = this._getClient(clientId);
+    client.rpc.connection.disconnect();
+    client.status = RPC_STATUS.DISCONNECTED;
+    client.addressSubscription = new Set();
   }
 
   /**
    * Remove specific RpcClient by ID
    * @param id - Client ID
    */
-  removeRpcClient (id: string): void {
-    this._disconnectRpcClient(id)
-    this._clients.delete(id)
+  removeRpcClient(id: string): void {
+    this._disconnectRpcClient(id);
+    this._clients.delete(id);
   }
 
   /**
@@ -194,11 +204,11 @@ export default class AeSdkWallet extends AeSdk {
    * @param clientConnection - AEPP connection object
    * @returns Client ID
    */
-  addRpcClient (clientConnection: BrowserConnection): string {
+  addRpcClient(clientConnection: BrowserConnection): string {
     // @TODO  detect if aepp has some history based on origin????
     // if yes use this instance for connection
-    const id = uuid()
-    let disconnectParams: any
+    const id = uuid();
+    let disconnectParams: any;
     const client: RpcClientsInfo = {
       id,
       status: RPC_STATUS.WAITING_FOR_CONNECTION_REQUEST,
@@ -207,126 +217,132 @@ export default class AeSdkWallet extends AeSdk {
       rpc: new RpcClient<AeppApi, WalletApi>(
         clientConnection,
         () => {
-          this._clients.delete(id)
-          this.onDisconnect(id, disconnectParams) // also related info
-        }, {
+          this._clients.delete(id);
+          this.onDisconnect(id, disconnectParams); // also related info
+        },
+        {
           [METHODS.closeConnection]: (params) => {
-            disconnectParams = params
-            this._disconnectRpcClient(id)
+            disconnectParams = params;
+            this._disconnectRpcClient(id);
           },
           // Store client info and prepare two fn for each client `connect` and `denyConnection`
           // which automatically prepare and send response for that client
-          [METHODS.connect]: async ({ name, version, icons, connectNode }, origin) => {
-            if (version !== RPC_VERSION) throw new RpcUnsupportedProtocolError()
+          [METHODS.connect]: async ({
+            name, version, icons, connectNode,
+          }, origin) => {
+            if (version !== RPC_VERSION) throw new RpcUnsupportedProtocolError();
 
-            await this.onConnection(id, { name, icons, connectNode }, origin)
-            client.status = RPC_STATUS.CONNECTED
-            client.connectNode = connectNode
+            await this.onConnection(id, { name, icons, connectNode }, origin);
+            client.status = RPC_STATUS.CONNECTED;
+            client.connectNode = connectNode;
             return {
               ...await this.getWalletInfo(),
-              ...connectNode && this._getNode()
-            }
+              ...connectNode && this._getNode(),
+            };
           },
           [METHODS.subscribeAddress]: async ({ type, value }, origin) => {
-            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError()
+            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError();
 
-            await this.onSubscription(id, { type, value }, origin)
+            await this.onSubscription(id, { type, value }, origin);
 
             switch (type) {
               case SUBSCRIPTION_TYPES.subscribe:
-                client.addressSubscription.add(value)
-                break
+                client.addressSubscription.add(value);
+                break;
               case SUBSCRIPTION_TYPES.unsubscribe:
-                client.addressSubscription.delete(value)
-                break
+                client.addressSubscription.delete(value);
+                break;
+              default:
+                throw new InternalError(`Unknown subscription type: ${type}`);
             }
 
             return {
               subscription: Array.from(client.addressSubscription),
-              address: this.getAccounts()
-            }
+              address: this.getAccounts(),
+            };
           },
           [METHODS.address]: async (params, origin) => {
-            if (!this._isRpcClientSubscribed(id)) throw new RpcNotAuthorizeError()
-            await this.onAskAccounts(id, params, origin)
-            return this.addresses()
+            if (!this._isRpcClientSubscribed(id)) throw new RpcNotAuthorizeError();
+            await this.onAskAccounts(id, params, origin);
+            return this.addresses();
           },
           [METHODS.sign]: async ({ tx, onAccount, returnSigned }, origin) => {
-            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError()
-            onAccount ??= await this.address()
+            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError();
+            onAccount ??= await this.address();
             if (!this.addresses().includes(onAccount)) {
-              throw new RpcPermissionDenyError(onAccount)
+              throw new RpcPermissionDenyError(onAccount);
             }
 
-            const overrides = await this.onSign(id, { tx, returnSigned, onAccount }, origin)
-            onAccount = overrides?.onAccount ?? onAccount
-            tx = overrides?.tx ?? tx
+            const overrides = await this.onSign(id, { tx, returnSigned, onAccount }, origin);
+            onAccount = overrides?.onAccount ?? onAccount;
+            tx = overrides?.tx ?? tx;
             if (returnSigned) {
-              return { signedTransaction: await this.signTransaction(tx, { onAccount }) }
+              return { signedTransaction: await this.signTransaction(tx, { onAccount }) };
             }
             try {
               return jsonBig.parse(jsonBig.stringify({
-                transactionHash: await this.send(tx, { onAccount, verify: false })
-              }))
+                transactionHash: await this.send(tx, { onAccount, verify: false }),
+              }));
             } catch (error) {
-              const validation = await verifyTransaction(tx, this.api)
-              if (validation.length > 0) throw new RpcInvalidTransactionError(validation)
-              throw new RpcBroadcastError(error.message)
+              const validation = await verifyTransaction(tx, this.api);
+              if (validation.length > 0) throw new RpcInvalidTransactionError(validation);
+              throw new RpcBroadcastError(error.message);
             }
           },
           [METHODS.signMessage]: async ({ message, onAccount }, origin) => {
-            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError()
-            onAccount ??= await this.address()
+            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError();
+            onAccount ??= await this.address();
             if (!this.addresses().includes(onAccount)) {
-              throw new RpcPermissionDenyError(onAccount)
+              throw new RpcPermissionDenyError(onAccount);
             }
 
-            const overrides = await this.onMessageSign(id, { message, onAccount }, origin)
-            onAccount = overrides?.onAccount ?? onAccount
+            const overrides = await this.onMessageSign(id, { message, onAccount }, origin);
+            onAccount = overrides?.onAccount ?? onAccount;
             return {
               // TODO: fix signMessage return type
               signature: await this.signMessage(message, { onAccount, returnHex: true }) as
-                unknown as string
-            }
-          }
-        })
-    }
-    this._clients.set(id, client)
-    return id
+                unknown as string,
+            };
+          },
+        },
+      ),
+    };
+    this._clients.set(id, client);
+    return id;
   }
 
   /**
    * Send shareWalletInfo message to notify AEPP about wallet
    * @param clientId - ID of RPC client send message to
    */
-  async shareWalletInfo (clientId: string): Promise<void> {
-    this._getClient(clientId).rpc.notify(METHODS.readyToConnect, await this.getWalletInfo())
+  async shareWalletInfo(clientId: string): Promise<void> {
+    this._getClient(clientId).rpc.notify(METHODS.readyToConnect, await this.getWalletInfo());
   }
 
   /**
    * Get Wallet info object
    * @returns Object with wallet information
    */
-  async getWalletInfo (): Promise<WalletInfo> {
+  async getWalletInfo(): Promise<WalletInfo> {
     return {
       id: this.id,
       name: this.name,
       networkId: await this.getNetworkId(),
       origin: window.location.origin,
-      type: this._type
-    }
+      type: this._type,
+    };
   }
 
   /**
    * Get Wallet accounts
    * @returns Object with accounts information (\{ connected: Object, current: Object \})
    */
-  getAccounts (): Accounts {
+  getAccounts(): Accounts {
     return {
       current: this.selectedAddress != null ? { [this.selectedAddress]: {} } : {},
       connected: this.addresses()
         .filter((a) => a !== this.selectedAddress)
-        .reduce((acc, a) => ({ ...acc, [a]: {} }), {})
-    }
+        .reduce((acc, a) => ({ ...acc, [a]: {} }), {}),
+    };
   }
 }