apollo_propeller: add base types (Channel, ShardIndex, MessageRoot)

[sirandreww-starkware]

No description provided.

[reviewable-StarkWare]

This change is 

[sirandreww-starkware]

• apollo_propeller: add minimal config #11196 : 2 dependent PRs (#11197 , #11942 )
• apollo_propeller: add behaviour skeleton #11195
• apollo_propeller: add Event enum to types #11194
• apollo_propeller: add dial upgrade error handling to handler #11074
• apollo_propeller: add rate-limited queue length warnings #11073
• apollo_propeller: add concurrent streams support to handler #11072
• apollo_propeller: implement outbound substream with message batching #11071
• apollo_propeller: add handler helper methods #11070
• apollo_propeller: use protobuf type in handler send queue #11069
• apollo_propeller: reorder handler structs #11068
• apollo_propeller: add inbound substream handling to receive units #11067
• apollo_propeller: add receive queue and emit logic to handler #11066
• apollo_propeller: add handler skeleton with TODOs #11065
• apollo_propeller: add protocol upgrade for libp2p streams #11064
• apollo_protobuf: add prost codec for length-delimited messages #11063
• apollo_propeller: add protobuf conversions for PropellerUnit #11062
• apollo_propeller: add merkle proof verification to validator #11061
• apollo_propeller: integrate tree origin verification in validator #11060
• apollo_propeller: add tree origin verification methods #11059
• apollo_propeller: add unit validator with signature caching #11058
• apollo_propeller: add tree topology core logic #11057
• apollo_propeller: add shard validation error type #11056
• apollo_propeller: add peer set error type #11055
• apollo_propeller: add core unit struct with accessors #11054
• apollo_propeller: add signature verification module #11053
• apollo_propeller: add reconstruction error type #11052
• apollo_propeller: add shard publish error type #11051
• apollo_propeller: add tree generation error type #11050
• apollo_propeller: add ShardSignatureVerificationError #11049
• apollo_propeller: add base types (Channel, ShardIndex, MessageRoot) #11048 👈 (View in Graphite)
• apollo_propeller: add reed-solomon erasure coding #11047
• apollo_propeller: added merkle implementation tests #11206 : 1 other dependent PR (#11572 )
• apollo_propeller: added merkle tree builder #11205
• apollo_propeller: added model merkle implementation #10985
• apollo_propeller: added model merkle proof implementation #11204
• apollo_protobuf: added propeller proto file #10654
• apollo_propeller: new crate for the propeller p2p protocol #11192
• main-v0.14.1-committer

This stack of pull requests is managed by Graphite. Learn more about stacking.

[sirandreww-starkware]

@sirandreww-starkware made 5 comments.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @ShahakShama).

---

crates/apollo_propeller/src/types.rs line 7 at r1 (raw file):

Previously, ShahakShama wrote…

Remove these

I want to keep them, the file gets larger and I use these to separate different sections I can add a TODO to remove these later but I think they should remain if we don't want to split this file up

---

crates/apollo_propeller/src/types.rs line 10 at r1 (raw file):

Previously, ShahakShama wrote…

Update according to what we decided in the proto PR

As we said there, once we finish the PR stack we will change this all across the codebase

---

crates/apollo_propeller/src/types.rs line 12 at r1 (raw file):

Previously, ShahakShama wrote…

What's wrong with the regular display?

What is a regular display? you mean the one you get with Debug?
https://doc.rust-lang.org/rust-by-example/hello/print/print_display.html
I just wanted the ability to print normally. And for the print output to be a bit nicer, this is not that important for Channel and Shard Index but is important for MessageRoot.
What do you think we should do?

---

crates/apollo_propeller/src/types.rs line 23 at r1 (raw file):

Previously, ShahakShama wrote…

Same here

^

---

crates/apollo_propeller/src/types.rs line 34 at r1 (raw file):

Previously, ShahakShama wrote…

Same here

^

[guy-starkware]

@guy-starkware reviewed 1 file and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @noamsp-starkware and @ShahakShama).

---

crates/apollo_propeller/src/types.rs line 12 at r1 (raw file):

Previously, sirandreww-starkware (Andrew Luka) wrote…

What is a regular display? you mean the one you get with Debug?
https://doc.rust-lang.org/rust-by-example/hello/print/print_display.html
I just wanted the ability to print normally. And for the print output to be a bit nicer, this is not that important for Channel and Shard Index but is important for MessageRoot.
What do you think we should do?

From what I've seen in other places, we only implement a Display function if we really need it to look prettier (e.g., the debug dump is too cluttered). IMO if you don't need this, better just derive(Debug) and use that (less code to read is always welcome).

On the other hand, if you want this to work as a standalone crate, maybe there's motivation to be "complete" about user-facing functionality. I don't know. Whatever makes more sense to you.

[ShahakShama]

@ShahakShama made 2 comments and resolved 1 discussion.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @sirandreww-starkware).

---

crates/apollo_propeller/src/types.rs line 7 at r1 (raw file):

Previously, sirandreww-starkware (Andrew Luka) wrote…

I want to keep them, the file gets larger and I use these to separate different sections I can add a TODO to remove these later but I think they should remain if we don't want to split this file up

If the file is too large then the correct thing to do is to split it

---

crates/apollo_propeller/src/types.rs line 12 at r1 (raw file):

Previously, guy-starkware wrote…

From what I've seen in other places, we only implement a Display function if we really need it to look prettier (e.g., the debug dump is too cluttered). IMO if you don't need this, better just derive(Debug) and use that (less code to read is always welcome).

On the other hand, if you want this to work as a standalone crate, maybe there's motivation to be "complete" about user-facing functionality. I don't know. Whatever makes more sense to you.

I agree with @guy-starkware 's less paragraph. Let's just delete this code

[ShahakShama]

@ShahakShama made 1 comment.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @sirandreww-starkware).

---

crates/apollo_propeller/src/types.rs line 10 at r2 (raw file):

#[derive(Debug, Default, PartialEq, Clone, Copy, Ord, PartialOrd, Eq, Hash)]
pub struct Channel(pub u32);

Rename to ChannelId

[ShahakShama]

@ShahakShama made 1 comment.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @sirandreww-starkware).

---

crates/apollo_propeller/src/types.rs line 12 at r1 (raw file):

Previously, ShahakShama wrote…

I agree with @guy-starkware 's less paragraph. Let's just delete this code

first*

[ShahakShama]

@ShahakShama made 2 comments.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @sirandreww-starkware).

---

crates/apollo_propeller/src/types.rs line 23 at r1 (raw file):

Previously, sirandreww-starkware (Andrew Luka) wrote…

^

^

---

crates/apollo_propeller/src/types.rs line 34 at r1 (raw file):

Previously, sirandreww-starkware (Andrew Luka) wrote…

^

^

[ShahakShama]

@ShahakShama reviewed all commit messages.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @guy-starkware, @noamsp-starkware, and @sirandreww-starkware).

[sirandreww-starkware]

@sirandreww-starkware made 5 comments.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @noamsp-starkware and @ShahakShama).

---

crates/apollo_propeller/src/types.rs line 7 at r1 (raw file):

Previously, ShahakShama wrote…

If the file is too large then the correct thing to do is to split it

correct

---

crates/apollo_propeller/src/types.rs line 12 at r1 (raw file):

Previously, ShahakShama wrote…

first*

Done.

---

crates/apollo_propeller/src/types.rs line 23 at r1 (raw file):

Previously, ShahakShama wrote…

^

Done.

---

crates/apollo_propeller/src/types.rs line 34 at r1 (raw file):

Previously, ShahakShama wrote…

^

Done.

---

crates/apollo_propeller/src/types.rs line 10 at r2 (raw file):

Previously, ShahakShama wrote…

Rename to ChannelId

I will put a TODO for now because I want to do this all over the code when it's all in. Do you accept?

[ShahakShama]

@ShahakShama reviewed 2 files and all commit messages, and resolved 5 discussions.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @noamsp-starkware).

[graphite-app]

Merge activity

• Jan 13, 3:07 PM UTC: Graphite rebased this pull request, because this pull request is set to merge when ready.