Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Node modules
/node_modules

# Compilation output
/dist

# pnpm deploy output
/bundle

# Hardhat Build Artifacts
/artifacts

# Hardhat compilation (v2) support directory
/cache

# Typechain output
/types

# Hardhat coverage reports
/coverage
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Sample Hardhat 3 Beta Project (`mocha` and `ethers`)

This project showcases a Hardhat 3 Beta project using `mocha` for tests and the `ethers` library for Ethereum interactions.

To learn more about the Hardhat 3 Beta, please visit the [Getting Started guide](https://hardhat.org/docs/getting-started#getting-started-with-hardhat-3). To share your feedback, join our [Hardhat 3 Beta](https://hardhat.org/hardhat3-beta-telegram-group) Telegram group or [open an issue](https://github.com/NomicFoundation/hardhat/issues/new) in our GitHub issue tracker.

## Project Overview

This example project includes:

- A simple Hardhat configuration file.
- Foundry-compatible Solidity unit tests.
- TypeScript integration tests using `mocha` and ethers.js
- Examples demonstrating how to connect to different types of networks, including locally simulating OP mainnet.

## Usage

### Running Tests

To run all the tests in the project, execute the following command:

```shell
npx hardhat test
```

You can also selectively run the Solidity or `mocha` tests:

```shell
npx hardhat test solidity
npx hardhat test mocha
```

### Make a deployment to Sepolia

This project includes an example Ignition module to deploy the contract. You can deploy this module to a locally simulated chain or to Sepolia.

To run the deployment to a local chain:

```shell
npx hardhat ignition deploy ignition/modules/Counter.ts
```

To run the deployment to Sepolia, you need an account with funds to send the transaction. The provided Hardhat configuration includes a Configuration Variable called `SEPOLIA_PRIVATE_KEY`, which you can use to set the private key of the account you want to use.

You can set the `SEPOLIA_PRIVATE_KEY` variable using the `hardhat-keystore` plugin or by setting it as an environment variable.

To set the `SEPOLIA_PRIVATE_KEY` config variable using `hardhat-keystore`:

```shell
npx hardhat keystore set SEPOLIA_PRIVATE_KEY
```

After setting the variable, you can run the deployment with the Sepolia network:

```shell
npx hardhat ignition deploy --network sepolia ignition/modules/Counter.ts
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;

contract Counter {
uint public x;

event Increment(uint by);

function inc() public {
x++;
emit Increment(1);
}

function incBy(uint by) public {
require(by > 0, "incBy: increment should be positive");
x += by;
emit Increment(by);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;

import {Counter} from "./Counter.sol";
import {Test} from "forge-std/Test.sol";

// Solidity tests are compatible with foundry, so they
// use the same syntax and offer the same functionality.

contract CounterTest is Test {
Counter counter;

function setUp() public {
counter = new Counter();
}

function test_InitialValue() public view {
require(counter.x() == 0, "Initial value should be 0");
}

function testFuzz_Inc(uint8 x) public {
for (uint8 i = 0; i < x; i++) {
counter.inc();
}
require(counter.x() == x, "Value after calling inc x times should be x");
}

function test_IncByZero() public {
vm.expectRevert();
counter.incBy(0);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;


contract CrowdFunding{

struct Adashey{
address owner;
uint deadline;
uint targetAmount;
uint totalCollected;
}

// create a counter to give each pool a uinque ID
uint public poolCounter;


// mapping the counter to the struct which contains the details of the pool
mapping(uint => Adashey) public fundingStorage;


// map pool ID to (contributor address to amount)
mapping(uint => mapping(address => uint)) public contributorsFunds;

function createPool(uint _deadline, uint _targetAmount) external returns(uint) {
require(_targetAmount > 0, "Must be greater than zero");
poolCounter++;
fundingStorage[poolCounter] = Adashey({
owner: msg.sender,
deadline: _deadline,
targetAmount: _targetAmount,
totalCollected: 0
});

return poolCounter;
}


function contribute(uint _id) external payable {
require(fundingStorage[_id].owner != address(0), "Pool does not exist");
require(block.timestamp < fundingStorage[_id].deadline, "Deadline passed");
require( msg.value > 0, "Must send eth");

// this line stores the amount each of the contributor contributed to the project in the mapping
contributorsFunds[_id][msg.sender] += msg.value;
// ths line refreshs the state of this transaction when a contributor contributes
fundingStorage[_id].totalCollected += msg.value;
}

function withdrawFunds(uint _id) external{
require(msg.sender == fundingStorage[_id].owner, "Only owner can withdraw");
require(fundingStorage[_id].totalCollected >= fundingStorage[_id].targetAmount, "Target amount hasn't reached");
require(block.timestamp >= fundingStorage[_id].deadline, "Deadline hasn't reached");
require(fundingStorage[_id].totalCollected > 0, "Already Withdrawn");

// Saves the total amount of contribution to this variable before reseting the state of the transaction
uint amount = fundingStorage[_id].totalCollected;

// prevent double withdraw
fundingStorage[_id].totalCollected = 0;

(bool success,) = msg.sender.call{value: amount}("");
require(success, "Transafer failed");
}



// this function refunds the money of the contributors back if they want a refund and if the target the project placed didn't complete and the deadline has passed
function refundFunds(uint _id) external {
require(block.timestamp <= fundingStorage[_id].deadline, "Deadline has reached");
require(contributorsFunds[_id][msg.sender] > 0, "You didn't contribute or already refunded");
require(fundingStorage[_id].totalCollected < fundingStorage[_id].targetAmount, "Target amount has reached");


// assigning the amount the contributor contributed to this varaible for easy access when attempting too refund.
uint amount = contributorsFunds[_id][msg.sender];

// setting the state to zero to avoid double request for refund after refund
contributorsFunds[_id][msg.sender] = 0;

(bool success,) = msg.sender.call{value: amount}("");
require(success, "Transafer failed");

}





}


Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import "dotenv/config";
import hardhatToolboxMochaEthersPlugin from "@nomicfoundation/hardhat-toolbox-mocha-ethers";
import { configVariable, defineConfig } from "hardhat/config";

export default defineConfig({
plugins: [hardhatToolboxMochaEthersPlugin],
solidity: {
profiles: {
default: {
version: "0.8.28",
},
production: {
version: "0.8.28",
settings: {
optimizer: {
enabled: true,
runs: 200,
},
},
},
},
},
networks: {
hardhatMainnet: {
type: "edr-simulated",
chainType: "l1",
},
hardhatOp: {
type: "edr-simulated",
chainType: "op",
},
sepolia: {
type: "http",
chainType: "l1",
url: configVariable("SEPOLIA_RPC_URL"),
accounts: [configVariable("SEPOLIA_PRIVATE_KEY")],
},
},
verify: {
etherscan: {
apiKey: configVariable("ETHERSCAN_API_KEY"),
},
},
});
Loading