[Completed] JavaScript SDK development Q1-2024

aeternity Foundation Grant Applications
1

Application Status

Status: Completed on 1.04.2024, Submitted on 4.02.2024
Last updated: 18.04.2024
Submitted by Denis Davidyuk [email protected]
Team: Denis Davidyuk
Approved Budget (in h): 300
Used Budget (in h):
Planned Delivery: 1.04.2024
Previous Application: [Completed] JavaScript SDK development Q4-2023
Following Application: [Active] JavaScript SDK development Q2-2024

Specify the funding category

Open Source Development

Application Title

JavaScript SDK and related projects development Q1-2024

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:

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

A significant part of Ceres compatibility was implemented in the previous grant.

Required Work

After Ceres protocol is finalized need to release one more non-breaking version of SDK supporting that. After that, I would release a version with dropped Iris support and other breaking changes.

Estimate

I would be working 80 hours per month on this (based on my availability for the last 3 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 the 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 in the proposed timeframe.

2 Likes
2

Week 1 (Jan 1 - Jan 7)

Time spent: 10.67

Week 2 (Jan 8 - Jan 14)

Time spent: 25.64

Week 3 (Jan 15 - Jan 21)

Time spent: 29.10

Week 4 (Jan 22 - Jan 28)

Time spent: 26.41

1 Like
3

Thanks for the update. I hope you wont be conscripted.

2 Likes
4

Week 5 (Jan 29 - Feb 4)

Time spent: 8.97

Week 6 (Feb 5 - Feb 11)

Time spent: 28.18

Week 7 (Feb 12 - Feb 18)

Time spent: 27.65

Week 8 (Feb 19 - Feb 25)

Time spent: 21.10

2 Likes
5

Week 9 (Feb 26 - Mar 3)

Time spent: 37.86

Week 10 (Mar 4 - Mar 10)

Time spent: 34.05

Week 11 (Mar 11 - Mar 17)

Time spent: 49.37

Week 12 (Mar 18 - Mar 24)

Time spent: 17.40

Week 13 (Mar 25 - Mar 31)

Time spent: 30.25

2 Likes
6

Final report

Overall spent 346.63 hours out of 300 hours available. Here is a list of issues closed in this grant, the same for merged pull requests. The most noticeable changes are:

In this grant, I’ve almost finished @aeternity/[email protected] release.

2 Likes