Skip to content

Commit

Permalink
Merge branch 'main' into ISC/updateNetworkInfo
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Apr 30, 2024
2 parents 6966983 + 0a51d5e commit 8dd2086
Show file tree
Hide file tree
Showing 14 changed files with 219 additions and 177 deletions.
19 changes: 19 additions & 0 deletions docs/build/_partials/_metamask_buttons.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { AddToMetaMaskButton } from '@theme/AddToMetaMaskButton';
import { Networks } from '@theme/constant';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs groupId='network'>
<TabItem value='iota' label='IOTA EVM'>
<AddToMetaMaskButton {...Networks['iota']}/>
</TabItem>
<TabItem value='iota_testnet' label='IOTA EVM Testnet'>
<AddToMetaMaskButton {...Networks['iota_testnet']}/>
</TabItem>
<TabItem value='shimmer' label='ShimmerEVM'>
<AddToMetaMaskButton {...Networks['shimmer']}/>
</TabItem>
<TabItem value='shimmer_testnet' label='ShimmerEVM Testnet'>
<AddToMetaMaskButton {...Networks['shimmer_testnet']}/>
</TabItem>
</Tabs>
6 changes: 3 additions & 3 deletions docs/build/getting-started/networks-endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ This network runs under a [Coordinator PoA scheme](/learn/protocols/coordinator/

<NetworkInfo.L1 {...Networks['iota']}/>

### IotaEVM
### IOTA EVM

[IotaEVM](https://explorer.evm.iota.org) is the L2 EVM running on top of the IOTA network.
[IOTA EVM](https://explorer.evm.iota.org) is the L2 EVM running on top of the IOTA network.

<AddToMetaMaskButton {...Networks['iota']} />

Expand All @@ -62,7 +62,7 @@ This network is subject to occasional resets (no data retention) which are usual

<NetworkInfo.L1 {...Networks['iota_testnet']} />

### IotaEVM Testnet
### IOTA EVM Testnet

[IOTA EVM Testnet](https://explorer.evm.testnet.iotaledger.net) is the L2 EVM running on top of the IOTA Testnet network.

Expand Down
67 changes: 67 additions & 0 deletions docs/build/isc/v1.0.0-rc.6/docs/_partials/_hardhat_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import CodeBlock from '@theme/CodeBlock';
import { Networks } from '@theme/constant';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs groupId='network'>
<TabItem value='iota_testnet' label='IOTA EVM Testnet'>

<CodeBlock language="js">
{`
networks: {
'iotaevm-testnet': {
url: '${Networks['iota_testnet'].evm.rpcUrls[0]}',
chainId: ${parseInt(Networks['iota_testnet'].evm.chainId)},
accounts: [YOUR PRIVATE KEY],
},
}
`}
</CodeBlock>

</TabItem>
<TabItem value='shimmer_testnet' label='ShimmerEVM Testnet'>

<CodeBlock language="js">
{`
networks: {
'shimmerevm-testnet': {
url: '${Networks['shimmer_testnet'].evm.rpcUrls[0]}',
chainId: ${parseInt(Networks['shimmer_testnet'].evm.chainId)},
accounts: [YOUR PRIVATE KEY],
},
}
`}
</CodeBlock>

</TabItem>
<TabItem value='iota_testnet' label='IOTA EVM Testnet'>

<CodeBlock language="js">
{`
networks: {
'iotaevm-testnet': {
url: '${Networks['iota_testnet'].evm.rpcUrls[0]}',
chainId: ${parseInt(Networks['iota_testnet'].evm.chainId)},
accounts: [YOUR PRIVATE KEY],
},
}
`}
</CodeBlock>

</TabItem>
<TabItem value='shimmer' label='ShimmerEVM'>

<CodeBlock language="js">
{`
networks: {
'shimmerevm': {
url: '${Networks['shimmer'].evm.rpcUrls[0]}',
chainId: ${parseInt(Networks['shimmer'].evm.chainId)},
accounts: [YOUR PRIVATE KEY],
},
}
`}
</CodeBlock>

</TabItem>
</Tabs>
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Here are some of the most important properties and limitations of EVM support in

There is no guaranteed _block time_. A new EVM "block" will be created only when an ISC block is created, and ISC does
not enforce an average block time. This means that block times are variable; a new block will be created as soon as needed.
The average block time on [IotaEVM](/build/networks-endpoints#iotaevm) and [ShimmerEVM](/build/networks-endpoints#shimmerevm)
The average block time on [IOTA EVM](/build/networks-endpoints#iotaevm) and [ShimmerEVM](/build/networks-endpoints#shimmerevm)
is 2.8 seconds.

### The Magic Contract
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,31 @@ import { Networks } from '@theme/constant';
import NetworkInfo from '@theme/NetworkInfo';

# Networks & Chains
## IOTA EVM Testnet

## IotaEVM
<AddToMetaMaskButton {...Networks['shimmer_testnet']} />

[The IOTA EVM Testnet](https://explorer.evm.testnet.iotaledger.net/) runs as a layer 2 on top
of the [IOTA Testnet](/build/networks-endpoints#iota-testnet). This network uses ISC to facilitate
an Ethereum Virtual Machine and has an enshrined bridge to layer 1.

:::info

This network is subject to occasional resets (no data retention) which are usually announced with a one-week grace period.

:::

<NetworkInfo.Evm {...Networks['shimmer_testnet']} />

:::note

[IotaEVM](https://explorer.evm.iota.org) is the L2 EVM running on top of the IOTA network.
The other values (network name and currency symbol) can be whatever value you like.

:::

## IOTA EVM

[IOTA EVM](https://explorer.evm.iota.org) is the L2 EVM running on top of the IOTA network.

<AddToMetaMaskButton {...Networks['iota']} />

Expand All @@ -26,12 +47,37 @@ import NetworkInfo from '@theme/NetworkInfo';

<NetworkInfo.EvmCustom {...Networks['iota']}/>

## IotaEVM Testnet
## IOTA EVM Testnet

<AddToMetaMaskButton {...Networks['shimmer_testnet']} />
<AddToMetaMaskButton {...Networks['iota_testnet']} />

[The IotaEVM Testnet](https://explorer.evm.testnet.iotaledger.net/) runs as a layer 2 on top
[The IOTA EVM Testnet](https://explorer.evm.testnet.iotaledger.net/) runs as a layer 2 on top
of the [IOTA Testnet](/build/networks-endpoints#iota-testnet). This network uses ISC to facilitate

:::info

This network is subject to occasional resets (no data retention) which are usually announced with a one-week grace period.

:::

<NetworkInfo.Evm {...Networks['iota_testnet']} />

:::note

The other values (network name and currency symbol) can be whatever value you like.

:::

### Additional Info

<NetworkInfo.EvmCustom {...Networks['iota_testnet']}/>

## ShimmerEVM Testnet

<AddToMetaMaskButton {...Networks['shimmer_testnet']} />

[The ShimmerEVM Testnet](https://explorer.evm.testnet.shimmer.network/) runs as a layer 2 on top
of the [Shimmer Testnet](/build/networks-endpoints#shimmer-testnet). This network uses ISC to facilitate
an Ethereum Virtual Machine and has an enshrined bridge to layer 1.

:::info
Expand Down Expand Up @@ -92,6 +138,6 @@ The other values (network name and currency symbol) can be whatever value you li

## Core Contracts

[IotaEVM](#iotaEVM), [ShimmerEVM](#shimmerEVM) and the testnet networks have 7
[IOTA EVM](#IOTAEVM), [ShimmerEVM](#shimmerEVM) and the testnet networks have 7
[core contracts](../reference/core-contracts/overview.md) deployed, as well as the
[Magic Contract](../reference/magic-contract/introduction.md).
49 changes: 33 additions & 16 deletions docs/build/isc/v1.0.0-rc.6/docs/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,16 @@ tags:
- RPC
---

import { AddToMetaMaskButton } from '@theme/AddToMetaMaskButton';
import MetamaskButtons from '../../../../_partials/_metamask_buttons.mdx';
import NetworkInfo from '@theme/NetworkInfo';
import { Networks } from '@theme/constant';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Link from '@docusaurus/Link';

# EVM Testnet Quickstart Guide
# EVM Testnets Quickstart Guide

This guide will help you quickly get started with the [EVM Testnet](/build/networks-endpoints/#shimmerevm-testnet), where you can deploy and interact with EVM-compatible smart contracts.
This guide will help you quickly get started with our [EVM Testnets](/build/networks-endpoints), where you can deploy and interact with EVM-compatible smart contracts.

## Prerequisites

Expand All @@ -28,29 +32,35 @@ This guide will help you quickly get started with the [EVM Testnet](/build/netwo

Click this button:

<AddToMetaMaskButton {...Networks['shimmer_testnet']} />
<MetamaskButtons/>

:::tip

Please read [the MetaMask section in the tools guide](tools.mdx#metamask) for a detailed guide.

:::

## Get Testnet SMR Tokens
## Get Testnet Tokens

:::tip ShimmerEVM
:::tip Fund your testnet account

If you want to fund your IotaEVM or ShimmerEVM accounts, please refer to our [How To Get Funds guide](../how-tos/send-funds-from-L1-to-L2.mdx).
If you want to fund your EVM testnet account, please refer to our [How To Get Funds guide](../how-tos/send-funds-from-L1-to-L2.mdx).

:::

1. Go to the [EVM Testnet Toolkit](https://evm-toolkit.evm.testnet.shimmer.network/).
1. Go to the [IOTA EVM](https://evm-toolkit.evm.testnet.iotaledger.net) or [ShimmerEVM](https://evm-toolkit.evm.testnet.shimmer.network/) Testnet Toolkit.
2. Connect your MetaMask wallet by clicking "Connect Wallet" or paste an EVM address.
3. Select the account you want to receive testnet SMR tokens.
4. Click "Send funds" to get testnet SMR tokens.
3. Select the account you want to receive testnet tokens.
4. Click "Send funds" to get testnet tokens.

## Get Simulated Bridged Tokens

:::info ShimmerEVM Testnet

The simulated bridged tokens are currently only available on the ShimmerEVM Testnet.

:::

1. Go to the [ERC20 Simulated Token Faucet](https://evm-faucet.testnet.shimmer.network/).
2. Connect your MetaMask wallet by clicking "Connect Wallet".
3. Select the account you want to receive simulated bridged tokens.
Expand All @@ -59,17 +69,24 @@ If you want to fund your IotaEVM or ShimmerEVM accounts, please refer to our [Ho

## Deploy and Interact with Smart Contracts

You can now use your testnet SMR tokens and simulated bridged tokens to deploy and interact with smart contracts on the [EVM Testnets](/build/networks-endpoints). Utilize popular development tools and frameworks, such as [Hardhat](https://hardhat.org/), or [Remix](https://remix.ethereum.org/), to build, test, and deploy your smart contracts.
You can now use your testnet tokens and simulated bridged tokens to deploy and interact with smart contracts on the testnets. Utilize popular development tools and frameworks, such as [Hardhat](https://hardhat.org/), or [Remix](https://remix.ethereum.org/), to build, test, and deploy your smart contracts.

## Explore the EVM Testnet

Visit the [EVM Testnet Block Explorer](https://explorer.evm.testnet.shimmer.network/) to monitor the chain, track transactions, and explore deployed smart contracts.
Visit the corresponding Testnet Block Explorer to monitor the chain, track transactions, and explore deployed smart contracts.

<Tabs groupId='network'>
<TabItem value='iotaEVMTestnet' label='IOTA EVM Testnet'>
<Link to={Networks['iota_testnet'].evm.blockExplorerUrls[0]}>Explorer</Link>
</TabItem>
<TabItem value='shimmerEVMTestnet' label='ShimmerEVM Testnet'>
<Link to={Networks['shimmer_testnet'].evm.blockExplorerUrls[0]}>Explorer</Link>
</TabItem>
</Tabs>

## Additional Resources

- [GitHub issues page for Wasp](https://github.com/iotaledger/wasp/issues)
- [EVM toolkit](https://evm-toolkit.evm.testnet.shimmer.network/)
- [ERC20 simulated token faucet](https://evm-faucet.testnet.shimmer.network)
- [Firefly Shimmer](https://firefly.iota.org)
- [Firefly](https://firefly.iota.org)

With this quickstart guide, you should now be able to set up and start exploring the [EVM Testnet](/build/networks-endpoints). As you begin to deploy and interact with smart contracts, remember to provide feedback on any issues or improvements you discover to help make the IotaEVM and ShimmerEVM even better. Happy developing!
With this quickstart guide, you should now be able to set up and start exploring the [Testnet](/build/networks-endpoints). As you begin to deploy and interact with smart contracts, remember to provide feedback on any issues or improvements you discover to help make our EVM even better. Happy developing!
Loading

0 comments on commit 8dd2086

Please sign in to comment.