Skip to content

chore: deprecate core module#311

Merged
rustaceanrob merged 1 commit into2140-dev:masterfrom
nyonson:break-up-core
Mar 20, 2025
Merged

chore: deprecate core module#311
rustaceanrob merged 1 commit into2140-dev:masterfrom
nyonson:break-up-core

Conversation

@nyonson
Copy link
Collaborator

@nyonson nyonson commented Mar 14, 2025

Remove the catch-all core module by promoting the implementation to the top level kyoto module. Some refinements were made by pushing things down into existing modules, like the peer_map to network. I still some smaller questions that can be dealt with later, like does broadcaster need to be its own module? Should that also live in network?

Related to #310

@nyonson nyonson marked this pull request as ready for review March 14, 2025 22:37

This section details what behavior to expect when using Kyoto, and why such decisions were made.

### Peer Selection
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is jumping from H1 to H3 a style choice?

//! Usual sync on Testnet.

use kyoto::{chain::checkpoints::HeaderCheckpoint, core::builder::NodeBuilder};
use kyoto::{builder::NodeBuilder, chain::checkpoints::HeaderCheckpoint};
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not shown in the diff, but managed and tor examples will likely also need an upgrade. They require the additional features flag when building.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah missed that ok, I am gonna try and add that feature flag matrix to CI in a separate PR too.

@nyonson nyonson force-pushed the break-up-core branch 2 times, most recently from 1088d1c to 3da5874 Compare March 19, 2025 03:23
@nyonson
Copy link
Collaborator Author

nyonson commented Mar 19, 2025

Ok everything iron'd out in 3da5874 except tor example, but that is broke on master right now too, will address separately.

@nyonson nyonson force-pushed the break-up-core branch 3 times, most recently from e526b87 to 1a6ffb4 Compare March 19, 2025 04:09
crate::client::{Client, Requester},
crate::error::{ClientError, NodeError},
crate::messages::{Event, Log, Progress, RejectPayload, SyncUpdate, Warning},
crate::network::PeerTimeoutConfig,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was previously used internally and did not hit the public API, but I think another method on the builder to allow users to use the PeerTimeoutConfig type would be a good follow up

@rustaceanrob
Copy link
Collaborator

We should probably remove the "Getting Started" section of the documentation in lib.rs since it now points to the rustlang core module. Or maybe point users towards builder.rs

Remove the catch-all core module by promoting the implementation to the
top level kyoto module. Further refactors can break this up into existing
and new feature specific modules.
@rustaceanrob
Copy link
Collaborator

ACK 41a9ac6

@rustaceanrob rustaceanrob merged commit 020a8fa into 2140-dev:master Mar 20, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants