@eco-incorp/sauce 0.99.6 → 0.99.7

package/skills/sauce-protocols/references/registry/trader-joe.md

@@ -0,0 +1,66 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Trader Joe (`trader-joe`)
+
+Liquidity Book DEX with variable-width bins for concentrated liquidity. Native to Avalanche with expansion to Arbitrum and BSC.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `TraderJoe` on bsc, arbitrum, avalanche |
+| Chains | bsc, arbitrum, avalanche |
+| Document | [trader-joe.md](../trader-joe.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On BNB Chain, `TraderJoe` is a namespace: its contracts need no import.
+
+```sauce chain=bsc
+function main() {
+  // BNB Chain's lbFactory, `0x8e42f2F4101563bF679975178e880FD87d3eFd4e`.
+  require(TraderJoe.LBFactory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | lbFactory | `0x8e42f2F4101563bF679975178e880FD87d3eFd4e` | `TraderJoe.LBFactory` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | lbRouter | `0xb4315e873dBcf96Ffd0acd8EA43f689D8c20fB30` | `TraderJoe.LBRouter` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | lbFactory | `0xb43120c4745967fa9b93E79C149E66B0f2D6Fe0c` | `TraderJoe.LBFactory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | lbRouter | `0x18556da13313f3532c54711497a8fedac273220e` | `TraderJoe.LBRouter` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | lbFactory | `0xb43120c4745967fa9b93E79C149E66B0f2D6Fe0c` | `TraderJoe.LBFactory` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | lbRouter | `0x18556DA13313f3532c54711497A8FedAC273220E` | `TraderJoe.LBRouter` |
+
+## ABI
+
+### `LBFactoryABI`
+
+`import LBFactoryABI from "./protocols/trader-joe/LBFactoryABI.json";` Speaks for: lbFactory.
+
+- `getLBPairInformation(address tokenA, address tokenB, uint256 binStep) view returns ((uint16 binStep, address LBPair, bool createdByOwner, bool ignoredForRouting) lbPairInformation)`
+
+### `LBPairABI`
+
+`import LBPairABI from "./protocols/trader-joe/LBPairABI.json";`
+
+- `getTokenX() pure returns (address tokenX)`
+- `getTokenY() pure returns (address tokenY)`
+- `getBinStep() pure returns (uint16)`
+- `getActiveId() view returns (uint24 activeId)`
+- `getReserves() view returns (uint128 reserveX, uint128 reserveY)`
+- `getBin(uint24 id) view returns (uint128 binReserveX, uint128 binReserveY)`
+- `getPriceFromId(uint24 id) pure returns (uint256 price)`
+- `getSwapIn(uint128 amountOut, bool swapForY) view returns (uint128 amountIn, uint128 amountOutLeft, uint128 fee)`
+- `getSwapOut(uint128 amountIn, bool swapForY) view returns (uint128 amountInLeft, uint128 amountOut, uint128 fee)`
+- `swap(bool swapForY, address to) returns (bytes32 amountsOut)`
+
+### `LBRouterABI`
+
+`import LBRouterABI from "./protocols/trader-joe/LBRouterABI.json";` Speaks for: lbRouter.
+
+- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, (uint256[] pairBinSteps, uint8[] versions, address[] tokenPath) path, address to, uint256 deadline) returns (uint256 amountOut)`
+- `swapTokensForExactTokens(uint256 amountOut, uint256 amountInMax, (uint256[] pairBinSteps, uint8[] versions, address[] tokenPath) path, address to, uint256 deadline) returns (uint256[] amountsIn)`
+- `addLiquidity((address tokenX, address tokenY, uint256 binStep, uint256 amountX, uint256 amountY, uint256 amountXMin, uint256 amountYMin, uint256 activeIdDesired, uint256 idSlippage, int256[] deltaIds, uint256[] distributionX, uint256[] distributionY, address to, address refundTo, uint256 deadline) liquidityParameters) returns (uint256 amountXAdded, uint256 amountYAdded, uint256 amountXLeft, uint256 amountYLeft, uint256[] depositIds, uint256[] liquidityMinted)`

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

@@ -0,0 +1,77 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Uniswap V2 (`uniswap-v2`)
+
+Constant product AMM (x*y=k) with permissionless pair creation. The most forked DEX protocol in DeFi.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Uniswap`: `uniswap-v2`, `uniswap-v3`, `uniswap-v4` |
+| Namespace | `UniswapV2` on ethereum, optimism, bsc, polygon, arc, base, arbitrum, avalanche, blast, zora |
+| Chains | ethereum, optimism, bsc, polygon, arc, base, arbitrum, avalanche, blast, zora |
+| Document | [uniswap-v2.md](../uniswap-v2.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `UniswapV2` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's factory, `0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f`.
+  require(UniswapV2.Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | factory | `0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f` | `UniswapV2.Factory` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | router | `0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D` | `UniswapV2.Router` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | factory | `0x0c3c1c532F1e39EdF36BE9Fe0bE1410313E074Bf` | `UniswapV2.Factory` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | router | `0x4A7b5Da61326A6379179b40d00F57E5bbDC962c2` | `UniswapV2.Router` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | factory | `0x8909Dc15e40173Ff4699343b6eB8132c65e18eC6` | `UniswapV2.Factory` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | router | `0x4752ba5DBc23f44D87826276BF6Fd6b1C372aD24` | `UniswapV2.Router` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | factory | `0x9e5A52f57b3038F1B8EeE45F28b3C1967e22799C` | `UniswapV2.Factory` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | router | `0xedf6066a2b290C185783862C7F4776A2C8077AD1` | `UniswapV2.Router` |
+| [Arc](../../../sauce-chains/references/arc.md) | factory | `0x89e5DB8B5aA49aA85AC63f691524311AEB649eba` | `UniswapV2.Factory` |
+| [Arc](../../../sauce-chains/references/arc.md) | router | `0x1f7d7550B1b028f7571E69A784071F0205FD2EfA` | `UniswapV2.Router` |
+| [Base](../../../sauce-chains/references/base.md) | factory | `0x8909Dc15e40173Ff4699343b6eB8132c65e18eC6` | `UniswapV2.Factory` |
+| [Base](../../../sauce-chains/references/base.md) | router | `0x4752ba5dbc23f44d87826276bf6fd6b1c372ad24` | `UniswapV2.Router` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | factory | `0xf1D7CC64Fb4452F05c498126312eBE29f30Fbcf9` | `UniswapV2.Factory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | router | `0x4752ba5dbc23f44d87826276bf6fd6b1c372ad24` | `UniswapV2.Router` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | factory | `0x9e5A52f57b3038F1B8EeE45F28b3C1967e22799C` | `UniswapV2.Factory` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | router | `0x4752ba5dbc23f44d87826276bf6fd6b1c372ad24` | `UniswapV2.Router` |
+| [Blast](../../../sauce-chains/references/blast.md) | factory | `0x5C346464d33F90bABaf70dB6388507CC889C1070` | `UniswapV2.Factory` |
+| [Blast](../../../sauce-chains/references/blast.md) | router | `0xBB66Eb1c5e875933D44DAe661dbD80e5D9B03035` | `UniswapV2.Router` |
+| [Zora](../../../sauce-chains/references/zora.md) | factory | `0x0F797dC7efaEA995bB916f268D919d0a1950eE3C` | `UniswapV2.Factory` |
+| [Zora](../../../sauce-chains/references/zora.md) | router | `0xa00F34A632630EFd15223B1968358bA4845bEEC7` | `UniswapV2.Router` |
+
+## ABI
+
+### `UniswapV2FactoryABI`
+
+`import UniswapV2FactoryABI from "./protocols/uniswap-v2/UniswapV2FactoryABI.json";` Speaks for: factory.
+
+- `getPair(address tokenA, address tokenB) view returns (address pair)`
+- `createPair(address tokenA, address tokenB) returns (address pair)`
+
+### `UniswapV2PairABI`
+
+`import UniswapV2PairABI from "./protocols/uniswap-v2/UniswapV2PairABI.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)`
+
+### `UniswapV2RouterABI`
+
+`import UniswapV2RouterABI from "./protocols/uniswap-v2/UniswapV2RouterABI.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/uniswap-v3.md

@@ -0,0 +1,113 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Uniswap V3 (`uniswap-v3`)
+
+Concentrated liquidity AMM allowing LPs to allocate capital within custom price ranges for higher capital efficiency.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Uniswap`: `uniswap-v2`, `uniswap-v3`, `uniswap-v4` |
+| Namespace | `UniswapV3` on ethereum, optimism, bsc, polygon, monad, arc, base, arbitrum, celo, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, monad, arc, base, arbitrum, celo, avalanche |
+| Document | [uniswap-v3.md](../uniswap-v3.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `UniswapV3` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's factory, `0x1F98431c8aD98523631AE4a59f267346ea31F984`.
+  require(UniswapV3.Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | factory | `0x1F98431c8aD98523631AE4a59f267346ea31F984` | `UniswapV3.Factory` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | nonfungiblePositionManager | `0xC36442b4a4522E871399CD717aBDD847Ab11FE88` | `UniswapV3.NonfungiblePositionManager` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | quoterV2 | `0x61fFE014bA17989E743c5F6cB21bF9697530B21e` | `UniswapV3.QuoterV2` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | swapRouter | `0xE592427A0AEce92De3Edee1F18E0157C05861564` | `UniswapV3.SwapRouter` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | swapRouter02 | `0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45` | `UniswapV3.SwapRouter02` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | factory | `0x1F98431c8aD98523631AE4a59f267346ea31F984` | `UniswapV3.Factory` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | nonfungiblePositionManager | `0xC36442b4a4522E871399CD717aBDD847Ab11FE88` | `UniswapV3.NonfungiblePositionManager` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | swapRouter | `0xE592427A0AEce92De3Edee1F18E0157C05861564` | `UniswapV3.SwapRouter` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | factory | `0xdB1d10011AD0Ff90774D0C6Bb92e5C5c8b4461F7` | `UniswapV3.Factory` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | swapRouter02 | `0xB971eF87ede563556b2ED4b1C0b0019111Dd85d2` | `UniswapV3.SwapRouter02` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | factory | `0x1F98431c8aD98523631AE4a59f267346ea31F984` | `UniswapV3.Factory` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | nonfungiblePositionManager | `0xC36442b4a4522E871399CD717aBDD847Ab11FE88` | `UniswapV3.NonfungiblePositionManager` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | swapRouter | `0xE592427A0AEce92De3Edee1F18E0157C05861564` | `UniswapV3.SwapRouter` |
+| [Monad](../../../sauce-chains/references/monad.md) | factory | `0x204faca1764b154221e35c0d20abb3c525710498` | `UniswapV3.Factory` |
+| [Monad](../../../sauce-chains/references/monad.md) | nonfungiblePositionManager | `0x7197e214c0b767cfb76fb734ab638e2c192f4e53` | `UniswapV3.NonfungiblePositionManager` |
+| [Monad](../../../sauce-chains/references/monad.md) | quoterV2 | `0x661e93cca42afacb172121ef892830ca3b70f08d` | `UniswapV3.QuoterV2` |
+| [Monad](../../../sauce-chains/references/monad.md) | swapRouter02 | `0xfe31f71c1b106eac32f1a19239c9a9a72ddfb900` | `UniswapV3.SwapRouter02` |
+| [Arc](../../../sauce-chains/references/arc.md) | factory | `0xf0db7b58379503491d857dB50AC9ece64c653918` | `UniswapV3.Factory` |
+| [Arc](../../../sauce-chains/references/arc.md) | nonfungiblePositionManager | `0x39654A85A4C05127f5Fd6ED22CAeC077A0fB1377` | `UniswapV3.NonfungiblePositionManager` |
+| [Arc](../../../sauce-chains/references/arc.md) | quoterV2 | `0x7DfD4F31be6814D2906BDE155c3e1B146EAc1468` | `UniswapV3.QuoterV2` |
+| [Arc](../../../sauce-chains/references/arc.md) | swapRouter02 | `0x53BF6B0684Ec7eF91e1387Da3D1a1769bC5A6F77` | `UniswapV3.SwapRouter02` |
+| [Base](../../../sauce-chains/references/base.md) | factory | `0x33128a8fC17869897dcE68Ed026d694621f6FDfD` | `UniswapV3.Factory` |
+| [Base](../../../sauce-chains/references/base.md) | nonfungiblePositionManager | `0x03a520b32C04BF3bEEf7BEb72E919cf822Ed34f1` | `UniswapV3.NonfungiblePositionManager` |
+| [Base](../../../sauce-chains/references/base.md) | swapRouter02 | `0x2626664c2603336E57B271c5C0b26F421741e481` | `UniswapV3.SwapRouter02` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | factory | `0x1F98431c8aD98523631AE4a59f267346ea31F984` | `UniswapV3.Factory` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | nonfungiblePositionManager | `0xC36442b4a4522E871399CD717aBDD847Ab11FE88` | `UniswapV3.NonfungiblePositionManager` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | swapRouter | `0xE592427A0AEce92De3Edee1F18E0157C05861564` | `UniswapV3.SwapRouter` |
+| [Celo](../../../sauce-chains/references/celo.md) | factory | `0xAfE208a311B21f13EF87E33A90049fC17A7acDEc` | `UniswapV3.Factory` |
+| [Celo](../../../sauce-chains/references/celo.md) | swapRouter02 | `0x5615CDAb10dc425a742d643d949a7F474C01abc4` | `UniswapV3.SwapRouter02` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | factory | `0x740b1c1de25031C31FF4fC9A62f554A55cdC1baD` | `UniswapV3.Factory` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | swapRouter02 | `0xbb00FF08d01D300023C629E8fFfFcb65A5a578cE` | `UniswapV3.SwapRouter02` |
+
+## ABI
+
+### `UniswapV3FactoryABI`
+
+`import UniswapV3FactoryABI from "./protocols/uniswap-v3/UniswapV3FactoryABI.json";` Speaks for: factory.
+
+- `getPool(address tokenA, address tokenB, uint24 fee) view returns (address pool)`
+- `createPool(address tokenA, address tokenB, uint24 fee) returns (address pool)`
+
+### `UniswapV3NonfungiblePositionManagerABI`
+
+`import UniswapV3NonfungiblePositionManagerABI from "./protocols/uniswap-v3/UniswapV3NonfungiblePositionManagerABI.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)`
+- `increaseLiquidity((uint256 tokenId, uint256 amount0Desired, uint256 amount1Desired, uint256 amount0Min, uint256 amount1Min, uint256 deadline) params) payable returns (uint128 liquidity, uint256 amount0, uint256 amount1)`
+- `decreaseLiquidity((uint256 tokenId, uint128 liquidity, uint256 amount0Min, uint256 amount1Min, uint256 deadline) params) payable returns (uint256 amount0, uint256 amount1)`
+- `collect((uint256 tokenId, address recipient, uint128 amount0Max, uint128 amount1Max) params) payable returns (uint256 amount0, uint256 amount1)`
+
+### `UniswapV3PoolABI`
+
+`import UniswapV3PoolABI from "./protocols/uniswap-v3/UniswapV3PoolABI.json";`
+
+- `slot0() view returns (uint160 sqrtPriceX96, int24 tick, uint16 observationIndex, uint16 observationCardinality, uint16 observationCardinalityNext, uint8 feeProtocol, bool unlocked)`
+- `liquidity() view returns (uint128)`
+- `fee() view returns (uint24)`
+- `tickSpacing() view returns (int24)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+
+### `UniswapV3QuoterV2ABI`
+
+`import UniswapV3QuoterV2ABI from "./protocols/uniswap-v3/UniswapV3QuoterV2ABI.json";` Speaks for: quoterV2.
+
+- `quoteExactInputSingle((address tokenIn, address tokenOut, uint256 amountIn, uint24 fee, uint160 sqrtPriceLimitX96) params) returns (uint256 amountOut, uint160 sqrtPriceX96After, uint32 initializedTicksCrossed, uint256 gasEstimate)`
+
+### `UniswapV3SwapRouter02ABI`
+
+`import UniswapV3SwapRouter02ABI from "./protocols/uniswap-v3/UniswapV3SwapRouter02ABI.json";` Speaks for: swapRouter02.
+
+- `exactInputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)`
+- `exactInput((bytes path, address recipient, uint256 amountIn, uint256 amountOutMinimum) 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)`
+- `exactOutput((bytes path, address recipient, uint256 amountOut, uint256 amountInMaximum) params) payable returns (uint256 amountIn)`
+
+### `UniswapV3SwapRouterABI`
+
+`import UniswapV3SwapRouterABI from "./protocols/uniswap-v3/UniswapV3SwapRouterABI.json";` Speaks for: swapRouter.
+
+- `exactInputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)`
+- `exactInput((bytes path, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum) params) payable returns (uint256 amountOut)`
+- `exactOutputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 deadline, uint256 amountOut, uint256 amountInMaximum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountIn)`
+- `exactOutput((bytes path, address recipient, uint256 deadline, uint256 amountOut, uint256 amountInMaximum) params) payable returns (uint256 amountIn)`

package/skills/sauce-protocols/references/registry/uniswap-v4.md

@@ -0,0 +1,117 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Uniswap V4 (`uniswap-v4`)
+
+Singleton AMM with hooks architecture enabling custom pool logic, flash accounting, and native ETH support.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Uniswap`: `uniswap-v2`, `uniswap-v3`, `uniswap-v4` |
+| Namespace | `UniswapV4` on ethereum, optimism, bsc, unichain, polygon, monad, arc, base, arbitrum, celo, avalanche, ink, blast, zora |
+| Chains | ethereum, optimism, bsc, unichain, polygon, monad, arc, base, arbitrum, celo, avalanche, ink, blast, zora |
+| Document | [uniswap-v4.md](../uniswap-v4.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `UniswapV4` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's poolManager, `0x000000000004444c5dc75cB358380D2e3dE08A90`.
+  require(UniswapV4.PoolManager != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | poolManager | `0x000000000004444c5dc75cB358380D2e3dE08A90` | `UniswapV4.PoolManager` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | positionManager | `0xbd216513d74c8cf14cf4747e6aaa6420ff64ee9e` | `UniswapV4.PositionManager` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | stateView | `0x7ffe42c4a5deea5b0fec41c94c136cf115597227` | `UniswapV4.StateView` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | universalRouter | `0x66a9893cc07d91d95644aedd05d03f95e1dba8af` | `UniswapV4.UniversalRouter` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | poolManager | `0x9a13f98cb987694c9f086b1f5eb990eea8264ec3` | `UniswapV4.PoolManager` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | positionManager | `0x3c3ea4b57a46241e54610e5f022e5c45859a1017` | `UniswapV4.PositionManager` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | stateView | `0xc18a3169788f4f75a170290584eca6395c75ecdb` | `UniswapV4.StateView` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | universalRouter | `0x851116d9223fabed8e56c0e6b8ad0c31d98b3507` | `UniswapV4.UniversalRouter` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | poolManager | `0x28e2ea090877bf75740558f6bfb36a5ffee9e9df` | `UniswapV4.PoolManager` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | positionManager | `0x7a4a5c919ae2541aed11041a1aeee68f1287f95b` | `UniswapV4.PositionManager` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | stateView | `0xd13dd3d6e93f276fafc9db9e6bb47c1180aee0c4` | `UniswapV4.StateView` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | universalRouter | `0x1906c1d672b88cd1b9ac7593301ca990f94eae07` | `UniswapV4.UniversalRouter` |
+| [Unichain](../../../sauce-chains/references/unichain.md) | poolManager | `0x1f98400000000000000000000000000000000004` | `UniswapV4.PoolManager` |
+| [Unichain](../../../sauce-chains/references/unichain.md) | stateView | `0x86e8631a016f9068c3f085faf484ee3f5fdee8f2` | `UniswapV4.StateView` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | poolManager | `0x67366782805870060151383f4bbff9dab53e5cd6` | `UniswapV4.PoolManager` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | positionManager | `0x1ec2ebf4f37e7363fdfe3551602425af0b3ceef9` | `UniswapV4.PositionManager` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | stateView | `0x5ea1bd7974c8a611cbab0bdcafcb1d9cc9b3ba5a` | `UniswapV4.StateView` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | universalRouter | `0x1095692a6237d83c6a72f3f5efedb9a670c49223` | `UniswapV4.UniversalRouter` |
+| [Monad](../../../sauce-chains/references/monad.md) | poolManager | `0x188d586ddcf52439676ca21a244753fa19f9ea8e` | `UniswapV4.PoolManager` |
+| [Monad](../../../sauce-chains/references/monad.md) | positionManager | `0x5b7ec4a94ff9bedb700fb82ab09d5846972f4016` | `UniswapV4.PositionManager` |
+| [Monad](../../../sauce-chains/references/monad.md) | stateView | `0x77395f3b2e73ae90843717371294fa97cc419d64` | `UniswapV4.StateView` |
+| [Monad](../../../sauce-chains/references/monad.md) | universalRouter | `0x0d97dc33264bfc1c226207428a79b26757fb9dc3` | `UniswapV4.UniversalRouter` |
+| [Arc](../../../sauce-chains/references/arc.md) | poolManager | `0x8366a39CC670B4001A1121B8F6A443A643e40951` | `UniswapV4.PoolManager` |
+| [Arc](../../../sauce-chains/references/arc.md) | positionManager | `0x6049c9a0e26405C0985f9E3685C87d0aE917f82B` | `UniswapV4.PositionManager` |
+| [Arc](../../../sauce-chains/references/arc.md) | stateView | `0xF3334192D15450CdD385c8B70e03f9A6bD9E673b` | `UniswapV4.StateView` |
+| [Arc](../../../sauce-chains/references/arc.md) | universalRouter | `0x4fcA4a51Ab4F23A7447b3284fBd7D73289A89Fb1` | `UniswapV4.UniversalRouter` |
+| [Base](../../../sauce-chains/references/base.md) | poolManager | `0x498581ff718922c3f8e6a244956af099b2652b2b` | `UniswapV4.PoolManager` |
+| [Base](../../../sauce-chains/references/base.md) | positionManager | `0x7c5f5a4bbd8fd63184577525326123b519429bdc` | `UniswapV4.PositionManager` |
+| [Base](../../../sauce-chains/references/base.md) | stateView | `0xa3c0c9b65bad0b08107aa264b0f3db444b867a71` | `UniswapV4.StateView` |
+| [Base](../../../sauce-chains/references/base.md) | universalRouter | `0x6ff5693b99212da76ad316178a184ab56d299b43` | `UniswapV4.UniversalRouter` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | poolManager | `0x360e68faccca8ca495c1b759fd9eee466db9fb32` | `UniswapV4.PoolManager` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | positionManager | `0xd88f38f930b7952f2db2432cb002e7abbf3dd869` | `UniswapV4.PositionManager` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | stateView | `0x76fd297e2d437cd7f76d50f01afe6160f86e9990` | `UniswapV4.StateView` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | universalRouter | `0xa51afafe0263b40edaef0df8781ea9aa03e381a3` | `UniswapV4.UniversalRouter` |
+| [Celo](../../../sauce-chains/references/celo.md) | poolManager | `0x288dc841A52FCA2707c6947B3A777c5E56cd87BC` | `UniswapV4.PoolManager` |
+| [Celo](../../../sauce-chains/references/celo.md) | stateView | `0xbc21f8720babf4b20d195ee5c6e99c52b76f2bfb` | `UniswapV4.StateView` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | poolManager | `0x06380c0e0912312b5150364b9dc4542ba0dbbc85` | `UniswapV4.PoolManager` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | positionManager | `0xb74b1f14d2754acfcbbe1a221023a5cf50ab8acd` | `UniswapV4.PositionManager` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | stateView | `0xc3c9e198c735a4b97e3e683f391ccbdd60b69286` | `UniswapV4.StateView` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | universalRouter | `0x94b75331ae8d42c1b61065089b7d48fe14aa73b7` | `UniswapV4.UniversalRouter` |
+| [Ink](../../../sauce-chains/references/ink.md) | poolManager | `0x360e68faccca8ca495c1b759fd9eee466db9fb32` | `UniswapV4.PoolManager` |
+| [Ink](../../../sauce-chains/references/ink.md) | stateView | `0x76fd297e2d437cd7f76d50f01afe6160f86e9990` | `UniswapV4.StateView` |
+| [Blast](../../../sauce-chains/references/blast.md) | poolManager | `0x1631559198a9e474033433b2958dabc135ab6446` | `UniswapV4.PoolManager` |
+| [Blast](../../../sauce-chains/references/blast.md) | stateView | `0x12a88ae16f46dce4e8b15368008ab3380885df30` | `UniswapV4.StateView` |
+| [Zora](../../../sauce-chains/references/zora.md) | poolManager | `0x0575338e4c17006ae181b47900a84404247ca30f` | `UniswapV4.PoolManager` |
+| [Zora](../../../sauce-chains/references/zora.md) | stateView | `0x385785af07d63b50d0a0ea57c4ff89d06adf7328` | `UniswapV4.StateView` |
+
+## ABI
+
+### `UniswapV4PoolManagerABI`
+
+`import UniswapV4PoolManagerABI from "./protocols/uniswap-v4/UniswapV4PoolManagerABI.json";` Speaks for: poolManager.
+
+- `initialize((address currency0, address currency1, uint24 fee, int24 tickSpacing, address hooks) key, uint160 sqrtPriceX96) returns (int24 tick)`
+- `swap((address currency0, address currency1, uint24 fee, int24 tickSpacing, address hooks) key, (bool zeroForOne, int256 amountSpecified, uint160 sqrtPriceLimitX96) params, bytes hookData) returns (int256 delta)`
+- `modifyLiquidity((address currency0, address currency1, uint24 fee, int24 tickSpacing, address hooks) key, (int24 tickLower, int24 tickUpper, int256 liquidityDelta, bytes32 salt) params, bytes hookData) returns (int256 delta, int256 feeDelta)`
+- `extsload(bytes32 slot) view returns (bytes32)`
+- `extsload(bytes32 startSlot, uint256 nSlots) view returns (bytes32[])`
+
+### `UniswapV4PositionManagerABI`
+
+`import UniswapV4PositionManagerABI from "./protocols/uniswap-v4/UniswapV4PositionManagerABI.json";` Speaks for: positionManager.
+
+- `modifyLiquidities(bytes unlockData, uint256 deadline) payable`
+
+### `UniswapV4StateViewABI`
+
+`import UniswapV4StateViewABI from "./protocols/uniswap-v4/UniswapV4StateViewABI.json";` Speaks for: stateView.
+
+- `getSlot0(bytes32 poolId) view returns (uint160 sqrtPriceX96, int24 tick, uint24 protocolFee, uint24 lpFee)`
+- `getLiquidity(bytes32 poolId) view returns (uint128 liquidity)`
+- `getTickInfo(bytes32 poolId, int24 tick) view returns (uint128 liquidityGross, int128 liquidityNet, uint256 feeGrowthOutside0X128, uint256 feeGrowthOutside1X128)`
+- `getTickLiquidity(bytes32 poolId, int24 tick) view returns (uint128 liquidityGross, int128 liquidityNet)`
+- `getTickFeeGrowthOutside(bytes32 poolId, int24 tick) view returns (uint256 feeGrowthOutside0X128, uint256 feeGrowthOutside1X128)`
+- `getTickBitmap(bytes32 poolId, int16 tick) view returns (uint256 tickBitmap)`
+- `getFeeGrowthGlobals(bytes32 poolId) view returns (uint256 feeGrowthGlobal0, uint256 feeGrowthGlobal1)`
+- `getFeeGrowthInside(bytes32 poolId, int24 tickLower, int24 tickUpper) view returns (uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128)`
+- `getPositionInfo(bytes32 poolId, bytes32 positionId) view returns (uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128)`
+- `getPositionInfo(bytes32 poolId, address owner, int24 tickLower, int24 tickUpper, bytes32 salt) view returns (uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128)`
+- `getPositionLiquidity(bytes32 poolId, bytes32 positionId) view returns (uint128 liquidity)`
+- `poolManager() view returns (address)`
+
+### `UniswapV4UniversalRouterABI`
+
+`import UniswapV4UniversalRouterABI from "./protocols/uniswap-v4/UniswapV4UniversalRouterABI.json";` Speaks for: universalRouter.
+
+- `execute(bytes commands, bytes[] inputs, uint256 deadline) payable`
+- `execute(bytes commands, bytes[] inputs) payable`

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

@@ -0,0 +1,65 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# UnitFlow V3 (`unitflow-v3`)
+
+Concentrated-liquidity AMM on Arc, forked from Uniswap V3 with native USDC in place of WETH9.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | `Unitflow`: `unitflow-v3` |
+| Namespace | `UnitflowV3` on arc |
+| Chains | arc |
+| Document | [unitflow-v3.md](../unitflow-v3.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arc, `UnitflowV3` is a namespace: its contracts need no import.
+
+```sauce chain=arc
+function main() {
+  // Arc's factory, `0x5bfBCeb73d39F722B1cB83fD2F11736b28c1Be6d`.
+  require(UnitflowV3.Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arc](../../../sauce-chains/references/arc.md) | factory | `0x5bfBCeb73d39F722B1cB83fD2F11736b28c1Be6d` | `UnitflowV3.Factory` |
+| [Arc](../../../sauce-chains/references/arc.md) | quoter | `0x5AF6E89F0960Ff375AF84d9911D8153ef6240E34` | `UnitflowV3.Quoter` |
+| [Arc](../../../sauce-chains/references/arc.md) | router | `0x6fD8351b9596C1F0b2f2479BfA6A171cb3d0f410` | `UnitflowV3.Router` |
+
+## ABI
+
+### `UnitFlowV3FactoryABI`
+
+`import UnitFlowV3FactoryABI from "./protocols/unitflow-v3/UnitFlowV3FactoryABI.json";` Speaks for: factory.
+
+- `getPool(address tokenA, address tokenB, uint24 fee) view returns (address pool)`
+- `feeAmountTickSpacing(uint24 fee) view returns (int24)`
+
+### `UnitFlowV3PoolABI`
+
+`import UnitFlowV3PoolABI from "./protocols/unitflow-v3/UnitFlowV3PoolABI.json";`
+
+- `slot0() view returns (uint160 sqrtPriceX96, int24 tick, uint16 observationIndex, uint16 observationCardinality, uint16 observationCardinalityNext, uint8 feeProtocol, bool unlocked)`
+- `liquidity() view returns (uint128)`
+- `fee() view returns (uint24)`
+- `tickSpacing() view returns (int24)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+
+### `UnitFlowV3QuoterABI`
+
+`import UnitFlowV3QuoterABI from "./protocols/unitflow-v3/UnitFlowV3QuoterABI.json";` Speaks for: quoter.
+
+- `quoteExactInputSingle(address tokenIn, address tokenOut, uint24 fee, uint256 amountIn, uint160 sqrtPriceLimitX96) returns (uint256 amountOut)`
+
+### `UnitFlowV3RouterABI`
+
+`import UnitFlowV3RouterABI from "./protocols/unitflow-v3/UnitFlowV3RouterABI.json";` Speaks for: router.
+
+- `exactInputSingle((address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)`
+- `factory() view returns (address)`

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

@@ -0,0 +1,58 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Velodrome (`velodrome`)
+
+The central trading and liquidity marketplace on Optimism. Solidly-fork with ve(3,3) tokenomics, supporting both stable and volatile pools.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `Velodrome` on optimism |
+| Chains | optimism |
+| Document | [velodrome.md](../velodrome.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Optimism, `Velodrome` is a namespace: its contracts need no import.
+
+```sauce chain=optimism
+function main() {
+  // Optimism's poolFactory, `0xF1046053aa5682b4F9a81b5481394DA16BE5FF5a`.
+  require(Velodrome.PoolFactory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Optimism](../../../sauce-chains/references/optimism.md) | poolFactory | `0xF1046053aa5682b4F9a81b5481394DA16BE5FF5a` | `Velodrome.PoolFactory` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | routerV2 | `0xa062aE8A9c5e11aaA026fc2670B0D65cCc8B2858` | `Velodrome.RouterV2` |
+
+## ABI
+
+### `VelodromePoolABI`
+
+`import VelodromePoolABI from "./protocols/velodrome/VelodromePoolABI.json";`
+
+- `getReserves() view returns (uint256 _reserve0, uint256 _reserve1, uint256 _blockTimestampLast)`
+- `getAmountOut(uint256 amountIn, address tokenIn) view returns (uint256)`
+- `stable() view returns (bool)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+- `swap(uint256 amount0Out, uint256 amount1Out, address to, bytes data)`
+
+### `VelodromePoolFactoryABI`
+
+`import VelodromePoolFactoryABI from "./protocols/velodrome/VelodromePoolFactoryABI.json";` Speaks for: poolFactory.
+
+- `getPool(address tokenA, address tokenB, bool stable) view returns (address pool)`
+
+### `VelodromeRouterABI`
+
+`import VelodromeRouterABI from "./protocols/velodrome/VelodromeRouterABI.json";` Speaks for: routerV2.
+
+- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, (address from, address to, bool stable, address factory)[] routes, address to, uint256 deadline) returns (uint256[] amounts)`
+- `addLiquidity(address tokenA, address tokenB, bool stable, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB, uint256 liquidity)`
+- `removeLiquidity(address tokenA, address tokenB, bool stable, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB)`

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

@@ -0,0 +1,62 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Venus (`venus`)
+
+Leading lending and borrowing protocol on BNB Chain. Fork of Compound V2 with additional features including VAI stablecoin minting.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | none |
+| Namespace | `Venus` on bsc |
+| Chains | bsc |
+| Document | [venus.md](../venus.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On BNB Chain, `Venus` is a namespace: its contracts need no import.
+
+```sauce chain=bsc
+function main() {
+  // BNB Chain's comptroller, `0xfD36E2c2a6789Db23113685031d7F16329158384`.
+  require(Venus.Comptroller != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | comptroller | `0xfD36E2c2a6789Db23113685031d7F16329158384` | `Venus.Comptroller` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | vBNB | `0xA07c5b74C9B40447a954e1466938b865b6BBea36` | `Venus.VBNB` |
+
+## ABI
+
+### `VBNBABI`
+
+`import VBNBABI from "./protocols/venus/VBNBABI.json";` Speaks for: vBNB.
+
+- `mint() payable`
+- `redeem(uint256 redeemTokens) returns (uint256)`
+- `redeemUnderlying(uint256 redeemAmount) returns (uint256)`
+- `borrow(uint256 borrowAmount) returns (uint256)`
+- `repayBorrow() payable`
+- `balanceOfUnderlying(address owner) returns (uint256)`
+
+### `VTokenABI`
+
+`import VTokenABI from "./protocols/venus/VTokenABI.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)`
+- `balanceOfUnderlying(address owner) returns (uint256)`
+
+### `VenusComptrollerABI`
+
+`import VenusComptrollerABI from "./protocols/venus/VenusComptrollerABI.json";` Speaks for: comptroller.
+
+- `enterMarkets(address[] vTokens) returns (uint256[])`
+- `exitMarket(address vToken) returns (uint256)`

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

@@ -0,0 +1,46 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Vertex (`vertex`)
+
+Vertically integrated DEX combining spot, perpetuals, and money markets with an off-chain sequencer for fast order matching on Arbitrum.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | none |
+| Namespace | `Vertex` on arbitrum |
+| Chains | arbitrum |
+| Document | [vertex.md](../vertex.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `Vertex` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's clearinghouse, `0x773bb71b0108b060b76746422ee810bfec9a963d`.
+  require(Vertex.Clearinghouse != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | clearinghouse | `0x773bb71b0108b060b76746422ee810bfec9a963d` | `Vertex.Clearinghouse` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | endpoint | `0x73eab16c88b9f38d3f2661c9e5875ec0eeee2965` | `Vertex.Endpoint` |
+
+## ABI
+
+### `ClearinghouseABI`
+
+`import ClearinghouseABI from "./protocols/vertex/ClearinghouseABI.json";` Speaks for: clearinghouse.
+
+- `withdrawCollateral((bytes32 sender, uint32 productId, uint128 amount, uint64 nonce) txn)`
+
+### `EndpointABI`
+
+`import EndpointABI from "./protocols/vertex/EndpointABI.json";` Speaks for: endpoint.
+
+- `depositCollateral(bytes12 subaccountName, uint32 productId, uint128 amount)`
+- `submitSlowModeTransaction(bytes transaction)`