@morpho-org/bundler-sdk-viem 1.12.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Morpho Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @morpho-org/bundler-sdk-viem
+
+<a href="https://www.npmjs.com/package/@morpho-org/bundler-sdk-viem">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/@morpho-org/bundler-sdk-viem?colorA=21262d&colorB=21262d&style=flat">
+        <img src="https://img.shields.io/npm/v/@morpho-org/bundler-sdk-viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
+    </picture>
+</a>
+<a href="https://github.com/morpho-org/bundler-sdk-viem/blob/main/LICENSE">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/@morpho-org/bundler-sdk-viem?colorA=21262d&colorB=21262d&style=flat">
+        <img src="https://img.shields.io/npm/l/@morpho-org/bundler-sdk-viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
+    </picture>
+</a>
+<a href="https://www.npmjs.com/package/@morpho-org/bundler-sdk-viem">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/dm/@morpho-org/bundler-sdk-viem?colorA=21262d&colorB=21262d&style=flat">
+        <img src="https://img.shields.io/npm/dm/@morpho-org/bundler-sdk-viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Downloads per month">
+    </picture>
+</a>
+<br />
+<br />
+
+Viem-based extension of `@morpho-org/simulation-sdk` that exports utilities to transform simple interactions on Morpho (such as `Blue_Borrow`) and Morpho Vaults (such as `MetaMorpho_Deposit`) into the required bundles (with ERC20 approvals, transfers, etc) to submit to the bundler onchain.
+
+## Installation
+
+```bash
+npm install @morpho-org/bundler-sdk-viem
+```
+
+```bash
+yarn add @morpho-org/bundler-sdk-viem
+```

package/lib/BundlerAction.d.ts

@@ -0,0 +1,320 @@
+import { type Address, type Hex } from "viem";
+import type { Action, Authorization, MarketParams, Permit2PermitSingle, ReallocationWithdrawal } from "./types/index.js";
+export type BundlerCall = Hex;
+/**
+ * Namespace to easily encode calls to the Bundler contract, using ethers.
+ */
+export declare namespace BundlerAction {
+    function encode({ type, args }: Action): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to transfer native tokens (ETH on ethereum, MATIC on polygon, etc).
+     * @param recipient The address to send native tokens to.
+     * @param amount The amount of native tokens to send (in wei).
+     */
+    function nativeTransfer(recipient: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to transfer ERC20 tokens.
+     * @param asset The address of the ERC20 token to transfer.
+     * @param recipient The address to send tokens to.
+     * @param amount The amount of tokens to send.
+     */
+    function erc20Transfer(asset: Address, recipient: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to transfer ERC20 tokens from the sender to the Bundler.
+     * @param asset The address of the ERC20 token to transfer.
+     * @param amount The amount of tokens to send.
+     */
+    function erc20TransferFrom(asset: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to permit an ERC20 token.
+     * @param asset The address of the ERC20 token to permit.
+     * @param amount The amount of tokens to permit.
+     * @param deadline The timestamp until which the signature is valid.
+     * @param signature The Ethers signature to permit the tokens.
+     * @param skipRevert Whether to allow the permit to revert without making the whole multicall revert.
+     */
+    function permit(asset: Address, amount: bigint, deadline: bigint, signature: Hex, skipRevert: boolean): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to permit DAI.
+     * @param nonce The permit nonce used.
+     * @param expiry The timestamp until which the signature is valid.
+     * @param allowed The amount of DAI to permit.
+     * @param signature The Ethers signature to permit the tokens.
+     * @param skipRevert Whether to allow the permit to revert without making the whole multicall revert.
+     */
+    function permitDai(nonce: bigint, expiry: bigint, allowed: boolean, signature: Hex, skipRevert: boolean): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to permit ERC20 tokens via Permit2.
+     * @param permitSingle The permit details to submit to Permit2.
+     * @param signature The Ethers signature to permit the tokens.
+     * @param skipRevert Whether to allow the permit to revert without making the whole multicall revert.
+     */
+    function approve2(permitSingle: Permit2PermitSingle, signature: Hex, skipRevert: boolean): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to transfer ERC20 tokens via Permit2 from the sender to the Bundler.
+     * @param asset The address of the ERC20 token to transfer.
+     * @param amount The amount of tokens to send.
+     */
+    function transferFrom2(asset: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to wrap ERC20 tokens via the provided ERC20Wrapper.
+     * @param wrapper The address of the ERC20 wrapper token.
+     * @param amount The amount of tokens to send.
+     */
+    function erc20WrapperDepositFor(wrapper: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to unwrap ERC20 tokens from the provided ERC20Wrapper.
+     * @param wrapper The address of the ERC20 wrapper token.
+     * @param account The address to send the underlying ERC20 tokens.
+     * @param amount The amount of tokens to send.
+     */
+    function erc20WrapperWithdrawTo(wrapper: Address, account: Address, amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to mint shares of the provided ERC4626 vault.
+     * @param erc4626 The address of the ERC4626 vault.
+     * @param shares The amount of shares to mint.
+     * @param maxAssets The maximum amount of assets to deposit (protects the sender from unexpected slippage).
+     * @param receiver The address to send the shares to.
+     */
+    function erc4626Mint(erc4626: Address, shares: bigint, maxAssets: bigint, receiver: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to deposit assets into the provided ERC4626 vault.
+     * @param erc4626 The address of the ERC4626 vault.
+     * @param assets The amount of assets to deposit.
+     * @param minShares The minimum amount of shares to mint (protects the sender from unexpected slippage).
+     * @param receiver The address to send the shares to.
+     */
+    function erc4626Deposit(erc4626: Address, assets: bigint, minShares: bigint, receiver: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to withdraw assets from the provided ERC4626 vault.
+     * @param erc4626 The address of the ERC4626 vault.
+     * @param assets The amount of assets to withdraw.
+     * @param maxShares The maximum amount of shares to redeem (protects the sender from unexpected slippage).
+     * @param receiver The address to send the assets to.
+     */
+    function erc4626Withdraw(erc4626: Address, assets: bigint, maxShares: bigint, receiver: Address, owner: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to redeem shares from the provided ERC4626 vault.
+     * @param erc4626 The address of the ERC4626 vault.
+     * @param shares The amount of shares to redeem.
+     * @param minAssets The minimum amount of assets to withdraw (protects the sender from unexpected slippage).
+     * @param receiver The address to send the assets to.
+     */
+    function erc4626Redeem(erc4626: Address, shares: bigint, minAssets: bigint, receiver: Address, owner: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to authorize an account on Morpho Blue.
+     * @param authorization The authorization details to submit to Morpho Blue.
+     * @param signature The Ethers signature to authorize the account.
+     * @param skipRevert Whether to allow the authorization call to revert without making the whole multicall revert.
+     */
+    function morphoSetAuthorizationWithSig(authorization: Authorization, signature: Hex, skipRevert: boolean): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to supply to a Morpho Blue market.
+     * @param market The market params to supply to.
+     * @param assets The amount of assets to supply.
+     * @param shares The amount of supply shares to mint.
+     * @param slippageAmount The maximum (resp. minimum) amount of assets (resp. supply shares) to supply (resp. mint) (protects the sender from unexpected slippage).
+     * @param onBehalf The address to supply on behalf of.
+     * @param callbackCalls The array of calls to execute inside Morpho Blue's `onMorphoSupply` callback.
+     */
+    function morphoSupply(market: MarketParams, assets: bigint, shares: bigint, slippageAmount: bigint, onBehalf: Address, callbackCalls: BundlerCall[]): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to supply collateral to a Morpho Blue market.
+     * @param market The market params to supply to.
+     * @param assets The amount of assets to supply.
+     * @param onBehalf The address to supply on behalf of.
+     * @param callbackCalls The array of calls to execute inside Morpho Blue's `onMorphoSupplyCollateral` callback.
+     */
+    function morphoSupplyCollateral(market: MarketParams, assets: bigint, onBehalf: Address, callbackCalls: BundlerCall[]): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to borrow from a Morpho Blue market.
+     * @param market The market params to borrow from.
+     * @param assets The amount of assets to borrow.
+     * @param shares The amount of borrow shares to mint.
+     * @param slippageAmount The minimum (resp. maximum) amount of assets (resp. borrow shares) to borrow (resp. mint) (protects the sender from unexpected slippage).
+     * @param receiver The address to send borrowed tokens to.
+     */
+    function morphoBorrow(market: MarketParams, assets: bigint, shares: bigint, slippageAmount: bigint, receiver: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to repay to a Morpho Blue market.
+     * @param market The market params to repay to.
+     * @param assets The amount of assets to repay.
+     * @param shares The amount of borrow shares to redeem.
+     * @param slippageAmount The maximum (resp. minimum) amount of assets (resp. borrow shares) to repay (resp. redeem) (protects the sender from unexpected slippage).
+     * @param onBehalf The address to repay on behalf of.
+     * @param callbackCalls The array of calls to execute inside Morpho Blue's `onMorphoSupply` callback.
+     */
+    function morphoRepay(market: MarketParams, assets: bigint, shares: bigint, slippageAmount: bigint, onBehalf: Address, callbackCalls: BundlerCall[]): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to withdraw from a Morpho Blue market.
+     * @param market The market params to withdraw from.
+     * @param assets The amount of assets to withdraw.
+     * @param shares The amount of supply shares to redeem.
+     * @param slippageAmount The minimum (resp. maximum) amount of assets (resp. supply shares) to withdraw (resp. redeem) (protects the sender from unexpected slippage).
+     * @param receiver The address to send withdrawn tokens to.
+     */
+    function morphoWithdraw(market: MarketParams, assets: bigint, shares: bigint, slippageAmount: bigint, receiver: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to withdraw collateral from a Morpho Blue market.
+     * @param market The market params to withdraw from.
+     * @param assets The amount of assets to withdraw.
+     * @param receiver The address to send withdrawn tokens to.
+     */
+    function morphoWithdrawCollateral(market: MarketParams, assets: bigint, receiver: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to flash loan from Morpho Blue.
+     * @param asset The address of the ERC20 token to flash loan.
+     * @param amount The amount of tokens to flash loan.
+     * @param callbackCalls The array of calls to execute inside Morpho Blue's `onMorphoFlashLoan` callback.
+     */
+    function morphoFlashLoan(asset: Address, amount: bigint, callbackCalls: BundlerCall[]): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to trigger a public reallocation on the PublicAllocator.
+     * @param publicAllocator The address of the PublicAllocator to use.
+     * @param vault The vault to reallocate.
+     * @param value The value of the call. Can be used to pay the vault reallocation fees.
+     * @param withdrawals The array of withdrawals to perform, before supplying everything to the supply market.
+     * @param supplyMarketParams The market params to reallocate to.
+     */
+    function metaMorphoReallocateTo(publicAllocator: Address, vault: Address, value: bigint, withdrawals: ReallocationWithdrawal[], supplyMarketParams: MarketParams): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to claim rewards from the Universal Rewards Distributor.
+     * @param distributor The address of the distributor to claim rewards from.
+     * @param account The address to claim rewards for.
+     * @param reward The address of the reward token to claim.
+     * @param amount The amount of rewards to claim.
+     * @param proof The Merkle proof to claim the rewards.
+     * @param skipRevert Whether to allow the claim to revert without making the whole multicall revert.
+     */
+    function urdClaim(distributor: Address, account: Address, reward: Address, amount: bigint, proof: Hex[], skipRevert: boolean): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to wrap native tokens (ETH to WETH on ethereum, MATIC to WMATIC on polygon, etc).
+     * @param amount The amount of native tokens to wrap (in wei).
+     */
+    function wrapNative(amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to unwrap native tokens (WETH to ETH on ethereum, WMATIC to MATIC on polygon, etc).
+     * @param amount The amount of native tokens to unwrap (in wei).
+     */
+    function unwrapNative(amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to stake native tokens using Lido (ETH to stETH on ethereum).
+     * @param amount The amount of native tokens to stake (in wei).
+     * @param minShares The minimum amount of shares to mint (protects the sender from unexpected slippage).
+     * @param referral The referral address to use.
+     */
+    function stakeEth(amount: bigint, minShares: bigint, referral: Address): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to wrap stETH (stETH to wstETH on ethereum).
+     * @param amount The amount of stETH to wrap (in wei).
+     */
+    function wrapStEth(amount: bigint): BundlerCall;
+    /**
+     * Encodes a call to the Bundler to unwrap wstETH (wstETH to stETH on ethereum).
+     * @param amount The amount of wstETH to unwrap (in wei).
+     */
+    function unwrapStEth(amount: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV2MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to repay a debt on AaveV2.
+     * @param asset The debt asset to repay.
+     * @param amount The amount of debt to repay.
+     * @param rateMode The interest rate mode used by the debt to repay.
+     */
+    function aaveV2Repay(asset: Address, amount: bigint, rateMode: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV2MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdrawn from AaveV2.
+     * @param asset The asset to withdraw.
+     * @param amount The amount of asset to withdraw.
+     */
+    function aaveV2Withdraw(asset: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to repay a debt on AaveV3.
+     * @param asset The debt asset to repay.
+     * @param amount The amount of debt to repay.
+     * @param rateMode The interest rate mode used by the debt to repay.
+     */
+    function aaveV3Repay(asset: Address, amount: bigint, rateMode: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdrawn from AaveV3.
+     * @param asset The asset to withdraw.
+     * @param amount The amount of asset to withdraw.
+     */
+    function aaveV3Withdraw(asset: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3OptimizerMigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to repay a debt on Morpho's AaveV3Optimizer.
+     * @param underlying The underlying debt asset to repay.
+     * @param amount The amount of debt to repay.
+     * @param maxIterations The maximum amount of iterations to use for the repayment.
+     */
+    function aaveV3OptimizerRepay(underlying: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3OptimizerMigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdraw from Morpho's AaveV3Optimizer.
+     * @param underlying The underlying asset to withdraw.
+     * @param amount The amount to withdraw.
+     * @param maxIterations The maximum amount of iterations to use for the withdrawal.
+     */
+    function aaveV3OptimizerWithdraw(underlying: Address, amount: bigint, maxIterations: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3OptimizerMigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdraw collateral from Morpho's AaveV3Optimizer.
+     * @param underlying The underlying asset to withdraw.
+     * @param amount The amount to withdraw.
+     */
+    function aaveV3OptimizerWithdrawCollateral(underlying: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on AaveV3OptimizerMigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to approve the Bundler as the sender's manager on Morpho's AaveV3Optimizer.
+     * @param isApproved Whether the manager is approved.
+     * @param nonce The nonce used to sign.
+     * @param deadline The timestamp until which the signature is valid.
+     * @param signature The Ethers signature to submit.
+     * @param skipRevert Whether to allow the signature to revert without making the whole multicall revert.
+     */
+    function aaveV3OptimizerApproveManagerWithSig(isApproved: boolean, nonce: bigint, deadline: bigint, signature: Hex, skipRevert: boolean): BundlerCall;
+    /**
+     * ! Only available on CompoundV2MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to repay a debt on CompoundV2.
+     * @param cToken The cToken on which to repay the debt.
+     * @param amount The amount of debt to repay.
+     */
+    function compoundV2Repay(cToken: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on CompoundV2MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdraw collateral from CompoundV2.
+     * @param cToken The cToken on which to withdraw.
+     * @param amount The amount to withdraw.
+     */
+    function compoundV2Redeem(cToken: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on CompoundV3MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to repay a debt on CompoundV3.
+     * @param instance The CompoundV3 instance on which to repay the debt.
+     * @param amount The amount of debt to repay.
+     */
+    function compoundV3Repay(instance: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on CompoundV3MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to withdraw collateral from CompoundV3.
+     * @param instance The CompoundV3 instance on which to withdraw.
+     * @param amount The amount to withdraw.
+     */
+    function compoundV3WithdrawFrom(instance: Address, asset: Address, amount: bigint): BundlerCall;
+    /**
+     * ! Only available on CompoundV3MigrationBundler instances (not the main Bundler contract!).
+     * Encodes a call to the Bundler to allow the Bundler to act on the sender's position on CompoundV3.
+     * @param instance The CompoundV3 instance on which to submit the signature.
+     * @param isAllowed Whether the manager is allowed.
+     * @param nonce The nonce used to sign.
+     * @param expiry The timestamp until which the signature is valid.
+     * @param signature The Ethers signature to submit.
+     * @param skipRevert Whether to allow the signature to revert without making the whole multicall revert.
+     */
+    function compoundV3AllowBySig(instance: Address, isAllowed: boolean, nonce: bigint, expiry: bigint, signature: Hex, skipRevert: boolean): BundlerCall;
+}
+export default BundlerAction;