diff --git a/README.md b/README.md index 9a24319..b8b65f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -## Module Template +[![test](https://github.com/onchainification/oxford-hackathon-2024/actions/workflows/test.yml/badge.svg)](https://github.com/onchainification/oxford-hackathon-2024/actions/workflows/test.yml) -**A template for building smart account modules using the [ModuleKit](https://github.com/rhinestonewtf/modulekit)** +# Revoooker + +rhinestone module that revokes erc20 approvals with lower signer threshold ## Usage @@ -10,48 +12,8 @@ pnpm install ``` -### Update ModuleKit - -```shell -pnpm update rhinestonewtf/modulekit -``` - -### Building modules - -1. Create a new file in `src` and inherit from the appropriate interface (see templates) -2. After you finished writing your module, run the following command: - -```shell -forge build -``` - ### Testing modules -1. Create a new `.t.sol` file in `test` and inherit from the correct testing kit (see templates) -2. After you finished writing your tests, run the following command: - ```shell -forge test +forge test -vvv ``` - -### Deploying modules - -1. Import your modules into the `script/DeployModule.s.sol` file. -2. Create a `.env` file in the root directory based on the `.env.example` file and fill in the variables. -3. Run the following command: - -```shell -source .env && forge script script/DeployModule.s.sol:DeployModuleScript --rpc-url $DEPLOYMENT_RPC --broadcast --sender $DEPLOYMENT_SENDER --verify -``` - -Your module is now deployed to the blockchain and verified on Etherscan. - -If the verification fails, you can manually verify it on Etherscan using the following command: - -```shell -source .env && forge verify-contract --chain-id [YOUR_CHAIN_ID] --watch --etherscan-api-key $ETHERSCAN_API_KEY [YOUR_MODULE_ADDRESS] src/[PATH_TO_MODULE].sol:[MODULE_CONTRACT_NAME] -``` - -## Tutorials - -For general explainers and guided walkthroughs of building a module, check out our [documentation](https://docs.rhinestone.wtf/modulekit).