Add stateDiff in SimulateTransaction API response

stellar · May 10, 2024 · ecaaa92 · ecaaa92
1 parent dedacda
commit ecaaa92
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 2 deletions.
diff --git a/src/soroban/api.ts b/src/soroban/api.ts
@@ -175,8 +175,18 @@ export namespace Api {
     value: string;
   }
 
-  export interface RequestAirdropResponse {
-    transaction_id: string;
+  interface RawLedgerEntryDiff {
+    type: number;
+    key: string;
+    before?: string;
+    after?: string;
+  }
+
+  interface LedgerEntryDiff{
+    type: number;
+    key: string;
+    before?: xdr.LedgerEntry;
+    after?: xdr.LedgerEntry;
   }
 
   export type SendTransactionStatus =
@@ -264,6 +274,9 @@ export namespace Api {
 
     /** present only for invocation simulation */
     result?: SimulateHostFunctionResult;
+
+    // State Difference information
+    stateDiff?: LedgerEntryDiff[];
   }
 
   /** Includes details about why the simulation failed */
@@ -347,5 +360,8 @@ export namespace Api {
       minResourceFee: string;
       transactionData: string;
     };
+
+    // State Difference information
+    stateDiff?: RawLedgerEntryDiff[];
   }
 }
diff --git a/test/unit/server/soroban/simulate_transaction_test.js b/test/unit/server/soroban/simulate_transaction_test.js
@@ -32,6 +32,18 @@ describe("Server#simulateTransaction", async function (done) {
       retval: xdr.ScVal.fromXDR(simulationResponse.results[0].xdr, "base64"),
     },
     cost: simulationResponse.cost,
+    stateDiff: [{
+      type:1,
+      key: 'example-key',
+      before: new xdr.LedgerEntry({
+        lastModifiedLedgerSeq: 0,
+        ext: new xdr.LedgerEntryExt(0),
+      }),
+      after: new xdr.LedgerEntry({
+        lastModifiedLedgerSeq: 0,
+        ext: new xdr.LedgerEntryExt(0),
+      }),
+    }],
     _parsed: true,
   };
 
@@ -175,6 +187,7 @@ describe("Server#simulateTransaction", async function (done) {
     delete expected.cost;
     delete expected.transactionData;
     delete expected.minResourceFee;
+    delete expected.stateDiff
     expected.error = "This is an error";
     expected.events = [];
 
@@ -200,6 +213,7 @@ function cloneSimulation(sim) {
       retval: xdr.ScVal.fromXDR(sim.result.retval.toXDR()),
     },
     cost: sim.cost,
+    stateDiff: sim.stateDiff,
     _parsed: sim._parsed,
   };
 }
@@ -262,6 +276,19 @@ function baseSimulationResponse(results) {
       cpuInsns: "1",
       memBytes: "2",
     },
+    stateDiff:[{
+      type:1,
+      key: 'example-key',
+      before: new xdr.LedgerEntry({
+        lastModifiedLedgerSeq: 0,
+        ext: new xdr.LedgerEntryExt(0),
+      }).toXDR('base64'),
+      after: new xdr.LedgerEntry({
+        lastModifiedLedgerSeq: 0,
+        ext: new xdr.LedgerEntryExt(0),
+      }).toXDR('base64'),
+    }],
+
   };
 }