schultz

Crates.ioschultz
lib.rsschultz
version
sourcesrc
created_at2024-11-07 05:48:45.160138
updated_at2024-11-07 05:55:06.045332
descriptionThe Schultz node - a handshake peer aware of its own identity
homepage
repository
max_upload_size
id1439498
Cargo.toml error:TOML parse error at line 17, column 1 | 17 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Alexsander Falcucci (falcucci)

documentation

README

SCHULTZ

The Schultz node - a handshake peer aware of its own identity.

CleanShot 2024-11-07 at 04 51 33@2x

A Carper-based blockchain node written in Rust, to be used as a peer in the Casper network. The Schultz node is a handshake peer that is aware of its own identity.

Setup

Clone the Casper repository:

git clone git@github.com:casper-network/casper-node.git

Clone the Schultz repository:

git clone git@github.com:falcucci/schultz.git

The Casper node must be compiled first so before building the Casper node, prepare your Rust build environment:

cd casper-node && make setup-rs

The node software can be compiled afterwards:

cargo build -p casper-node --release

The very first handshake trial

Running a node as bootstraped validator

For the node to connect to a network, the node needs a set of trusted peers for that network, as an initiator validator, we just set its own node IP address and then it will automatically wait for incoming connections.

sed -i '' 's/known_addresses = \['\''127.0.0.1:5001'\''\]/known_addresses = \['\''127.0.0.1:34553'\''\]/' ./examples/config.toml

To run a validator node you will need to specify a config file and launch the validator subcommand:

sudo RUST_LOG=trace ./target/release/casper-node validator <SCHULTZ-PATH>/examples/config.toml

The Carper node should now be running so we can handle the incoming connections.

Terminal Casper node running as an initiator

Running the Schultz node

cd schultz && cargo build --release

Or you can just install using cargo:

cargo install schultz

The Schultz node can be run with the following command:

RUST_LOG=trace ./target/release/schultz bootstrap --addr 127.0.0.1:5001 --bootnode 127.0.0.1:34553 --chainspec ./examples

And the similar handshake trace can be found:

2024-11-07T05:09:51.320354Z  INFO schultz::node: Starting node at 127.0.0.1:5001
2024-11-07T05:09:51.326674Z  INFO schultz::network::manager: Starting network communications...
2024-11-07T05:09:51.326770Z  INFO schultz::network::tls: Generating new keys and certificates
2024-11-07T05:09:51.330164Z  INFO schultz::network::manager: Starting to listen on TCP Endpoint for incoming connections
2024-11-07T05:09:51.330212Z  INFO schultz::network::manager: Starting connection pool listener thread
2024-11-07T05:09:51.330266Z  INFO schultz::network::manager: Network communications started!
2024-11-07T05:09:51.330275Z TRACE schultz::network::manager: Waiting for incoming connections...
2024-11-07T05:09:51.330282Z  INFO schultz::network::manager: Connecting to 127.0.0.1:34553
2024-11-07T05:09:51.338439Z TRACE schultz::network::manager: 1.Trying to send a Handshake to 127.0.0.1:34553
2024-11-07T05:09:51.338454Z  INFO schultz::network::manager: Sending message to 127.0.0.1:34553
2024-11-07T05:09:51.338479Z TRACE tokio_util::codec::framed_impl: flushing framed transport
2024-11-07T05:09:51.338485Z TRACE tokio_util::codec::framed_impl: writing; remaining=103
2024-11-07T05:09:51.338502Z TRACE tokio_util::codec::framed_impl: framed transport flushed
2024-11-07T05:09:51.338520Z  INFO schultz::network::manager: Sent a handshake to 127.0.0.1:34553
2024-11-07T05:09:51.338528Z  INFO schultz::node: Started node at 127.0.0.1:5001
2024-11-07T05:09:51.338535Z  INFO schultz::node: Starting keepalive task
2024-11-07T05:09:51.341658Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:09:51.341681Z TRACE tokio_util::codec::framed_impl: frame decoded from buffer
2024-11-07T05:09:51.341855Z  INFO schultz::network::manager: Received handshake from the contacted peer
2024-11-07T05:09:51.341966Z  INFO schultz::network::manager: Handshake complete! Successfully connected to peer 127.0.0.1:34553
2024-11-07T05:09:51.341985Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:09:52.326362Z  INFO schultz::network::manager: New connection received!
2024-11-07T05:09:52.326396Z  INFO schultz::network::manager: Setting up TLS with connected peer
2024-11-07T05:09:52.326407Z  INFO schultz::network::manager: Setting up TLS with connected peer
2024-11-07T05:09:52.326417Z  INFO schultz::network::manager: Creating TLS acceptor for incoming connections
2024-11-07T05:09:52.326690Z  INFO schultz::network::manager: Performing TLS handshake with connected peer
2024-11-07T05:09:52.326708Z  INFO schultz::network::manager: Starting TLS level handshake
2024-11-07T05:09:52.338368Z  INFO schultz::network::manager: Receiving peer Ssl certificates
2024-11-07T05:09:52.338414Z  INFO schultz::network::manager: Verifying peer's certificates for sanity
2024-11-07T05:09:52.339834Z  INFO schultz::network::manager: Framing the stream to match Casper's encoding
2024-11-07T05:09:52.339854Z  INFO schultz::network::manager: Inserting stream into schultz connection pool
2024-11-07T05:09:52.342400Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:09:52.342436Z TRACE tokio_util::codec::framed_impl: frame decoded from buffer
2024-11-07T05:09:52.342905Z  INFO schultz::node: Received handshake from 127.0.0.1:52434
2024-11-07T05:09:52.342928Z  INFO schultz::network::manager: Sending a ping to 127.0.0.1:34553
2024-11-07T05:09:52.343039Z  INFO schultz::network::manager: Sending message to 127.0.0.1:34553
2024-11-07T05:09:52.343054Z  INFO schultz::network::manager: Sending Handshake to Casper
2024-11-07T05:09:52.343065Z TRACE schultz::network::manager: Handshake { network_name: "casper", public_addr: 127.0.0.1:5001, protocol_version: ProtocolVersion(SemVer { major: 1, minor: 5, patch: 2 }), consensus_certificate: None, is_syncing: false, chainspec_hash: Some(8b0c9bd3559fc2574a7aa76c26ebaabe50a9ff372d38bcaa5d6ad7e963aeff28) }

The handshake process as a listener

For Networking and Gossiping the casper node requires an accessible IP address which is the Schultz node.

sed -i '' 's/known_addresses = \['\''127.0.0.1:34553'\''\]/known_addresses = \['\''127.0.0.1:5001'\''\]/' ./examples/config.toml

The Schultz node can be run as a listener of Casper upcoming connections through:

RUST_LOG=trace ./target/release/schultz -- bootstrap --addr 127.0.0.1:5001 --chainspec ./examples

And then start the Casper node:

sudo RUST_LOG=trace ./target/release/casper-node validator <SCHULTZ-PATH>/examples/config.toml
2024-11-07T05:19:08.751711Z  INFO schultz::node: Starting node at 127.0.0.1:5001
2024-11-07T05:19:08.757526Z  INFO schultz::network::manager: Starting network communications...
2024-11-07T05:19:08.757624Z  INFO schultz::network::tls: Generating new keys and certificates
2024-11-07T05:19:08.764079Z  INFO schultz::network::manager: Starting to listen on TCP Endpoint for incoming connections
2024-11-07T05:19:08.764124Z  INFO schultz::network::manager: Starting connection pool listener thread
2024-11-07T05:19:08.764180Z  INFO schultz::network::manager: Network communications started!
2024-11-07T05:19:08.764189Z TRACE schultz::network::manager: Waiting for incoming connections...
2024-11-07T05:19:08.764196Z  INFO schultz::node: Started node at 127.0.0.1:5001
2024-11-07T05:19:08.764213Z  INFO schultz::node: Starting keepalive task
2024-11-07T05:19:21.251135Z  INFO schultz::network::manager: New connection received!
2024-11-07T05:19:21.251168Z  INFO schultz::network::manager: Setting up TLS with connected peer
2024-11-07T05:19:21.251184Z  INFO schultz::network::manager: Setting up TLS with connected peer
2024-11-07T05:19:21.251199Z  INFO schultz::network::manager: Creating TLS acceptor for incoming connections
2024-11-07T05:19:21.251666Z  INFO schultz::network::manager: Performing TLS handshake with connected peer
2024-11-07T05:19:21.251701Z  INFO schultz::network::manager: Starting TLS level handshake
2024-11-07T05:19:21.263328Z  INFO schultz::network::manager: Receiving peer Ssl certificates
2024-11-07T05:19:21.263346Z  INFO schultz::network::manager: Verifying peer's certificates for sanity
2024-11-07T05:19:21.264002Z  INFO schultz::network::manager: Framing the stream to match Casper's encoding
2024-11-07T05:19:21.264016Z  INFO schultz::network::manager: Inserting stream into schultz connection pool
2024-11-07T05:19:21.264577Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:19:21.264593Z TRACE tokio_util::codec::framed_impl: frame decoded from buffer
2024-11-07T05:19:21.265020Z  INFO schultz::node: Received handshake from 127.0.0.1:52605
2024-11-07T05:19:21.265100Z  INFO schultz::network::manager: Sending Handshake to Casper
2024-11-07T05:19:21.265106Z TRACE schultz::network::manager: Handshake { network_name: "casper", public_addr: 127.0.0.1:5001, protocol_version: ProtocolVersion(SemVer { major: 1, minor: 5, patch: 2 }), consensus_certificate: None, is_syncing: false, chainspec_hash: Some(8b0c9bd3559fc2574a7aa76c26ebaabe50a9ff372d38bcaa5d6ad7e963aeff28) }
2024-11-07T05:19:21.265155Z TRACE tokio_util::codec::framed_impl: flushing framed transport
2024-11-07T05:19:21.265159Z TRACE tokio_util::codec::framed_impl: writing; remaining=103
2024-11-07T05:19:21.265177Z TRACE tokio_util::codec::framed_impl: framed transport flushed
2024-11-07T05:19:21.265225Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:19:26.253633Z TRACE tokio_util::codec::framed_impl: attempting to decode a frame
2024-11-07T05:19:26.253688Z TRACE tokio_util::codec::framed_impl: frame decoded from buffer
2024-11-07T05:19:26.253733Z TRACE schultz::network::manager: BYTES FROM CASPER b"\x03\x05\0\0\x7f\0\0\x01\xfb\xf9\x86"
2024-11-07T05:19:26.253778Z  WARN schultz::network::manager: Error deserializing Custom { kind: InvalidData, error: Custom("Slice had bytes remaining after deserialization") }
2024-11-07T05:19:26.253843Z  WARN schultz::network::manager: Received an internal message from Casper. Ignoring the deserialization error

Generating keys using OpenSSL

The keys are already generated at ./examples path but just in case you want just generate new ones by generating the secret_key.pem file

openssl genpkey -algorithm ed25519 -out secret_key.pem

Generating public keys from the secret_key.pem file

openssl pkey -in secret_key.pem -pubout -out public_key.pem

{ echo -n 01; openssl pkey -outform DER -pubout -in "secret_key.pem" | tail -c +13 | openssl base64 | openssl base64 -d | hexdump -ve '/1 "%02x" ' | tr -d "/n"; } > public_key_hex
Commit count: 0

cargo fmt