Remix
Overview¶
This tutorial guides you to implement a Hello World dApp which echoes a message passed to the contract on to the frontend. You can also change the message using the interactive panel.
Recommended
We recommend you to follow this tutorial using the online IDE available at Remix IDE. Remix IDE is an easy-to-use platform that does not require any downloads, creating accounts, or logins.
What you will do¶
- Create a file on Remix.
- Upload a pre-built smart contract into the IDE.
- Compile the smart contract.
- Connect the application to the Polygon Amoy testnet via MetaMask.
- Deploy the smart contract.
- Verify the smart contract.
Getting started with Remix IDE¶
Remix is a Ethereum-focused IDE: an online platform to develop and deploy smart contracts. To start building a smart contract, click on New File and name it HelloWorld.sol
.
Smart contract¶
Copy and paste the smart contract code provided below into the newly created HelloWorld.sol
file.
// Specifies that the source code is for a version
// of Solidity greater than 0.5.10
pragma solidity ^0.5.10;
// A contract is a collection of functions and data (its state)
// that resides at a specific address on the Ethereum blockchain.
contract HelloWorld {
// The keyword "public" makes variables accessible from outside a contract
// and creates a function that other contracts or SDKs can call to access the value
string public message;
// A special function only run during the creation of the contract
constructor(string memory initMessage) public {
// Takes a string value and stores the value in the memory data storage area,
// setting `message` to that value
message = initMessage;
}
// A publicly accessible function that takes a string as a parameter
// and updates `message`
function update(string memory newMessage) public {
message = newMessage;
}
}
The first line pragma solidity ^0.5.10
specifies that the source code is for a Solidity version greater than 0.5.10. Pragmas are common instructions for compilers about how to treat the source code (e.g., pragma once).
A contract in the sense of Solidity is a collection of code (its functions) and data (its state) that resides at a specific address on the Ethereum blockchain. The line string public message
declares a public state variable called message
of type string
. You can think of it as a single slot in a database that you can query and alter by calling functions of the code that manages the database. The keyword public
automatically generates a function that allows you to access the current value of the state variable from outside of the contract. Without this keyword, other contracts have no way to access the variable.
The constructor is a special function run during the creation of the contract and cannot be called afterward. In this case, it takes a string value initMessage
, stores the value in the memory data storage area, and sets message
to that value.
The update
function is another public function that is similar to the constructor, taking a string as a parameter, and updating the message
variable.
Compile smart contract¶
-
Go to the Solidity Compiler tab (below the search button)
-
Select compiler version to 0.5.10
-
Now, compile
HelloWorld.sol
-
After successful compilation, it will show a green tick mark on the Compiler tab button
Deploying to the Amoy testnet¶
Now, we have to deploy our smart contract on Amoy, the Polygon testnet. Not only does it cost money (e.g., gas fees) to deploy a smart contract on Polygon mainnet, but the contract is immutable and can’t be changed once deployed. Therefore, it’s best to deploy your smart contract to the testnet first.
To deploy to the Amoy testnet, we have to connect to the web3 with a service like MetaMask, Brave, Portis, etc. We use MetaMask in this tutorial. Please follow this guide to set up a MetaMask account.
-
Open Metamask. Click on the network dropdown menu (set to Ethereum Mainnet by default) and click on the Add Network button. MaticVigil provides a public endpoint and is rate-limited. Therefore, most developers use a free blockchain provider like Alchemy or Quicknode to have a dedicated RPC endpoint with faster throughput AKA computing units per second (CUPs). You need to create a free account to get your private API key from one of these providers to put into the dedicated RPC endpoint URL below.
- Network: Polygon Amoy testnet
- RPC URL (public endpoint): https://rpc-amoy.polygon.technology/.
- RPC URL (dedicated endpoint): https://polygon-amoy.g.alchemy.com/v2/{your-api-key}. You need a free API key
- Chain ID: 80002
- Currency Symbol: MATIC
- Block explorer URL: https://amoy.polygonscan.com/
-
Go ahead and click Save
-
Copy your wallet address from MetaMask by clicking over your account name
-
Head over to the faucet and request test MATIC to pay for gas on the Polygon network. Select Amoy as the network and MATIC Token as the token in the faucet. You can also use the Alchemy Amoy faucet.
-
Finally, to deploy to Amoy, refer to the instructions in the Remix deployment section below.
Deploying to Polygon mainnet¶
After deploying on Amoy without any errors, you can deploy the smart contract on the Polygon mainnet. Remember this costs real $ in the form of MATIC tokens.
- Open your MetaMask wallet.
- Click on the network dropdown menu (set to Ethereum Mainnet by default) and click on the Add Network button.
-
Make sure to have your Alchemy API key to hand.
-
Add the info:
- Network Name: Polygon Mainnet
- New RPC URL: https://polygon-mainnet.g.alchemy.com/v2/{your-api-key}
- Chain ID: 137
- Currency Symbol: MATIC
- Block Explorer URL: https://polygonscan.com/
-
Go ahead and click Save
-
Copy your wallet address from MetaMask by clicking over your account name
-
Make sure your MetaMask wallet has MATIC tokens to pay the deployment’s gas fees.
Remix deployment¶
In both Testnet and Mainnet, you do the below to deploy your smart contract using Remix. The below step will use the connect MetaMask API keys you set up in the previous steps.
- Select Injected Provider MetaMask in the Environment dropdown and your contract
-
Accept the Connect request received in MetaMask. If the popup doesn’t open by default, you can also try manually launching the MetaMask extension
-
Once MetaMask is connected to Remix, the
Deploy
transaction would generate another MetaMask popup that requires transaction confirmation. Simply confirm the transaction!
Congratulations! You have successfully deployed the HelloWorld smart contract to the Polygon Amoy testnet. You can now start interacting with your smart contract. Check the deployment status at https://amoy.polygonscan.com/.
Verifying your contract¶
Flatten your smart contract¶
The first and foremost step is to flatten the solidity smart contract into a single file. In order to do that, install truffle-flattener or sol-merger.
After installation, flatten the contract using below command (we have demonstrated using sol-merger).
sol-merger \"./contracts/*.sol\" ./build
Verifying on Polygonscan¶
- Navigate to your contract’s Polygonscan page and click on Verify and Publish.
-
Select Solidity (Single File) in compiler type
-
Select appropriate compiler version
-
Choose the license type of your contract
In the next section, paste your flattened smart contract here. If you had enabled optimization, then adjust the optimization
section accordingly.
Constructor arguments should have been filled in automatically. If not, they can be retrieved from the trailing bytes of the deployment transaction (example: 000000000000000000000000a6fa4fb5f76172d178d61b04b0ecd319c5d1c0aa
).