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.

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

Create sui-glossary.md #766

Merged
merged 3 commits into from
Mar 17, 2022
Merged

Create sui-glossary.md #766

merged 3 commits into from
Mar 17, 2022

Conversation

Clay-Mysten
Copy link
Contributor

Launch initial glossary of terms for Sui

Launch initial glossary of terms for Sui
Copy link
Contributor

@velvia velvia left a comment

Choose a reason for hiding this comment

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

Some comments


### Authority

An authority in Sui plays a passive role analogous to the more active role of validators and minors in other blockchains. In Sui,
Copy link
Contributor

Choose a reason for hiding this comment

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

There was a discussion about this from @gdanezis @adeabiodun and others. Basically "passive" is no longer true or won't be true soon as we add features such as shared objects which require consensus, plus other things down the line like state agreement.

The other question for everyone is since authorities are becoming active should we just call them validators?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would file an issue for this update as we use passive already in our docs. And you will have better luck getting a decision from others in a bug, for sure.


### Certificate

A certificate is the mechanism proving a transaction has been approved, or certified. Authorities vote on transactions, and the sender collects
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we say gateway here instead of "sender"? Just to clarify we don't mean the end user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I get the impression the gateway is optional. End users may act as senders directly, eating the bandwidth cost a gateway would help them avoid. I could be mistaken. Feel free to edit directly when you have an answer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huitseeker for comment here, as well.


### Epoch

An [epoch](https://coinmarketcap.com/alexandria/glossary/epoch) refers to the period between increments made in a blockchain, for instance before
Copy link
Contributor

Choose a reason for hiding this comment

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

Epochs more refer to long periods of time in a blockchain, typically at which point there is an agreement event between the nodes in a chain, and potential membership changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huitseeker for guidance as he seemed to indicate these were smaller periods in our talk within the Sui world at least.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ping

Making accumulator-gateway relationship clear
@Clay-Mysten Clay-Mysten requested a review from velvia March 11, 2022 19:37
Fixed epoch entry and linked to our canonical definition
@gdanezis gdanezis added the Type: Documentation Improvements or additions to documentation label Mar 12, 2022
@Clay-Mysten
Copy link
Contributor Author

Ping?

Copy link
Contributor

@lxfind lxfind left a comment

Choose a reason for hiding this comment

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

I think this doc requires some collective editing. We probably should start from a GDoc, have everyone contribute, and commit the final version into github once it's doen.

Find terms used in Sui defined below. Where possible, we link to a canonical definition and focus upon Sui’s use of the term.


### Accumulator
Copy link
Contributor

Choose a reason for hiding this comment

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

First time hearing about this. Is this used somewhere in our design?

Copy link
Contributor

Choose a reason for hiding this comment

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

I know a few folks have used this term to explain things but guess the impt Q is usage in other docs

check of the sender’s account, greatly speeding transaction times.


### Total order
Copy link
Contributor

Choose a reason for hiding this comment

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

Might want to put Total Order together with Causal Order

smart contracts are written in the [Move](https://github.com/MystenLabs/awesome-move) programming language.


### Single-writer objects
Copy link
Contributor

Choose a reason for hiding this comment

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

First time hearing about this, is this referenced/used anywhere?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure what we call non-shared objects, regular objects? Owned objects (to use a Rust term?)

exchange of private keys, third parties may offload bandwidth use from mobile device to server - for a fee.


### Multi-writer objects
Copy link
Contributor

Choose a reason for hiding this comment

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

This definition seems problematic, I think we call it Shared Mutable Object, and it's shared by everyone, not just more than one account.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I think it's better to say "Shared Mutable Object", I see that term used everywhere, and explain that it means multiple people can write.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please edit in the Google Doc. Thanks!

@Clay-Mysten
Copy link
Contributor Author

I think this doc requires some collective editing. We probably should start from a GDoc, have everyone contribute, and commit the final version into github once it's doen.

Alright, Doc for drafting here:
https://docs.google.com/document/d/1607YUKGjR0avOV8qyMI_sjvA97vWLS5uyPtYr-OL_Vc/edit?usp=sharing

Thanks!

@Clay-Mysten Clay-Mysten requested a review from adeabiodun March 17, 2022 17:47
@adeabiodun adeabiodun merged commit 4b7efb4 into main Mar 17, 2022
@adeabiodun adeabiodun deleted the Clay-Mysten-patch-11 branch March 17, 2022 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants