fix(kwil): separate authentication errors from call errors

There was a minor bug where, when a call failed in private mode, the call error was thrown as part of the authentication error stack, regardless of whether the call failure was related to authentication. This commit separates the logic so that only authentication errors are thrown in the authentication stack.
kwilteam · Oct 16, 2024 · a43ca86 · a43ca86
1 parent d7c7bb7
commit a43ca86
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 32 deletions.
diff --git a/src/auth/auth.ts b/src/auth/auth.ts
@@ -103,7 +103,7 @@ export class Auth<T extends EnvironmentType> {
 
     // Check if challenge.data is undefined
     if (!msgChallenge) {
-      throw new Error('Challenge data is undefined. Unable to authenticate in private mode.');
+      throw new Error('Challenge data is undefined. Something went wrong.');
     }
 
     // Check if multiple inputs were provided

diff --git a/src/client/node/nodeKwil.ts b/src/client/node/nodeKwil.ts
@@ -4,10 +4,10 @@ import { ActionInput, Entries, ActionBodyNode } from '../../core/action';
 import { ActionBuilder } from '../../core/builders';
 import { AuthenticationMode, BytesEncodingStatus, EnvironmentType } from '../../core/enums';
 import { KwilSigner } from '../../core/kwilSigner';
-import { BaseMessage, CallClientResponse, Message, MsgReceipt } from '../../core/message';
+import { BaseMessage, Message, MsgReceipt } from '../../core/message';
 import { GenericResponse } from '../../core/resreq';
 import { Kwil } from '../kwil';
-import { Signature } from '../../core/signature';
+import { AuthBody, Signature } from '../../core/signature';
 
 export class NodeKwil extends Kwil<EnvironmentType.NODE> {
   private autoAuthenticate: boolean;
@@ -65,10 +65,17 @@ export class NodeKwil extends Kwil<EnvironmentType.NODE> {
       }
       return response;
     } else if (this.authMode === AuthenticationMode.PRIVATE) {
-      return await this.handleAuthenticatePrivate(actionBody, kwilSigner)
+      const authBody = await this.handleAuthenticatePrivate(actionBody, kwilSigner)
+      const message = await this.buildMessage(
+        actionBody,
+        kwilSigner,
+        authBody.challenge,
+        authBody.signature
+      );
+      return await this.callClient(message);
     }
 
-    throw new Error("Unexpected authentication mode or action body type.");
+    throw new Error("Unexpected authentication mode. If you hit this error, please report it to the Kwil team.");
   }
 
   /**
@@ -222,7 +229,7 @@ export class NodeKwil extends Kwil<EnvironmentType.NODE> {
   private async handleAuthenticatePrivate(
     actionBody: ActionBodyNode,
     kwilSigner?: KwilSigner
-  ): Promise<CallClientResponse<MsgReceipt>> {
+  ): Promise<AuthBody> {
     if (this.autoAuthenticate) {
       try {
         // PRIVATE MODE AUTHENTICATION
@@ -231,18 +238,10 @@ export class NodeKwil extends Kwil<EnvironmentType.NODE> {
             throw new Error('Private mode authentication requires a KwilSigner.');
           }
 
-          const authPrivateModeRes = await this.auth.authenticatePrivateMode(
+          return await this.auth.authenticatePrivateMode(
             actionBody,
             kwilSigner
           );
-          const message = await this.buildMessage(
-            actionBody,
-            kwilSigner,
-            authPrivateModeRes.challenge,
-            authPrivateModeRes.signature
-          );
-
-          return await this.callClient(message);
         }
       } catch (error) {
         throw new Error(`Authentication failed: ${error}`);

diff --git a/src/client/web/webKwil.ts b/src/client/web/webKwil.ts
@@ -4,9 +4,9 @@ import { ActionBody, ActionBodyNode, ActionInput, Entries } from '../../core/act
 import { ActionBuilder } from '../../core/builders';
 import { AuthenticationMode, BytesEncodingStatus, EnvironmentType } from '../../core/enums';
 import { KwilSigner } from '../../core/kwilSigner';
-import { BaseMessage, CallClientResponse, Message, MsgReceipt } from '../../core/message';
+import { BaseMessage, Message, MsgReceipt } from '../../core/message';
 import { GenericResponse } from '../../core/resreq';
-import { Signature } from '../../core/signature';
+import { AuthBody, Signature } from '../../core/signature';
 import { Kwil } from '../kwil';
 
 export class WebKwil extends Kwil<EnvironmentType.BROWSER> {
@@ -60,10 +60,17 @@ export class WebKwil extends Kwil<EnvironmentType.BROWSER> {
       }
       return response;
     } else if (this.authMode === AuthenticationMode.PRIVATE) {
-      return await this.handleAuthenticatePrivate(actionBody, kwilSigner);
+      const authBody = await this.handleAuthenticatePrivate(actionBody, kwilSigner);
+      const message = await this.buildMessage(
+        actionBody,
+        kwilSigner,
+        authBody.challenge,
+        authBody.signature
+      );
+      return await this.callClient(message);
     }
 
-    throw new Error("Unexpected authentication mode or action body type."); 
+    throw new Error("Unexpected authentication mode. If you hit this error, please report it to the Kwil team.");
   }
 
   /**
@@ -174,7 +181,7 @@ export class WebKwil extends Kwil<EnvironmentType.BROWSER> {
           }
           await this.auth.authenticateKGW(kwilSigner);
       } catch (error) {
-        console.error('Authentication failed:', error);
+        throw  new Error(`Authentication failed: ${error}`)
       }
     }
   }
@@ -191,7 +198,7 @@ export class WebKwil extends Kwil<EnvironmentType.BROWSER> {
   private async handleAuthenticatePrivate(
     actionBody: ActionBodyNode,
     kwilSigner?: KwilSigner
-  ): Promise<CallClientResponse<MsgReceipt>> {
+  ): Promise<AuthBody> {
     if (this.autoAuthenticate) {
       try {
         // PRIVATE MODE AUTHENTICATION
@@ -200,22 +207,13 @@ export class WebKwil extends Kwil<EnvironmentType.BROWSER> {
             throw new Error('Private mode authentication requires a KwilSigner.');
           }
 
-          const authPrivateModeRes = await this.auth.authenticatePrivateMode(
+          return await this.auth.authenticatePrivateMode(
             actionBody,
             kwilSigner
           );
-          const message = await this.buildMessage(
-            actionBody,
-            kwilSigner,
-            authPrivateModeRes.challenge,
-            authPrivateModeRes.signature
-          );
-
-          return await this.callClient(message);
         }
       } catch (error) {
-        console.error('Authentication failed:', error);
-        throw new Error('Authentication failed')
+        throw  new Error(`Authentication failed: ${error}`)
       }
     }