Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZMQ PUB/SUB JSON Types #330

Merged
merged 21 commits into from
Nov 21, 2024
Merged

ZMQ PUB/SUB JSON Types #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
03e1939
ZMQ types crate added
dimalinux Oct 10, 2024
57fbb6b
added TxPoolAdd message type
dimalinux Oct 13, 2024
e5875ed
test for Display trait of Bytes<N>
dimalinux Oct 13, 2024
89b964d
added TxPoolAddMin
dimalinux Oct 13, 2024
40a26bc
added FullChainMain
dimalinux Oct 14, 2024
9817bbd
added FullMinerData
dimalinux Oct 20, 2024
811c921
added ChainMainMin
dimalinux Oct 27, 2024
7292bba
fixes for tx extra, switched to existing HexBytes
dimalinux Oct 28, 2024
d4a6998
documentation updates
dimalinux Oct 29, 2024
f76c84d
MinerRingCt made private
dimalinux Oct 29, 2024
d301deb
more documentation, difficulty is u64
dimalinux Oct 30, 2024
d120285
documented more fields
dimalinux Oct 31, 2024
d06d4b8
more documentation
dimalinux Nov 1, 2024
bf48d4d
all fields/types documented
dimalinux Nov 1, 2024
0086962
Merge remote-tracking branch 'origin/main' into dimalinux/zmq-types
dimalinux Nov 2, 2024
863a77d
workspace dependencies for cuprate crates
dimalinux Nov 2, 2024
ce822f9
better declarations for empty JSON arrays
dimalinux Nov 2, 2024
ef74d21
added ZMQ section to crates doc
dimalinux Nov 2, 2024
dbaad27
authors update
dimalinux Nov 20, 2024
2f3d176
Merge remote-tracking branch 'origin/main' into dimalinux/zmq-types
dimalinux Nov 20, 2024
a719f7a
converted 1-item-only vectors into arrays
dimalinux Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ members = [
"rpc/json-rpc",
"rpc/types",
"rpc/interface",
"zmq/types",
]

[profile.release]
Expand Down Expand Up @@ -79,6 +80,7 @@ cuprate-types = { path = "types", default-features =
cuprate-json-rpc = { path = "rpc/json-rpc", default-features = false }
cuprate-rpc-types = { path = "rpc/types", default-features = false }
cuprate-rpc-interface = { path = "rpc/interface", default-features = false }
cuprate-zmq-types = { path = "zmq/types", default-features = false }

# External dependencies
anyhow = { version = "1", default-features = false }
Expand Down
5 changes: 5 additions & 0 deletions books/architecture/src/appendix/crates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ cargo doc --open --package cuprate-blockchain
| [`cuprate-rpc-interface`](https://doc.cuprate.org/cuprate_rpc_interface) | [`rpc/interface/`](https://github.com/Cuprate/cuprate/tree/main/rpc/interface) | RPC interface & routing
| [`cuprate-rpc-handler`](https://doc.cuprate.org/cuprate_rpc_handler) | [`rpc/handler/`](https://github.com/Cuprate/cuprate/tree/main/rpc/handler) | RPC inner handlers

## ZMQ
| Crate | In-tree path | Purpose |
|-------|--------------|---------|
| [`cuprate-zmq-types`](https://doc.cuprate.org/cuprate_zmq_types) | [`zmq/types/`](https://github.com/Cuprate/cuprate/tree/main/zmq/types) | Message types for ZMQ Pub/Sub interface

## 1-off crates
| Crate | In-tree path | Purpose |
|-------|--------------|---------|
Expand Down
20 changes: 20 additions & 0 deletions zmq/types/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[package]
name = "cuprate-zmq-types"
version = "0.1.0"
edition = "2021"
description = "Types for the ZMQ Pub/Sub API"
license = "MIT"
authors = ["dimalinux"]
repository = "https://github.com/Cuprate/cuprate/tree/main/zmq/types"

[dependencies]
serde = { workspace = true, features = ["derive"] }
hex = { workspace = true, features = ["std", "serde"] }
cuprate-types = { workspace = true, features = ["hex"] }

[dev-dependencies]
serde_json = { workspace = true, features = ["std"] }
assert-json-diff = "2.0.2"
Copy link
Member

Choose a reason for hiding this comment

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

IMO I would rather have worse error messages on tests than pull an extra dep in

Copy link
Contributor Author

@dimalinux dimalinux Nov 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I pulled it in as a dev-only dependency, because testing JSON equality is a very non-trivial thing to do. Client readers are not supposed to care about whitespace or the order of fields within an object. If the input object is a map, its field output emit order can even vary between test runs.

In Golang, the feature to test JSON equality is built right into the most popular testing library (testify). assert-json-diff appeared to be the most widely used option for testing JSON-backwards-compatibility in Rust.

I did verify that the library differentiates between empty lists and nil lists, and the other types of backwards compatibility that we care about.

If, after reading this, we still don't want to use the assert-json-diff crate, let me know and I'll find a way to make the tests work without it. We are not using any maps, so it should be possible. The expected values will probably have to be on single, super-long lines, so they won't be human readable. Or I can get the test samples formatted in the same way as serde's pretty print and use multi-line raw strings.

Copy link
Member

Choose a reason for hiding this comment

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

Seen as it is only a dev dep we can keep it for now, although it might get removed to reduce the number of deps in the future


[lints]
workspace = true
Loading
Loading