feat(accounts): add zkapp command signing (#7)

Author: mrcnk

packages/accounts/src/accounts/__snapshots__/private-key-to-account.spec.ts.snap

@@ -53,3 +53,32 @@ exports[`signs fields 1`] = `
   "signature": "7mXCUvhLhFvG9ptrdfNceCrpThkCUyg1ct2z8uwY7eQbKz7UNmhv33TbuDjTznaypJtXRiMJyQWDnf27TH1FSXG7uJHTKAd9",
 }
 `;
+
+exports[`signs a zkapp command 1`] = `
+{
+  "data": {
+    "feePayer": {
+      "fee": "100000000",
+      "feePayer": "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+      "memo": "Test",
+      "nonce": "0",
+      "validUntil": "null",
+    },
+    "zkappCommand": {
+      "accountUpdates": [],
+      "feePayer": {
+        "authorization": "7mXWqNfmqMTM5uSCS2xLfsRBLTjGZKTtpEakdsrdQz1EUgYXogSvKxxtfGbBkqQ2mZRMA3uPAM8riaCF56pkqpZBLr2kNBLa",
+        "body": {
+          "fee": "100000000",
+          "nonce": "0",
+          "publicKey": "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+          "validUntil": null,
+        },
+      },
+      "memo": "E4YVT4x3A9rUhmjkjGn8ZYBLZn7zK4cfvnMtBYZFdWkg37n2s3nrP",
+    },
+  },
+  "publicKey": "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+  "signature": "7mXWqNfmqMTM5uSCS2xLfsRBLTjGZKTtpEakdsrdQz1EUgYXogSvKxxtfGbBkqQ2mZRMA3uPAM8riaCF56pkqpZBLr2kNBLa",
+}
+`;

packages/accounts/src/accounts/private-key-to-account.spec.ts

@@ -33,6 +33,35 @@ it("signs a transaction", async () => {
 	expect(signedTransaction).toMatchSnapshot();
 });
 
+it("signs a zkapp command", async () => {
+	const account = privateKeyToAccount({
+		privateKey: Test.accounts[0].privateKey,
+	});
+	const command = {
+		zkappCommand: {
+			accountUpdates: [],
+			memo: "E4YM2vTHhWEg66xpj52JErHUBU4pZ1yageL4TVDDpTTSsv8mK6YaH",
+			feePayer: {
+				body: {
+					publicKey: "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+					fee: "100000000",
+					validUntil: "100000",
+					nonce: "1",
+				},
+				authorization: "",
+			},
+		},
+		feePayer: {
+			feePayer: "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+			fee: "100000000",
+			nonce: "0",
+			memo: "Test",
+		},
+	};
+	const signedTransaction = await account.signTransaction({ command });
+	expect(signedTransaction).toMatchSnapshot();
+});
+
 it("creates a nullifier", async () => {
 	const account = privateKeyToAccount({
 		privateKey: Test.accounts[0].privateKey,

packages/accounts/src/accounts/private-key-to-account.ts

@@ -29,9 +29,14 @@ export function privateKeyToAccount({
 		async signMessage({ message }) {
 			return SignedMessageSchema.parse(client.signMessage(message, privateKey));
 		},
-		async signTransaction({ transaction }) {
+		async signTransaction(signable) {
+			if ("transaction" in signable) {
+				return SignedTransactionSchema.parse(
+					client.signTransaction(signable.transaction, privateKey),
+				);
+			}
 			return SignedTransactionSchema.parse(
-				client.signTransaction(transaction, privateKey),
+				client.signTransaction(signable.command as never, privateKey),
 			);
 		},
 		async createNullifier({ message }) {

packages/accounts/src/types.ts

@@ -4,6 +4,7 @@ import type {
 	SignedFields,
 	SignedMessage,
 	SignedTransaction,
+	TransactionOrZkAppCommandProperties,
 } from "@mina-js/utils";
 import type { HDKey } from "@scure/bip32";
 import type { Simplify } from "type-fest";
@@ -12,7 +13,6 @@ import type {
 	CreateNullifierParamsSchema,
 	SignFieldsParamsSchema,
 	SignMessageParamsSchema,
-	SignTransactionParamsSchema,
 } from "./validation";
 
 export enum MinaKeyConst {
@@ -81,7 +81,6 @@ export type { HDKey };
 export type SignFieldsParams = z.infer<typeof SignFieldsParamsSchema>;
 export type SignMessageParams = z.infer<typeof SignMessageParamsSchema>;
 export type CreateNullifierParams = z.infer<typeof CreateNullifierParamsSchema>;
-export type SignTransactionParams = z.infer<typeof SignTransactionParamsSchema>;
 
 /**
  * Signer methods
@@ -92,5 +91,5 @@ export type CreateNullifier = (
 	params: CreateNullifierParams,
 ) => Promise<Nullifier>;
 export type SignTransaction = (
-	params: SignTransactionParams,
+	params: TransactionOrZkAppCommandProperties,
 ) => Promise<SignedTransaction>;

packages/utils/src/types.ts

@@ -14,6 +14,7 @@ import type {
 	SignedTransactionSchema,
 	StoredCredentialSchema,
 	TransactionBodySchema,
+	TransactionOrZkAppCommandSchema,
 	TransactionPayloadSchema,
 	TransactionReceiptSchema,
 	ZkAppCommandBodySchema,
@@ -32,6 +33,9 @@ export type TransactionPayload = z.infer<typeof TransactionPayloadSchema>;
 export type PartialTransaction = z.infer<typeof PartialTransactionSchema>;
 export type ZkAppCommandBody = z.infer<typeof ZkAppCommandBodySchema>;
 export type ZkAppCommandProperties = z.infer<typeof ZkAppCommandPayload>;
+export type TransactionOrZkAppCommandProperties = z.infer<
+	typeof TransactionOrZkAppCommandSchema
+>;
 export type Sendable = z.infer<typeof SendableSchema>;
 
 /**

packages/utils/src/validation.ts

@@ -79,6 +79,11 @@ export const ZkAppCommandPayload = z
 	})
 	.strict();
 
+export const TransactionOrZkAppCommandSchema = z.union([
+	TransactionPayloadSchema,
+	ZkAppCommandPayload,
+]);
+
 /**
  * Return type schemas
  */
@@ -122,7 +127,7 @@ export const NullifierSchema = z
 
 export const SignedTransactionSchema = z
 	.object({
-		signature: SignatureSchema,
+		signature: z.union([SignatureSchema, z.string()]),
 		publicKey: PublicKeySchema,
 		data: z.union([TransactionBodySchema, ZkAppCommandBodySchema]),
 	})