search

Tribler / trustchain-superapp

Kotlin implementation of Trustchain and IPv8 with rich networking: multihoming of local Bluetooth+4G, decentral social networking, UDP hole punching, etc.
GNU General Public License v3.0
80 stars 63 forks source link

readme

TrustChain Super App

Build Status ktlint

This repository contains a collection of Android apps built on top of IPv8 (our P2P networking stack) and TrustChain (a scalable, distributed, pair-wise ledger). All applications are built into a single APK, following the concept of super apps – an emerging trend that provides an ecosystem for multiple services within a single all-in-one app experience.

Build Instructions

Clone

Clone the repository including the submodule with the following command:

git clone --recurse-submodules <URL>

If you have already cloned the repository and forgot to include the --recurse-submodules flag, you can initialize the submodule with the following command:

git submodule update --init --recursive

You can also update the submodule with this command.

Build

If you want to build an APK, run the following command:

./gradlew :app:assembleDebug

The resulting APK will be stored in app/build/outputs/apk/debug/app-debug.apk.

Install

You can also build and automatically install the app on all connected Android devices with a single command:

./gradlew :app:installDebug

Note: It is required to have an Android device connected with USB debugging enabled before running this command.

Check

Run the Gradle check task to verify that the project is correctly set up and that tests pass:

./gradlew check

Note: this task is also run on the CI, so ensure that it passes before making a PR.

Tests

Run unit tests:

./gradlew test

Run instrumented tests:

./gradlew connectedAndroidTest

Code style

Ktlint is used to enforce a consistent code style across the whole project. It is recommended to install the ktlint plugin for your IDE to get real-time feedback.

Check code style:

./gradlew ktlintCheck

Apply linter:

./gradlew ktlintFormat

Adding Your Own App

If you want to add your own app to the TrustChain Super App, you can follow the tutorial in the AppTutorial.md document.

Apps

On-Chain Democracy

We build a DAO for a better world. On-Chain Democracy is an Android application built on top of IPv8 and Trustchain and is integrated into the Trustchain Superapp. It is a proof-of-concept implementation of a DAO system using Trustchain and Bitcoin. Trustchain is used for communication and bookkeeping while the Bitcoin blockchain is used to have collective multi-signature wallets for each DAO. The content of the app is split up into several tabs:

Currently, the On-Chain Democracy app only allows Regtest, since it uses a future update of Bitcoin called Taproot. Once Taproot is officially released, the app can support TestNet or Production again. Taproot allows the DAO to scale to thousands or even millions of users. The beauty of Taproot is that it uses Schnorr signatures for each transaction. This enables transaction sizes that are equal independent of the number of users in a DAO since each user combines their signature collaboratively into one for the whole DAO. This also ensures privacy, since it is no longer possible to tell whether a transaction originates from a single person or from millions.



https://user-images.githubusercontent.com/23526224/116259903-85efd900-a776-11eb-93b1-384936d215c4.mp4

More about On-Chain Democracy

PeerChat

PeerChat implements a fully functional prototype of a distributed messaging app. First, the users have to exchange the public keys by scanning each other's QR code, or by copy-pasting the hexadecimal public keys. This guarantees the authenticity of all messages which are signed by their author. It prevents man-in-the-middle and impersonation attacks.

An online indicator and the last message are shown for each contact. Users can exchange text messages and get acknowledgments when a message is delivered.

Digital Euro

The Superapp is connected to the European IBAN Euro system. You can send and receive digital Euros using QR codes or built-in chat. Experimental. Sending Euros is as easy as sending an emoji. We did a test with a native implementation of Trustchain and a digital Euro last week. Field test date: 4 March 2021 at 10:30 am. The native Android implementation in Kotlin is slowly getting mature. Location: the bar Doerak (with a liquor license! This is a special place, therefore selected as the site for our trial. Shops that sell coffee or closed canisters of alcohol are "essential shops" and therefore open in Corona times.) Loading real money on your phone requires an operational an open source gateway of Euros to digital Euros. Discussed in this master thesis issue: https://github.com/Tribler/tribler/issues/4629

Double Spending mitigation

Double spending in EuroToken occurs when a malicious user sends a transaction to a wallet, and then sends the same transaction to another wallet whilst the second receiver is not aware of the first transaction. This has been mitigated by introducing a web-of-trust, read more about this in the EuroToken README.MD

Creative Commons CC0 license - share freely:

Zooming into the actual mechanism of QR-Codes (Creative Commons CC0 license - share freely) ![Demo](eurotoken/images/demo.gif) ### Debug **Debug** shows various information related to connectivity, including: - The list of bootstrap servers and their health. The server is considered to be alive if we receive a response from it within the last 120 seconds. - The number of connected peers in the loaded overlays. - The LAN address estimated from the network interface and the WAN address estimated from the packets received from peers outside of our LAN. - The public key and member ID (SHA-1 hash of the public key) - TrustChain statistics (the number of stored blocks and the length of our chain) ### Freedom-of-Computing App Freedom-of-Computing provides users with the ability to freely distribute and execute code in the form of APK applications on the Trustchain Superapp. To facilitate the sharing of applications, Freedom-of-Computing contains a gossiping mechanism that periodically shares local applications with other users and downloads unseen applications from other users. This sharing is conducted through a torrent peer-to-peer (P2P) network and uses the EVA Protocol as a fallback. Once the application has been downloaded by the users, they can dynamically load and execute it. The application, apart from being an APK file, needs to have a specific format for the execution to work, the requirements/constraints are listed inside [the documentation](freedomOfComputing/README.md). The left demo shows the upload procedure, while the right demo shows the download and code execution procedure. [More about Freedom-of-Computing App](freedomOfComputing/README.md) ### MusicDAO In short, the MusicDAO is an IPv8 app where users can share and discover tracks on the trustchain. Track streaming, downloading, and seeking interactions are done using JLibtorrent. A user can publish a Release (which is an album/EP/single/...), after which the app creates a magnet link referring to these audio tracks. Then, the app creates a proposal block for the Trustchain which contains some metadata (release date, title, ...) this metadata is submitted by the user with a dialog. When a signed block is discovered (currently self-signed), the app tries to obtain the file list using JLibtorrent. Each file can be streamed independently by clicking the _play_ button. **Videos** Video 1: Load example. This uses a default magnet link for an album that has a decent amount of peers. The user submits the metadata and the block gets proposed and signed. Then playback. Video 2: Share track. Note: as a fresh magnet link is generated in this video, there is only 1 peer. For this reason, it will be difficult to obtain the metadata of the magnet link (cold start issues) so the video stops there.