Skip to content

📘 Getting Started

Janison Sivarajah edited this page Dec 21, 2022 · 5 revisions

Feeling lost? That's fine! Lets check how to get things going. This section will guide you at least with the basics about how to get started. Note, depending on how experienced you are with Web3, you might not need some of the earlier sections so see where you fall into when using this guide.

Setup your wallet

Essentially an entry point for web3 stack is defining a place to safely identify and secure your assets. A crypto wallet is where you are able to create a secure key for interact with all web3 world.

There are a lot of different crypto wallet applications in the market, but we recommend getting started with Metamask. You are able to download and install the browser extension from its website. After installing, you need to follow the instructions to setup your wallet, make your 12 words password secure and you are good to go.

Polygon Network

In the web3 world there are a bunch of different networks that you can interact with. Each network has its own particularities and features. This project takes Polygon Network as it start main network and we will be approaching it in the following content. You will need to setup the network in your wallet to make it possible to communicate with it. Follow this instruction on Polygon wiki to setup the network in your Metamask wallet. It is important to setup both Polygon-Mainnet and Mumbai-Testnet.

Mumbai testnet

Almost every network has mocked version for development purposes, that's what we call testnet. Polygon is not different and its testnet is called Mumbai. If you have followed the the previous section, you should already have the Mumbai-Testnet setup on your Metamask wallet and you are able to select it in the top right corner of your browser extension. Working with the testnet we can get free amounts of MATIC, so we are able to pay for Ethereum gas and test out our contracts.

Faucet

The Faucet application is where you can retrieve your free MATIC for testing on Mumbai-Testnet. First of all access the Polygon Faucet app, and select Mumbai in the network selection field. The token selection field should be set to MATIC Token. Now grab your wallet address on your Metamask extension and paste it in the wallet address field. Submit the form and wait for few seconds and the you will be able to see a few MATIC on your wallet.

Testing

We use Hardat and Foundry for test. To get instructions about it, please refer to the testing section of our readme

Deploying

After developing your changes you are up to deploy the contracts through testnets and test it. We recommend using Mumbai-Testnet but you may choose any network you want.

For deployment instructions, please refer to the deployments section of our readme.

You can checkout the deploying script under scripts folder.

Useful Links

Here we will be pointing out some useful links to get things going and more knowledge about the approached subject:

Build contracts

Interact with Ethereum

Train your skills

Clone this wiki locally