https://github.com/epam/openvasp-java-host
A reference implementation for a JAVA host for the OpenVASP standard. Not yet compatible with the current OpenVASP protocol version.
https://github.com/epam/openvasp-java-host
Last synced: 11 months ago
JSON representation
A reference implementation for a JAVA host for the OpenVASP standard. Not yet compatible with the current OpenVASP protocol version.
- Host: GitHub
- URL: https://github.com/epam/openvasp-java-host
- Owner: epam
- Created: 2020-04-14T14:06:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-14T17:25:28.000Z (over 3 years ago)
- Last Synced: 2025-07-07T21:32:44.115Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 471 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openvasp-java-host
[](https://open.vscode.dev/OpenVASP/openvasp-java-host)
This is a companion application to demo the `openvasp-java-client` implementation.
See for more information.
## Pre-requirements
- **Docker**. The OpenVASP Host depends on a couple of external services, *i.e.*, MySQL and Waku. Docker and Docker Compose are used to spin these services more easily.
- **JDK 8+**. To compile and execute the OpenVASP Spring-Boot demo application.
- **curl** *(Optional)*. To test API calls.
## Folder structure
```Project
+-- config
| |
| +-- dump <-- mysql dumps from test environment. All SQLs will be ingested automatically when docker compose is up
| +-- waku <-- basic configs for status node spin up
|
+-- src
| |
| +-- main <-- host backend codebase
| +-- test <-- host backend unit tests
|
+-- app.sh
+-- docker-compose.yml
```
## How to spin up
Compile and package the Spring Boot application
```sh
mvn package -DskipTests
```
`skipTests` is needed because currently they failed.
this creates `target/host-.jar` file that contains the Spring Boot application.
```bash
sh app.sh
java -Dspring.profiles.active=local,caffeine -jar ./target/host-.jar --openvasp.host.config=local --server.port=8080
```
or alternatively run
```sh
docker-compose up --detach
```
```sh
mvn spring-boot:run
```
## Testing
```bash
curl -H 'Authorization: Basic b3Zhc3A6MDctTWF5LTIwMjA=' http://localhost:8080/api/v1/counterparties/all
```
## Details
### (Add MySQL details)
Spin up DB (h2 / mysql)
### Waku/`statusd`
Use the following to spin up the Waku node/`statusd`
```sh
docker run --rm \ <<<
-p 8545:8545 \
-p 30303:30303 \
-v $(pwd)/waku.json:/waku.json \
statusteam/status-go \
-register \
-log DEBUG \
-c /waku.json
```
### Pipeline in Jenkins
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.