From aa945f356d775419bd2429977686bf9ae49e01d3 Mon Sep 17 00:00:00 2001
From: Blackienbad <22733639+BlackienBad@users.noreply.github.com>
Date: Fri, 18 Oct 2024 17:54:33 +0200
Subject: [PATCH 1/2] Insurance Premium Hook
Balancer Hackaton Hook Submission
---
README.md | 311 +---------------
diagram.png | Bin 0 -> 440169 bytes
.../contracts/hooks/InsurancePremiumHook.sol | 314 +++++++++++++++++
.../contracts/hooks/interfaces/IERC4626.sol | 111 ++++++
.../hooks/interfaces/IOutflowProcessor.sol | 78 ++++
.../contracts/hooks/interfaces/IPoolImpl.sol | 91 +++++
.../foundry/test/InsurancePremiumHook.t.sol | 332 ++++++++++++++++++
roadmap.png | Bin 0 -> 853715 bytes
8 files changed, 945 insertions(+), 292 deletions(-)
create mode 100644 diagram.png
create mode 100644 packages/foundry/contracts/hooks/InsurancePremiumHook.sol
create mode 100644 packages/foundry/contracts/hooks/interfaces/IERC4626.sol
create mode 100644 packages/foundry/contracts/hooks/interfaces/IOutflowProcessor.sol
create mode 100644 packages/foundry/contracts/hooks/interfaces/IPoolImpl.sol
create mode 100644 packages/foundry/test/InsurancePremiumHook.t.sol
create mode 100644 roadmap.png
diff --git a/README.md b/README.md
index 1397b2da..019a0b93 100644
--- a/README.md
+++ b/README.md
@@ -1,301 +1,28 @@
-# ποΈ Scaffold Balancer v3
+# Insurance Premium Hook
-A starter kit for building on top of Balancer v3. Accelerate the process of creating custom pools and hooks contracts. Concentrate on mastering the core concepts within a swift and responsive environment augmented by a local fork and a frontend pool operations playground.
+Insurance is crucial for new or high-risk protocols in DeFi to provide coverage in the event of failures or other risks. However, for the insurance to be effective, a premium must be paid to the insurer. This hook collects a fee when liquidity is added or removed proportionally, and uses it to pay the insurance premium.
-[](https://www.youtube.com/watch?v=m6q5M34ZdXw)
+
-### π Development Life Cycle
+Currently, the hook does this:
+1. Takes a fee when the addition/removal of liquidity is proportionalΒΉ
+2. Uses the fee to add liquidity back and receives a BPT
+3. Deposits the BPT into an [atomica pool](https://www.atomica.org/), since an atomica pool is basically an ERC4626, the user will receive the shares of the atomica pool, essentially wrappedBPTs
+4. The hook will also work as an outflow processor for the atomica pool, it will determine permissionlessly if a user can be granted an outflow request based on when he deposited, this is decided based on when the premium was deposited, if the premium was deposited more than 10 days ago, then the request is approved, otherwise it is rejectedΒ².
-1. Learn the core concepts for building on top of Balancer v3
-2. Configure and deploy factories, pools, and hooks contracts to a local anvil fork of Sepolia
-3. Interact with pools via a frontend that runs at [localhost:3000](http://localhost:3000/)
+ΒΉ It needs to be proportional because of how the hooks work now, as of now, from the current documentation there seem to be no way of receiving directly the bpts as fee, and using an unproportional amount of tokens would require the hook to receive the fee as bpts
-### πͺ§ Table Of Contents
+Β² For example this is done to insure that no predatorial funds can come in and claim, an insurance refund on a stablecoin after it has already depegged.
-- [π§βπ» Environment Setup](#-environment-setup)
-- [π©βπ« Learn Core Concepts](#-learn-core-concepts)
-- [π΅οΈ Explore the Examples](#-explore-the-examples)
-- [π Create a Custom Pool](#-create-a-custom-pool)
-- [π Create a Pool Factory](#-create-a-pool-factory)
-- [πͺ Create a Pool Hook](#-create-a-pool-hook)
-- [π’ Deploy the Contracts](#-deploy-the-contracts)
-- [π§ͺ Test the Contracts](#-test-the-contracts)
+# Roadmap
-## π§βπ» Environment Setup
+
-### 1. Requirements π
+For now this is more of a proof of concept and can be improved upon greatly.
+The improvements are:
+Phase 1: (we are currently in this phase) Present the idea on the hackaton and see if it has traction.
+Phase 2: Improve the calculation of the fee from a static fee decided by an owner to a dynamic fee that is calculated based on how much insurance is needed for the pool
+Phase 3: Improve the permissionaless side of the hook and make it act as an outflow processor also for the insurer side (right now is being an outflow processor only for the user)
+Phase 4: Being able to receive directly BPTs (so even liquidity that is added or removed not proportionally) and being able to insure also only 1 of the tokens of the pool
-- [Node (>= v18.17)](https://nodejs.org/en/download/)
-- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
-- [Git](https://git-scm.com/downloads)
-- [Foundry](https://book.getfoundry.sh/getting-started/installation) (>= v0.2.0)
-
-### 2. Quickstart π
-
-1. Ensure you have the latest version of foundry installed
-
-```
-foundryup
-```
-
-2. Clone this repo & install dependencies
-
-```bash
-git clone https://github.com/balancer/scaffold-balancer-v3.git
-cd scaffold-balancer-v3
-yarn install
-```
-
-3. Set a `SEPOLIA_RPC_URL` in the `packages/foundry/.env` file
-
-```
-SEPOLIA_RPC_URL=...
-```
-
-4. Start a local anvil fork of the Sepolia testnet
-
-```bash
-yarn fork
-```
-
-5. Deploy the mock tokens, pool factories, pool hooks, and custom pools contracts
- > By default, the anvil account #0 will be the deployer and recieve the mock tokens and BPT from pool initialization
-
-```bash
-yarn deploy
-```
-
-6. Start the nextjs frontend
-
-```bash
-yarn start
-```
-
-7. Explore the frontend
-
-- Navigate to http://localhost:3000 to see the home page
-- Visit the [Pools Page](http://localhost:3000/pools) to search by address or select using the pool buttons
-- Vist the [Debug Page](http://localhost:3000/debug) to see the mock tokens, factory, and hooks contracts
-
-8. Run the Foundry tests
-
-```
-yarn test
-```
-
-### 3. Scaffold ETH 2 Tips ποΈ
-
-SE-2 offers a variety of configuration options for connecting an account, choosing networks, and deploying contracts
-
-π₯ Burner Wallet
-
-If you do not have an active wallet extension connected to your web browser, then scaffold eth will automatically connect to a "burner wallet" that is randomly generated on the frontend and saved to the browser's local storage. When using the burner wallet, transactions will be instantly signed, which is convenient for quick iterative development.
-
-To force the use of burner wallet, disable your browsers wallet extensions and refresh the page. Note that the burner wallet comes with 0 ETH to pay for gas so you will need to click the faucet button in top right corner. Also the mock tokens for the pool are minted to your deployer account set in `.env` so you will want to navigate to the "Debug Contracts" page to mint your burner wallet some mock tokens to use with the pool.
-
-
-
-
-
-π Browser Extension Wallet
-
-- To use your preferred browser extension wallet, ensure that the account you are using matches the PK you previously provided in the `foundry/.env` file
-- You may need to add a local development network with rpc url `http://127.0.0.1:8545/` and chain id `31337`. Also, you may need to reset the nonce data for your wallet exension if it gets out of sync.
-
-π Debug Contracts Page
-
-The [Debug Contracts Page](http://localhost:3000/debug) can be useful for viewing and interacting with all of the externally avaiable read and write functions of a contract. The page will automatically hot reload with contracts that are deployed via the `01_DeployConstantSumFactory.s.sol` script. We use this handy setup to mint `mockERC20` tokens to any connected wallet
-
-π Changing The Frontend Network Connection
-
-- The network the frontend points at is set via `targetNetworks` in the `scaffold.config.ts` file using `chains` from viem.
-- By default, the frontend runs on a local node at `http://127.0.0.1:8545`
-
-```typescript
-const scaffoldConfig = {
- targetNetworks: [chains.foundry],
-```
-
-π΄ Changing The Forked Network
-
-- By default, the `yarn fork` command points at sepolia, but any of the network aliases from the `[rpc_endpoints]` of `foundry.toml` can be used to modify the `"fork"` alias in the `packages/foundry/package.json` file
-
-```json
- "fork": "anvil --fork-url ${0:-sepolia} --chain-id 31337 --config-out localhost.json",
-```
-
-- To point the frontend at a different forked network, change the `targetFork` in `scaffold.config.ts`
-
-```typescript
-const scaffoldConfig = {
- // The networks the frontend can connect to
- targetNetworks: [chains.foundry],
-
- // If using chains.foundry as your targetNetwork, you must specify a network to fork
- targetFork: chains.sepolia,
-```
-
-2R%2<;aTeih-f>%^G}o;2ak*kM>qtJJAh+)=mob;zA&aMqstV#e}u`^+TqI
z7@VPOMVf4B(#DDI0(T$M57ga_R&kBk@v0gVqcyP_8z1DeiW5<7me;n|3%$C!*tQz;
z!tfE55|w9W{q5Y%+<7&R06I9qgYhYA**z^A(0HNtK9h|&A^J7a`eruNF8-Ar23kpb
zJR(Z!dr`0;t6svExnVp|?xGh(xow?hQ>ImFJQV5P^XjM?E}N)IPvC($tmnXA1zYJ~zQ;OKdA(K%FU~?f3-c2$L=CLvTg)b_XVSgGxJRHAln1H(
z4EeZ&x9xDcpNd0acXc}3x1n|S4bge$!F-Ko0za%>Rb`SJ^f-J+J9BV+0|7L&dycTx
z&=$qG9Vld;l&E}n9Z7=mxQOyF6d`cEy5XL;iPd#r2Z+R7`cVT$slfgyqs{r&{ERQ}
zuD*rwee;~^NNq8)q8C~W4!%2E;r{w8nVu_LM(_Fw^J<^Jb6e#N_Gm`=r$y$+0R6$GIKnSl>J~tMY^o3{H<4BRd`w0#ZZn;$ynk)n}+qq
zG%{R!+d3soZveLYQ1m1X`O>2KuwByygb05DBC))G_oxrpf}OTVxU7a3*(FGWit>xp
zj#9@jQGD}lFXBJ5FD2f*2FPr^LKn^hi?wW+{?Ph{{?k6M*@?@iL(#`T*1dZ>)OwXXk5aZs
zo<)ZZM=QEbBK%k@r&DxcL2Ud(qX;CKn+=^|)~}PW>s}n5UdmbZ`sy&4s)l!EuJ4J0
zB#IS4c_5`Yfl&hYG_o)lCr<9X7*RHN?`?t0-5+gLwoRS!vP?QmgA%vZ6X*I$Etb-T
zX?G+@8ifrDvXAf?Ak==iQMgGC{HL1qw+;=6N4V~{y5|4!B5kx!I7I~s0%gQ}aTz?0
z@UMzkrrsln^DTCFe9dEQ4n?RGrD}9V>^%*CV_*8H#41f~{%5~8l+99)WL5KO
zxqNS0FI>N>&fq78!y9~~pJ61^!fvn;Thpe*kJpjB32NYo4v-_zu)?p{?Y!*e!ar2F
z>b1P8>sWmO$>~+P;)NOhm~x=qgaqMTg3?__!XeTbDL})nde~33<#h{Ih
z^kO6Tu;{B~Og!n*#DRm%V8s0bh=)ysZC{6b$ad~2v_5E#J_ubr8|7@cII+IS8LYs>dB}Aeemc6
z6ZXsS!TZNA=v|D0H(6M-tIRn`Y@_)$dV|!?IiA@hu(X`0fy!<_*Y*El;ihgIPJ(s(&C
z*j252D1~p#1;~t8ezHBRZosuMsipbj2Ds2GhONZZpq135>E8w>*6oD$ro5I`ORtoJ
zCco{Upf=yH!Bc^gnq3~pPxf#Hiom=u3D8lK7V3(cM-$vsa=Bfzu(|a#h?g+FgYJiMM3CB6kP1(+XpXug_52SH{?RYaK+B42W*GfD#pS?
zGuyxIO3mTLVoX@Hp|d$(XkF2glH@UZ2C{{;?~8DX;s5D-2PfP+@6-D&D9ILdf;C7x
z++%?=QW%u!oVZ{2l78W&=|<iv0^{>9cYawfv5)*EmB
z9GtT1t7ozL2FXbod^x1BvPeJBMfPWV
zP*U~9S^U#Pxoc6zk~@6Qk_%WTzdxoa6cW(+yZ>KI67M?Rzv|D&RDO9Iv0*a7!IP?*
z`yzs>bl@k;ua=oSsZRzX7p~_
z?p(nUYzp_iw%)#+3T=Tc0aG-YgPoVkS76Ypg=IglBqD*L+-@`f-$X7
znCQj`wFv@YGMsl)Fmon=N3_EBr$DXWCzLcEOh63Wy?7j_T@
zH9jlD6wWC4)nL6CKzizeJ58gfl*V`sdW0PmER3pB++C3)u$a~^t!jjlMy<)$+&1mC
zqSoiblEsd2VAo#&3nq{dUZJ`|!9*hiB?WqXWh+d%((b!FeyUyZY6>s!r*{(M)PY>#
zk-zZ4i-;%XMkAv&=nwQ3&r}JECw?g`HX8E`n6Y^(TB(%})><|jkc}tTRNPrs``VOP
z_qZh$@n;QBGOcb*Vy~s#^rip9pp~?$+aLlPQ{=QS{x58cm)CB{h9%c!J2njKtRnLj>aP@J47wnb*Y1JJ4Zu{MQTgg~n&fKoCI
z^8lqx>0T`CBWR`FRD2<+j_2lRs1dhE`@1?S%IU(#$ZNbyWaN}i(yZJBHhLV(46I#{
zD~pDX2E`j6tAqY-U+&|#*GBsvxAHZP)>nNs&v^Dv%QX+BiDI;bANvJjnvPTLWsktNmExXhUIK-&Q95pD&L(9f{Zx?uZd#-z{!e;bpI=!Ckbtpwe85^Kn?+-~CB9
zf8z^cjxLOVlh`kL$ykgv>NxgL_n|i0o~<=jthZYZRSFiT*K55iAZES&$LS7ta&!D=
z`tk)>A7@%aRwnzbT<*VN(uc1{uuf^&Yr;ud&=zUjdYla+2yvBgP)(`}lp&V^h%6IW
zYvR@=Q2ZOb3v
zhdN&eGr5ppX=vgz*5DCE2NBx+n$mY}fuB!#6#JEBH@U5x!gAS!&+H%gRouqXZuozV
zD>MH2N0Hm3rF`i^|J&L=1RrZ>9>}gNHqMg|U4;!7i(A1@tMN3Vc42;h6BZ!Ve=&dI
zFQ;&}#qRh~#
zME1~0r%NWHd#!gbw%QUgJ!EA96dCm$Ig`94`^9D8;TYWPe;0(GJC&p#QE!NzpFREI
zTTY02s24B%LDiyLz}@hj3zkLNQamc6scJ^==lgnR+PSd+zJtl43cOAc!(A5p2X
zTXK#~Ap57e6g?FJ@^}D7z8&U#*hOt=oCzV)^^Ia+@+kI^-pJi^2xzo${7L{1;0*W6
zK$VfZ7zU0)ccDUfCZ?(V)wriTo-2qUYjqmh*ejAcy@l;8%hm8P;qwP+?~50UYLR5%q*{s6btZ7@&BYfXDboOpRVU_
zcV-LWQxFdHEuH!r9zPX}`mGyTyz60#>kqq>{^SFJaku*8^0gJQbk9+Fi?@lWujmIe
z+HMI!dAP!pXTdYjYe*1|g?xV+qh5#|_rBE}M2_V`CAZZ_`>
zug!|%{rc`{TQ91E12SiuG;&8c4f3DoaDni3zANA4nzg=a8=RxZr`xXeE5~b-CC)=6
zB1HFTlyZY&RWBQsd}i?gPI2k;NRR$=9wHcv`Bws1dN##8-+qZV+wyhngT^t0MQ^g2_eob-lg#9XN(@J3_R
z7*}^<{y$A6r-jvW=vb@`Rb?j-JkWxe`{b?4$&C;5
zszIZ@OY>I(c8lOUZ*!mupeXO#+5GKHh@w6TxRC&9|L`SyA2xz0=o4>(?c=9R%zITF
zi3fQL$h~$@s)&`%HBIgOPP}A~rZ96XQ?rTnd?rud}lu%3q
z9+4@3^Hb-w=C^q^zt1DRa`UyC!pde^{FP~=g1f1Iw?6#QZ}n8aJW6-|ZJE>|{qt*N
z08y}*GWKcOMIqfbnS3B_?o&3rkscB3hfS<4Si1)i-;^V{DFJ%Q!UKJ4KygrULki9@
zz?4_fUB=HD6d|EVNxj=!AtrsV7iCgmTL<-kJm>R8>1;H|=nFIyjFD8!VLc;}ObIU%
zKGa6};;|FsMbhoUxZMnAy?_e%%i&*MJ+J_&O?|W2_dMUxPeD&NCUQ4190DzD9FvPU|ME|U-enA
z=(Rh$ehIBZ!#J;i2A|lVuHSpD{USB}J1%%qAx?Oz&;1roN#Jzq>A?@1)E2{xa6UKWS_e@U
z%~+kOm<`yB^|}ow$sHAjZgk01z?P0UtuqU*oeT++aF?Lh%eSWtZsn%G`9+DAm
zf%wmgEgS{2gVu70F(!EtFATU){0bHumEoRmceXDslxu%n6o|Rt;2@hXN}+Ekx_m#
zobHf_WYg%iULa?}lXBAFP-q(6-Paf=ri4{_hky6}cieC_l{xNPrFWNU2w-n2G`peS
zsZNe{iltarV}oiKPet~weUYEuD;A$RP``MiHtdkJ@=}}JBg(6f`5t`kw>_vqnuWQc
zblIOAs!ShV`#TJa_ofHud+#v`t#FbJDcZG