Feature/client socket adjustments (#212)

* Changed default listening port to something slightly more meaningful

* Removed TCP socket and made websocket the default option (as opposed to 'None')

* Updated template

* Updated ReceivedBuffer to allow direct message forwarding

* ignoring vscode directory

* Push messages mechanism for websocket client-clients

* Removed flawed chunking example

* ... but added bunch of websocket examples in return!

* Moves js example directory

* Cargo fmt

* Removed old listener code

Author: jstuczyn

.gitignore

@@ -7,4 +7,5 @@ target
 .env
 /.vscode/settings.json
 validator/.vscode
-sample-configs/validator-config.toml
+sample-configs/validator-config.toml
+.vscode

clients/desktop/examples/chunking.rs

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam quis efficitur neque. Quisque aliquet vulputate ante, eget vehicula odio feugiat ac. Nulla ut mattis magna. Aenean tincidunt quis nulla eget eleifend. Cras in pretium sem. Nunc lorem metus, blandit sit amet egestas ut, feugiat quis tellus. Aenean tristique, enim a tincidunt condimentum, eros est blandit nunc, id viverra metus erat at nulla. Vivamus at tellus sodales, feugiat odio vel, laoreet neque. Vivamus posuere nulla ac sodales bibendum.
+
+Vestibulum pulvinar nisi non ultricies egestas. Integer finibus ultrices justo vitae suscipit. Etiam interdum eu justo vel interdum. Morbi sagittis ac nisl quis consequat. Mauris dapibus ut risus ac facilisis. Pellentesque non tortor feugiat, consectetur arcu vel, ullamcorper sapien. Proin sodales purus non orci bibendum, sit amet ultrices justo ullamcorper. Nullam ac risus ac justo ultricies efficitur auctor nec arcu. Etiam sed finibus felis. Suspendisse potenti. Phasellus malesuada velit ac ullamcorper egestas. Sed elementum diam ut est gravida ultricies.
+
+Pellentesque sed metus massa. Cras imperdiet lacus sit amet dolor aliquam, luctus posuere justo hendrerit. Morbi augue ex, gravida a metus sed, scelerisque euismod lacus. Nam consequat sapien ac pellentesque sagittis. Morbi a ultrices massa, vel aliquet ex. Maecenas ac sem diam. Nunc sed erat et ipsum volutpat auctor. Etiam elit felis, commodo vitae ipsum ac, fermentum lobortis arcu. Aliquam eu tempus enim. Curabitur vulputate imperdiet aliquam. Morbi iaculis rhoncus risus at malesuada. Donec accumsan feugiat ligula ut facilisis. Nunc porttitor sit amet est eget malesuada. Sed sed consectetur augue, non dapibus orci. Mauris aliquam pellentesque quam, sit amet pellentesque velit cursus vitae. Morbi sit amet molestie risus.
+
+Nam gravida non ligula a egestas. Fusce sodales, purus id rhoncus mattis, purus est vehicula urna, vel finibus augue velit et est. Donec dictum erat eleifend lobortis iaculis. Praesent id venenatis ante. Donec feugiat, ipsum eget porttitor pulvinar, nisl odio posuere lorem, ut placerat elit nulla a ligula. Suspendisse nec nibh tincidunt, sollicitudin mi a, volutpat ligula. In maximus quam lacus, eget semper dolor sagittis sit amet.
+
+In vitae hendrerit est, quis facilisis dui. In eu ante enim. Nullam hendrerit odio sit amet odio tincidunt eleifend. Aliquam erat volutpat. Curabitur commodo, purus pharetra lobortis rhoncus, tortor massa imperdiet nisl, vel dignissim tortor sem at orci. Aliquam maximus lobortis lacus, eu porttitor purus dapibus ut. Praesent at dapibus felis, efficitur blandit tortor. In hac habitasse platea dictumst. Aenean ultrices, nisl a pretium sagittis, tellus sapien mollis erat, eu consectetur erat mauris sed libero. Duis feugiat dapibus mi, vel ornare velit vehicula mattis. Ut suscipit pharetra leo et sollicitudin.

clients/desktop/examples/dummy_file

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam quis efficitur neque. Quisque aliquet vulputate ante, eget vehicula odio feugiat ac. Nulla ut mattis magna. Aenean tincidunt quis nulla eget eleifend. Cras in pretium sem. Nunc lorem metus, blandit sit amet egestas ut, feugiat quis tellus. Aenean tristique, enim a tincidunt condimentum, eros est blandit nunc, id viverra metus erat at nulla. Vivamus at tellus sodales, feugiat odio vel, laoreet neque. Vivamus posuere nulla ac sodales bibendum.
+
+Vestibulum pulvinar nisi non ultricies egestas. Integer finibus ultrices justo vitae suscipit. Etiam interdum eu justo vel interdum. Morbi sagittis ac nisl quis consequat. Mauris dapibus ut risus ac facilisis. Pellentesque non tortor feugiat, consectetur arcu vel, ullamcorper sapien. Proin sodales purus non orci bibendum, sit amet ultrices justo ullamcorper. Nullam ac risus ac justo ultricies efficitur auctor nec arcu. Etiam sed finibus felis. Suspendisse potenti. Phasellus malesuada velit ac ullamcorper egestas. Sed elementum diam ut est gravida ultricies.
+
+Pellentesque sed metus massa. Cras imperdiet lacus sit amet dolor aliquam, luctus posuere justo hendrerit. Morbi augue ex, gravida a metus sed, scelerisque euismod lacus. Nam consequat sapien ac pellentesque sagittis. Morbi a ultrices massa, vel aliquet ex. Maecenas ac sem diam. Nunc sed erat et ipsum volutpat auctor. Etiam elit felis, commodo vitae ipsum ac, fermentum lobortis arcu. Aliquam eu tempus enim. Curabitur vulputate imperdiet aliquam. Morbi iaculis rhoncus risus at malesuada. Donec accumsan feugiat ligula ut facilisis. Nunc porttitor sit amet est eget malesuada. Sed sed consectetur augue, non dapibus orci. Mauris aliquam pellentesque quam, sit amet pellentesque velit cursus vitae. Morbi sit amet molestie risus.
+
+Nam gravida non ligula a egestas. Fusce sodales, purus id rhoncus mattis, purus est vehicula urna, vel finibus augue velit et est. Donec dictum erat eleifend lobortis iaculis. Praesent id venenatis ante. Donec feugiat, ipsum eget porttitor pulvinar, nisl odio posuere lorem, ut placerat elit nulla a ligula. Suspendisse nec nibh tincidunt, sollicitudin mi a, volutpat ligula. In maximus quam lacus, eget semper dolor sagittis sit amet.
+
+In vitae hendrerit est, quis facilisis dui. In eu ante enim. Nullam hendrerit odio sit amet odio tincidunt eleifend. Aliquam erat volutpat. Curabitur commodo, purus pharetra lobortis rhoncus, tortor massa imperdiet nisl, vel dignissim tortor sem at orci. Aliquam maximus lobortis lacus, eu porttitor purus dapibus ut. Praesent at dapibus felis, efficitur blandit tortor. In hac habitasse platea dictumst. Aenean ultrices, nisl a pretium sagittis, tellus sapien mollis erat, eu consectetur erat mauris sed libero. Duis feugiat dapibus mi, vel ornare velit vehicula mattis. Ut suscipit pharetra leo et sollicitudin.

clients/desktop/examples/go-examples/websocket/dummy_file

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/btcsuite/btcutil/base58"
+	"github.com/gorilla/websocket"
+	"io/ioutil"
+)
+
+func getSelfAddress(conn *websocket.Conn) string {
+	selfAddressRequest, err := json.Marshal(map[string]string{"type": "selfAddress"})
+	if err != nil {
+		panic(err)
+	}
+
+	if err = conn.WriteMessage(websocket.TextMessage, []byte(selfAddressRequest)); err != nil {
+		panic(err)
+	}
+
+	responseJSON := make(map[string]interface{})
+	err = conn.ReadJSON(&responseJSON)
+	if err != nil {
+		panic(err)
+	}
+
+	return responseJSON["address"].(string)
+}
+
+func main() {
+	uri := "ws://localhost:1977"
+
+	conn, _, err := websocket.DefaultDialer.Dial(uri, nil)
+	if err != nil {
+		panic(err)
+	}
+	defer conn.Close()
+
+	selfAddress := getSelfAddress(conn)
+	fmt.Printf("our address is: %v\n", selfAddress)
+	decodedAddress := base58.Decode(selfAddress)
+
+	read_data, err := ioutil.ReadFile("dummy_file")
+	if err != nil {
+		panic(err)
+	}
+
+	payload := append(decodedAddress[:], read_data[:]...)
+	fmt.Printf("sending content of 'dummy file' over the mix network...\n")
+	if err = conn.WriteMessage(websocket.BinaryMessage, payload); err != nil {
+		panic(err)
+	}
+	sendConfirmationJSON := make(map[string]interface{})
+	err = conn.ReadJSON(&sendConfirmationJSON)
+	if err != nil {
+		panic(err)
+	}
+	if sendConfirmationJSON["type"].(string) != "send" {
+		panic("invalid send confirmation")
+	}
+
+	fmt.Printf("waiting to receive a message from the mix network...\n")
+	_, receivedMessage, err := conn.ReadMessage()
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("writing the file back to the disk!\n")
+	ioutil.WriteFile("received_file", receivedMessage, 0644)
+}

clients/desktop/examples/go-examples/websocket/filesend.go

@@ -0,0 +1,67 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/gorilla/websocket"
+)
+
+func getSelfAddress(conn *websocket.Conn) string {
+	selfAddressRequest, err := json.Marshal(map[string]string{"type": "selfAddress"})
+	if err != nil {
+		panic(err)
+	}
+
+	if err = conn.WriteMessage(websocket.TextMessage, []byte(selfAddressRequest)); err != nil {
+		panic(err)
+	}
+
+	responseJSON := make(map[string]interface{})
+	err = conn.ReadJSON(&responseJSON)
+	if err != nil {
+		panic(err)
+	}
+
+	return responseJSON["address"].(string)
+}
+
+func main() {
+	message := "Hello Nym!"
+
+	uri := "ws://localhost:1977"
+
+	conn, _, err := websocket.DefaultDialer.Dial(uri, nil)
+	if err != nil {
+		panic(err)
+	}
+	defer conn.Close()
+
+	selfAddress := getSelfAddress(conn)
+	fmt.Printf("our address is: %v\n", selfAddress)
+	sendRequest, err := json.Marshal(map[string]string{"type": "send", "recipient": selfAddress, "message": message})
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("sending '%v' over the mix network...\n", message)
+	if err = conn.WriteMessage(websocket.TextMessage, []byte(sendRequest)); err != nil {
+		panic(err)
+	}
+
+	sendConfirmationJSON := make(map[string]interface{})
+	err = conn.ReadJSON(&sendConfirmationJSON)
+	if err != nil {
+		panic(err)
+	}
+	if sendConfirmationJSON["type"].(string) != "send" {
+		panic("invalid send confirmation")
+	}
+
+	fmt.Printf("waiting to receive a message from the mix network...\n")
+	_, receivedMessage, err := conn.ReadMessage()
+	if err != nil {
+		panic(err)
+	}
+	fmt.Printf("received %v from the mix network!\n", string(receivedMessage))
+}

clients/desktop/examples/go-examples/websocket/textsend.go

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam quis efficitur neque. Quisque aliquet vulputate ante, eget vehicula odio feugiat ac. Nulla ut mattis magna. Aenean tincidunt quis nulla eget eleifend. Cras in pretium sem. Nunc lorem metus, blandit sit amet egestas ut, feugiat quis tellus. Aenean tristique, enim a tincidunt condimentum, eros est blandit nunc, id viverra metus erat at nulla. Vivamus at tellus sodales, feugiat odio vel, laoreet neque. Vivamus posuere nulla ac sodales bibendum.
+
+Vestibulum pulvinar nisi non ultricies egestas. Integer finibus ultrices justo vitae suscipit. Etiam interdum eu justo vel interdum. Morbi sagittis ac nisl quis consequat. Mauris dapibus ut risus ac facilisis. Pellentesque non tortor feugiat, consectetur arcu vel, ullamcorper sapien. Proin sodales purus non orci bibendum, sit amet ultrices justo ullamcorper. Nullam ac risus ac justo ultricies efficitur auctor nec arcu. Etiam sed finibus felis. Suspendisse potenti. Phasellus malesuada velit ac ullamcorper egestas. Sed elementum diam ut est gravida ultricies.
+
+Pellentesque sed metus massa. Cras imperdiet lacus sit amet dolor aliquam, luctus posuere justo hendrerit. Morbi augue ex, gravida a metus sed, scelerisque euismod lacus. Nam consequat sapien ac pellentesque sagittis. Morbi a ultrices massa, vel aliquet ex. Maecenas ac sem diam. Nunc sed erat et ipsum volutpat auctor. Etiam elit felis, commodo vitae ipsum ac, fermentum lobortis arcu. Aliquam eu tempus enim. Curabitur vulputate imperdiet aliquam. Morbi iaculis rhoncus risus at malesuada. Donec accumsan feugiat ligula ut facilisis. Nunc porttitor sit amet est eget malesuada. Sed sed consectetur augue, non dapibus orci. Mauris aliquam pellentesque quam, sit amet pellentesque velit cursus vitae. Morbi sit amet molestie risus.
+
+Nam gravida non ligula a egestas. Fusce sodales, purus id rhoncus mattis, purus est vehicula urna, vel finibus augue velit et est. Donec dictum erat eleifend lobortis iaculis. Praesent id venenatis ante. Donec feugiat, ipsum eget porttitor pulvinar, nisl odio posuere lorem, ut placerat elit nulla a ligula. Suspendisse nec nibh tincidunt, sollicitudin mi a, volutpat ligula. In maximus quam lacus, eget semper dolor sagittis sit amet.
+
+In vitae hendrerit est, quis facilisis dui. In eu ante enim. Nullam hendrerit odio sit amet odio tincidunt eleifend. Aliquam erat volutpat. Curabitur commodo, purus pharetra lobortis rhoncus, tortor massa imperdiet nisl, vel dignissim tortor sem at orci. Aliquam maximus lobortis lacus, eu porttitor purus dapibus ut. Praesent at dapibus felis, efficitur blandit tortor. In hac habitasse platea dictumst. Aenean ultrices, nisl a pretium sagittis, tellus sapien mollis erat, eu consectetur erat mauris sed libero. Duis feugiat dapibus mi, vel ornare velit vehicula mattis. Ut suscipit pharetra leo et sollicitudin.

clients/desktop/js-examples/websocket/.gitignore clients/desktop/examples/js-examples/websocket/.gitignore

@@ -0,0 +1,35 @@
+
+import asyncio
+import base58
+import json
+import websockets
+
+self_address_request = json.dumps({
+    "type": "selfAddress"
+})
+
+
+async def send_file():
+    uri = "ws://localhost:1977"
+    async with websockets.connect(uri) as websocket:
+        await websocket.send(self_address_request)
+        self_address = json.loads(await websocket.recv())
+        print("our address is: {}".format(self_address["address"]))
+
+        bin_payload = bytearray(base58.b58decode(self_address["address"]))
+        with open("dummy_file", "rb") as input_file:
+            read_data = input_file.read()
+            bin_payload += read_data
+
+        print("sending content of 'dummy_file' over the mix network...")
+        await websocket.send(bin_payload)
+        msg_send_confirmation = json.loads(await websocket.recv())
+        assert msg_send_confirmation["type"], "send"
+
+        print("waiting to receive the 'dummy_file' from the mix network...")
+        received_data = await websocket.recv()
+        with open("received_file", "wb") as output_file:
+            print("writing the file back to the disk!")
+            output_file.write(received_data)
+
+asyncio.get_event_loop().run_until_complete(send_file())

clients/desktop/js-examples/websocket/README.md clients/desktop/examples/js-examples/websocket/README.md

@@ -0,0 +1,36 @@
+
+import asyncio
+import base58
+import json
+import websockets
+
+self_address_request = json.dumps({
+    "type": "selfAddress"
+})
+
+
+async def send_file():
+    message = "Hello Nym!"
+
+    uri = "ws://localhost:1977"
+    async with websockets.connect(uri) as websocket:
+        await websocket.send(self_address_request)
+        self_address = json.loads(await websocket.recv())
+        print("our address is: {}".format(self_address["address"]))
+
+        text_send = json.dumps({
+            "type": "send",
+            "message": message,
+            "recipient": self_address["address"]
+        })
+
+        print("sending '{}' over the mix network...".format(message))
+        await websocket.send(text_send)
+        msg_send_confirmation = json.loads(await websocket.recv())
+        assert msg_send_confirmation["type"], "send"
+
+        print("waiting to receive a message from the mix network...")
+        received_message = await websocket.recv()
+        print("received {} from the mix network!".format(received_message))
+
+asyncio.get_event_loop().run_until_complete(send_file())

clients/desktop/js-examples/websocket/package-lock.json clients/desktop/examples/js-examples/websocket/package-lock.json

@@ -0,0 +1,62 @@
+use bs58;
+use futures::{SinkExt, StreamExt};
+use nym_client::websocket::{BinaryClientRequest, ClientRequest, ServerResponse};
+use nymsphinx::DestinationAddressBytes;
+use std::convert::TryFrom;
+use tokio_tungstenite::{connect_async, tungstenite::protocol::Message};
+#[tokio::main]
+async fn main() {
+    let uri = "ws://localhost:1977";
+    let (mut ws_stream, _) = connect_async(uri).await.unwrap();
+
+    let self_address_request = ClientRequest::SelfAddress;
+    ws_stream.send(self_address_request.into()).await.unwrap();
+
+    let raw_response = ws_stream.next().await.unwrap().unwrap();
+    // what we received now is just a json, but we know it's exact format
+    // so might as well use that
+    let response = match raw_response {
+        Message::Text(txt_msg) => ServerResponse::try_from(txt_msg).unwrap(),
+        _ => panic!("received an unexpected response type!"),
+    };
+
+    let self_address = match response {
+        ServerResponse::SelfAddress { address } => address,
+        _ => panic!("received an unexpected response type!"),
+    };
+    println!("our address is: {}", self_address.clone());
+
+    let mut address_bytes = [0; 32];
+    bs58::decode(self_address).into(&mut address_bytes).unwrap();
+
+    // this is equivalent to just sending bs58 decoding of the address, which is always 32 bytes
+    let decoded_address = DestinationAddressBytes::from_bytes(address_bytes);
+    let read_data = std::fs::read("examples/dummy_file").unwrap();
+
+    let send_request = BinaryClientRequest::Send {
+        recipient_address: decoded_address,
+        data: read_data,
+    };
+
+    println!("sending content of 'dummy_file' over the mix network...");
+    ws_stream.send(send_request.into()).await.unwrap();
+
+    let raw_send_confirmation = ws_stream.next().await.unwrap().unwrap();
+    let _send_confirmation = match raw_send_confirmation {
+        Message::Text(txt_msg) => match ServerResponse::try_from(txt_msg).unwrap() {
+            ServerResponse::Send => (),
+            _ => panic!("received an unexpected response type!"),
+        },
+        _ => panic!("received an unexpected response type!"),
+    };
+
+    println!("waiting to receive the 'dummy_file' from the mix network...");
+    let raw_message = ws_stream.next().await.unwrap().unwrap();
+    let message = match raw_message {
+        Message::Binary(bin_payload) => bin_payload,
+        _ => panic!("received an unexpected response type!"),
+    };
+
+    println!("writing the file back to the disk!");
+    std::fs::write("examples/received_file", message).unwrap();
+}