@eco-incorp/sauce 0.99.6 → 0.99.7

package/sdk/src/skills/safe.md

@@ -1,56 +0,0 @@
-# Safe
-
-The most trusted multi-signature smart contract wallet, securing billions in digital assets. Supports programmable account abstraction and modular security.
-
-## Category
-
-infrastructure | Chains: Ethereum, Arbitrum, Optimism, Base, Polygon, Arc
-
-## Key Operations
-
-- **getThreshold**: Query the signing threshold of a Safe multisig
-- **execTransaction**: Execute a transaction with collected signatures
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/safe";
-```
-
-## SauceScript Examples
-
-```typescript
-// Get Safe threshold
-import { SafeABI as ISafe } from "./abis";
-function main(safeAddress: Address): Uint256 {
-  const safe = ISafe.at(safeAddress);
-  return safe.getThreshold();
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract   | Address                                      |
-| -------- | ---------- | -------------------------------------------- |
-| Ethereum | safeV141   | `0x41675C099F32341bf84BFc5382aF534df5C7461a` |
-| Ethereum | safeL2V130 | `0x3E5c63644E683549055b9Be8653de26E0B4CD36E` |
-| Arbitrum | safeL2V130 | `0x3E5c63644E683549055b9Be8653de26E0B4CD36E` |
-| Optimism | safeL2V130 | `0x3E5c63644E683549055b9Be8653de26E0B4CD36E` |
-| Base     | safeL2V130 | `0x3E5c63644E683549055b9Be8653de26E0B4CD36E` |
-| Polygon  | safeL2V130 | `0x3E5c63644E683549055b9Be8653de26E0B4CD36E` |
-
-## ABI Methods
-
-### SafeABI
-
-- `execTransaction(address,uint256,bytes,uint8,uint256,uint256,uint256,address,address,bytes)` - Execute signed transaction. Payable. Params: to (target), value (ETH), data (calldata), operation (0=call, 1=delegatecall), safeTxGas, baseGas, gasPrice, gasToken (address(0) for ETH), refundReceiver, signatures (packed owner signatures). Returns success bool
-- `getOwners()` - List all Safe owners. Returns address[] of current owners
-- `getThreshold()` - Get signing threshold. Returns uint256 (M in M-of-N)
-
-## Notes
-
-- Secures $100B+ in assets across DeFi
-- safeV141 is for Ethereum L1; safeL2V130 is the L2-optimized version (emits events for cheaper indexing)
-- operation: 0 = CALL (normal), 1 = DELEGATECALL (execute in Safe context)
-- signatures are sorted by owner address, packed as 65 bytes each (r, s, v)
-- Modular: supports Guards (pre/post checks), Modules (extend functionality), and Fallback handlers

package/sdk/src/skills/seaport.md

@@ -1,65 +0,0 @@
-# Seaport
-
-OpenSea's decentralized NFT marketplace protocol supporting flexible order types including English and Dutch auctions, collection offers, and trait-based offers.
-
-## Category
-
-nft-marketplace | Chains: Ethereum, Arbitrum, Optimism, Polygon, Base, Arc
-
-## Key Operations
-
-- **fulfillBasicOrder**: Fulfill a basic NFT buy/sell order
-- **cancel**: Cancel pending orders
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/seaport";
-```
-
-## SauceScript Examples
-
-```typescript
-// Note: Seaport orders require off-chain signature creation via seaport-js SDK.
-// On-chain fulfillment uses the signed order parameters.
-```
-
-## Key Addresses
-
-| Chain    | Contract   | Address                                      |
-| -------- | ---------- | -------------------------------------------- |
-| Ethereum | seaportV16 | `0x0000000000000068F116a894984e2DB1123eB395` |
-| Arbitrum | seaportV16 | `0x0000000000000068F116a894984e2DB1123eB395` |
-| Optimism | seaportV16 | `0x0000000000000068F116a894984e2DB1123eB395` |
-| Polygon  | seaportV16 | `0x0000000000000068F116a894984e2DB1123eB395` |
-| Base     | seaportV16 | `0x0000000000000068F116a894984e2DB1123eB395` |
-
-## ABI Methods
-
-### SeaportABI
-
-- `fulfillBasicOrder(tuple)` - Fulfill a basic order. Payable. Returns fulfilled bool. BasicOrderParameters tuple:
-  - `considerationToken` (address) - Token to pay (address(0) for ETH)
-  - `considerationIdentifier` (uint256) - Token ID (0 for ERC-20/ETH)
-  - `considerationAmount` (uint256) - Payment amount
-  - `offerer` (address) - Order creator
-  - `zone` (address) - Zone contract for access control
-  - `offerToken` (address) - NFT contract address
-  - `offerIdentifier` (uint256) - NFT token ID
-  - `offerAmount` (uint256) - NFT amount (1 for ERC-721)
-  - `basicOrderType` (uint8) - Order type enum
-  - `startTime`, `endTime` (uint256) - Order validity window
-  - `zoneHash` (bytes32), `salt` (uint256) - Order uniqueness
-  - `offererConduitKey`, `fulfillerConduitKey` (bytes32) - Conduit keys for token transfers
-  - `totalOriginalAdditionalRecipients` (uint256) - Creator fees count
-  - `additionalRecipients` (`(uint256 amount, address recipient)[]`) - Extra consideration recipients (fees)
-  - `signature` (bytes) - Offerer's EIP-712 signature
-- `cancel(tuple[])` - Cancel orders. Params: orders (array of OrderComponents: offerer, zone, offer items, consideration items, orderType, startTime, endTime, zoneHash, salt, conduitKey, counter). Returns cancelled bool
-
-## Notes
-
-- Same address across all 5 chains
-- Zone-based access control for order restrictions
-- Conduits are approved transfer proxies - conduitKey=bytes32(0) for default
-- basicOrderType encodes: ERC-721/1155 + ETH/ERC-20 payment + buy/sell direction
-- Orders are signed off-chain, fulfilled on-chain - use seaport-js SDK for order creation

package/sdk/src/skills/sommelier.md

@@ -1,47 +0,0 @@
-# Sommelier
-
-ERC-4626 strategy vaults (Cellars) managed by off-chain strategists via Cosmos validators. Automated DeFi portfolio management.
-
-## Category
-
-yield | Chains: Ethereum
-
-## Key Operations
-
-- **deposit**: Deposit assets into Cellar vault
-- **withdraw**: Withdraw assets from Cellar
-- **redeem**: Redeem Cellar shares
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/sommelier";
-```
-
-## SauceScript Examples
-
-```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);
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract     | Address                                      |
-| -------- | ------------ | -------------------------------------------- |
-| Ethereum | cellarRouter | `0x6b7f87279982d919Bbf85182DDeAB179B366d8f2` |
-
-## ABI Methods
-
-- `deposit(uint256,address)` - Deposit assets
-- `withdraw(uint256,address,address)` - Withdraw assets
-- `redeem(uint256,address,address)` - Redeem shares
-
-## Notes
-
-- Cellars are ERC-4626 vaults. Strategies managed off-chain via Cosmos governance.

package/sdk/src/skills/stader.md

@@ -1,53 +0,0 @@
-# Stader
-
-Multi-chain liquid staking protocol. ETHx is Stader's non-rebasing liquid staking token for Ethereum.
-
-## Category
-
-liquid-staking | Chains: Ethereum
-
-## Key Operations
-
-- **deposit**: Stake ETH to receive ETHx
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/stader";
-```
-
-## SauceScript Examples
-
-```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);
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract         | Address                                      |
-| -------- | ---------------- | -------------------------------------------- |
-| Ethereum | ETHx             | `0xA35b1B31Ce002FBF2058D22F30f95D405200A15b` |
-| Ethereum | stakePoolManager | `0xcf5EA1b38380f6aF39068375516Daf40Ed70D299` |
-
-## ABI Methods
-
-### StakePoolManagerABI
-
-- `deposit(address)` - Stake ETH (payable), receive ETHx. Param: receiver address. Returns ETHx amount
-- `getExchangeRate()` - Current ETHx/ETH exchange rate
-
-### ETHxABI
-
-- `balanceOf(address)` - Query ETHx balance
-- `approve(address,uint256)` - Approve ETHx spending
-
-## 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/swell.md

@@ -1,65 +0,0 @@
-# Swell
-
-Liquid staking and restaking protocol for Ethereum. Offers swETH for liquid staking and rswETH for liquid restaking via EigenLayer.
-
-## Category
-
-liquid-staking | Chains: Ethereum
-
-## Key Operations
-
-- **stakeSwETH**: Deposit ETH for swETH (liquid staking)
-- **stakeRswETH**: Deposit ETH for rswETH (liquid restaking)
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/swell";
-```
-
-## SauceScript Examples
-
-```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;
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract | Address                                      |
-| -------- | -------- | -------------------------------------------- |
-| Ethereum | swETH    | `0xf951E335afb289353dc249e82926178EaC7DEd78` |
-| Ethereum | rswETH   | `0xFAe103DC9cf190eD75350761e95403b7b8aFa6c0` |
-
-## ABI Methods
-
-### SwETHABI
-
-- `deposit()` - Stake ETH (payable), receive swETH. Returns nothing: read the minted amount as a balance change
-- `swETHToETHRate()` - Current swETH/ETH exchange rate
-- `balanceOf(address)` - Query swETH balance
-
-### RswETHABI
-
-- `deposit()` - Stake ETH (payable), receive rswETH. Returns nothing: read the minted amount as a balance change
-- `rswETHToETHRate()` - Current rswETH/ETH exchange rate
-- `balanceOf(address)` - Query rswETH balance
-
-## 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/sdk/src/skills/synapse.md

@@ -1,63 +0,0 @@
-# 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: Ethereum (1), Arbitrum (42161), Optimism (10), Base (8453), Polygon (137), Avalanche (43114)
-
-## SauceScript Functions
-
-### 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
-
-## Deployed Addresses
-
-| Chain     | Contract      | Address                                      |
-| --------- | ------------- | -------------------------------------------- |
-| Ethereum  | synapseBridge | `0x2796317b0fF8538F253012862c06787Adfb8cEB6` |
-| Ethereum  | cctpRouter    | `0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E` |
-| Arbitrum  | synapseBridge | `0x6F4e8eba4d337f874AB57478AcC2Cb5BacDc19c9` |
-| Optimism  | synapseBridge | `0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b` |
-| Base      | synapseBridge | `0xf07d1C752fAb503E47FEF309bf14fbDD3E867089` |
-| Polygon   | synapseBridge | `0x8F5BBB2BB8c2Ee94639E55d5F41de9b4839C1280` |
-| Avalanche | synapseBridge | `0xC05e61d0E7a63D27546389B7aD62FdFf5A91aACE` |
-
-## ABI Reference
-
-### SynapseBridgeABI
-
-- `deposit(address to, uint256 chainId, address token, uint256 amount)` - Deposit tokens for bridging to destination chain
-- `depositAndSwap(address to, uint256 chainId, address token, uint256 amount, uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 minDy, uint256 deadline)` - Deposit with swap on destination (e.g. nUSD to USDC). Use token indices from the destination AMM pool
-- `redeem(address to, uint256 chainId, address token, uint256 amount)` - Redeem bridge tokens (for wrapped/synthetic assets like nUSD, nETH)
-
-## 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/synthra-v3.md

@@ -1,57 +0,0 @@
-# Synthra V3
-
-Concentrated-liquidity spot DEX on Arc: a Uniswap V3 fork with renamed pool callbacks.
-
-## Category
-
-dex | Chains: Arc (5042)
-
-## SauceScript Functions
-
-### swap
-
-Exact-input single-hop swap through SwapRouter02.
-
-```typescript
-import { SynthraV3SwapRouter02ABI as ISwapRouter02 } from "./abis";
-
-function main(
-  routerAddress: Address,
-  tokenIn: Address,
-  tokenOut: Address,
-  fee: Uint256,
-  amountIn: Uint256,
-  amountOutMin: Uint256,
-  recipient: Address,
-): Uint256 {
-  const router = ISwapRouter02.at(routerAddress);
-  return router.exactInputSingle({
-    tokenIn: tokenIn,
-    tokenOut: tokenOut,
-    fee: fee,
-    recipient: recipient,
-    amountIn: amountIn,
-    amountOutMinimum: amountOutMin,
-    sqrtPriceLimitX96: 0,
-  });
-}
-```
-
-- SwapRouter02's params have no `deadline`
-- `tokenIn` must be `approve`d to the router
-
-## Deployed Addresses
-
-| Chain | Contract                   | Address                                      |
-| ----- | -------------------------- | -------------------------------------------- |
-| Arc   | Factory                    | `0x6307fc239C7964942c1BfFE51930E55606619c74` |
-| Arc   | SwapRouter02               | `0xa50eDe66a573eE5bB37E28AF5789B76aE5FEb828` |
-| Arc   | QuoterV2                   | `0x9c179A7335B3fc841F59Aa6a62daf6d5c61b65D7` |
-| Arc   | NonfungiblePositionManager | `0x2743b771659fD9CE13970d7367e7e84AF6a31049` |
-
-## Notes
-
-- The external ABIs are Uniswap V3's (`getPool`, `exactInputSingle`, `quoteExactInputSingle`, `mint`, …), and the Arc bytecode dispatches every one of them
-- Pools call back `synthraV3SwapCallback` (`0x13abb0ca`) and `synthraV3MintCallback`, not the `uniswapV3*` callbacks, so a contract that swaps or mints against a Synthra pool directly must implement the renamed callbacks
-- On Arc there is no wrapped native token; pools pair against USDC's ERC-20 interface `0x3600…0000`
-- Addresses come from docs.synthra.org's contract-addresses page

package/sdk/src/skills/thales.md

@@ -1,74 +0,0 @@
-# Thales
-
-Positional markets protocol built on Synthetix offering binary options, speed markets, and sports markets on Optimism.
-
-## Category
-
-options | Chains: Optimism
-
-## Key Operations
-
-- **exerciseMarket**: Exercise a matured market position to claim payout
-- **buyFromAMM**: Buy positional tokens (UP/DOWN) from the Thales AMM
-- **createSpeedMarket**: Create a speed market position
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/thales";
-```
-
-## SauceScript Examples
-
-```typescript
-// Buy from AMM
-import { ThalesAMMABI as IThalesAMM } from "./abis";
-function main(
-  thalesAMMAddress: Address,
-  market: Address,
-  position: Uint256,
-  amount: Uint256,
-  expectedPayout: Uint256,
-  slippage: Uint256,
-): Uint256 {
-  const amm = IThalesAMM.at(thalesAMMAddress);
-  return amm.buyFromAMM(market, position, amount, expectedPayout, slippage);
-}
-
-// Exercise a matured market: on the market itself
-import { PositionalMarketABI as IPositionalMarket } from "./abis";
-function main(market: Address): Uint256 {
-  const positionalMarket = IPositionalMarket.at(market);
-  positionalMarket.exerciseOptions();
-  return 1;
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract        | Address                                      |
-| -------- | --------------- | -------------------------------------------- |
-| Optimism | thalesAMM       | `0x278B5A44397c9D8E52743fEdec263c4760dc1A1A` |
-| Optimism | speedMarketsAMM | `0xE16B8a01490835EC1e76bAbbB3Cadd8921b32001` |
-
-## ABI Methods
-
-### ThalesAMMABI
-
-- `buyFromAMM(address,uint8,uint256,uint256,uint256) returns (uint256)` - Buy positional tokens. Params: market (market address), position (0=UP, 1=DOWN), amount (tokens to buy), expectedPayout (expected return), additionalSlippage (slippage tolerance). Returns the amount paid
-
-### PositionalMarketABI
-
-- `exerciseOptions() returns (uint256)` - Exercise the caller's positions in a matured market (called on the market, not the AMM)
-
-### SpeedMarketsAMMABI
-
-- `createNewMarket(CreateMarketParams) returns (address)` - Create a speed market. One struct: `(address user, bytes32 asset, uint64 strikeTime, uint64 delta, int64 strikePrice, uint64 strikePricePublishTime, uint8 oracleSource, uint8 direction, address collateral, uint256 collateralAmount, address referrer, uint256 skewImpact)`. Returns the market address
-
-## Notes
-
-- Position 0 = UP (price goes up), Position 1 = DOWN (price goes down)
-- Markets expire at set times - exercise only after maturation
-- Speed markets have short durations (minutes to hours)
-- Binary outcome: winning position gets payout, losing gets nothing
-- Approve sUSD/USDC to thalesAMM before buying

package/sdk/src/skills/tokemak.md

@@ -1,48 +0,0 @@
-# Tokemak
-
-Liquidity routing protocol with Autopilot Autopools that automatically deploy and rebalance liquidity across DeFi destinations.
-
-## Category
-
-yield | Chains: Ethereum
-
-## Key Operations
-
-- **deposit**: Deposit assets into Autopool
-- **withdraw**: Withdraw assets from Autopool
-- **redeem**: Redeem Autopool shares
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/tokemak";
-```
-
-## SauceScript Examples
-
-```typescript
-// Deposit into Tokemak Autopool
-import { AutopoolABI as IAutopool } from "./abis";
-
-function main(autopoolAddress: Address, assets: Uint256, receiver: Address): Uint256 {
-  const autopool = IAutopool.at(autopoolAddress);
-  return autopool.deposit(assets, receiver);
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract         | Address                                      |
-| -------- | ---------------- | -------------------------------------------- |
-| Ethereum | toke             | `0x2e9d63788249371f1DFC918a52f8d799F4a38C94` |
-| Ethereum | autopoolRegistry | `0x7E5828a3A6Ae75426d739E798140513A2E2964E4` |
-
-## ABI Methods
-
-- `deposit(uint256,address)` - Deposit assets
-- `withdraw(uint256,address,address)` - Withdraw assets
-- `redeem(uint256,address,address)` - Redeem shares
-
-## Notes
-
-- Autopools are ERC-4626 vaults. Autopilot automatically rebalances across DeFi venues.