refactor(rpc): migrate signPsbt methods

packages/rpc/package.json

@@ -18,7 +18,10 @@
   },
   "dependencies": {
     "@leather.io/models": "workspace:*",
-    "zod": "3.23.8"
+    "@leather.io/utils": "workspace:*",
+    "@scure/btc-signer": "1.4.0",
+    "zod": "3.23.8",
+    "zod-validation-error": "3.4.0"
   },
   "devDependencies": {
     "tsup": "8.1.0",

packages/rpc/src/index.ts

@@ -17,6 +17,9 @@ export * from './methods/send-transfer';
 export * from './methods/sign-message';
 export * from './methods/stx-sign-message';
 
+export * from './schemas/network-schemas';
+export * from './schemas/validators';
+
 export type LeatherRpcMethodMap = DefineGetInfoMethod &
   DefineGetAddressesMethod &
   DefineSignPsbtMethod &

packages/rpc/src/methods/sign-psbt.ts

@@ -1,6 +1,14 @@
-import { DefaultNetworkConfigurations } from '@leather.io/models';
+import { SigHash } from '@scure/btc-signer/transaction';
+import { z } from 'zod';
 
+import { testIsNumberOrArrayOfNumbers } from '../rpc/helpers';
 import { DefineRpcMethod, RpcRequest, RpcResponse } from '../rpc/schemas';
+import { baseNetworkSchema } from '../schemas/network-schemas';
+import {
+  formatValidationErrors,
+  getRpcParamErrors,
+  validateRpcParams,
+} from '../schemas/validators';
 
 /**
  * DEFAULT       -- all inputs, all outputs
@@ -21,16 +29,42 @@ export enum SignatureHash {
   SINGLE_ANYONECANPAY = 0x83,
 }
 
-export interface SignPsbtRequestParams {
-  account?: number;
-  allowedSighash?: SignatureHash[];
-  broadcast: boolean;
-  hex: string;
-  network: DefaultNetworkConfigurations;
-  signAtIndex?: number | number[];
-  [x: string]: unknown;
+export type AllowedSighashTypes = SignatureHash | SigHash;
+
+// Pass all sighashTypes through as allowed to btc-signer
+export const allSighashTypes = [
+  SigHash.DEFAULT,
+  SignatureHash.ALL,
+  SignatureHash.NONE,
+  SignatureHash.SINGLE,
+  SigHash.ALL_ANYONECANPAY,
+  SignatureHash.ALL_ANYONECANPAY,
+  SignatureHash.NONE_ANYONECANPAY,
+  SignatureHash.SINGLE_ANYONECANPAY,
+];
+
+export const rpcSignPsbtParamsSchema = z.object({
+  account: z.number().int().optional(),
+  allowedSighash: z.array(z.any()).optional(),
+  broadcast: z.boolean().optional(),
+  hex: z.string(),
+  network: baseNetworkSchema.optional(),
+  signAtIndex: z
+    .union([z.number(), z.array(z.number())])
+    .optional()
+    .refine(testIsNumberOrArrayOfNumbers),
+});
+
+export function validateRpcSignPsbtParams(obj: unknown) {
+  return validateRpcParams(obj, rpcSignPsbtParamsSchema);
 }
 
+export function getRpcSignPsbtParamErrors(obj: unknown) {
+  return formatValidationErrors(getRpcParamErrors(obj, rpcSignPsbtParamsSchema));
+}
+
+export type SignPsbtRequestParams = z.infer<typeof rpcSignPsbtParamsSchema>;
+
 export interface SignPsbtResponseBody {
   hex: string;
   txid?: string;

packages/rpc/src/rpc/helpers.ts

@@ -0,0 +1,6 @@
+import { isNumberOrNumberList, isUndefined } from '@leather.io/utils';
+
+export function testIsNumberOrArrayOfNumbers(value: unknown) {
+  if (isUndefined(value)) return true;
+  return isNumberOrNumberList(value);
+}

packages/rpc/src/schemas/network-schemas.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+import {
+  type DefaultNetworkConfigurations,
+  WalletDefaultNetworkConfigurationIds,
+} from '@leather.io/models';
+
+type NonEmptyDefaultNetworkIdList = [
+  DefaultNetworkConfigurations,
+  ...DefaultNetworkConfigurations[],
+];
+
+export const baseNetworkSchema = z.enum(
+  Object.values(WalletDefaultNetworkConfigurationIds) as NonEmptyDefaultNetworkIdList
+);

packages/rpc/src/schemas/validators.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+import { fromError } from 'zod-validation-error';
+
+export function validateRpcParams(obj: unknown, validator: z.ZodSchema) {
+  try {
+    validator.parse(obj);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+export function getRpcParamErrors(obj: unknown, validator: z.ZodTypeAny) {
+  try {
+    validator.parse(obj);
+    return [];
+  } catch (e) {
+    if (e instanceof z.ZodError) return [e];
+    return [];
+  }
+}
+
+export function formatValidationErrors(errors: z.ZodError[]) {
+  return errors
+    .map(error => fromError(error))
+    .join('. ')
+    .trim();
+}

packages/utils/package.json

@@ -29,7 +29,6 @@
   "dependencies": {
     "@leather.io/constants": "workspace:*",
     "@leather.io/models": "workspace:*",
-    "@leather.io/rpc": "workspace:*",
     "bignumber.js": "9.1.2"
   },
   "devDependencies": {

packages/utils/src/index.ts

@@ -228,3 +228,8 @@
     return match[variant];
   };
 }
+
+export function isNumberOrNumberList(value: unknown): value is number | number[] {
+  if (Array.isArray(value)) return value.every(item => isNumber(item));
+  return isNumber(value);
+}