Skip to content

Commit

Permalink
chore: adds docs on how to use custom contracts
Browse files Browse the repository at this point in the history
  • Loading branch information
iPaulPro committed Jan 12, 2024
1 parent 0b901fa commit 360b9a5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This repo demonstrates how to debug and test the `TipActionModule`. Additions to
- [Debugging](#debugging)
- [Unit Testing](#testing)
- [Deploying to Mumbai](#deploying-to-mumbai)
- [Using your own contracts](#using-your-own-contracts)
- [About Scaffold-ETH 2](#about-scaffold-eth-2)

## Requirements
Expand Down Expand Up @@ -185,6 +186,15 @@ Once you are ready to deploy your smart contracts, there are a few things you ne
```
---

## Using your own contracts

If you want to use your own contracts there are a few simple steps.

1. Replace the `TipActionModule.sol` contract in `/packages/hardhat/contracts` with your own.
2. Update the script(s) in `/packages/hardhat/deploy` to deploy your contract(s) instead of the mock contracts.
3. Change the tag in the `deploy:mumbai` script in `/packages/hardhat/package.json` to the tag(s) of your contract(s).
4. (Optional) Remove the `/packages/hardhat/contracts/helpers` directory and related deploy scripts unless you want to use the `MockModuleRegistry` and `TestToken` contracts for testing and debugging.

## About Scaffold-ETH 2

Scaffold-ETH is an open-source toolkit for building Ethereum dapps, built using NextJS, RainbowKit, Hardhat, Wagmi, and Typescript.
Expand Down

0 comments on commit 360b9a5

Please sign in to comment.