@lit-protocol/vincent-ability-erc20-approval 0.0.7-mma

package/dist/src/lib/vincent-ability.d.ts

@@ -0,0 +1,62 @@
+export declare const vincentAbility: import("@lit-protocol/vincent-ability-sdk").VincentAbility<import("zod").ZodObject<{
+    rpcUrl: import("zod").ZodString;
+    chainId: import("zod").ZodNumber;
+    spenderAddress: import("zod").ZodString;
+    tokenAddress: import("zod").ZodString;
+    tokenDecimals: import("zod").ZodNumber;
+    tokenAmount: import("zod").ZodNumber;
+}, "strip", import("zod").ZodTypeAny, {
+    tokenAddress: string;
+    rpcUrl: string;
+    chainId: number;
+    spenderAddress: string;
+    tokenAmount: number;
+    tokenDecimals: number;
+}, {
+    tokenAddress: string;
+    rpcUrl: string;
+    chainId: number;
+    spenderAddress: string;
+    tokenAmount: number;
+    tokenDecimals: number;
+}>, string, import("node_modules/@lit-protocol/vincent-ability-sdk/dist/src/lib/abilityCore/helpers").AbilityPolicyMap<readonly [], never>, {}, import("zod").ZodObject<{
+    approvalTxHash: import("zod").ZodOptional<import("zod").ZodString>;
+    approvedAmount: import("zod").ZodString;
+    tokenAddress: import("zod").ZodString;
+    tokenDecimals: import("zod").ZodNumber;
+    spenderAddress: import("zod").ZodString;
+}, "strip", import("zod").ZodTypeAny, {
+    tokenAddress: string;
+    spenderAddress: string;
+    tokenDecimals: number;
+    approvedAmount: string;
+    approvalTxHash?: string | undefined;
+}, {
+    tokenAddress: string;
+    spenderAddress: string;
+    tokenDecimals: number;
+    approvedAmount: string;
+    approvalTxHash?: string | undefined;
+}>, import("zod").ZodObject<{
+    error: import("zod").ZodString;
+}, "strip", import("zod").ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>, import("zod").ZodObject<{
+    alreadyApproved: import("zod").ZodBoolean;
+    currentAllowance: import("zod").ZodString;
+}, "strip", import("zod").ZodTypeAny, {
+    alreadyApproved: boolean;
+    currentAllowance: string;
+}, {
+    alreadyApproved: boolean;
+    currentAllowance: string;
+}>, import("zod").ZodObject<{
+    noNativeTokenBalance: import("zod").ZodBoolean;
+}, "strip", import("zod").ZodTypeAny, {
+    noNativeTokenBalance: boolean;
+}, {
+    noNativeTokenBalance: boolean;
+}>>;
+//# sourceMappingURL=vincent-ability.d.ts.map

package/dist/src/lib/vincent-ability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vincent-ability.d.ts","sourceRoot":"","sources":["../../../src/lib/vincent-ability.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgHzB,CAAC"}

package/dist/src/lib/vincent-ability.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vincentAbility = void 0;
+const vincent_ability_sdk_1 = require("@lit-protocol/vincent-ability-sdk");
+const ethers_1 = require("ethers");
+const helpers_1 = require("./helpers");
+const lit_action_helpers_1 = require("./lit-action-helpers");
+const schemas_1 = require("./schemas");
+exports.vincentAbility = (0, vincent_ability_sdk_1.createVincentAbility)({
+    packageName: '@lit-protocol/vincent-ability-erc20-approval',
+    abilityDescription: 'Allow, up to a limit, of an ERC20 token spending to another address.',
+    abilityParamsSchema: schemas_1.abilityParamsSchema,
+    supportedPolicies: (0, vincent_ability_sdk_1.supportedPoliciesForAbility)([]),
+    precheckSuccessSchema: schemas_1.precheckSuccessSchema,
+    precheckFailSchema: schemas_1.precheckFailSchema,
+    executeSuccessSchema: schemas_1.executeSuccessSchema,
+    executeFailSchema: schemas_1.executeFailSchema,
+    precheck: async ({ abilityParams }, { succeed, fail, delegation: { delegatorPkpInfo } }) => {
+        const { ethAddress } = delegatorPkpInfo;
+        const { rpcUrl, spenderAddress, tokenAddress, tokenDecimals, tokenAmount } = abilityParams;
+        const provider = new ethers_1.ethers.providers.JsonRpcProvider(rpcUrl);
+        const hasNativeTokenBalance = await (0, helpers_1.checkNativeTokenBalance)({
+            provider,
+            pkpEthAddress: ethAddress,
+        });
+        if (!hasNativeTokenBalance) {
+            return fail({ noNativeTokenBalance: true });
+        }
+        const currentAllowance = await (0, helpers_1.getCurrentAllowance)({
+            provider,
+            tokenAddress,
+            owner: ethAddress,
+            spender: spenderAddress,
+        });
+        const requiredAmount = ethers_1.ethers.utils.parseUnits(tokenAmount.toString(), tokenDecimals);
+        return succeed({
+            alreadyApproved: currentAllowance == requiredAmount.toBigInt(),
+            currentAllowance: currentAllowance.toString(),
+        });
+    },
+    execute: async ({ abilityParams }, { succeed, delegation: { delegatorPkpInfo } }) => {
+        console.log('Executing ERC20 Approval Ability');
+        const { ethAddress, publicKey } = delegatorPkpInfo;
+        const { rpcUrl, chainId, spenderAddress, tokenAddress, tokenDecimals, tokenAmount } = abilityParams;
+        const provider = new ethers_1.ethers.providers.JsonRpcProvider(rpcUrl);
+        await (0, helpers_1.checkNativeTokenBalance)({
+            provider,
+            pkpEthAddress: ethAddress,
+        });
+        const currentAllowance = await (0, helpers_1.getCurrentAllowance)({
+            provider,
+            tokenAddress,
+            owner: ethAddress,
+            spender: spenderAddress,
+        });
+        const requiredAmount = ethers_1.ethers.utils
+            .parseUnits(tokenAmount.toString(), tokenDecimals)
+            .toBigInt();
+        console.log(`currentAllowance: ${currentAllowance} >= requiredAmount: ${requiredAmount} (execute)`);
+        if (currentAllowance === requiredAmount) {
+            console.log('Ability execution successful', {
+                approvedAmount: currentAllowance.toString(),
+                spenderAddress,
+                tokenAddress,
+                tokenDecimals: parseInt(tokenDecimals.toString()),
+            });
+            return succeed({
+                approvedAmount: currentAllowance.toString(),
+                tokenAddress,
+                tokenDecimals: parseInt(tokenDecimals.toString()),
+                spenderAddress,
+            });
+        }
+        const approvalTxHash = await (0, lit_action_helpers_1.sendErc20ApprovalTx)({
+            rpcUrl,
+            chainId,
+            pkpEthAddress: ethAddress,
+            pkpPublicKey: publicKey,
+            spenderAddress,
+            tokenAmount: requiredAmount,
+            tokenAddress,
+        });
+        console.log('Ability execution successful', {
+            approvalTxHash,
+            approvedAmount: requiredAmount.toString(),
+            spenderAddress,
+            tokenAddress,
+            tokenDecimals: parseInt(tokenDecimals.toString()),
+        });
+        return succeed({
+            approvalTxHash,
+            approvedAmount: requiredAmount.toString(),
+            tokenAddress,
+            tokenDecimals: parseInt(tokenDecimals.toString()),
+            spenderAddress,
+        });
+    },
+});
+//# sourceMappingURL=vincent-ability.js.map

package/dist/src/lib/vincent-ability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vincent-ability.js","sourceRoot":"","sources":["../../../src/lib/vincent-ability.ts"],"names":[],"mappings":";;;AAAA,2EAG2C;AAC3C,mCAAgC;AAEhC,uCAAyE;AACzE,6DAA2D;AAC3D,uCAMmB;AAEN,QAAA,cAAc,GAAG,IAAA,0CAAoB,EAAC;IACjD,WAAW,EAAE,8CAAuD;IACpE,kBAAkB,EAChB,sEAA+E;IACjF,mBAAmB,EAAnB,6BAAmB;IACnB,iBAAiB,EAAE,IAAA,iDAA2B,EAAC,EAAE,CAAC;IAElD,qBAAqB,EAArB,+BAAqB;IACrB,kBAAkB,EAAlB,4BAAkB;IAElB,oBAAoB,EAApB,8BAAoB;IACpB,iBAAiB,EAAjB,2BAAiB;IAEjB,QAAQ,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE;QACzF,MAAM,EAAE,UAAU,EAAE,GAAG,gBAAgB,CAAC;QACxC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;QAE3F,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,qBAAqB,GAAG,MAAM,IAAA,iCAAuB,EAAC;YAC1D,QAAQ;YACR,aAAa,EAAE,UAAU;SAC1B,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,IAAA,6BAAmB,EAAC;YACjD,QAAQ;YACR,YAAY;YACZ,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;QAEtF,OAAO,OAAO,CAAC;YACb,eAAe,EAAE,gBAAgB,IAAI,cAAc,CAAC,QAAQ,EAAE;YAC9D,gBAAgB,EAAE,gBAAgB,CAAC,QAAQ,EAAE;SAC9C,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE;QAClF,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAEhD,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC;QACnD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,GACjF,aAAa,CAAC;QAEhB,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,IAAA,iCAAuB,EAAC;YAC5B,QAAQ;YACR,aAAa,EAAE,UAAU;SAC1B,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,MAAM,IAAA,6BAAmB,EAAC;YACjD,QAAQ;YACR,YAAY;YACZ,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,eAAM,CAAC,KAAK;aAChC,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC;aACjD,QAAQ,EAAE,CAAC;QAEd,OAAO,CAAC,GAAG,CACT,qBAAqB,gBAAgB,uBAAuB,cAAc,YAAY,CACvF,CAAC;QAEF,IAAI,gBAAgB,KAAK,cAAc,EAAE,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;gBAC1C,cAAc,EAAE,gBAAgB,CAAC,QAAQ,EAAE;gBAC3C,cAAc;gBACd,YAAY;gBACZ,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;aAClD,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC;gBACb,cAAc,EAAE,gBAAgB,CAAC,QAAQ,EAAE;gBAC3C,YAAY;gBACZ,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACjD,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAA,wCAAmB,EAAC;YAC/C,MAAM;YACN,OAAO;YACP,aAAa,EAAE,UAAU;YACzB,YAAY,EAAE,SAAS;YACvB,cAAc;YACd,WAAW,EAAE,cAAc;YAC3B,YAAY;SACb,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;YAC1C,cAAc;YACd,cAAc,EAAE,cAAc,CAAC,QAAQ,EAAE;YACzC,cAAc;YACd,YAAY;YACZ,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;SAClD,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;YACb,cAAc;YACd,cAAc,EAAE,cAAc,CAAC,QAAQ,EAAE;YACzC,YAAY;YACZ,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YACjD,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@lit-protocol/vincent-ability-erc20-approval",
+  "version": "0.0.7-mma",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "ethers": "^5.8.0",
+    "tslib": "2.8.1",
+    "zod": "^3.25.64",
+    "@lit-protocol/vincent-ability-sdk": "0.0.7-mma"
+  },
+  "peerDependencies": {
+    "@lit-protocol/vincent-app-sdk": "^0.0.7-mma"
+  },
+  "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"
+  ]
+}