← Guides
/ Web3 SDKs
/ How to Setup Local Development Environment for Solidity
How to Setup Local Development Environment for Solidity
April 12, 2022
Overview
The success story of blockchain started with Bitcoin and was given wings by Ethereum. Ethereum was the first blockchain to introduce programmable software to the immutable ledger; these programs that live on the blockchain are called smart contracts. Solidity is the programming language where you write smart contracts.
To build smart contracts we need a development environment to work in. Here you have two options. You can either setup your development environment in the browser, or on your machine. In the former's case we have Remix IDE and EthFiddle. And when it comes to the latter we have Hardhat and Truffle. This article will focus on a local environment to develop, test, and deploy our smart contracts.
Solidity is an object-oriented, high-level language for implementing smart contracts. Smart contracts are programs which govern the behavior of accounts within the Ethereum state.
Solidity takes its inspiration from some of the popular programming languages like C++, JavaScript, and Python. It is an ideal choice to develop smart contracts. Some well-known DeFi projects that leverage Solidity for designing smart contracts are UniSwap, SushiSwap, and Aave. Now that you know some of the places Solidity is used, let us break down some its characteristics.
It is a statically typed language.
It supports Object-Oriented core paradigms like inheritance, user-defined datatype, libraries, and encapsulation.
Solidity's compiler compiles the smart contract down to Bytecode and ABI. Bytecode is the low-level language interpreted by Ethereum Virtual Machine(EVM) to execute the functions. On the other hand, ABI or Application Binary Interface is a JSON file used by the web application to call the smart contract functions.
Environments to Write Solidity Smart Contracts
Now that you are geared up with a basic understanding of Solidity, let's talk of places where we can write and execute our smart contracts. Let's start with online editors.
1. Remix
Remix is a popular browser-based IDE (Integrated Development Environment) to write your smart contracts. It even enables you to compile and deploy your contract. By default, it provides the Javascript Virtual Machine, which simulates the Ethereum Virtual Machine. With the recent London upgrade, you can see two versions of Javascript Virtual Machine: Berlin and London. They each provide 15 Ethereum addresses with 100 dummy Ether. These are ideal for testing, deploying, and otherwise interacting with your contract functions. The next step is to deploy your contract to any of the test networks using Injected Web3. This enables you to connect to your MetaMask wallet, and gives a feel for how the functions will work on the mainnet. The last option, Web3 Provider, you can use to provide a custom provider using Geth. It is used to test contract functions in a private Ethereum Blockchain.
2. EthFiddle
EthFiddle is another well-known online editor by Looms Network. It has limited functionality compared to Remix, but developers use it widely to test their contract functions. You can share your contracts known as fiddles with your fellow developers.
Now, let's talk about local development. Online editors are good enough when you are learning Solidity or using them for your blogs. But when it comes to production level work, it's recommended to set up a local development environment.
Truffle Suite
Truffle Suite is a famous development suite that makes the smart contract development cycle sweet, just like any dish sizzled with Truffle. In the suite we have -
Truffle: A development and testing framework for your smart contracts. It manages the complicated stuff for you, so development can be focused on the logic for your smart contract. It enables you to write automated test cases to bulletproof your contract from external attacks. Finally, it provides the necessary support for you to deploy your contract to any network.
Ganache: Instantly spawn a private Ethereum network with just a few clicks/commands. It comes with both a CLI and GUI. No matter which one you choose, they provide 10 Ethereum accounts with 100 dummy Ether by default. With a few clicks you can set your block time. It also comes with a blockchain explorer to gain deeper insights into any transactions that take place. Ganache is compatible with Truffle and vice-versa. This creates a powerful combination of tools that enable seamless smart contract development.
Truffle overall is a solid choice for development. It shouldn't leave you out in the wind, and plenty of developers rely on it in their everyday work. Next up we will talk about another alternative choice to the Truffle Suite.
Hardhat
Hardhat is an all-around development environment where you can compile, deploy, test, and benchmark your smart contracts. Hardhat implements various toolkits to aid you in smart contract development. The first one to cover is a task. Tasks are commands to be run from your terminal; one example of a task is hardhat deploy , which will deploy your contract to a blockchain network. The second addition to Hardhat's tool belt is the plugin ecosystem. You can use plugins to extend and bend Hardhat to your specific use case. Another unique feature of Hardhat is console.log which enables you to use a JavaScript console. Hardhat even provides the flexibility to override the built-in features and use them at your convenience.
With that in mind, let's get started with testing a sample contract using the Truffle Suite and Hardhat.
npm install -g truffle
truffle init
## You may need to run this if on MacOS or Linux
sudo npm install -g truffle
truffle init
npm install -g truffle
truffle init
## You may need to run this if on MacOS or Linux
sudo npm install -g truffle
truffle init
npm install -g truffle
truffle init
## You may need to run this if on MacOS or Linux
sudo npm install -g truffle
truffle init
4. You can open the project folder in your favorite editor. The initial folder structure will look something like this:
5. Inside the contracts folder, create a file named Hero.sol.
6. If you are seeing the Solidity code for the first time, you can checkout our comprehensive guide on how to write an Ethereum smart contract using Solidity. Otherwise, go ahead and copy and paste the following code.
7. Inside the truffle-config.json, use the following code snippet to define your compiler verison. We will be using 0.8.1. You can remove all of the starter code in the file.
9. Now, you should see a build folder with two json files. Each houses the ABI code and the Bytecode of the smart contracts. If you have made this far, just give yourself a pat on the back.
The project after running Truffle compile
Deploying to Ganache
Now that our contract is ready and configured our truffle let's deploy the contract to Ganache and test its functionalities.
1. Now, let's deploy to our local Ethereum Network, which Ganache will provide.
2. For this, you can download Ganache from the official website and install it. After that, you can fire it up. It should show a screen like this
3. Click on QUICKSTART, it should open a screen with 10 wallets.
4. Keep note of the port number visible under RPC Server. In this case, its 7545.
5. Now, we will have to update the truffle-config.js to enable deploying to the local network.
6. Now, we have to develop a migration script for deploying our contract. The following code snippet will enable you to do that In the migrations folder delete the starter file and create a new file: 2_deploy_contract.js.
var Hero = artifacts.require("Hero");
module.exports = function(deployer) {
deployer.deploy(Hero,"Hulk");
};
var Hero = artifacts.require("Hero");
module.exports = function(deployer) {
deployer.deploy(Hero,"Hulk");
};
var Hero = artifacts.require("Hero");
module.exports = function(deployer) {
deployer.deploy(Hero,"Hulk");
};
Line 1: It imports the artifacts from the build folder
Line 2: It exports the module which takes deployer as a function parameter.
Line 3: The deployer deploys the contract. It takes the Hero artifact we defined earlier, and we are passing the constructor parameter. In this case, we are passing Hulk.
7. Run the following in your terminal to deploy your contract to the local network:
With that done you should see a log like the one below. Keep note of the contract address you see in there. In our case, it is 0x57b3D5818463fda3E88aA529d82E8b4771a1EE29. Notice the contract is being deployed from the first address you see in Ganache.
8. We can easily interact with the contract in the terminal itself. Run this command in your terminal:
const Hero = artifacts.require("Hero");
contract('Hero', (accounts) => {
let hero
before(async () => {
hero = await Hero.deployed()
})
it('It should return Hulk', async () => {
const receivedHero = await hero.getHero()
assert.equal(receivedHero, "Hulk")
})
it('It should set hero to Iron Man',async()=>{
await hero.setHero("Iron Man",{from:accounts[0]})
const receivedHero = await hero.getHero()
assert.equal(receivedHero,"Iron Man")
})
});
const Hero = artifacts.require("Hero");
contract('Hero', (accounts) => {
let hero
before(async () => {
hero = await Hero.deployed()
})
it('It should return Hulk', async () => {
const receivedHero = await hero.getHero()
assert.equal(receivedHero, "Hulk")
})
it('It should set hero to Iron Man',async()=>{
await hero.setHero("Iron Man",{from:accounts[0]})
const receivedHero = await hero.getHero()
assert.equal(receivedHero,"Iron Man")
})
});
const Hero = artifacts.require("Hero");
contract('Hero', (accounts) => {
let hero
before(async () => {
hero = await Hero.deployed()
})
it('It should return Hulk', async () => {
const receivedHero = await hero.getHero()
assert.equal(receivedHero, "Hulk")
})
it('It should set hero to Iron Man',async()=>{
await hero.setHero("Iron Man",{from:accounts[0]})
const receivedHero = await hero.getHero()
assert.equal(receivedHero,"Iron Man")
})
});
Line 1: We have imported the contract we want to test i.e Hero contract using artifacts.require.
Line 2: Next, we define the contract for testing which is Hero and then we pass the accounts as a parameter that contains all the addresses.
Line 3: The hero variable is defined which stores the instances of the deployed contract.
Line 4-7: before is a command that will ensure that whatever is inside it gets called before the test will move forward. In this case, we need to ensure the contract Hero is deployed before we test it.
Line 9: it encloses a short description of what test we want to run, it as an async function that contains all the test related scripts.
Line 10: We are calling getHero() and storing it inside the recivedHero.
Line 11: We are asserting if the output from earlier matches with our expectation i.e. Hulk.
Line 14-18: It is used to test the setHero() function. Keep note that in the function parameter, we are passing {from:accounts[0]} because we deployed using the first address and according to the contract only the owner can change the value. If you use other values like accounts[1], accounts[2] and so on, it would throw an error.
3. Now that our test cases are complete, let's test it out. Run the following command in your terminal:
truffle test
You should see a similar output as below:
This means, the output we are getting matches the behavior we are expecting. Now that we know our contracts work how we want them to, we can deploy them to the network!
Deploying to Ropsten
The last thing, we need to do is to deploy it to a public test network. Before we can do that we will need to get some test Ether for the Ropsten network. We will need this to pay the gas fees for deploying a smart contract to the network. Go to this faucet and paste in your wallet address to send yourself some test Ether. Now you are ready to start deploying!
1. Grab your Ropsten node URL from your QuickNode dashboard.
2. Now, you will grab the mnemonics from MetaMask. Go to Settings→Security & Privacy → Reveal Secret Recovery Phase. Enter Your Password and it should reveal the seed phase.
3. Update the truffle-config.js to include the network detail that will assist us in deploying to Ropsten.
It may take sometime, so hold on!! At the end, you will get a log like the below. Keep note of the contract address. In our case, it is 0x675aC09AC86dfc3CE15C93Ab307c0Da17eBE84F3.
6. Head over to Ropsten Block Explorer and paste the contract address in the search bar. You should see something like this:
Congratulations on completing the life-cycle of smart contract development!!! You can go ahead and treat yourself with some Dark Chocolate Ganache Truffles! :)
Here we saw how to work with Truffle and hardhat. Using them, you can write tests for your contracts and debug them efficiently. You can also refer to their official documentation for more information.
Subscribe to our newsletter for more articles and guides on Ethereum. If you have any feedback, feel free to reach out to us via Twitter. You can always chat with us on our Discord community server, featuring some of the coolest developers you’ll ever meet :)
Hello reader! Today is an exhilarating day because we are going on an expedition to the Solana Blockchain. Solana is an up-and-coming blockchain seeking to improve upon the current ecosystem's solutions to the complex problem of providing a secure, scalable, decentralized...
PHP is very popular in developing the backend of websites or web applications. PHP has a huge crowd of developers trusting it as their go-to language. In this guide, we will see how we can generate a new Ethereum address in...
Private keys are one of the most sensitive pieces of data when it comes to cryptography and the blockchain. However, there has always been debate/confusion about choosing between custodial wallets (where the wallet provider has custody of the user’s private key) and...
Dotnet or .NET is very popular for the development of desktop applications, most Windows desktop applications are built using .NET, and it also contributes largely to web application’s tech stack. In this guide, let’s see how we can connect to Ethereum using .NET and
With high usage in web applications and straightforward syntax, Ruby is used by a vast number of people. This guide will cover creating an Ethereum address in Ruby using ruby-eth...
In this tutorial we will look at how we can setup a basic NEAR project from scratch, installing and configuring dependencies and customizing the project to work well with AssemblyScript.We will first start by initializing our project with a package.json file using...
To send a transaction on the Ethereum network, you need to pay fees for including the transaction in a block as well as the computation necessary in the transaction; this fee is called gas. The transactions are accepted into the block based on the amount of gas they are...
Coleccionables digitales que son compatibles con ERC-721 se han vuelto muy populares desde el lanzamiento de Cryptokitties y han ganado adopción masiva en los últimos meses. Esta guía cubrirá la parte de creación y lanzamiento...
When building a smart contract on the Ethereum blockchain, new developers tend to reach out to tools like truffle and web3.js in building their smart contracts. This tutorial will look at how to use Hardhat and Ether.js, which are now becoming the standard in building...
We can say that Java is one of the most versatile languages out there, and it continues to be relevant in today's time. Java is so popular because of its massive user base and use cases. In this guide/tutorial, we'll learn how to connect to the Ethereum Blockchain network...
It can be costly to store massive files on a blockchain mainnet, and this is where decentralized file storing systems like IPFS can come in handy. Sometimes, NFTs use IPFS as well. In this guide, we’ll cover how we can integrate IPFS with...
The Ruby programming language has a huge fanbase. Ruby was developed by its creator with an intention to invent a language developers can enjoy learning and using. Ruby has been largely accepted by developers all around the world since its launch, in fact, the biggest...
This guide demonstrates how to mint an NFT on the Polygon blockchain using the Ethers.js library and our Factory ERC-1155 contract we built in an earlier
When someone thinks of developing a dApp the first tool that comes to their mind is web3.js which is pretty common because of its popularity in the community and wide use cases, dApp development has been consistently growing and there are a lot of developers who want to...
Updated at: April 10, 2022Welcome to another QuickNode guide on Solana - the up-and-coming blockchain that seeks to solve the scalability issues of Ethereum. We will be walking through step-by-step how to create an NFT on Solana. NFT, short for Non Fungible Token,...
A developer stack is a bag of technologies a developer possesses. For example, MEAN (MongoDB, Express.js, AngularJS/Angular, and Node.js) and MERN (MongoDB, Express.js, React, and Node.js) are common web developer stacks. Similarly, today we will learn more about the web3...
Hello readers! We know Solana network congestion can sometimes throw a wrench in your transactions. Occasionally, when Solana is congested, transactions get dropped, meaning your sendTransaction request may return a valid Transaction ID, but the response...
Python is one of the most versatile programming languages; from researchers running their test models to developers using it in heavy production environments, it has use cases in every possible technical field. In today's guide, we will learn about Brownie, a Python-based...
Hello readers! To kick off Solana Summer and the current whitelist meta, we thought it would be helpful to dig into all of the token accounts you and your users have using the getParsedProgramAccounts method. This tool is convenient for querying different...
Developing applications involves juggling several moving pieces like front-ends, back-ends, and databases. But developing a decentralized application on a blockchain adds a few more elements like smart contracts and nodes that allow you to connect to the...
To do any type of transaction on the Bitcoin blockchain, you’ll need a public key or a Bitcoin address. In this guide, we’ll cover how to generate a new Bitcoin address in JavaScript using CyrptoCoinJS.
¡Hola querido lector! Bienvenidos a una nueva guía de Solana.Solana es una blockchain que promete mucho a la hora de intentar resolver los problemas de escalabilidad que podemos apreciar en otras blockchains, como Ethereum por...
Terra is the stablecoins framework with a pool of tokens to work with. Today in this guide, we will learn how to create our own token on the Terra blockchain network.PrerequisitesA Terra Bombay testnet...
Ever need to pull all the transactions associated with a Wallet? Want to see all of the mint transactions associated with a Candy Machine? Or maybe see transaction history of an NFT? Solana's getSignaturesForAddress method is a versatile tool that makes...
When a new token is made on the Ethereum network, it usually follows a specification. The most popular of which is the ERC20 specification. To meet this ERC20 standard, one's token must have a multitude of...
While Ethereum has been trying to scale, it has encountered some gas price issues. Many layer 2 solutions and sidechains sprang into existence to solve this problem, but Ethereum is the main chain, and at some point, it has to be improved. EIP-1559 was introduced to...
Avalanche is an open-source, proof-of-stake blockchain with smart contract functionality that uses the Snow family of consensus protocols. The Avalanche Primary Network consists of
Hello reader! Welcome to QuickNode's first Solana guide. Solana is an up-and-coming blockchain that seeks to solve the scalability issues that Ethereum has been handling. You will walk through step-by-step how to create a Solana address using the @solana/web3.js...
Blockchain provides us with the power of decentralization. Decentralization means the transfer of power to users/members rather than having a single centralized authority governing everything; it enables various use cases in finance, governance, voting, fundraising, etc....
Ethereum development environments like Truffle and Hardhat make it easier to work with smart contracts and Ethereum nodes. They provide a set of tools to seamlessly write, test, and deploy...
Stablecoins have been bridging the gap between traditional currencies and blockchains. Stablecoins offer stable price tokens pegged by a reserve asset which is often a fiat current like USD, EUR, GBP. The Terra protocol provides a framework to work with stablecoins. This...
Go helps you make faster scalable backends and this guide will show you how to connect your backend to Ethereum (and make it even faster, more reliable, and globally accessible, all thanks to QuickNode’s global infrastructure). What is...
Sometimes, you submit a transaction on Ethereum without enough gas due to network congestion or too many pending transactions offering a higher gas price than you have offered on your transaction. If you have a high priority transaction but low gas, you could end up...
Forking the chain at an older block of the blockchain is helpful if you want to simulate the blockchain’s state at that block; Hardhat has this functionality built in. In this guide, let’s go through the process of forking the Ethereum Mainnet at an older...
PHP is a very popular choice among developers and has a vast community due to its long presence in web development. In this guide, we’ll cover how to connect to Ethereum with PHP using the web3.php...
You can build Ethereum applications in different programming languages. In this article, we will connect to the Ethereum network using Python.PrerequisiteEthereum Node (We will use QuickNode’s free...
In this guide, we'll understand a bit about reactive development and how to use Subspace with QuickNode.JavaScript is the programming language behind most of the internet apps and websites. JavaScript today has become one of the most used programming languages,...
Forking and running a local simulated Ethereum environment is essential if you want to work with DeFi or do Ethereum development in general. In this guide, we’ll cover how to fork Ethereum Blockchain with
Libraries and frameworks make the development process a lot easier and faster. When it comes to Ethereum development, Web3.js is the go to library. That's because Web3.js is the official library, from the
In this practical guide you will build a basic Wallet application with React and Web3 that will interact with Solana Network.This application will do the following operations:Connect to the...
If you are building on Ethereum, you may run into scenarios where you need to fetch transaction history for a given address. Unfortunately, the current design for Ethereum lacks an easy way to retrieve this data. For this reason, we are dedicating this guide to explaining...
Today we will be building a sample app in Svelte, and connecting it to a smart contract that we deploy on the Ropsten Network.Our frontend will be able to do the following:Allow the user to send a greeting message along with a wave to the...
Been building on Solana and ready to bring your dApp to the web? You're going to need a way to connect your tools to your users' wallets. Though there are a few ways to connect your dApp to your users' wallets, Solana has created a couple of handy tools that make getting...
In our dApp, we will have a simple react user interface that has a material button asking the user to connect to MetaMask. And if they do not have an account, they can create one or log in to their account. They will then view their wallet balance and address displayed on...
Social logins: we have all seen them, we have all used them. "Login with Facebook". "Login with Github".If you have been around the Web3 community you may have come across a more recent player in the game: "Login with MetaMask". For instance, this is...
Golang is very popular among backend developers for building infrastructures and microservices. Go is a procedural programming language. Developed in 2007 by Robert Griesemer, Rob Pike, and Ken Thompson at Google, then launched in 2009 as...
Python is one of the most versatile programming languages out there with an abundance of use cases; We can build many applications with Python from client-side to back end. In this guide, we will cover creating an Ethereum address in Python using the
When it comes to programming, there’s hardly anyone who has not used or heard about JavaScript. JavaScript was initially created for client-side scripting but has become a full-featured Object-Oriented...
¡Hola querido lector! Hemos recibido un montón de pedidos por otra guía de NFT en Solana. En la guia anterior no llegamos hasta la parte mas jugosa, que es la parte donde enlazamos una...
Ethereum log records are very useful to understand and keep track of smart contract events. In this guide, we are going to learn how to fetch Ethereum event logs in Ruby using eth.rb Ruby...
Hello readers, in this guide we are going to walk through how to set up an NFT mint on Solana using Candy Machine v2. Candy Machine v2 has some similarities to v1 but quite a lot of differences. The main catalyst that drove v2 was to curb the botting that the NFT...
Terra has emerged as the choice of blockchain for developing a stablecoin based dApp. Terra provides a cutting-edge stablecoin framework for modern dApp development. In this guide, we will learn how to send a transaction on Terra using their javascript library...
NFTs are great for creators to monetize their artwork and for people to get ownership of an item. But since gas prices are usually high given the highly in-demand space on Ethereum, minting an NFT or an NFT collection can become costly for a creator. Lazy minting solves...