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

add whisperlinks #63

Merged
merged 4 commits into from
Aug 25, 2020
Merged

add whisperlinks #63

merged 4 commits into from
Aug 25, 2020

Conversation

cblgh
Copy link
Member

@cblgh cblgh commented Aug 20, 2020

Hi friends!

This PR adds whisperlinks. Whisperlinks are user defined, shortlived, shortname aliases for a cabal key. They look something like

whisper://workshop-1ee

where the first part identifies the string as a whisper link, workshop is the user defined alias, and the -1ee suffix are three first hex characters of the cabal key being shared (which helps verify the joined cabal, as well as disambiguate names & prevent already-unlikely name collisions).

Whisperlinks are shortlived, currently terminating after 5 minutes. A whisperlink can be used multiple times before it self-terminates, and it will sync over LAN as well as the internet (it uses hyperswarm, under the hood)

Anyone can create a whisperlink for a cabal they are in by invoking the /whisper <name> command.

The entire raison d'être of whisperlinks is that creating and sharing cabals in physical space was really awkward before. If you had a workshop at a hackerspace, with everyone gathered locally, you practically had to use a separate chat software in order to transmit the 64 character long cabal key amongst the group. Now, someone could just create a whisperlink and verbally transmit the short & understandable alias they chose.

This PR uses a module I created a while back called paperslip to accomplish most of the not-so-heavy lifting.

@cblgh
Copy link
Member Author

cblgh commented Aug 20, 2020

hm. might use crypto.discoveryKey to create a discovery key of the passed in whisperlink, to prevent the possibility that anyone could be monitoring the DHT

edit: added in paperslip@3.0.0

Copy link
Member

@hackergrrl hackergrrl left a comment

Choose a reason for hiding this comment

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

Cool feature @cblgh 🎉

src/client.js Outdated Show resolved Hide resolved
src/client.js Outdated Show resolved Hide resolved
src/client.js Outdated Show resolved Hide resolved
@cblgh
Copy link
Member Author

cblgh commented Aug 22, 2020

thanks for the reviews friends! i'll comment individually above :)

@pvh
Copy link

pvh commented Nov 17, 2020

Hey this is awesome, @cblgh! I definitely want to clone this feature in our work in the future.

@cblgh
Copy link
Member Author

cblgh commented Nov 17, 2020

@pvh go for it! 🖤

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.

4 participants