@zerodev/sdk 4.0.17 → 4.0.19

package/README.md

@@ -535,6 +535,115 @@ const sessionKeyProvider = await SessionKeyProvider.fromSessionKeyParams({
     });
 ```
 
+### Recovery Key Validator
+
+#### Initiate the recovery and retrieve the recoveryId
+
+```ts
+// 1. Get the default ecdsa validator provider
+const ecdsaProvider = await ECDSAProvider.init({
+  projectId, // zeroDev projectId
+  owner,
+});
+
+// 2. Initialize the Recovery Provider
+const recoveryData = {
+  guardians: {  // Guardian addresses with their weights
+    [guardianAddress]: 1,
+    [guardian2Address]: 1,
+    [guardian3Address]: 1,
+  },
+  threshold: 3,
+  delaySeconds: 0,
+};
+
+const recoveryProvider = await RecoveryProvider.init({
+  projectId,
+  defaultProvider: ecdsaProvider,
+  opts: {
+    validatorConfig: {
+      ...recoveryData,
+    },
+  },
+});
+
+// 3. Enable the recovery plugin
+const result = await recoveryProvider.enableRecovery();
+await recoveryProvider.waitForUserOperationTransaction(
+  result.hash as Hex
+);
+
+// 3. Initiate the recovery
+const recoveryId = await recoveryProvider.initiateRecovery(<NewOwnerAddress>);
+```
+
+#### Share recoveryId with the guardians to sign recoveryHash
+
+```ts
+// 1. Intialize the Recovery Provider for guardian
+const guardian =
+  LocalAccountSigner.privateKeyToAccountSigner(<PrivateKey>);
+const recoveryProvider = await RecoveryProvider.init({
+  projectId,
+  recoveryId,
+  opts: {
+    validatorConfig: {
+      accountSigner: guardian,
+    },
+  },
+});
+
+// 2. Sign the recovery hash
+await recoveryProvider.signRecovery();
+```
+
+#### Submit the recovery request
+
+| Anybody can submit the recovery request if they have the recoveryId
+
+```ts
+// 1. Initialize the recovery provider
+const account = privateKeyToAccount(<PrivateKey>);
+const recoveryProvider = await RecoveryProvider.init({
+  projectId,
+  recoveryId,
+  opts: {
+    validatorConfig: {
+      guardianAccountOrProvider: account,
+    },
+  },
+});
+
+// 2. Submit the recovery request
+const result = await recoveryProvider.submitRecovery();
+await recoveryProvider.waitForUserOperationTransaction(
+  result.hash as Hex
+);
+```
+
+#### Cancel the recovery request
+
+| Owner of the account can canel the recovery request
+
+```ts
+// 1. Get the default ecdsa validator provider
+const ecdsaProvider = await ECDSAProvider.init({
+  projectId, // zeroDev projectId
+  owner,
+});
+
+// 2. Initialize the Recovery Provider
+const recoveryProvider = await RecoveryProvider.init({
+  projectId,
+  defaultProvider: ecdsaProvider,
+  recoveryId,
+});
+
+// 3. Cancel the recovery
+const result = await recoveryProvider.cancelRecovery();
+await recoveryProvider.waitForUserOperationTransaction(result.hash as Hex);
+```
+
 ## Components
 
 ### Core Components

package/dist/cjs/kernel-zerodev/abis/RecoveryActionAbi.d.ts

@@ -0,0 +1,15 @@
+export declare const RecoveryActionAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_validator";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "_data";
+        readonly type: "bytes";
+    }];
+    readonly name: "doRecovery";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];

package/dist/cjs/kernel-zerodev/abis/RecoveryActionAbi.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecoveryActionAbi = void 0;
+exports.RecoveryActionAbi = [
+    {
+        inputs: [
+            {
+                internalType: "address",
+                name: "_validator",
+                type: "address",
+            },
+            {
+                internalType: "bytes",
+                name: "_data",
+                type: "bytes",
+            },
+        ],
+        name: "doRecovery",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+];
+//# sourceMappingURL=RecoveryActionAbi.js.map

package/dist/cjs/kernel-zerodev/abis/RecoveryActionAbi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecoveryActionAbi.js","sourceRoot":"","sources":["../../../../src/kernel-zerodev/abis/RecoveryActionAbi.ts"],"names":[],"mappings":";;;AAAa,QAAA,iBAAiB,GAAG;IAC/B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;aACd;SACF;QACD,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;CACO,CAAC","sourcesContent":["export const RecoveryActionAbi = [\n  {\n    inputs: [\n      {\n        internalType: \"address\",\n        name: \"_validator\",\n        type: \"address\",\n      },\n      {\n        internalType: \"bytes\",\n        name: \"_data\",\n        type: \"bytes\",\n      },\n    ],\n    name: \"doRecovery\",\n    outputs: [],\n    stateMutability: \"nonpayable\",\n    type: \"function\",\n  },\n] as const;\n"]}

package/dist/cjs/kernel-zerodev/abis/WeightedValidatorAbi.d.ts

@@ -0,0 +1,296 @@
+export declare const WeightedValidatorAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "_callDataAndNonceHash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "address";
+        readonly name: "_kernel";
+        readonly type: "address";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "_callDataAndNonceHash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "address";
+        readonly name: "_kernel";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "sigs";
+        readonly type: "bytes";
+    }];
+    readonly name: "approveWithSig";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes";
+        readonly name: "";
+        readonly type: "bytes";
+    }];
+    readonly name: "disable";
+    readonly outputs: readonly [];
+    readonly stateMutability: "payable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "eip712Domain";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes1";
+        readonly name: "fields";
+        readonly type: "bytes1";
+    }, {
+        readonly internalType: "string";
+        readonly name: "name";
+        readonly type: "string";
+    }, {
+        readonly internalType: "string";
+        readonly name: "version";
+        readonly type: "string";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "chainId";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "address";
+        readonly name: "verifyingContract";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "salt";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "uint256[]";
+        readonly name: "extensions";
+        readonly type: "uint256[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes";
+        readonly name: "_data";
+        readonly type: "bytes";
+    }];
+    readonly name: "enable";
+    readonly outputs: readonly [];
+    readonly stateMutability: "payable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "guardian";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "kernel";
+        readonly type: "address";
+    }];
+    readonly name: "guardian";
+    readonly outputs: readonly [{
+        readonly internalType: "uint24";
+        readonly name: "weight";
+        readonly type: "uint24";
+    }, {
+        readonly internalType: "address";
+        readonly name: "nextGuardian";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "callDataAndNonceHash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "address";
+        readonly name: "kernel";
+        readonly type: "address";
+    }];
+    readonly name: "proposalStatus";
+    readonly outputs: readonly [{
+        readonly internalType: "enum ProposalStatus";
+        readonly name: "status";
+        readonly type: "uint8";
+    }, {
+        readonly internalType: "ValidAfter";
+        readonly name: "validAfter";
+        readonly type: "uint48";
+    }, {
+        readonly internalType: "uint24";
+        readonly name: "weightApproved";
+        readonly type: "uint24";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "";
+        readonly type: "bytes";
+    }];
+    readonly name: "validCaller";
+    readonly outputs: readonly [{
+        readonly internalType: "bool";
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "hash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "signature";
+        readonly type: "bytes";
+    }];
+    readonly name: "validateSignature";
+    readonly outputs: readonly [{
+        readonly internalType: "ValidationData";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "sender";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "nonce";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "bytes";
+            readonly name: "initCode";
+            readonly type: "bytes";
+        }, {
+            readonly internalType: "bytes";
+            readonly name: "callData";
+            readonly type: "bytes";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "callGasLimit";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "verificationGasLimit";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "preVerificationGas";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "maxFeePerGas";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "maxPriorityFeePerGas";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "bytes";
+            readonly name: "paymasterAndData";
+            readonly type: "bytes";
+        }, {
+            readonly internalType: "bytes";
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+        readonly internalType: "struct UserOperation";
+        readonly name: "userOp";
+        readonly type: "tuple";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "userOpHash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "missingFunds";
+        readonly type: "uint256";
+    }];
+    readonly name: "validateUserOp";
+    readonly outputs: readonly [{
+        readonly internalType: "ValidationData";
+        readonly name: "validationData";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "payable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "_callDataAndNonceHash";
+        readonly type: "bytes32";
+    }];
+    readonly name: "veto";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "callDataAndNonceHash";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "address";
+        readonly name: "guardian";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "kernel";
+        readonly type: "address";
+    }];
+    readonly name: "voteStatus";
+    readonly outputs: readonly [{
+        readonly internalType: "enum VoteStatus";
+        readonly name: "status";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "kernel";
+        readonly type: "address";
+    }];
+    readonly name: "weightedStorage";
+    readonly outputs: readonly [{
+        readonly internalType: "uint24";
+        readonly name: "totalWeight";
+        readonly type: "uint24";
+    }, {
+        readonly internalType: "uint24";
+        readonly name: "threshold";
+        readonly type: "uint24";
+    }, {
+        readonly internalType: "uint48";
+        readonly name: "delay";
+        readonly type: "uint48";
+    }, {
+        readonly internalType: "address";
+        readonly name: "firstGuardian";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];