Code Monkey home page Code Monkey logo

faucet-tool's Introduction

Handshake Faucet Tool

This tool generates the first receiving address, in the first account of a BIP44 HD wallet. It also generates the 24 word BIP39 mnemonic phrase which was used to seed the wallet. It is important that you keep this seed phrase private. It is the only way to access your HNS coins. Do not share your mnemonic seed phrase with anyone that should not have access to the contents of the wallet.

NOTE: we recommend running this software on an air gapped computer. Running this software on compromised hardware will leave you in danger of losing funds.

Requirements

  • Linux, OSX or Windows
  • git
  • node.js >=v8.0.0
  • npm >=v4.0.0

CLI tool

Run:

$ git clone https://github.com/handshake-org/faucet-tool.git
$ cd faucet-tool
$ npm install
$ ./bin/faucet-tool createaddress

Usage:

$ faucet-tool createaddress
$ faucet-tool createmultisig <num required> <pubkey1> <pubkey2> ... <pubkeyN>
$ faucet-tool version

Options:
  -n <network> (default "main")
  -l <seed language> (default "english")
  -b <bits of entropy> (default 256)

Flags:
  --backup (creates a backup file of wallet details)
  --show-keys (show address key pair)
  --project-sponsor (generates encryped address for project sponsors)

Notes

This tool uses faucet-tool.js for generating mnemonic seed phrases.

Forked from https://github.com/handshake-org/hskd

HD keys and mnemonics (BIP32, BIP39).

Parts of this software were originally based on bitcore-lib:

BIP32

Copyright (c) 2015-2016, Christopher Jeffrey (MIT License).
https://github.com/bcoin-org/bcoin

Copyright (c) 2013-2015 BitPay, Inc.

Parts of this software are based on Bitcoin Core
Copyright (c) 2009-2015 The Bitcoin Core developers

Parts of this software are based on fullnode
Copyright (c) 2014 Ryan X. Charles
Copyright (c) 2014 reddit, Inc.

Parts of this software are based on BitcoinJS
Copyright (c) 2011 Stefan Thomas <[email protected]>

Parts of this software are based on BitcoinJ
Copyright (c) 2011 Google Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

BIP39

The MIT License (MIT)

Copyright (c) 2014 BitPay

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

faucet-tool's People

Contributors

boymanjor avatar dependabot[bot] avatar hschoenburg avatar pinheadmz avatar schumaml avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

faucet-tool's Issues

not installing

first two error code messages:
npm ERR! code 1
npm ERR! git dep preparation failed
......

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.