v1.0.0: SDK Modular Refactor
This release is the first stable and fully Node.js/browser compatible Typescript SDK release for aleph.im using the new refactored package structure. This marks the beginning of a more streamlined and simplified interface, inspired by the Python SDK's structure.
Package Refactoring
To reduce dependency bloat, the previously monolithic aleph-ts-sdk
package has been refactored into multiple smaller packages, divided by functionalities:
@aleph-sdk/core
: Commonly shared utilities and constants@aleph-sdk/account
: Basic interfaces for all types of signing accounts@aleph-sdk/message
: Aleph Message specification and API call methods (to be moved toclient
)@aleph-sdk/client
: Main entrypoint & interface for developers looking to fetch & post messages
Every chain now also has its own implementation in its own package:
@aleph-sdk/evm
: Common interfaces of EVM-based accounts@aleph-sdk/ethereum
@aleph-sdk/avalanche
@aleph-sdk/solana
- etc.
Most of them have peer dependencies defined, so make sure you install them along with the SDK!
Added Domain features
@aleph-sdk/dns
is now available on the Typescript SDK as well and can be used to setup your domains for your aleph.im resources, such as stored files and deployed programs or VPS instances!
Removed Encryption Methods
Encryption/Decryption methods have been removed due to security concerns, at least for now. Please find an encryption scheme suitable to your project according to your needs. We found that proposing exactly one way to encrypt data to users is opinionated and could lead to insecure usage of those encryption methods.
Added Parameters and Message Fields
Previously missing parameters for querying and creating messages have been added, as well as the message specification updated to the current standard.
Known Issues
- Avalanche signatures for X-Chain addresses is currently not working: #162
Please report any issues encountered in the issues section. Thank you!
What's Changed
- Move Superfluid constants to Superfluid package by @MHHukiewitz in #164
- Limit rootfs size to not trigger message rejection by @MHHukiewitz in #163
- Update and add README.md where needed for v1.0.0 release by @MHHukiewitz in #166
- Add DNS functionality by @MHHukiewitz in #165
Full Changelog: v1.0.0-rc2...v1.0.0