@eco-incorp/sauce 0.99.6 → 0.99.7

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)`

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

@@ -0,0 +1,43 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Pendle (`pendle`)
+
+Yield trading protocol that tokenizes future yield. Split yield-bearing assets into principal tokens (PT) and yield tokens (YT) for trading.
+
+| Fact | Value |
+| --- | --- |
+| Category | Yield and vaults |
+| Family | none |
+| Namespace | `Pendle` on ethereum, monad, arbitrum |
+| Chains | ethereum, monad, arbitrum |
+| Document | [pendle.md](../pendle.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Pendle` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's router, `0x888888888889758F76e7103c6CbF23ABbF58F946`.
+  require(Pendle.Router != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | router | `0x888888888889758F76e7103c6CbF23ABbF58F946` | `Pendle.Router` |
+| [Monad](../../../sauce-chains/references/monad.md) | router | `0x888888888889758F76e7103c6CbF23ABbF58F946` | `Pendle.Router` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | router | `0x888888888889758F76e7103c6CbF23ABbF58F946` | `Pendle.Router` |
+
+## ABI
+
+### `PendleRouterABI`
+
+`import PendleRouterABI from "./protocols/pendle/PendleRouterABI.json";` Speaks for: router.
+
+- `addLiquiditySingleToken(address receiver, address market, uint256 minLpOut, (uint256 guessMin, uint256 guessMax, uint256 guessOffchain, uint256 maxIteration, uint256 eps) guessPtReceivedFromSy, (address tokenIn, uint256 netTokenIn, address tokenMintSy, address pendleSwap, (uint8 swapType, address extRouter, bytes extCalldata, bool needScale) swapData) input, (address limitRouter, uint256 epsSkipMarket, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] normalFills, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] flashFills, bytes optData) limit) payable returns (uint256 netLpOut, uint256 netSyFee, uint256 netSyInterm)`
+- `removeLiquiditySingleToken(address receiver, address market, uint256 netLpToRemove, (address tokenOut, uint256 minTokenOut, address tokenRedeemSy, address pendleSwap, (uint8 swapType, address extRouter, bytes extCalldata, bool needScale) swapData) output, (address limitRouter, uint256 epsSkipMarket, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] normalFills, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] flashFills, bytes optData) limit) returns (uint256 netTokenOut, uint256 netSyFee, uint256 netSyInterm)`
+- `swapExactTokenForPt(address receiver, address market, uint256 minPtOut, (uint256 guessMin, uint256 guessMax, uint256 guessOffchain, uint256 maxIteration, uint256 eps) guessPtOut, (address tokenIn, uint256 netTokenIn, address tokenMintSy, address pendleSwap, (uint8 swapType, address extRouter, bytes extCalldata, bool needScale) swapData) input, (address limitRouter, uint256 epsSkipMarket, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] normalFills, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] flashFills, bytes optData) limit) payable returns (uint256 netPtOut, uint256 netSyFee, uint256 netSyInterm)`
+- `swapExactTokenForYt(address receiver, address market, uint256 minYtOut, (uint256 guessMin, uint256 guessMax, uint256 guessOffchain, uint256 maxIteration, uint256 eps) guessYtOut, (address tokenIn, uint256 netTokenIn, address tokenMintSy, address pendleSwap, (uint8 swapType, address extRouter, bytes extCalldata, bool needScale) swapData) input, (address limitRouter, uint256 epsSkipMarket, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] normalFills, ((uint256 salt, uint256 expiry, uint256 nonce, uint8 orderType, address token, address YT, address maker, address receiver, uint256 makingAmount, uint256 lnImpliedRate, uint256 failSafeRate, bytes permit) order, bytes signature, uint256 makingAmount)[] flashFills, bytes optData) limit) payable returns (uint256 netYtOut, uint256 netSyFee, uint256 netSyInterm)`

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

@@ -0,0 +1,50 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Permit2 (`permit2`)
+
+Universal token approval infrastructure by Uniswap. Provides a single approval contract for all DeFi protocols, improving security and UX.
+
+| Fact | Value |
+| --- | --- |
+| Category | Infrastructure and standards |
+| Family | none |
+| Namespace | `Permit2` on ethereum, optimism, bsc, polygon, monad, arc, base, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, monad, arc, base, arbitrum, avalanche |
+| Document | [permit2.md](../permit2.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Permit2` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's permit2, `0x000000000022D473030F116dDEE9F6B43aC78BA3`.
+  require(Permit2.Permit2 != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Monad](../../../sauce-chains/references/monad.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Arc](../../../sauce-chains/references/arc.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Base](../../../sauce-chains/references/base.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | permit2 | `0x000000000022D473030F116dDEE9F6B43aC78BA3` | `Permit2.Permit2` |
+
+## ABI
+
+### `Permit2ABI`
+
+`import Permit2ABI from "./protocols/permit2/Permit2ABI.json";` Speaks for: permit2.
+
+- `approve(address token, address spender, uint160 amount, uint48 expiration)`
+- `transferFrom(address from, address to, uint160 amount, address token)`
+- `permitTransferFrom(((address token, uint256 amount) permitted, uint256 nonce, uint256 deadline) permit, (address to, uint256 requestedAmount) transferDetails, address owner, bytes signature)`
+- `nonceBitmap(address owner, uint256 wordPosition) view returns (uint256)`
+- `lockdown((address token, address spender)[] approvals)`

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

@@ -0,0 +1,49 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Perpetual Protocol (`perpetual-protocol`)
+
+Decentralized perpetual futures exchange (Curie v2) on Optimism. Concentrated-liquidity virtual AMM with cross-margin trading.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | none |
+| Namespace | `PerpetualProtocol` on optimism |
+| Chains | optimism |
+| Document | [perpetual-protocol.md](../perpetual-protocol.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Optimism, `PerpetualProtocol` is a namespace: its contracts need no import.
+
+```sauce chain=optimism
+function main() {
+  // Optimism's clearingHouse, `0x82ac2CE43e33683c58BE4cDc40975E73aA50f459`.
+  require(PerpetualProtocol.ClearingHouse != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Optimism](../../../sauce-chains/references/optimism.md) | clearingHouse | `0x82ac2CE43e33683c58BE4cDc40975E73aA50f459` | `PerpetualProtocol.ClearingHouse` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | vault | `0xAD7b4C162707E0B2b5f6fdDbD3f8538A5fbA0d60` | `PerpetualProtocol.Vault` |
+
+## ABI
+
+### `ClearingHouseABI`
+
+`import ClearingHouseABI from "./protocols/perpetual-protocol/ClearingHouseABI.json";` Speaks for: clearingHouse.
+
+- `openPosition((address baseToken, bool isBaseToQuote, bool isExactInput, uint256 amount, uint256 oppositeAmountBound, uint256 deadline, uint160 sqrtPriceLimitX96, bytes32 referralCode) params) returns (uint256 base, uint256 quote)`
+- `closePosition((address baseToken, uint160 sqrtPriceLimitX96, uint256 oppositeAmountBound, uint256 deadline, bytes32 referralCode) params) returns (uint256 base, uint256 quote)`
+- `getAccountValue(address trader) view returns (int256)`
+
+### `VaultABI`
+
+`import VaultABI from "./protocols/perpetual-protocol/VaultABI.json";` Speaks for: vault.
+
+- `deposit(address token, uint256 amount)`
+- `withdraw(address token, uint256 amount)`
+- `getFreeCollateral(address trader) view returns (uint256)`

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

@@ -0,0 +1,43 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Polygon Native Bridge (`polygon-bridge`)
+
+Official Polygon PoS bridge via RootChainManager. Supports ETH, ERC-20, ERC-721, and ERC-1155 deposits with checkpoint-based withdrawals.
+
+| Fact | Value |
+| --- | --- |
+| Category | Bridges |
+| Family | none |
+| Namespace | `PolygonBridge` on ethereum, polygon |
+| Chains | ethereum, polygon |
+| Document | [polygon-bridge.md](../polygon-bridge.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `PolygonBridge` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's erc20Predicate, `0x40ec5B33f54e0E8A33A975908C5BA1c14e5BbbDf`.
+  require(PolygonBridge.Erc20Predicate != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | erc20Predicate | `0x40ec5B33f54e0E8A33A975908C5BA1c14e5BbbDf` | `PolygonBridge.Erc20Predicate` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | etherPredicate | `0x8484Ef722627bf18ca5Ae6BcF031c23E6e922B30` | `PolygonBridge.EtherPredicate` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | rootChainManager | `0xA0c68C638235ee32657e8f720a23ceC1bFc77C77` | `PolygonBridge.RootChainManager` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | childChainManager | `0xA6FA4fB5f76172d178d61B04b0ecd319C5d1C0aa` | `PolygonBridge.ChildChainManager` |
+
+## ABI
+
+### `PolygonRootChainManagerABI`
+
+`import PolygonRootChainManagerABI from "./protocols/polygon-bridge/PolygonRootChainManagerABI.json";` Speaks for: rootChainManager.
+
+- `depositEtherFor(address user) payable`
+- `depositFor(address user, address rootToken, bytes depositData)`
+- `exit(bytes inputData)`

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

@@ -0,0 +1,40 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Premia (`premia`)
+
+Decentralized options protocol with an AMM-based pricing model and concentrated liquidity for options vaults.
+
+| Fact | Value |
+| --- | --- |
+| Category | Options |
+| Family | none |
+| Namespace | `Premia` on arbitrum |
+| Chains | arbitrum |
+| Document | [premia.md](../premia.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `Premia` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's poolFactory, `0xAE4fB6622F25f397587F11638dA8CE88C27b5645`.
+  require(Premia.PoolFactory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | poolFactory | `0xAE4fB6622F25f397587F11638dA8CE88C27b5645` | `Premia.PoolFactory` |
+
+## ABI
+
+### `DiamondABI`
+
+`import DiamondABI from "./protocols/premia/DiamondABI.json";`
+
+- `trade(uint256 size, bool isBuy, uint256 premiumLimit, address referrer) returns (uint256 totalPremium, (int256 collateral, int256 longs, int256 shorts) delta)`
+- `exercise() returns (uint256 exerciseValue, uint256 exerciseFee)`
+- `settle() returns (uint256 collateral)`

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

@@ -0,0 +1,43 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Puffer Finance (`puffer`)
+
+Liquid restaking protocol that issues pufETH. Deposits are natively restaked via EigenLayer for additional yield.
+
+| Fact | Value |
+| --- | --- |
+| Category | Restaking |
+| Family | none |
+| Namespace | `Puffer` on ethereum |
+| Chains | ethereum |
+| Document | [puffer.md](../puffer.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Puffer` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's pufETH, `0xD9A442856C234a39a81a089C06451EBAa4306a72`.
+  require(Puffer.PufETH != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | pufETH | `0xD9A442856C234a39a81a089C06451EBAa4306a72` | `Puffer.PufETH` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | pufferVault | `0xD9A442856C234a39a81a089C06451EBAa4306a72` | `Puffer.PufETH` |
+
+## ABI
+
+### `PufferVaultABI`
+
+`import PufferVaultABI from "./protocols/puffer/PufferVaultABI.json";` Speaks for: pufferVault.
+
+- `deposit(uint256 assets, address receiver) returns (uint256 shares)`
+- `redeem(uint256 shares, address receiver, address owner) returns (uint256 assets)`
+- `convertToShares(uint256 assets) view returns (uint256)`
+- `convertToAssets(uint256 shares) view returns (uint256)`
+- `balanceOf(address account) view returns (uint256)`

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

@@ -0,0 +1,40 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Pyth Network (`pyth`)
+
+High-fidelity oracle network providing low-latency price feeds from institutional sources. Uses pull-based model for efficient on-chain price updates.
+
+| Fact | Value |
+| --- | --- |
+| Category | Oracles |
+| Family | none |
+| Namespace | `Pyth` on ethereum |
+| Chains | ethereum |
+| Document | [pyth.md](../pyth.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Pyth` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's oracle, `0x4305FB66699C3B2702D4d05CF36551390A4c69C6`.
+  require(Pyth.Oracle != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | oracle | `0x4305FB66699C3B2702D4d05CF36551390A4c69C6` | `Pyth.Oracle` |
+
+## ABI
+
+### `PythOracleABI`
+
+`import PythOracleABI from "./protocols/pyth/PythOracleABI.json";` Speaks for: oracle.
+
+- `updatePriceFeeds(bytes[] updateData) payable`
+- `getPrice(bytes32 id) view returns ((int64 price, uint64 conf, int32 expo, uint256 publishTime) price)`
+- `getUpdateFee(bytes[] updateData) view returns (uint256 feeAmount)`

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

@@ -0,0 +1,80 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# QuickSwap (`quickswap`)
+
+The leading DEX on Polygon with V2 (constant product) and V3 (Algebra concentrated liquidity) pools. Low-fee trading powered by Polygon's infrastructure.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `Quickswap` on polygon |
+| Chains | polygon |
+| Document | [quickswap.md](../quickswap.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Polygon, `Quickswap` is a namespace: its contracts need no import.
+
+```sauce chain=polygon
+function main() {
+  // Polygon's v2Factory, `0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32`.
+  require(Quickswap.V2Factory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Polygon](../../../sauce-chains/references/polygon.md) | v2Factory | `0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32` | `Quickswap.V2Factory` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | v2Router | `0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff` | `Quickswap.V2Router` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | v3Factory | `0x411b0fAcC3489691f28ad58c47006AF5E3Ab3A28` | `Quickswap.V3Factory` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | v3SwapRouter | `0xf5b509bB0909a69B1c207E495f687a596C168e12` | `Quickswap.V3SwapRouter` |
+
+## ABI
+
+### `QuickSwapV2FactoryABI`
+
+`import QuickSwapV2FactoryABI from "./protocols/quickswap/QuickSwapV2FactoryABI.json";` Speaks for: v2Factory.
+
+- `getPair(address tokenA, address tokenB) view returns (address pair)`
+
+### `QuickSwapV2PairABI`
+
+`import QuickSwapV2PairABI from "./protocols/quickswap/QuickSwapV2PairABI.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)`
+
+### `QuickSwapV2RouterABI`
+
+`import QuickSwapV2RouterABI from "./protocols/quickswap/QuickSwapV2RouterABI.json";` Speaks for: v2Router.
+
+- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, 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)`
+
+### `QuickSwapV3FactoryABI`
+
+`import QuickSwapV3FactoryABI from "./protocols/quickswap/QuickSwapV3FactoryABI.json";` Speaks for: v3Factory.
+
+- `poolByPair(address tokenA, address tokenB) view returns (address pool)`
+
+### `QuickSwapV3PoolABI`
+
+`import QuickSwapV3PoolABI from "./protocols/quickswap/QuickSwapV3PoolABI.json";`
+
+- `globalState() view returns (uint160 price, int24 tick, uint16 fee, uint16 timepointIndex, uint8 communityFeeToken0, uint8 communityFeeToken1, bool unlocked)`
+- `liquidity() view returns (uint128)`
+- `tickSpacing() pure returns (int24)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+
+### `QuickSwapV3SwapRouterABI`
+
+`import QuickSwapV3SwapRouterABI from "./protocols/quickswap/QuickSwapV3SwapRouterABI.json";` Speaks for: v3SwapRouter.
+
+- `exactInputSingle((address tokenIn, address tokenOut, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum, uint160 limitSqrtPrice) params) payable returns (uint256 amountOut)`

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

@@ -0,0 +1,41 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Radiant (`radiant`)
+
+Omnichain lending protocol on Arbitrum. Aave V2 fork with cross-chain lending capabilities via LayerZero. Requires dLP locking for emission eligibility.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | none |
+| Namespace | `Radiant` on arbitrum |
+| Chains | arbitrum |
+| Document | [radiant.md](../radiant.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `Radiant` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's lendingPool, `0xF4B1486DD74D07706052A33d31d7c0AAFD0659E1`.
+  require(Radiant.LendingPool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | lendingPool | `0xF4B1486DD74D07706052A33d31d7c0AAFD0659E1` | `Radiant.LendingPool` |
+
+## ABI
+
+### `RadiantLendingPoolABI`
+
+`import RadiantLendingPoolABI from "./protocols/radiant/RadiantLendingPoolABI.json";` Speaks for: lendingPool.
+
+- `deposit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode)`
+- `withdraw(address asset, uint256 amount, address to) returns (uint256)`
+- `borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)`
+- `repay(address asset, uint256 amount, uint256 rateMode, address onBehalfOf) returns (uint256)`

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

@@ -0,0 +1,39 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Ramses (`ramses`)
+
+Arbitrum-native ve(3,3) DEX with concentrated liquidity. Features gauge voting, bribes, and protocol-owned liquidity mechanisms.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `Ramses` on arbitrum |
+| Chains | arbitrum |
+| Document | [ramses.md](../ramses.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `Ramses` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's router, `0xAAA87963EFeB6f7E0a2711F397663105Acb1805e`.
+  require(Ramses.Router != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | router | `0xAAA87963EFeB6f7E0a2711F397663105Acb1805e` | `Ramses.Router` |
+
+## ABI
+
+### `RamsesRouterABI`
+
+`import RamsesRouterABI from "./protocols/ramses/RamsesRouterABI.json";` Speaks for: router.
+
+- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, (address from, address to, bool stable)[] 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)`