https://github.com/cardano-foundation/hydra-java
Incubation project for Java client for Hydra L2 solution.
https://github.com/cardano-foundation/hydra-java
Last synced: 14 days ago
JSON representation
Incubation project for Java client for Hydra L2 solution.
- Host: GitHub
- URL: https://github.com/cardano-foundation/hydra-java
- Owner: cardano-foundation
- License: mit
- Created: 2023-02-22T08:35:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-06T21:33:33.000Z (over 1 year ago)
- Last Synced: 2024-05-18T22:04:03.556Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 423 KB
- Stars: 12
- Watchers: 10
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# hydra-java
[](https://github.com/cardano-foundation/hydra-java/actions/workflows/maven-build.yml)
[](https://github.com/cardano-foundation/hydra-java/blob/master/LICENSE)
[](https://discord.gg/4WVNHgQ7bP)
This is an **incubator project**, which simplifies working with Hydra from java applications. Hydra is an isomorphic state machine L2 network, which works seamlessly with Cardano.
## Hydra
You can access documentation regarding Hydra here: https://hydra.family/head-protocol/. We recommend especially to follow QuickStart on devnet network (https://hydra.family/head-protocol/docs/getting-started/quickstart) and (https://hydra.family/head-protocol/docs/getting-started/demo/with-docker) as well as reading (https://hydra.family/head-protocol/docs/tutorial/using_hydra/using-hydra-part-3)
Hydra API specs: https://hydra.family/head-protocol/api-reference
Hydra State Machine Diagram: https://hydra.family/head-protocol/core-concepts/behavior
## Requirements
- JDK17
- maven3
## Building
```
git clone https://github.com/cardano-foundation/hydra-java
cd hydra-java
mvn clean install
```
## Running integration tests
```shell
mvn clean verify -P with-integration-tests
```
## Version Compatibility Matrix
| Hydra Version | Library Version | Cardano Client Library Version | JDK VERSION |
|---------------|-----------------|--------------------------------|-------------|
| 0.10.x | 0.0.6 | 0.4.x | JDK 11 |
| 0.10.x | 0.0.7 | 0.5.x | JDK 11 |
| 0.10.x | 0.0.8 | 0.5.x | JDK 11 |
| 0.13.x | 0.0.9 | 0.5.x | JDK 17 |
| 0.13.x | 0.0.10 | 0.5.x | JDK 17 |
## Dependency
```xml
org.cardanofoundation
hydra-java-core
0.0.10
org.cardanofoundation
hydra-java-client
0.0.10
org.cardanofoundation
hydra-java-cardano-client-lib-adapter
0.0.10
org.cardanofoundation
hydra-java-reactive-reactor-client
0.0.10
```
## Project Missing features / functionality
The current version may not contain exactly what you need. If there is a missing feature / functionality, we happily accept pull requests. Ideally please discuss with us the idea first, file an issue and let's agree on design of it. Should pull request not be possible we are open to do the work for you provided the github issue is raised and documented well enough to understand it.
## Additional Docs
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
- [SECURITY.md](SECURITY.md)
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CHANGELOG.md](CHANGELOG.md)
## Modules
| Submodule | Goal / Description |
|----------------------------|----------------------------------------------------------------------------|
| hydra-java-core | main classes / code |
| hydra-java-client | low level web socket client |
| reactive-reactor-client | experimental request / response high level reactive client (using reactor) |
| cardano-client-lib-adapter | bindings to BloxBean's cardano-client lib |
| test-containers-support | utilities to assist in testing via test containers project |
## Example usage (client)
For examples please refer to integration tests in hydra-java-client and hydra-java-reactive-reactor-client projects.