Skip to content

Commit

Permalink
Clean up repo (#159)
Browse files Browse the repository at this point in the history
* Clean up repo

* Move safe callback
  • Loading branch information
hensha256 authored Jul 18, 2024
1 parent 087a262 commit f242024
Show file tree
Hide file tree
Showing 46 changed files with 14 additions and 7,160 deletions.
7 changes: 0 additions & 7 deletions .env

This file was deleted.

22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,6 @@ Uniswap v4 is a new automated market maker protocol that provides extensibility

If you’re interested in contributing please see the [contribution guidelines](https://github.com/Uniswap/v4-periphery/blob/main/CONTRIBUTING.md)!

## Repository Structure

```solidity
contracts/
----hooks/
----examples/
| GeomeanOracle.sol
| LimitOrder.sol
| TWAMM.sol
| VolatilityOracle.sol
----libraries/
| Oracle.sol
BaseHook.sol
test/
```

To showcase the power of hooks, this repository provides some interesting examples in the `/hooks/examples/` folder. Note that none of the contracts in this repository are fully production-ready, and the final design for some of the example hooks could look different.

Eventually, some hooks that have been audited and are considered production-ready will be placed in the root `hooks` folder. Not all hooks will be safe or valuable to users. This repository will maintain a limited set of hook contracts. Even a well-designed and audited hook contract may not be accepted in this repo.

## Local Deployment and Usage

To utilize the contracts and deploy to a local testnet, you can install the code in your repo with forge:
Expand All @@ -38,7 +18,7 @@ If you are building hooks, it may be useful to inherit from the `BaseHook` contr

```solidity
import {BaseHook} from 'v4-periphery/contracts/BaseHook.sol';
import {BaseHook} from 'v4-periphery/src/base/hooks/BaseHook.sol';
contract CoolHook is BaseHook {
// Override the hook callbacks you want on your hook
Expand Down
41 changes: 0 additions & 41 deletions contracts/base/PeripheryPayments.sol

This file was deleted.

11 changes: 0 additions & 11 deletions contracts/base/PeripheryValidation.sol

This file was deleted.

Loading

0 comments on commit f242024

Please sign in to comment.