update sign message

Author: chcmedeiros

.github/workflows/publish.yml

@@ -27,7 +27,6 @@ jobs:
         with:
           registry-url: "https://registry.npmjs.org"
           scope: "@zondax"
-      - run: mv README-npm.md README.md
       - name: Install yarn
         run: npm install -g yarn
       - run: yarn install

README-npm.md

@@ -7,6 +7,40 @@ This package provides a basic client library to communicate with the Mina App ru
 
 We recommend using the npmjs package in order to receive updates/fixes.
 
+### App Operations
+
+| Operation    | Response                    | Command | Notes                                |
+| ------------ | --------------------------- | ------- | ------------------------------------ |
+| getAppName   | { name: string, version: string } | None | Returns app name and version |
+| getAppVersion| { version: string }         | None    | Returns app version                  |
+
+### Address Operations
+
+| Operation    | Response                    | Command | Notes                                |
+| ------------ | --------------------------- | ------- | ------------------------------------ |
+| getAddress   | { publicKey: string }       | account + showAddrInDevice | Retrieves public key for given account |
+
+### Transaction Operations
+
+| Operation      | Response                    | Command                                                                 | Notes                                |
+| -------------- | --------------------------- | ----------------------------------------------------------------------- | ------------------------------------ |
+| signTransaction| { signature: string }       | txType + senderAccount + senderAddress + receiverAddress + amount + fee + nonce + validUntil + memo + networkId | Signs a Mina transaction |
+| signMessage    | { field: string, scalar: string, raw_signature: string, signed_message: string } | account + networkId + message | Signs a message using the specified account |
+
+### Transaction Types
+
+| Type | Value | Description |
+|------|-------|-------------|
+| PAYMENT | 0x00 | Payment transaction |
+| DELEGATION | 0x04 | Delegation transaction |
+
+### Network IDs
+
+| Network | Value | Description |
+|---------|-------|-------------|
+| MAINNET | 0x01 | Mina mainnet |
+| DEVNET | 0x00 | Mina devnet |
+
 ## Notes
 
 Use `yarn install` to avoid issues.

README.md

@@ -23,7 +23,8 @@
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
   "files": [
-    "dist/**"
+    "dist/**",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc",

package.json

@@ -55,9 +55,10 @@ interface SignTransactionResponse extends BaseLedgerResponse {
 }
 
 interface SignMessageResponse extends BaseLedgerResponse {
-    field: string | null;
-    scalar: string | null;
-    raw_signature?: string | null;
+  field: string | null;
+  scalar: string | null;
+  raw_signature?: string | null;
+  signed_message?: string | null;
 }
 
 
@@ -245,33 +246,49 @@ export class MinaApp extends BaseApp {
         }
     }
 
-    async signMessage(account: number, networkId: number, message: string): Promise<SignMessageResponse> {
-        if (message.length === 0) {
-            return {
-                field: null,
-                scalar: null,
-                raw_signature: null,
-                returnCode: "-6",
-                message: "Message is empty",
-            };
-        }
-        if (message.length > 255) {
-            return {
-                field: null,
-                scalar: null,
-                raw_signature: null,
-                returnCode: "-7",
-                message: "Message too long",
-            };
-        }
-        try {
-            const accountHex = Buffer.from(account.toString(16).padStart(8, '0'), 'hex');
-            const networkIdHex = Buffer.from(networkId.toString(16).padStart(2, '0'), 'hex');
-            const messageHex = Buffer.from(message, 'utf8');
-            // Calculate total buffer length
-            const totalLength = accountHex.length + networkIdHex.length + messageHex.length;
-            // Create buffer with total length
-            const dataTx = Buffer.concat([accountHex, networkIdHex, messageHex], totalLength);
+  async signMessage(
+    account: number,
+    networkId: number,
+    message: string,
+  ): Promise<SignMessageResponse> {
+    if (message.length === 0) {
+      return {
+        field: null,
+        scalar: null,
+        raw_signature: null,
+        signed_message: null,
+        returnCode: "-6",
+        message: "Message is empty",
+      };
+    }
+    if (message.length > 255) {
+      return {
+        field: null,
+        scalar: null,
+        raw_signature: null,
+        signed_message: null,
+        returnCode: "-7",
+        message: "Message too long",
+      };
+    }
+    try {
+      const accountHex = Buffer.from(
+        account.toString(16).padStart(8, "0"),
+        "hex",
+      );
+      const networkIdHex = Buffer.from(
+        networkId.toString(16).padStart(2, "0"),
+        "hex",
+      );
+      const messageHex = Buffer.from(message, "utf8");
+      // Calculate total buffer length
+      const totalLength =
+        accountHex.length + networkIdHex.length + messageHex.length;
+      // Create buffer with total length
+      const dataTx = Buffer.concat(
+        [accountHex, networkIdHex, messageHex],
+        totalLength,
+      );
 
             const responseBuffer = await this.transport.send(
                 this.CLA,
@@ -281,28 +298,47 @@ export class MinaApp extends BaseApp {
                 dataTx
             );
 
-            const response = processResponse(responseBuffer)
-            const signature = response.readBytes(response.length()).toString("hex");
-            const sigLength = signature.length;
-            const field_extracted = signature.substring(0, sigLength / 2);
-            const scalar_extracted = signature.substring(sigLength / 2, sigLength);
-
-            return {
-                field: BigInt("0x" + field_extracted).toString(),
-                scalar: BigInt("0x" + scalar_extracted).toString(),
-                raw_signature: signature,
-                returnCode: "9000"
-            };
-        } catch (e) {
-            const respError = processErrorResponse(e)
-            return {
-                field: null,
-                scalar: null,
-                raw_signature: null,
-                returnCode: respError.returnCode.toString(),
-                message: respError.errorMessage,
-            };
-        }
+      const response = processResponse(responseBuffer);
+      
+      // Validate minimum buffer length (64 bytes for signature + 1 byte for message length)
+      if (response.length() < 65) {
+        throw new Error("Response buffer too short");
+      }
+
+      // First read the signature (64 bytes)
+      const signature = response.readBytes(64).toString("hex");
+      const sigLength = signature.length;
+      const field_extracted = signature.substring(0, sigLength / 2);
+      const scalar_extracted = signature.substring(sigLength / 2, sigLength);
+      
+      // Then read the message length (1 byte)
+      const messageLength = response.readBytes(1).readUInt8();
+      
+      // Validate remaining buffer length against message length
+      if (response.length() < messageLength) {
+        throw new Error("Response buffer too short for message");
+      }
+      
+      // Finally read the message
+      const returnedMessage = response.readBytes(messageLength).toString('utf8');
+
+      return {
+        field: BigInt("0x" + field_extracted).toString(),
+        scalar: BigInt("0x" + scalar_extracted).toString(),
+        raw_signature: signature,
+        signed_message: returnedMessage,
+        returnCode: "9000",
+      };
+    } catch (e) {
+      const respError = processErrorResponse(e);
+      return {
+        field: null,
+        scalar: null,
+        raw_signature: null,
+        signed_message: null,
+        returnCode: respError.returnCode.toString(),
+        message: respError.errorMessage,
+      };
     }