@eco-incorp/sauce 0.99.5 → 0.99.7

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

@@ -0,0 +1,40 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Frax Finance (`frax`)
+
+Fractional-algorithmic stablecoin protocol with FRAX stablecoin, sFRAX staking, and FXS governance.
+
+| Fact | Value |
+| --- | --- |
+| Category | CDPs and stablecoins |
+| Family | none |
+| Namespace | `Frax` on ethereum |
+| Chains | ethereum |
+| Document | [frax.md](../frax.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Frax` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's frax, `0x853d955aCEf822Db058eb8505911ED77F175b99e`.
+  require(Frax.Frax != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | frax | `0x853d955aCEf822Db058eb8505911ED77F175b99e` | `Frax.Frax` |
+
+## ABI
+
+### `FraxERC20ABI`
+
+`import FraxERC20ABI from "./protocols/frax/FraxERC20ABI.json";` Speaks for: frax.
+
+- `balanceOf(address account) view returns (uint256)`
+- `approve(address spender, uint256 amount) returns (bool)`
+- `transfer(address to, uint256 amount) returns (bool)`

package/skills/sauce-protocols/references/registry/gains-network.md

@@ -0,0 +1,43 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Gains Network (`gains-network`)
+
+Decentralized leveraged trading platform (gTrade) supporting crypto, forex, and stocks with synthetic leverage up to 1000x on forex.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | none |
+| Namespace | `GainsNetwork` on polygon, arbitrum |
+| Chains | polygon, arbitrum |
+| Document | [gains-network.md](../gains-network.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Polygon, `GainsNetwork` is a namespace: its contracts need no import.
+
+```sauce chain=polygon
+function main() {
+  // Polygon's diamond, `0x209A9A01980377916851af2cA075C2b170452018`.
+  require(GainsNetwork.Diamond != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Polygon](../../../sauce-chains/references/polygon.md) | diamond | `0x209A9A01980377916851af2cA075C2b170452018` | `GainsNetwork.Diamond` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | diamond | `0xFF162c694eAA571f685030649814282eA457f169` | `GainsNetwork.Diamond` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | gns | `0x18c11FD286C5EC11c3b683Caa813B77f5163A122` | `GainsNetwork.Gns` |
+
+## ABI
+
+### `DiamondABI`
+
+`import DiamondABI from "./protocols/gains-network/DiamondABI.json";` Speaks for: diamond.
+
+- `openTrade((address user, uint32 index, uint16 pairIndex, uint24 leverage, bool long, bool isOpen, uint8 collateralIndex, uint8 tradeType, uint120 collateralAmount, uint64 openPrice, uint64 tp, uint64 sl, bool isCounterTrade, uint160 positionSizeToken, uint24 __placeholder) trade, uint16 maxSlippageP, address referrer)`
+- `closeTradeMarket(uint32 index, uint64 expectedPrice)`
+- `updateSl(uint32 index, uint64 newSl)`
+- `updateTp(uint32 index, uint64 newTp)`

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

@@ -0,0 +1,56 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Gamma Strategies (`gamma`)
+
+Active concentrated liquidity management protocol. Manages Uniswap V3 and other DEX positions with automated rebalancing.
+
+| Fact | Value |
+| --- | --- |
+| Category | Yield and vaults |
+| Family | none |
+| Namespace | `Gamma` on ethereum, polygon |
+| Chains | ethereum, polygon |
+| Document | [gamma.md](../gamma.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Gamma` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's uniProxy, `0xf5bfa20f4a77933fee0c7bb7f39e7642a070d599`.
+  require(Gamma.UniProxyLegacy != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | uniProxy | `0xf5bfa20f4a77933fee0c7bb7f39e7642a070d599` | `Gamma.UniProxyLegacy` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | uniProxy | `0xA42d55074869491D60Ac05490376B74cF19B00e6` | `Gamma.UniProxy` |
+
+## ABI
+
+### `HypervisorABI`
+
+`import HypervisorABI from "./protocols/gamma/HypervisorABI.json";`
+
+- `withdraw(uint256 shares, address to, address from, uint256[4] minAmounts) returns (uint256 amount0, uint256 amount1)`
+- `balanceOf(address account) view returns (uint256)`
+- `totalSupply() view returns (uint256)`
+- `getTotalAmounts() view returns (uint256 total0, uint256 total1)`
+
+### `UniProxyABI`
+
+`import UniProxyABI from "./protocols/gamma/UniProxyABI.json";` Speaks for: uniProxy.
+
+- `deposit(uint256 deposit0, uint256 deposit1, address to, address pos, uint256[4] minIn) returns (uint256 shares)`
+- `getDepositAmount(address pos, address token, uint256 _deposit) view returns (uint256 amountStart, uint256 amountEnd)`
+
+### `UniProxyLegacyABI`
+
+`import UniProxyLegacyABI from "./protocols/gamma/UniProxyLegacyABI.json";` Speaks for: uniProxy.
+
+- `deposit(uint256 deposit0, uint256 deposit1, address to, address pos) returns (uint256 shares)`
+- `getDepositAmount(address pos, address token, uint256 _deposit) view returns (uint256 amountStart, uint256 amountEnd)`

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

@@ -0,0 +1,45 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Gelato Network (`gelato`)
+
+Web3 automation network for scheduling and executing smart contract functions and off-chain computations.
+
+| Fact | Value |
+| --- | --- |
+| Category | Infrastructure and standards |
+| Family | none |
+| Namespace | `Gelato` on ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, base, arbitrum, avalanche |
+| Document | [gelato.md](../gelato.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Gelato` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's automate, `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0`.
+  require(Gelato.Automate != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [Base](../../../sauce-chains/references/base.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | automate | `0x2A6C106ae13B558BB9E2Ec64Bd2f1f7BEFF3A5E0` | `Gelato.Automate` |
+
+## ABI
+
+### `GelatoAutomateABI`
+
+`import GelatoAutomateABI from "./protocols/gelato/GelatoAutomateABI.json";` Speaks for: automate.
+
+- `createTask(address execAddress, bytes execDataOrSelector, (uint8[] modules, bytes[] args) moduleData, address feeToken) returns (bytes32 taskId)`
+- `cancelTask(bytes32 taskId)`

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

@@ -0,0 +1,40 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# GHO (`gho`)
+
+Aave-native decentralized stablecoin minted against Aave V3 collateral. Multi-collateral, transparent, and governed by Aave DAO.
+
+| Fact | Value |
+| --- | --- |
+| Category | CDPs and stablecoins |
+| Family | none |
+| Namespace | `Gho` on ethereum |
+| Chains | ethereum |
+| Document | [gho.md](../gho.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Gho` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's gho, `0x40D16FC0246aD3160Ccc09B8D0D3A2cD28aE6C2f`.
+  require(Gho.Gho != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | gho | `0x40D16FC0246aD3160Ccc09B8D0D3A2cD28aE6C2f` | `Gho.Gho` |
+
+## ABI
+
+### `GhoTokenABI`
+
+`import GhoTokenABI from "./protocols/gho/GhoTokenABI.json";` Speaks for: gho.
+
+- `transfer(address to, uint256 amount) returns (bool)`
+- `approve(address spender, uint256 amount) returns (bool)`
+- `balanceOf(address account) view returns (uint256)`

package/skills/sauce-protocols/references/registry/gmx-v1.md

@@ -0,0 +1,59 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# GMX V1 (`gmx-v1`)
+
+Decentralized perpetual exchange with multi-asset liquidity pool (GLP). Supports leverage trading with low swap fees and zero price impact trades.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | `Gmx`: `gmx-v1`, `gmx-v2` |
+| Namespace | `GmxV1` on arbitrum, avalanche |
+| Chains | arbitrum, avalanche |
+| Document | [gmx-v1.md](../gmx-v1.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `GmxV1` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's glp, `0x4277f8F2c384827B5273592FF7CeBd9f2C1ac258`.
+  require(GmxV1.Glp != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | glp | `0x4277f8F2c384827B5273592FF7CeBd9f2C1ac258` | `GmxV1.Glp` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | positionRouter | `0xb87a436B93fFE9D75c5cFA7bAcFff96430b09868` | `GmxV1.PositionRouter` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | router | `0xaBBc5F99639c9B6bCb58544ddf04EFA6802F4064` | `GmxV1.Router` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | vault | `0x489ee077994B6658eAfA855C308275EAd8097C4A` | `GmxV1.Vault` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | router | `0x5F719c2F1095F7B9fc68a68e35B51194f4b6abe8` | `GmxV1.Router` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | vault | `0x9ab2De34A33fB459b538c43f251eB825645e8595` | `GmxV1.Vault` |
+
+## ABI
+
+### `PositionRouterABI`
+
+`import PositionRouterABI from "./protocols/gmx-v1/PositionRouterABI.json";` Speaks for: positionRouter.
+
+- `createIncreasePosition(address[] _path, address _indexToken, uint256 _amountIn, uint256 _minOut, uint256 _sizeDelta, bool _isLong, uint256 _acceptablePrice, uint256 _executionFee, bytes32 _referralCode, address _callbackTarget) payable returns (bytes32 requestKey)`
+- `createDecreasePosition(address[] _path, address _indexToken, uint256 _collateralDelta, uint256 _sizeDelta, bool _isLong, address _receiver, uint256 _acceptablePrice, uint256 _minOut, uint256 _executionFee, bool _withdrawETH, address _callbackTarget) payable returns (bytes32 requestKey)`
+
+### `RouterABI`
+
+`import RouterABI from "./protocols/gmx-v1/RouterABI.json";` Speaks for: router.
+
+- `approvePlugin(address _plugin)`
+- `swap(address[] _path, uint256 _amountIn, uint256 _minOut, address _receiver)`
+
+### `VaultABI`
+
+`import VaultABI from "./protocols/gmx-v1/VaultABI.json";` Speaks for: vault.
+
+- `swap(address _tokenIn, address _tokenOut, address _receiver) returns (uint256)`
+- `increasePosition(address _account, address _collateralToken, address _indexToken, uint256 _sizeDelta, bool _isLong)`
+- `decreasePosition(address _account, address _collateralToken, address _indexToken, uint256 _collateralDelta, uint256 _sizeDelta, bool _isLong, address _receiver) returns (uint256)`

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

@@ -0,0 +1,41 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# GMX V2 (`gmx-v2`)
+
+Next generation of GMX perpetual exchange with isolated markets, improved risk management, and GM liquidity tokens replacing GLP.
+
+| Fact | Value |
+| --- | --- |
+| Category | Perpetuals |
+| Family | `Gmx`: `gmx-v1`, `gmx-v2` |
+| Namespace | `GmxV2` on arbitrum |
+| Chains | arbitrum |
+| Document | [gmx-v2.md](../gmx-v2.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `GmxV2` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's dataStore, `0xFD70de6b91282D8017aA4E741e9Ae325CAb992d8`.
+  require(GmxV2.DataStore != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | dataStore | `0xFD70de6b91282D8017aA4E741e9Ae325CAb992d8` | `GmxV2.DataStore` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | exchangeRouter | `0x7dE39FF2e232A2203196788d37e234cF8F1b83f1` | `GmxV2.ExchangeRouter` |
+
+## ABI
+
+### `ExchangeRouterABI`
+
+`import ExchangeRouterABI from "./protocols/gmx-v2/ExchangeRouterABI.json";` Speaks for: exchangeRouter.
+
+- `createOrder(((address receiver, address cancellationReceiver, address callbackContract, address uiFeeReceiver, address market, address initialCollateralToken, address[] swapPath) addresses, (uint256 sizeDeltaUsd, uint256 initialCollateralDeltaAmount, uint256 triggerPrice, uint256 acceptablePrice, uint256 executionFee, uint256 callbackGasLimit, uint256 minOutputAmount, uint256 validFromTime) numbers, uint8 orderType, uint8 decreasePositionSwapType, bool isLong, bool shouldUnwrapNativeToken, bool autoCancel, bytes32 referralCode, bytes32[] dataList) params) payable returns (bytes32 orderKey)`
+- `cancelOrder(bytes32 key) payable`
+- `sendTokens(address token, address receiver, uint256 amount) payable`

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

@@ -0,0 +1,44 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Harvest Finance (`harvest`)
+
+Yield farming protocol that automatically compounds rewards across DeFi strategies via Vault+Strategy pattern.
+
+| Fact | Value |
+| --- | --- |
+| Category | Yield and vaults |
+| Family | none |
+| Namespace | `Harvest` on ethereum |
+| Chains | ethereum |
+| Document | [harvest.md](../harvest.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Harvest` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's controller, `0x222412af183BCeAdEFd72e4Cb1b71f1889953b1C`.
+  require(Harvest.Controller != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | controller | `0x222412af183BCeAdEFd72e4Cb1b71f1889953b1C` | `Harvest.Controller` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | depositHelper | `0xF8ce90c2710713552fb564869694B2505Bfc0846` | `Harvest.DepositHelper` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | farm | `0xa0246c9032bC3A600820415aE600c6388619A14D` | `Harvest.Farm` |
+
+## ABI
+
+### `VaultABI`
+
+`import VaultABI from "./protocols/harvest/VaultABI.json";`
+
+- `deposit(uint256 amount) returns (uint256)`
+- `withdraw(uint256 numberOfShares) returns (uint256)`
+- `getPricePerFullShare() view returns (uint256)`
+- `underlyingBalanceWithInvestment() view returns (uint256)`
+- `balanceOf(address account) view returns (uint256)`

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

@@ -0,0 +1,39 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Hegic (`hegic`)
+
+On-chain options trading protocol allowing users to buy call and put options on ETH and BTC with simplified UX.
+
+| Fact | Value |
+| --- | --- |
+| Category | Options |
+| Family | none |
+| Namespace | `Hegic` on arbitrum |
+| Chains | arbitrum |
+| Document | [hegic.md](../hegic.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Arbitrum One, `Hegic` is a namespace: its contracts need no import.
+
+```sauce chain=arbitrum
+function main() {
+  // Arbitrum One's hegic, `0x431402e8b9dE9aa016C743880e04E517074D8cEC`.
+  require(Hegic.Hegic != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | hegic | `0x431402e8b9dE9aa016C743880e04E517074D8cEC` | `Hegic.Hegic` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | operationalTreasury | `0xec096ea6eB9aa5ea689b0CF00882366E92377371` | `Hegic.OperationalTreasury` |
+
+## ABI
+
+### `HegicABI`
+
+`import HegicABI from "./protocols/hegic/HegicABI.json";` Speaks for: operationalTreasury.
+
+- `payOff(uint256 positionID, address account)`

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

@@ -0,0 +1,49 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Hop Protocol (`hop`)
+
+Token bridge for rollups using bonders for fast withdrawals. Supports ETH, USDC, USDT, DAI, and MATIC bridging across L2s.
+
+| Fact | Value |
+| --- | --- |
+| Category | Bridges |
+| Family | none |
+| Namespace | `Hop` on ethereum, optimism, polygon, base, arbitrum |
+| Chains | ethereum, optimism, polygon, base, arbitrum |
+| Document | [hop.md](../hop.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Hop` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's l1EthBridge, `0xb8901acb165ed027e32754e0ffe830802919727f`.
+  require(Hop.L1EthBridge != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | l1EthBridge | `0xb8901acb165ed027e32754e0ffe830802919727f` | `Hop.L1EthBridge` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | l1UsdcBridge | `0x3666f603Cc164936C1b87e207F36BEBa4AC5f18a` | `Hop.L1UsdcBridge` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | l2AmmWrapper | `0x86cA30bEF97fB651b8d866D45503684b90cb3312` | `Hop.L2AmmWrapper` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | l2AmmWrapper | `0x76b22b8C1079A44F1211D867D68b1eda76a635A7` | `Hop.L2AmmWrapper` |
+| [Base](../../../sauce-chains/references/base.md) | l2AmmWrapper | `0x10541b07d8Ad2647Dc6cD67abd4c03575dade261` | `Hop.L2AmmWrapper` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | l2AmmWrapper | `0x33ceb27b39d2Bb7D2e61F7564d3Df29344020417` | `Hop.L2AmmWrapper` |
+
+## ABI
+
+### `HopL1BridgeABI`
+
+`import HopL1BridgeABI from "./protocols/hop/HopL1BridgeABI.json";` Speaks for: l1EthBridge, l1UsdcBridge.
+
+- `sendToL2(uint256 chainId, address recipient, uint256 amount, uint256 amountOutMin, uint256 deadline, address relayer, uint256 relayerFee) payable`
+
+### `HopL2AmmWrapperABI`
+
+`import HopL2AmmWrapperABI from "./protocols/hop/HopL2AmmWrapperABI.json";` Speaks for: l2AmmWrapper.
+
+- `swapAndSend(uint256 chainId, address recipient, uint256 amount, uint256 bonderFee, uint256 amountOutMin, uint256 deadline, uint256 destinationAmountOutMin, uint256 destinationDeadline) payable`

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

@@ -0,0 +1,48 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Hyperlane (`hyperlane`)
+
+Permissionless interchain messaging protocol. Supports modular security with ISMs (Interchain Security Modules) across 150+ chains.
+
+| Fact | Value |
+| --- | --- |
+| Category | Cross-chain messaging |
+| Family | none |
+| Namespace | `Hyperlane` on ethereum, optimism, bsc, polygon, arc, base, arbitrum, avalanche |
+| Chains | ethereum, optimism, bsc, polygon, arc, base, arbitrum, avalanche |
+| Document | [hyperlane.md](../hyperlane.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Hyperlane` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's mailbox, `0xc005dc82818d67AF737725bD4bf75435d065D239`.
+  require(Hyperlane.Mailbox != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | mailbox | `0xc005dc82818d67AF737725bD4bf75435d065D239` | `Hyperlane.Mailbox` |
+| [Optimism](../../../sauce-chains/references/optimism.md) | mailbox | `0xd4C1905BB1D26BC93DAC913e13CaCC278CdCC80D` | `Hyperlane.Mailbox` |
+| [BNB Chain](../../../sauce-chains/references/bsc.md) | mailbox | `0x2971b9Aec44bE4eb673DF1B88cDB57b96eefe8a4` | `Hyperlane.Mailbox` |
+| [Polygon](../../../sauce-chains/references/polygon.md) | mailbox | `0x5d934f4e2f797775e53561bB72aca21ba36B96BB` | `Hyperlane.Mailbox` |
+| [Arc](../../../sauce-chains/references/arc.md) | mailbox | `0x7f50C5776722630a0024fAE05fDe8b47571D7B39` | `Hyperlane.Mailbox` |
+| [Base](../../../sauce-chains/references/base.md) | mailbox | `0xeA87ae93Fa0019a82A727bfd3eBd1cFCa8f64f1D` | `Hyperlane.Mailbox` |
+| [Arbitrum One](../../../sauce-chains/references/arbitrum.md) | mailbox | `0x979Ca5202784112f4738403dBec5D0F3B9daabB9` | `Hyperlane.Mailbox` |
+| [Avalanche C-Chain](../../../sauce-chains/references/avalanche.md) | mailbox | `0xFf06aFcaABaDDd1fb08371f9ccA15D73D51FeBD6` | `Hyperlane.Mailbox` |
+
+## ABI
+
+### `HyperlaneMailboxABI`
+
+`import HyperlaneMailboxABI from "./protocols/hyperlane/HyperlaneMailboxABI.json";` Speaks for: mailbox.
+
+- `dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes _messageBody) payable returns (bytes32)`
+- `quoteDispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes _messageBody) view returns (uint256)`
+- `process(bytes _metadata, bytes _message) payable`
+- `delivered(bytes32 _id) view returns (bool)`

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

@@ -0,0 +1,39 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Instadapp (`instadapp`)
+
+Flash loan aggregator that routes across Aave, Maker, Balancer and other sources to find the cheapest flash loan.
+
+| Fact | Value |
+| --- | --- |
+| Category | Infrastructure and standards |
+| Family | none |
+| Namespace | `Instadapp` on ethereum |
+| Chains | ethereum |
+| Document | [instadapp.md](../instadapp.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Instadapp` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's flashloanAggregator, `0xE6054aE0Dba269560061D736e7510Ce64fCD517d`.
+  require(Instadapp.FlashloanAggregator != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | flashloanAggregator | `0xE6054aE0Dba269560061D736e7510Ce64fCD517d` | `Instadapp.FlashloanAggregator` |
+
+## ABI
+
+### `FlashAggregatorABI`
+
+`import FlashAggregatorABI from "./protocols/instadapp/FlashAggregatorABI.json";` Speaks for: flashloanAggregator.
+
+- `flashLoan(address[] tokens, uint256[] amounts, uint256 route, bytes data, bytes extraData)`
+- `getRoutes() pure returns (uint16[] routes)`

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

@@ -0,0 +1,47 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Kelp DAO (`kelp`)
+
+Liquid restaking protocol built on EigenLayer. Deposit LSTs and receive rsETH, a liquid restaked token.
+
+| Fact | Value |
+| --- | --- |
+| Category | Restaking |
+| Family | none |
+| Namespace | `Kelp` on ethereum |
+| Chains | ethereum |
+| Document | [kelp.md](../kelp.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Ethereum, `Kelp` is a namespace: its contracts need no import.
+
+```sauce chain=ethereum
+function main() {
+  // Ethereum's lrtDepositPool, `0x036676389e48133B63a802f8635AD39E752D375D`.
+  require(Kelp.LRTDepositPool != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | lrtDepositPool | `0x036676389e48133B63a802f8635AD39E752D375D` | `Kelp.LRTDepositPool` |
+| [Ethereum](../../../sauce-chains/references/ethereum.md) | rsETH | `0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7` | `Kelp.RsETH` |
+
+## ABI
+
+### `LRTDepositPoolABI`
+
+`import LRTDepositPoolABI from "./protocols/kelp/LRTDepositPoolABI.json";` Speaks for: lrtDepositPool.
+
+- `depositAsset(address asset, uint256 depositAmount, uint256 minRSETHAmountExpected, string referralId)`
+- `getRsETHAmountToMint(address asset, uint256 amount) view returns (uint256 rsethAmountToMint)`
+
+### `RsETHABI`
+
+`import RsETHABI from "./protocols/kelp/RsETHABI.json";` Speaks for: rsETH.
+
+- `balanceOf(address account) view returns (uint256)`
+- `approve(address spender, uint256 amount) returns (bool)`

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

@@ -0,0 +1,39 @@
+<!-- Generated from the SDK's registries. Do not edit. -->
+
+# Kim (`kim`)
+
+Mode-native DEX with UniV2-style constant product pools. The primary trading venue on Mode Network with farming incentives.
+
+| Fact | Value |
+| --- | --- |
+| Category | DEX |
+| Family | none |
+| Namespace | `Kim` on mode |
+| Chains | mode |
+| Document | [kim.md](../kim.md): what it is for, how to choose it, its pitfalls |
+
+## In a program
+
+On Mode, `Kim` is a namespace: its contracts need no import.
+
+```sauce chain=mode
+function main() {
+  // Mode's v2Router, `0x5D61c537393cf21893BE619E36fC94cd73C77DD3`.
+  require(Kim.V2Router != 0n);
+}
+```
+
+## Deployments
+
+| Chain | Contract | Address | In a program |
+| --- | --- | --- | --- |
+| [Mode](../../../sauce-chains/references/mode.md) | v2Router | `0x5D61c537393cf21893BE619E36fC94cd73C77DD3` | `Kim.V2Router` |
+
+## ABI
+
+### `KimRouterABI`
+
+`import KimRouterABI from "./protocols/kim/KimRouterABI.json";` Speaks for: v2Router.
+
+- `swapExactTokensForTokensSupportingFeeOnTransferTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, address referrer, uint256 deadline)`
+- `addLiquidity(address tokenA, address tokenB, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB, uint256 liquidity)`