@eco-incorp/sauce 0.99.6 → 0.99.7

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

@@ -0,0 +1,45 @@
+# Pyth Network
+
+High-fidelity oracle network providing low-latency price feeds from institutional sources. Uses pull-based model for efficient on-chain price updates.
+
+## Category
+
+oracle | Chains and addresses: [registry/pyth.md](registry/pyth.md)
+
+## Key Operations
+
+- **getPrice**: Read price from Pyth oracle by price feed ID
+
+## Typed templates for the raw compiler (not for `sauce compile`)
+
+These import the protocol's ABI from `./abis`, the way the registry compiles them with the raw
+compiler; `sauce compile` has no such module. In a program for a chain, name the contract by its
+namespace, or import its ABI from `./protocols/<slug>/<Export>.json` as the registry file at the
+top of this document shows, and write SauceScript's values (`~0n`, not `type(uint256).max`).
+
+```typescript
+// Get price by feed ID
+import { PythOracleABI as IPythOracle } from "./abis";
+function main(
+  oracleAddress: Address,
+  priceId: Uint256,
+): { price: Uint256; conf: Uint256; expo: Uint256; publishTime: Uint256 } {
+  const oracle = IPythOracle.at(oracleAddress);
+  return oracle.getPrice(priceId);
+}
+```
+
+## Deployments and ABI
+
+The registry's addresses per chain, how a program names each contract there (a namespace, or
+an ABI import bound to the address), and the ABI functions are generated in
+[registry/pyth.md](registry/pyth.md).
+
+## Notes
+
+- Pull-based oracle: users must call updatePriceFeeds before reading prices
+- Sub-second latency from institutional market data providers
+- Actual price = price * 10^expo (e.g. price=12345, expo=-2 means $123.45)
+- Price feed IDs are bytes32 - see Pyth docs for specific feed IDs per asset
+- updatePriceFeeds requires sending ETH to pay the update fee (use getUpdateFee to check)
+- Get price update data from Pyth Hermes API off-chain, then submit on-chain

package/{sdk/src/skills → skills/sauce-protocols/references}/quickswap.md

@@ -1,10 +1,12 @@
 # QuickSwap
 
+> **In a Sauce program**, swap through the Sauce Router wherever it services the pool, with a price limit, a minimum output and the unspent input returned (`sauce-swaps`; several pools under one limit, `sauce-distributed-swap`). The templates below call the protocol's own contracts.
+
 The leading DEX on Polygon with V2 (constant product, x*y=k) and V3 (Algebra-based concentrated liquidity with dynamic fees) pools. Low-fee trading powered by Polygon's infrastructure.
 
 ## Category
 
-dex | Chains: Polygon
+dex | Chains and addresses: [registry/quickswap.md](registry/quickswap.md)
 
 ## Key Operations
 
@@ -13,13 +15,12 @@ dex | Chains: Polygon
 - **addLiquidity**: Add liquidity to V2 pools
 - **removeLiquidity**: Remove liquidity from V2 pools
 
-## SDK Usage
+## Typed templates for the raw compiler (not for `sauce compile`)
 
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/quickswap";
-```
-
-## SauceScript Examples
+These import the protocol's ABI from `./abis`, the way the registry compiles them with the raw
+compiler; `sauce compile` has no such module. In a program for a chain, name the contract by its
+namespace, or import its ABI from `./protocols/<slug>/<Export>.json` as the registry file at the
+top of this document shows, and write SauceScript's values (`~0n`, not `type(uint256).max`).
 
 ### swapV2
 
@@ -71,7 +72,7 @@ function main(
 ```
 
 - No `fee` parameter: QuickSwap V3 uses Algebra protocol with dynamic fees (not fixed fee tiers)
-- `limitSqrtPrice`: Set to `0` for no price limit
+- `limitSqrtPrice`: `0` in this template, no price limit, so `amountOutMin` is the only bound. QuickSwap V3 is an Algebra pool, which the Sauce Router's `swapV3` drives with a real limit (`sauce-swaps`)
 
 ### addLiquidity
 
@@ -133,26 +134,11 @@ function main(
 
 - LP token must be approved to the V2 router
 
-## Key Addresses
-
-| Chain   | Contract      | Address                                      |
-| ------- | ------------- | -------------------------------------------- |
-| Polygon | V2 Factory    | `0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32` |
-| Polygon | V2 Router     | `0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff` |
-| Polygon | V3 Factory    | `0x411b0fAcC3489691f28ad58c47006AF5E3Ab3A28` |
-| Polygon | V3 SwapRouter | `0xf5b509bB0909a69B1c207E495f687a596C168e12` |
-
-## ABI Methods
-
-### QuickSwapV2RouterABI
-
-- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, uint256 deadline) -> uint256[] amounts` - V2 swap exact input along path
-- `addLiquidity(address tokenA, address tokenB, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB, uint256 liquidity)` - Add V2 LP
-- `removeLiquidity(address tokenA, address tokenB, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB)` - Remove V2 LP
-
-### QuickSwapV3SwapRouterABI
+## Deployments and ABI
 
-- `exactInputSingle(tuple(address tokenIn, address tokenOut, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum, uint160 limitSqrtPrice)) -> uint256 amountOut` - V3 concentrated liquidity swap with dynamic fees
+The registry's addresses per chain, how a program names each contract there (a namespace, or
+an ABI import bound to the address), and the ABI functions are generated in
+[registry/quickswap.md](registry/quickswap.md).
 
 ## Notes
 

package/{sdk/src/skills → skills/sauce-protocols/references}/radiant.md

@@ -4,9 +4,14 @@ Omnichain lending protocol on Arbitrum. Aave V2 fork with cross-chain lending ca
 
 ## Category
 
-lending | Chains: Arbitrum (42161)
+lending | Chains and addresses: [registry/radiant.md](registry/radiant.md)
 
-## SauceScript Functions
+## Typed templates for the raw compiler (not for `sauce compile`)
+
+These import the protocol's ABI from `./abis`, the way the registry compiles them with the raw
+compiler; `sauce compile` has no such module. In a program for a chain, name the contract by its
+namespace, or import its ABI from `./protocols/<slug>/<Export>.json` as the registry file at the
+top of this document shows, and write SauceScript's values (`~0n`, not `type(uint256).max`).
 
 ### deposit
 
@@ -90,20 +95,11 @@ function main(
 - `rateMode`: Must match existing debt type (1 = stable, 2 = variable)
 - Requires ERC-20 approval to the LendingPool
 
-## Deployed Addresses
-
-| Chain    | Contract    | Address                                      |
-| -------- | ----------- | -------------------------------------------- |
-| Arbitrum | lendingPool | `0xF4B1486DD74D07706052A33d31d7c0AAFD0659E1` |
-
-## ABI Reference
-
-### RadiantLendingPoolABI
+## Deployments and ABI
 
-- `deposit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode)` - Deposit asset to earn interest
-- `withdraw(address asset, uint256 amount, address to) returns (uint256)` - Withdraw deposited asset
-- `borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)` - Borrow against collateral
-- `repay(address asset, uint256 amount, uint256 rateMode, address onBehalfOf) returns (uint256)` - Repay borrowed debt
+The registry's addresses per chain, how a program names each contract there (a namespace, or
+an ABI import bound to the address), and the ABI functions are generated in
+[registry/radiant.md](registry/radiant.md).
 
 ## Notes
 

package/{sdk/src/skills → skills/sauce-protocols/references}/ramses.md

@@ -1,22 +1,23 @@
 # Ramses
 
+> **In a Sauce program**, swap through the Sauce Router wherever it services the pool, with a price limit, a minimum output and the unspent input returned (`sauce-swaps`; several pools under one limit, `sauce-distributed-swap`). The templates below call the protocol's own contracts.
+
 Arbitrum-native ve(3,3) DEX with concentrated liquidity support. Features gauge voting, bribes, and protocol-owned liquidity mechanisms. Solidly-fork architecture.
 
 ## Category
 
-dex | Chains: Arbitrum
+dex | Chains and addresses: [registry/ramses.md](registry/ramses.md)
 
 ## Key Operations
 
 - **swap**: Swap tokens with route-based routing specifying stable or volatile pool type
 
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/ramses";
-```
+## Typed templates for the raw compiler (not for `sauce compile`)
 
-## SauceScript Examples
+These import the protocol's ABI from `./abis`, the way the registry compiles them with the raw
+compiler; `sauce compile` has no such module. In a program for a chain, name the contract by its
+namespace, or import its ABI from `./protocols/<slug>/<Export>.json` as the registry file at the
+top of this document shows, and write SauceScript's values (`~0n`, not `type(uint256).max`).
 
 ### swap
 
@@ -52,18 +53,11 @@ function main(
 - Routes support multi-hop: `[{from: A, to: B, stable: false}, {from: B, to: C, stable: true}]`
 - Note: Ramses routes do NOT include a `factory` field (unlike Velodrome/Aerodrome)
 
-## Key Addresses
-
-| Chain    | Contract | Address                                      |
-| -------- | -------- | -------------------------------------------- |
-| Arbitrum | Router   | `0xAAA87963EFeB6f7E0a2711F397663105Acb1805e` |
-
-## ABI Methods
-
-### RamsesRouterABI
+## Deployments and ABI
 
-- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, tuple[](address from, address to, bool stable) routes, address to, uint256 deadline) -> uint256[] amounts` - Swap with route tuples specifying pool type per hop
-- `addLiquidity(address tokenA, address tokenB, bool stable, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB, uint256 liquidity)` - Add liquidity to a stable or volatile pool
+The registry's addresses per chain, how a program names each contract there (a namespace, or
+an ABI import bound to the address), and the ABI functions are generated in
+[registry/ramses.md](registry/ramses.md).
 
 ## Notes
 

package/skills/sauce-protocols/references/reflexer.md

@@ -0,0 +1,52 @@
+# Reflexer
+
+Non-pegged stablecoin protocol issuing RAI. Uses a PID controller to dampen RAI price volatility against ETH collateral.
+
+## Category
+
+cdp | Chains and addresses: [registry/reflexer.md](registry/reflexer.md)
+
+## Key Operations
+
+- **exitRai**: Exit RAI from the system (withdraw RAI tokens)
+- **joinRai**: Join RAI into the system (deposit RAI tokens)
+
+## Typed templates for the raw compiler (not for `sauce compile`)
+
+These import the protocol's ABI from `./abis`, the way the registry compiles them with the raw
+compiler; `sauce compile` has no such module. In a program for a chain, name the contract by its
+namespace, or import its ABI from `./protocols/<slug>/<Export>.json` as the registry file at the
+top of this document shows, and write SauceScript's values (`~0n`, not `type(uint256).max`).
+
+```typescript
+// Exit RAI from system
+import { CoinJoinABI as ICoinJoin } from "./abis";
+function main(coinJoinAddress: Address, account: Address, amount: Uint256): Uint256 {
+  const coinJoin = ICoinJoin.at(coinJoinAddress);
+  coinJoin.exit(account, amount);
+  return 1;
+}
+
+// Join RAI into system
+import { CoinJoinABI as ICoinJoin } from "./abis";
+function main(coinJoinAddress: Address, account: Address, amount: Uint256): Uint256 {
+  const coinJoin = ICoinJoin.at(coinJoinAddress);
+  coinJoin.join(account, amount);
+  return 1;
+}
+```
+
+## Deployments and ABI
+
+The registry's addresses per chain, how a program names each contract there (a namespace, or
+an ABI import bound to the address), and the ABI functions are generated in
+[registry/reflexer.md](registry/reflexer.md).
+
+## Notes
+
+- RAI is non-pegged, floating around $3 - NOT a $1 stablecoin
+- PID controller adjusts the redemption rate to dampen RAI price volatility
+- Inspired by MakerDAO but with a non-pegged design philosophy
+- SAFEs (similar to MakerDAO Vaults) hold ETH collateral backing RAI debt
+- coinJoin converts between internal system debt units and external RAI ERC-20
+- ethJoin converts between ETH and internal collateral accounting

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

@@ -0,0 +1,43 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Aave V2 (`aave-v2`)
+
+Legacy version of Aave lending protocol. Still holds significant TVL on Ethereum, Polygon, and Avalanche.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | `Aave`: `aave-v2`, `aave-v3`, `aave-v4` |
+| Namespace | `AaveV2` on ethereum, polygon, avalanche |
+| Chains | ethereum, polygon, avalanche |
+| Document | [aave-v2.md](../aave-v2.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `AaveV2` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's lendingPool, `0x7d2768dE32b0b80b7a3454c06BdAc94A69DDc7A9`.
+  require(AaveV2.LendingPool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | lendingPool | `0x7d2768dE32b0b80b7a3454c06BdAc94A69DDc7A9` | `AaveV2.LendingPool` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | lendingPool | `0x8dFf5E27EA6b7AC08EbFdf9eB090F32ee9a30fcf` | `AaveV2.LendingPool` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | lendingPool | `0x4F01AeD16D97E3aB5ab2B501154DC9bb0F1A5A2C` | `AaveV2.LendingPool` |
+
+## ABI
+
+### `LendingPoolABI`
+
+`import LendingPoolABI from "./protocols/aave-v2/LendingPoolABI.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/aave-v3.md

@@ -0,0 +1,62 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Aave V3 (`aave-v3`)
+
+Non-custodial liquidity protocol for earning interest on deposits and borrowing assets. The most widely deployed lending protocol in DeFi.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | `Aave`: `aave-v2`, `aave-v3`, `aave-v4` |
+| Namespace | `AaveV3` on ethereum, optimism, bsc, gnosis, polygon, monad, fantom, metis, base, arbitrum, avalanche, scroll |
+| Chains | ethereum, optimism, bsc, gnosis, polygon, monad, fantom, metis, base, arbitrum, avalanche, scroll |
+| Document | [aave-v3.md](../aave-v3.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `AaveV3` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's pool, `0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2`.
+  require(AaveV3.Pool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | pool | `0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2` | `AaveV3.Pool` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | poolAddressesProvider | `0x2f39d218133AFaB8F2B819B1066c7E434Ad94E9e` | `AaveV3.PoolAddressesProvider` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | pool | `0x794a61358D6845594F94dc1DB02A252b5b4814aD` | `AaveV3.Pool` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | poolAddressesProvider | `0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb` | `AaveV3.PoolAddressesProvider` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | pool | `0x6807dc923806fE8Fd134338EABCA509979a7e0cB` | `AaveV3.Pool` |
+| [Gnosis](../../../sauce-chains/references/gnosis.md) | pool | `0xb50201558B00496A145fE76f7424749556E326D8` | `AaveV3.Pool` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | pool | `0x794a61358D6845594F94dc1DB02A252b5b4814aD` | `AaveV3.Pool` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | poolAddressesProvider | `0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb` | `AaveV3.PoolAddressesProvider` |
+| [Monad](../../../sauce-chains/references/monad.md) | pool | `0x69a5F9AD4f96ebf0a0C792dD42a01cC5C0102fef` | `AaveV3.Pool` |
+| [Monad](../../../sauce-chains/references/monad.md) | poolAddressesProvider | `0x34793Fb9935F7bB5E5aE920fb963F39063E7A615` | `AaveV3.PoolAddressesProvider` |
+| [Fantom](../../../sauce-chains/references/fantom.md) | pool | `0x794a61358D6845594F94dc1DB02A252b5b4814aD` | `AaveV3.Pool` |
+| [Metis](../../../sauce-chains/references/metis.md) | pool | `0x90df02551bB792286e8D4f13E0e357b4Bf1D6a57` | `AaveV3.Pool` |
+| [Base](../../../sauce-chains/references/base.md) | pool | `0xA238Dd80C259a72e81d7e4664a9801593F98d1c5` | `AaveV3.Pool` |
+| [Base](../../../sauce-chains/references/base.md) | poolAddressesProvider | `0xe20fCBdBfFC4Dd138cE8b2E6FBb6CB49777ad64D` | `AaveV3.PoolAddressesProvider` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | pool | `0x794a61358D6845594F94dc1DB02A252b5b4814aD` | `AaveV3.Pool` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | poolAddressesProvider | `0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb` | `AaveV3.PoolAddressesProvider` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | pool | `0x794a61358D6845594F94dc1DB02A252b5b4814aD` | `AaveV3.Pool` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | poolAddressesProvider | `0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb` | `AaveV3.PoolAddressesProvider` |
+| [Scroll](../../../sauce-chains/references/scroll.md) | pool | `0x11fCfe756c05AD438e312a7fd934381537D3cFfe` | `AaveV3.Pool` |
+
+## ABI
+
+### `PoolABI`
+
+`import PoolABI from "./protocols/aave-v3/PoolABI.json";` Speaks for: pool.
+
+- `supply(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 interestRateMode, address onBehalfOf) returns (uint256)`
+- `flashLoanSimple(address receiverAddress, address asset, uint256 amount, bytes params, uint16 referralCode)`
+- `liquidationCall(address collateralAsset, address debtAsset, address user, uint256 debtToCover, bool receiveAToken)`
+- `getUserAccountData(address user) view returns (uint256 totalCollateralBase, uint256 totalDebtBase, uint256 availableBorrowsBase, uint256 currentLiquidationThreshold, uint256 ltv, uint256 healthFactor)`

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

@@ -0,0 +1,80 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Aave V4 (`aave-v4`)
+
+Hub-and-spoke lending. Liquidity sits in a Hub; users supply, borrow and repay through Spokes, each addressing its assets by reserve id.
+
+| Fact | Value |
+| --- | --- |
+| Category | Lending |
+| Family | `Aave`: `aave-v2`, `aave-v3`, `aave-v4` |
+| Namespace | `AaveV4` on ethereum, arc, base, avalanche |
+| Chains | ethereum, arc, base, avalanche |
+| Document | [aave-v4.md](../aave-v4.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `AaveV4` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's bluechipSpoke, `0x973a023A77420ba610f06b3858aD991Df6d85A08`.
+  require(AaveV4.BluechipSpoke != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | bluechipSpoke | `0x973a023A77420ba610f06b3858aD991Df6d85A08` | `AaveV4.BluechipSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | coreHub | `0xCca852Bc40e560adC3b1Cc58CA5b55638ce826c9` | `AaveV4.CoreHub` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | ethenaCorrelatedSpoke | `0x58131E79531caB1d52301228d1f7b842F26B9649` | `AaveV4.EthenaCorrelatedSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | ethenaEcosystemSpoke | `0xba1B3D55D249692b669A164024A838309B7508AF` | `AaveV4.EthenaEcosystemSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | etherfiESpoke | `0xbF10BDfE177dE0336aFD7fcCF80A904E15386219` | `AaveV4.EtherfiESpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | forexSpoke | `0xD8B93635b8C6d0fF98CbE90b5988E3F2d1Cd9da1` | `AaveV4.ForexSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | globalDollarHub | `0x62d63197660c080236193CA60b70E49A08E90368` | `AaveV4.GlobalDollarHub` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | goldSpoke | `0x65407b940966954b23dfA3caA5C0702bB42984DC` | `AaveV4.GoldSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | kelpESpoke | `0x3131FE68C4722e726fe6B2819ED68e514395B9a4` | `AaveV4.KelpESpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | lidoESpoke | `0xe1900480ac69f0B296841Cd01cC37546d92F35Cd` | `AaveV4.LidoESpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | lombardBtcSpoke | `0x7EC68b5695e803e98a21a9A05d744F28b0a7753D` | `AaveV4.LombardBtcSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | mainSpoke | `0x94e7A5dCbE816e498b89aB752661904E2F56c485` | `AaveV4.MainSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | paxgGoldSpoke | `0xAD75cE6354f87F3135cE10621d385d8D1e2562C2` | `AaveV4.PaxgGoldSpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | plusHub | `0x06002e9c4412CB7814a791eA3666D905871E536A` | `AaveV4.PlusHub` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | primeHub | `0x943827DCA022D0F354a8a8c332dA1e5Eb9f9F931` | `AaveV4.PrimeHub` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | usdgMapleESpoke | `0x774b9655413c34809c1f1b16b654465A89EBE989` | `AaveV4.UsdgMapleESpoke` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | usdgPendleSpoke | `0x956d8e0A89cfa3744428C4641b5a53B56167a7f9` | `AaveV4.UsdgPendleSpoke` |
+| [Arc](../../../sauce-chains/references/arc.md) | coreHub | `0x17288dfc86205301064577b98B02b81017e6F79C` | `AaveV4.CoreHub` |
+| [Arc](../../../sauce-chains/references/arc.md) | forexSpoke | `0x4164EBCAF74670aa74C8D4F59de6157c0780F1bB` | `AaveV4.ForexSpoke` |
+| [Arc](../../../sauce-chains/references/arc.md) | mainSpoke | `0xB843bdC3a87A05E77E07Df9FE48928b3A34b134d` | `AaveV4.MainSpoke` |
+| [Base](../../../sauce-chains/references/base.md) | equitiesHub | `0xa4d5947Eb727A052bae69C593FfC84247EC9864E` | `AaveV4.EquitiesHub` |
+| [Base](../../../sauce-chains/references/base.md) | mag7Spoke | `0x17905Db0e4A3514467539956c084180616AE7B8D` | `AaveV4.Mag7Spoke` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | avaxCorrelatedSpoke | `0x3b517594277c67307CF2d7CBE6FE1D4399B68c41` | `AaveV4.AvaxCorrelatedSpoke` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | coreHub | `0xd07369fAE4A5BB13c9Ce446B052c7867B1AbDf6e` | `AaveV4.CoreHub` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | forexSpoke | `0x6a37776B5E026dBdF043b4F933c323C84DD1B514` | `AaveV4.ForexSpoke` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | mainSpoke | `0x435272CefF93a1E657E8ABfdf0A13e95900A3a56` | `AaveV4.MainSpoke` |
+
+## ABI
+
+### `AaveV4HubABI`
+
+`import AaveV4HubABI from "./protocols/aave-v4/AaveV4HubABI.json";` Speaks for: coreHub, plusHub, primeHub, globalDollarHub, equitiesHub.
+
+- `getAssetId(address underlying) view returns (uint256)`
+- `getAssetCount() view returns (uint256)`
+- `getAssetLiquidity(uint256 assetId) view returns (uint256)`
+- `isUnderlyingListed(address underlying) view returns (bool)`
+
+### `AaveV4SpokeABI`
+
+`import AaveV4SpokeABI from "./protocols/aave-v4/AaveV4SpokeABI.json";` Speaks for: mainSpoke, forexSpoke, bluechipSpoke, ethenaCorrelatedSpoke, ethenaEcosystemSpoke, goldSpoke, paxgGoldSpoke, lombardBtcSpoke, usdgPendleSpoke, etherfiESpoke, kelpESpoke, lidoESpoke, usdgMapleESpoke, mag7Spoke, avaxCorrelatedSpoke.
+
+- `supply(uint256 reserveId, uint256 amount, address onBehalfOf) returns (uint256, uint256)`
+- `withdraw(uint256 reserveId, uint256 amount, address onBehalfOf) returns (uint256, uint256)`
+- `borrow(uint256 reserveId, uint256 amount, address onBehalfOf) returns (uint256, uint256)`
+- `repay(uint256 reserveId, uint256 amount, address onBehalfOf) returns (uint256, uint256)`
+- `setUsingAsCollateral(uint256 reserveId, bool usingAsCollateral, address onBehalfOf)`
+- `getReserveId(address hub, uint256 assetId) view returns (uint256)`
+- `getReserveCount() view returns (uint256)`
+- `getUserSuppliedAssets(uint256 reserveId, address user) view returns (uint256)`
+- `getUserTotalDebt(uint256 reserveId, address user) view returns (uint256)`

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

@@ -0,0 +1,54 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Abracadabra (`abracadabra`)
+
+Lending protocol that lets users borrow MIM stablecoin against yield-bearing collateral via isolated Cauldron markets built on DegenBox.
+
+| Fact | Value |
+| --- | --- |
+| Category | CDPs and stablecoins |
+| Family | none |
+| Namespace | `Abracadabra` on ethereum, arbitrum |
+| Chains | ethereum, arbitrum |
+| Document | [abracadabra.md](../abracadabra.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Abracadabra` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's degenBox, `0xd96f48665a1410C0cd669A88898ecA36B9Fc2cce`.
+  require(Abracadabra.DegenBox != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | degenBox | `0xd96f48665a1410C0cd669A88898ecA36B9Fc2cce` | `Abracadabra.DegenBox` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | mim | `0x99D8a9C45b2ecA8864373A26D1459e3Dff1e17F3` | `Abracadabra.Mim` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | degenBox | `0x7C8FeF8eA9b1fE46A7689bfb8149341C90431D38` | `Abracadabra.DegenBox` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | mim | `0xFEa7a6a0B346362BF88A9e4A88416B77a57D6c2A` | `Abracadabra.Mim` |
+
+## ABI
+
+### `CauldronABI`
+
+`import CauldronABI from "./protocols/abracadabra/CauldronABI.json";`
+
+- `addCollateral(address to, bool skim, uint256 share)`
+- `removeCollateral(address to, uint256 share)`
+- `borrow(address to, uint256 amount) returns (uint256 part, uint256 share)`
+- `repay(address to, bool skim, uint256 part) returns (uint256 amount)`
+- `userCollateralShare(address user) view returns (uint256)`
+- `userBorrowPart(address user) view returns (uint256)`
+
+### `DegenBoxABI`
+
+`import DegenBoxABI from "./protocols/abracadabra/DegenBoxABI.json";` Speaks for: degenBox.
+
+- `deposit(address token, address from, address to, uint256 amount, uint256 share) payable returns (uint256 amountOut, uint256 shareOut)`
+- `withdraw(address token, address from, address to, uint256 amount, uint256 share) returns (uint256 amountOut, uint256 shareOut)`
+- `balanceOf(address token, address user) view returns (uint256)`

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

@@ -0,0 +1,57 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Across (`across`)
+
+Optimistic cross-chain bridge powered by UMA's optimistic oracle. Uses relayers for fast fills and canonical bridges for settlement.
+
+| Fact | Value |
+| --- | --- |
+| Category | Bridges |
+| Family | none |
+| Namespace | `Across` on ethereum, optimism, polygon, zksync, arc, base, mode, arbitrum, linea, blast, scroll |
+| Chains | ethereum, optimism, polygon, zksync, arc, base, mode, arbitrum, linea, blast, scroll |
+| Document | [across.md](../across.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Across` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's hubPool, `0xc186fA914353c44b2E33eBE05f21846F1048bEda`.
+  require(Across.HubPool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | hubPool | `0xc186fA914353c44b2E33eBE05f21846F1048bEda` | `Across.HubPool` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | spokePool | `0x5c7BCd6E7De5423a257D81B442095A1a6ced35C5` | `Across.SpokePool` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | spokePool | `0x6f26Bf09B1C792e3228e5467807a900A503c0281` | `Across.SpokePool` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | spokePool | `0x9295ee1d8C5b022Be115A2AD3c30C72E34e7F096` | `Across.SpokePool` |
+| [zkSync Era](../../../sauce-chains/references/zksync.md) | spokePool | `0xE0B015E54d54fc84a6cB9B666099c46adE9335FF` | `Across.SpokePool` |
+| [Arc](../../../sauce-chains/references/arc.md) | spokePool | `0x9b4A302A548c7e313c2b74C461db7b84d3074A84` | `Across.SpokePool` |
+| [Base](../../../sauce-chains/references/base.md) | spokePool | `0x09aea4b2242abC8bb4BB78D537A67a245A7bEC64` | `Across.SpokePool` |
+| [Mode](../../../sauce-chains/references/mode.md) | spokePool | `0x3baD7AD0728f9917d1Bf08af5782dCbD516cDd96` | `Across.SpokePool` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | spokePool | `0xe35e9842fceaCA96570B734083f4a58e8F7C5f2A` | `Across.SpokePool` |
+| [Linea](../../../sauce-chains/references/linea.md) | spokePool | `0x7E63A5f1a8F0B4d0934B2f2327DAED3F6bb2ee75` | `Across.SpokePool` |
+| [Blast](../../../sauce-chains/references/blast.md) | spokePool | `0x2D509190Ed0172ba588407D4c2df918F955Cc6E1` | `Across.SpokePool` |
+| [Scroll](../../../sauce-chains/references/scroll.md) | spokePool | `0x3baD7AD0728f9917d1Bf08af5782dCbD516cDd96` | `Across.SpokePool` |
+
+## ABI
+
+### `AcrossHubPoolABI`
+
+`import AcrossHubPoolABI from "./protocols/across/AcrossHubPoolABI.json";` Speaks for: hubPool.
+
+- `liquidityUtilizationCurrent(address l1Token) returns (uint256)`
+- `pooledTokens(address l1Token) view returns (address lpToken, bool isEnabled, uint32 lastLpFeeUpdate, int256 utilizedReserves, uint256 liquidReserves, uint256 undistributedLpFees)`
+
+### `AcrossSpokePoolABI`
+
+`import AcrossSpokePoolABI from "./protocols/across/AcrossSpokePoolABI.json";` Speaks for: spokePool.
+
+- `depositV3(address depositor, address recipient, address inputToken, address outputToken, uint256 inputAmount, uint256 outputAmount, uint256 destinationChainId, address exclusiveRelayer, uint32 quoteTimestamp, uint32 fillDeadline, uint32 exclusivityParameter, bytes message) payable`
+- `deposit(bytes32 depositor, bytes32 recipient, bytes32 inputToken, bytes32 outputToken, uint256 inputAmount, uint256 outputAmount, uint256 destinationChainId, bytes32 exclusiveRelayer, uint32 quoteTimestamp, uint32 fillDeadline, uint32 exclusivityParameter, bytes message) payable`

package/skills/sauce-protocols/references/registry/aerodrome-slipstream.md

@@ -0,0 +1,72 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Aerodrome Slipstream (`aerodrome-slipstream`)
+
+Aerodrome's concentrated-liquidity (Uniswap V3-style) pools, keyed by tick spacing rather than fee: three generations on Base, and Aero Lite on Arc.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `AerodromeSlipstream` on arc, base |
+| Chains | arc, base |
+| Document | [aerodrome-slipstream.md](../aerodrome-slipstream.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arc, `AerodromeSlipstream` is a namespace: its contracts need no import.
+
+```sauce chain=arc
+function main() {
+  // Arc's clFactory, `0xb89Df768aF2CFE637ceB352c587Fe8edAf491d03`.
+  require(AerodromeSlipstream.CLFactory != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arc](../../../sauce-chains/references/arc.md) | clFactory | `0xb89Df768aF2CFE637ceB352c587Fe8edAf491d03` | `AerodromeSlipstream.CLFactory` |
+| [Arc](../../../sauce-chains/references/arc.md) | metarouter | `0x7275FA44c67BbA8d921422e600B4ed396209c886` | `AerodromeSlipstream.Metarouter` |
+| [Arc](../../../sauce-chains/references/arc.md) | nonfungiblePositionManager | `0xc84bB45D43CD25D02b83B4C085eaA4e08da8f473` | `AerodromeSlipstream.NonfungiblePositionManager` |
+| [Base](../../../sauce-chains/references/base.md) | clFactory | `0x5e7BB104d84c7CB9B682AaC2F3d509f5F406809A` | `AerodromeSlipstream.CLFactory` |
+| [Base](../../../sauce-chains/references/base.md) | clFactoryGaugeCaps | `0xaDe65c38CD4849aDBA595a4323a8C7DdfE89716a` | `AerodromeSlipstream.CLFactoryGaugeCaps` |
+| [Base](../../../sauce-chains/references/base.md) | clFactoryGaugesV3 | `0xf8f2eB4940CFE7d13603DDDD87f123820Fc061Ef` | `AerodromeSlipstream.CLFactoryGaugesV3` |
+| [Base](../../../sauce-chains/references/base.md) | nonfungiblePositionManager | `0x827922686190790b37229fd06084350E74485b72` | `AerodromeSlipstream.NonfungiblePositionManager` |
+| [Base](../../../sauce-chains/references/base.md) | nonfungiblePositionManagerGaugeCaps | `0xa990C6a764b73BF43cee5Bb40339c3322FB9D55F` | `AerodromeSlipstream.NonfungiblePositionManagerGaugeCaps` |
+| [Base](../../../sauce-chains/references/base.md) | nonfungiblePositionManagerGaugesV3 | `0xe1f8cd9AC4e4A65F54f38a5CdAfCA44f6dD68b53` | `AerodromeSlipstream.NonfungiblePositionManagerGaugesV3` |
+
+## ABI
+
+### `AeroMetarouterABI`
+
+`import AeroMetarouterABI from "./protocols/aerodrome-slipstream/AeroMetarouterABI.json";` Speaks for: metarouter.
+
+- `execute(bytes _commands, bytes[] _inputs, uint256 _deadline) payable`
+
+### `AerodromeSlipstreamPoolABI`
+
+`import AerodromeSlipstreamPoolABI from "./protocols/aerodrome-slipstream/AerodromeSlipstreamPoolABI.json";`
+
+- `slot0() view returns (uint160 sqrtPriceX96, int24 tick, uint16 observationIndex, uint16 observationCardinality, uint16 observationCardinalityNext, bool unlocked)`
+- `liquidity() view returns (uint128)`
+- `fee() view returns (uint24)`
+- `tickSpacing() view returns (int24)`
+- `token0() view returns (address)`
+- `token1() view returns (address)`
+
+### `SlipstreamCLFactoryABI`
+
+`import SlipstreamCLFactoryABI from "./protocols/aerodrome-slipstream/SlipstreamCLFactoryABI.json";` Speaks for: clFactory, clFactoryGaugeCaps, clFactoryGaugesV3.
+
+- `getPool(address tokenA, address tokenB, int24 tickSpacing) view returns (address)`
+- `allPoolsLength() view returns (uint256)`
+- `tickSpacingToFee(int24) view returns (uint24)`
+
+### `SlipstreamPositionManagerABI`
+
+`import SlipstreamPositionManagerABI from "./protocols/aerodrome-slipstream/SlipstreamPositionManagerABI.json";` Speaks for: nonfungiblePositionManager, nonfungiblePositionManagerGaugeCaps, nonfungiblePositionManagerGaugesV3.
+
+- `factory() view returns (address)`
+- `positions(uint256 tokenId) view returns (uint96 nonce, address operator, address token0, address token1, int24 tickSpacing, int24 tickLower, int24 tickUpper, uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128, uint128 tokensOwed0, uint128 tokensOwed1)`