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

Update StakeShuffle/Privacy Documentation #1153

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dezryth
Copy link
Contributor

@dezryth dezryth commented Feb 12, 2021

This PR addresses #1151 and #1152.

  • The term StakeShuffle is used to describe Decred's implementation of the CoinShuffle++ protocol to create CoinJoin transactions. I attempted to replace the reference to CoinShuffle++ where StakeShuffle is more appropriate without making it too confusing as a lot of the URLs and documentation for command still references "cspp".
  • I've updated verbiage in overview to reflect recent developments that have addressed limitations of the code since the docs were last updated. (VSPD allows mixing and staking/delegated voting rights, GUI is now available, regular non-staking transactions can be mixed)
  • I've added a link to Exitus's privacy tutorial for participating in mixing via Decrediton on the "How to use StakeShuffle" page.

Please review and let me know of any changes anyone would like to see before merging. Given this is a very important area to Decred stakeholders, I want to ensure the verbiage changes are satisfactory.

@dezryth dezryth force-pushed the Update-StakeShuffle-Doco branch from 72073c6 to 421b97e Compare February 12, 2021 12:51
Update verbiage on CSPP/StakeShuffle with more recent developments.
Adds terms CoinShuffle++ and StakeShuffle to glossary.
Adds video tutorial for privacy mixing on "How To" page.
Addresses decred#1151 and decred#1152.
@dezryth dezryth force-pushed the Update-StakeShuffle-Doco branch from 421b97e to 4ec350a Compare February 12, 2021 13:17
@raedah
Copy link

raedah commented Feb 15, 2021

Can you update the urls and provide redirects for the old urls?

You could add a definition for CoinJoin to the glossary for consistency.

@jrick
Copy link
Member

jrick commented Feb 17, 2021

Rebranding this feature is silly, and afaict, was not discussed or approved anywhere else.

The protocol is still CoinShuffle++ no matter how it is used and what amounts are mixed. In fact, the server does not even know the current ticket price. It only groups peers which are mixing the same amounts.

@raedah
Copy link

raedah commented Feb 18, 2021

The function of CSPP is distinct from coinjoins on chain. Due to the original branding of CSPP, people are frequently using the term incorrectly to describe the properties of the coinjoins on chain. CSPP is the client-server protocol for creating the coinjoin transactions. StakeShuffle was proposed as the branding for what people have been calling Decred Privacy. It makes a lot of sense since the primary usage is with the ticket system. The goal is to make this easier to understand for users and for terms to be used correctly.

@dezryth
Copy link
Contributor Author

dezryth commented Feb 22, 2021

I had some reservations about these changes myself that I'm more concerned with after jrick's response. CSPP is referenced a lot in the underlying code and documentation for the applications in their current versions. A rebranding needs wider consensus between developers and marketing. I think it may be best to revert most of the rebranding changes and perhaps just include a note that CSPP CoinJoin transactions used in combination with Staking have been referred to as "StakeShuffle". Calling it all StakeShuffle when it's not only ticket purchasing transactions that are mixed definitely seems off. This change introduces more confusion in it's current state. I will clean up and separate my changes into separate commits.

@xaur
Copy link

xaur commented Feb 24, 2021

Agreed @dezryth, if there is not enough consensus we need to discuss this further and undo the relevant changes here to not block this PR.

@dezryth
Copy link
Contributor Author

dezryth commented Mar 4, 2021

There has been more discussion on this topic and I feel more comfortable that this PR addresses the current takeaways I saw in this discussion.

  • Component CSPP++ needs to be mentioned/given credit in docs
  • Most seem amenable to the overall process referred to as StakeShuffle
  • DCRWallet CLI commands etc will remain as is regarding cspp until a deprecation cycle

I think my PR here accomplishes this actually, and I’m seeing more support than I expected for the branded name for the mixing process than I initially thought existed between marketing/dev. Can someone take a look at the changes here and let me know what parts in particular you take issue with in the review? I want to move it forward and this most recent conversation has been really helpful.

@matthawkins90
Copy link
Contributor

Great work! Looks good to me. I thought it might be valuable to link to the new glossary terms in the "Overview" section, but then I realized you had pretty much the exact same content covered there, so it would be redundant.

@xaur
Copy link

xaur commented Mar 6, 2021

I'd also replace the cspp in the URLs, but in a way that cspp links still work and redirects to the new ones.

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.

5 participants