Skip to content

development.md

Latest commit

 

History

History
182 lines (127 loc) · 5.37 KB

development.md

File metadata and controls

182 lines (127 loc) · 5.37 KB

Development Guide

This document outlines the process to set up a development environment for the mirror node. It covers the required software, environment setup, IDE configurations, project compilation, and how to run tests.

Prerequisites

To contribute to the mirror node project, you need to install the following software and tools:

Java

Requires Java 25 for development. On Ubuntu and macOS we recommend using SDKMAN! to manage JVM versions:

curl -s "https://get.sdkman.io" | bash
sdk install java 25-tem
sdk use java 25-tem
java -version

Docker

Docker is used to manage and run containerized services (such as databases) for the mirror node. To install Docker, follow the get started guide on docker.com.

Coding Standards

We follow best practices to ensure that code quality and maintainability remain high. Below are the key coding standards to follow:

  1. Java Coding Style: Follow the Google Java Style Guide for writing clean and readable Java code.
  2. Kotlin Style: Follow the Kotlin Style Guide for Kotlin-based files.
  3. Spotless Plugin: The project uses the Spotless plugin to enforce consistent formatting. You can run this before submitting code: 
    ./gradlew spotlessApply

IDE Setup

We recommend using IntelliJ IDEA for development.

IntelliJ IDEA Setup

  1. Install IntelliJ IDEA:

    • Download IntelliJ IDEA from JetBrains.

  2. Set up Project SDK:

    • Go to File > Project Structure > Project.
    • Set Project SDK to the version of Java installed previously.
    • Set Project language level to SDK Default.

  3. Gradle Configuration:

    • Go to IntelliJ IDEA > Settings > Build, Execution, Deployment > Build Tools > Gradle
    • Ensure Gradle JVM is set to Project SDK.

  4. Enable Save Actions:

    • Go to IntelliJ IDEA > Settings > Tools > Actions on Save
    • Enable the following save actions:
      • Reformat code: Ensures consistent code style by reformatting code on save.
      • Optimize imports: Automatically removes unused imports and arranges them.
      • Rearrange code: Arranges code based on predefined rules.
      • Run code cleanup: Cleans up unnecessary elements in the code.
      • Build project: Automatically builds the project upon saving if needed.

  5. Import Java Code Style:

    • Download the Java code file located in the repository at docs/palantir-style.xml
    • Go to IntelliJ IDEA > Settings > Editor > Code Style > Java.
    • Choose ⚙️ (gear icon) > Import Scheme > IntelliJ IDEA code style XML.
    • Import the downloaded Java code style file to ensure consistent formatting across the project.

Compiling the Project

This project uses Gradle for building and managing dependencies. It's not necessary to install Gradle locally as the project automatically downloads it via the Gradle Wrapper.

  1. Clean and Build the Project: Run the following command to clean and build the project:

    ./gradlew clean build

    This command will:

    • Clean previous builds.
    • Compile the source code.
    • Download any required dependencies.
    • Run tests.

  2. Compile Specific Subprojects: If you want to build a specific subproject (e.g., monitor), run:

    ./gradlew :monitor:build

Running Tests

You can run the project’s tests using Gradle.

  1. Run All Tests: To run all the tests, use:

    ./gradlew test

  2. Run Tests for a Specific Subproject: To run tests for a specific subproject (e.g., common):

    ./gradlew :common:test

  3. Running Specific Tests: You can also run specific test classes or methods:

    ./gradlew test --tests "*YourTestClassName"

    or:

    ./gradlew test --tests "*YourTestClassName.yourTestMethodName"

Docker Integration for Local Development

The mirror node often depends on containerized services such as PostgreSQL or Redis. These services are defined in docker-compose files within the repository.

  1. Start Docker Services: To start all services needed for local development:

    docker compose up

  2. Stop Docker Services: To stop the services:

    docker compose down

Container Images

For production or deployment, you may need to generate container images.

  1. Build Container Images: You can build container images using Gradle and specify custom properties to control the platform, registry, and tag.

    ./gradlew dockerBuild \
-PimagePlatform=linux/amd64 \
-PimageRegistry=docker.io/mydockerid \
-PimageTag=1.0.0-SNAPSHOT

  2. Push Container Images: After building the container image, you can push it to the specified image registry to make it available for use in a remote Kubernetes environment.

       ./gradlew dockerPush \
   -PimagePlatform=linux/amd64 \
   -PimageRegistry=docker.io \
   -PimageTag=1.0.0-SNAPSHOT

    Note: Ensure you are logged into the image registry if authentication is required. This command will push the image with the specified tag to the registry.