/
Project Plan - Hyperledger Web3j: Enhancing Android Support with Updated web3j-android Integration

Project Plan - Hyperledger Web3j: Enhancing Android Support with Updated web3j-android Integration

Jul 01, 2024

Abstract

The Hyperledger Web3j-android library enables Android applications to interact with the Ethereum blockchain using Hyperledger web3j. This project aims to update and restructure the library (version 4.8.8) to comply with modern Android development standards and current Ethereum technologies, enhancing coherence and functionality. Recommended skills include proficiency in Android development (SDK, Studio, lifecycle), Java and Kotlin, Ethereum and smart contracts, web3j library, blockchain principles, problem-solving, version control with Git, and strong communication and collaboration abilities.

Project Repository - https://github.com/hyperledger/web3j

Mentee(s) Names and Contact Info

Name: Shashank Kumar

Email: shashank.kumar.phe22@itbhu.ac.in

LFXID: @Shashank Kumar 4-Yr B.Tech.: Pharmaceutical Engg. & Tech., IIT(BHU) 

 

Volunteer Mentee

Name: Harshit Malhotra 

Email: harshitmalhotra99@gmail.com

LFXID: @harshitmalhotraa

Deliverables

Conduct comprehensive review and draft a detailed project plan for web3j-android improvements.
Update minSDKVersion and targetSDKVersion, ensuring broad Android compatibility.
Review and update dependencies, resolving deprecated APIs, and optimizing the build process.
Propose and implement a streamlined versioning strategy aligned with web3j core releases.
Develop and execute a comprehensive testing suite, finalizing the library for official release.

 

Milestones

Eval 1:

Setup new Android branch and complete Initial documentation

Eval 2:

Update Dependencies, Resolve Deprecated APIs, and Refractor codebase to improve compatibility on Android.

Eval 3:

Implement a Versioning Strategy, and develop a comprehensive testing suite.

Eval 4:

All Deliverables

Timeline

Week

Task/Plan

Status

Week

Task/Plan

Status

June 03 - June 23

On boarding/orientation sessions. Meet with the mentors, discuss project implementation details,
deliverables and scope. Prepare the project plan.

 

June 24 - July 7

Conduct comprehensive review of current web3j-android architecture, dependencies, and Android development guidelines. Identify key areas for improvement and potential challenges. Draft a detailed project plan outlining milestones and deliverables.

 

July 8 - July 22

Engage with the community and stakeholders to gather feedback and suggestions. Set up the new Android branch and initial documentation.

 

July 22 - July 26

1ST QUARTER MENTEE EVALUATION

 

July 27 - August 18

Update minSDKVersion and targetSDKVersion, ensuring broad Android compatibility. Refactor the existing codebase to improve compatibility on Android.

 

August 19 - September 01

Review and update dependencies, resolving deprecated APIs and optimizing the build process.

 

September 02 - September 06

MIDTERM EVALUATIONS

 

September 08 - September 22

Propose and implement a streamlined versioning strategy aligned with web3j core releases.

 

September 23 - October 19

Develop and execute a comprehensive testing suite, finalizing the library for official release.

 

October 14 - October 18

3RD QUARTER MENTEE EVALUATION

 

October 19 - November 10

Write detailed documentation for the library, including usage examples, setup guides, and contribution guidelines. Announce the release to the community through blog posts, social media, and developer forums.

 

November 11 - November 29

FINAL MENTEE EVALUATION