Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish docs #253

Merged
merged 3 commits into from
May 8, 2024
Merged
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
89 changes: 19 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,91 +27,40 @@ The PufferPool repo contains the smart contracts to handle all validator and res
---
- See [/docs/README.md](./docs/README.md) for technical documentation
- See the [pufETH repo](https://github.com/PufferFinance/pufETH) for information on Puffer's LRT
- See the [website docs](https://docs.puffer.fi) for information on Puffer
- See the [website docs](https://docs.puffer.fi) for all other information on Puffer Protocol

### Testing

## Deployments
For all deployment, contract addresses, ABIs, and more, see the [Deployments and ACL](https://github.com/PufferFinance/Deployments-and-ACL/tree/main/docs/deployments) repository. You can also find the deployment for each release on the [releases page](https://github.com/PufferFinance/PufferPool/releases).


## Audits
- Trail of Bits: [Audit Report](https://github.com/trailofbits/publications/blob/master/reviews/2024-03-pufferfinance-securityreview.pdf)
- Nethermind: [Audit Report](https://github.com/NethermindEth/PublicAuditReports/blob/main/NM0202-FINAL_PUFFER.pdf)
- SlowMist [Audit Report](./docs/audits/SlowMist_PufferFinance_Phase2.pdf)
- Blocksec: [Audit Report](./docs/audits/Blocksec_audit_April2024.pdf)
- Creed: [Audit Report](./docs/audits/Creed_Puffer_Finance_Audit_April2024.pdf)



# Testing
---
Follow the [Foundry docs](https://book.getfoundry.sh/) for installation instructions, then install all dependencies and run tests by executing:

```
forge test
```

**Running Unit Tests**
## Running Unit Tests

Refine the command as follows:
```
forge test -vvv --match-path './test/unit/*'
```

**Running Fork Tests**
## Running Fork Tests

Fork tests require first setting the `ETH_RPC_URL` and `HOLESKY_RPC_URL` environment variables to pass (archive nodes).
```
forge test --no-match-path './test/fork-tests/*'
```
### Audit Reports
---
- Nethermind: [Audit Report](./docs/audits/Nethermind_PufferProtocol_NM0202_April2024.pdf)
- SlowMist: [todo]()
- BlockSec: [todo]()
- Creed: [todo]()

## Deployments


### Mainnet

###### Core

| Name | Proxy | Implementation |
| ------------------------------- | ----- | -------------- |
| PufferVault | [0xD9A442856C234a39a81a089C06451EBAa4306a72](https://etherscan.io/address/0xD9A442856C234a39a81a089C06451EBAa4306a72) | [0x7C93...09B6](https://etherscan.io/address/0x7C93eDab7326E5Ff8d5B89B13e3681216Ab409B6) |
| PufferDepositor | [0x4aA799C5dfc01ee7d790e3bf1a7C2257CE1DcefF](https://etherscan.io/address/0x4aa799c5dfc01ee7d790e3bf1a7c2257ce1dceff) | [0x55F4...a304](https://etherscan.io/address/0x55F4d6Acf015c878A88C8CD08a9D74ea0d40a304) |
| Timelock | - | [0x3C28...26eA](https://etherscan.io/address/0x3C28B7c7Ba1A1f55c9Ce66b263B33B204f2126eA) |
| AccessManager | - | [0x8c16...EE11](https://etherscan.io/address/0x8c1686069474410E6243425f4a10177a94EBEE11) |
| PufferProtocol | [todo]() | [todo]() |
| EnclaveVerifier | - | [todo]() |
| GuardianModule | - | [todo]() |
| PufferModuleManager | [todo]() | [todo]() |
| PufferOracle | - | [todo]() |
| PufferModuleBeacon | [todo]() | - |
| PufferModule | - | [todo]() |
| RestakingOperatorBeacon | [todo]() | - |
| RestakingOperator | - | [todo]() |
| ValidatorTicket | [todo]() | [todo]() |

###### Multisig
| Name | Address |
| ------------------------------- | -------------- |
| Pauser Multisig | [0x1ba8e3aA853F73ae8093E26B7B8F2520c3620Df4](https://etherscan.io/address/0x1ba8e3aA853F73ae8093E26B7B8F2520c3620Df4) |
| Community Multisig | [0x446d4d6b26815f9bA78B5D454E303315D586Cb2a](https://etherscan.io/address/0x446d4d6b26815f9bA78B5D454E303315D586Cb2a) |
| Operations Multisig | [0xC0896ab1A8cae8c2C1d27d011eb955Cca955580d](https://etherscan.io/address/0xC0896ab1A8cae8c2C1d27d011eb955Cca955580d) |


### Holesky

| Name | Proxy | Implementation |
| ----------------------------- | ----- | -------------- |
| PufferVault (pufETH) | [0x98408eadD0C7cC9AebbFB2AD2787c7473Db7A1fa](https://holesky.etherscan.io/address/0x98408eadD0C7cC9AebbFB2AD2787c7473Db7A1fa) | [0x3Ed1...72F5](https://holesky.etherscan.io/address/0x3Ed1653677626C38afcf88C6Eec954EE805B72F5) |
| PufferDepositor | [0x9BEF4B8E025ecc91FE5Ee865f4880b106F106e5a](https://holesky.etherscan.io/address/0x9BEF4B8E025ecc91FE5Ee865f4880b106F106e5a) | [0x335b...18e6](https://holesky.etherscan.io/address/0x335b6c8f5aa0073849a174c73eba985b851d18e6) |
| AccessManager | - | [0xA6c9...38fF](https://holesky.etherscan.io/address/0xA6c916f85DAfeb6f726E03a1Ce8d08cf835138fF) |
| PufferProtocol | [0x705E27D6A6A0c77081D32C07DbDE5A1E139D3F14](https://holesky.etherscan.io/address/0x705E27D6A6A0c77081D32C07DbDE5A1E139D3F14) | [0xEFd2...8642](https://holesky.etherscan.io/address/0xEFd2C463CD787e1e9119873dc0cbFd0AE28D8642) |
| EnclaveVerifier | - | [0x7920...Df24](https://holesky.etherscan.io/address/0x79200dE6299F27b7354Ca95A09a9C3978DBEDf24) |
| GuardianModule | - | [0xD349...b326](https://holesky.etherscan.io/address/0xD349FdCD0e4451381bfE7cba3ac28773E176b326) |
| PufferModuleManager | [0xe4695ab93163F91665Ce5b96527408336f070a71](https://holesky.etherscan.io/address/0xe4695ab93163F91665Ce5b96527408336f070a71) | [0x1145...234e](https://holesky.etherscan.io/address/0x11459c5d3e8502ce5afb745619cdb6900f1b234e) |
| PufferOracle | - | [0xEf93...7b74](https://holesky.etherscan.io/address/0xEf93AA29F627465A7f58A1F25980c90116f27b74) |
| PufferModuleBeacon | [0x5B81A4579f466fB17af4d8CC0ED51256b94c61D4](https://holesky.etherscan.io/address/0x5B81A4579f466fB17af4d8CC0ED51256b94c61D4) | - |
| PufferModule | - | [0x0F5B...3e6a](https://holesky.etherscan.io/address/0x0F5B5b94B9f91601EAB9bC2e74D70Aea8C203e6a) |
| RestakingOperatorBeacon | [0xa7DC88c059F57ADcE41070cEfEFd31F74649a261](https://holesky.etherscan.io/address/0xa7DC88c059F57ADcE41070cEfEFd31F74649a261) | - |
| RestakingOperator | - | [0x89fE...0fA5](https://holesky.etherscan.io/address/0x89fE1Ab8A0f74494Bf3Fc0f238d40799BA360fA5) |
| ValidatorTicket | [0xA143c6bFAff0B25B485454a9a8DB94dC469F8c3b](https://holesky.etherscan.io/address/0xA143c6bFAff0B25B485454a9a8DB94dC469F8c3b) | [0x5C67...4325](https://holesky.etherscan.io/address/0x5C67fb4410797960C45e573e266A7B79d5Bb4325) |


# Audits
- Nethermind: [Audit Report](./docs/audits/Nethermind_PufferProtocol_NM0202_April2024.pdf)
- Blocksec: [Audit Report](./docs/audits/Blocksec_audit_April2024.pdf)
- Creed: [Audit Report](./docs/audits/Creed_Puffer_Finance_Audit_April2024.pdf)

# See [/docs/README.md](./docs/README.md) for more documentation

```
4 changes: 3 additions & 1 deletion docs/AccessManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ Puffer's [Timelock contract](../lib/pufETH/docs/Timelock.md) is the owner of the
## Deployments

- **AccessManager**: https://etherscan.io/address/0x8c1686069474410e6243425f4a10177a94ebee11
- **Timelock**: https://etherscan.io/address/0x3C28B7c7Ba1A1f55c9Ce66b263B33B204f2126eA
- **Timelock**: https://etherscan.io/address/0x3C28B7c7Ba1A1f55c9Ce66b263B33B204f2126eA

For more information on the deployment, see the [Deployments and ACL](https://github.com/PufferFinance/Deployments-and-ACL/blob/main/docs/deployments/) repository.
Binary file added docs/audits/SlowMist_PufferFinance_Phase2.pdf
Binary file not shown.
Loading