Merge pull request #353 from LIT-Protocol/feat/multistep-uniswap-ability

Feat/multistep uniswap ability

Author: spacesailor24

.nx/version-plans/version-plan-1759470078312.md

@@ -0,0 +1,5 @@
+---
+ability-sdk: minor
+---
+
+Export new methods: sponsoredGasContractCall and sponsoredGasRawTransaction to allow for Alchemy gas sponsorship of broadcast transaction from a Vincent Ability

.nx/version-plans/version-plan-1759470137894.md

@@ -0,0 +1,5 @@
+---
+ability-uniswap-swap: major
+---
+
+Adds new Ability parameters that dictate what the Ability does (e.g. ERC20 allowance approvals, Uniswap Swaps, or both). Additionally, adds support for Alchemy gas sponsorship of both ERC20 approval and Uniswap swap txs. The Ability now returns failure reponses for known errors like insufficient balances or allowances

packages/apps/abilities-e2e/test-e2e/swap.spec.ts

@@ -1,3 +1,3 @@
 {
-  "ipfsCid": "QmTvPwj165nh8ps6Zxfi6yhS4qpb5aQQGV5vj7i4Zfp5cV"
+  "ipfsCid": "QmS5hyaSvdcjgMDeEfybzTESHpRTj4aJsagqfu6VLkVVcB"
 }

packages/apps/ability-uniswap-swap/src/generated/lit-action-prepare.js

@@ -1,6 +1,6 @@
 {
-  "ipfsCid": "QmTHxA1szqumjfndvB8D59qRPhrhMsJWr6jTq81RFeaf1D",
-  "pkpTokenId": "44317236434387694874531930309258310489704884861516325543415539434780397033801",
-  "pkpPublicKey": "0x04c2aed3bbbe57674ec7a0b2e094d8e365415508dd9725bf1b7c8a526e58a75c2e7f2a830a50ac7fc5d26610ba23ad81be1eb8a032f3f813db67d2324df6ecd650",
-  "pkpEthAddress": "0xa7A476c03a04C1aa86Ad2319594376a124E7f598"
+  "ipfsCid": "QmcvRUyTiRwaw5CzuYhFwrJbUkfegMS9gnFh8Z5ciBgg1u",
+  "pkpTokenId": "111900264250323532308709640357423227654246808641396976251148600630865853586661",
+  "pkpPublicKey": "0x04e68f03f0dd111c94f4dd890c20f06edf4256050452256fea1a214c1a7f6acfaaf25f5f152caaf5d1774e1f2fd9bac4da33fcb75a6ce2acef3e8eb34d7ef0eabc",
+  "pkpEthAddress": "0xbe37409C68283fAA2eC57e6c1EC0dD96421A391B"
 }

packages/apps/ability-uniswap-swap/src/generated/lit-action.js

@@ -2,3 +2,15 @@ export { bundledVincentAbility } from './generated/vincent-bundled-ability';
 export { getSignedUniswapQuote } from './lib/prepare/get-signed-uniswap-quote';
 export { validateSignedUniswapQuote } from './lib/prepare/validate-signed-uniswap-quote';
 export type * from './lib/prepare/types';
+export type {
+  CheckNativeTokenBalanceResult,
+  CheckNativeTokenBalanceResultSuccess,
+  CheckNativeTokenBalanceResultFailure,
+  CheckErc20BalanceResult,
+  CheckErc20BalanceResultSuccess,
+  CheckErc20BalanceResultFailure,
+  CheckErc20AllowanceResult,
+  CheckErc20AllowanceResultSuccess,
+  CheckErc20AllowanceResultFailure,
+} from './lib/types';
+export { AbilityAction } from './lib/types';

packages/apps/ability-uniswap-swap/src/generated/vincent-ability-metadata.json

@@ -1,31 +1,44 @@
 import { ethers } from 'ethers';
-import { getErc20Contract } from './getErc20Contract';
+
+import { getErc20Allowance } from '../ability-helpers/get-erc20-allowance';
+import { CheckErc20AllowanceResult } from '../types';
 
 export const checkErc20Allowance = async ({
   provider,
   tokenAddress,
   owner,
   spender,
-  tokenAmount,
+  requiredAllowance,
 }: {
   provider: ethers.providers.StaticJsonRpcProvider;
   tokenAddress: string;
   owner: string;
   spender: string;
-  tokenAmount: bigint;
-}): Promise<ethers.BigNumber> => {
-  const contract = getErc20Contract(tokenAddress, provider);
-
-  const currentAllowance = await contract.allowance(owner, spender);
-
-  // Convert bigint to BigNumber for comparison
-  const tokenAmountBN = ethers.BigNumber.from(tokenAmount.toString());
+  requiredAllowance: ethers.BigNumber;
+}): Promise<CheckErc20AllowanceResult> => {
+  const currentAllowance = await getErc20Allowance({
+    provider,
+    tokenAddress,
+    owner,
+    spender,
+  });
 
-  if (currentAllowance.lt(tokenAmountBN)) {
-    throw new Error(
-      `Address ${owner} has insufficient ERC20 allowance for spender ${spender} for token ${tokenAddress} (checkErc20Allowance)`,
-    );
+  if (currentAllowance.lt(requiredAllowance)) {
+    return {
+      success: false,
+      reason: `[checkErc20Allowance] Address ${owner} has insufficient ERC20 allowance for spender ${spender} for token ${tokenAddress}`,
+      spenderAddress: spender,
+      tokenAddress: tokenAddress,
+      requiredAllowance,
+      currentAllowance,
+    };
   }
 
-  return currentAllowance;
+  return {
+    success: true,
+    spenderAddress: spender,
+    tokenAddress: tokenAddress,
+    requiredAllowance,
+    currentAllowance,
+  };
 };

packages/apps/ability-uniswap-swap/src/generated/vincent-prepare-metadata.json

@@ -0,0 +1,37 @@
+import { ethers } from 'ethers';
+
+import { getErc20Contract } from '../ability-helpers/get-erc20-contract';
+import { CheckErc20BalanceResult } from '../types';
+
+export const checkErc20Balance = async ({
+  provider,
+  pkpEthAddress,
+  tokenAddress,
+  requiredTokenAmount,
+}: {
+  provider: ethers.providers.StaticJsonRpcProvider;
+  pkpEthAddress: string;
+  tokenAddress: string;
+  requiredTokenAmount: ethers.BigNumber;
+}): Promise<CheckErc20BalanceResult> => {
+  const contract = getErc20Contract(tokenAddress, provider);
+
+  const tokenBalance: ethers.BigNumber = await contract.balanceOf(pkpEthAddress);
+
+  if (tokenBalance.lt(requiredTokenAmount)) {
+    return {
+      success: false,
+      reason: `pkpEthAddress (${pkpEthAddress}) has insufficient balance of tokenIn (${tokenAddress}). Wanted ${requiredTokenAmount}, but only have ${tokenBalance}`,
+      tokenAddress,
+      requiredTokenAmount,
+      tokenBalance,
+    };
+  }
+
+  return {
+    success: true,
+    tokenAddress,
+    requiredTokenAmount,
+    tokenBalance,
+  };
+};