AVM Tools

A monorepo that contains types, utilities and general tools that help developers navigate the AVM ecosystem.

---

Table Of Contents

• 1. Overview
  • 1.1. Monorepo Project Structure
• 2. Getting Started
  • 2.1. Requirements
  • 2.2. Installation
• 3. Appendix
  • 3.1. Packages
• 4. How To Contribute

🗂️ 1. Overview

1.1. Monorepo Project Structure

The repo follows the following structure:

.
├─ packages
│   ├── <package>
│   │   ├── .lintstagedrc.mjs
│   │   ├── LICENSE
│   │   ├── package.json       <-- contains package dependencies and is used to run package-level scripts
│   │   ├── README.md
│   │   ├── release.config.mjs <-- semantic release configuration
│   │   └── ...
│   └── ...                    <-- other packages
├── package.json               <-- root package.json that contains top-level dependencies and tools
└── ...

Root package.json

The root package.json utilizes pnpm's workspace feature. The root package.json should only reference packages that are used at the root level or are utilities/tools.

packages/ Directory

The packages/ directory contains, as the name suggests, the packages of the monorepo.

packages/<package> Directory

Each package SHOULD reflect the name of the package, i.e. the packages/sigillum/ and SHOULD contain the following files and directories:

• .lintstagedrc.mjs - Scripts to run on the pre-commit hook. This file is REQUIRED, however, if there are no scripts to run, use an empty file.
• LICENSE - The license for the package.
• package.json - The package's dependencies and is used to run package-level scripts.
• README.md - Contains installation and usage instructions relevant to the package.
• release.config.mjs - The local semantic-release configuration.

🪄 2. Getting Started

2.1. Requirements

• Install Node v20.18.0+
• Install pnpm v10.3.0+

^{Back to top ^}

2.2. Installation

1. Install the dependencies using:

pnpm install

^{Back to top ^}

📑 3. Appendix

3.1. Packages

Name	Visibility	Description	Package
@agoralabs/bytes	public	Utilities for handling byte arrays.
@agoralabs/uuid	public	A UUID v4 utility package that allows generation and encoding/decoding.
@agoralabs-sh/vip030026	public	Various utilities and tools that allow for the creation and manipulation of credentials that conform to the VIP-03-0026 standard.

^{Back to top ^}

👏 4. How To Contribute

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}