Public Avalanche SDKS

This is an official Ava Labs monorepo used as a testbed for various open source projects.

Getting Started 🚀

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

Status

public-avalanche-sdks is considered ALPHA software and is not safe to use in production. The repo is under active development and may change significantly over the coming months as its packages are optimized and audited.

What's inside? 🔍

Apps

These are apps published to the web

• teleporter-demo: This is a demo of the Avalanche Teleporter cross-chain messaging system for EVM subnets.

Packages

These Packages are published to NPM

• vm-parser (🚧 WIP 🚧): Parse arbitrary VM data for display in the Avalanche Subnet Explorer.

Internal Packages

These packages are only used internally within this repo

• tsconfig: tsconfig for sdks
• tsupp-config: tsup for sdks
• eslint-config-custom: eslint config for sdks
• github-actions: eslint config for sdks

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 in #versioning-and-publishing-packages

Versioning and Publishing packages

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.

Contributing

If you're interested in contributing, please read the contributing docs before submitting a pull request.