thirdweb-dev · codypharm · Oct 16, 2023 · Oct 17, 2023 · Oct 20, 2023 · Oct 20, 2023
diff --git a/.env_example b/.env_example
@@ -0,0 +1,4 @@
+ANVIL_PRIVATE_KEY=
+ANVIL_PUBLIC_KEY=
+ANVIL_RPC_URL=http://127.0.0.1:8545
+
diff --git a/Makefile b/Makefile
@@ -0,0 +1,47 @@
+-include .env
+
+.PHONY: all test test_anvil clean deploy fund help install snapshot format anvil 
+
+DEFAULT_ANVIL_KEY := 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+
+help:
+	@echo "Usage:"
+	@echo "  make deploy [ARGS=...]\n    example: make deploy ARGS=\"--network sepolia\""
+	@echo ""
+	@echo "  make fund [ARGS=...]\n    example: make deploy ARGS=\"--network sepolia\""
+
+all: clean remove update build deploy
+
+# Clean the repo
+clean  :; forge clean
+
+# Remove modules
+remove :; rm -rf .gitmodules && rm -rf .git/modules/* && rm -rf lib && touch .gitmodules && git add . && git commit -m "modules"
+
+# Update Dependencies
+update:; forge update
+
+build:; forge build
+
+test :; forge test 
+
+test_anvil :; forge test --rpc-url $(ANVIL_RPC_URL)
+
+snapshot :; forge snapshot
+
+format :; forge fmt
+
+anvil :; anvil -m 'test test test test test test test test test test test junk' --steps-tracing --block-time 1
+
+NETWORK_ARGS := --rpc-url $(ANVIL_RPC_URL) --private-key $(ANVIL_PRIVATE_KEY) --broadcast
+
+# ifeq ($(findstring --network sepolia,$(ARGS)),--network sepolia)
+# 	NETWORK_ARGS := --rpc-url $(SEPOLIA_RPC_URL) --private-key $(SEPOLIA_PRIVATE_KEY) --broadcast --verify --etherscan-api-key $(ETHERSCAN_API_KEY) -vvvv
+# endif
+
+# ifeq ($(findstring --network ganache,$(ARGS)),--network ganache)
+# 	NETWORK_ARGS := --rpc-url $(GANACHE_RPC_URL) --private-key $(GANACHE_PRIVATE_KEY) --broadcast -vvvv
+# endif
+
+deploy:
+	@forge script scripts/DeploySmartAccountUtilContracts.s.sol:DeploySmartAccountUtilContracts $(NETWORK_ARGS)
diff --git a/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-1700379942.json b/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-1700379942.json
diff --git a/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-1700553682.json b/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-1700553682.json
diff --git a/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-latest.json b/broadcast/DeploySmartAccountUtilContracts.s.sol/31337/run-latest.json
diff --git a/contracts/prebuilts/account/interface/IAccountGuardian.sol b/contracts/prebuilts/account/interface/IAccountGuardian.sol
@@ -2,8 +2,7 @@
 pragma solidity ^0.8.12;
 
 interface IAccountGuardian {
-
-     /*///////////////////////////////////////////////////////////////
+    /*///////////////////////////////////////////////////////////////
                         Events
     //////////////////////////////////////////////////////////////*/
 
@@ -20,7 +19,6 @@ interface IAccountGuardian {
      */
     event GuardianRemoved(address indexed guardian);
 
-
     /*///////////////////////////////////////////////////////////////
                         Errors
     //////////////////////////////////////////////////////////////*/
@@ -33,9 +31,9 @@ interface IAccountGuardian {
     error GuardianNotVerified(address guardian);
 
     /**
-     * An error thrown if the guardian the user is trying to remove is not a part of 
+     * An error thrown if the guardian the user is trying to remove is not a part of
      * the user's guardian list.
-     * @param guardian address which the user was trying to remove from their 
+     * @param guardian address which the user was trying to remove from their
      * guardian list but was not the guardian
      */
     error NotAGuardian(address guardian);
@@ -46,27 +44,21 @@ interface IAccountGuardian {
      * @param guardian address of guardian user is trying to remove
      * @param recoveryHash active recovery request hash
      */
-    error GuardianNotRemovedDueToActiveRecoveryRequest(
-        address guardian,
-        bytes32 recoveryHash
-        );
-
+    error GuardianNotRemovedDueToActiveRecoveryRequest(address guardian, bytes32 recoveryHash);
 
-     /*///////////////////////////////////////////////////////////////
+    /*///////////////////////////////////////////////////////////////
                         External Functions
     //////////////////////////////////////////////////////////////*/
 
-
     /**
      * @notice Add guardians for your smart-wallet.
-     * @dev The guardian address needs to connect to the thirdweb’s 
+     * @dev The guardian address needs to connect to the thirdweb’s
      * guardian signup dapp by accepting the signin request.
      * @param guardian the verified address of a wallet to be
      * added as a guardian.
      */
     function addGuardian(address guardian) external;
 
-
     /**
      * @notice A user will be able to remove allotted guardian(s) from
      * their smart-wallet guardian list.
@@ -79,17 +71,23 @@ interface IAccountGuardian {
      * @notice Returns a list of all added guardians of the sender.
      * @return List of guardians of the sender smart-wallet.
      */
-    function getAllGuardians() external returns(address[] memory);
+    function getAllGuardians() external returns (address[] memory);
 
     /**
      * @notice Returns a bool value indicating if the guardian is that
      * account's guardian or not.
      * @param guardian guardian to be checked for
      * @return bool
      */
-    function isAccountGuardian(address guardian) external view returns (bool); 
-
+    function isAccountGuardian(address guardian) external view returns (bool);
+
+    /**
+     * @dev This will return the number of guardians allot for the account. Will be used when creating shards of the account's private key
+     * @return uint256 No. of account guardians
+     */
+    function getTotalGuardians() external view returns (uint256);
+
     /**
      * @notice Sign the lock request
      */
-}
+}
diff --git a/contracts/prebuilts/account/interface/IAccountLock.sol b/contracts/prebuilts/account/interface/IAccountLock.sol
@@ -19,18 +19,16 @@ interface IAccountLock {
     event AccountUnLockRequestCreated(address indexed account);
 
     /**
-     * An event emitted when a guardian accepts a lock request.
-     * @param lockRequest type hash of the lock request
-     * @param guardian address of guardian who accepted the request
+     * @notice Event emitted when request Concensus achieved
+     * @param account Address of the account
      */
-    event AccountLockRequestAccepted(bytes32 indexed lockRequest, address indexed guardian);
+    event RequestConcensusAchieved(address indexed account);
 
     /**
-     * @notice An event emitted when a guardian declines a lock request.
-     * @param lockRequest type hash of the lock request
-     * @param guardian address of guardian who accepted the request
+     * @notice Event emitted when request Concensus could not be achieved
+     * @param account Address of the account
      */
-    event AccountLockRequestRejected(bytes32 indexed lockRequest, address indexed guardian);
+    event RequestConcensusCouldNotBeAchieved(address indexed account);
 
     /*///////////////////////////////////////////////////////////////
                         Errors
@@ -56,15 +54,26 @@ interface IAccountLock {
     error AccountAlreadyLocked(address account);
 
     /**
-     * Error returned when creating a account lock request for which lock reques already exists.
+     * Error thrown when a unlock request is created for an already unlocked smart-wallet
+     * @param account address of the smart wallet being unlocked
+     */
+    error AccountAlreadyUnLocked(address account);
+
+    /**
+     * Error returned when creating a account lock request for which lock request already exists.
      */
     error ActiveLockRequestFound();
 
     /**
-     * Error thrown when a unlock request is created for an already unlocked smart-wallet
-     * @param account address of the smart wallet being unlocked
+     * Error returned when creating a account unlock request for which an unlock request already exists.
+     */
+    error ActiveUnLockRequestFound();
+
+    /**
+     * Error thrown when trying to evaluate Concensus for lock request that is not connected to the account sent
+     * @param account account whose lock req Concensus is being evaluated
      */
-    error AccountAlreadyUnlocked(address account);
+    error NoActiveRequestFoundForAccount(address account);
 
     /*///////////////////////////////////////////////////////////////
                         External Functions
@@ -87,11 +96,10 @@ interface IAccountLock {
 
     /**
      * @dev This function is used to evaluate if the lockRequest was accepted or rejected by the guardians.
-     * @param lockRequest The lockRequest to evaluate
      * @param account Account to which the lock request belongs.
      */
 
-    function lockRequestEvaluation(bytes32 lockRequest, address account) external;
+    function accountRequestConcensusEvaluation(address account) external returns (bool);
 
     /**
      * Will be called to execute the lock request on an account

diff --git a/contracts/prebuilts/account/interface/IAccountRecovery.sol b/contracts/prebuilts/account/interface/IAccountRecovery.sol
@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity ^0.8.12;
+
+interface IAccountRecovery {
+    // Errors //
+    error NotOwner(address sender);
+    error NotAGuardian(address sender);
+    error NoRecoveryRequestFound(address account);
+    error NoSignaturesYet();
+
+    // Events //
+    event PrivateKeyShardsAlloted();
+    event AccountRecoveryRequestCreated(address indexed account);
+    event GuardianSignatureRecorded(address indexed guardian);
+    event AccountRecoveryRequestConcensusAchieved(address indexed account);
+    event AccountRecoveryRequestConcensusFailed(address indexed account);
+
+    /**
+     * @dev Will be used to store the shards of user's private key in a secure cloud based storage of the user.
+     * @param privateKeyShards Array of private key shards of the user's account
+     */
+    function storePrivateKeyShards(uint8[] calldata privateKeyShards) external;
+
+    /**
+     * @dev Will collect the guardians signatures on the account's active recovery request
+     * @param recoveryReqSignature The signature of the guardian on the account's active recovery req.
+     */
+    function collectGuardianSignaturesOnRecoveryRequest(address guardian, bytes memory recoveryReqSignature) external;
+
+    /**
+     * @dev Will contain the evaluation logic for concensus of account recovery request by the guardians
+     * @return Boolean flag indicating if the concensus on account recovery was achieved or not
+     */
+    function accountRecoveryConcensusEvaluation() external returns (bool);
+
+    /**
+     * @dev Will restore the private key, encrypt and return/email the user
+     * @return Encrypted private key of the account
+     */
+    function restorePrivateKey() external returns (bytes memory);
+}
diff --git a/contracts/prebuilts/account/interface/IGuardian.sol b/contracts/prebuilts/account/interface/IGuardian.sol
@@ -2,12 +2,11 @@
 pragma solidity ^0.8.12;
 
 interface IGuardian {
-
-     //////////////////////////////////////
+    //////////////////////////////////////
     /////////// Errors ////////////////
     //////////////////////////////////////
 
- /**
+    /**
      * Emits error if the guardian already exists
      * @param guardian wallet address of the guardian being added.
      */
@@ -19,7 +18,7 @@ interface IGuardian {
      */
     error NotAGuardian(address guardian);
 
-     //////////////////////////////////////
+    //////////////////////////////////////
     /////////// Events ////////////////
     //////////////////////////////////////
 
@@ -32,7 +31,7 @@ interface IGuardian {
      * @param guardian address of the guardian being removed.
      */
     event GuardianRemoved(address indexed guardian);
-   
+
     /////////////////////////////////////
     /////////// External Functions //////
     //////////////////////////////////////
@@ -49,14 +48,13 @@ interface IGuardian {
      * @return bool Boolean value indicating if a address is a verified
      * guardian or not.
      */
-    function isVerifiedGuardian(address isVerified) external returns(bool);
+    function isVerifiedGuardian(address isVerified) external returns (bool);
 
     /**
      * @notice Remove the sender as a verified thirdweb guardian.
      */
     function removeVerifiedGuardian() external;
 
-
     /**
      * @notice Used to maintain a record of each account and it's guardian (accountGuardian) contract instance
      * @param account Address of the account that got initialised
@@ -68,9 +66,9 @@ interface IGuardian {
     /**
      * @notice Creates a mapping of account to their respective guardians
      * @param guardian Guardian to be added to account
-     * @param account Account whose guardian list is to be updated. 
+     * @param account Account whose guardian list is to be updated.
      */
-     function addAccountToGuardian(address guardian, address account) external;
+    function addAccountToGuardian(address guardian, address account) external;
 
     //////////////////////////////////////
     /////////// Getter Function //////////
@@ -80,19 +78,30 @@ interface IGuardian {
      * Returns the list of verified guardians.
      * Can only be called by the owner.
      */
-    function getVerifiedGuardians() external view returns(address[] memory);
+    function getVerifiedGuardians() external view returns (address[] memory);
 
     /**
      * @notice Returns the accountGuardian address of an account
      * @param account account
      * @return address accountGuardian
      */
-    function getAccountGuardian(address account) external view returns(address);
+    function getAccountGuardian(address account) external view returns (address);
 
     /**
      * @notice Returns the list of accounts the guardian is guarding
      * @param guardian Guardian whose account list has to be returned
      */
-    function getAccountsTheGuardianIsGuarding(address guardian) external view returns(address[] memory);
+    function getAccountsTheGuardianIsGuarding(address guardian) external view returns (address[] memory);
 
-}
+    /**
+     * @dev Returns the address of the Account Recovery contract of an account. Will be used by guardians to get the account recovery request and send signature back to the account recovery contract.
+     * @param account The account for which it's recovery contract is requested
+     */
+    function getAccountRecovery(address account) external returns (address);
+
+    /**
+     * @dev A checker function to check if a sender is guardian for the account
+     * @param account Account address for which check is being done.
+     */
+    function isGuardingAccount(address account, address guardian) external view returns (bool);
+}