Readme touchups

thirdweb-dev · codypharm · Oct 16, 2023 · Oct 17, 2023 · Oct 20, 2023 · Oct 20, 2023
commit d54fdb547e60911509618766fd5bf7ce895188e7
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 <h1 align="center">CryptoPhoenix Smart Wallet Contracts</h1>
 <p>CryptoPhoenix Wallet SDK is a rollup to thirdweb's smart wallet contracts and offers: <br />
 <ol>
+<li>Smart Accounts</li>
 <li>Social Account Locking</li>
 <li>Social Account Recovery</li>
 <li>Guardian Management</li>
@@ -10,36 +11,9 @@
 ## Problem Statement
 As we all know, a wallet is a gateway to web3 but the wallet experience is unfortunately broken! For a user to interact with a blockchain, they not only have to **create a wallet but also secure their private keys and seed phrase, purchase native tokes to pay for gas, and sign every single action** that they take on a dApp. 
 
-Such an intimidating user experience for newcomers is a big obstacle in the mass adoption of web3 and CryptoPhoenix Wallet SDK is here to change this through its **Account abstraction technology.
+Such an intimidating user experience for newcomers is a big obstacle in the mass adoption of web3 and CryptoPhoenix Wallet SDK is here to change this through its **Account abstraction technology.**
 
-## Smart Wallets (ERC 4337)
-Smart wallets are wallets that are controlled by programmable smart contract therefore having the following key benefits:
-1. **Improved user experience:**
-   Eliminates the need to manage private keys, making it easier and safer for users to interact with Web3.
-Enable gasless transactions for your users.
-Enable batched transactions, preventing user from having to approve every single transaction.
-Enables features like social recovery and multi-signature wallets.
-Allows for programmable payments and recurring subscriptions.
-Enhanced security:
-Reduces the risk of losing funds due to private key theft.
-Smart contracts can be programmed with additional security features.
-Increased flexibility:
-Enables new types of wallets and applications.
-Allows for more complex financial transactions.
-Reduced transaction costs:
-Can batch multiple transactions into one, saving gas fees.
-Greater scalability:
-Can improve the overall performance of blockchain networks.
-They follow ERC-4337, a new ‘account abstraction’ standard that unlocks the power of smart contract wallets, or ‘smart accounts,’ on the Ethereum blockchain (and EVM-compatible networks). 
-## Architecture
-
-<img src="./images/architecture.png" width="400" alt="puppy-raffle">
-<br/>
-<br />
-
-[**Architecture walkthrough**](https://www.youtube.com/embed/0zq2YdOYFUo)
-
-## Smart wallets
+## Smart wallets and its features
 Smart wallets are wallets that are controlled by a smart contract and have the following key benefits-
 <ol>
 <li>
@@ -58,23 +32,37 @@ Smart accounts can also provide multisig capabilities, requiring multiple signat
 <li><h4>Automation of transactions</h4>
 Enables self executing transactions when certain defined conditions are met like approving a predefined number of tokens to an entity based on fixed time intervals, stop loss and take profit orders, recurring subscriptions, etc.
 </li>
+</ol>
+
+## Architecture
+
+<img src="./images/architecture.png" width="600" alt="cryptophoenix_architecture">
+<br/>
+<br />
 
-## How we built it
+[![YouTube](https://img.shields.io/badge/YouTube-Video-red?style=for-the-badge&logo=youtube)](https://youtu.be/0zq2YdOYFUo?si=Ng6favRkGL9faG_Y)
+
+
+## Contracts
 The wallet SDK is a rollup to thirdweb's smart wallet (ERC-4337) contracts. We've added the following contracts to extend it's functionality:
-<li> AccountGuardian.sol: Used to assign guardians for smart wallet accounts. </li>
-<li> Guardian.sol: Powers the guardian interactions, like attending to account lock & recovery requests. </li>
-<li> AccountLock.sol: Adds features like creating and evaluating account lock requests and locking the account assets, if consensus is achieved. </li>
-<li> AccountRecovery.sol: Offers the ability to back up account's private key shards, create and evaluate account recovery requests and help with account recovery overall. </li>
-<li> CrossChainTokenTransfer.sol: Provides creation of Chainlink's CCIP transfer request, signature verification, and finally implementation according to the ERC-4337 standards. </li>
+<li> <b>Account.sol:</b>This is the smart contract that powers the smart wallet by offering features like executing single or batched transactions, locking account assets and updating the owner of the smart account incase of an account recovery is made.</li>
+<li> <b>AccountGuardian.sol:</b> Used by the user to assign guardians for smart wallet accounts. </li>
+<li> <b>Guardian.sol:</b> Powers the guardian interactions, like attending to account lock & recovery requests for the account they are guarding. </li>
+<li> <b>AccountLock.sol:</b> Adds features like creating account lock requests and evaluating concensus on them followed by locking/unlocking the account assets.</li>
+<li> <b>AccountRecovery.sol:</b> One of the most important contracts adding features like creating account recovery requests and evaluating concensus on them. Once the concensus is achieved, a new embedded wallet is created and made the owner of the smart contract holding all user assets, thus recovering the account.</li>
+
 
 ## Documentation 
 
-[CryptoPhoenix Smart Wallet Contract Docs](https://chukwunonsos-personal-organizati.gitbook.io/cryptophoenix/)
+[**CryptoPhoenix Smart Wallet Contract Docs**](https://0xshiven.gitbook.io/cryptophoenix/)
 
-## Authors
+## Author: 
+### Shivendra Singh
+[![GitHub](https://img.shields.io/badge/GitHub-Profile-black?logo=github)](https://github.com/alfheimrShiven)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Profile-blue?logo=linkedin)](https://www.linkedin.com/in/shivends)
+[![Twitter](https://img.shields.io/badge/Twitter-Profile-blue?logo=twitter)](https://twitter.com/0xShiven)
+[![Substack](https://img.shields.io/badge/Substack-Newsletter-orange?logo=substack)](https://0xshiven.substack.com/)
 
-- [Shiven](https://github.com/alfheimrShiven)
-- [William](https://github.com/techyNonso)
 
 ## License