Merge pull request #3102 from ethereum/integrations

updated external native Integrations
ethereum · Jul 21, 2022 · e6a5fca · e6a5fca
2 parents 21f679c + c67d0a1
commit e6a5fca
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 46 deletions.
diff --git a/docs/foundry.md b/docs/foundry.md
@@ -0,0 +1,40 @@
+Foundry
+============
+
+_(Supported since Remix IDE v0.25.0)_
+
+Foundry Provider
+------------------
+
+ **Foundry Provider** is a plugin on Remix IDE which enables users to deploy the contract to the Foundry's built-in **Anvil** blockchain. `Foundry Provider` can be chosen from the list of environments in `Deploy & Run Transactions` plugin.
+
+![](images/a-foundry-provider.png)
+
+As soon as you select `Foundry Provider`, a modal is opened asking for the `Anvil JSON-RPC Endpoint`.
+
+![](images/a-foundry-provider-modal.png)
+
+If Foundry Anvil node is running with default options, the default endpoint value in modal will not need any change. In case, Anvil node host and port are different, JSON-RPC endpoint should be updated in the modal text box.
+
+Once the correct endpoint is filled in the modal, just click on `OK` and the accounts from the Anvil node will be loaded in the `ACCOUNT` section. Network id will also be shown.
+
+![](images/a-foundry-provider-connected.png)
+
+Now, one can start deploying the contract from Remix IDE to the local Anvil node as usual.
+
+Foundry Remappings
+------------------
+
+Foundry manages dependencies using git submodules and can remap dependencies to make them easier to import. So import defined by remappings can have compilation errors on Remix IDE.
+
+To support such compilation, Remix suggests running [compilation using a compiler config file](https://remix-ide.readthedocs.io/en/latest/compile.html#json-file-for-compiler-configuration). Remix adds some default Forge remappings in the compiler config file when a Foundry project is loaded in Remix IDE using remixd.
+
+![](images/a-foundry-cc.png)
+
+Further, more remappings can be added manually, if required.
+
+
+
+
+
+
diff --git a/docs/hardhat.md b/docs/hardhat.md
@@ -1,4 +1,4 @@
-Hardhat Integration
+Hardhat
 ============
 
 _(Supported since Remix IDE v0.12.0 and Remixd v0.3.6)_
@@ -56,7 +56,7 @@ Hardhat Provider
 
 _In Hardhat, contracts are deployed by starting a local node. Read more about it in [Hardhat documentation](https://hardhat.org/getting-started/#connecting-a-wallet-or-dapp-to-hardhat-network)_
 
-**Hardhat Provider** is a plugin on Remix IDE which enables users to deploy the contract to the Hardhat 'localhost' network. This can be chosed from the `ENVIRONMENT` dropdown of `Deploy and Run Transactions` plugin.
+**Hardhat Provider** is a plugin on Remix IDE which enables users to deploy the contract to the Hardhat 'localhost' network. This can be chosen from the `ENVIRONMENT` dropdown of `Deploy and Run Transactions` plugin.
 
 ![](images/a-hardhat-provider-dropdown.png)
 
@@ -72,6 +72,33 @@ Once the correct endpoint is filled in the modal, just click on `OK` and the acc
 
 Now, one can start deploying the contract from Remix IDE to the Hardhat local node as usual.
 
+`console.log` in Remix IDE
+---------------------------
+
+_(Supported since Remix IDE v0.17.0)_
+
+Remix IDE supports hardhat console library while using `Remix VM`. It can be used while making a transaction or running unit tests.
+
+### Deploy and Run Transactions
+
+To try it out, you need to put an import statement and use `console.log` to print the value as shown in image.
+
+![](images/hardhat-console-file.png)
+
+Further, once you execute the `changeOwner` method, the value from console statement will be shown in Remix terminal after transaction details as below:
+
+![](images/hardhat-tx-terminal.png)
+
+### Solidity Unit Testing
+
+Similarly, `console.log` can be used while running unit tests using Remix Solidity Unit Testing plugin. See image below.
+
+![](images/hardhat-utesting-file.png)
+
+For the tests including logging message, it will display in the Remix Terminal corresponding to test name.
+
+![](images/hardhat-utesting-terminal.png)
+
 
 
 

diff --git a/docs/hardhat_console.md b/docs/hardhat_console.md
diff --git a/docs/images/a-foundry-cc.png b/docs/images/a-foundry-cc.png
diff --git a/docs/images/a-foundry-provider-connected.png b/docs/images/a-foundry-provider-connected.png
diff --git a/docs/images/a-foundry-provider-modal.png b/docs/images/a-foundry-provider-modal.png
diff --git a/docs/images/a-foundry-provider.png b/docs/images/a-foundry-provider.png
diff --git a/docs/images/a-hardhat-provider-dropdown.png b/docs/images/a-hardhat-provider-dropdown.png
diff --git a/docs/images/a-truffle-provider-modal.png b/docs/images/a-truffle-provider-modal.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -88,7 +88,7 @@ Useful links:
    hardhat
    truffle
    slither
-   hardhat_console
+   foundry
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/slither.md b/docs/slither.md
@@ -1,4 +1,4 @@
-Slither Integration
+Slither
 ============
 
 _(Supported since Remix IDE v0.15.0 and Remixd v0.5.0)_

diff --git a/docs/truffle.md b/docs/truffle.md
@@ -1,4 +1,4 @@
-Truffle Integration
+Truffle
 ============
 
 _(Supported since Remix IDE v0.23.0 and Remixd v0.6.0)_