Jędrzej Stuczyński
5709c45a50
* Fixed typo in node_status_cache constant * ibid * Moved some caching stuff around so I can see what depends on what * Finishing merge of conflicted files * Minor smoothing * Got cache reads working for circ supply and refactored common cache * Refactored nyxd client usages to make things bit more clear * Moved caching support stuff into the support folder * Moved storage code into support module * Removed dead code * Tweaks * Handling cases a little more nicely in circulating supply api * Renamed nymd_client to nyxd_client * Pulled CacheNotification into the caching support module * Pulled some domain-specific helpers out of cache refresher * Moving some more helper methods out of the cache refresher * Deleting unused code * Extracted a few more functions out of the cache refresher * A few comments as breadcrumbs * Renaming the anemic "helpers" to "node_sets" * Renaming the validator_cache module to nym_contract_cache * Renaming nym contract cache stuff to make things clearer * Renamging a few things in comments * Renaming validator_cache to nym_contract_cache * foomp * Started refactoring http and cli * Extracted cli arg parsing into its own module * Cleanup * Extracted start methods into various modules to clean main up * WIP commit * Build working, swagger not * Fixed swagger docs metadata * Removed log statement * Circulating supply cache now working with simple logic * Fixed up circulating supply method names * Starting to work in some (wrong) constants * Documented the cache * Renaming circulating-supply route * nym-api compiling after the rebasing but most likely not fully working yet * removed unused imports * only starting RewardedSetUpdater if the config flag is set * nym-api compiling with coconut feature * removed redundant process_runner * removed generic aspect of nym-api nyxd::Client * signle entry point for starting nym_contract_cache * do not eagerly grab instances of managed state * inlining openapi route spec * CirculatingSupplyResponse type * fixed compilation of coconut tests * calculating circulating supply based on mixmining reserve and vesting tokens * separated different variants of caching intervals * allow nym-api to specify address of the vesting contract * fixed types export * renamed the query on the vesting contract * reorganised startup procedure and made all start methods independent from rocket * cleaned up startup procedure for nym-api * startup checks for rewarding permisssions * updated changelog * added config flag to control whether circulating supply should be updated Co-authored-by: Dave Hrycyszyn <futurechimp@users.noreply.github.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 of the Nym mixnet to test node liveness and quality of service.
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.