psychiccat / mymonero-app-js

The MyMonero Desktop and Cordova Javascript Apps

MyMonero JS - Desktop (Electron) & Android (Cordova) Apps

General Info

1. What's in This Repo?
2. What is MyMonero?
3. Features
4. Downloads
5. Requirements & Install Locations
6. Reporting Bugs & Making Feature Requests
7. 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. License and Copyrights

What's in This Repo?

This repository holds the source code, resources, and build scripts for the official MyMonero downloadable desktop and Cordova-based mobile apps, which are built in Javascript.

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.

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 mobile apps are built on Apache Cordova and can be packaged for Android.

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 supports for mobile builds, and it can be selected for use with [sudo] npm install -g [email protected].

User Data Locations

• Mac / Windows / Linux: via Electron's app.getPath('userData')

• Android: via cordova.file.dataDirectory

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

• Why We Built the Native Apps

• Technology Notes

• Unofficial Technology Roadmap

• Packaging the App for Production Mode

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. Install all dependencies 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

Contributing

Contributions by way of pull request are very welcome, and you will be credited in the release notes if your PR is merged.

If you would like to contribute, please scan the technology notes in order to find information on libraries used, the reasons behind various architectural choices, and how to write tests.

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.

Getting Help with Testing or Contributing

Feel free to create a Github issue if you want to report bugs, discuss improvements, submit feature ideas, or ask development & QA-specific questions.

MyMonero testers and contributors have also been rumored to hang out on IRC in #mymonero on freenode.

Code Style Guidelines

There is no specific code styleguide yet (with the exception of the preference of tab-indentation) but we ask that code contributions generally:

• are kept modular or well factored, either platform-agnostic or with platform specified (see Technology Notes),
• are written in a clear, understandable, simple, and maintainable manner,
• employ best practices, and
• are well tested and don't break anything, especially security.

Conditions on Merging PRs

• Pull Requests which ask us to merge integration 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.

MyMonero Core Contributors

Contributors to each release are credited in release notes.

The MyMonero "core contributors" listed below either work on MyMonero full-time, or have made essential contributions, and have long-term involvement.

• 🏂 Paul Shapiro endogenic – Project maintainer; Lead client app developer; Partner

• 🦄 Riccardo Spagni fluffyponyza – Advisor; Partner; Monero project core member

• 😎 Lee Clagett vtnerd – Lead back-end developer

• 🔥 Matt D Smith mds – v1/MVP app and website designer

• 🍄 luigi1111 luigi1112 – Monero tech advisor; Built client-side RingCT support

• 🌠 Your name here?

License and Copyrights

See LICENSE.txt for license.

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