Skip to content

ColossusCoinXT/COLXj

 
 

Repository files navigation

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.

About

JAVA core for the ColossusXT cryptocurrency (COLX)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 93.3%
  • C 6.3%
  • C++ 0.4%
  • CSS 0.0%
  • Makefile 0.0%
  • Batchfile 0.0%