Application Status
Status: Approved on the 11.04.2023, submitted on the 10.04.2023
Last updated: 10.04.2023
Submited by Denis Davidyuk [email protected]
Team: Denis Davidyuk
Approved Budget:
Used Budget:
Planned Delivery:
Specify the funding category
Open Source Development
Application Title
JavaScript SDK development Q2-2023
Applicant
Denis Davidyuk – GitHub
Value Application
JS SDK is actively used by onboard and community developers. Some use cases raise features that need to be implemented on the SDK side, the same as bugs that need to be fixed. Dependent projects may contribute to SDK and these contributions need to be reviewed. This proposal is intended to solve these requests firstly, to keep the development of dependent projects efficient.
Additionally, there is a set of things that are known to be good to have, the most important of them are:
- Implement ability to sign typed structured data
Implement ability to sign typed structured data · Issue #1781 · aeternity/aepp-sdk-js · GitHub - Aepp-wallet connection improvements
Issues · aeternity/aepp-sdk-js · GitHub - HyperChains support
HyperChains support · Issue #1719 · aeternity/aepp-sdk-js · GitHub - Rearrange transaction interactions
Ability to calculate fee before transaction signing · Issue #1328 · aeternity/aepp-sdk-js · GitHub - Consistent coins representation
rethink & consolidate usage of BigInt / BigNumber throughout the SDK · Issue #1290 · aeternity/aepp-sdk-js · GitHub - Documentation updates
Issues · aeternity/aepp-sdk-js · GitHub - Middleware support
add MDW support · Issue #442 · aeternity/aepp-sdk-js · GitHub
Definition of Terms
JS SDK aka @aeternity/aepp-sdk
is an NPM package that implements basic functionality for web-based aepp to communicate with aeternity blockchain and to access user accounts provided by the wallet.
Status Quo
The 13th release of sdk that should fit the argent needs of developers is done. There is a clear roadmap for issues “consistent coins representation”, “middleware support”, “signing typed structured data”. Some research is still needed for the others.
Required Work
Once I have enough features implemented or bugs fixed, I would make an official release.
Estimate
I would be working 4 days in a week on this (based on my availability for the last 4 months).
Known Limitations
Although I aim at delivering all proposed features as outlined, there may be some higher priority tasks coming up that need to be worked on, thus not every proposed item is expected to be delivered.
Outlook
SDK should satisfy the demands of projects depending on it. In the same, it should be easy to use, well-documented, well-typed, and built according to the modern standards of JavaScript ecosystem.
Publishment
The work outcome will be published at GitHub - aeternity/aepp-sdk-js: JavaScript SDK for the æternity blockchain and related repositories under ISC license.
Maintainance
Maintenance is part of the proposal and included for the proposed timeframe.