VM Modules

Getting Started 🚀

pnpm i        # installs all dependencies
pnpm build    # builds all packages

What's inside? 🔍

Packages

External

These Packages are published to NPM

• evm-module: EVM module
• avalanche-module: Avalanche module
• bitcoin-module: Bitcoin module
• hvm-module: Hyper VM Module
• svm-module: Solana Virtual Machine module
• types: shared types for modules

Internal

These packages are only used internally within this repo

• tsconfig: tsconfig for modules
• eslint-config-custom: eslint config for modules
• github-actions: custom github actions
• utils: utils for all vm-module packages

Each package and app is 100% TypeScript.

Useful commands

• pnpm build - Build all packages
• pnpm dev - Develop all packages
• pnpm lint - Lint all packages
• pnpm changeset - Generate a changeset. See Versioning and Publishing packages

Versioning and Publishing packages

Versioning

Run pnpm changeset on your branch and follow the CLI prompts to put in the summary and it will create the xxx.md file under .changeset directory. Push the change and create the PR.

Once the PR is merged, a new PR will be auto generated to bump the version to packages listed in the xxx.md file, and the summary in CHANGELOG.md

Publishing

Package publishing has been configured using Changesets. Please review their documentation to familiarize yourself with the workflow.

This repo has an automated npm releases setup in a GitHub Action using the Changesets bot.