{"id":1168,"date":"2022-12-15T22:05:10","date_gmt":"2022-12-15T22:05:10","guid":{"rendered":"https:\/\/dodona.software\/?p=1168"},"modified":"2022-12-15T22:10:43","modified_gmt":"2022-12-15T22:10:43","slug":"setting-up-your-local-environment-intro-to-solidity-ethereum-developer-tutorial-for-beginners","status":"publish","type":"post","link":"https:\/\/brandweaver.ai\/blog\/setting-up-your-local-environment-intro-to-solidity-ethereum-developer-tutorial-for-beginners\/","title":{"rendered":"Setting Up Your Local Environment \u2013\u00a0Intro to Solidity: Ethereum Developer Tutorial for Beginners"},"content":{"rendered":"\n<p>Welcome to the Sidekik class on Solidity programming. In this video and blog series, we aim to teach new developers how to code smart contracts \u2013\u00a0for free. <\/p>\n\n\n\n<figure class=\"wp-block-embed is-type-video is-provider-youtube wp-block-embed-youtube wp-embed-aspect-16-9 wp-has-aspect-ratio\"><div class=\"wp-block-embed__wrapper\">\n<div class=\"ast-oembed-container\" style=\"height: 100%;\"><iframe loading=\"lazy\" title=\"Intro to Solidity: Setting Up Your Local Environment - Ethereum Developer Tutorial for Beginners\" width=\"500\" height=\"281\" src=\"https:\/\/www.youtube.com\/embed\/O_ofQXNDnhw?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen><\/iframe><\/div>\n<\/div><\/figure>\n\n\n\n<h1 class=\"wp-block-heading\">Setting Up Your Local Environment<\/h1>\n\n\n\n<p>In today&#8217;s post, we show you how to setup your Solidity Programming environment so that you have a solid foundation for Blockchain development.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Hardhat is for professionals<\/h2>\n\n\n\n<p>I recommend Hardhat for Solidity programmers who are serious about building smart contracts. Many tutorials recommend Remix, and that\u2019s a great environment for tinkering. But if you talk to professional developers, you\u2019ll see that they use either Hardhat or Foundry for real work.<\/p>\n\n\n\n<p>Let&#8217;s start with a solid foundation as we dive into Solidity. You&#8217;ll need to spend 5-10 minutes setting up our Hardhat environment. <\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Installing Hardhat<\/h3>\n\n\n\n<p>You can install Hardhat directly by running <code>npm install --save-dev hardhat<\/code> in your Terminal console. But I strongly recommend you accelerate your setup by cloning the <a href=\"https:\/\/github.com\/mistersingh179\/badass-hardhat-setup\">Badass Hardhat Repo<\/a>, created by Sidekik&#8217;s CTO. It&#8217;s pre-configured to help you go faster. For instance, it&#8217;s configured to auto-compile and deploy after each file change, and it writes your ABI and contract addresses to a JSON file for easy reference.<\/p>\n\n\n\n<p>Open your terminal and run <code>git clone git@github.com:mistersingh179\/badass-hardhat-setup.git<\/code>. Next, run <code>npm install<\/code> to download the necessary packages and dependencies. <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"563\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4-1024x563.png\" alt=\"Screenshot of iTerm showing how to clone the badass-hardhat-repo and install the necessary packages to accelerate a developer's smart contract lifecycle.\" class=\"wp-image-1169\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4-1024x563.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4-300x165.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4-768x422.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4-1536x844.png 1536w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-4.png 1873w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Open your IDE of choice, (I like VScode, but you do you \ud83d\ude0e) and explore the repo. You&#8217;ll notice a contracts folder with *.sol files and a deploy folder with *.js Javascript files. <\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Setup Local Environment Variables<\/h3>\n\n\n\n<p>This repo uses three environment variables to help accelerate your smart contract development process: a mnemonic, an Etherscan API key, and an Alchemy API key. <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"434\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5-1024x434.png\" alt=\"\" class=\"wp-image-1170\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5-1024x434.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5-300x127.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5-768x325.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5-1536x651.png 1536w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-5.png 1667w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>The mnemonic is &#8220;a 12 or 24 word mnemonic phrase as defined by BIP39.&#8221; It&#8217;s default value is &#8220;test test test test test test test test test test test junk&#8221;. Because we&#8217;re just developing in our local environment, this mnemonic will work. However, in a production environment, you would use your wallet&#8217;s 12 or 24 seed phrase (private key), which would be the source of gas to deploy a contract on a target blockchain. <\/p>\n\n\n\n<p>The second item you need is the Etherscan API key. This is free and easy to obtain. Navigate to Etherscan.io, create an account, and then visit the &#8220;API Keys&#8221; tab on the left-hand side. Create a new key and copy-paste that into your .env file. This API Key from Etherscan is useful to upload ABIs and verify contracts that you have deployed to a testnet or mainnet.<\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"725\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-6-1024x725.png\" alt=\"\" class=\"wp-image-1171\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-6-1024x725.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-6-300x212.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-6-768x544.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-6.png 1259w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Finally, you&#8217;ll want to grab an Alchemy API key. Alchemy is a blockchain scaling platform that gives devs network connectivity and node management endpoints to certain blockchains. In the <code>badass-hardhat-setup<\/code>, Alchemy is used to create a fork of mainnet whenever you run a local chain. The advantage of this approach is that you bring in a snapshot of everything that&#8217;s on-chain at that moment so that your local environment can interact with external contracts (e.g., USDC, Uniswap Router, etc.). <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"756\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-7-1024x756.png\" alt=\"Get an Alchemy API key to enable simple forking of mainnet in your local environment.\" class=\"wp-image-1172\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-7-1024x756.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-7-300x221.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-7-768x567.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-7.png 1256w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Running a Local Blockchain<\/h3>\n\n\n\n<p>Much like running a local server to test and debug your code, Hardhat enables you to run a local copy of the blockchain. To do this, run <code>npm run chain<\/code> in your Terminal. The <code>badass-hardhat-setup<\/code> repo is configured to run the local chain and make it accessible via HTTP and Websocket JSON-RPC server at http:\/\/127.0.0.1:8545\/. <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"716\" height=\"641\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-8.png\" alt=\"The badass-hardhat-setup repo is configured to run the local chain and make it accessible via HTTP and Websocket JSON-RPC server at http:\/\/127.0.0.1:8545\/. \" class=\"wp-image-1173\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-8.png 716w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-8-300x269.png 300w\" sizes=\"(max-width: 716px) 100vw, 716px\" \/><\/figure>\n\n\n\n<p>Depending on your version of NPM, Node, and other factors, you may get an error about missing packages. If that happens, follow the instructions in the error message to resolve the missing dependencies: <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"297\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10-1024x297.png\" alt=\"\" class=\"wp-image-1175\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10-1024x297.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10-300x87.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10-768x223.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10-1536x445.png 1536w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-10.png 1876w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>In the example above, I was missing various packages. I ran the following in Terminal: <\/p>\n\n\n\n<p><code>npm install --save-dev \"@nomicfoundation\/hardhat-network-helpers@^1.0.0\" \"@nomicfoundation\/hardhat-chai-matchers@^1.0.0\" \"@nomiclabs\/hardhat-ethers@^2.0.0\" \"@nomiclabs\/hardhat-etherscan@^3.0.0\" \"@types\/chai@^4.2.0\" \"@types\/mocha@^9.1.0\" \"@typechain\/ethers-v5@^10.1.0\" \"@typechain\/hardhat@^6.1.2\" \"chai@^4.2.0\" \"hardhat-gas-reporter@^1.0.8\" \"solidity-coverage@^0.8.1\" \"ts-node@>=8.0.0\" \"typechain@^8.1.0\" \"typescript@>=4.5.0\"<\/code><\/p>\n\n\n\n<p>and that resolved the issue for me. Don&#8217;t just copy-paste the above; look at the specific error message if you run into this issue.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Compiling &amp; Deploying your Smart Contracts<\/h3>\n\n\n\n<p>After your local chain is running, you&#8217;ll compile and deploy your contracts to that chain. Execute <code>npm run deploy<\/code> in your Terminal: <\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"587\" height=\"212\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-9.png\" alt=\"\" class=\"wp-image-1174\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-9.png 587w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-9-300x108.png 300w\" sizes=\"(max-width: 587px) 100vw, 587px\" \/><\/figure>\n\n\n\n<p>Congrats, you just setup your Hardhat environment, ran a local chain, and deployed your smart contract to it. Now how do you see the fruits of your labor? Simple: connect Sidekik to your environment to easily interact with your code and check that it works as intended. <\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Use Sidekik to Interact with your smart contract<\/h2>\n\n\n\n<p>Navigate to the client-side web application at <a rel=\"noreferrer noopener\" href=\"https:\/\/app.brandweaver.ai\/\" target=\"_blank\">https:\/\/app.brandweaver.ai\/<\/a>. First, verify that your local chain is running and connected. Second, click on Sync File(s) and select the JSON file that contains your ABI and deployed contract address. (If you&#8217;re using the <code>badass-hardhat-setup<\/code> repo, then you&#8217;re already outputting your ABI and deployed contract address to a JSON file, <code>contract-addresses.json-file<\/code> \ud83c\udf89 If you&#8217;re not using our recommended repo, <a rel=\"noreferrer noopener\" href=\"https:\/\/docs.brandweaver.ai\/setup\/overview\/how-to-save-contract-addresses-to-disk\" target=\"_blank\">here&#8217;s documentation<\/a> on how to write the ABI and address to a JSON file.)  You&#8217;ll know that Sidekik is ready when it shows your deployed contracts (<code>FavContract<\/code> and <code>MyContract<\/code>), their addresses, and ABIs:<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"443\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-12-1024x443.png\" alt=\"\" class=\"wp-image-1177\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-12-1024x443.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-12-300x130.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-12-768x332.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-12.png 1133w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>After you click Continue, Sidekik gives you a visual way to interact with your smart contract. For instance, your public variables are readable by clicking on the blue buttons, which simulates a read transaction on your local chain. You can also run public functions. Just input your variables, click on the orange button, and you&#8217;ll see that function&#8217;s output. <\/p>\n\n\n\n<p>As an example, confirm that your smart contract logic is correct by clicking on the variable <code>name<\/code> after running your <code>changeName<\/code> function to demonstrate that your code changed the <code>name<\/code> variable from &#8220;foobar&#8221; to your input.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"565\" src=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11-1024x565.png\" alt=\"\" class=\"wp-image-1176\" srcset=\"https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11-1024x565.png 1024w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11-300x165.png 300w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11-768x423.png 768w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11-1536x847.png 1536w, https:\/\/brandweaver.ai\/wp-content\/uploads\/2022\/12\/image-11.png 1792w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Again, congratulations on completing this first step on your journey into the Solidity programming language. We look forward to hearing from you on <a href=\"https:\/\/twitter.com\/sidekik_xyz\" target=\"_blank\" rel=\"noreferrer noopener\">Twitter<\/a>, <a href=\"https:\/\/discord.gg\/yjYSbyapkg\" data-type=\"URL\" data-id=\"https:\/\/discord.gg\/yjYSbyapkg\" target=\"_blank\" rel=\"noreferrer noopener\">Discord<\/a>, or in the comments below!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Welcome to the Sidekik class on Solidity programming. In this video and blog series, we aim to teach new developers how to code smart contracts \u2013\u00a0for free. Setting Up Your Local Environment In today&#8217;s post, we show you how to setup your Solidity Programming environment so that you have a solid foundation for Blockchain development. &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/brandweaver.ai\/blog\/setting-up-your-local-environment-intro-to-solidity-ethereum-developer-tutorial-for-beginners\/\"> <span class=\"screen-reader-text\">Setting Up Your Local Environment \u2013\u00a0Intro to Solidity: Ethereum Developer Tutorial for Beginners<\/span> Read More &raquo;<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"default","ast-global-header-display":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","footnotes":""},"categories":[13],"tags":[],"featured_image_src":null,"featured_image_src_square":null,"author_info":{"display_name":"Rod Fuentes","author_link":"https:\/\/brandweaver.ai\/blog\/author\/rodsidekik-xyz\/"},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"gb-block-post-grid-landscape":false,"gb-block-post-grid-square":false},"uagb_author_info":{"display_name":"Rod Fuentes","author_link":"https:\/\/brandweaver.ai\/blog\/author\/rodsidekik-xyz\/"},"uagb_comment_info":2,"uagb_excerpt":"Welcome to the Sidekik class on Solidity programming. In this video and blog series, we aim to teach new developers how to code smart contracts \u2013\u00a0for free. Setting Up Your Local Environment In today&#8217;s post, we show you how to setup your Solidity Programming environment so that you have a solid foundation for Blockchain development.&hellip;","_links":{"self":[{"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/posts\/1168"}],"collection":[{"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/comments?post=1168"}],"version-history":[{"count":0,"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/posts\/1168\/revisions"}],"wp:attachment":[{"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/media?parent=1168"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/categories?post=1168"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/brandweaver.ai\/wp-json\/wp\/v2\/tags?post=1168"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}