defaults results to an empty object if null or undefined (#270)

allow returning void infer storage set return value
LedgerHQ · Dec 6, 2023 · 0bd66f5 · 0bd66f5 · vercel · Dec 6, 2023
1 parent 20fad45
commit 0bd66f5
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 7 deletions.
diff --git a/.changeset/rude-boxes-flash.md b/.changeset/rude-boxes-flash.md
@@ -0,0 +1,7 @@
+---
+"@ledgerhq/wallet-api-simulator": patch
+"@ledgerhq/wallet-api-client": patch
+"@ledgerhq/wallet-api-core": patch
+---
+
+allow empty (void) values to be returned by the RPCNode requests
diff --git a/packages/core/src/JSONRPC/RpcNode.ts b/packages/core/src/JSONRPC/RpcNode.ts
@@ -47,7 +47,7 @@ export abstract class RpcNode<TSHandlers, TCHandlers> {
 
   private _request<K extends keyof TCHandlers>(
     request: RpcRequest<K, MethodParamsIfExists<TCHandlers, K>>,
-  ): Promise<ReturnTypeOfMethodIfExists<TCHandlers, K>> {
+  ): Promise<ReturnTypeOfMethodIfExists<TCHandlers, K> | undefined> {
     return new Promise((resolve, reject) => {
       if (!request.id) {
         reject(new Error("requests need to have an id"));
@@ -90,7 +90,7 @@ export abstract class RpcNode<TSHandlers, TCHandlers> {
   public request<K extends keyof TCHandlers>(
     method: K,
     params: MethodParamsIfExists<TCHandlers, K>,
-  ): Promise<ReturnTypeOfMethodIfExists<TCHandlers, K>> {
+  ): Promise<ReturnTypeOfMethodIfExists<TCHandlers, K> | undefined> {
     const requestId = uuidv4();
     return this._request({
       id: requestId,

diff --git a/packages/core/src/JSONRPC/helpers.ts b/packages/core/src/JSONRPC/helpers.ts
@@ -48,7 +48,7 @@ export function createRpcRequest<T>(
 type CreateRpcResponseParams<T, E> =
   | {
       id: string | number | null;
-      result: T;
+      result?: T;
     }
   | {
       id: string | number | null;

diff --git a/packages/core/src/JSONRPC/types.ts b/packages/core/src/JSONRPC/types.ts
@@ -113,7 +113,7 @@ export type RpcResponseSuccess<TResult = unknown> = RpcResponseCommon & {
    * This member **MUST NOT** exist if there was an error invoking the method.
    * The value of this member is determined by the method invoked on the Server.
    */
-  result: TResult;
+  result?: TResult;
 };
 
 export type RpcResponseFailed<TErrorData = unknown> = RpcResponseCommon & {

diff --git a/packages/core/src/JSONRPC/validation.ts b/packages/core/src/JSONRPC/validation.ts
@@ -23,7 +23,7 @@ export const schemaRPCResponseSuccess = z
   .object({
     jsonrpc: z.literal("2.0"),
     id: schemaRPCId,
-    result: z.object({}).passthrough(),
+    result: z.object({}).passthrough().optional(),
   })
   .strict();
 

diff --git a/packages/core/src/spec/types/StorageSet.ts b/packages/core/src/spec/types/StorageSet.ts
@@ -6,7 +6,7 @@ const schemaStorageSetParams = z.object({
   storeId: z.string().optional(),
 });
 
-const schemaStorageSetResults = z.void();
+const schemaStorageSetResults = z.void().optional();
 
 export const schemaStorageSet = {
   params: schemaStorageSetParams,

diff --git a/packages/simulator/tests/simulator.spec.ts b/packages/simulator/tests/simulator.spec.ts
@@ -244,7 +244,7 @@ describe("Simulator", () => {
       // WHEN
       const key = "testKey";
       const value = "testValue";
-      void client.storage.set(key, value); // TODO fix me when we can await
+      await client.storage.set(key, value);
       const retrievedValue = await client.storage.get(key);
 
       // THEN