Android Update - Addresses generation / Authenticator with usernames

[Filmaluco]

Background

The Android platform has a huge growth potential for Stacks. Currently Android Developers can use the Blockstack Android SDK to develop apps within the Stacks ecosystem. But the SDK is outdated, with no major changes since Stacks 2.0 was launched.

Project Overview

The main goals are to update the Android SDK and release the Circles app.

There's currently no method to generate a Stacks Address (Mainnet or Testnet) and the lookup system still uses the legacy core API "https://core.blockstack.org/". These are breaking changes that have not yet been addressed within the SDK.

This changes would make the release of Circles possible again allowing Android Users to have an authentication system that is compatible with both Android Apps and Web Apps, and supports, again, username registration.

(Circles was a Grants project that is fully open source, you can find the repository at https://github.com/blocoio/stacks-circles-app)

Scope

While Stacks 2.0 brought a lot of new changes and updates we want to target 3 main things:

1. Migrate to the new API
   We want to update the current lookup system, including migrating from core.blockstack.org to stacks-node-api.stacks.co.

2. STX Address Generation
   With the help of @friedger, we already have a proof of concept for the STX Address generation in Kotlin. We want to implement a final version, for both Mainnet and Testnet, into the SDK, with a set of tests.

3. Ability to register stacks subdomains (usernames)

   Give back to Android users the ability to register usernames, so apps like Envelop can again receive new users. Users will be able to register usernames from within the Android Authenticator app Circles.

Since the app Circles will make use of the updated SDK and is open source, we can measure our success if the app itself can:

• Login with old accounts
• Login with new accounts
• Sign-up with
• Sign-up with the ability to associate usernames within the new Registrar system

Budget and Milestones

Total Grant Request: $2000

Total effort: 1.5 weeks / person

1. Release new update of the Android SDK (1 week)
   • Migrate to the new API
   • Ability to generate both Mainnet and Testnet STX addresses
2. Public release of the Circles app (0.5 weeks)
   • Implement ability to register Stacks usernames

Team

The Bloco team, builders of Envelop and Circles:

• @sdsantos (Android developer)
• @Filmaluco (Android developer)

Risks

With the proof of concept for STX Address generation for Mainnet, there's no high risks. But there's always the chance that, due to some internal Stacks team work, the technical specifications of what we need to do also change.

Community and Supporting Materials

We've built a popular Blockstack app, Envelop, that's fully open-source. And we made contributions to the blockstack-android SDK. We've also hosted a Blockstack Meetup Portugal.

We are also responsible for building and maintaining the Blockstack Auth Android application Circles.

[stx-grant-bot]

Thanks for submitting a grant proposal. Our team will review your submission and get back to you.

[friedger]

Looking forward to it so that OI Calendar can get updated!

[RaffiSapire]

Hi @Filmaluco we are pleased to approve this grant. A couple of asks:

1. Could you scope out the name registration more?
2. We suggest start small, look up names, registration could be a feature added in the future. How are you thinking about this?
   Thank you!

[Filmaluco]

@RaffiSapire

1. Registration was develop on the Android Authenticator app, as part of another (original) grant.

   When it was developed and launched it was made using the old APIs and before Stacks2.0 new BNS system.

   • we lookup the intended username, using the SDK
   • we validate the username, using the SDK
   • we create and upload the users wallet (with Bitcoin address)
   • we create and upload the users profile (with BTC address)
   • we would register with account profile and its BTC address

   But soon after it became incompatible with the changes to stack addresses.

   We want update the steps using BTC with STX addresses, that (along the API update within the SDK) will allow the registration of usernames again with the app.

---

2. We intend to update the look up names within the SDK, registration will also be updated but on the Android Authenticator. Registration as an "added" feature would be in the SDK, but yes it could/would be as a future addition.

[stx-grant-bot]

Congratulations. Your grant is now approved. Please complete the on-boarding link here: https://stacks-grant.netlify.app/onboard?q=4f0be1135ea6f4cecac370a285dbd754

[RaffiSapire]

Thank you! I've updated the grant to approved, please fill this form out?

@ Alex Grabe, one of the grant committee members, had a couple questions, if you want input from him. Even in the scope, I don't see that they are spinning up their own registrar. In the past, the Blockstack Auth would allow name registrations for free as part of the onboarding flow - this is not the case anymore. There’s work need to register names for a new namespace.

This isn't gating, but if you want to chat with him about it join the discord grant channel and chime on in!

Congrats and thank you.

[RaffiSapire]

Hi @Filmaluco - wanted to check to see if you were able to fill out the form?

[Filmaluco]

@RaffiSapire Yes we filled the form and already talked with Alex Grabe, we are now waiting for the contract/ Docusign agreement.

[Filmaluco]

@RaffiSapire we are still waiting for the contract/ Docusign agreement.

Release new update of the Android SDK (1 week)

Migrate to the new API
Ability to generate both Mainnet and Testnet STX addresses

"Phase" 1:
Migrate to the new API PR
Ability to generate both Mainnet and Testnet STX addresses

We understand that a few changes might still be needed, but we are now working on Phase 2

Public release of the Circles app (0.5 weeks)

Implement ability to register Stacks usernames

We have already implemented the the ability to register Stacks usernames as well but we found an issue on the generation of the AuthResponses... We think that something changed and we are now trying to find out what, and why.

[Filmaluco]

@RaffiSapire we are still waiting for the contract/ Docusign agreement, is everything alright?

[RaffiSapire]

@Filmaluco the docusign was sent but never signed, we just resent it. If you have issues please find me on discord to get a response more quickly! @RSAP

[markmhendrickson]

@friedger @yknl I'm assigning you two as reviewers of the above PRs in the hope you can help get them to approval, then I'll help merge them in 🙏