From 12d828188b3eb721d3b4d4c6f04812161efa029e Mon Sep 17 00:00:00 2001 From: Justin Starry Date: Thu, 1 Sep 2022 13:08:39 -0400 Subject: [PATCH] chore: add docs for simulation config parameters --- web3.js/src/connection.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/web3.js/src/connection.ts b/web3.js/src/connection.ts index a4631d2571fe66..5789b27f241aa0 100644 --- a/web3.js/src/connection.ts +++ b/web3.js/src/connection.ts @@ -803,13 +803,18 @@ export type TransactionReturnData = { }; export type SimulateTransactionConfig = { + /** Optional parameter used to enable signature verification before simulation */ sigVerify?: boolean; + /** Optional parameter used to replace the simulated transaction's recent blockhash with the latest blockhash */ replaceRecentBlockhash?: boolean; + /** Optional parameter used to set the commitment level when selecting the latest block */ commitment?: Commitment; + /** Optional parameter used to specify a list of account addresses to return post simulation state for */ accounts?: { encoding: 'base64'; addresses: string[]; }; + /** Optional parameter used to specify the minimum block slot that can be used for simulation */ minContextSlot?: number; };