Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 3.55 KB

README.md

File metadata and controls

108 lines (75 loc) · 3.55 KB

Neon Wallet

Electron wallet for the NEO blockchain.

Coverage Status

Overview

What does it currently do

  • Create a wallet
  • Encrypt a Private Key
  • Login with Ledger, Private Key, Encrypted Private Key or a stored account.
  • Import/Export wallet accounts (NEP6 Standard)
  • View balance
  • View prices for GAS and NEO in multiple currencies
  • Send GAS, NEO and any NEP5 token
  • Claim GAS
  • Send to multiple recipients
  • Address book
  • Switch networks (Test/Main)
  • nep9 QR support
  • Participate in NEO token sales
  • View wallet activity
  • Translation support for Arabic, Chinese, French, German, Italian, Korean, Portuguese, Russian, Turkish and Vietnamese.

Installation

The latest release binaries can be found here, to build manually see the steps below.

Required Tools and Dependencies

Developing and Running

Execute these commands in the project's root directory:

Setup:

Developing:

  • yarn dev - Start the application in development mode with hot reloading enabled
    • There is a known condition that may arise on Linux systems where yarn dev builds but Neon never opens. Try using yarn dev >/dev/null.

Running (for production):

  • yarn assets
  • yarn start

Testing:

  • yarn test or yarn run test-watch for live testing.

Support

A gentle reminder, github issues are meant to be used by developers for maintaining and improving the codebase, and is not the proper location for support issues. Questions such as

  • "Why can't I log in?"
  • "I lost my private key, is there anyway to recover it?"
  • "Why is my balance not showing?"

should be asked in proper support channels such as the NEO subreddit, or the official NEO Discord Channel. You should also check the list of frequently asked questions (FAQ) to see if your question has been answered there already.

Releasing

  • The CI process for deploys is triggered via tags, the script below will automatically bump the version in package.json and create a tag on whatever branch it is being run from. CI will automatically create a DRAFT release, that must manually be promoted to "the latest release". Currently, release notes must also be manually generated.
  • To bump the patch version:
yarn create-release:patch
  • To bump the minor version:
yarn create-release:minor
  • To bump the major version:
yarn create-release:major