(core) add gasEstimate field to PreSignOperation (#587)

* add gasEstimate field to PreSignOperation * add gasEstimate field to PreSignOperation * changeset * rename field to `gasFeeEstimate` * fix unit test
nocturne-xyz · Nov 10, 2023 · 4070b15 · 4070b15
1 parent 94bb921
commit 4070b15
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/.changeset/sweet-trainers-wink.md b/.changeset/sweet-trainers-wink.md
@@ -0,0 +1,5 @@
+---
+"@nocturne-xyz/core": patch
+---
+
+add `gasEstimate` to `PreSignOperation`
diff --git a/packages/client/src/prepareOperation.ts b/packages/client/src/prepareOperation.ts
@@ -93,6 +93,9 @@ export async function prepareOperation(
     gasPrice: opRequest.gasPrice,
     deadline,
     atomicActions: true, // always default to atomic until we find reason not to
+
+    // TODO: add actual estimate here
+    gasFeeEstimate: opRequest.gasAssetRefundThreshold,
   };
 
   return op;

diff --git a/packages/client/test/utils.ts b/packages/client/test/utils.ts
@@ -287,6 +287,7 @@ export function dummyOp(
     deadline: 0n,
     atomicActions: false,
     joinSplits,
+    gasFeeEstimate: 0n,
   };
 }
 

diff --git a/packages/core/src/primitives/types.ts b/packages/core/src/primitives/types.ts
@@ -138,6 +138,11 @@ export interface BaseOperation {
 
 export interface PreSignOperation extends BaseOperation {
   joinSplits: PreSignJoinSplit[];
+
+  // gas fee estimate for the operation denominated in `encodedGasAsset`
+  // this is passed along to the snap so the user can see how much gas
+  // they will front for the operation
+  gasFeeEstimate: bigint;
 }
 
 export interface SignedOperation extends BaseOperation {