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

package/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to Vincent Ability Aave
+
+This document provides guidelines for contributing to the Vincent Ability Aave project.
+
+## Overview
+
+The Vincent Ability Aave is a ability to send deposit, withdraw or redeem Aave 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-aave
+```
+
+### Building the Lit Action
+
+Build the ability:
+
+```bash
+nx action:build ability-aave
+```
+
+### 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,113 @@
+# Vincent Aave Ability
+
+A comprehensive DeFi ability for interacting with Aave v3 protocol on Ethereum, built for the Vincent
+Scaffold SDK and Lit Actions execution environment.
+
+## Overview
+
+The Vincent Aave Ability enables secure, decentralized interactions with the Aave v3 lending protocol
+through Lit Actions. It supports all core Aave operations: supplying assets as collateral, borrowing
+against collateral, repaying debt, and withdrawing assets.
+
+## Features
+
+- Supply assets as collateral to earn interest
+- Withdraw supplied assets
+- Borrow against collateral with stable or variable rates
+- Repay borrowed assets
+- Multi-chain support (Ethereum, Polygon, Arbitrum, Optimism, Base, and more)
+- Integrated with Vincent Ability SDK for secure execution
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-ability-aave
+```
+
+## Usage
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk';
+import { bundledVincentAbility as aaveAbility } from '@lit-protocol/vincent-ability-aave';
+
+// Initialize the ability client
+const aaveAbilityClient = getVincentAbilityClient({
+  bundledVincentAbility: aaveAbility,
+  ethersSigner: yourSigner, // Your ethers signer
+});
+
+// Example: Supply WETH as collateral
+const supplyParams = {
+  operation: 'supply',
+  asset: '0xC558DBdd856501FCd9aaF1E62eae57A9F0629a3c', // WETH on Sepolia
+  amount: '0.01',
+  chain: 'sepolia',
+};
+
+// First run precheck
+const precheckRes = await aaveAbilityClient.precheck(supplyParams, {
+  delegatorPkpEthAddress: pkpAddress,
+});
+
+if (precheckRes.success) {
+  // Then execute
+  const executeRes = await aaveAbilityClient.execute(supplyParams, {
+    delegatorPkpEthAddress: pkpAddress,
+  });
+
+  if (executeRes.success) {
+    console.log('Transaction hash:', executeRes.result.data.txHash);
+  }
+}
+```
+
+## Parameters
+
+| Parameter          | Type                                            | Required | Description                                                    |
+| ------------------ | ----------------------------------------------- | -------- | -------------------------------------------------------------- |
+| `operation`        | `"supply" \| "withdraw" \| "borrow" \| "repay"` | ✅       | The Aave operation to perform                                  |
+| `asset`            | `string`                                        | ✅       | Token contract address (0x format)                             |
+| `amount`           | `string`                                        | ✅       | Amount as a string (e.g., "1.5")                               |
+| `chain`            | `string`                                        | ✅       | Chain identifier (e.g., "ethereum", "polygon")                 |
+| `interestRateMode` | `1 \| 2`                                        | ❌       | 1=Stable, 2=Variable (required for borrow/repay)               |
+| `onBehalfOf`       | `string`                                        | ❌       | Address to perform operation on behalf of (defaults to sender) |
+| `rpcUrl`           | `string`                                        | ❌       | Custom RPC URL for precheck validation                         |
+
+## Prerequisites
+
+- Node.js 16+ and npm/yarn
+- Sufficient token balance for the operation
+- Token approval for supply/repay operations
+- Properly configured PKP wallet with required permissions
+
+## Building
+
+```bash
+# Build the ability
+npm run build
+
+# Build all abilitys and policies
+npm run vincent:build
+```
+
+## Testing
+
+```bash
+# Run unit tests
+npm test
+
+# Run E2E tests
+npm run test:e2e
+
+# Reset test state
+npm run test:reset
+```
+
+## Contributing
+
+Contributions are welcome! 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](../../LICENSE) file for details.

package/dist/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to Vincent Ability Aave
+
+This document provides guidelines for contributing to the Vincent Ability Aave project.
+
+## Overview
+
+The Vincent Ability Aave is a ability to send deposit, withdraw or redeem Aave 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-aave
+```
+
+### Building the Lit Action
+
+Build the ability:
+
+```bash
+nx action:build ability-aave
+```
+
+### 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,113 @@
+# Vincent Aave Ability
+
+A comprehensive DeFi ability for interacting with Aave v3 protocol on Ethereum, built for the Vincent
+Scaffold SDK and Lit Actions execution environment.
+
+## Overview
+
+The Vincent Aave Ability enables secure, decentralized interactions with the Aave v3 lending protocol
+through Lit Actions. It supports all core Aave operations: supplying assets as collateral, borrowing
+against collateral, repaying debt, and withdrawing assets.
+
+## Features
+
+- Supply assets as collateral to earn interest
+- Withdraw supplied assets
+- Borrow against collateral with stable or variable rates
+- Repay borrowed assets
+- Multi-chain support (Ethereum, Polygon, Arbitrum, Optimism, Base, and more)
+- Integrated with Vincent Ability SDK for secure execution
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-ability-aave
+```
+
+## Usage
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk';
+import { bundledVincentAbility as aaveAbility } from '@lit-protocol/vincent-ability-aave';
+
+// Initialize the ability client
+const aaveAbilityClient = getVincentAbilityClient({
+  bundledVincentAbility: aaveAbility,
+  ethersSigner: yourSigner, // Your ethers signer
+});
+
+// Example: Supply WETH as collateral
+const supplyParams = {
+  operation: 'supply',
+  asset: '0xC558DBdd856501FCd9aaF1E62eae57A9F0629a3c', // WETH on Sepolia
+  amount: '0.01',
+  chain: 'sepolia',
+};
+
+// First run precheck
+const precheckRes = await aaveAbilityClient.precheck(supplyParams, {
+  delegatorPkpEthAddress: pkpAddress,
+});
+
+if (precheckRes.success) {
+  // Then execute
+  const executeRes = await aaveAbilityClient.execute(supplyParams, {
+    delegatorPkpEthAddress: pkpAddress,
+  });
+
+  if (executeRes.success) {
+    console.log('Transaction hash:', executeRes.result.data.txHash);
+  }
+}
+```
+
+## Parameters
+
+| Parameter          | Type                                            | Required | Description                                                    |
+| ------------------ | ----------------------------------------------- | -------- | -------------------------------------------------------------- |
+| `operation`        | `"supply" \| "withdraw" \| "borrow" \| "repay"` | ✅       | The Aave operation to perform                                  |
+| `asset`            | `string`                                        | ✅       | Token contract address (0x format)                             |
+| `amount`           | `string`                                        | ✅       | Amount as a string (e.g., "1.5")                               |
+| `chain`            | `string`                                        | ✅       | Chain identifier (e.g., "ethereum", "polygon")                 |
+| `interestRateMode` | `1 \| 2`                                        | ❌       | 1=Stable, 2=Variable (required for borrow/repay)               |
+| `onBehalfOf`       | `string`                                        | ❌       | Address to perform operation on behalf of (defaults to sender) |
+| `rpcUrl`           | `string`                                        | ❌       | Custom RPC URL for precheck validation                         |
+
+## Prerequisites
+
+- Node.js 16+ and npm/yarn
+- Sufficient token balance for the operation
+- Token approval for supply/repay operations
+- Properly configured PKP wallet with required permissions
+
+## Building
+
+```bash
+# Build the ability
+npm run build
+
+# Build all abilitys and policies
+npm run vincent:build
+```
+
+## Testing
+
+```bash
+# Run unit tests
+npm test
+
+# Run E2E tests
+npm run test:e2e
+
+# Reset test state
+npm run test:reset
+```
+
+## Contributing
+
+Contributions are welcome! 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](../../LICENSE) file for details.

package/dist/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@lit-protocol/vincent-ability-aave",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bgd-labs/aave-address-book": "^4.19.3",
+    "@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"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist/**",
+    "*.md"
+  ],
+  "type": "commonjs"
+}