-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,13 @@ | ||
| # 🏗 Scaffold-ETH 2 | ||
| # 🏗 Scaffold-ETH 2 | Smart Accounts | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://docs.scaffoldeth.io">Documentation</a> | | ||
| <a href="https://scaffoldeth.io">Website</a> | ||
| </h4> | ||
| This build is a first implementation of smart account using scaffold-ETH 2, the build implements (all the below features were made using the Particle Auth and AA SDKs): | ||
| - A web 2 auth using Google, this way of auth makes it easier for web 2 users that are not familiar with web 3 and the complexity of EOS, once the user logs in with his web2 account a wallet is created on the particle side. | ||
| - After logging in (using web2 or EOS), a smart account is created and linked to the connected address. | ||
| - Transactions batching, the users can mint and NFT and send it to an address in only 1 transactions. | ||
|
|
||
| 🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts. | ||
| Note that : | ||
| - The transactions fees are sponsored by the smart account, so once the smart account is funded all the expenses are made from the smart account side. | ||
|
|
||
| ⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript. | ||
|
|
||
| - ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. | ||
| - 🪝 **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion. | ||
| - 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend. | ||
| - 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet. | ||
| - 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network. | ||
|
|
||
|  | ||
|
|
||
| ## Requirements | ||
|
|
||
| Before you begin, you need to install the following tools: | ||
|
|
||
| - [Node (>= v18.17)](https://nodejs.org/en/download/) | ||
| - Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ## Quickstart | ||
|
|
||
| To get started with Scaffold-ETH 2, follow the steps below: | ||
|
|
||
| 1. Clone this repo & install dependencies | ||
|
|
||
| ``` | ||
| git clone https://github.com/scaffold-eth/scaffold-eth-2.git | ||
| cd scaffold-eth-2 | ||
| yarn install | ||
| ``` | ||
|
|
||
| 2. Run a local network in the first terminal: | ||
|
|
||
| ``` | ||
| yarn chain | ||
| ``` | ||
|
|
||
| This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `hardhat.config.ts`. | ||
|
|
||
| 3. On a second terminal, deploy the test contract: | ||
|
|
||
| ``` | ||
| yarn deploy | ||
| ``` | ||
|
|
||
| This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script. | ||
|
|
||
| 4. On a third terminal, start your NextJS app: | ||
|
|
||
| ``` | ||
| yarn start | ||
| ``` | ||
|
|
||
| Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. | ||
|
|
||
| Run smart contract test with `yarn hardhat:test` | ||
|
|
||
| - Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts` | ||
| - Edit your frontend in `packages/nextjs/pages` | ||
| - Edit your deployment scripts in `packages/hardhat/deploy` | ||
|
|
||
| ## Documentation | ||
|
|
||
| Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2. | ||
|
|
||
| To know more about its features, check out our [website](https://scaffoldeth.io). | ||
|
|
||
| ## Contributing to Scaffold-ETH 2 | ||
|
|
||
| We welcome contributions to Scaffold-ETH 2! | ||
|
|
||
| Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2. | ||
| TODO (for now): | ||
| - Paying fees with other ERC-20. | ||
| - Implementing a paymaster that will sponsor the fees instead of the smart account. |