Multi-Chain Template

Overview

This implementation provides a reference implementation of an adapter that allows the Modular Messaging endpoint to communicate over Wormhole.

An adapter MUST implement the IAdapter interface defined in the Modular Messaging repo.

Runtime Support

• EVM
• SVM
• Sui Move
• Aptos Move

Developer Dependencies

Miscellaneous

• Node.js

Run npm ci at the root of this repo to install Prettier.

EVM

• Foundry

SVM

• Rust 1.75.0
• Solana 1.18.17
• Yarn
• Anchor 0.30.1

Required versions are defined in ./svm/rust-toolchain.toml and ./svm/Anchor.toml

Recommended VSCode Settings

Recommended VSCode settings and extensions have been included as workspace settings in this repository (.vscode).

This includes:

• Foundry's forge formatting
• Prettier
  • This should work after running npm ci at the root of this repo.

Additional, related settings may be required based on your use.

Recommended GitHub Settings

General

• Default branch: main
• Disallow merge commits
• Always suggest updating pull request branches
• Automatically delete head branches

Rules / Rulesets

• Ruleset Name: Require PRs
• Enforcement status: Active
• Target branches / Add target: Include default branch
• Branch rules
  • Restrict deletions
  • Require linear history
  • Require a pull request before merging
    • Required approvals: 1 (or more/less depending on your number of contributors)
    • Dismiss stale pull request approvals when new commits are pushed
    • Require review from Code Owners
    • Require approval of the most recent reviewable push
    • Require conversation resolution before merging
  • Require status checks to pass
    • Require branches to be up to date before merging
    • Add checks
      • Anchor Test
      • Foundry project
      • prettier
      • spellcheck
  • Block force pushes
• Restrictions [Enterprise Only]
  • Restrict commit metadata
    • Add restriction
      • Applies to: Commit message
      • Requirement: Must match a given regex pattern
      • Matching pattern:
        • ^(ci|evm|svm|readme){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*) for file/folder prefixes
        • or ^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*) to enforce conventional commits