/belgraderocks

Primary LanguageTypeScriptMIT LicenseMIT

What's included

  • SvelteKit app
    • Auto-generated and fully-typed ABIs using wagmi-generate
    • Web3modal connect button using wagmi-core
  • Foundry contracts
    • Configured for easy multi-chain deployments

Create your dapp with one-click deploy button (recommended)

Deploy with Vercel

  1. Click the Deploy with Vercel button above
  2. Clone and cd the repo that was created by Vercel using git clone <REPO_NAME> && cd <REPO_NAME>
  3. Install Foundry dependency because Vercel doesn't clone the submodules: forge install foundry-rs/forge-std (must have foundry installed, see here: https://book.getfoundry.sh/getting-started/installation)
  4. Install packages and copy .env.example files: sh setup.sh
  5. Set mnemonic phrase in root .env for test accounts (generate a bip39 mnemonic)
  6. Set web3modal project id in .env (obtain a project id for web3modal)

Create your dapp manually

  1. Clone/fork the repo: git clone https://github.com/d1onys1us/dapp-slaps.git
  2. Install packages and copy .env.example files: cd dapp-slaps && sh setup.sh
  3. Set mnemonic phrase in root .env for test accounts (generate a bip39 mnemonic)
  4. Set web3modal project id in .env (obtain a project id for web3modal)
  5. Source environment vars: source .env
  6. (optional) if using vscode check the vscode config section

Start the development environment

You will have three development windows, start them all and source all .env files with source .env && source packages/app/.env.

  1. Start local chain: anvil -m $MNEMONIC
  2. Deploy the Foo contract: forge script Deploy --broadcast --rpc-url $FOUNDRY && pnpm -F app wagmi:generate
  3. Start app: pnpm -F app dev

Get testnet ETH

Sepolia

Goerli

Common app commands

Start the app locally

pnpm -F app dev

Generate typed ABIs from Foundry contracts

pnpm -F app wagmi

Common Foundry commands

Install a Foundry package

  1. Start by installing the package (example: openzeppelin-contracts):
forge install OpenZeppelin/openzeppelin-contracts
  1. Regenerate the remappings for the contract imports (run this from the project root):
forge remappings > remappings.txt

Start local anvil chain from mnemonic

anvil -m $MNEMONIC

Deploy contracts to some chain and generate types

forge script Deploy --broadcast --rpc-url $FOUNDRY && pnpm -F app wagmi:generate

Troubleshooting

  • Try resetting account in MetaMask
  • Try clearing all browser storage
  • Try disconnecting account and reconnecting
  • Ensure all env vars are set

Acknowledgements