From 6df1802a24a776d3a32e3c8b4a781bf07f9fbc59 Mon Sep 17 00:00:00 2001 From: Kim Neunert Date: Wed, 17 Jun 2020 17:03:59 +0200 Subject: [PATCH 1/5] add github workflow for readme-toc --- .github/workflows/toc.yml | 8 ++++++++ docs/faq.md | 3 +++ 2 files changed, 11 insertions(+) create mode 100644 .github/workflows/toc.yml diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml new file mode 100644 index 000000000..5558da0d9 --- /dev/null +++ b/.github/workflows/toc.yml @@ -0,0 +1,8 @@ +on: push +name: TOC Generator +jobs: + generateTOC: + name: TOC Generator + runs-on: ubuntu-latest + steps: + - uses: technote-space/toc-generator@v2 \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index af4b1d9a0..90eb977e4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,8 @@ # Frequently Asked Questions + + + ## ABOUT THE PROJECT The goal of this project is to make a convenient and user-friendly GUI around Bitcoin Core with a focus on multisignature setup with airgapped (offline) hardware wallets. From e40a5a0fc598eb0e383b7c0912ccf0a5784044b1 Mon Sep 17 00:00:00 2001 From: k9ert Date: Wed, 17 Jun 2020 15:04:37 +0000 Subject: [PATCH 2/5] docs: update TOC --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index caa34f505..5e432bc32 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ + + +**Table of Contents** + +- [Specter Desktop](#specter-desktop) + - [DISCLAIMER](#disclaimer) + - [Why?](#why) + - [How to run](#how-to-run) + - [Detailed instructions](#detailed-instructions) + - [A few screenshots](#a-few-screenshots) + - [Adding a new device](#adding-a-new-device) + - [Creating a new wallet](#creating-a-new-wallet) + - [Wallet interface](#wallet-interface) + - [Configuration](#configuration) + + + # Specter Desktop [![Build Status](https://travis-ci.org/cryptoadvance/specter-desktop.svg?branch=master)](https://travis-ci.org/cryptoadvance/specter-desktop) From 77950938742d02ea461d63a73a37e47b185bb833 Mon Sep 17 00:00:00 2001 From: Kim Neunert Date: Wed, 17 Jun 2020 17:15:22 +0200 Subject: [PATCH 3/5] adding path for faq.md --- .github/workflows/toc.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml index 5558da0d9..07bda3e7c 100644 --- a/.github/workflows/toc.yml +++ b/.github/workflows/toc.yml @@ -5,4 +5,6 @@ jobs: name: TOC Generator runs-on: ubuntu-latest steps: - - uses: technote-space/toc-generator@v2 \ No newline at end of file + - uses: technote-space/toc-generator@v2 + env: + TARGET_PATHS: README.md, docs/faq.md \ No newline at end of file From c7d46698dfa68486514be83368ef5744a89f443c Mon Sep 17 00:00:00 2001 From: Kim Neunert Date: Wed, 17 Jun 2020 17:19:41 +0200 Subject: [PATCH 4/5] fix githubAction --- .github/workflows/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml index 07bda3e7c..23e0225bd 100644 --- a/.github/workflows/toc.yml +++ b/.github/workflows/toc.yml @@ -6,5 +6,5 @@ jobs: runs-on: ubuntu-latest steps: - uses: technote-space/toc-generator@v2 - env: + with: TARGET_PATHS: README.md, docs/faq.md \ No newline at end of file From c848a3bfd2e63c637d475b02934641ffe716b918 Mon Sep 17 00:00:00 2001 From: k9ert Date: Wed, 17 Jun 2020 15:20:01 +0000 Subject: [PATCH 5/5] docs: update TOC --- docs/faq.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 60 insertions(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 90eb977e4..3a4d8f628 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,7 +1,65 @@ # Frequently Asked Questions - - + + +**Table of Contents** + +- [ABOUT THE PROJECT](#about-the-project) +- [*Why the name Specter?*](#why-the-name-specter) +- [GENERAL QUESTIONS](#general-questions) +- [*How safe is the app to use? Is it still considered alpha/beta or safe enough to use it with real sats in a HWW or Specter-DIY multisig setup?*](#how-safe-is-the-app-to-use-is-it-still-considered-alphabeta-or-safe-enough-to-use-it-with-real-sats-in-a-hww-or-specter-diy-multisig-setup) +- [*What does WIP mean?*](#what-does-wip-mean) +- [*What's the difference between specter-desktop and specter-DIY?*](#whats-the-difference-between-specter-desktop-and-specter-diy) +- [*I'm not sure I want the Bitcoin-Core wallet functionality to be used, is that mandatory? If so, is it considered secure?*](#im-not-sure-i-want-the-bitcoin-core-wallet-functionality-to-be-used-is-that-mandatory-if-so-is-it-considered-secure) +- [*I make unsigned transactions from my cold storage using a watching-only Electrum wallet. I use public servers instead of my own node because doing it "right" is too complicated for me. Specter may be an ideal alternative if it will connect to my **headless bitcoind node**. Will this be possible?*](#i-make-unsigned-transactions-from-my-cold-storage-using-a-watching-only-electrum-wallet-i-use-public-servers-instead-of-my-own-node-because-doing-it-right-is-too-complicated-for-me-specter-may-be-an-ideal-alternative-if-it-will-connect-to-my-headless-bitcoind-node-will-this-be-possible) +- [*What is the practical difference of using PSBT (partially signed bitcoin transaction) with multisig vs. just signing the raw multisig transaction normally?*](#what-is-the-practical-difference-of-using-psbt-partially-signed-bitcoin-transaction-with-multisig-vs-just-signing-the-raw-multisig-transaction-normally) +- [USAGE](#usage) +- [*How do I run the app?*](#how-do-i-run-the-app) +- [*What do I need to do in order to create a multisig wallet?*](#what-do-i-need-to-do-in-order-to-create-a-multisig-wallet) +- [*Can I use Bluewallet with Specter DIY?*](#can-i-use-bluewallet-with-specter-diy) +- [*Which HWW's are supported?*](#which-hwws-are-supported) +- [*Can this also work with external nodes like Casa, MyNode, and Raspilitz?*](#can-this-also-work-with-external-nodes-like-casa-mynode-and-raspilitz) +- [*Can I use Tor?*](#can-i-use-tor) +- [*How to set the URL for the block explorer?*](#how-to-set-the-url-for-the-block-explorer) +- [BACKING UP FUNDS](#backing-up-funds) +- [*If something happens to the `~/.specter` folder, is it still possible to **restore** acccess to multisigs created there (assuming there is no backup of the `~/.specter` folder)?*](#if-something-happens-to-the-specter-folder-is-it-still-possible-to-restore-acccess-to-multisigs-created-there-assuming-there-is-no-backup-of-the-specter-folder) +- [SPECTER-DIY](#specter-diy) +- [*What does the Specter-DIY consist of?*](#what-does-the-specter-diy-consist-of) +- [*Is specter-DIY safe to use?*](#is-specter-diy-safe-to-use) +- [*I'm wondering what if someone takes the device? How does Specter-DIY approach this scenario?*](#im-wondering-what-if-someone-takes-the-device-how-does-specter-diy-approach-this-scenario) +- [*Currently there is a `specter_hwi.py` file, which implements the HWIClient for Specter-DIY. Is there any reason you didn't add that directly to HWI?*](#currently-there-is-a-specter_hwipy-file-which-implements-the-hwiclient-for-specter-diy-is-there-any-reason-you-didnt-add-that-directly-to-hwi) +- [*Do you have a physical security design?*](#do-you-have-a-physical-security-design) +- [*Is there a simulator I can try the Specter-DIY with?*](#is-there-a-simulator-i-can-try-the-specter-diy-with) +- [*Is there a goal to get Specter-DIY loading firmware updates from the SD card?*](#is-there-a-goal-to-get-specter-diy-loading-firmware-updates-from-the-sd-card) +- [*Can specter-DIY register cosigner xpubs like coldcard? I know you wipe private keys on shutdown, but do you save stuff like that?*](#can-specter-diy-register-cosigner-xpubs-like-coldcard-i-know-you-wipe-private-keys-on-shutdown-but-do-you-save-stuff-like-that) +- [*Once you add the javacard (secure element) you'll save the private keys, too?*](#once-you-add-the-javacard-secure-element-youll-save-the-private-keys-too) +- [SPECTER-DEVKIT](#specter-devkit) +- [*Can I buy the Specter-devkit pre-built?*](#can-i-buy-the-specter-devkit-pre-built) +- [TROUBLESHOOT](#troubleshoot) +- [*How to upgrade?*](#how-to-upgrade) +- [*How can I access the web interface if it's hosted on a headless computer?*](#how-can-i-access-the-web-interface-if-its-hosted-on-a-headless-computer) +- [*Keep getting: No matching distribution found for cryptoadvance.specter](#keep-getting-no-matching-distribution-found-for-cryptoadvancespecter) +- [*Even after upgrading to python3 it's still looking at 2.7 version. I uninstalled 2.7, so not sure where to go next?*](#even-after-upgrading-to-python3-its-still-looking-at-27-version-i-uninstalled-27-so-not-sure-where-to-go-next) +- [*How to delete a wallet using a remote full node?*](#how-to-delete-a-wallet-using-a-remote-full-node) +- [DIY TROUBLESHOOT](#diy-troubleshoot) +- [*Does anyone have any tips on mounting the power bank and QR code scanner to the STM32 board in a somewhat ergonomic manner?*](#does-anyone-have-any-tips-on-mounting-the-power-bank-and-qr-code-scanner-to-the-stm32-board-in-a-somewhat-ergonomic-manner) +- [HWW TROUBLESHOOT](#hww-troubleshoot) +- [*With achow's HWI tool, input and output PSBT are the same. And with Electrum 4, I get a rawtransaction, not a base64 PSBT.*](#with-achows-hwi-tool-input-and-output-psbt-are-the-same-and-with-electrum-4-i-get-a-rawtransaction-not-a-base64-psbt) +- [TECHNICAL QUESTIONS (not dev related)](#technical-questions-not-dev-related) +- [*Does specter-desktop require `txindex=1` to be set in your `bitcoin.conf`?*](#does-specter-desktop-require-txindex1-to-be-set-in-your-bitcoinconf) +- [FUTURE FEATURES](#future-features) +- [*Will Specter-Desktop ever be a full Hot-Wallet?*](#will-specter-desktop-ever-be-a-full-hot-wallet) +- [*How are you guys planning to do airgapped firmware updates via QR codes?*](#how-are-you-guys-planning-to-do-airgapped-firmware-updates-via-qr-codes) +- [*Will this device be Shamir Secret Shares compatible?*](#will-this-device-be-shamir-secret-shares-compatible) +- [*Will there be coinjoin support in the future?*](#will-there-be-coinjoin-support-in-the-future) +- [VIDEOS](#videos) +- [**1** Getting started with Specter-DIY and Specter-Desktop](#1-getting-started-with-specter-diy-and-specter-desktop) +- [**2** Assembling Specter-DIY](#2-assembling-specter-diy) +- [**3** Specter-DIY air-gapped open source bitcoin hardware wallet overview](#3-specter-diy-air-gapped-open-source-bitcoin-hardware-wallet-overview) +- [**4** Build your own bitcoin hardware-wallet YT series](#4-build-your-own-bitcoin-hardware-wallet-yt-series) +- [*What is the difference between that project (DIYbitcoinhardware) & Specter? Is DIYbitcoinhardware sort of a prerequisite for Specter?*](#what-is-the-difference-between-that-project-diybitcoinhardware--specter-is-diybitcoinhardware-sort-of-a-prerequisite-for-specter) + + ## ABOUT THE PROJECT