search

MystenLabs / sui

Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language
https://sui.io
Apache License 2.0
6.04k stars 11.13k forks source link

Clarify Bullshark is default, Tusk is still available #4175

Closed Clay-Mysten closed 1 year ago

Clay-Mysten commented 2 years ago

What are the existing URLs containing the issue, if any? https://docs.sui.io/devnet/learn/architecture/consensus https://github.com/MystenLabs/narwhal

How would you describe the issue? (What needs changing?) We introduced this in: https://github.com/MystenLabs/narwhal/blob/85c226f2824010ff695d0bc5789a24cad2bce289/node/src/lib.rs#L266

Where should this information land if new? (Learn, Build, Explore, Contribute.) Existing pages above.

What changes are needed to support this new feature or product? (A simple overview, detailed procedures?) We need to update references and explain Bullshark. See: https://decentralizedthoughts.github.io/2022-06-28-DAG-meets-BFT/

This came from Adeniyi. Asking Randall to take lead as he is our new validator writer per Koh.

Who is the audience for that information? (App developers, investors, creators, validators, someone else?) Validators!

What precisely must they do with it? (Configure a new service? Process some output?) Learn about our consensus protocol.

Clay-Mysten commented 2 years ago

Hi team,

Here is the first change: https://github.com/MystenLabs/sui/pull/4228

Please review when you get a chance. Thanks!

Clay-Mysten commented 2 years ago

@huitseeker and team, please reopen this issue if you need help updating the Narwhal README.

Clay-Mysten commented 2 years ago

Hello @huitseeker , I have started making it more clear Tusk still exists and may be used in: https://github.com/MystenLabs/sui/pull/4394

I am concerned stripping only the line added here isn't enough to re-enable Tusk: https://github.com/MystenLabs/narwhal/blob/85c226f2824010ff695d0bc5789a24cad2bce289/node/src/lib.rs#L158 I say this given how many other changes went into: https://github.com/MystenLabs/narwhal/pull/716

So please review and confirm the Tusk re-inclusion statement.

If that language works for you, I can also include something similar in the existing Narwhal README: https://github.com/MystenLabs/narwhal

I've also added @bwann52 since I'm trying to group these three as the proper noun (product name) Sui Consensus Engine for simplicity and memory.

Finally, I did catch a Tusk reference in this file I can make generic or include Bullshark if you like: https://github.com/MystenLabs/narwhal/blob/85c226f2824010ff695d0bc5789a24cad2bce289/node/src/lib.rs#L158

All, please advise. Thanks!

Clay-Mysten commented 2 years ago

Hi @huitseeker , I am noting @randall-Mysten has some questions for you in: https://github.com/MystenLabs/sui/pull/4394

Thanks, all.

Clay-Mysten commented 2 years ago

Reopening to update the Narwhal README to use similar language and introduce Tusk.