add optional receipt to submit commitment response (#33)

* add optional receipt to submit commitment response

Author: jait91

package-lock.json

@@ -29,7 +29,7 @@
   "license": "ISC",
   "homepage": "https://unicitynetwork.github.io/state-transition-sdk/",
   "dependencies": {
-    "@unicitylabs/commons": "2.4.0-rc.a5f85b0",
+    "@unicitylabs/commons": "2.4.0-rc.1d26eee",
     "@unicitylabs/prefix-hash-tree": "1.2.13-rc.43a27ce"
   },
   "devDependencies": {
@@ -48,6 +48,6 @@
     "typescript-eslint": "8.33.0"
   },
   "overrides": {
-    "@unicitylabs/commons": "2.4.0-rc.a5f85b0"
+    "@unicitylabs/commons": "2.4.0-rc.1d26eee"
   }
 }

package.json

@@ -5,10 +5,10 @@ import { DataHash } from '@unicitylabs/commons/lib/hash/DataHash.js';
 import { HashAlgorithm } from '@unicitylabs/commons/lib/hash/HashAlgorithm.js';
 import { SigningService } from '@unicitylabs/commons/lib/signing/SigningService.js';
 import { HexConverter } from '@unicitylabs/commons/lib/util/HexConverter.js';
+import { SubmitCommitmentStatus } from '@unicitylabs/commons/lib/api/SubmitCommitmentResponse.js';
 
 import { DirectAddress } from './address/DirectAddress.js';
 import { IAggregatorClient } from './api/IAggregatorClient.js';
-import { SubmitCommitmentStatus } from './api/SubmitCommitmentResponse.js';
 import { ISerializable } from './ISerializable.js';
 import { TokenCoinData } from './token/fungible/TokenCoinData.js';
 import { NameTagToken } from './token/NameTagToken.js';

src/StateTransitionClient.ts

@@ -1,11 +1,12 @@
 import { Authenticator } from '@unicitylabs/commons/lib/api/Authenticator.js';
 import { InclusionProof } from '@unicitylabs/commons/lib/api/InclusionProof.js';
 import { RequestId } from '@unicitylabs/commons/lib/api/RequestId.js';
+import { SubmitCommitmentRequest } from '@unicitylabs/commons/lib/api/SubmitCommitmentRequest.js';
+import { SubmitCommitmentResponse } from '@unicitylabs/commons/lib/api/SubmitCommitmentResponse.js';
 import { DataHash } from '@unicitylabs/commons/lib/hash/DataHash.js';
 import { JsonRpcHttpTransport } from '@unicitylabs/commons/lib/json-rpc/JsonRpcHttpTransport.js';
 
 import { IAggregatorClient } from './IAggregatorClient.js';
-import { SubmitCommitmentResponse, SubmitCommitmentStatus } from './SubmitCommitmentResponse.js';
 
 /**
  * Client implementation for communicating with an aggregator via JSON-RPC.
@@ -29,16 +30,13 @@ export class AggregatorClient implements IAggregatorClient {
     requestId: RequestId,
     transactionHash: DataHash,
     authenticator: Authenticator,
+    receipt: boolean = false,
   ): Promise<SubmitCommitmentResponse> {
-    const data = {
-      authenticator: authenticator.toJSON(),
-      requestId: requestId.toJSON(),
-      transactionHash: transactionHash.toJSON(),
-    };
-
-    await this.transport.request('submit_commitment', data);
-    // TODO: Fix response
-    return new SubmitCommitmentResponse(SubmitCommitmentStatus.SUCCESS);
+    const request = new SubmitCommitmentRequest(requestId, transactionHash, authenticator, receipt);
+
+    const response = await this.transport.request('submit_commitment', request.toJSON());
+
+    return SubmitCommitmentResponse.fromJSON(response)
   }
 
   /**

src/api/AggregatorClient.ts

@@ -2,8 +2,7 @@ import { Authenticator } from '@unicitylabs/commons/lib/api/Authenticator.js';
 import { InclusionProof } from '@unicitylabs/commons/lib/api/InclusionProof.js';
 import { RequestId } from '@unicitylabs/commons/lib/api/RequestId.js';
 import { DataHash } from '@unicitylabs/commons/lib/hash/DataHash.js';
-
-import { SubmitCommitmentResponse } from './SubmitCommitmentResponse.js';
+import { SubmitCommitmentResponse } from '@unicitylabs/commons/lib/api/SubmitCommitmentResponse.js';
 
 /**
  * Client interface for interacting with an aggregator service.
@@ -21,6 +20,7 @@ export interface IAggregatorClient {
     requestId: RequestId,
     transactionHash: DataHash,
     authenticator: Authenticator,
+    receipt?: boolean,
   ): Promise<SubmitCommitmentResponse>;
 
   /**

src/api/IAggregatorClient.ts

@@ -6,7 +6,6 @@ export * from './address/IAddress.js';
 // API exports
 export * from './api/AggregatorClient.js';
 export * from './api/IAggregatorClient.js';
-export * from './api/SubmitCommitmentResponse.js';
 
 // Predicate exports
 export * from './predicate/BurnPredicate.js';