@eco-incorp/sauce 0.99.6 → 0.99.7

package/sdk/src/skills/axelar.md

@@ -1,80 +0,0 @@
-# Axelar
-
-Universal cross-chain communication protocol with decentralized validator set. Supports GMP (General Message Passing) and ITS (Interchain Token Service).
-
-## Category
-
-cross-chain messaging + bridge | Direction: any-to-any | Chains: Ethereum (1), Arbitrum (42161), Optimism (10), Base (8453), Polygon (137), Avalanche (43114)
-
-## SauceScript Functions
-
-### sendToken
-
-Send tokens cross-chain via the Axelar Gateway.
-
-```typescript
-import { AxelarGatewayABI as IGateway } from "./abis";
-
-function main(
-  gatewayAddress: Address,
-  destinationChain: string,
-  destinationAddress: string,
-  symbol: string,
-  amount: Uint256,
-): Uint256 {
-  const gateway = IGateway.at(gatewayAddress);
-  gateway.sendToken(destinationChain, destinationAddress, symbol, amount);
-  return 1;
-}
-```
-
-- `destinationChain`: Chain name as string (e.g. "ethereum", "arbitrum", "base")
-- `destinationAddress`: Recipient address as string
-- `symbol`: Token symbol as string (e.g. "axlUSDC", "WETH")
-- Requires ERC-20 approval to the Gateway
-
-## Deployed Addresses
-
-| Chain     | Contract   | Address                                      |
-| --------- | ---------- | -------------------------------------------- |
-| Ethereum  | gateway    | `0x4F4495243837681061C4743b74B3eEdf548D56A5` |
-| Ethereum  | gasService | `0x2d5d7d31F671F86C782533cc367F14109a082712` |
-| Ethereum  | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-| Arbitrum  | gateway    | `0xe432150cce91c13a887f7D836923d5597adD8E31` |
-| Arbitrum  | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-| Optimism  | gateway    | `0xe432150cce91c13a887f7D836923d5597adD8E31` |
-| Optimism  | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-| Base      | gateway    | `0xe432150cce91c13a887f7D836923d5597adD8E31` |
-| Base      | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-| Polygon   | gateway    | `0x6f015F16De9fC8791b234eF68D486d2bF203FBA8` |
-| Polygon   | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-| Avalanche | gateway    | `0x5029C0EFf6C34351a0CEc334542cDb22c7928f78` |
-| Avalanche | its        | `0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C` |
-
-## ABI Reference
-
-### AxelarGatewayABI
-
-- `callContract(string destinationChain, string contractAddress, bytes payload)` - Send arbitrary message to destination contract (GMP)
-- `callContractWithToken(string destinationChain, string contractAddress, bytes payload, string symbol, uint256 amount)` - Send message + tokens together
-- `sendToken(string destinationChain, string destinationAddress, string symbol, uint256 amount)` - Send tokens to destination address
-- `tokenAddresses(string symbol) returns (address)` - Look up token address by symbol (view)
-
-### AxelarGasServiceABI
-
-- `payNativeGasForContractCall(address sender, string destinationChain, string destinationAddress, bytes payload, address refundAddress)` [payable] - Pre-pay gas for GMP execution on destination chain
-
-### AxelarITSABI
-
-- `interchainTransfer(bytes32 tokenId, string destinationChain, bytes destinationAddress, uint256 amount, bytes metadata, uint256 gasValue)` [payable] - Transfer ITS-registered tokens cross-chain
-
-## Notes
-
-- Uses chain name strings for destination (e.g. "ethereum", "arbitrum", "Polygon") -- NOT chain IDs
-- `sendToken`: Simple token transfer. `callContract`: GMP message. `callContractWithToken`: Both
-- GMP calls require pre-paying gas via GasService or including gasValue in ITS calls
-- ITS (Interchain Token Service) enables native cross-chain tokens without wrapping
-- Same ITS address (`0xB5FB...`) across all chains
-- `tokenAddresses(symbol)` to look up the local address of an Axelar-supported token
-- Finality: typically 2-5 minutes depending on source chain
-- TVL: $800M+. Audited

package/sdk/src/skills/chainlink.md

@@ -1,62 +0,0 @@
-# Chainlink
-
-Industry-standard decentralized oracle network providing price feeds, VRF randomness, automation, and cross-chain interoperability (CCIP).
-
-## Category
-
-oracle | Chains: Ethereum, Arc
-
-## Key Operations
-
-- **getLatestPrice**: Read latest price from a Chainlink price feed aggregator
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/chainlink";
-```
-
-## SauceScript Examples
-
-```typescript
-// Get latest price from feed
-import { AggregatorV3ABI as IAggregatorV3 } from "./abis";
-function main(feedAddress: Address): {
-  roundId: Uint256;
-  answer: Uint256;
-  startedAt: Uint256;
-  updatedAt: Uint256;
-  answeredInRound: Uint256;
-} {
-  const feed = IAggregatorV3.at(feedAddress);
-  return feed.latestRoundData();
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract         | Address                                      |
-| -------- | ---------------- | -------------------------------------------- |
-| Ethereum | ethUsdFeed       | `0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419` |
-| Ethereum | feedRegistry     | `0x47Fb2585D2C56Fe188D0E6ec628a38b74fCeeeDf` |
-| Ethereum | vrfV2Coordinator | `0x271682DEB8C4E0901D1a1550aD2e64D568E69909` |
-
-## ABI Methods
-
-### AggregatorV3ABI
-
-- `latestRoundData()` - Get latest price data. Returns tuple: (roundId uint80, answer int256, startedAt uint256, updatedAt uint256, answeredInRound uint80). answer is the price with feed-specific decimals
-- `decimals()` - Get price feed decimal precision. Returns uint8 (usually 8 for USD feeds, 18 for ETH feeds)
-
-### FeedRegistryABI
-
-- `latestRoundData(address,address)` - Get latest price for a base/quote pair. Params: base (token address), quote (denomination address, use 0x348... for USD). Returns same tuple as AggregatorV3
-- `getFeed(address,address)` - Look up aggregator address for a pair. Params: base, quote. Returns aggregator address
-
-## Notes
-
-- Price feeds return answer in int256 with feed-specific decimals (usually 8 for USD pairs)
-- Always check updatedAt timestamp for staleness - stale prices can cause issues
-- Feed Registry is Ethereum-only; on L2s, use individual feed addresses directly
-- VRF provides verifiable randomness for on-chain applications
-- Common feed addresses vary by chain - check Chainlink docs for specific chain deployments

package/sdk/src/skills/curve.md

@@ -1,141 +0,0 @@
-# Curve Finance
-
-StableSwap AMM optimized for low-slippage swaps between pegged assets (stablecoins, wrapped tokens). Uses a specialized invariant that provides near-zero slippage for like-kind assets while maintaining AMM properties.
-
-## Category
-
-dex | Chains: Ethereum, Arbitrum, Optimism, Base, Polygon, Avalanche, Fantom, Gnosis
-
-## Key Operations
-
-- **swap**: Exchange tokens within a pool using index-based routing
-- **addLiquidity**: Add liquidity with flexible token amounts (can be imbalanced)
-- **removeLiquidity**: Remove liquidity proportionally or single-sided
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/curve";
-```
-
-## SauceScript Examples
-
-### swap
-
-```typescript
-import { CurveStableSwapABI as IStableSwap } from "./abis";
-
-function main(
-  poolAddress: Address,
-  i: Uint256,
-  j: Uint256,
-  amountIn: Uint256,
-  minAmountOut: Uint256,
-): Uint256 {
-  const pool = IStableSwap.at(poolAddress);
-  return pool.exchange(i, j, amountIn, minAmountOut);
-}
-```
-
-- `poolAddress`: The specific Curve pool contract address (each pool is a separate contract)
-- `i`: Index of the input token within the pool (0-based)
-- `j`: Index of the output token within the pool (0-based)
-- `amountIn`: Exact amount of input token (in wei)
-- `minAmountOut`: Minimum output for slippage protection
-- Token indices vary per pool
-- For StableSwap-NG pools. 3pool's `exchange` returns nothing, so reading back a `uint256` reverts there: use `CurveThreePoolABI` for 3pool
-
-### addLiquidity
-
-```typescript
-import { CurveStableSwapABI as IStableSwap } from "./abis";
-
-function main(poolAddress: Address, amounts: Uint256[], minMintAmount: Uint256): Uint256 {
-  const pool = IStableSwap.at(poolAddress);
-  return pool.add_liquidity(amounts, minMintAmount);
-}
-```
-
-- `amounts`: Array of deposit amounts for each token in pool order (can include zeros for imbalanced deposits)
-- `minMintAmount`: Minimum LP tokens to receive (slippage protection)
-- All deposited tokens must be approved to the pool contract
-
-### removeLiquidity
-
-```typescript
-import { CurveStableSwapABI as IStableSwap } from "./abis";
-
-function main(poolAddress: Address, amount: Uint256, minAmounts: Uint256[]): Uint256[] {
-  const pool = IStableSwap.at(poolAddress);
-  return pool.remove_liquidity(amount, minAmounts);
-}
-```
-
-- `amount`: Amount of LP tokens to burn
-- `minAmounts`: Minimum amounts of each token to receive (array in pool token order)
-
-## Key Addresses
-
-| Chain     | Contract              | Address                                      |
-| --------- | --------------------- | -------------------------------------------- |
-| Ethereum  | RouterNG              | `0x16C6521Dff6baB339122a0FE25a9116693265353` |
-| Ethereum  | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-| Ethereum  | CRV Token             | `0xD533a949740bb3306d119CC777fa900bA034cd52` |
-| Ethereum  | 3pool (DAI/USDC/USDT) | `0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7` |
-| Arbitrum  | RouterNG              | `0x2191718CD32d02B8E60BAdFFeA33E4B5DD9A0A0D` |
-| Arbitrum  | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-| Optimism  | RouterNG              | `0x0DCDED3545D565bA3B19E683431381007245d983` |
-| Base      | RouterNG              | `0x4f37A9d177470499A2dD084621020b023fcffc1F` |
-| Polygon   | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-| Avalanche | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-| Fantom    | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-| Gnosis    | AddressProvider       | `0x0000000022D53366457F9d5E68Ec105046FC4383` |
-
-## ABI Methods
-
-### CurveStableSwapABI
-
-The StableSwap-NG pool interface (plain and meta pools). Classic pools such as 3pool have their own shape: see `CurveThreePoolABI` below.
-
-- `exchange(int128 i, int128 j, uint256 dx, uint256 min_dy) -> uint256` - Swap between two tokens in the pool by index
-- `exchange_underlying(int128 i, int128 j, uint256 dx, uint256 min_dy) -> uint256` - Swap between underlying tokens (metapools only)
-- `add_liquidity(uint256[] amounts, uint256 min_mint_amount) -> uint256` - Deposit tokens and receive LP tokens (can be imbalanced)
-- `remove_liquidity(uint256 _amount, uint256[] min_amounts) -> uint256[]` - Burn LP tokens and withdraw all tokens proportionally
-- `remove_liquidity_one_coin(uint256 _token_amount, int128 i, uint256 min_amount) -> uint256` - Burn LP tokens and withdraw as a single token
-- `get_dy(int128 i, int128 j, uint256 dx) -> uint256` - Quote: estimate output for a given input (view)
-- `get_virtual_price() -> uint256` - Get the virtual price of the LP token (view, useful for pricing)
-
-### CurveThreePoolABI
-
-3pool (`threePool` in the addresses), a classic StableSwap pool. Its liquidity arrays are fixed-size, and its state-changing functions return nothing: read amounts as balance changes.
-
-- `exchange(int128 i, int128 j, uint256 dx, uint256 min_dy)` - Swap between two of DAI(0), USDC(1), USDT(2)
-- `add_liquidity(uint256[3] amounts, uint256 min_mint_amount)` - Deposit tokens and receive 3CRV
-- `remove_liquidity(uint256 _amount, uint256[3] min_amounts)` - Burn 3CRV and withdraw all three tokens proportionally
-- `remove_liquidity_one_coin(uint256 _token_amount, int128 i, uint256 min_amount)` - Burn 3CRV and withdraw one token
-- `get_dy(int128 i, int128 j, uint256 dx) -> uint256` - Quote (view)
-- `get_virtual_price() -> uint256` - Virtual price of 3CRV (view)
-
-### CurveRouterNGABI
-
-- `exchange(address[11] _route, uint256[5][5] _swap_params, uint256 _amount, uint256 _expected, address[5] _pools) -> uint256` - Multi-pool routed swap for optimal execution
-- `exchange(address[11] _route, uint256[5][5] _swap_params, uint256 _amount, uint256 _min_dy, address[5] _pools, address _receiver) -> uint256` - The same routed swap, paying `_receiver` instead of the caller
-- `get_dy(address[11] _route, uint256[5][5] _swap_params, uint256 _amount, address[5] _pools) -> uint256` - Quote routed swap output (view)
-
-### CurveAddressProviderABI
-
-- `get_registry() -> address` - Get the main registry contract address (view)
-- `get_address(uint256 _id) -> address` - Get a specific system contract by ID (view)
-
-## Notes
-
-- Pool tokens are indexed (i, j) not addressed; you must know the token order for each pool
-- Common pool token orders: 3pool = [DAI(0), USDC(1), USDT(2)]
-- `exchange_underlying` is used for metapools or lending pools where tokens wrap underlying assets
-- `remove_liquidity_one_coin` is useful for single-sided withdrawal (higher slippage than proportional)
-- Each pool is a separate contract; use the AddressProvider or registry to discover pools
-- RouterNG enables cross-pool routing for multi-hop swaps across different pools
-- Curve excels at stablecoin swaps (much lower slippage than Uniswap for like-kind pairs)
-- The `get_virtual_price` never decreases and represents the LP token value growth over time
-- Tokens must be ERC20-approved to the pool contract (not a router) for direct pool swaps
-- For Router NG swaps, approve tokens to the Router NG contract

package/sdk/src/skills/eigenlayer.md

@@ -1,71 +0,0 @@
-# EigenLayer
-
-Restaking protocol that enables staked ETH to secure additional protocols (AVS). Deposit LSTs into strategies to earn restaking rewards on top of staking yield.
-
-## Category
-
-restaking | Chains: Ethereum
-
-## Key Operations
-
-- **depositIntoStrategy**: Deposit LSTs (stETH, rETH, cbETH) into a restaking strategy
-- **delegateTo**: Delegate restaked assets to an operator (via DelegationManager)
-- **undelegate**: Undelegate from an operator, initiating withdrawal
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/eigenlayer";
-```
-
-## SauceScript Examples
-
-```typescript
-// Deposit LST into restaking strategy
-import { StrategyManagerABI as IStrategyManager } from "./abis";
-function main(
-  strategyManagerAddress: Address,
-  strategy: Address,
-  token: Address,
-  amount: Uint256,
-): Uint256 {
-  const sm = IStrategyManager.at(strategyManagerAddress);
-  return sm.depositIntoStrategy(strategy, token, amount);
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract          | Address                                      |
-| -------- | ----------------- | -------------------------------------------- |
-| Ethereum | strategyManager   | `0x858646372CC42E1A627fcE94aa7A7033e7CF075A` |
-| Ethereum | delegationManager | `0x39053D51B77DC0d36036Fc1fCc8Cb819df8Ef37A` |
-| Ethereum | stETHStrategy     | `0x93c4b944D05dfe6df7645A86cd2206016c51564D` |
-| Ethereum | rETHStrategy      | `0x1BeE69b7dFFfA4E2d53C2a2Df135C388AD25dCD2` |
-| Ethereum | cbETHStrategy     | `0x54945180dB7943c0ed0FEE7EdaB2Bd24620256bc` |
-
-## ABI Methods
-
-### StrategyManagerABI
-
-- `depositIntoStrategy(address,address,uint256)` - Deposit token into strategy. Params: strategy address, token address, amount. Returns shares
-- `stakerDepositShares(address staker, address strategy)` - Query staker's deposit shares in a strategy (renamed from `stakerStrategyShares`)
-
-### DelegationManagerABI
-
-- `delegateTo(address,tuple,bytes32)` - Delegate to operator. Tuple is (signature bytes, expiry uint256). Use empty sig + max expiry
-- `undelegate(address)` - Undelegate staker. Returns withdrawal root bytes32[]
-- `isDelegated(address)` - Check if address is delegated to an operator
-
-### StrategyABI
-
-- `sharesToUnderlyingView(uint256)` - Convert shares to underlying token amount
-- `underlyingToSharesView(uint256)` - Convert underlying amount to shares
-
-## Notes
-
-- TVL: $13B+. Foundation of the restaking ecosystem
-- Approve LST token to StrategyManager before depositing
-- Each LST has its own strategy contract (stETH, rETH, cbETH listed above)
-- Withdrawal has a 7-day delay period after undelegating
-- delegateTo requires approverSignatureAndExpiry tuple - use empty bytes + far-future expiry for typical cases

package/sdk/src/skills/gamma.md

@@ -1,79 +0,0 @@
-# Gamma Strategies
-
-Active concentrated liquidity management protocol. Manages Uniswap V3, Algebra, and other CL DEX positions with automated rebalancing via Hypervisor vaults.
-
-## Category
-
-yield | Chains: Ethereum, Polygon
-
-## Key Operations
-
-- **deposit**: Deposit token pair into Gamma Hypervisor via UniProxy
-- **withdraw**: Withdraw liquidity from Hypervisor
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/gamma";
-```
-
-## SauceScript Examples
-
-```typescript
-// Deposit into Gamma Hypervisor
-import { UniProxyABI as IUniProxy } from "./abis";
-function main(
-  uniProxyAddress: Address,
-  deposit0: Uint256,
-  deposit1: Uint256,
-  to: Address,
-  pos: Address,
-): Uint256 {
-  const proxy = IUniProxy.at(uniProxyAddress);
-  return proxy.deposit(deposit0, deposit1, to, pos, [0, 0, 0, 0]);
-}
-
-// Withdraw from Hypervisor
-import { HypervisorABI as IHypervisor } from "./abis";
-function main(hypervisorAddress: Address, shares: Uint256, to: Address, from: Address): Uint256 {
-  const hv = IHypervisor.at(hypervisorAddress);
-  hv.withdraw(shares, to, from, [0, 0, 0, 0]);
-  return 1;
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract | Address                                                                                    |
-| -------- | -------- | ------------------------------------------------------------------------------------------ |
-| Ethereum | uniProxy | `0xf5bfa20f4a77933fee0c7bb7f39e7642a070d599` (an earlier release: use `UniProxyLegacyABI`) |
-| Polygon  | uniProxy | `0xA42d55074869491D60Ac05490376B74cF19B00e6`                                               |
-
-## ABI Methods
-
-### UniProxyABI
-
-- `deposit(uint256,uint256,address,address,uint256[4])` - Deposit tokens. Params: deposit0, deposit1, to (receiver), pos (hypervisor address), minIn[4] (slippage, use [0,0,0,0])
-- `getDepositAmount(address,address,uint256)` - Preview required token1 amount for given token0 deposit. Params: pos, token, deposit amount. Returns (amountStart, amountEnd)
-
-### UniProxyLegacyABI
-
-The Ethereum UniProxy is an earlier release; its `deposit` has no `minIn` (the `depositLegacy` template calls it).
-
-- `deposit(uint256,uint256,address,address)` - Deposit tokens. Params: deposit0, deposit1, to (receiver), pos (hypervisor address). Returns shares
-- `getDepositAmount(address,address,uint256)` - As on the current UniProxy
-
-### HypervisorABI
-
-- `withdraw(uint256,address,address,uint256[4])` - Withdraw by burning shares. Params: shares, to, from, minAmounts[4]. Returns (amount0, amount1)
-- `balanceOf(address)` - Query Hypervisor share balance
-- `totalSupply()` - Total shares outstanding
-- `getTotalAmounts()` - Total (amount0, amount1) managed
-
-## Notes
-
-- TVL: $200M+. Each Hypervisor is a vault for a specific token pair
-- Deposit via UniProxy (not directly on Hypervisor) - UniProxy handles deposit ratio enforcement
-- Use getDepositAmount() to find correct token1 amount for your token0 deposit
-- The uint256[4] minIn/minAmounts array provides slippage protection (use zeros for no limit)
-- Approve both token0 and token1 to UniProxy before depositing

package/sdk/src/skills/harvest.md

@@ -1,49 +0,0 @@
-# Harvest Finance
-
-Yield farming protocol that automatically compounds rewards across DeFi strategies via Vault+Strategy pattern.
-
-## Category
-
-yield | Chains: Ethereum
-
-## Key Operations
-
-- **deposit**: Deposit tokens into Harvest vault
-- **withdraw**: Withdraw tokens from vault
-- **getPricePerFullShare**: Query vault share price
-
-## SDK Usage
-
-```typescript
-import { protocolInfo, deployments, sauceFunctions } from "@eco-incorp/sauce/protocols/harvest";
-```
-
-## SauceScript Examples
-
-```typescript
-// Deposit into Harvest vault
-import { VaultABI as IVault } from "./abis";
-
-function main(vaultAddress: Address, amount: Uint256): Uint256 {
-  const vault = IVault.at(vaultAddress);
-  vault.deposit(amount);
-  return 1;
-}
-```
-
-## Key Addresses
-
-| Chain    | Contract   | Address                                      |
-| -------- | ---------- | -------------------------------------------- |
-| Ethereum | controller | `0x222412af183BCeAdEFd72e4Cb1b71f1889953b1C` |
-| Ethereum | farm       | `0xa0246c9032bC3A600820415aE600c6388619A14D` |
-
-## ABI Methods
-
-- `deposit(uint256) returns (uint256)` - Deposit tokens
-- `withdraw(uint256) returns (uint256)` - Withdraw shares
-- `getPricePerFullShare()` - Get share price
-
-## Notes
-
-- FARM token for governance. Auto-compounds strategy rewards.