Angstrom Hooks with tests

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Test
-        run: yarn test:forge
+        run: yarn test:forge-with-hardhat
 
   test-hardhat:
     runs-on: ubuntu-latest

README.md

@@ -1,17 +1,56 @@
-# custom-pool-v3
+# Balancer V3 Angstrom Router and Hook
 
-Example of external custom pool for Balancer V3. Extend it to create new pool types.
+A specialized router and hook system for Balancer V3 that implements node-based access control and block-level unlocking mechanisms for Angstrom pools.
 
-# Requirements
+## Overview
+
+The Angstrom Router is a combination of a batch router and hook that provides controlled access to Angstrom pools within the Balancer V3 ecosystem. It ensures that only registered nodes can perform swaps and unbalanced liquidity operations before the network is unlocked for a given block, maintaining price consistency with off-chain computations.
+
+## Key Features
+
+### 🔐 Node-Based Access Control
+
+- Only registered Angstrom nodes can perform the first swap and/or liquidity transaction (before network unlock)
+- Node registration is managed through authenticated `toggleNodes()` function
+- Prevents unauthorized access to locked pools
+
+### 🔓 Block-Level Unlocking
+
+- Network can only be unlocked once per block
+- Unlocking is global - once unlocked, all pools accept operations from any router
+
+### 🔄 Dual Operation Modes
+
+- **Router Mode**: Direct swaps against pools, as a registered node (no signature required)
+- **Hook Mode**: Operations through any router with cryptographic signature verification (node register is still required)
+
+### 📊 Comprehensive Swap Support
+
+- Exact amount in swaps (`swapExactIn`)
+- Exact amount out swaps (`swapExactOut`)
+- Query functions for both swap types
+- Support for multi-hop routing through multiple pools
+
+### 🏊 Liquidity Hooks for pools
+
+- Proportional liquidity operations (no unlock required)
+- Unbalanced liquidity operations (requires network unlock)
+- Hook-based validation for all liquidity operations
+
+## Requirements
 
 - Node.js v18.x (we recommend using nvm to install it)
 - Yarn v4.x
 - Foundry v1.0.0
 
-# Installation
+## Installation
+
+If it's the first time running the project, run `sh ./scripts/install-fresh.sh` to install the dependencies and build the project. It'll download and compile V3 monorepo, creating node_modules folders in the library (these folders will be needed to use monorepo as a submodule of the angstrom project).
+
+## Testing
 
-If it's the first time running the project, run `sh ./scripts/install-fresh.sh` to install the dependencies and build the project. It'll download and compile V3 monorepo, creating node_modules folders in the library (these folders will be needed to use monorepo as a submodule of the custom pool, so tests can use the base test files).
+After installing the dependencies, run `yarn test:forge` to run forge tests. Also, run `yarn coverage` to generate a coverage report.
 
-# Testing
+## Contributing
 
-After installing the dependencies, run `yarn test` to run forge and hardhat tests.
+This project is part of the Balancer ecosystem. Please refer to the main Balancer repository for contribution guidelines.