Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bokkypoobah/getstartedwithdevelopinginethereum

Getting Started In Ethereum, with an interactive ERC-20, ERC-721 and ERC-1155 token contract explorer dapp
https://github.com/bokkypoobah/getstartedwithdevelopinginethereum

approvals balances erc-1155 erc-20 erc-721 ethereum events token-explorer

Last synced: 9 days ago
JSON representation

Getting Started In Ethereum, with an interactive ERC-20, ERC-721 and ERC-1155 token contract explorer dapp

Host: GitHub
URL: https://github.com/bokkypoobah/getstartedwithdevelopinginethereum
Owner: bokkypoobah
License: mit
Created: 2024-08-11T07:39:07.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-08-15T04:02:42.000Z (about 2 months ago)
Last Synced: 2024-09-23T07:04:17.380Z (12 days ago)
Topics: approvals, balances, erc-1155, erc-20, erc-721, ethereum, events, token-explorer
Language: Solidity
Homepage: https://bokkypoobah.github.io/GetStartedWithDevelopingInEthereum/
Size: 28.2 MB
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Get Started With Developing In Ethereum

Materials prepared for [ETHSydney August - Get started with developing in Ethereum](https://lu.ma/42iq2h0p), Tuesday Aug 13 2024.

If you like this, please share it.

##### Aim
* Have the capabilities to launch your own **sh*tcoin** within minutes!

You can do this on Ethereum mainnet for the cost of ~600k gas or ~USD 3, at time of writing. As well as most "EVM" (Ethereum Virtual Machine) [compatible chains](https://l2beat.com/scaling/summary) like Arbitrum, Base or Optimism.
* Demystify ERC-20s

An ERC-20 token contract is a little bit like a database table with two columns - owner and balance. And with stored procedures to implement transfer rules.

**balances:** section in the ERC-20 browser.

With events logs recording the transfers

**events:** section in the ERC-20 browser.

Token amounts are stored as raw numbers with a specified number of `decimals`, `18` in this case.

##### Steps
* Deploy your own ERC-20 token contract - [contracts/ERC20Token.sol](contracts/ERC20Token.sol) (Sepolia [0x1e5D...4D59](https://sepolia.etherscan.io/address/0x1e5Df6dB242d07cc40a37b634022c02F73A74D59#code)) or [contracts/FixedSupplyToken.sol](contracts/FixedSupplyToken.sol) (Sepolia [0x8fAF...d093](https://sepolia.etherscan.io/address/0x8fAF86fa6B137B316D699e23Ae1DcA3C12e7d093#code)).
* Interact with your own ERC-20 token contract
* Deploy a simple vault that operates with your ERC-20 token contract - [contracts/SimpleVault.sol](contracts/SimpleVault.sol)
* Interact with your simple vault

##### Outcome
On completion of Exercises 1 & 2, you will have deployed and interacted with your first ERC-20 token contract on the Ethereum Sepolia testnet

##### ERC-20 Token Browser
* https://bokkypoobah.github.io/GetStartedWithDevelopingInEthereum/

I built a simple tool to inspect and interact with ERC-20 token contracts. The main source code file is [docs/index.html](docs/index.html). View the developer pane when running this tool to see the simple interactions required between your web browser and the blockchain.

This tool can also be run locally by executing e.g. [anywhere](https://www.npmjs.com/package/anywhere?activeTab=readme) in the [docs/](docs/) folder of this GitHub repository downloaded onto your local machine

##### Requirements
* Web browser, with the MetaMask https://metamask.io/, or Rabby https://rabby.io/ browser plug-in
* Sepolia testnet ethers in your MetaMask account. Try https://www.alchemy.com/faucets, https://www.infura.io/faucet/sepolia, https://sepolia-faucet.pk910.de/ or https://cloud.google.com/application/web3/faucet/ethereum/sepolia
* For developing and testing on your local computer, familiarity with the Linux, MacOS or Windows command line. And [npx](https://docs.npmjs.com/cli/v10/commands/npx) to run commands from Node packages.

##### TODO
* Contents and UI for ERC-721 and ERC-1155

---

## Table Of Contents

* [Overview](#overview)
* [Exercise 1 - Deploy Your Own ERC-20 Token Contract](#exercise-1---deploy-your-own-erc-20-token-contract)
* [Exercise 2 - Interact With Your ERC-20 Token Contract](#exercise-2---interact-with-your-erc-20-token-contract)

---

## Overview

---

## Exercise 1 - Deploy Your Own ERC-20 Token Contract

Go to https://remix.ethereum.org/. In the `FILE EXPLORER` tab, create a new `ERC20Token.sol` document under `default_workspace` -> `contracts`. Copy the content from [contracts/ERC20Token.sol](contracts/ERC20Token.sol) or , or [contracts/FixedSupplyToken.sol](contracts/FixedSupplyToken.sol) and paste into your newly created `ERC20Token.sol` document.

Change the `_name` and `_symbol` on lines 80 and 81. Save and you should have a green tick below the third icon on the sidebar.

Switch to the `SOLIDITY COMPILER` tab. Note the `COMPILER` version, `0.8.26+commit.8a87fa7a` in this case. Check that `Enable optimisation` is ticked and the number beside it set to `200`.

Switch to the `DEPLOY & RUN TRANSACTIONS` tab. Set `ENVIRONMENT` to `Injected Provider - MetaMask` and your MetaMask account should appear under the `ACCOUNT` label.

Select `CONTRACT` to be `ERC20Token - contracts/ERC20Token.sol`.

Click [Deploy], and [Confirm] your transaction in MetaMask.

In the bottom pane, you will see your completed transaction and newly created `contract address`. `0xac09587d186d70d93dd9b16328c2e4fa845cc9cf` in my case.

The contract can be viewed at https://sepolia.etherscan.io/address/0xac09587d186d70d93dd9b16328c2e4fa845cc9cf, in my case.

Switch to the `Contract` tab.

Click on [Verify and Publish] to upload the source code for your ERC-20 token contract. Select the `Compiler Type` of `Solidity(Single file)`. Select the `Compiler Version` to compiler version you compiled your contract with, `0.8.26+commit.8a87fa7a` currently. Select the `Open Source License Type` of `3) MIT License (MIT)`. Click [Continue].

Paste the contents of ERC20Token.sol from Remix into the text box under `Enter the Solidity Contract Code below`.

Set `Optimization` to `Yes` and `Runs` to `200`, matching the same parameters in Remix above.

Click [Verify and Publish].

**CONGRATULATIONS** You have published your ?first contract!

The newly deployed contract code can be viewed at https://sepolia.etherscan.io/address/0xac09587d186d70d93dd9b16328c2e4fa845cc9cf#code, in my case.

The ERC-20 token transactions can be viewed at https://sepolia.etherscan.io/token/0xac09587d186d70d93dd9b16328c2e4fa845cc9cf, in my case. You can see `1,000,000` tokens being minted from address `0x0000...0000` to deploying address.

Click on the [Holders] tab to view the account holdings.

---

## Exercise 2 - Interact With Your ERC-20 Token Contract

View your ERC-20 token contract on https://bokkypoobah.github.io/GetStartedWithDevelopingInEthereum/.

Using my newly deployed ERC-20 token contract `0xAC09587d186D70d93dd9B16328C2E4fA845cC9CF`, you can see the initially minted `1,000,000` `TOOSEXY` tokens transferred to my account when my ERC-20 token contract was deployed.

If required, create your second MetaMask account and transfers some Sepolia testnet ethers to it.

In the **transfer:** block, set `to:` to your second MetaMask account, and `tokens:` to `10`. Click [Transfer], then confirm the transaction in MetaMask.

After MetaMask sends your transaction, you should see your `txHash:`. Click on the link to `View in explorer` if you want to view your transaction.

Click [Retrieve], and you can see the new transaction of `10` tokens, and 3 rows in the **balances:** table.

Execute a second transfer of `1` token to your second account.

Click [Retrieve] at the top of the page, and you can see the new transaction of `1` token, and **balances:** table updated appropriately.

In the **approve:** block, set `spender:` to your second MetaMask account, and `tokens:` to `100`. Click [Approve], then confirm the transaction in MetaMask.

After MetaMask sends your transaction, you should see your `txHash:`. Click on the link to `View in explorer` if you want to view your transaction.

Click [Retrieve] at the top of the page, and you can see the new `Approval` transaction of `100` token, and **allowances:** table updated appropriately.

In the **allowance:** block, you can check the allowance just set.

Switch to your second account in MetaMask.

In the **transferFrom:** block, set `from:` to be your first account, and `tokens:` to be `0.12345`. Click [Transfer From], then confirm the transaction in MetaMask.

Click [Retrieve] at the top of the page, and you can see the new `Transfer` transaction of `0.12345` token, and **balances:** table updated appropriately.

In the **allowance:** block, you can see that the allowance of `100` that you set has now been reduced to `99.87655`, as account2 has used `0.12345` of their allowance.

---

## Exercise 3 - SimpleVault Gadget for ERC-20s

TODO

##### Aim
* Deploy and interact with a simple gadget that uses the ERC-20 basic building block

##### Steps
1. Set up the Hardhat testing environment - https://hardhat.org/docs
2. Modify [contracts/SimpleVault.sol](contracts/SimpleVault.sol) to break the functionality and confirm with the tests
3. Deploy your own SimpleVault to the Sepolia testnet
4. Send and withdraw some of your very own ERC-20 tokens created in Exercise 1

#### Exercise 1 - Step 1 - Hardhat Testing Environment

```bash
npm install --save-dev hardhat

# Run test
npx hardhat test

# Or run test and save output in ./testIt.out
./10_testIt.sh
# 00_test_0
# Deployment
# Signers
# * owner: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
# * otherAccount: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8
# Deploying ERC20
# * symbol: MYSYMBOL
# * name: My Name
# * decimals: 18
# * totalSupply: 1000000000000000000000000
# Deploying SimpleVault
# * owner: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
# ✔ ERC20 token should have the correct symbol, name, decimals and totalSupply (548ms)
# ✔ ERC20 token should emit an event on transfers and balanceOf adds up
# ✔ SimpleVault should process token deposits and withdrawals correctly
#
#
# 3 passing (581ms)
```

---

## Building Blocks - Tokens

### ERC-20 Fungible Tokens - "Coins"

e.g., Bank balance, Opal card balance, transfers

* [contracts/ERC20Token.sol](contracts/ERC20Token.sol)

### ERC-721 Non-Fungible Tokens - "Pictures"

e.g., Bank account number, Opal card number, drivers license, registry item

* [contracts/ERC721Token.sol](contracts/ERC721Token.sol)

### ERC-1155 Non-Fungible Tokens - "Coins & Pictures"

e.g., Game items

* [contracts/ERC1155Token.sol](contracts/ERC1155Token.sol)

---

## Resources

### Solidity

* Solidity compiler and deployer - [https://remix.ethereum.org/](https://remix.ethereum.org/)
* Solidity Documentation - [https://docs.soliditylang.org/](https://docs.soliditylang.org/)
* OpenZeppelin Contracts - [https://github.com/OpenZeppelin/openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts)
* Hardhat development environment - [https://hardhat.org/](https://hardhat.org/)

### Other

* [mindmap/GetStartedWithDevelopingInEthereum-202408.mm](mindmap/GetStartedWithDevelopingInEthereum-202408.mm) that can be viewed in [FreePlane](https://docs.freeplane.org/)

Enjoy!