@eco-incorp/sauce 0.99.5 → 0.99.7

package/skills/sauce-protocols/references/registry/maverick.md

@@ -0,0 +1,60 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Maverick (`maverick`)
+
+Dynamic distribution AMM with directional liquidity positioning. Allows LPs to follow price movements automatically with customizable bin strategies.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `Maverick` on ethereum, base, arbitrum |
+| Chains | ethereum, base, arbitrum |
+| Document | [maverick.md](../maverick.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Maverick` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's v2Factory, `0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e`.
+  require(Maverick.V2Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | v2Factory | `0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e` | `Maverick.V2Factory` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | v2Router | `0x62e31802c6145A2D5E842EeD8efe01fC224422fA` | `Maverick.V2Router` |
+| [Base](../../../sauce-chains/references/base.md) | v2Factory | `0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e` | `Maverick.V2Factory` |
+| [Base](../../../sauce-chains/references/base.md) | v2Router | `0x5eDEd0d7E76C563FF081Ca01D9d12D6B404Df527` | `Maverick.V2Router` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | v2Factory | `0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e` | `Maverick.V2Factory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | v2Router | `0x5c3b380e5Aeec389d1014Da3Eb372FA2C9e0fc76` | `Maverick.V2Router` |
+
+## ABI
+
+### `MaverickV2FactoryABI`
+
+`import MaverickV2FactoryABI from "./protocols/maverick/MaverickV2FactoryABI.json";` Speaks for: v2Factory.
+
+- `lookup(address tokenA, address tokenB, uint256 startIndex, uint256 endIndex) view returns (address[] pools)`
+
+### `MaverickV2PoolABI`
+
+`import MaverickV2PoolABI from "./protocols/maverick/MaverickV2PoolABI.json";`
+
+- `getState() view returns ((uint128 reserveA, uint128 reserveB, int64 lastTwaD8, int64 lastLogPriceD8, uint40 lastTimestamp, int32 activeTick, bool isLocked, uint32 binCounter, uint8 protocolFeeRatioD3))`
+- `fee(bool tokenAIn) view returns (uint256)`
+- `tickSpacing() view returns (uint256)`
+- `tokenA() view returns (address)`
+- `tokenB() view returns (address)`
+
+### `MaverickV2RouterABI`
+
+`import MaverickV2RouterABI from "./protocols/maverick/MaverickV2RouterABI.json";` Speaks for: v2Router.
+
+- `exactInputSingle(address recipient, address pool, bool tokenAIn, uint256 amountIn, uint256 amountOutMinimum) payable returns (uint256 amountOut)`
+- `exactOutputSingle(address recipient, address pool, bool tokenAIn, uint256 amountOut, uint256 amountInMaximum) payable returns (uint256 amountIn, uint256 amountOut)`

package/skills/sauce-protocols/references/registry/moonwell.md

@@ -0,0 +1,49 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Moonwell (`moonwell`)
+
+Leading lending protocol on Base. Compound V2 fork with governance and safety module features.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | none |
+| Namespace | `Moonwell` on base |
+| Chains | base |
+| Document | [moonwell.md](../moonwell.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Base, `Moonwell` is a namespace: its contracts need no import.
+
+```sauce chain=base
+function main() {
+  // Base's comptroller, `0xfBb21d0380beE3312B33c4353c8936a0F13EF26C`.
+  require(Moonwell.Comptroller != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Base](../../../sauce-chains/references/base.md) | comptroller | `0xfBb21d0380beE3312B33c4353c8936a0F13EF26C` | `Moonwell.Comptroller` |
+
+## ABI
+
+### `MTokenABI`
+
+`import MTokenABI from "./protocols/moonwell/MTokenABI.json";`
+
+- `mint(uint256 mintAmount) returns (uint256)`
+- `redeem(uint256 redeemTokens) returns (uint256)`
+- `redeemUnderlying(uint256 redeemAmount) returns (uint256)`
+- `borrow(uint256 borrowAmount) returns (uint256)`
+- `repayBorrow(uint256 repayAmount) returns (uint256)`
+
+### `MoonwellComptrollerABI`
+
+`import MoonwellComptrollerABI from "./protocols/moonwell/MoonwellComptrollerABI.json";` Speaks for: comptroller.
+
+- `enterMarkets(address[] mTokens) returns (uint256[])`
+- `exitMarket(address mToken) returns (uint256)`

package/skills/sauce-protocols/references/registry/morpho-blue.md

@@ -0,0 +1,47 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Morpho Blue (`morpho-blue`)
+
+Minimal and gas-efficient lending primitive with permissionless market creation. Markets are defined by a unique (loan token, collateral token, oracle, IRM, LLTV) tuple.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | none |
+| Namespace | `MorphoBlue` on ethereum, monad, arc, base |
+| Chains | ethereum, monad, arc, base |
+| Document | [morpho-blue.md](../morpho-blue.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `MorphoBlue` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's bundler3, `0x6566194141eefa99Af43Bb5Aa71460Ca2Dc90245`.
+  require(MorphoBlue.Bundler3 != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | bundler3 | `0x6566194141eefa99Af43Bb5Aa71460Ca2Dc90245` | `MorphoBlue.Bundler3` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | morpho | `0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb` | `MorphoBlue.Morpho` |
+| [Monad](../../../sauce-chains/references/monad.md) | morpho | `0xD5D960E8C380B724a48AC59E2DfF1b2CB4a1eAee` | `MorphoBlue.Morpho` |
+| [Arc](../../../sauce-chains/references/arc.md) | morpho | `0x34CD04070dD72b14E241112F6d83812Df5Af7fCD` | `MorphoBlue.Morpho` |
+| [Base](../../../sauce-chains/references/base.md) | morpho | `0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb` | `MorphoBlue.Morpho` |
+
+## ABI
+
+### `MorphoABI`
+
+`import MorphoABI from "./protocols/morpho-blue/MorphoABI.json";` Speaks for: morpho.
+
+- `supply((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, uint256 shares, address onBehalf, bytes data) returns (uint256 assetsSupplied, uint256 sharesSupplied)`
+- `withdraw((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, uint256 shares, address onBehalf, address receiver) returns (uint256 assetsWithdrawn, uint256 sharesWithdrawn)`
+- `borrow((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, uint256 shares, address onBehalf, address receiver) returns (uint256 assetsBorrowed, uint256 sharesBorrowed)`
+- `repay((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, uint256 shares, address onBehalf, bytes data) returns (uint256 assetsRepaid, uint256 sharesRepaid)`
+- `supplyCollateral((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, address onBehalf, bytes data)`
+- `withdrawCollateral((address loanToken, address collateralToken, address oracle, address irm, uint256 lltv) marketParams, uint256 assets, address onBehalf, address receiver)`

package/skills/sauce-protocols/references/registry/mux-protocol.md

@@ -0,0 +1,49 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# MUX Protocol (`mux-protocol`)
+
+Leveraged trading aggregator on Arbitrum. Routes trades across multiple perpetual DEXs for best execution with shared liquidity pool.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | none |
+| Namespace | `MuxProtocol` on arbitrum |
+| Chains | arbitrum |
+| Document | [mux-protocol.md](../mux-protocol.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `MuxProtocol` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's liquidityPool, `0x3e0199792Ce69DC29A0a36146bFa68bd7C8D6633`.
+  require(MuxProtocol.LiquidityPool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | liquidityPool | `0x3e0199792Ce69DC29A0a36146bFa68bd7C8D6633` | `MuxProtocol.LiquidityPool` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | orderBook | `0xa19fD5aB6C8DCffa2A295F78a5Bb4aC543AAF5e3` | `MuxProtocol.OrderBook` |
+
+## ABI
+
+### `LiquidityPoolABI`
+
+`import LiquidityPoolABI from "./protocols/mux-protocol/LiquidityPoolABI.json";` Speaks for: liquidityPool.
+
+- `depositCollateral(bytes32 subAccountId, uint256 rawAmount)`
+- `getAssetAddress(uint8 assetId) view returns (address)`
+- `getSubAccount(bytes32 subAccountId) view returns (uint96 collateral, uint96 size, uint32 lastIncreasedTime, uint96 entryPrice, uint128 entryFunding)`
+
+### `OrderBookABI`
+
+`import OrderBookABI from "./protocols/mux-protocol/OrderBookABI.json";` Speaks for: orderBook.
+
+- `cancelOrder(uint64 orderId)`
+- `placeLiquidityOrder(uint8 assetId, uint96 rawAmount, bool isAdding) payable`
+- `placePositionOrder3(bytes32 subAccountId, uint96 collateralAmount, uint96 size, uint96 price, uint8 profitTokenId, uint8 flags, uint32 deadline, bytes32 referralCode, (uint96 tpPrice, uint96 slPrice, uint8 tpslProfitTokenId, uint32 tpslDeadline) extra) payable`

package/skills/sauce-protocols/references/registry/olympus.md

@@ -0,0 +1,42 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Olympus DAO (`olympus`)
+
+Decentralized reserve currency protocol. OHM staking and bonding mechanism with protocol-owned liquidity and treasury management.
+
+| Fact | Value |
+| --- | --- |
+| Category | Staking |
+| Family | none |
+| Namespace | `Olympus` on ethereum |
+| Chains | ethereum |
+| Document | [olympus.md](../olympus.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Olympus` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's ohm, `0x64aa3364F17a4D01c6f1751Fd97C2BD3D7e7f1D5`.
+  require(Olympus.Ohm != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | ohm | `0x64aa3364F17a4D01c6f1751Fd97C2BD3D7e7f1D5` | `Olympus.Ohm` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | staking | `0xB63cac384247597756545b500253ff8E607a8020` | `Olympus.Staking` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | stakingHelper | `0xC8C436271f9A6F10a5B80c8b8eD7D0E8f37a612d` | `Olympus.StakingHelper` |
+
+## ABI
+
+### `StakingABI`
+
+`import StakingABI from "./protocols/olympus/StakingABI.json";` Speaks for: staking.
+
+- `stake(address to, uint256 amount, bool rebasing, bool claim) returns (uint256)`
+- `unstake(address to, uint256 amount, bool trigger, bool rebasing) returns (uint256)`
+- `claim(address to, bool rebasing) returns (uint256)`

package/skills/sauce-protocols/references/registry/oneinch.md

@@ -0,0 +1,45 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# 1inch (`oneinch`)
+
+Leading DEX aggregator that finds optimal swap routes across multiple liquidity sources. Supports limit orders and Fusion mode for gasless swaps.
+
+| Fact | Value |
+| --- | --- |
+| Category | Aggregators |
+| Family | none |
+| Namespace | `Oneinch` on ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Document | [oneinch.md](../oneinch.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Oneinch` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's aggregationRouterV6, `0x111111125421cA6dc452d289314280a0f8842A65`.
+  require(Oneinch.AggregationRouterV6 != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [Base](../../../sauce-chains/references/base.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | aggregationRouterV6 | `0x111111125421cA6dc452d289314280a0f8842A65` | `Oneinch.AggregationRouterV6` |
+
+## ABI
+
+### `AggregationRouterV6ABI`
+
+`import AggregationRouterV6ABI from "./protocols/oneinch/AggregationRouterV6ABI.json";` Speaks for: aggregationRouterV6.
+
+- `swap(address executor, (address srcToken, address dstToken, address srcReceiver, address dstReceiver, uint256 amount, uint256 minReturnAmount, uint256 flags) desc, bytes data) payable returns (uint256 returnAmount, uint256 spentAmount)`
+- `unoswap(uint256 token, uint256 amount, uint256 minReturn, uint256 dex) returns (uint256 returnAmount)`

package/skills/sauce-protocols/references/registry/openocean.md

@@ -0,0 +1,44 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# OpenOcean (`openocean`)
+
+Cross-chain DEX aggregator providing optimal swap routing across multiple DEXes and chains.
+
+| Fact | Value |
+| --- | --- |
+| Category | Aggregators |
+| Family | none |
+| Namespace | `Openocean` on ethereum, optimism, bsc, polygon, fantom, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, fantom, arbitrum, avalanche |
+| Document | [openocean.md](../openocean.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Openocean` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's exchangeV2, `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64`.
+  require(Openocean.ExchangeV2 != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [Fantom](../../../sauce-chains/references/fantom.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | exchangeV2 | `0x6352a56caadC4F1E25CD6c75970Fa768A3304e64` | `Openocean.ExchangeV2` |
+
+## ABI
+
+### `OpenOceanExchangeV2ABI`
+
+`import OpenOceanExchangeV2ABI from "./protocols/openocean/OpenOceanExchangeV2ABI.json";` Speaks for: exchangeV2.
+
+- `swap(address caller, (address srcToken, address dstToken, address srcReceiver, address dstReceiver, uint256 amount, uint256 minReturnAmount, uint256 guaranteedAmount, uint256 flags, address referrer, bytes permit) desc, (uint256 target, uint256 gasLimit, uint256 value, bytes data)[] calls) payable returns (uint256 returnAmount)`

package/skills/sauce-protocols/references/registry/optimism-bridge.md

@@ -0,0 +1,42 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Optimism Native Bridge (`optimism-bridge`)
+
+Official Optimism L1StandardBridge for depositing ETH and ERC-20 tokens from Ethereum to Optimism with 7-day withdrawal finality.
+
+| Fact | Value |
+| --- | --- |
+| Category | Bridges |
+| Family | none |
+| Namespace | `OptimismBridge` on ethereum, optimism |
+| Chains | ethereum, optimism |
+| Document | [optimism-bridge.md](../optimism-bridge.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `OptimismBridge` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's l1StandardBridge, `0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1`.
+  require(OptimismBridge.L1StandardBridge != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | l1StandardBridge | `0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1` | `OptimismBridge.L1StandardBridge` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | l2StandardBridge | `0x4200000000000000000000000000000000000010` | `OptimismBridge.L2StandardBridge` |
+
+## ABI
+
+### `OptimismL1StandardBridgeABI`
+
+`import OptimismL1StandardBridgeABI from "./protocols/optimism-bridge/OptimismL1StandardBridgeABI.json";` Speaks for: l1StandardBridge.
+
+- `depositETH(uint32 _minGasLimit, bytes _extraData) payable`
+- `depositERC20(address _l1Token, address _l2Token, uint256 _amount, uint32 _minGasLimit, bytes _extraData)`
+- `depositETHTo(address _to, uint32 _minGasLimit, bytes _extraData) payable`
+- `depositERC20To(address _l1Token, address _l2Token, address _to, uint256 _amount, uint32 _minGasLimit, bytes _extraData)`

package/skills/sauce-protocols/references/registry/opyn.md

@@ -0,0 +1,42 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Opyn (`opyn`)
+
+DeFi options protocol known for Squeeth (squared ETH), a power perpetual that provides leveraged ETH exposure without liquidations.
+
+| Fact | Value |
+| --- | --- |
+| Category | Options |
+| Family | none |
+| Namespace | `Opyn` on ethereum |
+| Chains | ethereum |
+| Document | [opyn.md](../opyn.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Opyn` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's controller, `0x64187ae08781B09368e6253F9E94951243A493D5`.
+  require(Opyn.Controller != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | controller | `0x64187ae08781B09368e6253F9E94951243A493D5` | `Opyn.Controller` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | oSQTH | `0xf1B99e3E573A1a9C5E6B2Ce818b617F0E664E86B` | `Opyn.OSQTH` |
+
+## ABI
+
+### `ControllerABI`
+
+`import ControllerABI from "./protocols/opyn/ControllerABI.json";` Speaks for: controller.
+
+- `mintPowerPerpAmount(uint256 _vaultId, uint256 _powerPerpAmount, uint256 _uniTokenId) payable returns (uint256, uint256)`
+- `burnPowerPerpAmount(uint256 _vaultId, uint256 _powerPerpAmount, uint256 _withdrawAmount) returns (uint256 wPowerPerpAmount)`
+- `deposit(uint256 _vaultId) payable`
+- `withdraw(uint256 _vaultId, uint256 _amount)`

package/skills/sauce-protocols/references/registry/pancakeswap-v2.md

@@ -0,0 +1,71 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# PancakeSwap V2 (`pancakeswap-v2`)
+
+The most popular DEX on BNB Chain using the constant product AMM model. Forked from Uniswap V2 with additional features like yield farming and lottery.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Pancakeswap`: `pancakeswap-v2`, `pancakeswap-v3` |
+| Namespace | `PancakeswapV2` on ethereum, bsc, monad, opbnb, base, arbitrum, linea |
+| Chains | ethereum, bsc, monad, opbnb, base, arbitrum, linea |
+| Document | [pancakeswap-v2.md](../pancakeswap-v2.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `PancakeswapV2` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's factory, `0x1097053Fd2ea711dad45caCcc45EfF7548fCB362`.
+  require(PancakeswapV2.Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | factory | `0x1097053Fd2ea711dad45caCcc45EfF7548fCB362` | `PancakeswapV2.Factory` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | router | `0xEfF92A263d31888d860bD50809A8D171709b7b1c` | `PancakeswapV2.Router` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | factory | `0xcA143Ce32Fe78f1f7019d7d551a6402fC5350c73` | `PancakeswapV2.Factory` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | router | `0x10ED43C718714eb63d5aA57B78B54704E256024E` | `PancakeswapV2.Router` |
+| [Monad](../../../sauce-chains/references/monad.md) | factory | `0x02a84c1b3BBD7401a5f7fa98a384EBC70bB5749E` | `PancakeswapV2.Factory` |
+| [Monad](../../../sauce-chains/references/monad.md) | router | `0xB1Bc24c34e88f7D43D5923034E3a14B24DaACfF9` | `PancakeswapV2.Router` |
+| [opBNB](../../../sauce-chains/references/opbnb.md) | factory | `0x02a84c1b3BBD7401a5f7fa98a384EBC70bB5749E` | `PancakeswapV2.Factory` |
+| [opBNB](../../../sauce-chains/references/opbnb.md) | router | `0x8cFe327CEc66d1C090Dd72bd0FF11d690C33a2Eb` | `PancakeswapV2.Router` |
+| [Base](../../../sauce-chains/references/base.md) | factory | `0x02a84c1b3BBD7401a5f7fa98a384EBC70bB5749E` | `PancakeswapV2.Factory` |
+| [Base](../../../sauce-chains/references/base.md) | router | `0x8cFe327CEc66d1C090Dd72bd0FF11d690C33a2Eb` | `PancakeswapV2.Router` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | factory | `0x02a84c1b3BBD7401a5f7fa98a384EBC70bB5749E` | `PancakeswapV2.Factory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | router | `0x8cFe327CEc66d1C090Dd72bd0FF11d690C33a2Eb` | `PancakeswapV2.Router` |
+| [Linea](../../../sauce-chains/references/linea.md) | factory | `0x02a84c1b3BBD7401a5f7fa98a384EBC70bB5749E` | `PancakeswapV2.Factory` |
+| [Linea](../../../sauce-chains/references/linea.md) | router | `0x8cFe327CEc66d1C090Dd72bd0FF11d690C33a2Eb` | `PancakeswapV2.Router` |
+
+## ABI
+
+### `PancakeSwapV2FactoryABI`
+
+`import PancakeSwapV2FactoryABI from "./protocols/pancakeswap-v2/PancakeSwapV2FactoryABI.json";` Speaks for: factory.
+
+- `getPair(address tokenA, address tokenB) view returns (address pair)`
+- `createPair(address tokenA, address tokenB) returns (address pair)`
+
+### `PancakeSwapV2PairABI`
+
+`import PancakeSwapV2PairABI from "./protocols/pancakeswap-v2/PancakeSwapV2PairABI.json";`
+
+- `getReserves() view returns (uint112 _reserve0, uint112 _reserve1, uint32 _blockTimestampLast)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+- `swap(uint256 amount0Out, uint256 amount1Out, address to, bytes data)`
+
+### `PancakeSwapV2RouterABI`
+
+`import PancakeSwapV2RouterABI from "./protocols/pancakeswap-v2/PancakeSwapV2RouterABI.json";` Speaks for: router.
+
+- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, uint256 deadline) returns (uint256[] amounts)`
+- `swapTokensForExactTokens(uint256 amountOut, uint256 amountInMax, address[] path, address to, uint256 deadline) returns (uint256[] amounts)`
+- `addLiquidity(address tokenA, address tokenB, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB, uint256 liquidity)`
+- `removeLiquidity(address tokenA, address tokenB, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB)`
+- `getAmountsOut(uint256 amountIn, address[] path) view returns (uint256[] amounts)`

package/skills/sauce-protocols/references/registry/pancakeswap-v3.md

@@ -0,0 +1,76 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# PancakeSwap V3 (`pancakeswap-v3`)
+
+Concentrated liquidity AMM on BNB Chain and multiple EVM chains. Built on Uniswap V3 architecture with custom fee tiers and farming integration.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Pancakeswap`: `pancakeswap-v2`, `pancakeswap-v3` |
+| Namespace | `PancakeswapV3` on ethereum, bsc, base, arbitrum, linea |
+| Chains | ethereum, bsc, base, arbitrum, linea |
+| Document | [pancakeswap-v3.md](../pancakeswap-v3.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `PancakeswapV3` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's factory, `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865`.
+  require(PancakeswapV3.Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | factory | `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865` | `PancakeswapV3.Factory` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | nonfungiblePositionManager | `0x46A15B0b27311cedF172AB29E4f4766fbE7F4364` | `PancakeswapV3.NonfungiblePositionManager` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | smartRouter | `0x13f4EA83D0bd40E75C8222255bc855a974568Dd4` | `PancakeswapV3.SmartRouter` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | factory | `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865` | `PancakeswapV3.Factory` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | nonfungiblePositionManager | `0x46A15B0b27311cedF172AB29E4f4766fbE7F4364` | `PancakeswapV3.NonfungiblePositionManager` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | smartRouter | `0x13f4EA83D0bd40E75C8222255bc855a974568Dd4` | `PancakeswapV3.SmartRouter` |
+| [Base](../../../sauce-chains/references/base.md) | factory | `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865` | `PancakeswapV3.Factory` |
+| [Base](../../../sauce-chains/references/base.md) | nonfungiblePositionManager | `0x46A15B0b27311cedF172AB29E4f4766fbE7F4364` | `PancakeswapV3.NonfungiblePositionManager` |
+| [Base](../../../sauce-chains/references/base.md) | smartRouter | `0x678Aa4bF4E210cf2166753e054d5b7c31cc7fa86` | `PancakeswapV3.SmartRouter` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | factory | `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865` | `PancakeswapV3.Factory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | nonfungiblePositionManager | `0x46A15B0b27311cedF172AB29E4f4766fbE7F4364` | `PancakeswapV3.NonfungiblePositionManager` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | smartRouter | `0x32226588378236Fd0c7c4053999F88aC0e5cAc77` | `PancakeswapV3.SmartRouter` |
+| [Linea](../../../sauce-chains/references/linea.md) | factory | `0x0BFbCF9fa4f9C56B0F40a671Ad40E0805A091865` | `PancakeswapV3.Factory` |
+| [Linea](../../../sauce-chains/references/linea.md) | nonfungiblePositionManager | `0x46A15B0b27311cedF172AB29E4f4766fbE7F4364` | `PancakeswapV3.NonfungiblePositionManager` |
+| [Linea](../../../sauce-chains/references/linea.md) | smartRouter | `0x678Aa4bF4E210cf2166753e054d5b7c31cc7fa86` | `PancakeswapV3.SmartRouter` |
+
+## ABI
+
+### `PancakeSwapV3FactoryABI`
+
+`import PancakeSwapV3FactoryABI from "./protocols/pancakeswap-v3/PancakeSwapV3FactoryABI.json";` Speaks for: factory.
+
+- `getPool(address tokenA, address tokenB, uint24 fee) view returns (address pool)`
+
+### `PancakeSwapV3NFPMABI`
+
+`import PancakeSwapV3NFPMABI from "./protocols/pancakeswap-v3/PancakeSwapV3NFPMABI.json";` Speaks for: nonfungiblePositionManager.
+
+- `mint((address token0, address token1, uint24 fee, int24 tickLower, int24 tickUpper, uint256 amount0Desired, uint256 amount1Desired, uint256 amount0Min, uint256 amount1Min, address recipient, uint256 deadline) params) payable returns (uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1)`
+
+### `PancakeSwapV3PoolABI`
+
+`import PancakeSwapV3PoolABI from "./protocols/pancakeswap-v3/PancakeSwapV3PoolABI.json";`
+
+- `slot0() view returns (uint160 sqrtPriceX96, int24 tick, uint16 observationIndex, uint16 observationCardinality, uint16 observationCardinalityNext, uint32 feeProtocol, bool unlocked)`
+- `liquidity() view returns (uint128)`
+- `fee() view returns (uint24)`
+- `tickSpacing() view returns (int24)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+
+### `PancakeSwapV3SmartRouterABI`
+
+`import PancakeSwapV3SmartRouterABI from "./protocols/pancakeswap-v3/PancakeSwapV3SmartRouterABI.json";` Speaks for: smartRouter.
+
+- `exactInputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)`
+- `exactOutputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 amountOut, uint256 amountInMaximum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountIn)`

package/skills/sauce-protocols/references/registry/paraswap.md

@@ -0,0 +1,51 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# ParaSwap (`paraswap`)
+
+Multi-chain DEX aggregator optimizing swap rates across decentralized exchanges. Supports limit orders and delta algorithm for MEV protection.
+
+| Fact | Value |
+| --- | --- |
+| Category | Aggregators |
+| Family | none |
+| Namespace | `Paraswap` on ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Document | [paraswap.md](../paraswap.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Paraswap` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's augustusV5, `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57`.
+  require(Paraswap.AugustusV5 != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [Base](../../../sauce-chains/references/base.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Base](../../../sauce-chains/references/base.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | augustusV5 | `0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57` | `Paraswap.AugustusV5` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | augustusV6 | `0x6A000F20005980200259B80c5102003040001068` | `Paraswap.AugustusV6` |
+
+## ABI
+
+### `AugustusV5ABI`
+
+`import AugustusV5ABI from "./protocols/paraswap/AugustusV5ABI.json";` Speaks for: augustusV5.
+
+- `simpleSwap((address fromToken, address toToken, uint256 fromAmount, uint256 toAmount, uint256 expectedAmount, address[] callees, bytes exchangeData, uint256[] startIndexes, uint256[] values, address beneficiary, address partner, uint256 feePercent, bytes permit, uint256 deadline, bytes16 uuid) data) payable returns (uint256 receivedAmount)`