Skip to content

Latest commit

 

History

History
264 lines (128 loc) · 11.2 KB

README.md

File metadata and controls

264 lines (128 loc) · 11.2 KB
Raw

MyMonero App for Desktop, Android, and Browser (Javascript)

Logo

Info

  1. License and Copyrights
  2. What's in This Repo?
  3. What is MyMonero?
  4. Features
  5. Downloads
  6. Requirements & Install Locations
  7. Reporting Bugs & Making Feature Requests
  8. Related Documents

Contributing and Testing

  1. Getting the Source Code
  2. Repository Contents
  3. Building for Production
  4. Running in Development Mode
  5. Contributing
  6. Main Contributors

License and Copyrights

See LICENSE.txt for license.

All app source code and assets copyright © 2014-2017 by MyMonero. All rights reserved.

What's in This Repo?

This repository holds the Javascript source for the MyMonero desktop and Android (Cordova) apps, plus the new MyMonero web wallet.

What is MyMonero?

MyMonero is a simple and featureful way to use the next-generation private digital currency called Monero. The MyMonero app lets you manage your Monero wallets, address book, and transactions by storing your information locally and keeping it encrypted.

MyMonero is currently available for:

  • desktop on Mac, Windows, and Linux; and
  • mobile on Android.

The main reasons people use MyMonero are its convenience and featurefulness. To accomplish this convenience and other features of MyMonero, there's the privacy trade-off of sharing your private Monero "view key" with the MyMonero server, so that it can scan the network for your wallets' transactions on your behalf. But it's impossible for MyMonero to spend any of your funds or otherwise access your metadata, because your "private spend key" and "private wallet mnemonic/seed" are never sent to our server. So MyMonero is often described as a 'non-custodial' service. In fact, in the near future, even the above trade-off will be eliminated as we're presently working to open-source a version of the back-end, which anybody can run as their own server at home.

Desktop Screenshot: Welcome to MyMonero! Let's get started.

Features

  • Multiple wallets at a time

  • Contacts address book

  • Deep OpenAlias integration (use domain or email instead of long Monero address)

  • Creation of QR codes and messages to request Monero be sent to you

  • Sending money to contacts, OpenAlias, or other Monero addresses (these may be input manually, or automatically by either dropping a request QR code on the Send screen or clicking a monero:… request URL on MacOS or Windows)

  • Settings (for clearing data, managing preferences such as idle timeout, etc.)

  • Strong (AES256) encryption to password protect all sensitive user data

  • Improved UX, including informative tooltips

Downloads

Download the latest version from our website at mymonero.com/app or from the Releases tab. (Coming soon)

Developers and pre-release testers who would like to use and work on the app can run it by obtaining the source and running one of the build commands below.

To get set up with the source code, please see Getting the Source Code below.

Requirements & Install Locations

The desktop app is built on Electron and can be packaged to run on modern versions of:

  • MacOS (.app)
  • Windows (installer .exe)
  • Linux (.appimage)

The present implementation of the Android app is built on Apache Cordova. Native Android app in-progress.

Note about Cordova version Apache has recently released Cordova 7.0.0. It was tested, but because it now places plugins into package.json, npm cannot update, as a handful of those plugins do not have package.json files, and npm and yarn (based on current info) cannot install them as deps. So 6.5.0 is the Cordova version that MyMonero currently targets for mobile builds, and it can be selected for use with [sudo] npm install -g cordova@6.5.0.

User Data Locations

Reporting Bugs & Making Feature Requests

If you would like to report an issue or share a feature request, please create a Github Issue on this project.

If you're reporting a bug, be sure to include all information which we would need to reproduce the issue, such as the operating system and app version on which you saw the bug, and the steps you took, if you can tell.

For customer support, you can also contact us directly.

Related Documents

Contributing & Testing

Getting the Source Code

Download & Install

  1. First, ensure that you have recent versions of node and npm installed.

  2. Clone or otherwise download this repository. Then, in your terminal, cd into the repo directory.

  3. (To get the bleeding edge, and/or if you are going to make changes) Switch to the develop branch by executing git checkout develop.

  4. NEW Be sure to set up and download all required Git submodules with bin/update_submodules.

    • Note: At present, run this command after pulling this repo as necessary to keep all sub-modules up-to-date.

  5. Install all required node_modules by executing npm install.

On Debian/Ubuntu/Linux

  • It has been reported that Debian/Ubuntu now calls the node binary nodejs. One workaround is to create a symlink from /usr/bin/nodejs to /usr/bin/node.

  • libgconf is now a requirement for running Electron under Linux, and can be installed with apt install libgconf-2-4 (electron/electron#1518)

Cordova

If you are going to run the Cordova app under Android

  1. Install all Cordova development dependencies for Android. See Cordova Installation Notes for details.

  2. Run bin/init_repo_for_cordova.

Repository Contents

  • Executable scripts for common tasks are located in bin/

  • Local, application source code is located in local_modules/. This includes bundled/static third-party "Vendor" libraries such as EmojiOne.

  • After installation, non-bundled third-party modules (such as Electron) will be located in node_modules/.

  • App package and build process info is located in package.json.

  • Cordova build configuration and dependencies are located in config.xml, cordova_res/, et al. Cordova build intermediate assets and stages are also located in plugins/, platforms/, and www/.

  • This readme is located at README.md, and the license is located at LICENSE.txt.

Building for Production

Unless you are a MyMonero pre-release tester, you will not need to produce a production build of MyMonero, especially because you want to be using a verified build of MyMonero for daily usage.

If you're testing a pre-release version of this app, you may want to build a production-ready version of the app rather than only running it in dev mode to verify its behavior in production mode.

See Packaging the App for Production Mode for information.

Running in Development Mode

Desktop

Does not require you to package, sign, and install the app, and will cause the Developer window to be shown. Certain features, such as URL opening under MacOS, require production build.

bin/start_dev_desktop

Cordova

Android - Emulator

Debugging is possible through Chrome; navigate to "chrome://inspect"

bin/start_dev_cordova_android_emu

Android - Device

Ensure that the USB Debugging is enabled and that the session is accepted on your Android device if you get device.js error. Also try removing the USB cable and replacing it. Navigate to "chrome://inspect" to monitor debug status. Also may help to run adb logcat while installing.

bin/start_dev_cordova_android_device

Browser (Web wallet)

bin/start_dev_browser

Note: If your system does not have the open command as is found on MacOS, then this command will fail at the last step to open browser_build/index.html. So after running the start_dev command, simply open index.html in your browser of choice.

Contributing

Testing

Please submit any bugs as Issues unless they have already been reported.

Suggestions and feedback are very welcome!

Developing

If you have an improvement to the MyMonero downloadable JS app and would like to have your code considered for usage in the production MyMonero app, we'll be happy to review pull requests. Contributors of merged PRs will be credited in the app's release notes.

Before contributing, please spend a few moments scanning the technology notes to learn about libraries used, reasons behind some architectural choices, and more.

  • Merging PRs which involve integrating with any third-party services will require discussion and agreement.

  • We reserve the right to refuse to merge any PRs, such as those which introduce breaking changes.

The maintainer enjoys collaborating with volunteer contributors to the MyMonero apps over IRC private message and the #mymonero room on freenode.net (Come say hello!), so PR'd submissions do not have to be at all complete or perfect on their first submission. (To submit a draft PR for review, simply mark it as '[DO NOT MERGE]')

For background on this project, see Why We Built the Native Apps.

You may also like to read the unofficial Technology Roadmap to get a peek at what we're thinking about for the future.

There's also an icebox of ideas, features, improvements, known issues, and other todos waiting to be knocked out which are kept in the Issues tracker.

Donating

MyMonero Donation Address (XMR): 48yi8KBxh7fdZzwnX2kFCGALRcN1sNjwBHDfd5i9WLAWKs7G9rVbXNnbJTqZhhZCiudVtaMJKrXxmBeBR9kggBXr8X7PxPT

Proceeds from donations are used to fund development on the MyMonero back-end server (a performant version of which we soon™ plan to open-source for anyone to run their own server at home). Any remaining funds will go towards product (app UI) R&D, and hosting costs.

Main Contributors

Contributors to each release are credited in release notes.

Core

  • 🏂 endogenic (Paul Shapiro) Repo maintainer; Lead app developer; MyMonero partner

  • 🦄 fluffyponyza (Riccardo Spagni) Advisor; MyMonero partner; Monero core team member

  • 😎 vtnerd (Lee Clagett) Lead back-end developer

  • 🍄 luigi Monero tech advisor; Main MyMonero JS core crypto contributor

  • 🔥 mds (Matt Smith) MVP designer

  • 🌠 Your name here?