mfahampshire
e454d71b78
* tcp conn tracker * make default decay const * first pass connpool * err handling conpool start * added notes for next features * first version working * first pass spin out client_pool * cancel token * logging change * bump default decay time * bugfix: make sure to apply gateway score filtering when choosing initial node * add duplicate packets received to troubleshooting * client_pool.rs mod * client pool example * clippy * client pool example done * added disconnect to client pool * update mod file * add cancel token disconnect fn * comments * comments * add clone * added disconnect thread * update example files tcpproxy * client pool docs * remove comments for future ffi push + lower default pool size from 4 to 2 * comment on ffi * update command help * clone impl * remove clone * fix clippy * fix clippy again * fix test * tweaked text grammar * updated comment in example * future is now * cherry * cherry * fix borked rebase * fix fmt * wasm fix --------- Co-authored-by: Jędrzej Stuczyński <jedrzej.stuczynski@gmail.com>
19 lines
1.5 KiB
Markdown
19 lines
1.5 KiB
Markdown
# Development status
|
|
The SDK is still somewhat a work in progress: interfaces are fairly stable but still may change in subsequent releases.
|
|
|
|
In the future the SDK will be made up of several modules, each of which will allow developers to interact with different parts of Nym infrastructure.
|
|
|
|
| Module | Functionality | Released |
|
|
|-----------|---------------------------------------------------------------------------------------|----------|
|
|
| Mixnet | Create / load clients & keypairs, subscribe to Mixnet events, send & receive messages | ✔️ |
|
|
| TcpProxy | Utilise the TcpProxyClient and TcpProxyServer abstractions for streaming | ✔️ |
|
|
| ClientPool| Create a pool of quickly useable Mixnet clients | ✔️ |
|
|
| 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 client](../clients/socks5).
|
|
|
|
The `TcpProxy` module exposes functionality to set up client/server instances that expose a localhost TcpSocket to read/write to.
|
|
|
|
The `ClientPool` is a configurable pool of ephemeral clients which can be created as a background process and quickly grabbed.
|