Skip to content

Commit

Permalink
Update readme to document burnerWallet changes on scaffold config
Browse files Browse the repository at this point in the history
  • Loading branch information
Pabl0cks committed Jul 7, 2023
1 parent fc031b2 commit 9dc2d0b
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,7 @@ export type ScaffoldConfig = {
pollingInterval: number;
alchemyApiKey: string;
walletConnectProjectId: string;
burnerWallet: {
enabled: boolean;
onlyLocal: boolean;
};
onlyLocalBurnerWallet: boolean;
walletAutoConnect: boolean;
// your dapp custom config, eg:
// tokenIcon : string;
Expand All @@ -163,13 +160,11 @@ The configuration parameters are described below, make sure to update the values
WalletConnect's default project ID from Scaffold ETH 2 for local testing purposes.
It's recommended to obtain your own project ID from the [WalletConnect website](https://cloud.walletconnect.com) and store it in an environment variable: `NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID` at `\packages\nextjs\.env` file.

- **burnerWallet**
You can activate the Burner Wallet feature, which provides a lightweight wallet for users.
- **onlyLocalBurnerWallet**
Controls the networks where the Burner Wallet feature is available. This feature provides a lightweight wallet for users.

- **enabled**
Set it to false to completely remove the Burner Wallet from all networks.
- **onlyLocal**
Set it to true to use the Burner Wallet only at local network (hardhat).
- `true` => Use Burner Wallet only on hardhat network.
- `false` => Use Burner Wallet on all networks.

- **walletAutoConnect**
Set it to true to activate automatic wallet connection behavior:
Expand Down

0 comments on commit 9dc2d0b

Please sign in to comment.