Fix ChaincodeResponse definition and add new response types (#413) (#414

) Signed-off-by: Jerrylum <[email protected]>
hyperledger · Mar 10, 2024 · 2d94982 · 2d94982
1 parent 6126c09
commit 2d94982
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 5 deletions.
diff --git a/apis/fabric-shim-api/types/index.d.ts b/apis/fabric-shim-api/types/index.d.ts
@@ -14,9 +14,21 @@ declare module 'fabric-shim-api' {
 
     interface ChaincodeResponse {
         status: number;
-        message: string;
+        message?: string;
+        payload?: Uint8Array;
+    }
+
+    interface SuccessResponse {
+        status: RESPONSE_CODE.OK;
+        message?: string;
         payload: Uint8Array;
     }
+
+    interface ErrorResponse {
+        status: RESPONSE_CODE.ERROR;
+        message: string;
+        payload?: Uint8Array;
+    }   
 
     interface ClientIdentity {
         assertAttributeValue(attrName: string, attrValue: string): boolean;

diff --git a/libraries/fabric-shim/types/index.d.ts b/libraries/fabric-shim/types/index.d.ts
@@ -12,6 +12,8 @@ declare module 'fabric-shim' {
     import {
         ChaincodeInterface,
         ChaincodeProposal,
+        ErrorResponse,
+        SuccessResponse,
         ChaincodeResponse,
         ChaincodeStub as IChaincodeStub,
         ClientIdentity as IClientIdentity,
@@ -26,6 +28,8 @@ declare module 'fabric-shim' {
     export {
         ChaincodeInterface,
         ChaincodeProposal,
+        ErrorResponse,
+        SuccessResponse,
         ChaincodeResponse,
         Iterators,
         QueryResponseMetadata,
@@ -35,16 +39,16 @@ declare module 'fabric-shim' {
         Timestamp
     }
 
-    export function error(msg: Uint8Array): ChaincodeResponse;
+    export function error(msg: string): ErrorResponse;
     export function newLogger(name: string): Logger;
     export function start(chaincode: ChaincodeInterface): any;
-    export function success(payload?: Uint8Array): ChaincodeResponse;
+    export function success(payload?: Uint8Array): SuccessResponse;
 
     export class Shim {
-        static error(msg: Uint8Array): ChaincodeResponse;
+        static error(msg: string): ErrorResponse;
         static newLogger(name: string): Logger;
         static start(chaincode: ChaincodeInterface): any;
-        static success(payload?: Uint8Array): ChaincodeResponse;
+        static success(payload?: Uint8Array): SuccessResponse;
         static server(chaincode: ChaincodeInterface, serverOpts: ChaincodeServerOpts): ChaincodeServer;
     }