doc: Add offline signing tutorial #28363

BrandonOdiwuor · 2023-08-29T12:24:14Z

This PR adds offline signing tutorial. Fixes #9492

Although there currently exists tutorials on external-signer and on multisig implemented on #24519 . The external-signer tutorial assumes a connected device and the multisig tutorial is only for multisig transactions and does not include using an offline wallet

The tutorial uses signet(instead of regtest) to be as close as possible to mainnet

DrahtBot · 2023-08-29T12:24:17Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	achow101, pinheadmz, willcl-ark, Zero-1729
Concept ACK	RandyMcMillan

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

doc/offline-signing-tutorial.md

pinheadmz

concept ACK de9a0f7

Left a few comments - I think the complexity can be reduced to make it more practical for actual mainnet users as opposed to a purely educational exercise.

doc/offline-signing-tutorial.md

willcl-ark

Nice work @BrandonOdiwuor

Gave it a first pass too, and agree with many of @pinheadmz comments. I think removing the online wallet would remove a load of steps and make things easier to follow.

Later today I will try and manually test the steps myself using a docker instance, as you described.

doc/offline-signing-tutorial.md

BrandonOdiwuor · 2023-09-07T13:57:57Z

Thanks all for the feedback, I have updated the docs to include the suggestions

willcl-ark · 2023-09-07T14:05:06Z

Thanks @BrandonOdiwuor, I'll take another look as soon as I am able, but you'll also probably want to squash these commits, either now or later, but certainly before merge :)

…if complete 2e249b9 doc: add release note for PR #28414 (Matthew Zipkin) 4614332 test: remove unnecessary finalizepsbt rpc calls (ismaelsadeeq) e3d484b wallet rpc: return final tx hex from walletprocesspsbt if complete (Matthew Zipkin) Pull request description: See #28363 (comment) `walletprocesspsbt` currently returns a base64-encoded PSBT and a boolean indicating if the tx is "complete". If it is complete, the base64 PSBT can be finalized with `finalizepsbt` which returns the hex-encoded transaction suitable for `sendrawtransaction`. With this patch, `walletprocesspsbt` return object will ALSO include the broadcast-able hex string if the tx is already final. This saves users the extra step of calling `finalizepsbt` assuming they have already inspected and approve the transaction from earlier steps. ACKs for top commit: ismaelsadeeq: re ACK 2e249b9 BrandonOdiwuor: re ACK 2e249b9 Randy808: Tested ACK 2e249b9 achow101: ACK 2e249b9 ishaanam: ACK 2e249b9 Tree-SHA512: 229c1103265a9b4248f080935a7ad5607c3be3f9a096a9ab6554093b2cd8aa8b4d1fa55b1b97d3925ba208dbc3ccba4e4d37c40e1491db0d27ba3d9fe98f931e

doc/offline-signing-tutorial.md

BrandonOdiwuor · 2023-09-13T08:59:14Z

@pinheadmz I have updated the doc to include the changes on #28414

pinheadmz

Looking great, almost done just a few ideas to make the offline/online wallets less confusing

doc/offline-signing-tutorial.md

…sspsbt if complete 2e249b9 doc: add release note for PR bitcoin#28414 (Matthew Zipkin) 4614332 test: remove unnecessary finalizepsbt rpc calls (ismaelsadeeq) e3d484b wallet rpc: return final tx hex from walletprocesspsbt if complete (Matthew Zipkin) Pull request description: See bitcoin#28363 (comment) `walletprocesspsbt` currently returns a base64-encoded PSBT and a boolean indicating if the tx is "complete". If it is complete, the base64 PSBT can be finalized with `finalizepsbt` which returns the hex-encoded transaction suitable for `sendrawtransaction`. With this patch, `walletprocesspsbt` return object will ALSO include the broadcast-able hex string if the tx is already final. This saves users the extra step of calling `finalizepsbt` assuming they have already inspected and approve the transaction from earlier steps. ACKs for top commit: ismaelsadeeq: re ACK 2e249b9 BrandonOdiwuor: re ACK 2e249b9 Randy808: Tested ACK 2e249b9 achow101: ACK 2e249b9 ishaanam: ACK 2e249b9 Tree-SHA512: 229c1103265a9b4248f080935a7ad5607c3be3f9a096a9ab6554093b2cd8aa8b4d1fa55b1b97d3925ba208dbc3ccba4e4d37c40e1491db0d27ba3d9fe98f931e

BrandonOdiwuor · 2023-09-26T06:21:53Z

@pinheadmz, @willcl-ark , @rot13maxi I have updated the doc with the feedbacks received

willcl-ark

Hey @BrandonOdiwuor looking pretty good now, nice work!

I left some (ok, quite a few!) nits, but not related to the process. Feel free to take whichever you feel improve the readability the most.

doc/offline-signing-tutorial.md

BrandonOdiwuor · 2023-10-23T08:17:15Z

cc @willcl-ark @rot13maxi

could you please review the latest version of the doc

doc/offline-signing-tutorial.md

achow101 · 2023-11-03T20:14:03Z

ACK 3c208cc

pinheadmz

ACK 3c208cc

Confirmed only updates since last review addressed achow101's nits re: send and blank

Show Signature

pinheadmz's public key is on keybase

willcl-ark · 2023-11-06T09:45:16Z

ACK 3c208cc

Looks good to me!

Zero-1729 · 2023-11-06T14:41:29Z

doc/offline-signing-tutorial.md

+
+### Process and Sign the PSBT
+
+1. Unlock the `offline_wallet` with the Passphrase:


Minor capitalization nit.

Suggested change

1. Unlock the `offline_wallet` with the Passphrase:

1. Unlock the `offline_wallet` with the passphrase:

Zero-1729 · 2023-11-06T14:41:43Z

doc/offline-signing-tutorial.md

+## Overview
+In this tutorial we have two hosts, both running Bitcoin v25.0
+
+* `offline` host which is disconnected from all networks (internet, Tor, wifi, bluetooth etc.) and does not have, or need, a copy of the blockchain.


Minor capitalization nit.

Suggested change

* `offline` host which is disconnected from all networks (internet, Tor, wifi, bluetooth etc.) and does not have, or need, a copy of the blockchain.

* `offline` host which is disconnected from all networks (Internet, Tor, WiFi, Bluetooth, etc.) and does not have, or need, a copy of the blockchain.

Zero-1729 · 2023-11-06T14:42:11Z

doc/offline-signing-tutorial.md

+
+This tutorial will describe how to use two instances of Bitcoin Core, one online and one offline, to greatly increase security by not having private keys reside on a networked device.
+
+Maintaining an air-gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.


Minor hyphenation nit.

Suggested change

Maintaining an air-gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.

Maintaining an air gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.

Zero-1729

ACK 3c208cc

Great work!

DrahtBot added the Docs label Aug 29, 2023

rot13maxi reviewed Aug 29, 2023

View reviewed changes

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

DrahtBot added the CI failed label Aug 30, 2023

BrandonOdiwuor force-pushed the offline_sining_doc branch from fd4366b to de9a0f7 Compare August 31, 2023 18:32

DrahtBot added CI failed and removed CI failed labels Aug 31, 2023

pinheadmz reviewed Sep 5, 2023

View reviewed changes

willcl-ark reviewed Sep 5, 2023

View reviewed changes

pinheadmz mentioned this pull request Sep 5, 2023

wallet rpc: return final tx hex from walletprocesspsbt if complete #28414

Merged

BrandonOdiwuor requested review from pinheadmz and willcl-ark September 7, 2023 13:58

BrandonOdiwuor force-pushed the offline_sining_doc branch from 117c378 to dcf4557 Compare September 7, 2023 18:03

pinheadmz reviewed Sep 12, 2023

View reviewed changes

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

BrandonOdiwuor force-pushed the offline_sining_doc branch from dcf4557 to f22625f Compare September 13, 2023 08:57

DrahtBot added CI failed and removed CI failed labels Sep 13, 2023

BrandonOdiwuor requested review from pinheadmz and rot13maxi September 14, 2023 08:09

pinheadmz reviewed Sep 15, 2023

View reviewed changes

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

BrandonOdiwuor force-pushed the offline_sining_doc branch from f22625f to c01707b Compare September 26, 2023 06:19

BrandonOdiwuor requested a review from pinheadmz September 26, 2023 06:22

willcl-ark reviewed Sep 26, 2023

View reviewed changes

BrandonOdiwuor requested a review from MarnixCroes October 17, 2023 15:35

DrahtBot removed request for rot13maxi and MarnixCroes October 23, 2023 08:17

BrandonOdiwuor requested a review from rot13maxi October 26, 2023 09:19

achow101 reviewed Oct 26, 2023

View reviewed changes

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

doc/offline-signing-tutorial.md Outdated Show resolved Hide resolved

DrahtBot removed the request for review from rot13maxi October 26, 2023 18:47

BrandonOdiwuor force-pushed the offline_sining_doc branch from 1f8ac46 to 915dbdc Compare October 27, 2023 09:03

BrandonOdiwuor requested review from achow101, pinheadmz, rot13maxi and MarnixCroes October 27, 2023 09:04

Add offline signing tutorial

3c208cc

BrandonOdiwuor force-pushed the offline_sining_doc branch from 915dbdc to 3c208cc Compare October 27, 2023 09:33

DrahtBot removed request for achow101, rot13maxi and MarnixCroes November 3, 2023 20:14

pinheadmz approved these changes Nov 5, 2023

View reviewed changes

DrahtBot removed the request for review from willcl-ark November 6, 2023 09:45

willcl-ark approved these changes Nov 6, 2023

View reviewed changes

Zero-1729 reviewed Nov 6, 2023

View reviewed changes

achow101 merged commit 4cebad4 into bitcoin:master Nov 6, 2023

reez mentioned this pull request Nov 7, 2023

Socratic Seminar #13 Topics NashBitDevs/nashbitdevs.org#15

Closed

BrandonOdiwuor deleted the offline_sining_doc branch November 21, 2023 09:36

bitcoin locked and limited conversation to collaborators Nov 20, 2024


		### Process and Sign the PSBT

		1. Unlock the `offline_wallet` with the Passphrase:

	* `offline` host which is disconnected from all networks (internet, Tor, wifi, bluetooth etc.) and does not have, or need, a copy of the blockchain.
	* `offline` host which is disconnected from all networks (Internet, Tor, WiFi, Bluetooth, etc.) and does not have, or need, a copy of the blockchain.


		This tutorial will describe how to use two instances of Bitcoin Core, one online and one offline, to greatly increase security by not having private keys reside on a networked device.

		Maintaining an air-gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.

	Maintaining an air-gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.
	Maintaining an air gap between private keys and any network connections drastically reduces the opportunity for those keys to be exfiltrated from the user.

doc: Add offline signing tutorial #28363

doc: Add offline signing tutorial #28363

Uh oh!

Conversation

BrandonOdiwuor commented Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrahtBot commented Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage

Reviews

Uh oh!

Uh oh!

Uh oh!

pinheadmz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

willcl-ark left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrandonOdiwuor commented Sep 7, 2023

Uh oh!

willcl-ark commented Sep 7, 2023

Uh oh!

Uh oh!

BrandonOdiwuor commented Sep 13, 2023

Uh oh!

pinheadmz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrandonOdiwuor commented Sep 26, 2023

Uh oh!

willcl-ark left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrandonOdiwuor commented Oct 23, 2023

Uh oh!

Uh oh!

Uh oh!

achow101 commented Nov 3, 2023

Uh oh!

pinheadmz left a comment

Choose a reason for hiding this comment

Uh oh!

willcl-ark commented Nov 6, 2023

Uh oh!

Zero-1729 Nov 6, 2023

Choose a reason for hiding this comment

Uh oh!

Zero-1729 Nov 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BrandonOdiwuor commented Aug 29, 2023 •

edited

Loading

DrahtBot commented Aug 29, 2023 •

edited

Loading

Zero-1729 Nov 6, 2023 •

edited

Loading