@lit-protocol/vincent-ability-morpho
v1.1.8
Published
A ability to interact with Morpho vaults (deposit, withdraw, redeem) from a Vincent app on behalf of the delegator.
Downloads
353
Keywords
Readme
Vincent Ability Morpho
A ability to interact with Morpho vaults (deposit, withdraw, redeem) from a Vincent app on behalf of the delegator.
Overview
The Vincent Ability Morpho is part of the Vincent Abilities ecosystem and is built using the Vincent Ability SDK. It allows Vincent apps to interact with Morpho vaults on behalf of users, enabling seamless integration with DeFi yield strategies.
Features
- Deposit assets into Morpho vaults
- Withdraw assets from Morpho vaults
- Redeem vault shares for underlying assets
- Support for multiple chains including Ethereum, Base, and Arbitrum
- Integration with spending limit policies for enhanced security
Installation
npm install @lit-protocol/vincent-ability-morphoUsage
This ability can be used in Vincent apps to interact with Morpho vaults:
import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk/abilityClient';
import { bundledVincentAbility, MorphoOperation } from '@lit-protocol/vincent-ability-morpho';
// One of delegatee signers from your app's Vincent Dashboard
const delegateeSigner = new ethers.Wallet('YOUR_DELEGATEE_PRIVATE_KEY');
// Initialize the Vincent Ability Client
const abilityClient = getVincentAbilityClient({
ethersSigner: delegateeSigner,
bundledVincentAbility,
});
const delegatorPkpEthAddress = '0x09182301238'; // The delegator PKP Eth Address
const abilityParams = {
operation: MorphoOperation.DEPOSIT, // 'approve', 'deposit', or 'redeem'
vaultAddress: '0x1234...', // The Morpho vault address
amount: '100000', // Amount to approve/withdraw/redeem
chain: 'base', // The chain where the vault is deployed
};
// Run precheck to see if ability should be executed
const precheckResult = await client.precheck(abilityParams, {
delegatorPkpEthAddress,
});
if (precheckResult.success === true) {
// Execute the Vincent Ability
const executeResult = await client.execute(abilityParams, {
delegatorPkpEthAddress,
});
// ...ability has executed, you can check `executeResult` for details
}Prerequisites
Before executing vault operations, ensure that:
- The user has approved the vault to spend their tokens (for deposits). You can use the MorphoOperation.APPROVE to handle token approvals
- The user has sufficient balance of the required tokens
- The user has delegated permission to the Vincent app to execute operations
Note: The ability can subsidize gas for the user using Alchemy. If not doing so, the user will also have to pay for the gas.
Vault Operations
The ability supports the following operations on Morpho vaults:
- APPROVE - Approve a Morpho vault to take your assets on deposit
- DEPOSIT - Deposit assets into a Morpho vault to earn yield
- REDEEM - Redeem vault shares for underlying assets
Parameters
| Parameter | Type | Required | Description |
| --------------------------- | ------------------------------------ | -------- | ------------------------------------------------------------------------------------------------ |
| operation | "approve" \| "deposit" \| "redeem" | ✅ | The vault operation to perform |
| vaultAddress | string | ✅ | Morpho vault contract address (0x format) |
| amount | string | ✅ | Amount as string in units, no decimal places (assets for deposit or withdraw, shares for redeem) |
| chain | string | ✅ | Chain identifier (e.g., "base") |
| rpcUrl | string | ❌ | Custom RPC URL (for precheck validation) |
| alchemyGasSponsor | boolean | ❌ | Whether to use Alchemy's gas sponsorship (EIP-7702) |
| alchemyGasSponsorApiKey | string | ❌ | Alchemy API key for gas sponsorship (required if alchemyGasSponsor is true) |
| alchemyGasSponsorPolicyId | string | ❌ | Alchemy gas policy ID for sponsorship (required if alchemyGasSponsor is true) |
Supported Networks
The ability supports all chains where Morpho is deployed, including:
- Ethereum Mainnet
- Base
- Arbitrum
- Optimism
- Polygon
Building
Run nx build ability-morpho to build the library.
Testing
Run nx test ability-morpho to execute the unit tests via Jest.
For end-to-end testing with the Vincent SDK:
nx e2e ability-morpho-e2eContributing
Please see CONTRIBUTING.md for guidelines on how to contribute to this project.
License
This project is licensed under the MIT License - see the LICENSE file for details.
