Skip to content

Commit

Permalink
instructions and textual changes
Browse files Browse the repository at this point in the history
  • Loading branch information
remcoros committed Jul 27, 2024
1 parent fda33b2 commit dda805f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
12 changes: 11 additions & 1 deletion instructions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# NFC Push TX

TODO: instructions
This feature allows single-tap broadcast of freshly-signed transactions from a COLDCARD and hopefully others soon(tm).

Once enabled with a URL, the COLDCARD will show the NFC animation after signing the transaction. When the user taps their phone, the phone will see an NFC tag with URL inside. That URL contains the signed transaction ready to go, and once opening in the mobile browser of the phone, that URL will load. The page will connect to your Bitcoin node and send the transaction on the public Bitcoin network.

## Setting up Coldcard

This feature is available on Q and Mk4 and requires NFC to be enabled. On your Coldcard, see Settings > NFC Push Tx to enable.

When enabling NFC Push TX in the Coldcard, you can use the QR scanner to scan the correct URL from the 'Properties' page in StartOS (click on the QR icon to show the QR code of the LAN or Tor url).

Note: do not use the URL from the 'Interfaces' page! Use the Tor or LAN url from the 'Properties' page instead. The url must end with a hashtag (#).
9 changes: 5 additions & 4 deletions manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ hardware-requirements:
- aarch64
health-checks:
app-ui:
name: NFC Push TX User Interface
success-message: Ready to be visited in a web browser
name: NFC Push TX Service
success-message: Go to 'Properties' to view the correct LAN/Tor url.
type: script
config:
get:
Expand All @@ -53,8 +53,8 @@ volumes:
interface-id: main
interfaces:
main:
name: NFC Push TX UI
description: NFC Push TX user interface
name: NFC Push TX Service
description: DO NOT USE! Go to 'Properties' and use the LAN/Tor url from there.
lan-config:
443:
ssl: true
Expand All @@ -66,6 +66,7 @@ interfaces:
protocols:
- tcp
- http
- https
dependencies:
bitcoind:
version: ">=0.21.1.2 <29.0.0"
Expand Down
6 changes: 3 additions & 3 deletions scripts/procedures/properties.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,18 @@ export const properties: T.ExpectedExports.properties = async (
result: {
version: 2,
data: {
"NFC Push TX Url (Tor)": {
"Tor Url": {
type: "string",
value: `https://${config["tor-address"]}#`,
description: "Use this link to setup NFC Push TX over Tor.",
copyable: true,
qr: true,
masked: false,
},
"NFC Push TX Url (Lan)": {
"LAN Url": {
type: "string",
value: `https://${config["lan-address"]}#`,
description: "Use this link to setup NFC Push TX over Lan.",
description: "Use this link to setup NFC Push TX over LAN.",
copyable: true,
qr: true,
masked: false,
Expand Down

0 comments on commit dda805f

Please sign in to comment.