Merge pull request #59 from picketapi/devstein/better-error-messages

Throw Errors on Missing Params for Creating Signing Message

Author: devstein

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@picketapi/picket-js",
-  "version": "0.0.99",
+  "version": "0.0.100",
   "description": "Javascript client for the Picket API",
   "main": "dist/index.mjs",
   "types": "dist/index.d.ts",

package.json

@@ -179,6 +179,18 @@ const getErrorMessage = ({
     if (err.msg.toLowerCase().includes("invalid project key")) {
       return "Invalid API key. Copy your project's publishable key from your Picket dashboard: https://picketapi.com/dashboard";
     }
+    if (
+      err.msg
+        .toLowerCase()
+        .includes("required to create a SIWE signing message")
+    ) {
+      return "Missing required context parameters for SIWE";
+    }
+    if (
+      err.msg.toLowerCase().includes("required to create a signing message")
+    ) {
+      return "Missing required parameters to create a signing message";
+    }
     // @ts-ignore TS isn't respecting "msg" in err
     if (err.msg.toLowerCase().includes("invalid signature")) {
       return "Signature expired. Please try again.";

src/connect/ConnectModal.tsx

@@ -673,6 +673,17 @@ export class Picket {
 
   static createSigningMessage(args: SigningMessageRequest) {
     const { format = SigningMessageFormat.SIMPLE } = args;
+
+    if (!args.nonce) {
+      throw new Error("'nonce' is required to create a signing message");
+    }
+
+    if (!args.walletAddress) {
+      throw new Error(
+        "'walletAddress' is required to create a signing message"
+      );
+    }
+
     if (format === SigningMessageFormat.SIMPLE) {
       const { statement, walletAddress, nonce } =
         args as SigningMessageRequestSimple;
@@ -690,6 +701,27 @@ export class Picket {
       chainType,
     } = args as SigningMessageRequestSIWE;
 
+    // validate parameters
+    if (!statement) {
+      throw new Error(
+        "'statement' is required to create a SIWE signing message"
+      );
+    }
+    if (!domain) {
+      throw new Error("'domain' is required to create a SIWE signing message");
+    }
+    if (!uri) {
+      throw new Error("'uri' is required to create a SIWE signing message");
+    }
+    if (!issuedAt) {
+      throw new Error(
+        "'issuedAt' is required to create a SIWE signing message"
+      );
+    }
+    if (!chainId) {
+      throw new Error("'chainId' is required to create a SIWE signing message");
+    }
+
     const message = new SiweMessage({
       address: walletAddress,
       nonce,