Skip to content

Latest commit

 

History

History
173 lines (140 loc) · 7.36 KB

README.md

File metadata and controls

173 lines (140 loc) · 7.36 KB
Raw

Amethyst: Nostr client for Android

Amethyst brings the best social network to your Android phone. Just insert your Nostr private key and start posting.

Current Features

  • Event Builders / WebSocket Subscriptions (NIP-01, NIP-15)
  • Home Feed
  • Notifications Feed
  • Global Feed
  • Reactions (likes NIP-25, boost, reply)
  • Image/Video/Url/LnInvoice Previews
  • View Threads
  • Private Messages (NIP-04)
  • User Profiles (edit/follow/unfollow - NIP-02)
  • Public Chats (NIP-28)
  • Bech Encoding support (NIP-19)
  • Notification Dots
  • Reporting and Hide User capability (NIP-56)
  • Automatic Translations
  • Relay Sets (home, dms, public chats, global)
  • User/Note Tagging (NIP-08, NIP-10)
  • Lightning Tips
  • Zaps (NIP-57)
  • URI Support (NIP-21)
  • Event Deletion (NIP-09: like, boost, text notes and reports)
  • Identity Verification (NIP-05)
  • Long-form Content (NIP-23)
  • Parameterized Replaceable Events (NIP-33)
  • Online Relay Search (NIP-50)
  • Internationalization
  • Badges (NIP-58)
  • Hashtags
  • Local Database
  • View Individual Reactions (Like, Boost, Zaps, Reports) per Post
  • Bookmarks, Pinned Posts, Muted Events (NIP-51)
  • Sensitive Content (NIP-36)
  • Relay Pages (NIP-11)
  • Relay Authentication (NIP-42)
  • Generic Tags (NIP-12)
  • Proof of Work in the Phone (NIP-13, NIP-20)
  • Events with a Subject (NIP-14)
  • Workspaces
  • Expiration Support (NIP-40)
  • Infinity Scroll
  • Relay List Metadata (NIP-65)
  • Signing Requests (NIP-46)
  • Delegated Event Signing (NIP-26)
  • Account Creation / Backup Guidance (NIP-06)
  • Message Sent feedback (NIP-20)

Development Overview

Overall Architecture

This is a native Android app made with Kotlin and Jetpack Compose. The app uses a modified version of the nostrpostrlib to talk to Nostr relays. The overall architecture consists in the UI, which uses the usual State/ViewModel/Composition, the service layer that connects with Nostr relays, and the model/repository layer, which keeps all Nostr objects in memory, in a full OO graph.

The repository layer stores Nostr Events as Notes and Users separately. Those classes use LiveData objects to allow the UI and other parts of the app to subscribe to each individual Note/User and receive updates when they happen. They are also responsible for updating viewModels when needed. Filters react to changes in the screen. As the user sees different Events, the Datasource classes are used to receive more information about those particular Events.

Most of the UI is reactive to changes in the repository classes. The service layer assembles Nostr filters for each need of the app, receives the data from the Relay, and sends it to the repository. Connection with relays is never closed during the use of the app. The UI receives a notification that objects were updated. Instances of User and Notes are mutable directly. There will never be two Notes with the same ID or two User instances with the same pubkey.

Lastly, the user's account information (priv key/pub key) is stored in the Android KeyStore for security.

Setup

Make sure to have the following pre-requisites installed:

  1. Java 11
  2. Android Studio
  3. Android 8.0+ Phone or Emulation setup

Fork and clone this repository and import into Android Studio

git clone https://github.com/vitorpamplona/amethyst.git

Use one of the Android Studio builds to install and run the app in your device or a simulator.

Building

Build the app:

./gradlew assembleDebug

Testing

./gradlew test
./gradlew connectedAndroidTest

Linting

./gradlew ktlintCheck
./gradlew ktlintFormat

Installing on device

./gradlew installDebug

How to Deploy

  1. Generate a new signing key
keytool -genkey -v -keystore <my-release-key.keystore> -alias <alias_name> -keyalg RSA -keysize 2048 -validity 10000
openssl base64 < <my-release-key.keystore> | tr -d '\n' | tee some_signing_key.jks.base64.txt
  1. Create 4 Secret Key variables on your GitHub repository and fill in with the signing key information
    • KEY_ALIAS <- <alias_name>
    • KEY_PASSWORD <- <your password>
    • KEY_STORE_PASSWORD <- <your key store password>
    • SIGNING_KEY <- the data from <my-release-key.keystore>
  2. Change the versionCode and versionName on app/build.gradle
  3. Commit and push.
  4. Tag the commit with v{x.x.x}
  5. Let the Create Release GitHub Action build a new aab file.
  6. Add your CHANGE LOG to the description of the new release
  7. Download the aab file and upload it to the` PlayStore.

Privacy on Relays & nostr

Your internet protocol (IP) address is exposed to the relays you connect to. If you want to improve your privacy, consider utilizing a service that masks your IP address (e.g. a VPN) from trackers online.

The relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.

Relays have all your data in raw text. They know your IP, your name, your location (guessed from IP), your pub key, all your contacts, and other relays, and can read every action you do (post, like, boost, quote, report, etc) with the exception of Private Zaps and Private DMs.

DM Privacy

While the content of direct messages (DMs) is only visible to you, and your DM nostr counterparty, everyone can see that and when you and your counterparty are DM-ing each other.

Visibility & Permanence of Your Content on nostr

Information Visibility

Content that you share can be shared to other relays. Information that you share is publicly visible to anyone reading from relays that have your information. Your information may also be visible to nostr users who do not share relays with you.

Information Permanence

Information shared on nostr should be assumed permanent for privacy purposes. There is no way to guarantee deleting or editing any content once posted.

Contributing

Issues and pull requests are very welcome.

MIT License

Copyright (c) 2023 Vitor Pamplona

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.