Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
PrintRH committed Mar 8, 2024
1 parent 8df2d45 commit c151674
Showing 1 changed file with 33 additions and 55 deletions.
88 changes: 33 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,53 @@
# 🏗 Scaffold-ETH 2

<h4 align="center">
<a href="https://docs.scaffoldeth.io">Documentation</a> |
<a href="https://scaffoldeth.io">Website</a>
</h4>
## Smart Wallet Scaffold ETH

🧪 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.
This codebase is as an integration on top of [Scaffold-ETH 2](https://scaffoldeth.io/). I learned about Smart Wallets at Base House ETH Denveer, and got really excited to set this up and share with everyone!

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.
## About Smart Wallet

-**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.
- Provides capability to create wallets using passkey ([ERC-4337](https://eips.ethereum.org/EIPS/eip-4337))
- Removes hassle of remembering seed phrases and private keys

![Debug Contracts tab](https://github.com/scaffold-eth/scaffold-eth-2/assets/55535804/b237af0c-5027-4849-a5c1-2e31495cccb1)
## Wallet Demo

## 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)
[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/F82n7ePUo6M/1.jpg)](https://youtu.be/F82n7ePUo6M)

## 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.
Quickstart for Scaffold ETH Users:

4. On a third terminal, start your NextJS app:
1. Clone Scaffold ETH Repo
```
git clone https://github.com/scaffold-eth/scaffold-eth-2.git
cd scaffold-eth-2
```
2. Specify resolution to use the wallet SDK beta version in `package.json`
```
{
"resolutions": {
"@coinbase/wallet-sdk": "npm:@coinbase/wallet-sdk@4.0.0-beta.0"
}
}
```
```
yarn start
```
3. Install dependencies
```
yarn install
```
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`.
4. Start NextJS App
```
yarn start
```
Run smart contract test with `yarn hardhat:test`
5. Test it on your localhost!
- 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
## Documentation
For more documentation on Smart Wallets, check out the [docs](https://docs.cloud.coinbase.com/wallet-sdk/docs/sw-setup) from Base here.
Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2.
Visit [Scaffold-ETH 2 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).
Expand Down

0 comments on commit c151674

Please sign in to comment.