Core is a tools provide reusable components, utilities, and infrastructure for building EasyLayer apps.

---

Website | Docs | Discussions

---

EasyLayer Core Packages

This repository contains the core packages for EasyLayer applications. It includes common modules and blockchain components:

• @easylayer/common: Shared utilities, CQRS, event sourcing and more.
• @easylayer/bitcoin: Bitcoin blockchain integration and utilities.
• @easylayer/evm: EVM-compatible blockchain integration and utilities.

EasyLayer provides a suite of ready-to-use, self-hosted solutions for blockchain indexing and real-time crypto processing. Our tools help developers and businesses easily integrate cryptocurrencies into their projects and operations.

Table of Contents

• Developer Setup
• Documentation
• Contributing
• Issue Reporting
• License

Developer Setup

Node.js version: 17 or higher is required. We recommend using the latest LTS (currently 22+).
Yarn version: 4.5+ is required (Yarn Berry).
Yarn is included in the repository under .yarn/releases/, so you do not need to install it globally.
You can run all commands using yarn if you have Yarn 4+ or Corepack enabled, or use node .yarn/releases/yarn-4.5.0.cjs <command> directly.

1. Clone the repository:

git clone https://github.com/easylayer/core.git
cd core

2. Install dependencies:

yarn install

3. Build all packages:

yarn build

4. Run unit tests:

yarn test:unit

5. Lint and format code:

yarn lint
# or
yarn lint:fix

Documentation

Developer documentation is generated using TypeDoc:

yarn docs:development:generate

The generated docs will be available in the typedoc/ directory.

Contributing

We welcome contributions! To get started:

• Fork this repository and create a new branch for your feature or bugfix.
• Make your changes and ensure all tests and lints pass locally.
• Submit a pull request (PR) to the development branch.
• • All PRs must use the provided pull request template.
• • Branch names and commit messages must follow the Conventional Changelog style. Allowed types: feat, fix, infra, refactor, chore, BREAKING (see .czrc for details). Please use descriptive messages for each commit.
• • All PRs are automatically checked by our GitHub Actions workflow (build, lint, unit tests).

Issue Reporting

If you encounter a bug or have a feature request related to the core repository, please open an issue and provide as much detail as possible. For issues related to other EasyLayer projects, please use the appropriate repository.

License

This project is licensed under the License.