@lit-protocol/vincent-ability-uniswap-swap 0.0.7-mma

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 1.0.2 (2025-07-08)
+
+### 🩹 Fixes
+
+- - Fixed `fail` results being returned as `success` in some cases ([867a2f85](https://github.com/LIT-Protocol/Vincent/commit/867a2f85))
+
+### 🧱 Updated Dependencies
+
+- Updated ability-sdk to 1.0.2
+- Updated app-sdk to 1.0.2
+- Updated policy-spending-limit to 1.0.2
+
+### ❤️ Thank You
+
+- Daryl Collins

package/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing to Vincent Ability Uniswap Swap
+
+This document provides guidelines for contributing to the Vincent Ability Uniswap Swap project.
+
+## Overview
+
+The Vincent Ability Uniswap Swap is an ability to trigger swaps on Uniswap 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-uniswap-swap
+```
+
+### Building the Lit Action
+
+Build the policy:
+
+```bash
+nx action:build ability-uniswap-swap
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the policy:
+
+```bash
+nx action:deploy ability-uniswap-swap
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Ability Development Guidelines
+
+1. Use the Vincent Ability SDK to create abilities
+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
+
+## Uniswap Integration
+
+This ability integrates with Uniswap V3 for token swaps. When working with this ability, consider:
+
+1. Understanding the Uniswap V3 SDK and how it works
+2. Handling token approvals before swaps
+3. Managing slippage and price impact
+4. Handling different token decimals
+5. Supporting multiple chains and Uniswap deployments
+
+## 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)
+- [Uniswap V3 Documentation](https://docs.uniswap.org/protocol/V3/introduction)
+- [Uniswap V3 SDK](https://docs.uniswap.org/sdk/v3/overview)

package/README.md

@@ -0,0 +1,127 @@
+# Vincent Ability Uniswap Swap
+
+An ability to trigger swaps on Uniswap from a Vincent app on behalf of the delegator.
+
+## Overview
+
+The Vincent Ability Uniswap Swap is part of the Vincent Abilities ecosystem and is built using the Vincent Ability SDK. It allows Vincent apps to execute token swaps on Uniswap V3 on behalf of users, enabling seamless integration with decentralized exchange functionality.
+
+## Features
+
+- Execute token swaps on Uniswap V3
+- Support for exact input and exact output swaps
+- Support for multiple token pairs
+- Integration with spending limit policies for enhanced security
+- Support for multiple chains and Uniswap deployments
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-ability-uniswap-swap
+```
+
+## Usage
+
+This ability can be used in Vincent apps to execute Uniswap swaps:
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk/abilityClient';
+import { bundledVincentAbility } from '@lit-protocol/vincent-ability-uniswap-swap';
+
+// 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 = {
+  chainId: '8453', // The chain where the tx will be executed
+  tokenIn: '0x1234...', // The input token address
+  amountIn: '1000000000000000000', // The input amount (in wei)
+  tokenOut: '0xabcd...', // The output token address
+  rpcUrl: 'https://mainnet.base.org', // The RPC to send the transaction through
+};
+
+// 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
+}
+```
+
+## Integration with Policies
+
+This ability is integrated with the Vincent Policy Spending Limit to enforce spending constraints:
+
+```typescript
+import {
+  createVincentAbilityPolicy,
+  createVincentAbility,
+  createPolicyMapFromAbilityPolicies,
+} from '@lit-protocol/vincent-ability-sdk';
+import { bundledVincentPolicy } from '@lit-protocol/vincent-policy-spending-limit';
+import { abilityParamsSchema } from '@lit-protocol/vincent-ability-uniswap-swap';
+
+const spendingLimitPolicy = createVincentAbilityPolicy({
+  abilityParamsSchema,
+  bundledVincentPolicy,
+  abilityParameterMappings: {
+    pkpEthAddress: 'pkpEthAddress',
+    ethRpcUrl: 'ethRpcUrl',
+    tokenInAddress: 'tokenAddress',
+    tokenInDecimals: 'tokenDecimals',
+    tokenInAmount: 'buyAmount',
+  },
+});
+
+export const uniswapSwapWithSpendingLimit = createVincentAbility({
+  abilityParamsSchema,
+  policyMap: createPolicyMapFromAbilityPolicies([spendingLimitPolicy]),
+  // ... rest of ability implementation
+});
+```
+
+## Prerequisites
+
+Before executing a swap, ensure that:
+
+1. The user has approved the input token for the Uniswap router
+2. The user has sufficient balance of the input token
+3. The user has delegated permission to the Vincent app to execute swaps
+
+You can use the Vincent Ability ERC20 Approval to handle token approvals:
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk/abilityClient';
+import { ERC20_APPROVAL_TOOL_IPFS_ID } from '@lit-protocol/vincent-ability-erc20-approval';
+
+// ... approve tokens before swap
+```
+
+## Building
+
+Run `nx build ability-uniswap-swap` to build the library.
+
+## Running unit tests
+
+Run `nx test ability-uniswap-swap` to execute the unit tests via [Jest](https://jestjs.io).
+
+## 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/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 1.0.2 (2025-07-08)
+
+### 🩹 Fixes
+
+- - Fixed `fail` results being returned as `success` in some cases ([867a2f85](https://github.com/LIT-Protocol/Vincent/commit/867a2f85))
+
+### 🧱 Updated Dependencies
+
+- Updated ability-sdk to 1.0.2
+- Updated app-sdk to 1.0.2
+- Updated policy-spending-limit to 1.0.2
+
+### ❤️ Thank You
+
+- Daryl Collins

package/dist/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing to Vincent Ability Uniswap Swap
+
+This document provides guidelines for contributing to the Vincent Ability Uniswap Swap project.
+
+## Overview
+
+The Vincent Ability Uniswap Swap is an ability to trigger swaps on Uniswap 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-uniswap-swap
+```
+
+### Building the Lit Action
+
+Build the policy:
+
+```bash
+nx action:build ability-uniswap-swap
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the policy:
+
+```bash
+nx action:deploy ability-uniswap-swap
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Ability Development Guidelines
+
+1. Use the Vincent Ability SDK to create abilities
+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
+
+## Uniswap Integration
+
+This ability integrates with Uniswap V3 for token swaps. When working with this ability, consider:
+
+1. Understanding the Uniswap V3 SDK and how it works
+2. Handling token approvals before swaps
+3. Managing slippage and price impact
+4. Handling different token decimals
+5. Supporting multiple chains and Uniswap deployments
+
+## 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)
+- [Uniswap V3 Documentation](https://docs.uniswap.org/protocol/V3/introduction)
+- [Uniswap V3 SDK](https://docs.uniswap.org/sdk/v3/overview)

package/dist/README.md

@@ -0,0 +1,127 @@
+# Vincent Ability Uniswap Swap
+
+An ability to trigger swaps on Uniswap from a Vincent app on behalf of the delegator.
+
+## Overview
+
+The Vincent Ability Uniswap Swap is part of the Vincent Abilities ecosystem and is built using the Vincent Ability SDK. It allows Vincent apps to execute token swaps on Uniswap V3 on behalf of users, enabling seamless integration with decentralized exchange functionality.
+
+## Features
+
+- Execute token swaps on Uniswap V3
+- Support for exact input and exact output swaps
+- Support for multiple token pairs
+- Integration with spending limit policies for enhanced security
+- Support for multiple chains and Uniswap deployments
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-ability-uniswap-swap
+```
+
+## Usage
+
+This ability can be used in Vincent apps to execute Uniswap swaps:
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk/abilityClient';
+import { bundledVincentAbility } from '@lit-protocol/vincent-ability-uniswap-swap';
+
+// 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 = {
+  chainId: '8453', // The chain where the tx will be executed
+  tokenIn: '0x1234...', // The input token address
+  amountIn: '1000000000000000000', // The input amount (in wei)
+  tokenOut: '0xabcd...', // The output token address
+  rpcUrl: 'https://mainnet.base.org', // The RPC to send the transaction through
+};
+
+// 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
+}
+```
+
+## Integration with Policies
+
+This ability is integrated with the Vincent Policy Spending Limit to enforce spending constraints:
+
+```typescript
+import {
+  createVincentAbilityPolicy,
+  createVincentAbility,
+  createPolicyMapFromAbilityPolicies,
+} from '@lit-protocol/vincent-ability-sdk';
+import { bundledVincentPolicy } from '@lit-protocol/vincent-policy-spending-limit';
+import { abilityParamsSchema } from '@lit-protocol/vincent-ability-uniswap-swap';
+
+const spendingLimitPolicy = createVincentAbilityPolicy({
+  abilityParamsSchema,
+  bundledVincentPolicy,
+  abilityParameterMappings: {
+    pkpEthAddress: 'pkpEthAddress',
+    ethRpcUrl: 'ethRpcUrl',
+    tokenInAddress: 'tokenAddress',
+    tokenInDecimals: 'tokenDecimals',
+    tokenInAmount: 'buyAmount',
+  },
+});
+
+export const uniswapSwapWithSpendingLimit = createVincentAbility({
+  abilityParamsSchema,
+  policyMap: createPolicyMapFromAbilityPolicies([spendingLimitPolicy]),
+  // ... rest of ability implementation
+});
+```
+
+## Prerequisites
+
+Before executing a swap, ensure that:
+
+1. The user has approved the input token for the Uniswap router
+2. The user has sufficient balance of the input token
+3. The user has delegated permission to the Vincent app to execute swaps
+
+You can use the Vincent Ability ERC20 Approval to handle token approvals:
+
+```typescript
+import { getVincentAbilityClient } from '@lit-protocol/vincent-app-sdk/abilityClient';
+import { ERC20_APPROVAL_TOOL_IPFS_ID } from '@lit-protocol/vincent-ability-erc20-approval';
+
+// ... approve tokens before swap
+```
+
+## Building
+
+Run `nx build ability-uniswap-swap` to build the library.
+
+## Running unit tests
+
+Run `nx test ability-uniswap-swap` to execute the unit tests via [Jest](https://jestjs.io).
+
+## 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,37 @@
+{
+  "name": "@lit-protocol/vincent-ability-uniswap-swap",
+  "version": "1.0.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@lit-protocol/vincent-policy-spending-limit": "workspace:*",
+    "@lit-protocol/vincent-ability-sdk": "workspace:*",
+    "@uniswap/sdk-core": "^7.7.2",
+    "ethers": "^5.8.0",
+    "tslib": "2.8.1",
+    "zod": "^3.25.64"
+  },
+  "peerDependencies": {
+    "@lit-protocol/vincent-app-sdk": "workspace:^"
+  },
+  "devDependencies": {
+    "@dotenvx/dotenvx": "^1.44.2",
+    "@lit-protocol/auth-helpers": "^7.2.0",
+    "@lit-protocol/constants": "^7.2.0",
+    "@lit-protocol/contracts-sdk": "^7.2.0",
+    "@lit-protocol/lit-node-client": "^7.0.8",
+    "esbuild": "^0.19.12",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
+    "ipfs-only-hash": "^4.0.0",
+    "viem": "^2.28.0"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist/**",
+    "*.md"
+  ],
+  "type": "commonjs"
+}