diff --git a/bff/development/creating-services.mdx b/bff/development/creating-services.mdx index 6437fb6..f962d3d 100644 --- a/bff/development/creating-services.mdx +++ b/bff/development/creating-services.mdx @@ -1,5 +1,6 @@ --- title: "Creating Services and Libraries" +sidebarTitle: "Creating services" description: "Guide to scaffolding new services, applications, and libraries in the CoW Protocol BFF monorepo using NX generators" --- diff --git a/changelog.mdx b/changelog.mdx index cd9ecf5..68348dd 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -1,6 +1,6 @@ --- title: "Changelog" -description: "Latest updates to CoW DAO documentation." +description: "Latest updates and announcements for the CoW Protocol, CoW Swap, and CoW DAO documentation." --- diff --git a/cow-amm.mdx b/cow-amm.mdx index a2e0eb0..29da19f 100644 --- a/cow-amm.mdx +++ b/cow-amm.mdx @@ -1,6 +1,7 @@ --- title: "CoW AMM: The First MEV-capturing AMM" -description: "CoW AMM protects LPs from LVR so they can provide liquidity with less risk and more return. CoW AMM achieves close to 5% more in TVL compared to reference pools, protects millions from LVR, and has captured over $100,000 in surplus for LPs to date." +sidebarTitle: "CoW AMM" +description: "CoW AMM is the first MEV-capturing AMM: it protects LPs from LVR, beats reference pools on TVL, and has captured over $100k in surplus for LPs." hidden: true --- diff --git a/cow-amm/explanation/how-cow-amms-work.mdx b/cow-amm/explanation/how-cow-amms-work.mdx index ed3ad70..3db5502 100644 --- a/cow-amm/explanation/how-cow-amms-work.mdx +++ b/cow-amm/explanation/how-cow-amms-work.mdx @@ -1,5 +1,6 @@ --- title: "How CoW AMMs Work" +description: "How CoW AMM uses function-maximizing batch auctions and solver competition to eliminate LVR and protect liquidity providers." --- ## FM-AMMs diff --git a/cow-amm/explanation/the-problem-of-lvr.mdx b/cow-amm/explanation/the-problem-of-lvr.mdx index 1645716..5745f40 100644 --- a/cow-amm/explanation/the-problem-of-lvr.mdx +++ b/cow-amm/explanation/the-problem-of-lvr.mdx @@ -1,6 +1,7 @@ --- title: "The Problem of LVR (Loss-versus-rebalancing)" -description: "First coined by a team of researchers from LVR is a form of arbitrage that occurs whenever an AMM has an outdated (stale) price in comparison to some other trading venue." +sidebarTitle: "The problem of LVR" +description: "LVR (Loss-versus-Rebalancing) is a form of arbitrage that occurs when an AMM has a stale price compared to other venues — and how it harms liquidity providers." --- Arbitrageurs exploit this difference by trading from the AMM to the more liquid exchange (usually a centralized exchange like Binance), correcting the arbitrage and extracting value from LPs in the process. diff --git a/cow-amm/tutorials/cow-amm-deployer.mdx b/cow-amm/tutorials/cow-amm-deployer.mdx index c74b9cb..33d63f7 100644 --- a/cow-amm/tutorials/cow-amm-deployer.mdx +++ b/cow-amm/tutorials/cow-amm-deployer.mdx @@ -1,6 +1,7 @@ --- title: "Deploying a CoW AMM Using Balancer" -description: "In this short tutorial, we describe how you can create and deploy their own Balancer CoW AMM." +sidebarTitle: "Deploy with Balancer" +description: "Step-by-step tutorial for creating and deploying your own Balancer-based CoW AMM pool, including pool parameters and post-deployment checks." hidden: true --- diff --git a/cow-amm/tutorials/cow-amm-for-solvers.mdx b/cow-amm/tutorials/cow-amm-for-solvers.mdx index 4d8deb1..a66ddcb 100644 --- a/cow-amm/tutorials/cow-amm-for-solvers.mdx +++ b/cow-amm/tutorials/cow-amm-for-solvers.mdx @@ -1,5 +1,6 @@ --- title: "CoW AMM Liquidity for Solvers" +description: "How solvers can use CoW AMM as a liquidity source on CoW Protocol, including custom buy and sell amounts and pool selection." --- ## I'm a solver. How do I use CoW AMM liquidity? diff --git a/cow-protocol/explanation/architecture/autopilot.mdx b/cow-protocol/explanation/architecture/autopilot.mdx index 79f406a..46b10d3 100644 --- a/cow-protocol/explanation/architecture/autopilot.mdx +++ b/cow-protocol/explanation/architecture/autopilot.mdx @@ -1,5 +1,6 @@ --- title: "Autopilot" +description: "The autopilot is the backend engine that orchestrates CoW Protocol auctions, coordinating solvers, orderbook, and on-chain settlement." --- ## Overview diff --git a/cow-protocol/explanation/architecture/driver.mdx b/cow-protocol/explanation/architecture/driver.mdx index aa8a1f2..fe16d2b 100644 --- a/cow-protocol/explanation/architecture/driver.mdx +++ b/cow-protocol/explanation/architecture/driver.mdx @@ -1,6 +1,6 @@ --- title: "Driver" -description: "People interested in running a solver to participate in CoW Protocol mainly want to focus on implementing the most efficient solver engine. However, there are also many mundane tasks that may not seem like a competitive advantage but have to be done regardless." +description: "The driver is the CoW Protocol component that handles non-competitive solver operations, freeing teams to focus on building an efficient solver engine." --- ## Overview diff --git a/cow-protocol/explanation/architecture/solver-engine.mdx b/cow-protocol/explanation/architecture/solver-engine.mdx index 83678eb..06f2b09 100644 --- a/cow-protocol/explanation/architecture/solver-engine.mdx +++ b/cow-protocol/explanation/architecture/solver-engine.mdx @@ -1,6 +1,6 @@ --- title: "Solver Engine" -description: "The Solver Engine implements the of the CoW Protocol batch auction. As part of the auction lifecycle, it receives a request from the containing a potentially pre-processed auction instance and returns information about which order to execute together with instructions on how to achieve the desired execution using on-chain liquidity \"interactions\"." +description: "The Solver Engine is the component that picks which CoW Protocol orders to execute in a batch and returns on-chain interactions to settle them." --- diff --git a/cow-protocol/explanation/benefits/trade-any-intent.mdx b/cow-protocol/explanation/benefits/trade-any-intent.mdx index f9670f1..fe13418 100644 --- a/cow-protocol/explanation/benefits/trade-any-intent.mdx +++ b/cow-protocol/explanation/benefits/trade-any-intent.mdx @@ -1,6 +1,6 @@ --- title: "Trade any intent" -description: "CoW Protocol allows users to express any type of trade intent on Ethereum and EVM-compatible chains, leveraging to execute the transactions through the most optimal route." +description: "CoW Protocol lets users express any trade intent on Ethereum and EVM-compatible chains, with solvers routing each intent through the most optimal path." --- The protocol supports any order logic which includes standard market and limit orders, but also advanced order types such as [TWAP](/cow-protocol/explanation/order-types/twap-orders). Thanks to `ERC-1271`, smart contracts can also submit intents, paving the way for the [Programmatic Order Framework](/cow-protocol/explanation/order-types/programmatic-orders) and contracts like [Milkman](/cow-protocol/explanation/order-types/milkman-orders). diff --git a/cow-protocol/explanation/flash-loans/integrators.mdx b/cow-protocol/explanation/flash-loans/integrators.mdx index 535ddf9..a4bdcca 100644 --- a/cow-protocol/explanation/flash-loans/integrators.mdx +++ b/cow-protocol/explanation/flash-loans/integrators.mdx @@ -1,6 +1,7 @@ --- title: "How to specify an order with flash loan" -description: "The flash loan is encoded into the 's metadata as an optional object. This information serves as a hint for the solver, but the solver ultimately can decide for a different approach in order to make the operation more optimal." +sidebarTitle: "Flash loan orders" +description: "How to encode a flash loan as optional metadata on a CoW Protocol order so solvers can use it as a hint when proposing settlements." --- It is important to ensure that the flash loan gas overhead is added to the slippage tolerance when creating the order. diff --git a/cow-protocol/explanation/how-it-works/flow-of-an-order.mdx b/cow-protocol/explanation/how-it-works/flow-of-an-order.mdx index ebaae20..1c078e6 100644 --- a/cow-protocol/explanation/how-it-works/flow-of-an-order.mdx +++ b/cow-protocol/explanation/how-it-works/flow-of-an-order.mdx @@ -1,6 +1,6 @@ --- title: "Flow of an order" -description: "Rather than creating executable on-chain transactions, CoW Protocol users submit their orders as signed  messages. This allows to find the optimal execution path for the batch of orders before committing them on-chain." +description: "How a CoW Protocol order flows from a signed off-chain message, through solver competition, to optimal batch execution and on-chain settlement." --- Let's bring all of our main concepts together by taking a look at the flow of an order through CoW Protocol. diff --git a/cow-protocol/explanation/introduction/fair-combinatorial-auction.mdx b/cow-protocol/explanation/introduction/fair-combinatorial-auction.mdx index d59774c..4add91f 100644 --- a/cow-protocol/explanation/introduction/fair-combinatorial-auction.mdx +++ b/cow-protocol/explanation/introduction/fair-combinatorial-auction.mdx @@ -1,6 +1,7 @@ --- title: "Fair Combinatorial Batch Auction" -description: "CoW Protocol collects and aggregates intents off-chain and auctions them off to solvers. The auction is a Fair Combinatorial Batch Auction (FCBA) because each solver can submit multiple bids. A solver can submit multiple bids on individual orders, in which case each \"bid\" represents the best price this solver can provide to an individual order. However, a solver can also submit \"batched\" bids, that is, bids on groups of orders." +sidebarTitle: "FCBA" +description: "How CoW Protocol's Fair Combinatorial Batch Auction (FCBA) aggregates off-chain intents and lets solvers submit individual or batched bids." --- The protocol filters out \`\`unfair'' batched bids, which are those delivering less to an order than some available "non-batched" bids. It then selects the combination of winning bids that maximizes the surplus received by the orders that are part of the auction (subject to some computational constraints due to the combinatorial nature of the problem). diff --git a/cow-protocol/explanation/introduction/intents.mdx b/cow-protocol/explanation/introduction/intents.mdx index 73db31f..d8de9ea 100644 --- a/cow-protocol/explanation/introduction/intents.mdx +++ b/cow-protocol/explanation/introduction/intents.mdx @@ -1,6 +1,6 @@ --- title: "Intents" -description: "Rather than placing orders by that executes directly on-chain (i.e. as happens on Uniswap or SushiSwap), CoW Protocol users place orders by that specifies parameters like the assets and amounts they would like to trade. The intent is a signed message which allows the solvers to execute a trade on behalf of the user using their specified assets and amounts." +description: "How CoW Protocol uses intents — signed messages that describe a desired trade — instead of on-chain transactions, letting solvers execute trades on the user's behalf." --- There are a number of [financial](#financial-benefits-of-intents) and [technical](#technical-benefits-of-intents) advantages to intent-based trading. diff --git a/cow-protocol/explanation/order-types/cow-hooks.mdx b/cow-protocol/explanation/order-types/cow-hooks.mdx index 6cf4839..303fa4c 100644 --- a/cow-protocol/explanation/order-types/cow-hooks.mdx +++ b/cow-protocol/explanation/order-types/cow-hooks.mdx @@ -1,6 +1,6 @@ --- title: "CoW Hooks" -description: "CoW Hooks allow users to pair any Ethereum action (or set of actions) with an order on CoW Protocol, leveraging the to execute the actions together in the sequence." +description: "CoW Hooks let users attach any Ethereum action to a CoW Protocol order so pre- and post-trade steps execute together as part of the same flow." --- Hooks execute the entire sequence as a single transaction. True to the CoW Protocol model, users pay gas fees in their sell token if, and only if, the sequence of transactions succeeds. Under the hood, CoW Hooks are arbitrary Ethereum "calls" that attach to an order and execute before and/or after the order. Developers and advanced traders can use code to express an intent that performs some action before a swap (pre-hooks) and after a swap (post-hooks). diff --git a/cow-protocol/explanation/order-types/pay-debt-flash-loans.mdx b/cow-protocol/explanation/order-types/pay-debt-flash-loans.mdx index f688f7c..713bd06 100644 --- a/cow-protocol/explanation/order-types/pay-debt-flash-loans.mdx +++ b/cow-protocol/explanation/order-types/pay-debt-flash-loans.mdx @@ -1,6 +1,7 @@ --- title: "Repay debt with collateral using flash loans" -description: "A key use case of flash loans is the ability to repay debt with collateral, since flash loans allow users to close or reduce their debt positions without needing upfront liquidity." +sidebarTitle: "Repay debt with collateral" +description: "Use CoW Protocol flash loans to repay debt with collateral, letting users close or reduce debt positions without needing upfront liquidity." --- Instead of requiring users to have assets readily available to repay their loans, flash loans enable them to temporarily borrow the needed funds, use those funds to repay their debt, and immediately reclaim their locked collateral. Once the collateral is received, it can be swapped or liquidated to cover the borrowed amount, ensuring the loan is repaid within the same transaction. diff --git a/cow-protocol/explanation/order-types/programmatic-orders.mdx b/cow-protocol/explanation/order-types/programmatic-orders.mdx index 9e26639..ee0bc0f 100644 --- a/cow-protocol/explanation/order-types/programmatic-orders.mdx +++ b/cow-protocol/explanation/order-types/programmatic-orders.mdx @@ -1,6 +1,6 @@ --- title: "Programmatic orders" -description: "In addition to normal wallets, CoW Protocol also supports smart contract wallets that implement . This allows users to place orders through smart contracts with programmable parameters that execute based on certain conditions." +description: "How programmatic orders on CoW Protocol let smart contract wallets place orders with programmable parameters that execute based on on-chain conditions." --- We call these types of orders "programmatic orders" and we've developed a framework for creating programmatic orders, aptly named the "Programmatic Order Framework." diff --git a/cow-protocol/howto/cow-explorer.mdx b/cow-protocol/howto/cow-explorer.mdx index 66aa16e..cd1ed70 100644 --- a/cow-protocol/howto/cow-explorer.mdx +++ b/cow-protocol/howto/cow-explorer.mdx @@ -1,6 +1,6 @@ --- title: "Viewing orders" -description: "As CoW Protocol utilizes an off-chain orderbook, and settles on-chain, getting a holistic view of the current state of CoW Protocol requires a combination of on-chain and off-chain data. Individually, this information is available from the following:" +description: "How to view CoW Protocol orders across on-chain and off-chain sources using the CoW Explorer and complementary tools." --- * [Order book API](/cow-protocol/reference/apis/orderbook) (off-chain) diff --git a/cow-protocol/howto/solvers/fee-computation.mdx b/cow-protocol/howto/solvers/fee-computation.mdx index 1061f81..e30e2a7 100644 --- a/cow-protocol/howto/solvers/fee-computation.mdx +++ b/cow-protocol/howto/solvers/fee-computation.mdx @@ -1,5 +1,6 @@ --- title: "Fee computation for limit orders" +sidebarTitle: "Fee computation" description: "Guidelines for how solvers should compute fees when executing limit orders, where users sign orders with zero fees and solvers propose fees at execution time." --- diff --git a/cow-protocol/howto/solvers/flashloans_support.mdx b/cow-protocol/howto/solvers/flashloans_support.mdx index 4906561..04fe0fa 100644 --- a/cow-protocol/howto/solvers/flashloans_support.mdx +++ b/cow-protocol/howto/solvers/flashloans_support.mdx @@ -1,6 +1,7 @@ --- title: "How to execute flashloans orders" -description: "This short tutorial explains how orders with flashloans hints can be executed by solvers." +sidebarTitle: "Execute flashloans orders" +description: "How CoW Protocol solvers can detect, route, and execute orders that include flashloan hints in their metadata." --- ## Where to get information about an order’s flashloan? diff --git a/cow-protocol/howto/solvers/onboard.mdx b/cow-protocol/howto/solvers/onboard.mdx index 600f6f8..f25165b 100644 --- a/cow-protocol/howto/solvers/onboard.mdx +++ b/cow-protocol/howto/solvers/onboard.mdx @@ -1,5 +1,7 @@ --- title: "Joining The CoW Protocol Solver Competition" +description: "Step-by-step guide to onboarding as a solver on CoW Protocol, including bonding pools, shadow competition, and going live in production." +sidebarTitle: "Solver onboarding" --- > ***NOTE:*** In order to get connected to the shadow competition, feel free to reach out to an admin of the ["CoW Swap Solvers"](https://t.me/+2Z_-DW57meA1MDlh) group on Telegram. diff --git a/cow-protocol/howto/solvers/routes_integration.mdx b/cow-protocol/howto/solvers/routes_integration.mdx index 3a8b1e4..18d07cf 100644 --- a/cow-protocol/howto/solvers/routes_integration.mdx +++ b/cow-protocol/howto/solvers/routes_integration.mdx @@ -1,5 +1,7 @@ --- title: "Getting new routes integrated Into CoW Protocol" +description: "Guide for DeFi teams to integrate their liquidity sources with CoW Protocol so solvers can route trades through them." +sidebarTitle: "Routes integration" --- ## Overview diff --git a/cow-protocol/reference/contracts/core/allowlist.mdx b/cow-protocol/reference/contracts/core/allowlist.mdx index 2546430..d25b8f7 100644 --- a/cow-protocol/reference/contracts/core/allowlist.mdx +++ b/cow-protocol/reference/contracts/core/allowlist.mdx @@ -1,6 +1,7 @@ --- title: "GPv2AllowlistAuthentication" -description: "import HistoricalFact from './_gpv2.md'" +description: "Reference for the GPv2AllowlistAuthentication contract, which manages the allowlist of solvers authorized to settle batches on CoW Protocol." +sidebarTitle: "Allowlist authentication" --- ## Architecture diff --git a/cow-protocol/reference/contracts/core/settlement.mdx b/cow-protocol/reference/contracts/core/settlement.mdx index 53d9b7b..ab9a7b2 100644 --- a/cow-protocol/reference/contracts/core/settlement.mdx +++ b/cow-protocol/reference/contracts/core/settlement.mdx @@ -1,6 +1,7 @@ --- title: "GPv2Settlement" -description: "import HistoricalFact from './_gpv2.md'" +description: "Reference for the GPv2Settlement contract, which executes batch settlements on CoW Protocol by matching orders and interacting with on-chain liquidity." +sidebarTitle: "Settlement" --- ## Architecture diff --git a/cow-protocol/reference/contracts/core/vault-relayer.mdx b/cow-protocol/reference/contracts/core/vault-relayer.mdx index d0e1be7..29d0e81 100644 --- a/cow-protocol/reference/contracts/core/vault-relayer.mdx +++ b/cow-protocol/reference/contracts/core/vault-relayer.mdx @@ -1,6 +1,7 @@ --- title: "GPv2VaultRelayer" -description: "import HistoricalFact from './_gpv2.md'" +description: "Reference for the GPv2VaultRelayer contract, which holds token allowances and shields user funds from malicious solver interactions on CoW Protocol." +sidebarTitle: "Vault relayer" --- ## Architecture diff --git a/cow-protocol/reference/contracts/periphery/composable-cow.mdx b/cow-protocol/reference/contracts/periphery/composable-cow.mdx index d3894e3..bb76252 100644 --- a/cow-protocol/reference/contracts/periphery/composable-cow.mdx +++ b/cow-protocol/reference/contracts/periphery/composable-cow.mdx @@ -1,6 +1,6 @@ --- title: "ComposableCoW" -description: "ComposableCoW is the contract that implements programmatic orders on CoW Protocol. Programmatic orders are a subset of smart contract orders. It allows one to create programmatic orders that:" +description: "Reference for the ComposableCoW contract, which implements programmatic orders on CoW Protocol as a subset of smart contract orders." --- 1. Can be used to generate multiple discrete order (self-expressing) diff --git a/cow-protocol/reference/contracts/programmatic/twap.mdx b/cow-protocol/reference/contracts/programmatic/twap.mdx index 2463cb1..6863f2a 100644 --- a/cow-protocol/reference/contracts/programmatic/twap.mdx +++ b/cow-protocol/reference/contracts/programmatic/twap.mdx @@ -1,6 +1,6 @@ --- title: "TWAP" -description: "A simple (TWAP) trade may be thought of as smaller trades happening every time interval, commencing at time . Additionally, it is possible to limit a part's validity of the order to a certain of time interval ." +description: "Reference for CoW Protocol TWAP orders — a programmatic order type that splits a trade into equal parts executed at regular intervals." --- ## Data Structure diff --git a/cow-protocol/reference/core/auctions.mdx b/cow-protocol/reference/core/auctions.mdx index 17ee32f..e3bf9a7 100644 --- a/cow-protocol/reference/core/auctions.mdx +++ b/cow-protocol/reference/core/auctions.mdx @@ -1,6 +1,6 @@ --- title: "Auction mechanism" -description: "CoW Protocol uses an implementation of the for executing trades. Within a given auction, the goal is to compute prices and traded amounts to maximize a well-defined function, subject to a fairness constraint." +description: "How CoW Protocol auctions compute prices and traded amounts to maximize a well-defined objective, subject to a fairness constraint." --- This can be formulated as a concrete optimization problem that needs to be solved, and this is where solvers come into play. Informally, a solver is an algorithm that takes as its input an auction instance and outputs a set of solutions (or bids), each corresponding to how it can best execute different combinations of orders in the batch. The solutions proposed by all solvers are then processed by the protocol, which selects (potentially multiple) winners according to a well-defined objective function. diff --git a/cow-protocol/reference/core/auctions/accounting.mdx b/cow-protocol/reference/core/auctions/accounting.mdx index 8a437b6..a97404d 100644 --- a/cow-protocol/reference/core/auctions/accounting.mdx +++ b/cow-protocol/reference/core/auctions/accounting.mdx @@ -1,6 +1,7 @@ --- title: "Solver competition accounting process" -description: "There is an accounting process in place for the solver competition. It is performed separately on each chain. Currently, the execution of the accounting process takes place once a week for all chains the protocol operates on, and each accounting week starts on Tuesday at midnight UTC and concludes a week later at midnight UTC. This accounting process consists of the following:" +sidebarTitle: "Accounting" +description: "Reference for the weekly accounting process used to settle the CoW Protocol solver competition on each chain, including timing and outputs." --- * calculation of total rewards/penalties, as specified by the [mechanism](/cow-protocol/reference/core/auctions/rewards); diff --git a/cow-protocol/reference/core/auctions/ebbo-rules.mdx b/cow-protocol/reference/core/auctions/ebbo-rules.mdx index afd9ba0..5971b78 100644 --- a/cow-protocol/reference/core/auctions/ebbo-rules.mdx +++ b/cow-protocol/reference/core/auctions/ebbo-rules.mdx @@ -1,6 +1,6 @@ --- title: "EBBO violations: details" -description: "In this section, we will elaborate on the details about what consistutes an EBBO violation, and what actions are taken by the DAO in case such a violation occurs. The content of this section is based on ." +description: "What constitutes an EBBO violation on CoW Protocol and the actions CoW DAO takes when a solver triggers one." --- ## Certificate of EBBO violation diff --git a/cow-protocol/reference/core/auctions/rewards.mdx b/cow-protocol/reference/core/auctions/rewards.mdx index 604f017..776e7a0 100644 --- a/cow-protocol/reference/core/auctions/rewards.mdx +++ b/cow-protocol/reference/core/auctions/rewards.mdx @@ -1,6 +1,6 @@ --- title: "Solver rewards" -description: "The protocol is currently subsidizing the solver competition on all chains it operates on, by rewarding solvers on a weekly basis (currently, every Tuesday) with rewards paid in COW. Solvers are rewarded based on their performance as solvers (i.e., when participating in the standard solver competition) as specified by , , , , and . Solver rewards for participating in the price estimation competition and providing quotes that are needed for the gas estimates and limit price computations of market orders are specified in , , , and ." +description: "Reference for how CoW Protocol rewards solvers weekly in COW tokens, covering both the standard solver competition and the price estimation competition." --- diff --git a/cow-protocol/reference/core/auctions/the-problem.mdx b/cow-protocol/reference/core/auctions/the-problem.mdx index a23faa5..e995484 100644 --- a/cow-protocol/reference/core/auctions/the-problem.mdx +++ b/cow-protocol/reference/core/auctions/the-problem.mdx @@ -1,6 +1,7 @@ --- title: "What is solving? A mathematical, high-level description" -description: "At a high level, a solver is an algorithm that takes as inputs the orders that are valid for an auction, the state of the liquidity sources that the solver can access, the rules set by the protocol (including those specifying the protocol fees), and returns one or multiple solutions, where a solution selects a subset of the orders valid in an auction and specifies feasible in and out amounts for each of those orders. The solutions proposed by each solver during a given auction are the outcome of a two-step optimization problem: optimal routing and then optimal bidding." +sidebarTitle: "What is solving?" +description: "A mathematical, high-level description of solving on CoW Protocol: how solvers take orders and liquidity as input and output optimal routing and bidding solutions." --- In this section, we describe mathematically the different components of the "solving" problem. We discuss optimal routing and optimal bidding [in the solvers' strategy section](/cow-protocol/reference/core/auctions/rewards#solvers-strategy). diff --git a/cow-protocol/reference/core/definitions.mdx b/cow-protocol/reference/core/definitions.mdx index 884430d..4fe1d66 100644 --- a/cow-protocol/reference/core/definitions.mdx +++ b/cow-protocol/reference/core/definitions.mdx @@ -1,5 +1,6 @@ --- title: "Definitions" +description: "Glossary of core CoW Protocol terms — intents, orders, solvers, auctions, batches, and settlement vocabulary used across the documentation." --- #### Intent diff --git a/cow-protocol/reference/core/intents/hooks.mdx b/cow-protocol/reference/core/intents/hooks.mdx index 14f236a..502130b 100644 --- a/cow-protocol/reference/core/intents/hooks.mdx +++ b/cow-protocol/reference/core/intents/hooks.mdx @@ -1,6 +1,6 @@ --- title: "Hooks" -description: "The allows users to request the solvers to execute user-defined Ethereum calls (also known as an \"inner/internal transaction\") before and after the execution of an order in a settlement." +description: "How CoW Protocol hooks let users request solvers to execute user-defined Ethereum calls before and after an order is settled." --- ## Specification diff --git a/cow-protocol/reference/core/signing-schemes.mdx b/cow-protocol/reference/core/signing-schemes.mdx index a4b6772..f72dbf1 100644 --- a/cow-protocol/reference/core/signing-schemes.mdx +++ b/cow-protocol/reference/core/signing-schemes.mdx @@ -1,6 +1,6 @@ --- title: "Signing schemes" -description: "As CoW Protocol handles user's orders that were provided off-chain, the authenticity of a user's order needs to be asserted. Authenticity is asserted by the user their order. A user may be an EOA or a smart contract." +description: "Reference for the signing schemes CoW Protocol uses to authenticate off-chain orders from EOAs and smart contract wallets." --- ## Order digest diff --git a/cow-protocol/reference/core/tokens.mdx b/cow-protocol/reference/core/tokens.mdx index cd1cdfc..2806eb1 100644 --- a/cow-protocol/reference/core/tokens.mdx +++ b/cow-protocol/reference/core/tokens.mdx @@ -1,6 +1,6 @@ --- title: "Supported tokens" -description: "CoW Protocol supports tokens. However, not all token contracts are created equal, despite the idea of a standard interface. Some contracts introduce issues, such as fee on transfer or lockup periods, which make them unsuitable." +description: "Which ERC-20 tokens CoW Protocol supports — and which token behaviors (fee-on-transfer, lockups, rebasing) cause incompatibility." --- ## Requirements diff --git a/cow-protocol/reference/sdks/cow-sdk.mdx b/cow-protocol/reference/sdks/cow-sdk.mdx index c9f2c6f..ce53140 100644 --- a/cow-protocol/reference/sdks/cow-sdk.mdx +++ b/cow-protocol/reference/sdks/cow-sdk.mdx @@ -1,5 +1,6 @@ --- title: "CoW SDK" +description: "Reference for the CoW SDK — the official TypeScript library for integrating with CoW Protocol's orderbook, signing, and trading flows." hidden: true --- diff --git a/cow-protocol/tutorials/cow-amm-deployer.mdx b/cow-protocol/tutorials/cow-amm-deployer.mdx index c1e8a83..5326224 100644 --- a/cow-protocol/tutorials/cow-amm-deployer.mdx +++ b/cow-protocol/tutorials/cow-amm-deployer.mdx @@ -1,6 +1,6 @@ --- title: "CoW AMM Deployer" -description: "The is a user-friendly Safe App that simplifies the process of deploying and managing (Automated Market Makers) from Safe wallets. It enables users without programming skills to take advantage of the benefits of CoW AMM." +description: "Use the CoW AMM Deployer Safe App to deploy and manage CoW AMM pools from a Safe wallet — no programming required." --- The app was developed by [bleu](https://github.com/bleu-fi) with sponsorship from the [CoW Grants DAO](https://grants.cow.fi/). diff --git a/cow-protocol/tutorials/cow-explorer/address.mdx b/cow-protocol/tutorials/cow-explorer/address.mdx index 6dcf44b..3fa9781 100644 --- a/cow-protocol/tutorials/cow-explorer/address.mdx +++ b/cow-protocol/tutorials/cow-explorer/address.mdx @@ -1,6 +1,6 @@ --- title: "By user address" -description: "A user may want to see the details of all orders that they have placed. When searching for their address, they will be presented with an overview of all orders that they have placed." +description: "Look up all CoW Protocol orders placed by a given address on CoW Explorer to see an overview of historical trading activity." --- For example, below the user has searched for their address [`0x2557...3af7`](https://explorer.cow.fi/gc/address/0x2557ed03e34f0141722a643589f007836a683af7) that contains multiple orders that were placed on CoW Protocol on Gnosis Chain: diff --git a/cow-protocol/tutorials/cow-explorer/batch-auction.mdx b/cow-protocol/tutorials/cow-explorer/batch-auction.mdx index 1bbe93d..cba6753 100644 --- a/cow-protocol/tutorials/cow-explorer/batch-auction.mdx +++ b/cow-protocol/tutorials/cow-explorer/batch-auction.mdx @@ -1,6 +1,6 @@ --- title: "By batch auction" -description: "A batch auction is settled on-chain as a single transaction, and it is this transaction hash that is used to query the details of the batch auction. By simply searching for the transaction hash, the user will be presented with an overview of the batch auction." +description: "Look up a CoW Protocol batch auction on CoW Explorer using the on-chain settlement transaction hash to see its trades and clearing prices." --- The batch auction details page provides: diff --git a/cow-protocol/tutorials/cow-explorer/order.mdx b/cow-protocol/tutorials/cow-explorer/order.mdx index 7acfe8a..b694142 100644 --- a/cow-protocol/tutorials/cow-explorer/order.mdx +++ b/cow-protocol/tutorials/cow-explorer/order.mdx @@ -1,6 +1,6 @@ --- title: "By order" -description: "A user may want to see the details of a specific order that they have placed. They can search for this order by its unique identifier, the . This identifier is returned when an order is placed and can be used to query the details of the order." +description: "Look up a specific CoW Protocol order on CoW Explorer by its order UID to see status, execution, and trade details." --- diff --git a/cow-protocol/tutorials/solvers/local_test.mdx b/cow-protocol/tutorials/solvers/local_test.mdx index 3a97f5e..c0059c2 100644 --- a/cow-protocol/tutorials/solvers/local_test.mdx +++ b/cow-protocol/tutorials/solvers/local_test.mdx @@ -1,6 +1,7 @@ --- title: "Locally testing a solver with the CoW Protocol orderflow" -description: "CoW Protocol infrastructure is a lot of services running together in herd harmony, which is a bit intimidating at the beginning. Before proceeding, it would be advisable to read the architectural overview to get a better understanding of how CoW Protocol works and its entities." +sidebarTitle: "Local solver testing" +description: "How to test a CoW Protocol solver locally against the full orderflow, including running the supporting services and connecting to a test network." --- In order to test a solver against CoW Protocol's orderflow, one needs to locally run the following components diff --git a/cow-protocol/tutorials/token-approvals.mdx b/cow-protocol/tutorials/token-approvals.mdx index b6169dc..aa9fc34 100644 --- a/cow-protocol/tutorials/token-approvals.mdx +++ b/cow-protocol/tutorials/token-approvals.mdx @@ -1,5 +1,6 @@ --- title: "Token Approvals & GPv2VaultRelayer" +sidebarTitle: "Token approvals" description: "How to approve tokens for trading on CoW Protocol — standard approvals, gasless approvals, and per-chain VaultRelayer addresses." --- diff --git a/cow-py/api/contracts.mdx b/cow-py/api/contracts.mdx index 2cbeb5a..55e7333 100644 --- a/cow-py/api/contracts.mdx +++ b/cow-py/api/contracts.mdx @@ -1,6 +1,6 @@ --- title: "Contracts API" -description: "Order creation, signing, and domain utilities" +description: "Reference for the CoW Protocol Python SDK contracts module — order creation, signing, EIP-712 domain handling, and related utilities." --- ## Order diff --git a/cow-py/api/subgraph.mdx b/cow-py/api/subgraph.mdx index 078e991..323a69d 100644 --- a/cow-py/api/subgraph.mdx +++ b/cow-py/api/subgraph.mdx @@ -1,6 +1,6 @@ --- title: "SubgraphClient" -description: "Client for querying CoW Protocol subgraph data" +description: "Reference for the SubgraphClient in the CoW Protocol Python SDK — query historical orders, settlements, and protocol metrics from the CoW subgraph." --- The `SubgraphClient` class provides methods to query historical data from the CoW Protocol subgraph, including trading volumes, totals, and other aggregated metrics. diff --git a/cow-py/installation.mdx b/cow-py/installation.mdx index 13844ed..7beeff7 100644 --- a/cow-py/installation.mdx +++ b/cow-py/installation.mdx @@ -1,6 +1,6 @@ --- title: "Installation" -description: "Learn how to install the CoW Protocol Python SDK" +description: "Install the CoW Protocol Python SDK (cow-py) using pip, uv, or Poetry, including supported Python versions and optional dependencies." --- ## Prerequisites diff --git a/cow-sdk/guides/erc1271-signing.mdx b/cow-sdk/guides/erc1271-signing.mdx index 925856b..e7c8467 100644 --- a/cow-sdk/guides/erc1271-signing.mdx +++ b/cow-sdk/guides/erc1271-signing.mdx @@ -1,5 +1,6 @@ --- title: "ERC-1271 Signing (Custom Contracts)" +sidebarTitle: "ERC-1271 signing" description: "How to place CoW Protocol orders from custom smart contracts using ERC-1271 off-chain signatures — for vaults, DAOs, treasuries, and any non-EOA wallet." --- diff --git a/cow-swap/hooks/hook-dapp.mdx b/cow-swap/hooks/hook-dapp.mdx index a9ade83..79fd651 100644 --- a/cow-swap/hooks/hook-dapp.mdx +++ b/cow-swap/hooks/hook-dapp.mdx @@ -1,5 +1,6 @@ --- title: "CoW Hook dApp" +description: "Build a CoW Hook dApp — overview, technical specification, and links to the Hook Store for embedding hooks into CoW Swap orders." --- ### [What are CoW Hooks?](/cow-protocol/explanation/order-types/cow-hooks) diff --git a/cow-swap/tutorials/dca-twap.mdx b/cow-swap/tutorials/dca-twap.mdx index c6b2d08..5581800 100644 --- a/cow-swap/tutorials/dca-twap.mdx +++ b/cow-swap/tutorials/dca-twap.mdx @@ -1,6 +1,7 @@ --- title: "Dollar-Cost Averaging with TWAP" -description: "Build a dollar-cost averaging strategy using TWAP orders to accumulate tokens over time" +sidebarTitle: "DCA with TWAP" +description: "Build a dollar-cost averaging strategy on CoW Swap using TWAP orders to accumulate tokens gradually with minimal price impact." --- Dollar-cost averaging (DCA) is a strategy where you invest a fixed amount at regular intervals, regardless of price. CoW Protocol's TWAP (Time-Weighted Average Price) orders are ideal for this — they split a large trade into smaller parts executed at regular intervals. diff --git a/cow-swap/widget/params.mdx b/cow-swap/widget/params.mdx index 01dd1a1..9b8850b 100644 --- a/cow-swap/widget/params.mdx +++ b/cow-swap/widget/params.mdx @@ -1,6 +1,6 @@ --- title: "CoW Swap Widget" -description: "Integrate the power of into your product! With the widget, you can create an incredible trading interface. Specify the required pair of currencies, customize the look and much more!" +description: "Configuration parameters for the CoW Swap widget — set the trading pair, customize the look and feel, and embed CoW Protocol trading in your product." --- Create your own widget using the configurator [https://widget.cow.fi](https://widget.cow.fi). diff --git a/governance.mdx b/governance.mdx index 2fdb162..4a2c4c5 100644 --- a/governance.mdx +++ b/governance.mdx @@ -1,5 +1,6 @@ --- title: "Governance" +description: "Entry point to CoW DAO governance — the current structure, processes, and CoWmunity-driven mechanisms that govern CoW Protocol." --- > This site represents the current governance structure of CoW DAO. diff --git a/governance/explanation/mission.mdx b/governance/explanation/mission.mdx index c282543..1de678d 100644 --- a/governance/explanation/mission.mdx +++ b/governance/explanation/mission.mdx @@ -1,6 +1,6 @@ --- title: "Mission statement" -description: "CoW DAO is an open organization of developers, market makers, and community contributors on a mission to create a fairer, more-protective financial system. CoW DAO currently supports CoW Swap and CoW Protocol – decentralized trading products that leverage order flow auctions to shield users from MEV attacks and give them more than they ask for." +description: "CoW DAO's mission — an open organization building a fairer financial system through CoW Protocol and CoW Swap, with MEV-protected order flow auctions." --- ## Vision diff --git a/governance/explanation/process.mdx b/governance/explanation/process.mdx index 0ffa715..da47602 100644 --- a/governance/explanation/process.mdx +++ b/governance/explanation/process.mdx @@ -1,5 +1,6 @@ --- title: "Governance Process" +description: "Overview of the CoW DAO governance process — how the CoWmunity proposes, discusses, and ratifies decisions that shape CoW Protocol." --- > This site represents the current governance structure of CoW DAO. diff --git a/governance/explanation/token.mdx b/governance/explanation/token.mdx index d43f91b..703978d 100644 --- a/governance/explanation/token.mdx +++ b/governance/explanation/token.mdx @@ -1,6 +1,6 @@ --- title: "Token" -description: "At the core of CoW Protocol lies the COW token, which serves as a governance token within the CoW Protocol ecosystem, allowing stakeholders to participate directly in the decision-making processes that guide the protocol's development and evolution. The governance framework is designed to align incentives between the protocol's users, developers, and supporters, creating a robust and community-driven governance system." +description: "The COW token is the governance token at the core of CoW Protocol, aligning incentives between users, developers, and supporters of the ecosystem." --- ### Contract Address diff --git a/governance/reference/cip-template.mdx b/governance/reference/cip-template.mdx index 869358a..afd18c1 100644 --- a/governance/reference/cip-template.mdx +++ b/governance/reference/cip-template.mdx @@ -1,5 +1,6 @@ --- title: "CIP Template" +description: "Template for drafting a CoW DAO Improvement Proposal (CIP) — the standard format for proposals submitted to CoW DAO governance." --- > 📜 This template is to be used to create any new CoW DAO Improvement Proposal. diff --git a/governance/reference/fees.mdx b/governance/reference/fees.mdx index 27b1be3..073989d 100644 --- a/governance/reference/fees.mdx +++ b/governance/reference/fees.mdx @@ -1,5 +1,6 @@ --- title: "Fees" +description: "Reference for CoW Protocol fee models currently active, including protocol fees, partner fees, and how they apply to users of CoW Swap." --- diff --git a/governance/reference/partner-fee.mdx b/governance/reference/partner-fee.mdx index 4f7dff0..dd78709 100644 --- a/governance/reference/partner-fee.mdx +++ b/governance/reference/partner-fee.mdx @@ -1,5 +1,6 @@ --- title: "Partner fee" +description: "How the CoW Protocol partner fee is calculated, declared via appData, collected at settlement, and distributed to integration partners." --- ### Partner Fee Calculation diff --git a/hooks-trampoline/api/errors.mdx b/hooks-trampoline/api/errors.mdx index 65ff352..f33057c 100644 --- a/hooks-trampoline/api/errors.mdx +++ b/hooks-trampoline/api/errors.mdx @@ -1,6 +1,6 @@ --- title: "Errors" -description: "Error types in the HooksTrampoline contract" +description: "Reference for the error types reverted by the CoW Protocol HooksTrampoline contract, including when each error is raised and how to handle them." --- The HooksTrampoline contract defines custom errors for access control and execution failures. diff --git a/mevblocker.mdx b/mevblocker.mdx index 14d9964..2144533 100644 --- a/mevblocker.mdx +++ b/mevblocker.mdx @@ -1,6 +1,6 @@ --- title: "MEV Blocker" -description: "MEV Blocker Update" +description: "MEV Blocker has moved — find the up-to-date MEV Blocker documentation at docs.mevblocker.io." hidden: true --- diff --git a/watch-tower/advanced/storage.mdx b/watch-tower/advanced/storage.mdx index a215ca5..58f923e 100644 --- a/watch-tower/advanced/storage.mdx +++ b/watch-tower/advanced/storage.mdx @@ -1,6 +1,6 @@ --- title: "Storage Architecture" -description: "How the Watch Tower persists state using LevelDB" +description: "How the CoW Protocol Watch Tower persists state using LevelDB, including key layout, durability guarantees, and operational considerations." --- # Storage Architecture diff --git a/watch-tower/deployment/dappnode.mdx b/watch-tower/deployment/dappnode.mdx index bf1921e..086db3a 100644 --- a/watch-tower/deployment/dappnode.mdx +++ b/watch-tower/deployment/dappnode.mdx @@ -1,6 +1,6 @@ --- title: "DAppNode Deployment" -description: "Deploy the CoW Protocol Watch Tower on DAppNode" +description: "Deploy the CoW Protocol Watch Tower on DAppNode, including installation steps, configuration, and verifying that the watch tower is running." --- # DAppNode Deployment diff --git a/watch-tower/deployment/docker.mdx b/watch-tower/deployment/docker.mdx index d1893cc..3941c2c 100644 --- a/watch-tower/deployment/docker.mdx +++ b/watch-tower/deployment/docker.mdx @@ -1,6 +1,6 @@ --- title: "Docker Deployment" -description: "Deploy the CoW Protocol Watch Tower using Docker" +description: "Deploy the CoW Protocol Watch Tower with Docker — pull the image, configure environment variables, and run the container for programmatic orders." --- # Docker Deployment