Qortal/altcoinj
3
0
Fork 0
mirror of https://github.com/Qortal/altcoinj.git synced 2025-01-30 14:52:16 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md to match libdohj not dogecoinj

Browse Source
This commit is contained in:
Ross Nicoll 2015-08-23 12:31:46 +01:00
parent 562ea4f56c
commit 98ae05b0a1
1 changed files with 12 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,20 +1,19 @@
### This branch is the latest version with name changes. The old branch is still up under old-master!
### Welcome to libdohj
### Welcome to dogecoinj
The dogecoinj library is a Java implementation of the Dogecoin protocol, which allows it to maintain a wallet and send/receive transactions without needing a local copy of Dogecoin Core. It comes with full documentation and some example apps showing how to use it.
This is a port of bitcoinj. All credits for the hard work goes to the bitcoinj team. The Dogecoin developers did the adaption to the Dogecoin protocol.
### Technologies
* Java 6 for the core modules, Java 8 for everything else
* [Maven 3+](http://maven.apache.org) - for building the project
* [Orchid](https://github.com/subgraph/Orchid) - for secure communications over [TOR](https://www.torproject.org)
* [Google Protocol Buffers](https://code.google.com/p/protobuf/) - for use with serialization and hardware communications
The libdohj library is a lightweight wrapper library around the bitcoij Java library,
enabling support for Dogecoin (pull requests for support for other altcoins would
be welcomed).
### 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.
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.
You should be familiar with bitcoinj first, as this library simply adds minor
changes to extend bitcoinj. Generally using libdohj is equivalent to using
bitcoinj, except with different network parameters (reflecting Dogecoin consensus
in place of Bitcoin).
Be aware however that altcoin blocks have their own class, AltcoinBlock, which
adds support for features such as AuxPoW.
#### Building from the command line
@ -34,24 +33,3 @@ The outputs are under the `target` directory.
Alternatively, just import the project using your IDE. [IntelliJ](http://www.jetbrains.com/idea/download/) 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 Dogecoin 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=com.dogecoin.dogecoinj.examples.ForwardingService -Dexec.args="<insert a dogecoin 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.
### Where next?
Now you are ready to [follow the tutorial](https://bitcoinj.github.io/getting-started).