fix: improve error codes

Author: AdriaCarrera

packages/dapp/core/src/clients/base/base.client.ts

@@ -1,6 +1,6 @@
 import { MsgAddLAK, MsgSignWithFAK, MsgSignIn, Permissions, MsgSignInQueryParams, Codec } from "@one-click-connect/core";
 import { BaseDAppClientConfig } from "./base.client.config";
-import { Account } from "../../common";
+import { Account, ErrorCodes } from "../../common";
 import { AccountStore, Callbacks, PendingTransactionStore, Provider } from "../../common";
 
 export abstract class BaseDAppClient<Transaction, TransactionResult, Config extends BaseDAppClientConfig = BaseDAppClientConfig> {
@@ -21,18 +21,18 @@ export abstract class BaseDAppClient<Transaction, TransactionResult, Config exte
     }
 
     get accountId() {
-        if (!this.connected) throw new Error("Not connected");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
         return this.account!.accountId;
     }
 
     get accessKey() {
-        if (!this.connected) throw new Error("Not connected");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
         return this.account!.accessKey;
     }
 
     get publicKey() {
-        if (!this.connected) throw new Error("Not connected");
-        if (!this.accessKey) throw new Error("Access key undefined");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
+        if (!this.accessKey) throw new Error(ErrorCodes.NO_ACCESS_KEY);
         return this.provider.derivePublicKey(this.accessKey);
     }
 
@@ -55,7 +55,7 @@ export abstract class BaseDAppClient<Transaction, TransactionResult, Config exte
             account = await this.accountStore.get();
         }
         if (!account) {
-            throw new Error("Could not sign in using One Click Connect, no msgSignIn detected and no account stored");
+            throw new Error(ErrorCodes.COULD_NOT_CONNECT);
         }
         this.account = account;
         if (executePendingTransactions) await this.executePendingTransactions();
@@ -68,7 +68,7 @@ export abstract class BaseDAppClient<Transaction, TransactionResult, Config exte
      * @returns The transaction result or void if executed a callback.
      */
     async signAndSendTransaction(transaction: Transaction): Promise<TransactionResult | void> {
-        if (!this.connected) throw new Error("Not connected");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
         const hasAccessKey = this.account!.accessKey !== undefined;
         const canExecute = await this.provider.canExecute(this.permissions, transaction);
         const hasPermissions =
@@ -100,20 +100,20 @@ export abstract class BaseDAppClient<Transaction, TransactionResult, Config exte
      * @returns A promise that resolves to the signed message as a string.
      */
     async signMessage(message: string): Promise<string> {
-        if (!this.connected) throw new Error("Not connected");
-        if (!this.accessKey) throw new Error("Access key undefined");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
+        if (!this.accessKey) throw new Error(ErrorCodes.NO_ACCESS_KEY);
         return this.provider.signMessage(this.accessKey, message);
     }
 
     /**
      * Executes any pending transactions stored in the pending transaction store.
      */
     async executePendingTransactions(): Promise<void> {
-        if (!this.connected) throw new Error("Not connected");
+        if (!this.connected) throw new Error(ErrorCodes.NOT_CONNECTED);
         if (!this.pendingTransactionStore) return;
         let pendingTransaction: Transaction | null = await this.pendingTransactionStore.pop(this.account!.accountId);
         while (pendingTransaction) {
-            if (!this.account?.accessKey) throw new Error("Access key undefined");
+            if (!this.account?.accessKey) throw new Error(ErrorCodes.NO_ACCESS_KEY);
             // NOTE: We wait for certain seconds to make sure transaction gets included in the blockchain
             await new Promise((resolve) => setTimeout(resolve, 1500));
             await this.signAndSendTransaction(pendingTransaction);

packages/dapp/core/src/common/errors/error-codes.ts

@@ -0,0 +1,5 @@
+export enum ErrorCodes {
+    NOT_CONNECTED = "Client is not connected",
+    NO_ACCESS_KEY = "No access key provided or stored",
+    COULD_NOT_CONNECT = "Could not sign in using One Click Connect, no msgSignIn detected and no account stored",
+}

packages/dapp/core/src/common/errors/index.ts

@@ -1,2 +1 @@
-export * from "./repository.errors";
-export * from "./service.errors";
+export * from "./error-codes";

packages/dapp/core/src/common/errors/repository.errors.ts

@@ -0,0 +1,4 @@
+export enum ErrorCodes {
+    METHOD_NOT_IMPLEMENTED = "Method not implemented",
+    UNREACHABLE = "This code should not be reachable",
+}

packages/dapp/core/src/common/errors/service.errors.ts

@@ -0,0 +1 @@
+export * from "./error-codes";

packages/dapp/wallet-selector/src/errors/error-codes.ts

@@ -1 +1,2 @@
+export * from "./errors";
 export { setupOneClickConnect } from "./setup";

packages/dapp/wallet-selector/src/errors/index.ts

@@ -12,6 +12,7 @@ import { SignAndSendTransactionParams, SignAndSendTransactionsParams } from "./t
 import { FunctionCallPermission } from "near-api-js/lib/transaction";
 import { DAppClient } from "@one-click-connect/dapp-sdk";
 import { createAction } from "@near-wallet-selector/wallet-utils";
+import { ErrorCodes } from "./errors";
 
 export class Wallet implements Omit<InstantLinkWallet, "id" | "type" | "metadata"> {
     constructor(
@@ -49,7 +50,7 @@ export class Wallet implements Omit<InstantLinkWallet, "id" | "type" | "metadata
      * @inheritDoc
      */
     verifyOwner = (_: VerifyOwnerParams): Promise<VerifiedOwner | void> => {
-        throw new Error("Method not implemented.");
+        throw new Error(ErrorCodes.METHOD_NOT_IMPLEMENTED);
     };
 
     /**
@@ -62,7 +63,7 @@ export class Wallet implements Omit<InstantLinkWallet, "id" | "type" | "metadata
             receiverId: params.receiverId ?? this.permissions.receiverId,
             actions,
         });
-        if (!result) throw new Error("unreachable code");
+        if (!result) throw new Error(ErrorCodes.UNREACHABLE);
         return result;
     };
 

packages/dapp/wallet-selector/src/index.ts

@@ -58,7 +58,7 @@ export class WalletClient<Transaction, Config extends WalletClientConfig = Walle
                 },
             };
         } catch (_) {}
-        throw new Error("Invalid URL");
+        throw new Error(ClientErrorCodes.INVALID_URL);
     }
 
     /**