Add tools/foundry subchapter #1151

ZigaMr · 2025-02-20T12:41:48Z

This PR adds foundry subchapter to tools.

netlify · 2025-02-20T12:51:25Z

✅ Deploy Preview for oasisprotocol-docs ready!

Name	Link
🔨 Latest commit	`1be90bf`
🔍 Latest deploy log	https://app.netlify.com/sites/oasisprotocol-docs/deploys/67cb4a3099068d00083c76cb
😎 Deploy Preview	https://deploy-preview-1151--oasisprotocol-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/build/tools/foundry.mdx

matevz

Also mention the forge verify command they can use after the contract is deployed. Details are on the Contract verification page.

docs/build/tools/foundry.mdx

… structure

docs/build/tools/foundry.mdx

matevz · 2025-03-03T15:46:26Z

docs/build/tools/foundry.mdx

+package using Foundry package manager [soldeer]:
+
+   ```shell
+   forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11


The version could be omitted right?

Suggested change

forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11

forge soldeer install @oasisprotocol-sapphire-contracts

I couldn't find a way to make it work without specifying version. The suggested change returns an error, and in soldeer/foundry docs, version is always mentioned.

Yes, Soldeer needs a version, there is nothing similar like @latest
To omit the version in the cmd line, the foundry.toml would to be updated first with the dependencies, then you could use forge soldeer install.

Since these are step-by-step instructions I think it's better to leave it as is. forge soldeer install shortcut and foundry.toml are already mentioned in the later section.

docs/build/tools/foundry.mdx

matevz

A few more suggestions.

docs/build/tools/foundry.mdx

rube-de · 2025-02-25T09:27:26Z

docs/build/tools/foundry.mdx

+
+```toml
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib", "dependencies"]
+ffi = true
+
+[dependencies]
+"@oasisprotocol-sapphire-contracts" = "0.2.11"
+"@oasisprotocol-sapphire-foundry" = "0.1.0"
+```


Suggested change

```toml

[profile.default]

src = "src"

out = "out"

libs = ["lib", "dependencies"]

ffi = true

[dependencies]

"@oasisprotocol-sapphire-contracts" = "0.2.11"

"@oasisprotocol-sapphire-foundry" = "0.1.0"

```

```toml title="foundry.toml"

[profile.default]

src = "src"

out = "out"

libs = ["lib", "dependencies"]

// highlight-start

ffi = true

[dependencies]

"@oasisprotocol-sapphire-contracts" = "0.2.11"

"@oasisprotocol-sapphire-foundry" = "0.1.0"

// highlight-end

Added highlighting.

rube-de · 2025-02-25T09:28:16Z

docs/build/tools/foundry.mdx

+- `ffi = true` enables `vm.ffi()` ([foreign function interface]) which is used to call rust bindings
+which contain the precompile and decryption logic.
+
+- `"dependencies"` is a list of dependencies that are required for the project.
+We use Foundry package manager [soldeer] to install these dependencies.


Suggested change

- `ffi = true` enables `vm.ffi()` ([foreign function interface]) which is used to call rust bindings

which contain the precompile and decryption logic.

- `"dependencies"` is a list of dependencies that are required for the project.

We use Foundry package manager [soldeer] to install these dependencies.

- `ffi = true` enables `vm.ffi()` ([foreign function interface]) which is used to call rust bindings

which contain the precompile and decryption logic.

- `"dependencies"` is a list of dependencies that are required for the project.

We use Foundry package manager [soldeer] to install these dependencies.

Added indentation.

docs/build/tools/foundry.mdx

rube-de · 2025-03-05T16:38:52Z

docs/build/tools/foundry.mdx

+package using Foundry package manager [soldeer]:
+
+   ```shell
+   forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11


Yes, Soldeer needs a version, there is nothing similar like @latest
To omit the version in the cmd line, the foundry.toml would to be updated first with the dependencies, then you could use forge soldeer install.

rube-de · 2025-03-05T16:41:47Z

docs/build/tools/foundry.mdx

+helper solidity contracts and libraries that enable convenient access to
+on-chain data and precompiles (rng, signatures, on-chain encryption, etc.).
+After intializing the project, we can install the **Sapphire Contracts**
+package using Foundry package manager [soldeer]:


Suggested change

package using Foundry package manager [soldeer]:

package using Foundry package manager [Soldeer]:

nitpick - lets keep product names capitalized

rube-de · 2025-03-05T18:00:48Z

docs/build/tools/foundry.mdx

+available in the default revm.
+When using `forge script` on an external RPC node or a fork,
+precompiles are available through the `vm.rpcUrl()` cheatcode.
+To disable simulation on integrated revm make sure to disable


I'm a bit confused, does simulation make sense with Sapphire?
At what point you wouldn't use --no-simulation?
If you use forge script without an external RPC, how do you use the precompiles?

rube-de · 2025-03-05T18:01:31Z

docs/build/tools/foundry.mdx

+## Verification with Foundry
+
+After contracts are deployed, you can verify them with Sourcify.
+Check out the [verification with foundry] section for more details.


Suggested change

Check out the [verification with foundry] section for more details.

Check out the [Verification with Foundry] section for more details.

nitpick - keep capitalization like in the header

rube-de · 2025-03-05T18:02:08Z

docs/build/tools/foundry.mdx

+[gasless transactions]: ../sapphire/develop/gasless
+[key]: ../sapphire/develop/concept
+[examples/foundry]: https://github.com/oasisprotocol/sapphire-paratime/tree/main/examples/foundry
+[verification with foundry]: ./verification/#verification-with-foundry


Suggested change

[verification with foundry]: ./verification/#verification-with-foundry

[Verification with Foundry]: ./verification/#verification-with-foundry

rube-de · 2025-03-05T18:02:18Z

docs/build/tools/foundry.mdx

+[examples/foundry]: https://github.com/oasisprotocol/sapphire-paratime/tree/main/examples/foundry
+[verification with foundry]: ./verification/#verification-with-foundry
+[foreign function interface]: https://book.getfoundry.sh/cheatcodes/ffi
+[soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager


Suggested change

[soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager

[Soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager

rube-de · 2025-03-05T18:02:29Z

docs/build/tools/foundry.mdx

+[foreign function interface]: https://book.getfoundry.sh/cheatcodes/ffi
+[soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager
+[Oasis Web3 gateway]: ../../node/web3.mdx
+[revm]: https://github.com/bluealloy/revm


Suggested change

[revm]: https://github.com/bluealloy/revm

[Revm]: https://github.com/bluealloy/revm

Add tools/foundry subchapter

9cc73c3

ZigaMr requested review from matevz and rube-de February 20, 2025 12:42

matevz reviewed Feb 20, 2025

View reviewed changes

rube-de reviewed Feb 20, 2025

View reviewed changes

matevz reviewed Feb 21, 2025

View reviewed changes

Add suggested changes, add foundry Card to develop subchapter

af86c0a

ZigaMr force-pushed the ZigaMr/foundry-docs branch from d082058 to af86c0a Compare February 24, 2025 13:08

ZigaMr added 3 commits February 24, 2025 14:49

Add rust nightly description

bf53c23

Remove ffi bullet point

9869ba2

Format foundry.mdx

c5f8764

matevz reviewed Feb 24, 2025

View reviewed changes

Add optional subsection for sapphire-foundry, update chisel desc, fix…

b010a8b

… structure

matevz reviewed Mar 3, 2025

View reviewed changes

Aesthetic changes

6e4711a

rube-de reviewed Mar 5, 2025

View reviewed changes

Improve Fork section, add suggested changes to capitalization

1be90bf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tools/foundry subchapter #1151

Add tools/foundry subchapter #1151

ZigaMr commented Feb 20, 2025

netlify bot commented Feb 20, 2025 •

edited

Loading

matevz left a comment

matevz Mar 3, 2025

ZigaMr Mar 5, 2025

rube-de Mar 5, 2025

ZigaMr Mar 7, 2025

matevz left a comment

rube-de Feb 25, 2025

ZigaMr Mar 7, 2025

rube-de Feb 25, 2025

ZigaMr Mar 7, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

rube-de Mar 5, 2025

	forge soldeer install @oasisprotocol-sapphire-contracts~0.2.11
	forge soldeer install @oasisprotocol-sapphire-contracts

	package using Foundry package manager [soldeer]:
	package using Foundry package manager [Soldeer]:

	Check out the [verification with foundry] section for more details.
	Check out the [Verification with Foundry] section for more details.

	[verification with foundry]: ./verification/#verification-with-foundry
	[Verification with Foundry]: ./verification/#verification-with-foundry

	[soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager
	[Soldeer]: https://book.getfoundry.sh/projects/soldeer?highlight=soldeer#soldeer-as-a-package-manager

	[revm]: https://github.com/bluealloy/revm
	[Revm]: https://github.com/bluealloy/revm

Add tools/foundry subchapter #1151

Are you sure you want to change the base?

Add tools/foundry subchapter #1151

Conversation

ZigaMr commented Feb 20, 2025

netlify bot commented Feb 20, 2025 • edited Loading

✅ Deploy Preview for oasisprotocol-docs ready!

matevz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matevz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Feb 20, 2025 •

edited

Loading