Add tools/foundry subchapter #1151
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for oasisprotocol-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
matevz
reviewed
Feb 20, 2025
rube-de
reviewed
Feb 20, 2025
matevz
reviewed
Feb 21, 2025
There was a problem hiding this comment.
Also mention the forge verify command they can use after the contract is deployed. Details are on the Contract verification page.
ZigaMr
force-pushed
the
ZigaMr/foundry-docs
branch
from
d082058 to
af86c0a
Compare
matevz
reviewed
Feb 24, 2025
matevz
reviewed
Mar 3, 2025
|
|
||
| ## Setup and Configuration | ||
|
|
||
| Foundry uses default revm EVM implementation which does not contain |
There was a problem hiding this comment.
Let's move this paragraph under the Installing Sapphire Foundry (Optional) section.
Also:
Suggested change
| Foundry uses default revm EVM implementation which does not contain | |
| Foundry uses [revm] EVM implementation which does not contain |
and below:
[revm]: https://github.com/bluealloy/revm
Comment on lines
+46
to
+48
| **Sapphire Contracts** package is also provided. It contains | ||
| helper solidity contracts and libraries that enable convenient access to | ||
| on-chain data and precompiles (rng, signatures, on-chain encryption, etc.). |
There was a problem hiding this comment.
Let's move this under step 3. below.
| package using Foundry package manager [soldeer]: | ||
|
|
||
| ```shell | ||
| forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11 |
There was a problem hiding this comment.
The version could be omitted right?
Suggested change
| forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11 | |
| forge soldeer install @oasisprotocol-sapphire-contracts |
| 1. Install the **Sapphire Foundry** soldeer package: | ||
|
|
||
| ```shell | ||
| forge soldeer install @oasisprotocol-sapphire-foundry~0.1.0 |
There was a problem hiding this comment.
Suggested change
| forge soldeer install @oasisprotocol-sapphire-foundry~0.1.0 | |
| forge soldeer install @oasisprotocol-sapphire-foundry |
| forge soldeer install @oasisprotocol-sapphire-foundry~0.1.0 | ||
| ``` | ||
|
|
||
| 2. Add `ffi = true` to your foundry.toml file: |
There was a problem hiding this comment.
Suggested change
| 2. Add `ffi = true` to your foundry.toml file: | |
| 2. Add `ffi = true` to your `foundry.toml` file: |
Comment on lines
+87
to
+89
| 3. Your foundry.toml file should now look like this: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Let's merge 2. and 3.:
Suggested change
| 3. Your foundry.toml file should now look like this: | |
| ```toml | |
| ```toml title="foundry.toml" |
Comment on lines
+148
to
+151
| ``` | ||
| and then inherit from `SapphireTest` from `BaseSapphireTest.sol` | ||
| and override the `setUp()` function: | ||
| ```solidity |
There was a problem hiding this comment.
Suggested change
| ``` | |
| and then inherit from `SapphireTest` from `BaseSapphireTest.sol` | |
| and override the `setUp()` function: | |
| ```solidity | |
| ``` | |
| and then inherit from `SapphireTest` from `BaseSapphireTest.sol` | |
| and override the `setUp()` function: | |
| ```solidity |
|
|
||
| Forge scripts should run the same way as tests. | ||
|
|
||
| ## A note on Forks/External RPC nodes |
There was a problem hiding this comment.
Suggested change
| ## A note on Forks/External RPC nodes | |
| ## A Note on Forks/External RPC Nodes |
matevz
reviewed
Mar 3, 2025
| cargo +nightly build --release | ||
| ``` | ||
|
|
||
| ## Sapphire specific features |
There was a problem hiding this comment.
Suggested change
| ## Sapphire specific features | |
| ## Sapphire-specific tests |
| The `@oasisprotocol-sapphire-foundry` package enables | ||
| testing with precompiles and encrypted calls. | ||
|
|
||
| #### Precompiles |
There was a problem hiding this comment.
Suggested change
| #### Precompiles | |
| ### Precompiles |
| } | ||
| ``` | ||
|
|
||
| #### Encrypted Transactions and Calls |
There was a problem hiding this comment.
Suggested change
| #### Encrypted Transactions and Calls | |
| ### Encrypted Transactions and Calls |
| 3. `vm.broadcastRawTransaction(raw_tx)` to send the raw transaction. | ||
|
|
||
|
|
||
| ### Forge Tests |
There was a problem hiding this comment.
Suggested change
| ### Forge Tests | |
| ### `forge test` |
|
|
||
| [foundry-example]: https://github.com/oasisprotocol/sapphire-paratime/tree/main/examples/foundry | ||
|
|
||
| ### Forge Script |
There was a problem hiding this comment.
Suggested change
| ### Forge Script | |
| ### `forge script` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds foundry subchapter to tools.