Update integrations info

2023-10-12 12:18:14 +02:00
parent 0fea2e09ae
commit da847b6ee8
3 changed files with 13 additions and 13 deletions
@@ -1,11 +1,11 @@
 # Welcome to the TS SDK FAQ!

-#### __How can I interact with Nym?__
+## How can I interact with Nym?

-##### For existing projects:
+#### For existing projects:
 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:
+#### For builders:
 ###### SDKs
 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.
@@ -24,7 +24,7 @@ Network requesters are a type of Service Provider that essentially act as a kind

 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?__
+## Which Service Provider to run?
 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;
@@ -32,7 +32,7 @@ In order to ensure uptime and reliability, it is recommended that you run some p
 - 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).


-#### __Why gateways?__
+## Why gateways?
 Nym apps have a stable, potentially long-lasting relation to a gateway node. A client will establish a symmetric key share with a gateway that can be verified on subsequent connection attempts.

 Gateways serve a few different functions:
@@ -44,7 +44,7 @@ Gateways serve a few different functions:
 If you want to learn more about gateways, you can check the [mixnet integration page](https://nymtech.net/developers/integrations/mixnet-integration.html).


-#### __Why and when does the mixnet client complain about insufficient topology?__
+## Why and when does the mixnet client complain about insufficient topology?

 It will in one of the following cases:
 - There are empty mix layers - although this is rare;
@@ -53,7 +53,7 @@ It will in one of the following cases:

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

-#### __How can I check whether the gateway I am connecting to is bonded and not blacklisted?__
+## How can I check whether the gateway I am connecting to is bonded and not blacklisted?

 The easiest way of checking what gateway you're registered with is to look at your client address. 
 Client addresses are in the format of:
@@ -66,7 +66,7 @@ To illustrate this: `DpB3cHAchJiNBQi5FrZx2csXb1mrHkpYh9Wzf8Rjsuko.ANNWrvHqMYuert
 - `2BuMSfMW3zpeAjKXyKLhmY4QW1DXurrtSPEJ6CjX3SEh`: is the gateway's identity, which is what you'll need to check the state of the gateway in the [Nym Explorer](https://explorer.nymtech.net/network-components/gateways). 


-#### __How can I get my service host whitelisted?__
+## How can I get my service host whitelisted?
 Currently, the different options are: 
 - You can get it added to the local list of an existing Network Requester;
 - You can ask the Nym team to add it to the global [allow list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) if it's not already there;
@@ -4,7 +4,7 @@ Welcome to the documentation for Nym's TypeScript SDK!

 This comprehensive guide contains information about the various TypeScript SDK modules that facilitate interaction with different components of the Nym stack, including the Nym mixnet, the Nyx blockchain, and Coconut credentials.

-### Other developer guides
+## Other developer guides

 If you're new to the Nym ecosystem and want to better understand the mixnet, explore kickstart options and demos, learn network integration, or follow developer tutorials, the [Developer Portal](https://nymtech.net/developers/) is your go-to resource.

@@ -15,7 +15,7 @@ If you'd like to build your own app or integrate pieces of the Nym infrastructur
 If you're looking for information and setup guides for the various pieces of Nym mixnet infrastructure (mix nodes, gateways, network requesters) and Nyx blockchain validators, then have a look at our [Operators Guide](https://nymtech.net/operators/introduction.html).


-### What is Nym?
+## What is Nym?
 Nym is a **privacy infrastructure that secures user data and protects against surveillance at the network level**.
 The platform does so by  leveraging different technological components:
 - **A Mixnet**, a type of overlay network that makes both content and metadata of transactions private through network-level obfuscation and incentivisation (using [Sphinx](https://blog.nymtech.net/sphinx-tl-dr-the-data-packet-that-can-anonymize-bitcoin-and-the-internet-18d152c6e4dc));
@@ -27,7 +27,7 @@ Simply put, the Nym network ("Nym") is a decentralized and incentivized infrastr



-### Read our protocol
+## Read our protocol

 [The Nym network ("Nym")](https://www.feat-nym-update-nym-web.websites.dev.nymte.ch/nym-whitepaper.pdf) is a privacy infrastructure that, simply put, can be seen as a ["Layer 0" privacy infrastructure](https://blog.nymtech.net/nym-layer-0-privacy-infrastructure-for-the-whole-internet-e53238f9b8e7) for the entire internet.
 Read more to understand the differences in between Nym, TOR (and other mixnets) and VPNs.
@@ -31,7 +31,7 @@ If you're unsure where to start, the following set of questions should help you


 ### Use one of our standalone Nym clients
- If you've answered 'No' to all of the above, you may need to use one of our [standalone clients](https://nymtech.net/docs/clients/overview.html). All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets.
+ If you've answered 'No' to all of the above, you may need to use one of our [standalone clients](https://nymtech.net/docs/clients/overview.html). All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets. While setting up those, and depending on your usecase, you may need to set-up and run a Service Provider. Read below the "How to deal with Service Providers" section for more details.
 You can find more information about the different standalone clients and the ways to interact with them [in this page](https://nymtech.net/developers/integrations/mixnet-integration.html). 


@@ -68,7 +68,7 @@ For integration entry points:
   ```

 ## How to deal with Service Providers? 
- In a nutshell: that depends on your app's goal and architecture (and the endpoint it needs to hit).
+If you decide to interact with one of the Nym [standalone clients](https://nymtech.net/docs/clients/overview.html), then you most likely will need to set-up a Service Provider. The need for a Service Provider mostly depends on your app's goal and architecture (and the endpoint it needs to hit).
 Again, as detailed in the [FAQ](../FAQ/general): 

 - 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.