https://github.com/evmts/evmts-esbuild-viem-example
A forkable evmts+esbuild+viem starter project
https://github.com/evmts/evmts-esbuild-viem-example
Last synced: 9 months ago
JSON representation
A forkable evmts+esbuild+viem starter project
- Host: GitHub
- URL: https://github.com/evmts/evmts-esbuild-viem-example
- Owner: evmts
- Created: 2023-07-10T05:49:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-16T20:26:14.000Z (almost 3 years ago)
- Last Synced: 2025-04-10T21:51:51.440Z (about 1 year ago)
- Language: Solidity
- Size: 70.3 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
EVMts esbuild viem Boilerplate
To use this plugin with Visual Studio Code, you should set your workspace's version of TypeScript, which will load plugins from your tsconfig.json file.
For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
## ✨ What is this?
This is a [EVMts](https://evmts.dev) + [viem](https://viem.sh) ! [esbuild](https://esbuild.github.io/api/) boilerplate to get started using EVMts quickly
EVMts allows you to import Solidity directly into your NEXT.js typescript files with great editor support and minimal boilerplate. Features include
- Etherscan links on hover
- Human readable ABIs
- Seemless integration with wagmi for reads, writes, and events
- No ABIs referenced again just import the contract directly
- No Addresses needed to be copy pasted just configure them in the [tsconfig](./tsconfig.json)
## 🌟 EVMts features
- Direct contract imports with etherscan links on hover
- [Read example](./src/wagmi/WagmiReads.tsx)
- [Write example](./src/wagmi/WagmiWrites.tsx)
- [Events example](./src/wagmi/WagmiEvents.tsx)
# 📜 Docs
EVMts docs exist at [evmts.dev](https://evmts.dev). As EVMts is currently still in Alpha and following [documentation driven development](https://gist.github.com/zsup/9434452) much of the documented behavior may not be implemented yet.
# 🤝 Getting Started
Run `npm run dev` in your terminal. If you are not using node18 you may have to pass in `--experimental-fetch` to node. Use [NVM](https://github.com/nvm-sh/nvm) with `nvm use` command to use this workspaces node version
# 🔧 Configuration
This boilerplate comes preconfigured but we will document what needed to be configured in case you are following along to add to your own NEXT.js app
EVMts requires two pieces of configuration to get started.
1. TypeScript configuration
`@evmts/ts-plugin` is configured in the [tsconfig.json](./tsconfig.json). EVMts uses this configuration to configure the addresses, solc version etc. The TypeScript plugin provides TypeScript editor support for your Solidity imports.
2. Bundler configuration
The bundler is how the files are processed at runtime. This boilerplate uses esbuild. Simple esbuild configuration is done in the [build.ts](./build.ts) file. The plugin here will read the configuration in the [tsconfig.json](./tsconfig.json)
## 🪄 Usage examples
Usage examples are in [src](./src/) folder
## 💻 VSCode setup
- **Recommended usage**
To use this plugin with Visual Studio Code, you should set your workspace's version of TypeScript, which will load plugins from your tsconfig.json file.
For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
- **Alternative usage**
You can simple add this plugin to "typescript.tsserver.pluginPaths" in settings. You cannot provide plugin options such as contract addresseswith this approach.
{
"typescript.tsserver.pluginPaths": ["@evmts/ts-plugin"]
}
- **Other editors**
Other editors are not tested/documented yet. I personally use neovim successfully and it should work in most editors. They all work via the ts-plugin settings similar to vscode.
## 🩹 Rough edges
#### Typechecking
Typechecking is disabled in the next.config.ts. Your editor will typecheck and provide diagnostics correctly but the NEXT.js build is not configured yet.
Full TypeChecking will be available soon in one of the next few releases of EVMts alpha after it migrates the langauge server to [volar](https://volarjs.github.io/)
## ⭐ Github
If you like EVMts give it a ⭐ at the [EVMts monorepo](https://github.com/evmts/evmts-monorepo)
## 🔗 See also
- Check out [Next example](https://github.com/orgs/evmts/repositories) for an example of EVMts wagmi and Next
- Check out [Vite example](https://github.com/evmts/evmts-monorepo/tree/main/examples/vite) for an example of EVMts wagmi and Vite