Update general FAQ

2023-10-05 12:06:37 +02:00
parent cee16cd957
commit 39856e58b6
1 changed files with 17 additions and 12 deletions
@@ -3,26 +3,31 @@
 #### __How can I interact with Nym?__

 ##### For existing projects:
-You'd like to integrate parts of the Nym stack to your existing app? Please check the dedicated [integrations page](../FAQ/integrations).
+If you would like to integrate parts of the Nym stack to your existing app, please check out the dedicated [integrations page](../FAQ/integrations).

 ##### For builders:
 ###### SDKs
-You'd like to build or Nymify existing solutions? If you develop in Rust or TS/JS, then our SDKs are your go-to. 
-Please visit the [RUST SDK documentation](https://nymtech.net/developers/tutorials/rust-sdk.html) for more RUST-related information and tutorials and go to the [TS SDK handbook](../) (you are here) for using the TypeScript SDK.
-These SDKs abstract away much of the messaging and core logic from your app, and allow you to run a Nym client as part of your application process, instead of having to run them seperately.
+If you’re looking to build or ‘Nymify’ existing solutions, read on: For developing in Rust or TS/JS, then the Nym SDKs are your go-to. Please visit the [RUST SDK documentation](https://nymtech.net/developers/tutorials/rust-sdk.html) for more RUST-related information and tutorials.
+Stay on this page, the [TS SDK handbook](../) (you are here) for using the TypeScript SDK.
+These SDKs abstract away much of the messaging and core logic from your app, and allow you to run a Nym client as part of your application process, instead of having to run them separately. In short, they simplify building Nym clients into your project.

 ###### Nym clients: Websocket, WebAssembly, SOCKS5
-Alternatively, you can also use one of the three Nym clients to connect your application to the mixnet. These clients do the majority of the heavy-lifting with regards to cryptographic operations and routing under the hood, and all do basically the same thing: create a connection to a gateway, encrypt and decrypt packets sent to and received from the mixnet, and send cover traffic to hide the flow of actual app traffic from observers. You can learn more about the Nym clients in this [Nym integration page](https://nymtech.net/developers/integrations/mixnet-integration.html).
+Alternatively, you can also use one of the three Nym clients to connect your application to the mixnet. 
+These clients do the majority of the heavy-lifting with regards to cryptographic operations and routing under the hood. 
+Essentially, they all do the same thing: create a connection to a gateway, encrypt and decrypt packets sent to and received from the mixnet, and send cover traffic to hide the flow of actual app traffic from observers. You can learn more about the Nym clients in this [Nym integration page](https://nymtech.net/developers/integrations/mixnet-integration.html).

 ###### Network requesters: 
-Network requesters are a type of Service Provider, that in essence, act as a form of proxy (somewhat analagous to a Tor exit node). If you have access to a server, you can run the Network Requester, which allows Nym users to send outbound requests from their local machine through the mixnet to a server, which then makes the request on their behalf, shielding them (and their metadata) from clearnet, untrusted and unknown infrastructure, such as email or message client servers.
+Network requesters are a type of Service Provider that essentially act as a kind of proxy, somewhat similarly to a Tor exit node. If you have access to a server, you can run a Network Requester, which will perform the following functions: 
+- Send outbound requests from the local machine through the mixnet to a server;
+- The Network Requester then makes a request on the user’s behalf, shielding the user and their metadata from the untrusted and unknown infrastructure, for example with  email or instant messaging client servers;
+

 By default the Network Requester is not an open proxy but rather uses a local and global [allow list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) to whitelist host access.

 #### __Which Service Provider to run?__
-In order to ensure uptime and reliability, it is recommended that you run some pieces of mixnet infrastructure. What infrastructure is necessary to run depends on the architecture of your application, and the endpoints that it needs to hit:
+In order to ensure uptime and reliability, it is recommended that you run some pieces of mixnet infrastructure. This infrastructure varies depending on the architecture of your application, as well as the endpoints that it needs to hit:

- No Service Provider (Network Requester) needed: If you’re running a purely P2P application, then just integrating clients and having some method of sharing addresses should be enough to route your traffic through the mixnet.
+- No Service Provider (Network Requester) needed: If you’re running a purely P2P application, then just integrating clients and having some method of sharing addresses should be enough to route your traffic through the mixnet;
 - Network Requester needed (existing or own): If you’re wanting to place the mixnet between your users’ application instances and a server-based backend, you will need a Network Requester. In this case, if your app supports SOCKS5, you could either use an existing NR or, if your app supports SOCKS5 but needs more extensive whitelisting, you could  use the [network requester service provider binary](https://nymtech.net/operators/nodes/network-requester-setup.html) to proxy these requests to your application backend yourself, with the mixnet ‘between’ the user and your service, in order to prevent metadata leakage being broadcast to the internet.
 - Running your own Service Provider: If your usecase is more complex, you’re wanting to route RPC requests through the mixnet to a blockchain for example, you will need to look into setting up some sort of Service that does the transaction broadcasting for you. You can find examples of such projects on the [community applications page](https://nymtech.net/developers/community-resources/community-applications-and-guides.html).

@@ -33,7 +38,7 @@ Nym apps have a stable, potentially long-lasting relation to a gateway node. A c
 Gateways serve a few different functions:

 - They act as an end-to-end encrypted message store in case your app goes offline;
- They send encrypted surb-acks for potentially offline recipients, to ensure reliable message delivery;
+- They send encrypted [surb-acks](https://nymtech.net/docs/architecture/traffic-flow.html) for potentially offline recipients, to ensure reliable message delivery;
 - They offer a stable addressing location for apps, although the IP may change frequently;

 If you want to learn more about gateways, you can check the [mixnet integration page](https://nymtech.net/developers/integrations/mixnet-integration.html).
@@ -42,9 +47,9 @@ If you want to learn more about gateways, you can check the [mixnet integration
 #### __Why and when does the mixnet client complain about insufficient topology?__

 It will in one of the following cases:
- There are empty Mix layers (rare);
- The gateway you've registered with does not appear in the network topology -> it is either unbonded or got blacklisted;
- The gateway you want to send packets to does not appear in the network topology -> it is either unbonded or got blacklisted;
+- There are empty mix layers - although this is rare;
+- The gateway you've registered with does not appear in the network topology -> it is either unbonded or was blacklisted;
+- The gateway you want to send packets to does not appear in the network topology -> it is either unbonded or was blacklisted;

 To avoid the last two, you need to make sure the gateway you are calling is bonded and whitelisted.