Skip to content

Commit e2b9a94

Browse files
authored
Feature/minor docs fixes (#223)
* webassembly: fixing example directory name in README * rust client: fixing what I suspect is a typo in a type name * Fixing wasm build instructions
1 parent 981f4de commit e2b9a94

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

clients/desktop/src/client/mod.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ use gateway_client::{GatewayClient, SphinxPacketReceiver, SphinxPacketSender};
2929
use gateway_requests::auth_token::AuthToken;
3030
use log::*;
3131
use nymsphinx::chunking::split_and_prepare_payloads;
32-
use nymsphinx::DestinationAddressBytes;
33-
use received_buffer::{ReceivedBufferMessage, ReconstructeredMessagesReceiver};
32+
use nymsphinx::{Destination, DestinationAddressBytes};
33+
use received_buffer::{ReceivedBufferMessage, ReconstructedMessagesReceiver};
34+
3435
use tokio::runtime::Runtime;
3536
use topology::NymTopology;
3637

@@ -52,7 +53,7 @@ pub struct NymClient {
5253
input_tx: Option<InputMessageSender>,
5354

5455
// to be used by "receive" function or socket, etc
55-
receive_tx: Option<ReconstructeredMessagesReceiver>,
56+
receive_tx: Option<ReconstructedMessagesReceiver>,
5657
}
5758

5859
#[derive(Debug)]

clients/desktop/src/client/received_buffer.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ pub(crate) type ReceivedBufferRequestSender = mpsc::UnboundedSender<ReceivedBuff
3131
pub(crate) type ReceivedBufferRequestReceiver = mpsc::UnboundedReceiver<ReceivedBufferMessage>;
3232

3333
// The channel set for the above
34-
pub(crate) type ReconstructeredMessagesSender = mpsc::UnboundedSender<Vec<Vec<u8>>>;
35-
pub(crate) type ReconstructeredMessagesReceiver = mpsc::UnboundedReceiver<Vec<Vec<u8>>>;
34+
pub(crate) type ReconstructedMessagesSender = mpsc::UnboundedSender<Vec<Vec<u8>>>;
35+
pub(crate) type ReconstructedMessagesReceiver = mpsc::UnboundedReceiver<Vec<Vec<u8>>>;
3636

3737
struct ReceivedMessagesBufferInner {
3838
messages: Vec<Vec<u8>>,
3939
message_reconstructor: MessageReconstructor,
40-
message_sender: Option<ReconstructeredMessagesSender>,
40+
message_sender: Option<ReconstructedMessagesSender>,
4141
}
4242

4343
#[derive(Debug, Clone)]
@@ -68,7 +68,7 @@ impl ReceivedMessagesBuffer {
6868
guard.message_sender = None;
6969
}
7070

71-
async fn connect_sender(&mut self, sender: ReconstructeredMessagesSender) {
71+
async fn connect_sender(&mut self, sender: ReconstructedMessagesSender) {
7272
let mut guard = self.inner.lock().await;
7373
if guard.message_sender.is_some() {
7474
// in theory we could just ignore it, but that situation should have never happened
@@ -149,7 +149,7 @@ impl ReceivedMessagesBuffer {
149149
pub(crate) enum ReceivedBufferMessage {
150150
// Signals a websocket connection (or a native implementation) was established and we should stop buffering messages,
151151
// and instead send them directly to the received channel
152-
ReceiverAnnounce(ReconstructeredMessagesSender),
152+
ReceiverAnnounce(ReconstructedMessagesSender),
153153

154154
// Explicit signal that Receiver connection will no longer accept messages
155155
ReceiverDisconnect,

clients/desktop/src/websocket/handler.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use super::types::{BinaryClientRequest, ClientRequest, ServerResponse};
1616
use crate::client::{
1717
received_buffer::{
18-
ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructeredMessagesReceiver,
18+
ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructedMessagesReceiver,
1919
},
2020
topology_control::TopologyAccessor,
2121
InputMessage, InputMessageSender,
@@ -265,7 +265,7 @@ impl<T: NymTopology> Handler<T> {
265265
}
266266
}
267267

268-
async fn listen_for_requests(&mut self, mut msg_receiver: ReconstructeredMessagesReceiver) {
268+
async fn listen_for_requests(&mut self, mut msg_receiver: ReconstructedMessagesReceiver) {
269269
loop {
270270
tokio::select! {
271271
socket_msg = self.next_websocket_request() => {

clients/webassembly/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See our [docs](https://nymtech.net/docs).
1414

1515
### Demo
1616

17-
There's a demo web application in the `www` folder. To run it, first make sure you've got a recent `npm` installed, then follow the instructions in its README.
17+
There's a demo web application in the `js-example` folder. To run it, first make sure you've got a recent `npm` installed, then follow the instructions in its README.
1818

1919
### Developing
2020

0 commit comments

Comments
 (0)