add comments to txOptions (#188)

storyprotocol · May 15, 2024 · 0f87ed6 · 0f87ed6
1 parent 15c74d8
commit 0f87ed6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/core-sdk/src/types/options.ts b/packages/core-sdk/src/types/options.ts
@@ -1,7 +1,14 @@
 export type TxOptions = {
+  // Whether or not to wait for the transaction so you
+  // can receive a transaction receipt in return (which
+  // contains data about the transaction and return values).
   waitForTransaction?: boolean;
+  // The price (in wei) to pay per gas.
   gasPrice?: bigint;
+  // Total fee per gas (in wei).
   maxFeePerGas?: bigint;
+  // The number of confirmations (blocks that have passed)
+  // to wait before resolving.
   numBlockConfirmations?: number;
 };