Skip to content

docs: document vm.prompt double display with external library linking… #1764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
awixor wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document vm.prompt double display with external library linking… #1764

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/pages/reference/cheatcodes/prompt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Displays an interactive prompt to the user for inserting arbitrary data.
### Parameters

| Parameter | Type | Description |
|--------------|----------|---------------------------------|
| ------------ | -------- | ------------------------------- |
| `promptText` | `string` | The text to display to the user |

### Returns

| Type | Description |
|-----------|----------------------------------------------|
| `string` | The user's input (for `prompt` and `promptSecret`) |
| Type | Description |
| --------- | -------------------------------------------------------- |
| `string` | The user's input (for `prompt` and `promptSecret`) |
| `uint256` | The user's input parsed as uint (for `promptSecretUint`) |

### Configuration
Expand Down Expand Up @@ -120,6 +120,10 @@ This cheatcode is meant to be used in scripts, not tests. It also reverts when r
Follow the best practices above for testing scripts that use `vm.prompt` and handling timeouts, since scripts might otherwise hang or revert.
:::

:::note
When a `forge script` deploys a contract that requires **external library linking**, `vm.prompt` will display the same prompt **twice**. This happens because Foundry runs the script twice internally — once for simulation and once for broadcast — and each run triggers the prompt independently. To work around this, consider passing values as script arguments or reading from environment variables with [`vm.envString`](/reference/cheatcodes/env-string) instead of using `vm.prompt` in scripts that link against external libraries.
:::

### Related Cheatcodes

- [`parseUint`](/reference/cheatcodes/parse-uint) - Parse string to uint
Expand Down