Giter Club home page Giter Club logo

devkit-wallet's Introduction

Bitcoindevkit Android Demo Wallet

The Android Devkit Demo Bitcoin Wallet (we're calling it Devkit Wallet for short) is a simple testnet Bitcoin wallet built as a reference app for the bitcoindevkit on Android. It is purposely lean on Android-specific bells and whistles in order to keep the focus on bitcoin fundamentals and the bitcoindevkit API.

The repository is built to help newcomers to the bitcoindevkit by layering complexity slowly while not adding too much UI polish to the app.

The repository works in the following way: multiple branches are maintained in parallel, each of them focusing on a specific version of the app.

  1. the default branch is the simple-wallet branch. It builds a simple bitcoin wallet which implements the core functionality one would expect from a wallet: create addresses, send, receive, display transaction history, and BIP84-compatible wallet recovery.
  2. The advanced-features branch showcases the more advanced features of the library
  3. the ui branch builds the basic design and UI without any functionality
  4. the docs branch is mostly empty and is used for docs

Feature list

simple-wallet branch

  • Receive
  • Send
  • Sync wallet using Electrum
  • Retrieve transaction history
  • Wallet recovery using BIP39 recovery phrases

advanced-features branch

  • Send to multiple recipients
  • "Send All" functionality
  • Replace-by-Fee (BIP125)
  • Choose custom Electrum server
  • Partial signatures on PSBTs
  • Create OP_RETURN outputs

Design Choices

The Devkit Wallet makes rather opinionated choices regarding its design and architecture, all with the goal of being as helpful to potential bitcoindevkit developers exploring the library and looking for a working example. The end users of this application are developers, not real users. Here are some of these choices:

  1. Be lean on Android-specific bells and whistles.
  2. Return types are explicitly stated for all code that touches bitcoin, even when the IDE doesn't like it.
  3. Some bugs are left in and considered acceptable if squashing them requires a lot of polish/boilerplate code that does not add to the understanding of the Bitcoin Dev Kit.
  4. Errors are not always communicated back to the user on-screen (for example through polished snackbars) for similar reasons as (3); if something is not working, take a look a the logcat output.
  5. The wallet does not make use of string resources. This makes the codebase easier to search and simpler to parse on GitHub and platforms where the IDE doesn't show inline replacements of the string resources. In short, string resources, while a best practice, do not improve readability, the prime focus of this sample application.

Companion Documentation Website

You can find the companion tutorial website for this repository here. To learn more about the bitcoindevkit, check out the shiny new docs here.

devkit-wallet's People

Contributors

thunderbiscuit avatar darkvoid32 avatar shobitb avatar notmandatory avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.