docs for isContext cheatcode, verify with linked libraries and custom create2 (#1406)

add docs for isContext, note re verify with libraries and custom create2

Author: grandizzy

src/SUMMARY.md

@@ -446,6 +446,7 @@
       - [`stopAndReturnStateDiff`](./cheatcodes/stop-and-return-state-diff.md)
       - [`snapshotState`](./cheatcodes/state-snapshots.md)
       - [`snapshotGas`](./cheatcodes/gas-snapshots.md)
+      - [`isContext`](./cheatcodes/is-context.md)
     - [Assertions](./cheatcodes/assertions.md)
       - [`expectRevert`](./cheatcodes/expect-revert.md)
       - [`expectEmit`](./cheatcodes/expect-emit.md)

src/cheatcodes/environment.md

@@ -35,3 +35,4 @@
 - [`txGasPrice`](./tx-gas-price.md)
 - [`startStateDiffRecording`](./start-state-diff-recording.md)
 - [`stopAndReturnStateDiff`](./stop-and-return-state-diff.md)
+- [`isContext`](./is-context.md)

src/cheatcodes/is-context.md

@@ -0,0 +1,50 @@
+## `isContext`
+
+### Signature
+
+```solidity
+enum ForgeContext {
+    // Test group execution context (test, coverage or snapshot).
+    TestGroup,
+    // `forge test` execution context.
+    Test,
+    // `forge coverage` execution context.
+    Coverage,
+    // `forge snapshot` execution context.
+    Snapshot,
+    // Script group execution context (dry run, broadcast or resume).
+    ScriptGroup,
+    // `forge script` execution context.
+    ScriptDryRun,
+    // `forge script --broadcast` execution context.
+    ScriptBroadcast,
+    // `forge script --resume` execution context.
+    ScriptResume,
+    // Unknown `forge` execution context.
+    Unknown
+}
+
+function isContext(ForgeContext context) external view returns (bool result);
+```
+
+### Description
+
+Checks the current `forge` execution context.
+
+### Examples
+
+```solidity
+import {VmSafe} from "forge-std/Vm.sol";
+
+if (vm.isContext(VmSafe.ForgeContext.ScriptDryRun)) {
+    // execute specific script dry run logic
+}
+
+if (vm.isContext(VmSafe.ForgeContext.ScriptBroadcast)) {
+    // execute specific script broadcast logic
+}
+
+if (vm.isContext(VmSafe.ForgeContext.ScriptResume)) {
+    // execute specific script resume logic
+}
+```

src/forge/deploying.md

@@ -68,6 +68,7 @@ You must provide:
 
 Moreover, you may need to provide:
 - the constructor arguments in the ABI-encoded format, if there are any
+- external linked libraries in `src_file_path:library_name:library_address` format, if there are any
 - [compiler version](https://etherscan.io/solcversions) used for build, with 8 hex digits from the commit version prefix (the commit will usually not be a nightly build). It is auto-detected if not specified.
 - the number of optimizations, if the Solidity optimizer was activated.  It is auto-detected if not specified.
 - the [chain ID](https://evm-chainlist.netlify.app/), if the contract is not on Ethereum Mainnet
@@ -93,6 +94,15 @@ Submitted contract for verification:
                 url: https://sepolia.etherscan.io//address/0x6a54…3a4c#code
 ```
 
+> ℹ️  **Note:**
+> 
+> External libraries can be specified with `--libraries` argument, one for each linked library. For example, to verify a contract with two linked libraries (`Maths` and `Utils`) the `forge verify-command` should be run with 
+> ```bash
+> --libraries src/lib/Maths.sol:Maths:<maths_lib_address> \
+> --libraries src/lib/Utils.sol:Utils:<utils_lib_address>
+> ```
+> arguments.
+
 It is recommended to use the [`--watch`](../reference/forge/forge-verify-contract.md#verify-contract-options) flag along
 with `verify-contract` command in order to poll for the verification result.
 

src/output/hello_foundry/tree

@@ -140,6 +140,12 @@ rpc_endpoints = { optimism = "https://optimism.alchemyapi.io/v2/...", mainnet =
 #build_info_path = None
 # Whether to allow `expectRevert` for internal functions.
 allow_internal_expect_revert = false
+# Use the create 2 factory in all cases including tests and non-broadcasting scripts.
+always_use_create_2_factory = false
+# The CREATE2 deployer address to use.
+create2_deployer = "0x4e59b44847b379578588920ca78fbf26c0b4956c"
+# CREATE2 salt to use for the library deployment in scripts.
+create2_library_salt = "0x0000000000000000000000000000000000000000000000000000000000000000"
 
 [fmt]
 # Maximum line length where formatter will try to wrap the line

src/static/config.default.toml

@@ -9,7 +9,9 @@ This is in contrast to the `CREATE` opcode, where the address of the deployed co
  With `CREATE2`, you can use the same deployer account to deploy contracts to the same address across multiple networks, even if the address has varying nonces.
 
 > ℹ️ **Note**
->This guide is intended to help understand `CREATE2`. In most use cases, you won't need to write and use your own deployer, and can use an existing deterministic deployer. In forge scripts, using `new MyContract{salt: salt}()` will use the deterministic deployer at [0x4e59b44847b379578588920ca78fbf26c0b4956c](https://github.com/Arachnid/deterministic-deployment-proxy).
+> 
+> This guide is intended to help understand `CREATE2`. In most use cases, you won't need to write and use your own deployer, and can use an existing deterministic deployer. In forge scripts, using `new MyContract{salt: salt}()` will use by default the deterministic deployer at [0x4e59b44847b379578588920ca78fbf26c0b4956c](https://github.com/Arachnid/deterministic-deployment-proxy).  
+> A different deployer address can be configured by setting `create2_deployer` in `foundry.toml` or by using `--create2-deployer` argument.  
 
 In this tutorial, we will:
 

src/tutorials/create2-tutorial.md

@@ -15,6 +15,10 @@ Solidity scripts are like the scripts you write when working with tools like Har
 3. Broadcasting - Optional. If the `--broadcast` flag is provided and the previous phases have succeeded, it will broadcast the transactions collected at step `1`. and simulated at step `2`.
 4. Verification - Optional. If the `--verify` flag is provided, there's an API key, and the previous phases have succeeded it will attempt to verify the contract. (eg. etherscan).
 
+> 💡 Note:
+> 
+> Transactions that previously failed or timed-out can be submitted again by providing `--resume` flag.
+
 Given this flow, it's important to be aware that transactions whose behaviour can be influenced by external state/actors might have a different result than what was simulated on step `2`. Eg. frontrunning.
 
 ### Set Up
@@ -178,6 +182,10 @@ contract MyScript is Script {
 }
 ```
 
+> 💡 Note:
+> 
+> The `vm.isContext` cheatcode can be used to execute logic specific to script phases, by checking if context is one of `ForgeContext.ScriptDryRun`, `ForgeContext.ScriptBroadcast` or `ForgeContext.ScriptResume`.
+
 Now let’s read through the code and figure out what it actually means and does.
 
 ```solidity