Tommy Verrall
22c59be82c
* changed last vers. checkout to master * corrected path of config * make binaries executable * docs: typescript.md - changing variables * docs: rust.md - changing variables * docs: vesting-contract.md - changing variables * docs: mixnet-contract.md - changing variables * docs: all variables changed * operators: all variables finished * dev-portal: mixnet-integration.md - variable changed * dev-portal: faq.md - variable changed * dev-portal: moredo.md up to date w NC default * dev-portal: telegram.md - added banner & minor fix * dev-portal: matrix.md - added banner * PR finished - ready for review and merge * removed all instances of platform_release_version var * removed all instances of platform_release_version var * changed version bumper script: removed platform_release_version references * changed comment * updating changelog and bumping versions --------- Co-authored-by: serinko <97586125+serinko@users.noreply.github.com> Co-authored-by: mfahampshire <maxhampshire@pm.me> Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com> Co-authored-by: benedettadavico <benedetta.davico@gmail.com>
Nym API
The Nym API provides multiple services to the Nym network, and is designed to be run alongside Nyxd validators. From a logical perspective, there are multiple applications, but they are bundled together for ease of deployment.
Nym Directory Caching
The Nym directory is contained in the mixnet smart contract in the Nyx blockchain. The blockchain holds the canonical directory information about nodes, stake, locations etc. The Nym API caches this information periodically to make queries faster and more scalable.
Nym Network Monitoring
The Nym API periodically sends test packets through the entire Nym mixnet to test node liveness and quality of service.
Nym Epoch Advancement and Payment
The Nym API periodically advances the epoch and triggers payment based on network monitoring measurements.
Coconut Credentials
Coconut [paper] is a distributed cryptographic signing scheme providing a high degree of privacy for its users. You can find an overview of how to use it in the Coconut section of the Nym documentation.
A simple explanation is also available in blog form.
This project was partially funded through the NGI0 PET Fund, a fund established by NL.net with financial support from the European Commission's NGI programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825310.