@lit-protocol/vincent-ability-morpho 0.0.7-mma

package/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to Vincent Ability Morpho
+
+This document provides guidelines for contributing to the Vincent Ability Morpho project.
+
+## Overview
+
+The Vincent Ability Morpho is a ability to send deposit, withdraw or redeem Morpho vault transactions and supply or withdrawCollateral Morpho market transactions from a Vincent app on behalf of the delegator. It's part of the Vincent Abilities ecosystem and is built using the Vincent Ability SDK.
+
+## Setup
+
+1. Follow the global setup instructions in the repository root [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+## Development Workflow
+
+### Testing
+
+Run tests:
+
+```bash
+nx test ability-morpho
+```
+
+### Building the Lit Action
+
+Build the ability:
+
+```bash
+nx action:build ability-morpho
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the ability:
+
+```bash
+nx action:deploy ability-erc20-approval
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Ability Development Guidelines
+
+1. Use the Vincent Ability SDK to create abilitys
+2. Define clear schemas for ability parameters
+3. Implement the ability lifecycle methods (precheck, execute)
+4. Handle errors gracefully
+5. Write comprehensive tests for all functionality
+6. Document the ability's purpose and usage
+
+## Integration with Policies
+
+This ability can be integrated with various Vincent Policies to enforce constraints. When developing or modifying the ability, consider how it will be used with policies such as:
+
+- Vincent Policy Spending Limit
+
+## Testing
+
+Write unit tests for all functionality:
+
+```bash
+pnpm test
+```
+
+## Documentation
+
+- Document the ability's purpose and usage
+- Update README.md when adding new features
+- Document the ability's parameters and behavior
+
+## Pull Request Process
+
+1. Ensure your code follows the coding standards
+2. Update documentation if necessary
+3. Include tests for new functionality
+4. Link any related issues in your pull request description
+5. Request a review from a maintainer
+
+## Additional Resources
+
+- [Vincent Documentation](https://docs.heyvincent.ai/)
+- [Vincent Ability SDK Documentation](../../libs/ability-sdk/README.md)
+- [ERC20 Standard](https://eips.ethereum.org/EIPS/eip-20)
+- [ERC4626 Standard](https://eips.ethereum.org/EIPS/eip-4626)

package/README.md

@@ -0,0 +1,136 @@
+# Vincent Ability Morpho
+
+An ability to interact with Morpho vaults (deposit, withdraw, redeem) or markets (supply,
+withdrawCollateral) 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
+
+```bash
+npm install @lit-protocol/vincent-ability-morpho
+```
+
+## Usage
+
+This ability can be used in Vincent apps to interact with Morpho vaults:
+
+```typescript
+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.VAULT_DEPOSIT, // The morpho operation, can apply to vault or market
+  marketId: '0x1234...', // The market id. Mandatory for market operations
+  vaultAddress: '0x1234...', // The Morpho vault or market contract address
+  amount: '1.0', // Amount to deposit/withdraw/redeem in the vault or supply/withdrawCollateral in the market
+  chain: 'base', // The chain where the contract is deployed
+  onBehalfOf: '0xabcd...', // Optional: address to receive vault shares (defaults to delegator)
+};
+
+// 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:
+
+1. The user has approved the vault to spend their tokens (for deposits)
+2. The user has sufficient balance of the required tokens
+3. The user has delegated permission to the Vincent app to execute operations
+
+You can use the Vincent Ability ERC20 Approval to handle token approvals
+
+## Vault Operations
+
+The ability supports the following operations on Morpho vaults:
+
+- **DEPOSIT** - Deposit assets into a Morpho vault to earn yield
+- **WITHDRAW** - Withdraw assets from a Morpho vault
+- **REDEEM** - Redeem vault shares for underlying assets
+
+And the following operations on Morpho markets:
+
+- **SUPPLY** - Supply collateral to a Morpho market to earn yield
+- **WITHDRAW_COLLATERAL** - Withdraw collateral from a Morpho market
+
+## Parameters
+
+| Parameter      | Type                                                                                                      | Required | Description                                                              |
+| -------------- | --------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------ |
+| `operation`    | `"vault_deposit" \| "vault_withdraw" \| "vault_redeem" \| "market_supply" \| "market_withdrawCollateral"` | ✅       | The vault or market operation to perform. Can use `MorphoOperation` enum |
+| `marketId`     | `string`                                                                                                  | ❌       | The market id. Mandatory for market operations                           |
+| `vaultAddress` | `string`                                                                                                  | ✅       | Morpho vault contract address (0x format)                                |
+| `amount`       | `string`                                                                                                  | ✅       | Amount as string (assets for deposit, shares for redeem)                 |
+| `chain`        | `string`                                                                                                  | ✅       | Chain identifier (e.g., "base")                                          |
+| `onBehalfOf`   | `string`                                                                                                  | ❌       | Address to receive tokens (defaults to sender)                           |
+| `rpcUrl`       | `string`                                                                                                  | ❌       | Custom RPC URL (for precheck validation)                                 |
+
+## 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](https://jestjs.io).
+
+For end-to-end testing with the Vincent SDK:
+
+```bash
+nx e2e ability-morpho-e2e
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](../../../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.

package/dist/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to Vincent Ability Morpho
+
+This document provides guidelines for contributing to the Vincent Ability Morpho project.
+
+## Overview
+
+The Vincent Ability Morpho is a ability to send deposit, withdraw or redeem Morpho vault transactions and supply or withdrawCollateral Morpho market transactions from a Vincent app on behalf of the delegator. It's part of the Vincent Abilities ecosystem and is built using the Vincent Ability SDK.
+
+## Setup
+
+1. Follow the global setup instructions in the repository root [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+## Development Workflow
+
+### Testing
+
+Run tests:
+
+```bash
+nx test ability-morpho
+```
+
+### Building the Lit Action
+
+Build the ability:
+
+```bash
+nx action:build ability-morpho
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the ability:
+
+```bash
+nx action:deploy ability-erc20-approval
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Ability Development Guidelines
+
+1. Use the Vincent Ability SDK to create abilitys
+2. Define clear schemas for ability parameters
+3. Implement the ability lifecycle methods (precheck, execute)
+4. Handle errors gracefully
+5. Write comprehensive tests for all functionality
+6. Document the ability's purpose and usage
+
+## Integration with Policies
+
+This ability can be integrated with various Vincent Policies to enforce constraints. When developing or modifying the ability, consider how it will be used with policies such as:
+
+- Vincent Policy Spending Limit
+
+## Testing
+
+Write unit tests for all functionality:
+
+```bash
+pnpm test
+```
+
+## Documentation
+
+- Document the ability's purpose and usage
+- Update README.md when adding new features
+- Document the ability's parameters and behavior
+
+## Pull Request Process
+
+1. Ensure your code follows the coding standards
+2. Update documentation if necessary
+3. Include tests for new functionality
+4. Link any related issues in your pull request description
+5. Request a review from a maintainer
+
+## Additional Resources
+
+- [Vincent Documentation](https://docs.heyvincent.ai/)
+- [Vincent Ability SDK Documentation](../../libs/ability-sdk/README.md)
+- [ERC20 Standard](https://eips.ethereum.org/EIPS/eip-20)
+- [ERC4626 Standard](https://eips.ethereum.org/EIPS/eip-4626)

package/dist/README.md

@@ -0,0 +1,136 @@
+# Vincent Ability Morpho
+
+An ability to interact with Morpho vaults (deposit, withdraw, redeem) or markets (supply,
+withdrawCollateral) 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
+
+```bash
+npm install @lit-protocol/vincent-ability-morpho
+```
+
+## Usage
+
+This ability can be used in Vincent apps to interact with Morpho vaults:
+
+```typescript
+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.VAULT_DEPOSIT, // The morpho operation, can apply to vault or market
+  marketId: '0x1234...', // The market id. Mandatory for market operations
+  vaultAddress: '0x1234...', // The Morpho vault or market contract address
+  amount: '1.0', // Amount to deposit/withdraw/redeem in the vault or supply/withdrawCollateral in the market
+  chain: 'base', // The chain where the contract is deployed
+  onBehalfOf: '0xabcd...', // Optional: address to receive vault shares (defaults to delegator)
+};
+
+// 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:
+
+1. The user has approved the vault to spend their tokens (for deposits)
+2. The user has sufficient balance of the required tokens
+3. The user has delegated permission to the Vincent app to execute operations
+
+You can use the Vincent Ability ERC20 Approval to handle token approvals
+
+## Vault Operations
+
+The ability supports the following operations on Morpho vaults:
+
+- **DEPOSIT** - Deposit assets into a Morpho vault to earn yield
+- **WITHDRAW** - Withdraw assets from a Morpho vault
+- **REDEEM** - Redeem vault shares for underlying assets
+
+And the following operations on Morpho markets:
+
+- **SUPPLY** - Supply collateral to a Morpho market to earn yield
+- **WITHDRAW_COLLATERAL** - Withdraw collateral from a Morpho market
+
+## Parameters
+
+| Parameter      | Type                                                                                                      | Required | Description                                                              |
+| -------------- | --------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------ |
+| `operation`    | `"vault_deposit" \| "vault_withdraw" \| "vault_redeem" \| "market_supply" \| "market_withdrawCollateral"` | ✅       | The vault or market operation to perform. Can use `MorphoOperation` enum |
+| `marketId`     | `string`                                                                                                  | ❌       | The market id. Mandatory for market operations                           |
+| `vaultAddress` | `string`                                                                                                  | ✅       | Morpho vault contract address (0x format)                                |
+| `amount`       | `string`                                                                                                  | ✅       | Amount as string (assets for deposit, shares for redeem)                 |
+| `chain`        | `string`                                                                                                  | ✅       | Chain identifier (e.g., "base")                                          |
+| `onBehalfOf`   | `string`                                                                                                  | ❌       | Address to receive tokens (defaults to sender)                           |
+| `rpcUrl`       | `string`                                                                                                  | ❌       | Custom RPC URL (for precheck validation)                                 |
+
+## 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](https://jestjs.io).
+
+For end-to-end testing with the Vincent SDK:
+
+```bash
+nx e2e ability-morpho-e2e
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](../../../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.

package/dist/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@lit-protocol/vincent-ability-morpho",
+  "version": "0.0.6",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "vault-search": "tsx examples/vault-search.ts"
+  },
+  "dependencies": {
+    "@lit-protocol/vincent-scaffold-sdk": "^1.1.6",
+    "@lit-protocol/vincent-ability-sdk": "workspace:*",
+    "ethers": "^5.8.0",
+    "tslib": "2.8.1",
+    "zod": "^3.25.64"
+  },
+  "peerDependencies": {
+    "@lit-protocol/vincent-app-sdk": "workspace:^"
+  },
+  "devDependencies": {
+    "esbuild": "^0.19.12",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
+    "ipfs-only-hash": "^4.0.0",
+    "tsx": "^4.19.4"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist/**",
+    "*.md"
+  ],
+  "type": "commonjs"
+}