@lit-protocol/vincent-ability-sdk 2.3.1 → 2.4.0-mma

package/dist/src/lib/gatedSigner/helpers/lifecycleFunctions.d.ts

@@ -0,0 +1,54 @@
+import type { Address } from 'viem';
+import type { z } from 'zod';
+import type { AbilityConfigLifecycleFunction } from '../../abilityCore/abilityConfig/types';
+import type { LowLevelCall } from './lowLevelCall';
+import type { SimulateAssetChangesResponse } from './simulation';
+export interface DecodedTransactionError {
+    kind: 'error';
+    message: string;
+}
+export interface DecodedTransactionSuccess extends Omit<LowLevelCall, 'data'> {
+    args: readonly unknown[] | undefined;
+    kind: string;
+    fn: string;
+}
+export type DecodedTransaction = DecodedTransactionSuccess | DecodedTransactionError;
+interface ValidationBaseParams {
+    chainId: number;
+    sender: Address;
+}
+export interface DecodeTransactionParams {
+    transaction: LowLevelCall;
+}
+export interface ValidateSimulationParams extends ValidationBaseParams {
+    simulation: SimulateAssetChangesResponse;
+}
+export interface ValidateTransactionParams extends ValidationBaseParams {
+    decodedTransaction: DecodedTransaction;
+}
+/**
+ * Interface defining the steps required to implement the lifecycle of a Gated Signer Ability.
+ */
+export interface LifecycleFunctionSteps {
+    /**
+     * Decodes the transaction data into a more usable format.
+     */
+    decodeTransaction: (params: DecodeTransactionParams) => DecodedTransaction;
+    /**
+     * Validates the result of the simulation.
+     * Should throw an error if the simulation result is invalid.
+     */
+    validateSimulation: (params: ValidateSimulationParams) => void;
+    /**
+     * Validates the decoded transaction.
+     * Should throw an error if the transaction is invalid.
+     */
+    validateTransaction: (params: ValidateTransactionParams) => void;
+}
+interface LifecycleFunctions<AbilityParamsSchema extends z.ZodType, ExecutePolicies, PrecheckPolicies, ExecuteSuccessSchema extends z.ZodType, ExecuteFailSchema extends z.ZodType, PrecheckSuccessSchema extends z.ZodType, PrecheckFailSchema extends z.ZodType> {
+    execute: AbilityConfigLifecycleFunction<AbilityParamsSchema, ExecutePolicies, ExecuteSuccessSchema, ExecuteFailSchema>;
+    precheck: AbilityConfigLifecycleFunction<AbilityParamsSchema, PrecheckPolicies, PrecheckSuccessSchema, PrecheckFailSchema>;
+}
+export declare function buildLifecycleFunctions<AbilityParamsSchema extends z.ZodType, ExecutePolicies, PrecheckPolicies, ExecuteSuccessSchema extends z.ZodType, ExecuteFailSchema extends z.ZodType, PrecheckSuccessSchema extends z.ZodType, PrecheckFailSchema extends z.ZodType>({ decodeTransaction, validateSimulation, validateTransaction, }: LifecycleFunctionSteps): LifecycleFunctions<AbilityParamsSchema, ExecutePolicies, PrecheckPolicies, ExecuteSuccessSchema, ExecuteFailSchema, PrecheckSuccessSchema, PrecheckFailSchema>;
+export {};
+//# sourceMappingURL=lifecycleFunctions.d.ts.map

package/dist/src/lib/gatedSigner/helpers/lifecycleFunctions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycleFunctions.d.ts","sourceRoot":"","sources":["../../../../../src/lib/gatedSigner/helpers/lifecycleFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAO,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,uCAAuC,CAAC;AAC5F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAOjE,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;IAC3E,IAAI,EAAE,SAAS,OAAO,EAAE,GAAG,SAAS,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAErF,UAAU,oBAAoB;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,iBAAiB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,kBAAkB,CAAC;IAC3E;;;OAGG;IACH,kBAAkB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAC/D;;;OAGG;IACH,mBAAmB,EAAE,CAAC,MAAM,EAAE,yBAAyB,KAAK,IAAI,CAAC;CAClE;AAED,UAAU,kBAAkB,CAC1B,mBAAmB,SAAS,CAAC,CAAC,OAAO,EACrC,eAAe,EACf,gBAAgB,EAChB,oBAAoB,SAAS,CAAC,CAAC,OAAO,EACtC,iBAAiB,SAAS,CAAC,CAAC,OAAO,EACnC,qBAAqB,SAAS,CAAC,CAAC,OAAO,EACvC,kBAAkB,SAAS,CAAC,CAAC,OAAO;IAEpC,OAAO,EAAE,8BAA8B,CACrC,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,iBAAiB,CAClB,CAAC;IACF,QAAQ,EAAE,8BAA8B,CACtC,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,CACnB,CAAC;CACH;AAED,wBAAgB,uBAAuB,CACrC,mBAAmB,SAAS,CAAC,CAAC,OAAO,EACrC,eAAe,EACf,gBAAgB,EAChB,oBAAoB,SAAS,CAAC,CAAC,OAAO,EACtC,iBAAiB,SAAS,CAAC,CAAC,OAAO,EACnC,qBAAqB,SAAS,CAAC,CAAC,OAAO,EACvC,kBAAkB,SAAS,CAAC,CAAC,OAAO,EACpC,EACA,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,GACpB,EAAE,sBAAsB,GAAG,kBAAkB,CAC5C,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,CACnB,CAqHA"}

package/dist/src/lib/gatedSigner/helpers/lifecycleFunctions.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildLifecycleFunctions = buildLifecycleFunctions;
+const schemas_1 = require("./schemas");
+const signTransaction_1 = require("./signTransaction");
+const signUserOperation_1 = require("./signUserOperation");
+const validation_1 = require("./validation");
+function buildLifecycleFunctions({ decodeTransaction, validateSimulation, validateTransaction, }) {
+    async function assertIsValidOperation(abilityParams) {
+        if ((0, schemas_1.isUserOpAbilityParams)(abilityParams)) {
+            const { alchemyRpcUrl, entryPointAddress, userOp } = abilityParams;
+            const simulationChanges = await (0, validation_1.assertIsValidUserOp)({
+                alchemyRpcUrl,
+                decodeTransaction,
+                entryPointAddress,
+                userOp,
+                validateSimulation,
+                validateTransaction,
+            });
+            return simulationChanges;
+        }
+        if ((0, schemas_1.isTransactionAbilityParams)(abilityParams)) {
+            const { alchemyRpcUrl, transaction } = abilityParams;
+            const simulationChanges = await (0, validation_1.assertIsValidTransaction)({
+                alchemyRpcUrl,
+                decodeTransaction,
+                transaction,
+                validateSimulation,
+                validateTransaction,
+            });
+            return simulationChanges;
+        }
+        throw new Error('Unsupported ability params payload. Must pass transaction or userOp');
+    }
+    const precheck = async ({ abilityParams }, { succeed, fail, delegation: { delegatorPkpInfo } }) => {
+        try {
+            console.log('[@lit-protocol/vincent-gated-signer]');
+            console.log('[@lit-protocol/vincent-gated-signer] params:', {
+                abilityParams,
+            });
+            console.log('[@lit-protocol/vincent-gated-signer] delegator:', {
+                delegatorPkpInfo,
+            });
+            const simulationChanges = await assertIsValidOperation(abilityParams);
+            return succeed({ simulationChanges });
+        }
+        catch (error) {
+            console.error('[@lit-protocol/vincent-gated-signer] Error:', error);
+            return fail({
+                error: `[@lit-protocol/vincent-gated-signer] Precheck failed: ${error instanceof Error ? error.message : 'Unknown error'}`,
+            });
+        }
+    };
+    const execute = async ({ abilityParams }, { succeed, fail, delegation: { delegatorPkpInfo } }) => {
+        try {
+            const simulationChanges = await assertIsValidOperation(abilityParams);
+            // Sign user operation
+            const { alchemyRpcUrl, eip712Params, entryPointAddress, safe4337ModuleAddress, transaction, userOp, validAfter, validUntil, } = abilityParams;
+            const signature = (0, schemas_1.isTransactionAbilityParams)(abilityParams)
+                ? await (0, signTransaction_1.signTransaction)({
+                    transaction,
+                    pkpPublicKey: delegatorPkpInfo.publicKey,
+                })
+                : await (0, signUserOperation_1.signUserOperation)({
+                    alchemyRpcUrl,
+                    entryPointAddress,
+                    userOp,
+                    pkpPublicKey: delegatorPkpInfo.publicKey,
+                    validAfter,
+                    validUntil,
+                    safe4337ModuleAddress,
+                    eip712Params,
+                });
+            return succeed({
+                signature,
+                simulationChanges,
+            });
+        }
+        catch (error) {
+            console.error('[@lit-protocol/vincent-gated-signer] Error:', error);
+            return fail({
+                error: `[@lit-protocol/vincent-gated-signer] Execute failed: ${error instanceof Error ? error.message : 'Unknown error'}`,
+            });
+        }
+    };
+    return {
+        execute,
+        precheck,
+    };
+}
+//# sourceMappingURL=lifecycleFunctions.js.map

package/dist/src/lib/gatedSigner/helpers/lifecycleFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycleFunctions.js","sourceRoot":"","sources":["../../../../../src/lib/gatedSigner/helpers/lifecycleFunctions.ts"],"names":[],"mappings":";;AAqFA,0DAyIC;AAvND,uCAA8E;AAC9E,uDAAoD;AACpD,2DAAwD;AACxD,6CAA6E;AA2E7E,SAAgB,uBAAuB,CAQrC,EACA,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,GACI;IASvB,KAAK,UAAU,sBAAsB,CAAC,aAA2C;QAC/E,IAAI,IAAA,+BAAqB,EAAC,aAAa,CAAC,EAAE,CAAC;YACzC,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;YAEnE,MAAM,iBAAiB,GAAG,MAAM,IAAA,gCAAmB,EAAC;gBAClD,aAAa;gBACb,iBAAiB;gBACjB,iBAAiB;gBACjB,MAAM;gBACN,kBAAkB;gBAClB,mBAAmB;aACpB,CAAC,CAAC;YAEH,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,IAAI,IAAA,oCAA0B,EAAC,aAAa,CAAC,EAAE,CAAC;YAC9C,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;YAErD,MAAM,iBAAiB,GAAG,MAAM,IAAA,qCAAwB,EAAC;gBACvD,aAAa;gBACb,iBAAiB;gBACjB,WAAW;gBACX,kBAAkB;gBAClB,mBAAmB;aACpB,CAAC,CAAC;YAEH,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,QAAQ,GAKV,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE;QACnF,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE;gBAC1D,aAAa;aACd,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE;gBAC7D,gBAAgB;aACjB,CAAC,CAAC;YAEH,MAAM,iBAAiB,GAAG,MAAM,sBAAsB,CAAC,aAAa,CAAC,CAAC;YAEtE,OAAO,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;YACpE,OAAO,IAAI,CAAC;gBACV,KAAK,EAAE,yDACL,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAC3C,EAAE;aACH,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAKT,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE;QACnF,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG,MAAM,sBAAsB,CAAC,aAAa,CAAC,CAAC;YAEtE,sBAAsB;YACtB,MAAM,EACJ,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,WAAW,EACX,MAAM,EACN,UAAU,EACV,UAAU,GACX,GAAG,aAAa,CAAC;YAElB,MAAM,SAAS,GAAG,IAAA,oCAA0B,EAAC,aAAa,CAAC;gBACzD,CAAC,CAAC,MAAM,IAAA,iCAAe,EAAC;oBACpB,WAAW;oBACX,YAAY,EAAE,gBAAgB,CAAC,SAAgB;iBAChD,CAAC;gBACJ,CAAC,CAAC,MAAM,IAAA,qCAAiB,EAAC;oBACtB,aAAa;oBACb,iBAAiB;oBACjB,MAAM;oBACN,YAAY,EAAE,gBAAgB,CAAC,SAAgB;oBAC/C,UAAU;oBACV,UAAU;oBACV,qBAAqB;oBACrB,YAAY;iBACb,CAAC,CAAC;YAEP,OAAO,OAAO,CAAC;gBACb,SAAS;gBACT,iBAAiB;aAClB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;YACpE,OAAO,IAAI,CAAC;gBACV,KAAK,EAAE,wDACL,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAC3C,EAAE;aACH,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACL,OAAO;QACP,QAAQ;KACT,CAAC;AACJ,CAAC"}

package/dist/src/lib/gatedSigner/helpers/lowLevelCall.d.ts

@@ -0,0 +1,13 @@
+import type { Address, Hex } from 'viem';
+import type { UserOp } from './userOperation';
+export interface LowLevelCall {
+    to: Address;
+    value: bigint;
+    data: Hex;
+}
+export interface DecodedFunctionCall<Args = unknown[] | null> {
+    functionName: string;
+    args: Args;
+}
+export declare const getUserOpCalls: (userOp: UserOp) => LowLevelCall[];
+//# sourceMappingURL=lowLevelCall.d.ts.map

package/dist/src/lib/gatedSigner/helpers/lowLevelCall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lowLevelCall.d.ts","sourceRoot":"","sources":["../../../../../src/lib/gatedSigner/helpers/lowLevelCall.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAK9C,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,WAAW,mBAAmB,CAAC,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI;IAC1D,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,KAAG,YAAY,EAiB3D,CAAC"}

package/dist/src/lib/gatedSigner/helpers/lowLevelCall.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserOpCalls = void 0;
+const kernel_1 = require("./smartAccounts/kernel");
+const safe_1 = require("./smartAccounts/safe");
+const getUserOpCalls = (userOp) => {
+    const callData = userOp.callData;
+    const kernelCalls = (0, kernel_1.tryDecodeKernelCalldataToLowLevelCalls)(callData);
+    const safeCalls = (0, safe_1.tryDecodeSafeCalldataToLowLevelCalls)(callData);
+    const decodedLowLevelCalls = [kernelCalls, safeCalls].filter(Boolean);
+    if (decodedLowLevelCalls.length > 1) {
+        throw new Error('Multiple decodings found');
+    }
+    else if (!decodedLowLevelCalls.length) {
+        throw new Error('Unsupported callData shape');
+    }
+    // Length is 1, we are good
+    return decodedLowLevelCalls[0];
+};
+exports.getUserOpCalls = getUserOpCalls;
+//# sourceMappingURL=lowLevelCall.js.map

package/dist/src/lib/gatedSigner/helpers/lowLevelCall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lowLevelCall.js","sourceRoot":"","sources":["../../../../../src/lib/gatedSigner/helpers/lowLevelCall.ts"],"names":[],"mappings":";;;AAIA,mDAAgF;AAChF,+CAA4E;AAarE,MAAM,cAAc,GAAG,CAAC,MAAc,EAAkB,EAAE;IAC/D,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IAEjC,MAAM,WAAW,GAAG,IAAA,+CAAsC,EAAC,QAAQ,CAAC,CAAC;IACrE,MAAM,SAAS,GAAG,IAAA,2CAAoC,EAAC,QAAQ,CAAC,CAAC;IAEjE,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,CAC1D,OAAO,CACuB,CAAC;IACjC,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;SAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,2BAA2B;IAC3B,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,cAAc,kBAiBzB"}