Merge pull-request #202

Author: r-n-o

.changeset/hungry-otters-destroy.md

@@ -0,0 +1,5 @@
+---
+"@turnkey/solana": minor
+---
+
+implemented signMessage on the Solana TurnkeySigner

packages/solana/package.json

@@ -52,7 +52,9 @@
     "@turnkey/http": "workspace:*"
   },
   "devDependencies": {
-    "@turnkey/api-key-stamper": "workspace:*"
+    "@turnkey/api-key-stamper": "workspace:*",
+    "bs58": "^5.0.0",
+    "tweetnacl": "^1.0.3"
   },
   "engines": {
     "node": ">=18.0.0"

packages/solana/src/__tests__/index-test.ts

@@ -3,8 +3,14 @@ import { TurnkeySigner } from "../";
 import { TurnkeyClient } from "@turnkey/http";
 import { ApiKeyStamper } from "@turnkey/api-key-stamper";
 import { PublicKey, SystemProgram, Transaction } from "@solana/web3.js";
+import nacl from "tweetnacl";
+import bs58 from "bs58";
 
 describe("TurnkeySigner", () => {
+  const organizationId = "4456e4c2-e8b5-4b93-a0cf-1dfae265c12c";
+  const apiPublicKey =
+    "025d374c674fc389c761462f3c59c0acabdcb3a17c599d9e62e5fe78fe984cfbeb";
+  const turnkeySolAddress = "D8P541wwnertZTgDT14kYJPoFT2eHUFqjTgPxMK5qatM";
   test("can sign a Solana transfer against production", async () => {
     if (!process.env.SOLANA_TEST_ORG_API_PRIVATE_KEY) {
       // This test requires an env var to be set
@@ -16,19 +22,16 @@ describe("TurnkeySigner", () => {
     const client = new TurnkeyClient(
       { baseUrl: "https://api.turnkey.com" },
       new ApiKeyStamper({
-        apiPublicKey:
-          "025d374c674fc389c761462f3c59c0acabdcb3a17c599d9e62e5fe78fe984cfbeb",
+        apiPublicKey,
         apiPrivateKey: process.env.SOLANA_TEST_ORG_API_PRIVATE_KEY,
       })
     );
 
     const signer = new TurnkeySigner({
-      organizationId: "4456e4c2-e8b5-4b93-a0cf-1dfae265c12c",
+      organizationId,
       client,
     });
 
-    const turnkeySolAddress = "D8P541wwnertZTgDT14kYJPoFT2eHUFqjTgPxMK5qatM";
-
     const transferTransaction = new Transaction().add(
       SystemProgram.transfer({
         fromPubkey: new PublicKey(turnkeySolAddress),
@@ -48,4 +51,41 @@ describe("TurnkeySigner", () => {
     await signer.addSignature(transferTransaction, turnkeySolAddress);
     expect(transferTransaction.signatures.length).toBe(1);
   });
+
+  test("can sign a message with a Solana account", async () => {
+    if (!process.env.SOLANA_TEST_ORG_API_PRIVATE_KEY) {
+      // This test requires an env var to be set
+      throw new Error(
+        "This test requires SOLANA_TEST_ORG_API_PRIVATE_KEY to be set"
+      );
+    }
+
+    const client = new TurnkeyClient(
+      { baseUrl: "https://api.turnkey.com" },
+      new ApiKeyStamper({
+        apiPublicKey,
+        apiPrivateKey: process.env.SOLANA_TEST_ORG_API_PRIVATE_KEY,
+      })
+    );
+
+    const signer = new TurnkeySigner({
+      organizationId,
+      client,
+    });
+
+    const message = "Hello world!";
+    const messageAsUint8Array = Buffer.from(message);
+
+    const signature = await signer.signMessage(
+      messageAsUint8Array,
+      turnkeySolAddress
+    );
+
+    const isValidSignature = nacl.sign.detached.verify(
+      messageAsUint8Array,
+      signature,
+      bs58.decode(turnkeySolAddress)
+    );
+    expect(isValidSignature).toBeTruthy();
+  });
 });

packages/solana/src/index.ts

@@ -20,13 +20,44 @@ export class TurnkeySigner {
     const fromKey = new PublicKey(fromAddress);
     const messageToSign = tx.serializeMessage();
 
+    const signRawPayloadResult = await this.signRawPayload(
+      messageToSign.toString("hex"),
+      fromAddress
+    );
+
+    const signature = `${signRawPayloadResult.signRawPayloadResult?.r}${signRawPayloadResult.signRawPayloadResult?.s}`;
+
+    tx.addSignature(fromKey, Buffer.from(signature, "hex"));
+  }
+
+  /**
+   * This function takes a message and returns it after being signed with Turnkey
+   *
+   * @param message The message to sign (Uint8Array)
+   * @param fromAddress Solana address (base58 encoded)
+   */
+  public async signMessage(
+    message: Uint8Array,
+    fromAddress: string
+  ): Promise<Uint8Array> {
+    const signRawPayloadResult = await this.signRawPayload(
+      Buffer.from(message).toString("hex"),
+      fromAddress
+    );
+    return Buffer.from(
+      `${signRawPayloadResult.signRawPayloadResult?.r}${signRawPayloadResult.signRawPayloadResult?.s}`,
+      "hex"
+    );
+  }
+
+  private async signRawPayload(payload: string, signWith: string) {
     const response = await this.client.signRawPayload({
       type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
       organizationId: this.organizationId,
       timestampMs: String(Date.now()),
       parameters: {
-        signWith: fromAddress,
-        payload: messageToSign.toString("hex"),
+        signWith,
+        payload,
         encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
         // Note: unlike ECDSA, EdDSA's API does not support signing raw digests (see RFC 8032).
         // Turnkey's signer requires an explicit value to be passed here to minimize ambiguity.
@@ -45,8 +76,6 @@ export class TurnkeySigner {
       });
     }
 
-    const signature = `${result.signRawPayloadResult?.r}${result.signRawPayloadResult?.s}`;
-
-    tx.addSignature(fromKey, Buffer.from(signature, "hex"));
+    return result;
   }
 }