Skip to content

Add README for examples directory #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bpdavenport merged 1 commit into from
Aug 1, 2014
Merged

Add README for examples directory #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
BitGoJS Examples
=======

# Wallet Recovery Tool

The wallet recovery tool allows you to completely recover a BitGo BIP32 multi-sig wallet
using only the user's 2 keys, without making any communication with BitGo. In the event
BitGo ceases to operate, or becomes temporarily unavailable, the tool makes it possible
to exert full control over the bitcoin in your wallet.

To use the tool, you will need the KeyCard from your BitGo wallet, along with your
wallet passcode. If you provided
your own backup public key at wallet creation time, you will also need the private half
of the backup key. It may be necessary to scan the QR codes from the KeyCard
with a mobile phone and email the resulting text to yourself.

Run the tool using 'node recoverwallet.js'

10 changes: 5 additions & 5 deletions example/recoverwallet.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ var collectInputs = function() {
inputs.nosend = true;
}

return getVariable("userKey", "Enter value from Box A: 'User Key':")()
.then(getVariable("backupKey", "Enter value from Box B: 'Backup Key':"))
.then(getVariable("bitgoKey", "Enter value from Box C: 'BitGo Public Key':"))
.then(getVariable("password", "Enter your wallet passcode:"))
.then(getVariable("destination", "Enter the bitcoin address to receive the funds:"));
return getVariable("userKey", "Enter value from Box A: 'User Key': ")()
.then(getVariable("backupKey", "Enter value from Box B: 'Backup Key': "))
.then(getVariable("bitgoKey", "Enter value from Box C: 'BitGo Public Key': "))
.then(getVariable("password", "Enter your wallet passcode: "))
.then(getVariable("destination", "Enter the bitcoin address to receive the funds: "));
};

//
Expand Down