diff --git a/docs/.vuepress/public/images/pool-deployments.svg b/docs/.vuepress/public/images/pool-deployments.svg new file mode 100644 index 00000000..7aa99f7f --- /dev/null +++ b/docs/.vuepress/public/images/pool-deployments.svg @@ -0,0 +1,190 @@ + + + + + + +balancer_deployments + + +cluster_weighted_pool + +weighted-pool + + +cluster_stable_pool + +stable-pool + + +cluster_v3_weighted_pool + +v3-weighted-pool + + +cluster_v3_stable_pool + +v3-stable-pool + + +cluster_v3_stable_surge_pool + +v3-stable-surge-pool + + + +n_20210418_weighted_pool_deprecated + +Weighted Pools of up to 8 tokens +2021-04-18 (v1, deprecated) + + + +n_20220908_weighted_pool_v2_deprecated + +Weighted Pool V2 +2022-09-08 (v2, deprecated) + + + +n_20210418_weighted_pool_deprecated->n_20220908_weighted_pool_v2_deprecated + + + + + +n_20230206_weighted_pool_v3_deprecated + +Weighted Pool V3 +2023-02-06 (v3, deprecated) + + + +n_20220908_weighted_pool_v2_deprecated->n_20230206_weighted_pool_v3_deprecated + + + + + +n_20230320_weighted_pool_v4_active + +Weighted Pool V4 +2023-03-20 (v4, active) + + + +n_20230206_weighted_pool_v3_deprecated->n_20230320_weighted_pool_v4_active + + + + + +n_20210624_stable_pool_deprecated + +Stable Pools of up to 5 tokens +2021-06-24 (v1, deprecated) + + + +n_20220609_stable_pool_v2_deprecated + +Stable Pools V2 of up to 5 tokens +2022-06-09 (v2, deprecated) + + + +n_20210624_stable_pool_deprecated->n_20220609_stable_pool_v2_deprecated + + + + + +n_20241205_v3_weighted_pool_deprecated + +V3 Weighted Pool +2024-12-05 (v1, deprecated) + + + +n_20260115_v3_weighted_pool_v2_active + +V3 Weighted Pool (V2) +2026-01-15 (v2, active) + + + +n_20241205_v3_weighted_pool_deprecated->n_20260115_v3_weighted_pool_v2_active + + + + + +n_20241205_v3_stable_pool_deprecated + +V3 Stable Pool +2024-12-05 (v1, deprecated) + + + +n_20250324_v3_stable_pool_v2_deprecated + +V3 Stable Pool V2 +2025-03-24 (v2, deprecated) + + + +n_20241205_v3_stable_pool_deprecated->n_20250324_v3_stable_pool_v2_deprecated + + + + + +n_20260116_v3_stable_pool_v3_active + +V3 Stable Pool (V3) +2026-01-16 (v3, active) + + + +n_20250324_v3_stable_pool_v2_deprecated->n_20260116_v3_stable_pool_v3_active + + + + + +n_20250121_v3_stable_surge_deprecated + +V3 Stable Surge Pool +2025-01-21 (v1, deprecated) + + + +n_20250404_v3_stable_surge_pool_factory_v2_deprecated + +V3 Stable Surge Pool (V2) +2025-04-04 (v2, deprecated) + + + +n_20250121_v3_stable_surge_deprecated->n_20250404_v3_stable_surge_pool_factory_v2_deprecated + + + + + +n_20260117_v3_stable_surge_pool_factory_v3_active + +V3 Stable Surge Pool (V3) +2026-01-17 (v3, active) + + + +n_20250404_v3_stable_surge_pool_factory_v2_deprecated->n_20260117_v3_stable_surge_pool_factory_v3_active + + + + + diff --git a/docs/.vuepress/public/images/router-deployments.svg b/docs/.vuepress/public/images/router-deployments.svg new file mode 100644 index 00000000..dd412cb7 --- /dev/null +++ b/docs/.vuepress/public/images/router-deployments.svg @@ -0,0 +1,112 @@ + + + + + + +balancer_deployments + + +cluster_v3_router + +v3-router + + +cluster_v3_batch_router + +v3-batch-router + + +cluster_v3_composite_liquidity_router + +v3-composite-liquidity-router + + +cluster_v3_prepaid_composite_liquidity_router + +v3-prepaid-composite-liquidity-router + + +cluster_v3_buffer_router + +v3-buffer-router + + + +n_20241205_v3_router_deprecated + +V3 Router +2024-12-05 (v1, deprecated) + + + +n_20250307_v3_router_v2_active + +V3 Router V2 +2025-03-07 (v2, active) + + + +n_20241205_v3_router_deprecated->n_20250307_v3_router_v2_active + + + + + +n_20241205_v3_batch_router_active + +V3 Batch Router +2024-12-05 (v1, active) + + + +n_20241205_v3_composite_liquidity_router_deprecated + +V3 Composite Liquidity Router +2024-12-05 (v1, deprecated) + + + +n_20250123_v3_composite_liquidity_router_v2_deprecated + +V3 Composite Liquidity Router (V2) +2025-01-23 (v2, deprecated) + + + +n_20241205_v3_composite_liquidity_router_deprecated->n_20250123_v3_composite_liquidity_router_v2_deprecated + + + + + +n_20251010_v3_composite_liquidity_router_v3_active + +V3 Composite Liquidity Router (V3) +2025-10-10 (v3, active) + + + +n_20250123_v3_composite_liquidity_router_v2_deprecated->n_20251010_v3_composite_liquidity_router_v3_active + + + + + +n_20251010_v3_prepaid_composite_liquidity_router_active + +V3 Prepaid Composite Liquidity Router (V3) +2025-10-10 (v1, active) + + + +n_20241205_v3_buffer_router_active + +V3 Buffer Router +2024-12-05 (v1, active) + + + diff --git a/docs/developer-reference/contracts/abi/.order b/docs/developer-reference/contracts/abi/.order index d8263ee9..ca7bf83a 100644 --- a/docs/developer-reference/contracts/abi/.order +++ b/docs/developer-reference/contracts/abi/.order @@ -1 +1 @@ -2 \ No newline at end of file +13 \ No newline at end of file diff --git a/docs/developer-reference/contracts/deployment-addresses/.order b/docs/developer-reference/contracts/deployment-addresses/.order index e440e5c8..da2d3988 100644 --- a/docs/developer-reference/contracts/deployment-addresses/.order +++ b/docs/developer-reference/contracts/deployment-addresses/.order @@ -1 +1 @@ -3 \ No newline at end of file +14 \ No newline at end of file diff --git a/docs/developer-reference/contracts/deployment-history/.order b/docs/developer-reference/contracts/deployment-history/.order new file mode 100644 index 00000000..3f10ffe7 --- /dev/null +++ b/docs/developer-reference/contracts/deployment-history/.order @@ -0,0 +1 @@ +15 \ No newline at end of file diff --git a/docs/developer-reference/contracts/deployment-history/pools.md b/docs/developer-reference/contracts/deployment-history/pools.md new file mode 100644 index 00000000..a90f2d60 --- /dev/null +++ b/docs/developer-reference/contracts/deployment-history/pools.md @@ -0,0 +1,17 @@ +# V3 Pool Deployments + +Here is the current list of official Balancer Pool deployments: + +![V3 Pools](/images/pool-deployments.svg) + +Each entry has the protocol version (V2 or V3), the pool type name, the deployment date (i.e., the date on the deployment task: not necessarily when the contract was actually deployed on-chain), the pool version (e.g., v1, v2, v3, ...), and whether it is active or deprecated. In general, only the latest version will be "active." + +For instance: +V3 Weighted Pool +2024-12-05 (v1, active) + +From this, it is easy to navigate to the corresponding task in the deployments repo: [/v3/tasks/20241205-v3-weighted-pool/readme.md](https://github.com/balancer/balancer-deployments/blob/master/v3/tasks/20241205-v3-weighted-pool/readme.md) + +Similarly, v2 tasks are under /v2. Each protocol version has /tasks and /deprecated directories for active and deprecated deployments, respectively. + +In addition to a description of the contract, this readme contains a link to the commit in the repo it was produced from (at least for V3 deployments), and links to the deployed contract addresses on all networks. diff --git a/docs/developer-reference/contracts/deployment-history/routers.md b/docs/developer-reference/contracts/deployment-history/routers.md new file mode 100644 index 00000000..74f813c8 --- /dev/null +++ b/docs/developer-reference/contracts/deployment-history/routers.md @@ -0,0 +1,26 @@ +# V3 Router Deployments + +Here is the current list of official Balancer Router deployments: + +![V3 Pools](/images/router-deployments.svg) + +Each entry has the protocol version (V2 or V3), the router name, the deployment date (i.e., the date on the deployment task: not necessarily when the contract was actually deployed on-chain), the router version (e.g., v1, v2, v3, ...), and whether it is active or deprecated. In general, only the latest version will be "active." + +For instance, here is the **original** V3 Router (since deprecated and replaced by V2): +V3 Router +2024-12-05 (v1, deprecated) + +From this, it is easy to navigate to the corresponding task in the deployments repo: [/v3/deprecated/20241205-v3-router/readme.md](https://github.com/balancer/balancer-deployments/blob/master/v3/deprecated/20241205-v3-router/readme.md) + +Similarly, v2 tasks are under /v2. Each protocol version has /tasks and /deprecated directories for active and deprecated deployments, respectively. + +The current V3 Router is: + +V3 Router V2 +2025-03-07 (v2, active) + +The corresponding task in the deployments repo is: [/v3/tasks/20250307-v3-router-v2/readme.md](https://github.com/balancer/balancer-deployments/blob/master/v3/tasks/20250307-v3-router-v2/readme.md) + +Since it is "active," we look under /tasks. + +In addition to a description of the contract, this readme contains a link to the commit in the repo it was produced from (at least for V3 deployments), and links to the deployed contract addresses on all networks. diff --git a/docs/developer-reference/contracts/error-codes.md b/docs/developer-reference/contracts/error-codes.md index 519f8fcd..7c838a10 100644 --- a/docs/developer-reference/contracts/error-codes.md +++ b/docs/developer-reference/contracts/error-codes.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 11 --- # Error Codes diff --git a/docs/developer-reference/contracts/error-signatures.md b/docs/developer-reference/contracts/error-signatures.md index feee5c10..5ad4418b 100644 --- a/docs/developer-reference/contracts/error-signatures.md +++ b/docs/developer-reference/contracts/error-signatures.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 12 --- # Error selector index diff --git a/docs/developer-reference/contracts/hooks-api.md b/docs/developer-reference/contracts/hooks-api.md index d5aaf5b4..603add99 100644 --- a/docs/developer-reference/contracts/hooks-api.md +++ b/docs/developer-reference/contracts/hooks-api.md @@ -1,5 +1,5 @@ --- -order: 7 +order: 6 title: Hooks API --- diff --git a/docs/developer-reference/contracts/protocol-fee-controller-api.md b/docs/developer-reference/contracts/protocol-fee-controller-api.md index 1318b30d..17b39bb6 100644 --- a/docs/developer-reference/contracts/protocol-fee-controller-api.md +++ b/docs/developer-reference/contracts/protocol-fee-controller-api.md @@ -1,5 +1,5 @@ --- -order: 8 +order: 7 title: Protocol Fee Controller API --- diff --git a/docs/developer-reference/contracts/security.md b/docs/developer-reference/contracts/security.md index 863b9965..67364083 100644 --- a/docs/developer-reference/contracts/security.md +++ b/docs/developer-reference/contracts/security.md @@ -1,5 +1,5 @@ --- -order: 5 +order: 10 title: Security --- # Security diff --git a/docs/developer-reference/contracts/vault-api.md b/docs/developer-reference/contracts/vault-api.md index 16e47a87..b183e62d 100644 --- a/docs/developer-reference/contracts/vault-api.md +++ b/docs/developer-reference/contracts/vault-api.md @@ -1,5 +1,5 @@ --- -order: 6 +order: 5 title: Vault API --- diff --git a/docs/developer-reference/contracts/vault-config.md b/docs/developer-reference/contracts/vault-config.md index 9db8cc11..5fd6bc40 100644 --- a/docs/developer-reference/contracts/vault-config.md +++ b/docs/developer-reference/contracts/vault-config.md @@ -1,5 +1,5 @@ --- -order: 2 +order: 9 title: Vault Configuration ---