Revert "Revert "Add message schema validators"" (#23)

* Add "build:watch" script

* Add getBalance method schema

* Add access denied error code

* Switch to bigint

* Add getBalance to BtcRequests

* Add RPC response schemas

* Update getBalance result schema

* Set result and error to non-optional

* Update types

* Use string instead of bigint

* Rename method names

* Fix method name

* added getInscriptions request

* remove comments

* Use same address definition for Stacks

* Support nullish param

* Add more types

* Revert "Revert "Add message schema validators""

---------

Co-authored-by: Eduard Bardají Puig <[email protected]>
Co-authored-by: Mahmoud Aboelenein <[email protected]>

package.json

@@ -11,6 +11,7 @@
     "test": "jest",
     "build-debug": "webpack --mode development",
     "build": "npm run clean && tsup src/index.ts --format esm --dts",
+    "build:watch": "npm run clean && tsup src/index.ts --format esm --dts --watch",
     "clean": "rimraf dist",
     "lint": "prettier --write .",
     "prepare": "husky install"
@@ -30,6 +31,9 @@
     "jsontokens": "4.0.1",
     "lodash.omit": "4.5.0"
   },
+  "peerDependencies": {
+    "valibot": "0.33.2"
+  },
   "devDependencies": {
     "@types/jest": "^29.2.6",
     "@types/lodash.omit": "4.5.9",
@@ -42,7 +46,7 @@
     "ts-jest": "^29.0.5",
     "ts-loader": "^9.4.1",
     "tsup": "^8.0.2",
-    "typescript": "^4.9.4",
+    "typescript": "5.4.5",
     "util": "^0.12.4",
     "vm-browserify": "^1.1.2",
     "webpack": "^5.74.0",

src/addresses/types.ts

@@ -1,3 +1,4 @@
+import * as v from 'valibot';
 import type { RequestOptions, RequestPayload } from '../types';
 
 export enum AddressPurpose {
@@ -20,12 +21,13 @@ export enum AddressType {
   stacks = 'stacks',
 }
 
-export interface Address {
-  address: string;
-  publicKey: string;
-  purpose?: AddressPurpose;
-  addressType?: AddressType;
-}
+export const addressSchema = v.object({
+  address: v.string(),
+  publicKey: v.string(),
+  purpose: v.enum(AddressPurpose),
+  addressType: v.enum(AddressType),
+});
+export type Address = v.InferOutput<typeof addressSchema>;
 
 export interface GetAddressResponse {
   addresses: Address[];

src/provider/types.ts

@@ -1,5 +1,6 @@
 import {
   BtcRequestMethod,
+  OrdinalsRequestMethod,
   Params,
   Requests,
   RunesRequestMethod,
@@ -46,7 +47,7 @@ export interface Provider {
   mozillaAddOnsUrl?: string;
   googlePlayStoreUrl?: string;
   iOSAppStoreUrl?: string;
-  methods?: (StxRequestMethod | BtcRequestMethod | RunesRequestMethod)[];
+  methods?: (StxRequestMethod | BtcRequestMethod | RunesRequestMethod | OrdinalsRequestMethod)[];
 }
 
 export interface SupportedWallet extends Provider {

src/request/index.ts

@@ -1,6 +1,12 @@
 import { getProviderById } from '../provider';
-import { RpcBase, RpcResult, RpcSuccessResponse } from '../types';
-import { Params, Requests } from './types';
+import {
+  RpcErrorCode,
+  RpcResult,
+  rpcErrorResponseMessageSchema,
+  rpcSuccessResponseMessageSchema,
+} from '../types';
+import * as v from 'valibot';
+import { Params, Requests, Return } from './types';
 
 export const request = async <Method extends keyof Requests>(
   method: Method,
@@ -20,23 +26,28 @@ export const request = async <Method extends keyof Requests>(
 
   const response = await provider.request(method, params);
 
-  if (isRpcSuccessResponse<Method>(response)) {
+  if (v.is(rpcErrorResponseMessageSchema, response)) {
+    return {
+      status: 'error',
+      error: response.error,
+    };
+  }
+
+  if (v.is(rpcSuccessResponseMessageSchema, response)) {
     return {
       status: 'success',
-      result: response.result,
+      result: response.result as Return<Method>,
     };
   }
 
   return {
     status: 'error',
-    error: response.error,
+    error: {
+      code: RpcErrorCode.INTERNAL_ERROR,
+      message: 'Received unknown response from provider.',
+      data: response,
+    },
   };
 };
 
-const isRpcSuccessResponse = <Method extends keyof Requests>(
-  response: RpcBase
-): response is RpcSuccessResponse<Method> => {
-  return Object.hasOwn(response, 'result') && !!(response as RpcSuccessResponse<Method>).result;
-};
-
 export * from './types';