Skip to content

Commit

Permalink
Merge pull request #31 from metastable-labs/njokuScript-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
njokuScript authored Jan 11, 2025
2 parents 7e7928f + 8cbcd69 commit 03e837a
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,39 @@
# Liquid Protocol

A protocol for Liquidity and best yield aggregation.
Liquid Curator is a permissionless strategy curation protocol. It introduces a new primitive for creating, managing, and executing complex DeFi strategies across multiple protocols. The protocol enables trustless strategy curation with atomic execution. It provides a framework for strategy composers to create and monetize their expertise while allowing users and AI Agents to discover, evaluate, and participate in these strategies with minimal friction.

## Architecture

The protocol consists of several key components:

### 1. Strategy Module
- **Strategy Contract**: Core contract that manages strategy creation and tracking
- Stores strategy metadata and execution steps
- Tracks strategy statistics and performance
- Manages user participation records
- Handles curator registration

### 2. Execution Engine
- **Engine Contract**: Handles atomic execution of strategy steps
- Validates and executes multi-step strategies
- Manages token approvals and transfers
- Ensures atomic execution (all steps succeed or revert)
- Updates strategy and user statistics

### 3. Protocol Connectors
- **Connector Contracts**: Protocol-specific adapters that:
- Standardize interactions with external protocols (Morpho, Moonwell, etc.)
- Handle protocol-specific logic and token conversions
- Track protocol-level balances and shares
- Report performance metrics back to the strategy module

### Component Diagram
[![](https://mermaid.ink/img/pako:eNp9kktvwjAMx79K5HPp-kKUakKaSo9IkwqXtRxCa0q1NkZposEQ330Z5VEOW6REf9s_O87jBAWVCBFUku93bDnPBTNjlcVackVyzUajGUuzVBkTqyNbUKkbXPfYIlt1eGWSLDlgoVVNgiWiqsUNSv8PJ5dw7GYxCYGF2ZO5rxv5MkO7ss12cr-jZ9QboN4QJfGFTfMM-wPYf8BvKKmU1D43mS7NQbnq2FLy4rMW1TXar53e9LcUk0T2LklRQU0fu9R4yGTgXfYaRflHsWt73SMndgfaG2j_XgssaFG2vC7N451-3TmoHbaYQ2RkiVuuG5VDLs4G5VpRehQFREpqtECSrnYQbXnTGUvvS_O485qbjtq7d8_FB1F7SzEmRCc4QOQGdjCZBFPP98x0grFnwdG4_bHtO14QuGHguGNvPDlb8H2p4NjBtB9O6IfuNAwtwLI2h170v68gsa0rOP8A6InBXw?type=png)](https://mermaid.live/edit#pako:eNp9kktvwjAMx79K5HPp-kKUakKaSo9IkwqXtRxCa0q1NkZposEQ330Z5VEOW6REf9s_O87jBAWVCBFUku93bDnPBTNjlcVackVyzUajGUuzVBkTqyNbUKkbXPfYIlt1eGWSLDlgoVVNgiWiqsUNSv8PJ5dw7GYxCYGF2ZO5rxv5MkO7ss12cr-jZ9QboN4QJfGFTfMM-wPYf8BvKKmU1D43mS7NQbnq2FLy4rMW1TXar53e9LcUk0T2LklRQU0fu9R4yGTgXfYaRflHsWt73SMndgfaG2j_XgssaFG2vC7N451-3TmoHbaYQ2RkiVuuG5VDLs4G5VpRehQFREpqtECSrnYQbXnTGUvvS_O485qbjtq7d8_FB1F7SzEmRCc4QOQGdjCZBFPP98x0grFnwdG4_bHtO14QuGHguGNvPDlb8H2p4NjBtB9O6IfuNAwtwLI2h170v68gsa0rOP8A6InBXw)

### Sequence Diagram / Execution Flow
[![](https://mermaid.ink/img/pako:eNptUt1rwjAQ_1fCPeypulpb3PLgi3OwwWBM3MPoS0jPWmiTLk1AJ_7vu7ZWqzWQ5D5-97sP7gBSJwgcKvx1qCS-ZCI1oogVo1MKYzOZlUJZtq7QDK0ra4TFdD_0LFWaKRzaF1oplFbfIfs02mqp89bTvnXa0Xze5eFsYZCkx3edqZvsnXYF_xZ5lpDMHsivDdIrbHXF3VbK2XKH0lm8Yc21LtmrNgyF3LLKYtna69NGEsW5qT5LH3kGELhrk7M3ZdEIaS-4zje6Jv1C64yir3K5vcfaa2NdNv3WfbrqTq2X2fSQJyCqpBVOaILXQxoUAB4UaAqRJbQ6hzokBrvFAmPgJCa4ETUOYnUkqHBWr_ZKArfGoQdGu3QLfCPyijTXVHHau7OVFuJH66ILIRX4AXbAJ-E4nM3C52Aa0PXDKPBgT-ZpNJ76QRhOnkJ_EgXR7OjBX8PgjyMPMMloTh_tsjc7f_wHVLD53g?type=png)](https://mermaid.live/edit#pako:eNptUt1rwjAQ_1fCPeypulpb3PLgi3OwwWBM3MPoS0jPWmiTLk1AJ_7vu7ZWqzWQ5D5-97sP7gBSJwgcKvx1qCS-ZCI1oogVo1MKYzOZlUJZtq7QDK0ra4TFdD_0LFWaKRzaF1oplFbfIfs02mqp89bTvnXa0Xze5eFsYZCkx3edqZvsnXYF_xZ5lpDMHsivDdIrbHXF3VbK2XKH0lm8Yc21LtmrNgyF3LLKYtna69NGEsW5qT5LH3kGELhrk7M3ZdEIaS-4zje6Jv1C64yir3K5vcfaa2NdNv3WfbrqTq2X2fSQJyCqpBVOaILXQxoUAB4UaAqRJbQ6hzokBrvFAmPgJCa4ETUOYnUkqHBWr_ZKArfGoQdGu3QLfCPyijTXVHHau7OVFuJH66ILIRX4AXbAJ-E4nM3C52Aa0PXDKPBgT-ZpNJ76QRhOnkJ_EgXR7OjBX8PgjyMPMMloTh_tsjc7f_wHVLD53g)

###

## Get started

Expand Down Expand Up @@ -78,4 +111,4 @@ sh shell/deploy.sh --network=DESIRED_NETWORK
|----------|---------|---------|
| AerodromeConnector | Base | [`0x10e1aC384A4Fb3e0Bc4724D097B0d7F4e99143E6`](https://basescan.org/address/0x10e1aC384A4Fb3e0Bc4724D097B0d7F4e99143E6) |
| ConnectorPlugin | Base | [`0x96281563A06a8D3319C9822B58d8808FaC7EA14D`](https://basescan.org/address/0x96281563A06a8D3319C9822B58d8808FaC7EA14D) |
| ConnectorRegistry | Base | [`0x5d15B83927e635ab2Ce2e1820F03Ac552082b047`](https://basescan.org/address/0x5d15B83927e635ab2Ce2e1820F03Ac552082b047) |
| ConnectorRegistry | Base | [`0x5d15B83927e635ab2Ce2e1820F03Ac552082b047`](https://basescan.org/address/0x5d15B83927e635ab2Ce2e1820F03Ac552082b047) |

0 comments on commit 03e837a

Please sign in to comment.