@evmts/plugin v0.0.1
@evmts/plugin
A rollup plugin for importing solidity files.
Currently @evmts/plugin only works in forge projects but work to make it support all wagmi plugins is underway
Instalation
pnpm i @evmts/plugin
Vite usage
Install rollup plugin
npm i @evmts/plugin
Add to your vite config
import { evmtsPluginrollup } from '@evmts/plugin`
import { defineConfig } from 'vite'
export default defineConfig({
plugins: [evmtsPluginRollup()]
})
Rollup usage
const { evmtsPlugin } = require('@evmts/plugin');
module.exports = {
...
plugins: [evmtsPlugin()]
};
ConfigOptions
To configure pass in the forge executable and the root folder that your foundery.toml is in
plugins: [
evmtsPlugin({
forgeExecutable: "forge",
projectRoot: __dirname,
}),
];
How it works
Under the hood this plugin will transform solidity imports
When the plugin sees a solidity import it will make the following changes
- Update the import to import a .ts file
- import scripts from './MyScript.sol'
+ import scripts from './MyScript.sol.ts'
Insert a new typescript file MyScript.sol.ts as an artifact
// MyScript.sol.ts
export default {
name,
artifactPath,
contractPath,
address,
abi,
bytecode,
};
The typescript can then go ahead and use the artifacts however it pleases
Usage in @evmts/core
See full evms-core for how it's used in evmts. This plugin can be used in other repos as well.
Usage in other libraries
Currently only @evmts/core
is using this but this could easily be adapted or extended for other libraries.
Autocompletion and Typesafety
For typesafety and autocompletion in your editor add @evmts/ts-plugin to your tsconfig.json.
Custom Ts plugins are for developer experience only
The typescript compiler does not use custom ts plugins at compile time only in your editor. You will get red squiggly lines telling you something is wrong but it will still compile.
1 year ago