This commit is contained in:
mfahampshire
2024-10-11 15:39:04 +02:00
parent e0e88d2b80
commit eb214a164e
4 changed files with 17 additions and 18 deletions
@@ -10,6 +10,6 @@ In the future the SDK will be made up of several modules, each of which will all
| Ecash | Create & verify Ecash credentials | ❌ |
| Validator | Sign & broadcast Nyx blockchain transactions, query the blockchain | ❌ |
The `Mixnet` module currently exposes the logic of two clients: the [websocket client](../clients/websocket), and the [socks](../clients/socks5) client.
The `Mixnet` module currently exposes the logic of two clients: the [websocket client](../clients/websocket), and the [socks client](../clients/socks5).
The `TcpProxy` module exposes functionality to set up client/server instances that expose a localhost TcpSocket to read/write to.
@@ -1,7 +1,5 @@
# Network Components
TODO new diagram
Core components:
* A **Mixnet**, which encrypts and mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. Our mixnet is based on a modified version of the [**Loopix** design](concepts/loopix). This is made up of [Nym nodes](architecture/mixnet/nodes) runnning on servers around the world.
* Various [**Nym clients**](architecture/mixnet/clients) which manage sending and receiving Sphinx packets, encrypting/decrypting traffic, and providing [cover traffic](./concepts/cover-traffic) to hide 'real' traffic timing.
+2 -1
View File
@@ -13,7 +13,8 @@
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve"
"jsx": "preserve",
"baseUrl": "."
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"exclude": ["node_modules"]
+14 -14
View File
@@ -24,7 +24,7 @@ Initial overhaul
- [x] ~~diagrams~~ (moved to new features)
- [ ] remove TODO links
- [ ] all licensing pages are the same: make a single component to import
- [x] all licensing pages are the same: make a single component to import
- [ ] operators
- [ ] tabs / general condensation of page length
@@ -40,23 +40,24 @@ Initial overhaul
- [x] ecash
- [ ] wait on ania's updates
- [ ] wait on whether we change the language now that we have 4 ticketbooks.. talk to jaya
- [ ] bring in notes from Claudia's presentation
- [ ] developers
- [ ] overhaul the FAQs and split out into integrations section
- [ ] ProxyClient/Server docs: formulate new integrations and docs around this
- [ ] integrations: pull all integration stuff from the TS SDK into its own subdir
- [ ] rewrite around the idea of using the proxy logic for the moment, in order for ease of integration
- [ ] write ovrview for the proxy
- [x] overhaul the FAQs and split out into integrations section
- [x] ProxyClient/Server docs: formulate new integrations and docs around this
- [x] integrations: pull all integration stuff from the TS SDK into its own subdir
- [x] rewrite around the idea of using the proxy logic for the moment, in order for ease of integration
- [x] write ovrview for the proxy
- [x] rust sdk - move to its own dir
- [x] proper code imports - static for the moment, look @ automation in next steps
- [x] redo cargo file example
- [ ] @ top: intro / quickstart / keyconcepts pages
- [ ] ts sdk docs
- [ ] quick content overhaul
- [ ] remove whitelist references: replace with tornull
- [ ] general
- [ ] remove numbering from sidebar
- [ ] check all links work and fix
- [x] @ top: intro / quickstart / keyconcepts pages
- [x] ts sdk docs
- [x] quick content overhaul
- [x] remove whitelist references: replace with tornull
- [x] general
- [x] remove numbering from sidebar
- [x] check all links work and fix
- [ ] replace `mdbook-cmdrun` with scripts in `package.json`
- [ ] all images to root images dir with subdirs
@@ -64,7 +65,6 @@ Initial overhaul
- [ ] make common links (e.g. github) variables if we require several
- [x] remove dangling index
- [ ] bring in notes from Claudia's presentation
Autodocs
--------