Add instructions to perform checksums
1 file changed
tree: a8495f866e63c6bb6feb74b04d8f4bd7a6ea9f64
  1. .circleci/
  2. .editorconfig
  3. .gitattributes
  4. .gitignore
  5. .gitmodules
  6. .idea/
  7. .rat-excludes
  8. CONTRIBUTING.md
  9. DISCLAIMER
  10. KEYS
  11. LICENSE
  12. NOTICE
  13. PACKAGES.md
  14. README.md
  15. RELEASE.md
  16. build.gradle
  17. bytes/
  18. concurrent-coroutines/
  19. concurrent/
  20. config/
  21. crypto/
  22. dependency-versions.gradle
  23. devp2p/
  24. dist/
  25. eth-reference-tests/
  26. eth-repository/
  27. eth/
  28. gossip/
  29. gradle.properties
  30. gradle/
  31. gradlew
  32. gradlew.bat
  33. io/
  34. junit/
  35. kademlia/
  36. kv/
  37. les/
  38. merkle-trie/
  39. net-coroutines/
  40. net/
  41. plumtree/
  42. progpow/
  43. rlp/
  44. rlpx/
  45. scuttlebutt-discovery/
  46. scuttlebutt-handshake/
  47. scuttlebutt-rpc/
  48. scuttlebutt/
  49. settings.gradle
  50. ssz/
  51. toml/
  52. units/
README.md

Tuweni: Apache Core Libraries for Java (& Kotlin)

Build Status License Maven Central Sonatype Nexus (Snapshots)

Tuweni is a set of libraries and other tools to aid development of blockchain and other decentralized software in Java and other JVM languages.

It includes a low-level bytes library, serialization and deserialization codecs (e.g. RLP), various cryptography functions and primatives, and lots of other helpful utilities.

Tuweni is developed for JDK 1.8 or higher, and depends on various other FOSS libraries, including Guava.

Getting tuweni

The libraries are published to the Apache Nexus Repository, synced to JCenter and Maven Central.

You can import all modules using the tuweni jar.

With Maven:

<dependency>
  <groupId>org.apache.tuweni</groupId>
  <artifactId>tuweni</artifactId>
  <version>1.0.0</version>
</dependency>

With Gradle: compile 'org.apache.tuweni:tuweni:1.0.0'

PACKAGES.md contains the list of modules and instructions to import them separately.

Getting snapshots

We publish a new snapshot on every change of the master branch.

Snapshots are stored under the Apache snapshots repository.

With Maven, add this repository with:

 <repositories>
    <repository>
      <id>apache.snapshots</id>
      <name>Apache Snapshot Repository</name>
      <url>https://repository.apache.org/snapshots</url>
      <releases>
        <enabled>false</enabled>
      </releases>
    </repository>
  </repositories>
<dependency>
  <groupId>org.apache.tuweni</groupId>
  <artifactId>tuweni</artifactId>
  <version>1.1.0-SNAPSHOT</version>
</dependency>

With gradle:

maven { url "https://repository.apache.org/snapshots"}

compile 'org.apache.tuweni:tuweni:1.1.0-SNAPSHOT'

Build Instructions

To build, clone this repo and run with ./gradlew like so:

git clone --recursive https://github.com/apache/incubator-tuweni
cd incubator-tuweni
./gradlew

After a successful build, libraries will be available in build/libs.

Contributing

Your contributions are very welcome! Here are a few links to help you:

Mailing lists

More information

License

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.