Skip to main content

Installation

This guide provides instructions for installing the HFT Signer Java SDK, which is designed for high-frequency trading applications.

Getting credentials​

To get the necessary credentials for accessing the Sodot JFrog Artifactory repository, use our guide here.

Minimum Requirements for Installation​

  • Java 17 compatibility
  • Maven 3.9 or higher

Install the SDK​

First, you need to configure your maven settings to include the Sodot JFrog Artifactory repository.

Add the following to your settings.xml file, which is located at ~/.m2/settings.xml on Unix-based systems or %USERPROFILE%\.m2\settings.xml on Windows:

<?xml version="1.0" encoding="UTF-8"?>
<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 http://maven.apache.org/xsd/settings-1.2.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.2.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <servers>
    <server>
      <username>${ARTIFACTORY_USER}</username>
      <password>${ARTIFACTORY_TOKEN}</password>
      <id>sodot-repo</id>
    </server>
  </servers>
  <profiles>
    <profile>
      <repositories>
        <repository>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
          <id>sodot-repo</id>
          <name>sodot-repo</name>
          <url>https://repo.sodot.dev/artifactory/sodot-java-sdk</url>
        </repository>
      </repositories>
      <id>artifactory</id>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>artifactory</activeProfile>
  </activeProfiles>
</settings>

Replace ${ARTIFACTORY_USER} and ${ARTIFACTORY_TOKEN} with your actual JFrog Artifactory username and token/password.

Next, add the HFT Signer Java SDK dependency to your pom.xml file in the <dependencies> section:

    <dependency>
      <groupId>dev.sodot.hftsigner</groupId>
      <artifactId>hft-signer-java-sdk</artifactId>
      <version>1.0.0</version>
    </dependency>