Releases: aleph-im/pyaleph
v0.3.1
This release fixes a synchronisation issue introduced in 0.3.0. Messages where the "item_type"
field was not specified could not be processed in real-time and had to wait for the on-chain
confirmation to be processed.
How to upgrade: https://pyaleph.readthedocs.io/en/latest/guides/upgrade.html
v0.3.0 - Harder, Better, Faster, Stronger
This release focuses on improvements related to performance, stability and code quality. We also introduce new features related to FORGET and PROGRAM messages.
How to upgrade: https://pyaleph.readthedocs.io/en/latest/guides/upgrade.html
New features
- Ability to forget aggregates by @odesenfans in #289
- Add an API that exposes programs that respond to Aleph messages by @hoh in #230
- Specify max log file size by @odesenfans in #248
- Use property value for max_log_file_size by @odesenfans in #257
- [API] Add chain query parameter for messages by @odesenfans in #282
- [API] Add content hash query parameter for messages by @odesenfans in #284
Improvements
- [Messages] Improve throughput of jobs by @odesenfans in #278
- [Messages] Pydantic schema for message validation by @odesenfans in #272
- [Messages] Support default item type by @odesenfans in #287
- [Messages] Ignore confirmations in capped collection by @odesenfans in #252
- [DB] Use unordered bulk inserts by @odesenfans in #279
- [Chains] Use pending message model in signature verification by @odesenfans in #273
- [Forget] Fetch less data by @odesenfans in #276
- [Forget] Multi-users test by @odesenfans in #249
- [Jobs] Simplify pending TXs job by @odesenfans in #236
- [IPFS] Upgrade to v0.12.2 by @odesenfans in #225
- [Fix] Ignore invalid messages in messages job by @odesenfans in #246
- [Types] New dataclass for tx context by @odesenfans in #235
- [Permissions] Process unauthorized messages gracefully by @odesenfans in #258
- [Tests] Make API endpoints testable by @odesenfans in #260
- [Tests] Fixture to generate the test API client by @odesenfans in #263
- [Tests] Messages API tests by @odesenfans in #261
- [Migrations] Support for async upgrade functions by @odesenfans in #253
- [Migrations] Filter to select migration scripts by @odesenfans in #255
Other
- [Exceptions] Move old exceptions from types to exceptions by @odesenfans in #226
- [Readme] Fix link to install guide by @odesenfans in #243
- [Fix] Typo in monitoring Docker Compose file by @odesenfans in #244
- [Fix] Use collection of DB op in bulk write by @odesenfans in #245
- [TXs] Increase IPFS pin timeout to 2 minutes by @odesenfans in #251
- [mypy] Bump to 0.950 by @odesenfans in #259
- [Storage] Remove filename parameter by @odesenfans in #262
- [Tests] Use valid fixtures in forget tests by @odesenfans in #275
- [Types] Use ItemType defined in aleph-message by @odesenfans in #271
- [Monitoring] Fix Grafana dashboard time ranges by @odesenfans in #291
- [Docs] Improve protocol documentation by @odesenfans in #286
Full Changelog: v0.2.1...v0.3.0
v0.2.1
TLDR;
This minor release focuses on code improvements, improved test coverage and bug fixes.
Breaking changes
- CCNs now required Python 3.8+ instead of Python 3.6.
Changelog
- Improved the code for the storage module and improved test coverage.
- Fixed a major synchronisation issue between CCNs. A shared variable was not updated correctly, making it impossible
for CCNs to fetch the content linked to random messages. - Fixed an issue where IPFS/P2P jobs in charge of listening to the "alive" topics would not restart
once an error occurred. - Fixed an issue resulting in a KeyError if an IPFS pin timed out.
v0.2.0 Codename "Asimov, a new foundation."
TLDR;
- Support for FORGET messages
- A new dedicated service handles P2P connections
- Node private keys need to be migrated for the new service to work
- Many API improvements and fixes
Breaking changes
- This release requires a new way to manage private keys. The private key must now be provided in a new serialized format. Use the configuration updater to migrate to the new format.
- The "protocol" P2P config is disabled until further notice as it was not working properly.
- MongoDB becomes the only supported internal storage engine. RocksDB is not supported anymore.
Main features
FORGET message
This is a new type of message. It is designed to order the explicit deletion of a message by a user.
When a FORGET message is received by a node, it will immediately:
- remove the ‘content’ and ‘item_content’ sections of the targeted messages
- add a field ‘forgotten_by’ that references to the processed FORGET message
The FORGET message will only be accepted if either:
- the sender of the FORGET matches the ‘sender’ field of the message
- the targeted message was created by a VM and the sender of the FORGET matches the ‘sender’ of the VM
If the forgotten message is of type STORE, the number of references to the data will be counted.
If the new count amounts to zero, the file will be deleted from the database or unpinned and cleared from IPFS.
P2P daemon
P2P communication is now managed with the official libp2p daemon.
This allows us to get rid of a dependency to the unmaintained py-libp2p library.
This in turn enables many improvements. We:
- Moved to newer versions of many dependencies
- Resolved many bugs related to P2P communication
- Simplified the overall architecture of PyAleph.
API improvements
- Calling
/api/v0/messages.json
with unsupported fields returns a proper error message instead of the obscure 500 Internal Server Error - Improved reliability of the Websocket API
- New parameters to
/api/v0/messages.json
:contentKeys
,startDate
,endDate
.
Other changes
- The
--gen-key
option is renamed to--gen-keys
. It now stores the public key along with the private key, and a serialized version of the private key for use by the P2P daemon. - The private key for the P2P host can no longer be provided through the config.yml file using the
p2p.key
field. The key must be provided as a serialized file in thekeys
directory. - Decommissioned the dockerized VMs as they were replaced by the micro-VMs.
- Introduced a new tool called the configuration updater to manage changes in the configuration
files and key files between versions. - Fixed minor issues in the index page of the web service.
- Optimized the processing of messages by prioritizing new messages over messages that are waiting for a retry.
- Add support for a IPFS content identifier (CID) format version 1.
- Improve the reliability of the Websocket API
- A new API
/api/v0/storage/count/<storage-hash>
exposes the number of times a IPFS/storage hash is pinned - A new metric exposes the number of files pinned that belong to a chain and cannot be unpinned
- Operators can now distinguish the different processes of the node
- Fixed issues where errors could not be reported on Sentry
- Fixed an issue where the logging level was different in subprocesses
v0.2.0-rc1
[DB] Create indexes in debug mode Indexes should be created in all execution modes.
v0.2.0-rc0
[Doc] Simplify install guide (#178) [Doc] Simplify install guide Removed the native install guide from the docs as it is unused. Simplified the docs by merging the main install guide with the Docker Compose section. Split the upgrade part into a dedicated guide and added more information on how to mount key files.