General Description and Overview

Introduction

The Whiteflag Java Library (WFJL) is an implementation of the Whiteflag Protocol in Java to support the development of Whiteflag-enabled applications.

The WFJL is to support all Whiteflag protocol features, but with minimal dependencies. Therefore, the library is independent from any specific blockchain, database solution, user interface, etc.

Documentation

Detailed API and Source Code References

• WFJL Javadoc API Reference

Source Code Description

• Package Structure
• High Level Overview
• Exception Handling
• Whiteflag Messages
• Cryptography

Installation

To use the WFJL, its GitHub package should be added to your project as a dependency using the following “group:artifact:version” information, with the most recently published version:

org.whiteflagprotocol.java:whiteflag-java:1.1.1

For example, when using Gradle, the following should be included in your build.gradle file:

dependencies {
  implementation 'org.whiteflagprotocol.java:whiteflag-java:1.1.1'
}

or in your pom.xml when using Maven:

<dependency>
  <groupId>org.whiteflagprotocol.java</groupId>
  <artifactId>whiteflag-java</artifactId>
  <version>1.1.0</version>
</dependency> 

Note that you also need to add the GitHub WFJL package repository URL https://maven.pkg.github.com/whiteflagprotocol/whiteflag-java to your project. Please see the GitHub documentation for detailed information about installing packages from the GitHub repository with either Maven or Gradle.