3
0
mirror of https://github.com/Qortal/altcoinj.git synced 2025-01-30 14:52:16 +00:00
altcoinj/README.md

47 lines
1.3 KiB
Markdown
Raw Normal View History

2020-02-26 12:45:21 +00:00
[![Apache-2](https://img.shields.io/badge/license-Apache-2.svg)](COPYING)
[![](https://jitpack.io/v/jjos2372/altcoinj.svg)](https://jitpack.io/#jjos2372/altcoinj)
2016-01-08 20:37:00 +00:00
2020-02-26 12:45:21 +00:00
### Welcome to altcoinj
The altcoinj (forked from [libdohj](https://github.com/dogecoin/libdohj)) library is a lightweight
Java library around the [bitcoinj](https://bitcoinj.github.io/),
with updated support for Litecoin and Dogecoin.
Pull requests for support for other altcoins would be welcomed.
### Getting started
2020-02-26 12:45:21 +00:00
You should be familiar with [bitcoinj](https://bitcoinj.github.io/) first, as this library simply adds minor
changes to extend bitcoinj. Generally using altcoinj is equivalent to using
bitcoinj, except with different network parameters (reflecting altcoin consensus
in place of Bitcoin).
2020-02-26 12:45:21 +00:00
Add the following to your gradle.build file:
```
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compile 'com.github.jjos2372:altcoinj:f26e20bb13'
compile 'org.bitcoinj:bitcoinj-core:0.15.6'
}
```
Be aware however that altcoin blocks have their own class, AltcoinBlock, which
adds support for features such as AuxPoW.
#### Building from the command line
2020-02-26 12:45:21 +00:00
Simply run on the command line
```
2020-02-26 12:45:21 +00:00
./gradlew jar
```
2020-02-26 12:45:21 +00:00
The outputs are under the `build` directory.
#### Building from an IDE
2020-02-26 12:45:21 +00:00
Alternatively, just import the project on your preferred IDE as a *gradle* project.