JAVA core for the ColossusXT cryptocurrency (COLX)
Clone or download
Pull request Compare This branch is 20 commits ahead of PIVX-Project:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
core SPV block store record size increased to keep zerocoin header Aug 7, 2018
designdocs minor changes Apr 14, 2018
examples Rebranding May 28, 2018
jni minor changes Apr 14, 2018
misc minor changes Apr 14, 2018
orchid minor changes Apr 14, 2018
tools Rebranding May 28, 2018
wallettemplate --testnet=1 cmd param added to connect to the testnet May 28, 2018
.DS_Store Revert "minor changes" May 23, 2018
.gitattributes minor changes Apr 14, 2018
.gitignore minor changes Apr 14, 2018
.travis.yml minor changes Apr 14, 2018
AUTHORS minor changes Apr 14, 2018
COPYING minor changes Apr 14, 2018
README minor changes Apr 14, 2018
README.md Rebranding May 28, 2018
pom.xml Rebranding May 28, 2018

README.md

Welcome to colx

The colxj library is a Java implementation of the COLX protocol, which allows it to maintain a wallet and send/receive transactions without needing a local copy of COLX Core. It comes with full documentation and some example apps showing how to use it.

Technologies

  • Java 6 for the core modules, Java 8 for everything else
  • Maven 3+ - for building the project
  • Orchid - for secure communications over TOR
  • Google Protocol Buffers - for use with serialization and hardware communications

Getting started

To get started, it is best to have the latest JDK and Maven installed. The HEAD of the master branch contains the latest development code and various production releases are provided on feature branches.

Building from the command line

To perform a full build use

mvn clean package

or skip tests

mvn clean package -Dmaven.test.skip

or

mvn clean package -Dmaven.test.skip -Dmaven.javadoc.skip=true

You can also run

mvn site:site

to generate a website with useful information like JavaDocs.

The outputs are under the target directory.

Building from an IDE

Alternatively, just import the project using your IDE. IntelliJ has Maven integration built-in and has a free Community Edition. Simply use File | Import Project and locate the pom.xml in the root of the cloned project source tree.

Example applications

These are found in the examples module.

Forwarding service

This will download the block chain and eventually print a COLX address that it has generated.

If you send coins to that address, it will forward them on to the address you specified.

  cd examples
  mvn exec:java -Dexec.mainClass=org.colxj.examples.ForwardingService -Dexec.args="<insert a colx address here>"

Note that this example app does not use checkpointing, so the initial chain sync will be pretty slow. You can make an app that starts up and does the initial sync much faster by including a checkpoints file; see the documentation for more info on this technique.