fix(rpc): refactor msg signing types, add publicKey param in response

Author: kyranjamie

packages/rpc/src/methods/stacks/stx-get-addresses.ts

@@ -2,7 +2,6 @@ import { z } from 'zod';
 
 import {
   DefineRpcMethod,
-  RpcResponse,
   createRpcRequestSchema,
   createRpcResponseSchema,
   defaultErrorSchema,
@@ -31,7 +30,7 @@ export const stxGetAddressesResponseSchema = createRpcResponseSchema(
   defaultErrorSchema
 );
 
-export type StxGetAddressesResponse = RpcResponse<typeof stxGetAddressesResponseBodySchema>;
+export type StxGetAddressesResponse = z.infer<typeof stxGetAddressesResponseSchema>;
 
 export type DefineStxGetAddressesMethod = DefineRpcMethod<
   StxGetAddressesRequest,

packages/rpc/src/methods/stacks/stx-sign-message.ts

@@ -1,36 +1,74 @@
-import { DefineRpcMethod, RpcParameterByName, RpcRequest, RpcResponse } from '../../rpc/schemas';
+import { z } from 'zod';
 
-export const stxMessageSigningTypes = ['utf8', 'structured'] as const;
+import {
+  DefineRpcMethod,
+  createRpcRequestSchema,
+  createRpcResponseSchema,
+  defaultErrorSchema,
+} from '../../rpc/schemas';
 
-export type StxSignMessageTypes = (typeof stxMessageSigningTypes)[number];
+export const stxSignMessageMethodName = 'stx_signMessage';
 
-export interface StxSignMessageRequestParamsBase extends RpcParameterByName {
-  messageType: StxSignMessageTypes;
-  network?: 'mainnet' | 'testnet' | 'devnet' | 'mocknet';
-}
+// Request
+export const stxSignMessageTypeSchema = z.enum(['utf8', 'structured']);
+export type StxSignMessageTypes = z.infer<typeof stxSignMessageTypeSchema>;
 
-export interface StxSignMessageRequestParamsUtf8 extends StxSignMessageRequestParamsBase {
-  type: 'utf8';
-  message: string;
-}
+export const stxSignMessageRequestBaseSchema = z.object({
+  messageType: stxSignMessageTypeSchema,
+  network: z.optional(z.enum(['mainnet', 'testnet', 'devnet', 'mocknet'])),
+});
 
-export interface StxSignMessageRequestParamsStructured extends StxSignMessageRequestParamsBase {
-  type: 'structured';
-  domain: string;
-  message: string;
-}
+export type StxSignMessageRequestParamsBase = z.infer<typeof stxSignMessageRequestBaseSchema>;
 
-export type StxSignMessageRequestParams =
-  | StxSignMessageRequestParamsUtf8
-  | StxSignMessageRequestParamsStructured;
+export const stxSignMessageRequestUtf8Schema = stxSignMessageRequestBaseSchema.merge(
+  z.object({
+    messageType: z.literal('utf8'),
+    message: z.string(),
+  })
+);
 
-export interface StxSignMessageResponseBody {
-  signature: string;
-}
+export type StxSignMessageRequestParamsUtf8 = z.infer<typeof stxSignMessageRequestUtf8Schema>;
 
-export type StxSignMessageRequest = RpcRequest<'stx_signMessage', StxSignMessageRequestParams>;
+export const stxSignMessageRequestStructuredSchema = stxSignMessageRequestBaseSchema.merge(
+  z.object({
+    messageType: z.literal('structured'),
+    domain: z.string(),
+    message: z.string(),
+  })
+);
 
-export type StxSignMessageResponse = RpcResponse<StxSignMessageResponseBody>;
+export type StxSignMessageRequestParamsStructured = z.infer<
+  typeof stxSignMessageRequestStructuredSchema
+>;
+
+export const stxSignMessageRequestParamsSchema = z.union([
+  stxSignMessageRequestUtf8Schema,
+  stxSignMessageRequestStructuredSchema,
+]);
+
+export type StxSignMessageRequestParams = z.infer<typeof stxSignMessageRequestParamsSchema>;
+
+export const stxSignMessageRequestSchema = createRpcRequestSchema(
+  stxSignMessageMethodName,
+  stxSignMessageRequestParamsSchema
+);
+
+export type StxSignMessageRequest = z.infer<typeof stxSignMessageRequestSchema>;
+
+// Response
+export const stxSignMessageResponseBodySchema = z.object({
+  signature: z.string(),
+  publicKey: z.string(),
+});
+
+export type StxSignMessageResponseSchema = z.infer<typeof stxSignMessageResponseBodySchema>;
+
+export const stxSignMessageResponseSchema = createRpcResponseSchema(
+  stxSignMessageResponseBodySchema,
+  defaultErrorSchema
+);
+
+export type StxSignMessageResponse = z.infer<typeof stxSignMessageResponseSchema>;
 
 export type DefineStxSignMessageMethod = DefineRpcMethod<
   StxSignMessageRequest,