@eco-incorp/sauce 0.99.6 → 0.99.8

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

@@ -4,9 +4,14 @@ Cross-chain bridge aggregator that finds optimal routes across multiple bridges
 
 ## Category
 
-bridge aggregator | Direction: any-to-any | Chains: Ethereum (1), Arbitrum (42161), Optimism (10), Base (8453), Polygon (137), BSC (56), Avalanche (43114)
+bridge aggregator | Direction: any-to-any | Chains and addresses: [registry/socket.md](registry/socket.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`).
 
 ### bridge
 
@@ -27,23 +32,11 @@ function main(gatewayAddress: Address, routeId: Uint256, bridgeData: bytes): Uin
 - Socket requires off-chain route computation via their API before on-chain execution
 - Requires ERC-20 approval to the Socket Gateway
 
-## Deployed Addresses
-
-| Chain     | Contract      | Address                                      |
-| --------- | ------------- | -------------------------------------------- |
-| Ethereum  | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| Arbitrum  | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| Optimism  | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| Base      | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| Polygon   | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| BSC       | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-| Avalanche | socketGateway | `0x3a23F943181408EAC424116Af7b7790c94Cb97a5` |
-
-## ABI Reference
-
-### SocketGatewayABI
+## Deployments and ABI
 
-- `executeRoute(uint32 routeId, bytes routeData) returns (bytes result)` [payable] - Execute a route (bridge, swap, or combined). Returns result data
+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/socket.md](registry/socket.md).
 
 ## Notes
 

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

@@ -0,0 +1,40 @@
+# Sommelier
+
+ERC-4626 strategy vaults (Cellars) managed by off-chain strategists via Cosmos validators. Automated DeFi portfolio management.
+
+## Category
+
+yield | Chains and addresses: [registry/sommelier.md](registry/sommelier.md)
+
+## Key Operations
+
+- **deposit**: Deposit assets into Cellar vault
+- **withdraw**: Withdraw assets from Cellar
+- **redeem**: Redeem Cellar shares
+
+## 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
+// Deposit into Sommelier Cellar
+import { CellarABI as ICellar } from "./abis";
+
+function main(cellarAddress: Address, assets: Uint256, receiver: Address): Uint256 {
+  const cellar = ICellar.at(cellarAddress);
+  return cellar.deposit(assets, receiver);
+}
+```
+
+## 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/sommelier.md](registry/sommelier.md).
+
+## Notes
+
+- Cellars are ERC-4626 vaults. Strategies managed off-chain via Cosmos governance.

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

@@ -4,9 +4,14 @@ Aave V3 fork operated by MakerDAO/Sky ecosystem. Offers competitive rates on DAI
 
 ## Category
 
-lending | Chains: Ethereum (1)
+lending | Chains and addresses: [registry/spark.md](registry/spark.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`).
 
 ### supply
 
@@ -87,21 +92,11 @@ function main(
 - `amount`: Use `type(uint256).max` to repay full debt
 - Requires ERC-20 approval to the Pool
 
-## Deployed Addresses
-
-| Chain    | Contract              | Address                                      |
-| -------- | --------------------- | -------------------------------------------- |
-| Ethereum | pool                  | `0xC13e21B648A5Ee794902342038FF3aDAB66BE987` |
-| Ethereum | poolAddressesProvider | `0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE` |
-
-## ABI Reference
-
-### SparkPoolABI
+## Deployments and ABI
 
-- `supply(address asset, uint256 amount, address onBehalfOf, uint16 referralCode)` - Supply asset to earn interest
-- `withdraw(address asset, uint256 amount, address to) returns (uint256)` - Withdraw supplied asset
-- `borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)` - Borrow against collateral
-- `repay(address asset, uint256 amount, uint256 interestRateMode, address onBehalfOf) returns (uint256)` - Repay 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/spark.md](registry/spark.md).
 
 ## Notes
 

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

@@ -1,10 +1,12 @@
 # SpookySwap
 
+> **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 largest DEX on Fantom with UniV2-style constant product pools (x*y=k). Features yield farming, cross-chain bridges, and limit orders. The default trading venue on the Fantom network.
 
 ## Category
 
-dex | Chains: Fantom
+dex | Chains and addresses: [registry/spookyswap.md](registry/spookyswap.md)
 
 ## Key Operations
 
@@ -12,13 +14,12 @@ dex | Chains: Fantom
 - **addLiquidity**: Deposit two tokens to mint LP tokens
 - **removeLiquidity**: Burn LP tokens to withdraw underlying tokens
 
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/spookyswap";
-```
+## 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
 
@@ -103,19 +104,11 @@ function main(
 
 - LP token must be approved to the router
 
-## Key Addresses
-
-| Chain  | Contract  | Address                                      |
-| ------ | --------- | -------------------------------------------- |
-| Fantom | V2 Router | `0xF491e7B69E4244ad4002BC14e878a34207E38c29` |
-
-## ABI Methods
-
-### SpookySwapRouterABI
+## Deployments and ABI
 
-- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, uint256 deadline) -> uint256[] amounts` - 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 liquidity and mint LP tokens
-- `removeLiquidity(address tokenA, address tokenB, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB)` - Burn LP tokens for underlying
+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/spookyswap.md](registry/spookyswap.md).
 
 ## Notes
 

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

@@ -4,9 +4,14 @@ Cross-chain liquidity router built on Axelar. Enables one-click cross-chain swap
 
 ## Category
 
-bridge aggregator | Direction: any-to-any | Chains: Ethereum (1), Arbitrum (42161), Optimism (10), Base (8453), Polygon (137), BSC (56), Avalanche (43114)
+bridge aggregator | Direction: any-to-any | Chains and addresses: [registry/squid.md](registry/squid.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`).
 
 ### bridge
 
@@ -45,26 +50,11 @@ function main(
 - `gasRefundRecipient`: receives unused Axelar gas; `enableExpress` (last) opts into express delivery
 - Requires ERC-20 approval to the Squid Router
 
-## Deployed Addresses
-
-| Chain     | Contract    | Address                                      |
-| --------- | ----------- | -------------------------------------------- |
-| Ethereum  | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| Arbitrum  | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| Optimism  | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| Base      | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| Polygon   | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| BSC       | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-| Avalanche | squidRouter | `0xce16F69375520ab01377ce7B88f5BA8C48F8D666` |
-
-## ABI Reference
-
-### SquidRouterABI
-
-- `bridgeCall(string bridgedTokenSymbol, uint256 amount, string destinationChain, string destinationAddress, bytes payload, address gasRefundRecipient, bool enableExpress)` [payable] - Bridge a gateway token by symbol, optionally executing `payload` on the destination
-- `callBridgeCall(address token, uint256 amount, ISquidMulticall.Call[] calls, string bridgedTokenSymbol, string destinationChain, string destinationAddress, bytes payload, address gasRefundRecipient, bool enableExpress)` [payable] - Run `calls` on the source chain (e.g. swap `token` into the bridged token), then bridge
+## Deployments and ABI
 
-ISquidMulticall.Call tuple: `(uint8 callType, address target, uint256 value, bytes callData, bytes payload)`
+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/squid.md](registry/squid.md).
 
 ## Notes
 

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

@@ -0,0 +1,39 @@
+# Stader
+
+Multi-chain liquid staking protocol. ETHx is Stader's non-rebasing liquid staking token for Ethereum.
+
+## Category
+
+liquid-staking | Chains and addresses: [registry/stader.md](registry/stader.md)
+
+## Key Operations
+
+- **deposit**: Stake ETH to receive ETHx
+
+## 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
+// Stake ETH for ETHx
+import { StakePoolManagerABI as IStakePoolManager } from "./abis";
+function main(stakePoolManagerAddress: Address, receiver: Address): Uint256 {
+  const pool = IStakePoolManager.at(stakePoolManagerAddress);
+  return pool.deposit(receiver);
+}
+```
+
+## 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/stader.md](registry/stader.md).
+
+## Notes
+
+- TVL: $300M+. ETHx is non-rebasing (value accrues over time)
+- deposit() is payable - send ETH as msg.value, pass receiver address
+- Compatible with EigenLayer restaking (can deposit into stETH/ETHx strategies)

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

@@ -4,9 +4,14 @@ Omnichain liquidity transport protocol built on LayerZero. Provides native asset
 
 ## Category
 
-bridge | Direction: L2-to-L2, L1-to-L2, L2-to-L1 (any-to-any) | Chains: Ethereum (1), Arbitrum (42161), Base (8453)
+bridge | Direction: L2-to-L2, L1-to-L2, L2-to-L1 (any-to-any) | Chains and addresses: [registry/stargate.md](registry/stargate.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`).
 
 ### bridge
 
@@ -50,27 +55,11 @@ function main(
 - Requires native token (ETH) for LayerZero messaging fee (sent as msg.value)
 - Requires ERC-20 approval to the pool for non-native tokens
 
-## Deployed Addresses
-
-| Chain    | Contract   | Address                                      |
-| -------- | ---------- | -------------------------------------------- |
-| Ethereum | poolNative | `0x77b2043768d28E9C9aB44E1aBfC95944bcE57931` |
-| Ethereum | poolUSDC   | `0xc026395860Db2d07ee33e05fE50ed7bD583189C7` |
-| Ethereum | poolUSDT   | `0x933597a323Eb81cAe705C5bC29985172fd5A3973` |
-| Arbitrum | poolNative | `0xA45B5130f36CDcA45667738e2a258AB09f4A5f7F` |
-| Arbitrum | poolUSDC   | `0xe8CDF27AcD73a434D661C84887215F7598e7d0d3` |
-| Base     | poolNative | `0xdc181Bd607330aeeBEF6ea62e03e5e1Fb4B6F7C7` |
-| Base     | poolUSDC   | `0x27a16dc786820B16E5c9028b75B99F6f604b5d26` |
-
-## ABI Reference
-
-### StargatePoolABI
-
-- `send(SendParam _sendParam, MessagingFee _fee, address _refundAddress) returns (MessagingReceipt msgReceipt, OFTReceipt oftReceipt)` [payable] - Bridge tokens to destination chain
-- `quoteOFT(SendParam _sendParam) returns (OFTLimit oftLimit, OFTFeeDetail[] oftFeeDetails, OFTReceipt oftReceipt)` - Quote bridge limits, fees and the amount received (view)
+## Deployments and ABI
 
-SendParam tuple: `(uint32 dstEid, bytes32 to, uint256 amountLD, uint256 minAmountLD, bytes extraOptions, bytes composeMsg, bytes oftCmd)`
-MessagingFee tuple: `(uint256 nativeFee, uint256 lzTokenFee)`
+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/stargate.md](registry/stargate.md).
 
 ## Notes
 

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

@@ -4,7 +4,7 @@ Protocol for real-time finance enabling continuous token streams (per-second pay
 
 ## Category
 
-payments | Chains: Ethereum, Polygon, Arbitrum, Optimism, Base
+payments | Chains and addresses: [registry/superfluid.md](registry/superfluid.md)
 
 ## Key Operations
 
@@ -12,13 +12,12 @@ payments | Chains: Ethereum, Polygon, Arbitrum, Optimism, Base
 - **updateFlow**: Update the flow rate of an existing stream
 - **deleteFlow**: Stop/delete a payment stream
 
-## SDK Usage
+## Typed templates for the raw compiler (not for `sauce compile`)
 
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/superfluid";
-```
-
-## 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`).
 
 ```typescript
 // Create payment stream
@@ -63,28 +62,11 @@ function main(
 }
 ```
 
-## Key Addresses
-
-| Chain    | Contract     | Address                                      |
-| -------- | ------------ | -------------------------------------------- |
-| Ethereum | host         | `0x3E14dC1b13c488a8d5D310918780c983bD5982E7` |
-| Ethereum | cfaForwarder | `0xcfA132E353cB4E398080B9700609bb008eceB125` |
-| Polygon  | host         | `0x3E14dC1b13c488a8d5D310918780c983bD5982E7` |
-| Polygon  | cfaForwarder | `0xcfA132E353cB4E398080B9700609bb008eceB125` |
-| Arbitrum | host         | `0x3E14dC1b13c488a8d5D310918780c983bD5982E7` |
-| Arbitrum | cfaForwarder | `0xcfA132E353cB4E398080B9700609bb008eceB125` |
-| Optimism | host         | `0x3E14dC1b13c488a8d5D310918780c983bD5982E7` |
-| Optimism | cfaForwarder | `0xcfA132E353cB4E398080B9700609bb008eceB125` |
-| Base     | host         | `0x3E14dC1b13c488a8d5D310918780c983bD5982E7` |
-| Base     | cfaForwarder | `0xcfA132E353cB4E398080B9700609bb008eceB125` |
-
-## ABI Methods
-
-### CFAForwarderABI
+## Deployments and ABI
 
-- `createFlow(address,address,address,int96,bytes)` - Create stream. Params: token (Super Token), sender, receiver, flowrate (tokens per second as int96), userData (arbitrary bytes, 0x00 for none). Returns bool
-- `updateFlow(address,address,address,int96,bytes)` - Update flow rate. Params: token, sender, receiver, flowrate (new rate), userData. Returns bool
-- `deleteFlow(address,address,address,bytes)` - Delete stream. Params: token, sender, receiver, userData. Returns bool
+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/superfluid.md](registry/superfluid.md).
 
 ## Notes
 

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

@@ -1,10 +1,37 @@
 # SushiSwap V2
 
+> **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.
+
 Community-driven fork of Uniswap V2 with additional yield farming features and multi-chain deployment. Identical AMM interface to Uniswap V2 (x*y=k constant product) with broader L2 and alt-chain coverage.
 
+## When to use it
+
+- A Uniswap V2 fork: constant-product pairs, 0.3% fee, the same Router interface. Use it where
+  its pair is deeper than Uniswap V2's on the chain.
+
+## Pitfalls for a program
+
+- As Uniswap V2: `amountOutMin` is the only bound, approve exactly `amountIn`, pass a deadline.
+
+## In a Sauce program
+
+Sell the Pot's USDC for WETH through the Router:
+
+```sauce chain=arbitrum
+function main(amountIn: Uint256, minOut: Uint256, recipient: Address) {
+  const self = ctx.self();
+  const before = WETH.balanceOf(self);
+  USDC.approve(SushiswapV2.Router, amountIn);
+  SushiswapV2.Router.swapExactTokensForTokens(amountIn, minOut, [USDC, WETH], self, ctx.timestamp());
+  const out = WETH.balanceOf(self) - before;
+  require(out >= minOut, "below minOut");
+  WETH.transfer(recipient, out);
+}
+```
+
 ## Category
 
-dex | Chains: Ethereum, Arbitrum, Polygon, BSC, Avalanche, Fantom, Optimism
+dex | Chains and addresses: [registry/sushiswap-v2.md](registry/sushiswap-v2.md)
 
 ## Key Operations
 
@@ -12,17 +39,12 @@ dex | Chains: Ethereum, Arbitrum, Polygon, BSC, Avalanche, Fantom, Optimism
 - **addLiquidity**: Deposit two tokens to mint SLP (SushiSwap LP) tokens
 - **removeLiquidity**: Burn SLP tokens to withdraw underlying tokens
 
-## SDK Usage
+## Typed templates for the raw compiler (not for `sauce compile`)
 
-```typescript
-import {
-  protocolInfo,
-  deployments,
-  sauceFunctions,
-} from "@eco-incorp/sauce/protocols/sushiswap-v2";
-```
-
-## 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
 
@@ -111,39 +133,11 @@ function main(
 - `liquidity`: Amount of SLP tokens to burn
 - SLP token must be approved to the router
 
-## Key Addresses
-
-| Chain     | Contract | Address                                      |
-| --------- | -------- | -------------------------------------------- |
-| Ethereum  | Factory  | `0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac` |
-| Ethereum  | Router   | `0xd9e1cE17f2641f24aE83637ab66a2cca9C378B9F` |
-| Arbitrum  | Factory  | `0xc35DADB65012eC5796536bD9864eD8773aBc74C4` |
-| Arbitrum  | Router   | `0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506` |
-| Polygon   | Factory  | `0xc35DADB65012eC5796536bD9864eD8773aBc74C4` |
-| Polygon   | Router   | `0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506` |
-| BSC       | Factory  | `0xc35DADB65012eC5796536bD9864eD8773aBc74C4` |
-| BSC       | Router   | `0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506` |
-| Avalanche | Factory  | `0xc35DADB65012eC5796536bD9864eD8773aBc74C4` |
-| Avalanche | Router   | `0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506` |
-| Fantom    | Factory  | `0xc35DADB65012eC5796536bD9864eD8773aBc74C4` |
-| Fantom    | Router   | `0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506` |
-| Optimism  | Factory  | `0xFbc12984689e5f15626Bad03Ad60160Fe98B303C` |
-| Optimism  | Router   | `0x2ABf469074dc0b54d793850807E6eb5Faf2625b1` |
-
-## ABI Methods
-
-### SushiSwapV2RouterABI
-
-- `swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, uint256 deadline) -> uint256[] amounts` - Swap exact input along path, returns amounts at each hop
-- `swapTokensForExactTokens(uint256 amountOut, uint256 amountInMax, address[] path, address to, uint256 deadline) -> uint256[] amounts` - Swap to get exact output amount
-- `addLiquidity(address tokenA, address tokenB, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB, uint256 liquidity)` - Add liquidity and mint SLP tokens
-- `removeLiquidity(address tokenA, address tokenB, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) -> (uint256 amountA, uint256 amountB)` - Burn SLP tokens for underlying tokens
-- `getAmountsOut(uint256 amountIn, address[] path) -> uint256[] amounts` - Quote output amounts along path (view)
-
-### SushiSwapV2FactoryABI
+## Deployments and ABI
 
-- `getPair(address tokenA, address tokenB) -> address pair` - Look up pair address (view)
-- `createPair(address tokenA, address tokenB) -> address pair` - Create a new pair
+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/sushiswap-v2.md](registry/sushiswap-v2.md).
 
 ## Notes
 
@@ -152,3 +146,4 @@ function main(
 - SLP tokens can be staked in SushiSwap's MasterChef/MiniChef contracts for SUSHI rewards (not in SDK)
 - Both tokens must be ERC20-approved to the Router before swap/addLiquidity
 - Use SushiSwap when Uniswap V2 is not deployed on the target chain, or when SUSHI farming incentives are active
+- From a Pot program, `@sauce/router` trades a SushiSwap V2 pair directly, with no router and no approval: `uniswapV2(pair, tokenIn, tokenOut, amountIn, 3000n, minOut, recipient)` reads the pair's `getReserves`, prices the output in the program with the pair's fee in parts per million, transfers the input to the pair and calls `pair.swap` with empty `data`, returning the amount out. The direction is the sort order of `tokenIn` and `tokenOut` (`token0` is the lower address), so there is no argument to get wrong. The swap consumes its whole input or reverts; there is no refund path. `tryUniswapV2` takes the same arguments and returns `0n`, moving nothing, when the pair cannot fill the whole input at the floor. The `uniswapV2Swap` action is the same call

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

@@ -0,0 +1,49 @@
+# Swell
+
+Liquid staking and restaking protocol for Ethereum. Offers swETH for liquid staking and rswETH for liquid restaking via EigenLayer.
+
+## Category
+
+liquid-staking | Chains and addresses: [registry/swell.md](registry/swell.md)
+
+## Key Operations
+
+- **stakeSwETH**: Deposit ETH for swETH (liquid staking)
+- **stakeRswETH**: Deposit ETH for rswETH (liquid restaking)
+
+## 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
+// Stake ETH for swETH
+import { SwETHABI as ISwETH } from "./abis";
+function main(swethAddress: Address): Uint256 {
+  const sweth = ISwETH.at(swethAddress);
+  sweth.deposit();
+  return 1;
+}
+
+// Stake ETH for rswETH (restaking)
+import { RswETHABI as IRswETH } from "./abis";
+function main(rswethAddress: Address): Uint256 {
+  const rsweth = IRswETH.at(rswethAddress);
+  rsweth.deposit();
+  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/swell.md](registry/swell.md).
+
+## Notes
+
+- TVL: $800M+. Both tokens are non-rebasing (value accrues)
+- swETH = standard liquid staking. rswETH = liquid restaking via EigenLayer
+- Both deposit() functions are payable - send ETH as msg.value

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

@@ -0,0 +1,54 @@
+# Synapse Protocol
+
+Cross-chain bridge and DEX with multi-chain AMM pools. Supports token swaps and bridging via SynapseBridge and CCTP router.
+
+## Category
+
+bridge | Direction: any-to-any (L1-to-L2, L2-to-L2, L2-to-L1) | Chains and addresses: [registry/synapse.md](registry/synapse.md)
+
+## 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`).
+
+### bridge
+
+Deposit tokens for cross-chain transfer via SynapseBridge.
+
+```typescript
+import { SynapseBridgeABI as ISynapseBridge } from "./abis";
+
+function main(
+  bridgeAddress: Address,
+  recipient: Address,
+  chainId: Uint256,
+  token: Address,
+  amount: Uint256,
+): Uint256 {
+  const bridge = ISynapseBridge.at(bridgeAddress);
+  bridge.deposit(recipient, chainId, token, amount);
+  return 1;
+}
+```
+
+- `chainId`: Destination EVM chain ID
+- `token`: ERC-20 token to bridge
+- Requires ERC-20 approval to the SynapseBridge
+
+## 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/synapse.md](registry/synapse.md).
+
+## Notes
+
+- `deposit`: For canonical tokens supported directly by the bridge
+- `depositAndSwap`: For bridging with an automatic swap on destination (e.g. bridge nUSD, swap to USDC on arrival)
+- `redeem`: For synthetic bridge tokens (nUSD, nETH) -- burns on source, mints on destination
+- Also supports CCTP-based USDC bridging via separate cctpRouter contract
+- Finality: typically 5-15 minutes depending on route
+- Requires ERC-20 approval to the SynapseBridge
+- TVL: $100M+. Audited

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

@@ -1,22 +1,23 @@
 # SyncSwap
 
+> **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 zkSync Era with optimized gas efficiency for the ZK rollup environment. Supports classic constant product pools and stable pools with native account abstraction support.
 
 ## Category
 
-dex | Chains: zkSync
+dex | Chains and addresses: [registry/syncswap.md](registry/syncswap.md)
 
 ## Key Operations
 
 - **swap**: Swap tokens via path-based routing with encoded swap data and step-based execution
 
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/syncswap";
-```
+## 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
 
@@ -57,17 +58,11 @@ function main(
 - `callbackData`: Set to `0x00` for standard swaps
 - Supports multi-step paths: add more entries to the `steps` array for multi-hop
 
-## Key Addresses
-
-| Chain  | Contract | Address                                      |
-| ------ | -------- | -------------------------------------------- |
-| zkSync | Router   | `0x2da10A1e27bF85cEdD8FFb1AbBe97e53391C0295` |
-
-## ABI Methods
-
-### SyncSwapRouterABI
+## Deployments and ABI
 
-- `swap(tuple[](tuple[](address pool, bytes data, address callback, bytes callbackData) steps, address tokenIn, uint256 amountIn) paths, uint256 amountOutMin, uint256 deadline) -> tuple(address token, uint256 amount) amountOut` - Execute a swap through one or more paths, each containing one or more pool steps
+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/syncswap.md](registry/syncswap.md).
 
 ## Notes