diff --git a/README.md b/README.md index 483edb2..b18a1d3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # HushChat - Signal-like Protocol on Hush - +

+ + MyHushTeam's Twitter + + follow on Twitter + + follow on Mastodon + + MyHushTeam's Reddit +

+ ## Features of HushChat: @@ -21,9 +32,7 @@ code from Signal. A HushChat protocol whitepaper is in progress. ## Is HushChat only compatible with HUSH mainnet? -No, it's designed to run on any compatible Zcash Protocol chain, including all Hush Smart Chains: - -https://git.hush.is/hush/hush-smart-chains +No, it's designed to run on any compatible Zcash Protocol chain, including all [Hush Smart Chains](https://git.hush.is/hush/hush-smart-chains). That being said, HushChat is being developed soley on HUSH mainnet. Other cryptocoins are encouraged to read our Free Software and port it to their codebases with appropriate licensing. @@ -80,7 +89,7 @@ communicaitons. The world is increasingly chat-based versus email-based and Hush ## Will HushChat store messages on the blockchain like HushList does? Yes, data must be stored on-chain to have censorship resistance and HushChat can be thought of as a "flavor" of HushList. -Users may choose between storing data on the *public* Hush blockchain or their own Hush Smart Chain (which could be public or completely private) : https://git.hush.is/hush/hush-smart-chains +Users may choose between storing data on the *public* Hush blockchain or their own [Hush Smart Chain](https://git.hush.is/hush/hush-smart-chains) (which could be public or completely private). ## Isn't it a bad idea to store private data in a blockchain? @@ -126,4 +135,4 @@ Glad you asked!! HushChat adds various layers of privacy on top of our "base" Hu ## Where can I learn more? -Join our [Telegram](https://hush.is/telegram) +Join us on [Telegram](https://hush.is/telegram) or our [Telegram Support](https://hush.is/telegram_support) channels. diff --git a/guide.md b/guide.md index 9bebe5a..3aec7ef 100644 --- a/guide.md +++ b/guide.md @@ -1,33 +1,80 @@ # HushChat Beta Guide -## Ask somebody for their HushChat z-address (z-addr) +## Initial Setup -They click the button that says "zs1" and it will copy it to their clipboard. Give every contact a different z-addr! +In our example we use HushChat user Alice and HushChat user Bob that **both have valid positive Hush values in their wallets**. -## When you know a HushChat z-addr, send a contact request - -Make sure you have funds! Send yourself funds 3+ times or with 3+ outputs in one transaction, so you have multiple +Tips: + * Make sure to send yourself funds 3+ times or with 3+ outputs in one transaction, so you have multiple "notes" to spend. This means you can send another memo before waiting for a confirmation. If you don't, you will need to wait for 1 confirmation every time, before sending. -Click the "add contact" button at the top left, and "Send Contact Request" screen will show up. - * Choose a name - * Enter zaddr + * **I cannot stress this enough, but make sure to give every contact a different z-addr (z-address)!** + +### HushChat handshake + +Alice and Bob first have to initiate the HushChat initial communication handshake otherwise HushChat will not work correctly and you will end up with garbage, like this: + + + +##### Alice begins... + +1. Alice asks Bob for a HushChat z-address (z-addr) to start communicating. + + + +1. Bob clicks on the "Zs1" button in his HushChat tab. The result is that the wallet creates a new z-addr and copies it into his clipboard. We'll call this Bob's HushChat z-addr. + +1. Bob shares his newly created HushChat z-addr with Alice. + +1. Alice receives Bob's HushChat z-addr. + +##### Alice adds Bob as HushChat contact + +1. Alice clicks on the "add contact" button in her HushChat tab, which is to the left of "Zs1". The result is the "Send Contact Request" screen appears with a new z-addr, which we'll call this Alice's HushChat z-addr. This screen appears as: + + + +1. Alice then fills it in as follows: + * Choose a nickname + * Enter Bob's HushChat z-addr * Choose an avatar (custom avatars coming soon) * Add a custom memo introducing yourself - * Click "create new address" to make a custom new zaddr for this contact - * Click "Add contact and send request" - * Close "send contact request" window (this will autoclose in the future) - -## If you sent a request, be patient! -It may take a few minutes. This process became twice as fast as of November 2020 at Block 340,000, when our block time -decreased to 75 seconds. +1. Alice then clicks "Add contact and send request" and then close "send contact request" window (this will autoclose in the future). + +##### Bob confirms new HushChat contact + + + +1. Bob clicks on the "incoming contact request" button in his HushChat tab, which is to the left of the "add contact" button. Note that Bob sees a red 1 here instead of the zero, as seen above. The result is the "Incoming Contact Request" screen, which is shown here: + + + +1. Bob then clicks on the request as seen here: + + + +1. Bob then fills it in as follows: + * Choose a nickname + * Choose an avatar (custom avatars coming soon) + +1. Bob then clicks "Add new contact" and sees the following "Added Contact" popup, which he clicks "OK" on. + + + +##### Now Patience... + +1. Now Bob sends a HushChat message to Alice. It may take a few minutes. This process became twice as fast as of November 2020 at Block 340,000, when our block time decreased to 75 seconds. + +1. Alice then responds once she receives Bob's message. + +### Success -## Once your contact has accepted +Now both Alice and Bob are able to type encrypted memos (messages) back and forth and enjoy a bit of privacy :sunglasses: -And you get a response, now you can type encrypted memos back and forth and enjoy a bit of privacy :sunglasses: + ## Support -Join our [Telegram](https://hush.is/telegram) +Join us on [Telegram](https://hush.is/telegram) or our [Telegram Support](https://hush.is/telegram_support) channels. diff --git a/hushchat-sneak-preview.png b/hushchat-sneak-preview.png deleted file mode 100644 index 8e4f36a..0000000 Binary files a/hushchat-sneak-preview.png and /dev/null differ diff --git a/images/hushchat-added-contact-popup.png b/images/hushchat-added-contact-popup.png new file mode 100644 index 0000000..57cf342 Binary files /dev/null and b/images/hushchat-added-contact-popup.png differ diff --git a/images/hushchat-contact-confirm-waiting.png b/images/hushchat-contact-confirm-waiting.png new file mode 100644 index 0000000..18627fb Binary files /dev/null and b/images/hushchat-contact-confirm-waiting.png differ diff --git a/images/hushchat-garbage.png b/images/hushchat-garbage.png new file mode 100644 index 0000000..5d068c1 Binary files /dev/null and b/images/hushchat-garbage.png differ diff --git a/images/hushchat-incoming-contact-request-2.png b/images/hushchat-incoming-contact-request-2.png new file mode 100644 index 0000000..1dbab1e Binary files /dev/null and b/images/hushchat-incoming-contact-request-2.png differ diff --git a/images/hushchat-incoming-contact-request.png b/images/hushchat-incoming-contact-request.png new file mode 100644 index 0000000..970d50b Binary files /dev/null and b/images/hushchat-incoming-contact-request.png differ diff --git a/hushchat-screen.png b/images/hushchat-screen.png similarity index 100% rename from hushchat-screen.png rename to images/hushchat-screen.png diff --git a/images/hushchat-send-contact-request.png b/images/hushchat-send-contact-request.png new file mode 100644 index 0000000..1a0ca5d Binary files /dev/null and b/images/hushchat-send-contact-request.png differ diff --git a/images/hushchat-tab-indicators.png b/images/hushchat-tab-indicators.png new file mode 100644 index 0000000..07caa7e Binary files /dev/null and b/images/hushchat-tab-indicators.png differ