Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limechain/fruzhin
Java implementation of the Polkadot Host
https://github.com/limechain/fruzhin
blockchain java libp2p polkadot wasm
Last synced: about 9 hours ago
JSON representation
Java implementation of the Polkadot Host
- Host: GitHub
- URL: https://github.com/limechain/fruzhin
- Owner: LimeChain
- License: apache-2.0
- Created: 2023-02-23T13:37:28.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-10-29T08:25:12.000Z (17 days ago)
- Last Synced: 2024-10-29T09:23:57.271Z (17 days ago)
- Topics: blockchain, java, libp2p, polkadot, wasm
- Language: Java
- Homepage:
- Size: 129 MB
- Stars: 31
- Watchers: 5
- Forks: 1
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Fruzhin is a Java Implementation of the Polkadot Host. The ultimate goal for Fruzhin is to be able to function as an
authoring and relaying node, increasing security of the Polkadot Protocol. It's been funded by
[Polkadot Pioneers Prize](https://polkadot.polkassembly.io/child_bounty/238).
> **Warning**
> Fruzhin is in pre-production state
# Status
- [x] Light Client
- [x] Full Node
- [ ] Authoring Node
- [ ] Relaying Node
# Getting started
## Clone
```bash
git clone https://github.com/LimeChain/Fruzhin.git
cd Fruzhin
```
## Setup & Build steps
### Java Version
Fruzhin works with Java 22.
If you have multiple java version installed please make sure you're using 22:
```
export JAVA_HOME=`/usr/libexec/java_home -v 22`
```
### Build
```bash
./gradlew build
```
## Running Fruzhin
### Sync with official chain
```bash
java -jar build/libs/Fruzhin-0.1.0.jar -n polkadot --node-mode full --sync-mode full
```
- `-n`(network) could be `westend`, `polkadot` or `kusama`
- `--node-mode` could be `full` or `light`
- `--sync-mode` could be `full` or `warp`
## Get docker image
```bash
docker image pull limechain/fruzhin
docker volume create rocksdb
```
### Run Fruzhin on docker
```bash
docker run -d -v rocksdb:/usr/app/rocks-db limechain/fruzhin -n polkadot --node-mode full --sync-mode full
```
### Local development
In order to use the Fruzhin node for local development you will first need to start another node that would serve as a
peer.
For the sake of this example we will use [Paritytech's implementation](https://github.com/paritytech/polkadot-sdk).
If you are not familiar with how to run a node see [this](https://wiki.polkadot.network/docs/maintain-sync#setup-instructions).
Once you have successfully built the Polkadot project run the node via ``polkadot --dev``.
(The node starts on port 9944 by default)
Now you have 2 options:
- Use the automated `local_dev.sh` script
- Manual setup.
#### Automated script
1. Install [JQ](https://github.com/jqlang/jq).
`sudo apt-get install jq` Ubuntu
`brew install jq` MacOS
2. Head to the main directory of Fruzhin execute the script `./local_dev.sh`.
#### Manual setup
1. Fetch the chain spec
```bash
curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "sync_state_genSyncSpec", "params": [true]}' http://localhost:9944
```
The `lightSyncState` field is important for the light client to
work. Without it, the light client won't have a checkpoint to start from
and could be long-range attacked
2. Create a new `westend-local.json` inside of the `genesis` project directory.
3. Copy the contents of the `result` field from the fetched chain spec into the newly created `westend-local.json`.
4. In order to comply with the project requirements change the json structured as follows:
Fetched chain spec
```JSON
{
"genesis": {
"raw": {
"top": {},
"childrenDefault": {}
}
}
}
```
Desired chain spec
```JSON
{
"genesis": {
"top": {},
"childrenDefault": {}
}
}
```
5. Fetch the local boot nodes.
```bash
curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "system_localListenAddresses"}' http://localhost:9944
```
Paste the response into the `bootNodes` field of the `westend-local.json` chain spec.
#### Build & Run
1. Build project
```
./gradlew build
```
2. Run Fruzhin
```
java -jar build/libs/Fruzhin-0.1.0.jar -n 'local' --node-mode 'full'/'light' --sync-mode 'full'/'warp' --db-recreate true/false
```