Skip to content

The Stacks Android Auth App for identity (Stacks-Grants#22)

License

Notifications You must be signed in to change notification settings

blocoio/stacks-circles-app

Repository files navigation

Circles

Lint Badge Testing Badge License: MIT Latest release Changelog

Stacks Circles Android App

The Stacks Circles App provides a native Android experience to the Stacks ecosystem. You can:

  • Learn more about the Stacks Ecosystem
  • Create a Stacks account
  • Manage your account identities
  • Safely sign in into web and Android apps using your Stacks account

This app is open source. The project was made possible by the Stacks Grants program and is currently maintained by Bloco.

New to the Stacks ecosystem?

Stacks offers the ability decentralized apps, creation of smart contracts, end-to-end encryption and many other features. This and other information can be seen at https://www.stacks.co/.

Where to start?

Take a look at apps like BlockSurvey, that make use of Stacks to provide privacy-first apps with no ads, no trackers. Protect your respondents' data and privacy with BlockSurvey. You can check this and other apps at https://www.app.co/.

Design

The design follows both the Stacks and Material UI/UX guidelines and it is also open source, for future improvements and feedback. You can see the design project in figma.

Screenshots

Normal Flow pic2 Normal Flow pic3 Normal Flow pic4
New Account pic1 New Account pic2
Login pic1 Login pic2 Login pic2
Normal Flow pic5

Demo Video

Login Video Demo New Account Video Demo

Usage

For authenticating other apps, this app intercepts the app.blockstack.org URL. This way, it is compatible with Android apps using the Blockstack SDK and web applications using stacks.js.

If an account is already configured, the user simply needs to pick an Identity (or create a new one) to complete the Authentication with other apps. If no account is configured the user can also complete the Login/Signup experience within the app to complete the Authentication.

For developers: Apps/Websites using Stacks Connect or the Android Blockstack SDK v0.6.4 or higher, should be able to make use of Circles app to authenticate without any problems. If you encounter any problems make sure the following pre-requisites are met:

  • support BNS v2
  • redirect uri equal to access uri
  • redirect uri ability to read ?authResponse=

If you still find problems and wish to see them resolved please open the issue on our Github. For developers is also worth noting that Circles is compatible with the flag registerSubdomain (by default the flag is false).

Roadmap

The current Milestones and projects can be found in this repo.

Future Goals:

  • Support legacy recovery keys
  • Dark Theme Support

Notes

This project was built using Bloco.io Android Template and follows it's clean architecture pattern. We recommend you take a look at it and its article if you want to contribute.