Nucypher

-------------------

Misc
~~~~

- Increase startup poll rate for checking bonding/funding from 10s to 120s. (`3364 <https://github.com/nucypher/nucypher/issues/3364>`__)

-------------------

-------------------

Internal Development Tasks
~~~~~~~~~~~~~~~~~~~~~~~~~~

- (`3360 <https://github.com/nucypher/nucypher/issues/3360>`__)

-------------------

Features
~~~~~~~~

- Basic support for polygon conditions (`2986 <https://github.com/nucypher/nucypher/issues/2986>`__)
- Add artifacts for new network: tapir (`2996 <https://github.com/nucypher/nucypher/issues/2996>`__)
- Update contract registry for lynx network (`3000 <https://github.com/nucypher/nucypher/issues/3000>`__)
- Allow a key to be specified for evaluating the return value (`3002 <https://github.com/nucypher/nucypher/issues/3002>`__)
- Bump ``nucypher-core`` to 0.6. (`3049 <https://github.com/nucypher/nucypher/issues/3049>`__)
- Include inventory entries for oryx. (`3069 <https://github.com/nucypher/nucypher/issues/3069>`__)
- Introduces support for DKG and Threshold Decryption. (`3083 <https://github.com/nucypher/nucypher/issues/3083>`__)
- Enables "Simple" threshold decryption variant and threshold decryption functionlity by Bob. (`3088 <https://github.com/nucypher/nucypher/issues/3088>`__)
- End-to-end encryption for CBD decryption requests. (`3123 <https://github.com/nucypher/nucypher/issues/3123>`__)
- ``TimeCondition`` now uses the timestamp of the latest block for evaluating conditions, instead of system time. System time condition evaluation is no longer supported. (`3139 <https://github.com/nucypher/nucypher/issues/3139>`__)
- Implement prefix notation for access control conditions with logical operators. (`3140 <https://github.com/nucypher/nucypher/issues/3140>`__)
- Sublcasses of Bob and Enrico which allow local, off-chain development and styling of both success and failure cases, which can be forced instead of checking conditions. (`3143 <https://github.com/nucypher/nucypher/issues/3143>`__)
- Add version element to condition language to allow future changes and to manage backwards compatibility. (`3145 <https://github.com/nucypher/nucypher/issues/3145>`__)
- Increase default timeout for ``/reencrypt`` requests to limit timeouts when multiple retrieval kits are included in a single request. (`3153 <https://github.com/nucypher/nucypher/issues/3153>`__)
- Reset default ferveo variant to be ``simple``. We can revisit whenever we add logic to properly deal with request failures for the ``precomputed`` variant. (`3174 <https://github.com/nucypher/nucypher/issues/3174>`__)
- - Support arbitrary multichain configuration for EVM-compatible blockchains for condition evaluation by ursula.
- Support for fallback RPC providers and multiple URI specification for a single chain ID. (`3185 <https://github.com/nucypher/nucypher/issues/3185>`__)
- Implement data encapsulation when encrypting data using ``ferveo`` encryption by utilizing ``ThresholdMessageKit`` and ``AccessControlPolicy``.
Provide framework to incorporate authorization allow logic for authorized encryptors of data for a ritual. (`3194 <https://github.com/nucypher/nucypher/issues/3194>`__)
- Add a mandatory condition_type field to condition schemas (`3201 <https://github.com/nucypher/nucypher/issues/3201>`__)
- New HTTP(S) endpoint to return a list of all the blockchains a node is currently connected to for conditions evaluation. (`3205 <https://github.com/nucypher/nucypher/issues/3205>`__)
- Introduces `nucypher ursula config migrate` for configuration file automation. (`3207 <https://github.com/nucypher/nucypher/issues/3207>`__)
- Implement functionality related to Encryptor authorization for specific ritual.
Obtain ritual threshold from Coordinator contract. (`3213 <https://github.com/nucypher/nucypher/issues/3213>`__)
- Nodes reject decryption requests for already expired rituals. (`3279 <https://github.com/nucypher/nucypher/issues/3279>`__)
- Added ``not`` operator functionality to ``CompoundAccessControlCondition`` so that the logical inverse of conditions can be evaluated. (`3293 <https://github.com/nucypher/nucypher/issues/3293>`__)
- Allow Bob / ThresholdAccessControlClient decryption and reencryption operations to specify timeouts. (`3337 <https://github.com/nucypher/nucypher/issues/3337>`__)
- Use ``TACoChildApplication`` contract for node sampling instead of ``TACoApplication`` contract. (`3341 <https://github.com/nucypher/nucypher/issues/3341>`__)


Bugfixes
~~~~~~~~

- temp workaround for Ropsten/oryx gas estimation issue (`2943 <https://github.com/nucypher/nucypher/issues/2943>`__)
- Show fleet state checksums as hex instead of an escaped bytestring (`2946 <https://github.com/nucypher/nucypher/issues/2946>`__)
- Correctly validate domain/network values provided via the ``--network`` parameter in the CLI. (`2952 <https://github.com/nucypher/nucypher/issues/2952>`__)
- Call `_resolve_abi` after the condition is initialized (`3014 <https://github.com/nucypher/nucypher/issues/3014>`__)
- Properly handle PRE request with no condition. (`3025 <https://github.com/nucypher/nucypher/issues/3025>`__)
- Restrict return value `key` to integer only (`3032 <https://github.com/nucypher/nucypher/issues/3032>`__)
- Use decoded text from failed HTTP Responses for exception messages. (`3042 <https://github.com/nucypher/nucypher/issues/3042>`__)
- Properly convert ritual id to bytes when being used as a seed for generating a session key. (`3178 <https://github.com/nucypher/nucypher/issues/3178>`__)
- Fix staking metrics in Prometheus exporter (`3199 <https://github.com/nucypher/nucypher/issues/3199>`__)
- Fix Prometheus import error when running Porter (`3202 <https://github.com/nucypher/nucypher/issues/3202>`__)
- (`3203 <https://github.com/nucypher/nucypher/issues/3203>`__, `#3209 <https://github.com/nucypher/nucypher/issues/3209>`__, `#3214 <https://github.com/nucypher/nucypher/issues/3214>`__)
- ``UrsulaConfiguration`` object should not be too eager to connect to provided blockchain endpoints; if faulty then the configuration file can't be updated. (`3282 <https://github.com/nucypher/nucypher/issues/3282>`__)
- Fix nucypher CLI: ``ursula config ip-address`` (`3292 <https://github.com/nucypher/nucypher/issues/3292>`__)
- Fix issues when bytes are provided as hex for return value comparators.
Make condition value types more strict by using ABI to validate. (`3303 <https://github.com/nucypher/nucypher/issues/3303>`__)
- Address bug where context variable not properly processed when doing type checking for multi-value output. (`3312 <https://github.com/nucypher/nucypher/issues/3312>`__)
- Include the port in ``seeds.nucyher.network`` URL entry in dictionary of teacher nodes for mainnet. (`3332 <https://github.com/nucypher/nucypher/issues/3332>`__)


Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~

- Add recommendation/information about restart functionality when running a PRE node. (`2945 <https://github.com/nucypher/nucypher/issues/2945>`__)
- Relocates documentation to https://docs.threshold.network (https://github.com/threshold-network/threshold). (`#3311 <https://github.com/nucypher/nucypher/issues/3311>`__)


Deprecations and Removals
~~~~~~~~~~~~~~~~~~~~~~~~~

- Remove set up dependency on ``setuptools-markdown`` which is no longer needed, but caused build failures. (`2942 <https://github.com/nucypher/nucypher/issues/2942>`__)
- Deprecates alice, bob, and contact CLI commands. (`2985 <https://github.com/nucypher/nucypher/issues/2985>`__)
- Removals:
- RPC servers
- character WebControllers
- unused literature
- unused CLI option definitions
- CLI helper functions for Alice, Bob, Contacts interactivity
- interactive Ursula mode
- enrico CLI commands (`2987 <https://github.com/nucypher/nucypher/issues/2987>`__)
- Removes LMDB Datastore (`2988 <https://github.com/nucypher/nucypher/issues/2988>`__)
- Removes clef and trezor signer support (`2989 <https://github.com/nucypher/nucypher/issues/2989>`__)
- Relocate porter to nucypher/nucypher-porter (`2990 <https://github.com/nucypher/nucypher/issues/2990>`__)
- Retires the Ibex and Oryx testnets (`2998 <https://github.com/nucypher/nucypher/issues/2998>`__)
- Deprecated "federated mode" ursulas and the --federated-only launch flag. (`3030 <https://github.com/nucypher/nucypher/issues/3030>`__)
- Deprecated "timelock" time condition that used system time in favor of a condition that uses block time. (`3139 <https://github.com/nucypher/nucypher/issues/3139>`__)
- Remove the use of infix notation for access control conditions with logical operators in favor of prefix notation. (`3140 <https://github.com/nucypher/nucypher/issues/3140>`__)
- removes `nucypher bond` CLI (`3149 <https://github.com/nucypher/nucypher/issues/3149>`__)
- (`3234 <https://github.com/nucypher/nucypher/issues/3234>`__)
- Remove ``EconomicsFactory`` and ``Economics`` classes. (`3241 <https://github.com/nucypher/nucypher/issues/3241>`__)
- Remove ``AdjudicatorAgent`` and custom ``Dispatcher`` proxy logic. (`3243 <https://github.com/nucypher/nucypher/issues/3243>`__)
- Deprecate configuration config/parameters ``pre-payment-network``, ``coordinator_uri`` since the L2 network is implied based on TACo network used. (`3262 <https://github.com/nucypher/nucypher/issues/3262>`__)


Misc
~~~~

- Add default seed node for Oryx testnet. (`2944 <https://github.com/nucypher/nucypher/issues/2944>`__)
- Prometheus metrics exporter returned (`2950 <https://github.com/nucypher/nucypher/issues/2950>`__)
- Extends policy probationary period until August 31st, 2022. No policies may be created on the network beyond this date. (`2952 <https://github.com/nucypher/nucypher/issues/2952>`__)
- Cleanup of prometheus metrics collection. (`2954 <https://github.com/nucypher/nucypher/issues/2954>`__)
- Reworks internal blockchain connection cache to support multiple concurrent connections. (`3137 <https://github.com/nucypher/nucypher/issues/3137>`__)
- Ensure that nodes can be more resilient when handling events related to rituals. (`3183 <https://github.com/nucypher/nucypher/issues/3183>`__)
- Use a time-to-live cache for trakcing ritual participation state which gets periodically purged when ritual state is deemed stale. (`3191 <https://github.com/nucypher/nucypher/issues/3191>`__)
- Don't allow users to specify the FerveoVariant to use for threshold decryption. The default, simple variant, will be used. (`3193 <https://github.com/nucypher/nucypher/issues/3193>`__)
- (`3204 <https://github.com/nucypher/nucypher/issues/3204>`__, `#3210 <https://github.com/nucypher/nucypher/issues/3210>`__, `#3215 <https://github.com/nucypher/nucypher/issues/3215>`__, `#3220 <https://github.com/nucypher/nucypher/issues/3220>`__)
- Update Ursula configuration version from 6 to 7.
Check operator for MATIC funding instead of ETH on startup.
Handle separation between mainnet root application contract and l2 child application contract. (`3227 <https://github.com/nucypher/nucypher/issues/3227>`__)
- Properly detect operator bonding status by using both ``TACoChildApplicationAgent`` and ``TACoApplicationAgent`` to ensure consistency. (`3237 <https://github.com/nucypher/nucypher/issues/3237>`__)
- Contract registries now use JSON format and support multi-chain deployments organized by nucypher "domain". (`3261 <https://github.com/nucypher/nucypher/issues/3261>`__)
- Since the L2 network is always implied based on the TACo network connected to, we no longer need those config/parameters across the codebase, it can be inferred.
Each Character now takes optional eth and polygon endpoints.
Remove various usages of redundant L2 values. General rename from ``[eth_]provider[_uri]`` to ``[blockchain/eth/polygon]_endpoint``. (`3262 <https://github.com/nucypher/nucypher/issues/3262>`__)
- Add ``tapir`` contract registry. (`3277 <https://github.com/nucypher/nucypher/issues/3277>`__)
- Reduce the number of times the blockchain is queried for chain id. (`3285 <https://github.com/nucypher/nucypher/issues/3285>`__)
- Add ``nucypher taco rituals`` CLI command to list ritual information for a TACo domain. (`3290 <https://github.com/nucypher/nucypher/issues/3290>`__)
- Require condition RPC endpoints for node startup (`3318 <https://github.com/nucypher/nucypher/issues/3318>`__)


Internal Development Tasks
~~~~~~~~~~~~~~~~~~~~~~~~~~

- (`3019 <https://github.com/nucypher/nucypher/issues/3019>`__, `#3021 <https://github.com/nucypher/nucypher/issues/3021>`__, `#3022 <https://github.com/nucypher/nucypher/issues/3022>`__, `#3023 <https://github.com/nucypher/nucypher/issues/3023>`__, `#3024 <https://github.com/nucypher/nucypher/issues/3024>`__, `#3026 <https://github.com/nucypher/nucypher/issues/3026>`__, `#3028 <https://github.com/nucypher/nucypher/issues/3028>`__, `#3029 <https://github.com/nucypher/nucypher/issues/3029>`__, `#3034 <https://github.com/nucypher/nucypher/issues/3034>`__, `#3037 <https://github.com/nucypher/nucypher/issues/3037>`__, `#3040 <https://github.com/nucypher/nucypher/issues/3040>`__, `#3046 <https://github.com/nucypher/nucypher/issues/3046>`__, `#3048 <https://github.com/nucypher/nucypher/issues/3048>`__, `#3071 <https://github.com/nucypher/nucypher/issues/3071>`__, `#3126 <https://github.com/nucypher/nucypher/issues/3126>`__, `#3134 <https://github.com/nucypher/nucypher/issues/3134>`__, `#3135 <https://github.com/nucypher/nucypher/issues/3135>`__, `#3138 <https://github.com/nucypher/nucypher/issues/3138>`__, `#3152 <https://github.com/nucypher/nucypher/issues/3152>`__, `#3158 <https://github.com/nucypher/nucypher/issues/3158>`__, `#3159 <https://github.com/nucypher/nucypher/issues/3159>`__, `#3160 <https://github.com/nucypher/nucypher/issues/3160>`__, `#3162 <https://github.com/nucypher/nucypher/issues/3162>`__, `#3165 <https://github.com/nucypher/nucypher/issues/3165>`__, `#3169 <https://github.com/nucypher/nucypher/issues/3169>`__, `#3170 <https://github.com/nucypher/nucypher/issues/3170>`__, `#3171 <https://github.com/nucypher/nucypher/issues/3171>`__, `#3179 <https://github.com/nucypher/nucypher/issues/3179>`__, `#3196 <https://github.com/nucypher/nucypher/issues/3196>`__, `#3208 <https://github.com/nucypher/nucypher/issues/3208>`__, `#3216 <https://github.com/nucypher/nucypher/issues/3216>`__, `#3221 <https://github.com/nucypher/nucypher/issues/3221>`__, `#3222 <https://github.com/nucypher/nucypher/issues/3222>`__, `#3233 <https://github.com/nucypher/nucypher/issues/3233>`__, `#3238 <https://github.com/nucypher/nucypher/issues/3238>`__, `#3239 <https://github.com/nucypher/nucypher/issues/3239>`__, `#3250 <https://github.com/nucypher/nucypher/issues/3250>`__, `#3252 <https://github.com/nucypher/nucypher/issues/3252>`__, `#3254 <https://github.com/nucypher/nucypher/issues/3254>`__, `#3255 <https://github.com/nucypher/nucypher/issues/3255>`__, `#3256 <https://github.com/nucypher/nucypher/issues/3256>`__, `#3257 <https://github.com/nucypher/nucypher/issues/3257>`__, `#3258 <https://github.com/nucypher/nucypher/issues/3258>`__, `#3267 <https://github.com/nucypher/nucypher/issues/3267>`__, `#3271 <https://github.com/nucypher/nucypher/issues/3271>`__, `#3272 <https://github.com/nucypher/nucypher/issues/3272>`__, `#3274 <https://github.com/nucypher/nucypher/issues/3274>`__, `#3275 <https://github.com/nucypher/nucypher/issues/3275>`__, `#3276 <https://github.com/nucypher/nucypher/issues/3276>`__, `#3295 <https://github.com/nucypher/nucypher/issues/3295>`__, `#3298 <https://github.com/nucypher/nucypher/issues/3298>`__, `#3304 <https://github.com/nucypher/nucypher/issues/3304>`__, `#3306 <https://github.com/nucypher/nucypher/issues/3306>`__, `#3308 <https://github.com/nucypher/nucypher/issues/3308>`__, `#3309 <https://github.com/nucypher/nucypher/issues/3309>`__, `#3312 <https://github.com/nucypher/nucypher/issues/3312>`__, `#3315 <https://github.com/nucypher/nucypher/issues/3315>`__, `#3317 <https://github.com/nucypher/nucypher/issues/3317>`__, `#3321 <https://github.com/nucypher/nucypher/issues/3321>`__, `#3323 <https://github.com/nucypher/nucypher/issues/3323>`__, `#3325 <https://github.com/nucypher/nucypher/issues/3325>`__, `#3330 <https://github.com/nucypher/nucypher/issues/3330>`__, `#3334 <https://github.com/nucypher/nucypher/issues/3334>`__, `#3335 <https://github.com/nucypher/nucypher/issues/3335>`__, `#3338 <https://github.com/nucypher/nucypher/issues/3338>`__, `#3344 <https://github.com/nucypher/nucypher/issues/3344>`__, `#3345 <https://github.com/nucypher/nucypher/issues/3345>`__, `#3347 <https://github.com/nucypher/nucypher/issues/3347>`__, `#3348 <https://github.com/nucypher/nucypher/issues/3348>`__)
- Updates to use ferveo v0.1.11. (`3121 <https://github.com/nucypher/nucypher/issues/3121>`__)
- Add profiling option to ``testnet_simple_taco.py`` demo. (`3284 <https://github.com/nucypher/nucypher/issues/3284>`__)
- Context variable names are restricted to alphanumeric characters, numbers and underscores. (`3331 <https://github.com/nucypher/nucypher/issues/3331>`__)

-------------------

Features
~~~~~~~~

- SSL Certificate fetching and Porter optimizations
- Middleware should try cached SSL certification for a node first, and then if the requests fails, fetch the node's up-to-date SSL cert
- Short-circuit WorkerPool background execution once sufficient successful executions occur
- Don't limit WorkerPool size; this has consequences when smaller samples of ursulas are performed; allow threadpool to be flexible by using default min/max
- Return more comprehensive error information for failed WorkerPool execution (`2908 <https://github.com/nucypher/nucypher/issues/2908>`__)


Bugfixes
~~~~~~~~

- Fix Porter sampling check that ensures Ursula is reachable to be more comprehensive; previously an unreachable Ursula could still be deemed as reachable. (`2888 <https://github.com/nucypher/nucypher/issues/2888>`__)
- Only print relevant network options when running `nucypher ursula init` (`2917 <https://github.com/nucypher/nucypher/issues/2917>`__)
- Retrieve contract registries from the ``development`` branch on GitHub instead of ``main``. (`2924 <https://github.com/nucypher/nucypher/issues/2924>`__)
- Properly support event retrieval for the PREApplication contract.
Remove invalid support for SubscriptionManager contract - proper support will be
added in a future release. (`2934 <https://github.com/nucypher/nucypher/issues/2934>`__)


Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~

- Remove references to ``cloudworkers`` CLI command, and update bond operator to reference UI. (`2896 <https://github.com/nucypher/nucypher/issues/2896>`__)
- Updated examples and demos for usage on polygon/mainnet. (`2897 <https://github.com/nucypher/nucypher/issues/2897>`__)
- Updates to nucypher-ops guides for mainnet usage (`2916 <https://github.com/nucypher/nucypher/issues/2916>`__)


Misc
~~~~

- Dependency updates - Tests target the london fork. (`2837 <https://github.com/nucypher/nucypher/issues/2837>`__)
- Creation of 'oryx' PRE testnet on Ropsten. (`2893 <https://github.com/nucypher/nucypher/issues/2893>`__)
- Add more color to cli output (`2909 <https://github.com/nucypher/nucypher/issues/2909>`__)
- Add a pre-commit hook and github action for `Darker <https://github.com/akaihola/darker>`_ to ensure all future changes conform to black and isort. (`#2921 <https://github.com/nucypher/nucypher/issues/2921>`__)
- Bump ``nucypher-core`` dependency to 0.2 (`2927 <https://github.com/nucypher/nucypher/issues/2927>`__)
- Show error message when ``--prometheus`` flag is used since functionality not currently supported. Prometheus
monitoring functionality will be revamped in a subsequent release. (`2929 <https://github.com/nucypher/nucypher/issues/2929>`__)
- Removes [docs] pip extra (`2932 <https://github.com/nucypher/nucypher/issues/2932>`__)

-------------------

Features
~~~~~~~~

- Introduction of NuCypher Porter - a web-based service that performs ``nucypher`` protocol operations on behalf of applications for cross-platform functionality. (`2664 <https://github.com/nucypher/nucypher/issues/2664>`__)
- Ursula no longer stores KFrags, instead Alice encrypts them inside the treasure map. Allow the KFrag generator and policy publisher to be different entities. (`2687 <https://github.com/nucypher/nucypher/issues/2687>`__)
- Characters use mnemonic seed words to derive deterministic keystore, taking the place of the "keyring". (`2701 <https://github.com/nucypher/nucypher/issues/2701>`__)
- Simplifies the retrieval protocol (see `259 <https://github.com/nucypher/nucypher/issues/259>`_ for the discussion). ``PolicyMessageKit`` is renamed to ``MessageKit``. ``Bob.retrieve()`` is renamed to ``retrieve_and_decrypt()``, and its signature is simplified: it only requires the treasure map, Alice's verifying key, and the policy encrypting key. A lower-level ``Bob.retrieve()`` is added that does not decrypt, but only attempts to retrieve the capsule frags. (`#2730 <https://github.com/nucypher/nucypher/issues/2730>`__)
- Allow importing of secret key material for power derivations. (`2742 <https://github.com/nucypher/nucypher/issues/2742>`__)
- Uniform versioning of bytes serializable protocol entities. (`2767 <https://github.com/nucypher/nucypher/issues/2767>`__)
- Modify Porter REST endpoint from ``/exec_work_order`` to ``/retrieve_cfrags`` and modify request parameters for retrieval of re-encrypted data.
Update Bob ``/retrieve_and_decrypt`` REST endpoint to accept a list of message kits instead of only one - to match updated ``Bob.retrieve_and_decrypt`` Python API. (`2768 <https://github.com/nucypher/nucypher/issues/2768>`__)
- Update WorkerPool error messages returned by Porter API. (`2772 <https://github.com/nucypher/nucypher/issues/2772>`__)
- Adds ansible build/deploy for Monitor (status.nucypher.network) (`2801 <https://github.com/nucypher/nucypher/issues/2801>`__)
- Extend brand size in ``Versioned`` to 4 bytes (`2805 <https://github.com/nucypher/nucypher/issues/2805>`__)
- CORS, NGINX support for Porter:
- Added opt-in CORS origins support to Porter; no origins allowed by default when running Porter directly.
- Provided docker-compose execution for Porter to run behind an NGINX reverse proxy server - all origins allowed by default for CORS, but can be customized. NGINX allows for the potential for more complex infrastructure configurations. (`2807 <https://github.com/nucypher/nucypher/issues/2807>`__)
- (`2809 <https://github.com/nucypher/nucypher/issues/2809>`__)
- Halting NU inflation, now refund in WorkLock is possible without work (claim still needed) (`2822 <https://github.com/nucypher/nucypher/issues/2822>`__)
- Updates to integrate NuCypher into Threshold Network (`2824 <https://github.com/nucypher/nucypher/issues/2824>`__)
- Integrate StakingEscrow with Threshold Network's TokenStaking (`2825 <https://github.com/nucypher/nucypher/issues/2825>`__)
- Removes snapshots logic from ``StakingEscrow`` (`2831 <https://github.com/nucypher/nucypher/issues/2831>`__)
- Switched to Rust implementation of the protocol types (``nucypher-core``). Correspondingly, API has been simplified, and type requirements have been made more strict. (`2832 <https://github.com/nucypher/nucypher/issues/2832>`__)
- Simple PRE application contract (`2838 <https://github.com/nucypher/nucypher/issues/2838>`__)
- Renames operator to staking provider and worker to operator (`2851 <https://github.com/nucypher/nucypher/issues/2851>`__)
- Modifies Ursulas for usage as Operators on the Threshold Network's PRE Application. (`2857 <https://github.com/nucypher/nucypher/issues/2857>`__)
- - Full support of policy payments sumitted to polygon in demos and top-level APIs.
- Improved certificate handling for network requests.
- Prioritizes in-memory node storage for all node runtimes. (`2873 <https://github.com/nucypher/nucypher/issues/2873>`__)
- Updated nucypher-core to 0.1 (`2883 <https://github.com/nucypher/nucypher/issues/2883>`__)
- Proactively shut down Ursula if it is no longer bonded to any staking provider. (`2886 <https://github.com/nucypher/nucypher/issues/2886>`__)
- Include polygon/matic contract registry for mainnet. (`2894 <https://github.com/nucypher/nucypher/issues/2894>`__)


Bugfixes
~~~~~~~~

- (`2727 <https://github.com/nucypher/nucypher/issues/2727>`__)
- Cloudworkers: ignore errors on stopping of ursula containers (`2728 <https://github.com/nucypher/nucypher/issues/2728>`__)
- Fixed a problem with node metadata being stored to a file with an incorrect name (`2748 <https://github.com/nucypher/nucypher/issues/2748>`__)
- Fixed failing transactions when gas price used is not an integer. (`2753 <https://github.com/nucypher/nucypher/issues/2753>`__)
- Stop writing bytes to log file which causes exceptions - instead write the hex representation. (`2762 <https://github.com/nucypher/nucypher/issues/2762>`__)
- ``StakingEscrow.partition_stakers_by_activity()`` no longer includes stakers with expired stakes in the ``missing_stakers`` value returned, thereby no longer overstating the number of inactive stakers. (`2764 <https://github.com/nucypher/nucypher/issues/2764>`__)
- force pull latest tagged image on external geth deployment (`2766 <https://github.com/nucypher/nucypher/issues/2766>`__)
- Minor memory improvement when collecting staker/worker metrics for prometheus. (`2785 <https://github.com/nucypher/nucypher/issues/2785>`__)
- Fix bug when generating file for output of events from status & stake cli commands. (`2786 <https://github.com/nucypher/nucypher/issues/2786>`__)
- Only use public data to generate keystore IDs and filenames. (`2800 <https://github.com/nucypher/nucypher/issues/2800>`__)
- Fixed WebController bug caused by Path object for TLS/certificate path provided to Hendrix instead of a string. (`2807 <https://github.com/nucypher/nucypher/issues/2807>`__)
- Avoid crashing the learning loop if there is a problem in the metadata returned by seed nodes. (`2815 <https://github.com/nucypher/nucypher/issues/2815>`__)
- Fixed a missing timestamp error when a node's status is requested before it participated in metadata exchange. (`2819 <https://github.com/nucypher/nucypher/issues/2819>`__)
- Fixed a memory leak in Ursula: removed some teacher statistics accumulated over time, and limited the amount of old fleet states stored. (`2820 <https://github.com/nucypher/nucypher/issues/2820>`__)
- Fixed some occurrences of the old term for ``shares`` (``n``) (`2829 <https://github.com/nucypher/nucypher/issues/2829>`__)
- Fix an incorrect usage of node object in ``FleetSensor``. (`2877 <https://github.com/nucypher/nucypher/issues/2877>`__)
- Fix runaway WorkTracker task that ensures operator confirmed transaction occurs but continues running and making web3 requests even after operator already confirmed. (`2886 <https://github.com/nucypher/nucypher/issues/2886>`__)


Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~

- Document how worker period commitment works. (`2776 <https://github.com/nucypher/nucypher/issues/2776>`__)
- Update documentation to reflect new TreasureMap con KFrags design. (`2833 <https://github.com/nucypher/nucypher/issues/2833>`__)
- Overhaul NuCypher documentation to accommodate the new PRE Application / Threshold Network paradigm. (`2870 <https://github.com/nucypher/nucypher/issues/2870>`__)
- Add documentation about bonding an operator to a staking provider. (`2874 <https://github.com/nucypher/nucypher/issues/2874>`__)
- Embed Threshold Network videos within docs. (`2882 <https://github.com/nucypher/nucypher/issues/2882>`__)


Deprecations and Removals
~~~~~~~~~~~~~~~~~~~~~~~~~

- Renames enviorment variable `NUCYPHER_KEYRING_PASSWORD` to `NUCYPHER_KEYSTORE_PASSWORD` (`2701 <https://github.com/nucypher/nucypher/issues/2701>`__)
- ``m`` and ``n`` parameters can no longer be used in character control and Python API; ``--m`` and ``--n`` are no longer supported by the CLI (``-m`` and ``-n`` still are; the long versions are now ``--threshold`` and ``--shares``) (`2774 <https://github.com/nucypher/nucypher/issues/2774>`__)
- Removal of treasure map storage functionality and supporting publication APIs from the decentralized network.
Encrypted treasure maps must be obtained from side channels instead of Ursulas on the network (unless cached). (`2780 <https://github.com/nucypher/nucypher/issues/2780>`__)
- Remove an unused method of ``Amonia`` (deprecated since we do not store the treasure map on Ursulas anymore) (`2804 <https://github.com/nucypher/nucypher/issues/2804>`__)
- Removes the Arrangement API for Alice/Ursula negotiations. Use a simple livliness check during grant-time. (`2808 <https://github.com/nucypher/nucypher/issues/2808>`__)
- Retires and removes eth/token faucet. (`2848 <https://github.com/nucypher/nucypher/issues/2848>`__)
- Remove NuCypher DAO specific code since we are now the Threshold DAO. (`2864 <https://github.com/nucypher/nucypher/issues/2864>`__)
- Removes 'cloudworkers' CLI command in favor of nucypher-ops. (`2895 <https://github.com/nucypher/nucypher/issues/2895>`__)


Misc
~~~~

- Switch to PyUmbral 0.2 and adjust its usage according to the changed API. (`2612 <https://github.com/nucypher/nucypher/issues/2612>`__)
- Add disclaimers to ``nucypher stake increase`` and ``nucypher stake merge`` CLI operations to provide warning about
potential reduced rewards for the first period after stake increase due to a known bug, and the workaround. (`2693 <https://github.com/nucypher/nucypher/issues/2693>`__)
- Added a more informative error message for ``WorkerPool`` exceptions. (`2744 <https://github.com/nucypher/nucypher/issues/2744>`__)
- Separated Alice and Publisher roles internally and in relevant public APIs (`2745 <https://github.com/nucypher/nucypher/issues/2745>`__)
- TreasureMap split into TreasureMap and EncryptedTreasureMap; external methods of Bob and Porter now take the latter, with the parameter named 'encrypted_treasure_map'. SignedTreasureMap is merged with TreasureMap. (`2773 <https://github.com/nucypher/nucypher/issues/2773>`__)
- Changed the names of ``m`` and ``n`` parameters to ``threshold`` and ``shares`` throughout the API. (`2774 <https://github.com/nucypher/nucypher/issues/2774>`__)
- Extends policy probationary period until October 31st, 2021. No policies may be created on the network beyond this date. (`2779 <https://github.com/nucypher/nucypher/issues/2779>`__)
- Umbral dependency bumped to v0.3.0 (`2798 <https://github.com/nucypher/nucypher/issues/2798>`__)
- Extracting protocol logic into an underlying layer and preparing to move it to Rust. Involves multiple ABI changes (in ``Arrangement``, ``MessageKit``, ``RevocationOrder``, ``EncryptedTreasureMap``, node metadata). In particular, old node metadata will be backward incompatible with the current version, since it now shares the versoning logic with other protocol objects. (`2802 <https://github.com/nucypher/nucypher/issues/2802>`__)
- Move some cryptographic operations inside the Rust extension. Remove dependency on `umbral` and `coincurve`. (`2850 <https://github.com/nucypher/nucypher/issues/2850>`__)
- Extend policy probationary period to 2022-6-16T23:59:59.0Z. (`2873 <https://github.com/nucypher/nucypher/issues/2873>`__)