Skip to content

Commit 2f3d599

Browse files
committed
update docstrings
1 parent 479b244 commit 2f3d599

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

src/seedsigner/helpers/embit_utils.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,12 @@ def encode_silent_payment_address(scan_privkey: ec.PrivateKey, spend_pubkey: ec.
211211
Adapted from https://github.com/bitcoin/bips/blob/master/bip-0352/reference.py
212212
213213
Generates the recipient's reusable silent payment address for a given:
214-
* scanning key (can be PublicKey or PrivateKey)
215-
* spending pubkey
214+
* scan private key
215+
* spend public key
216216
* optional label for labeled addresses
217217
218-
if scan_key is a PrivateKey and label is provided, generates a labeled address.
218+
Scan private key → generates labeled silent address.
219+
Scan public key → generates normal silent address.
219220
"""
220221
scan_pubkey = scan_privkey.get_public_key()
221222
if label is not None:

src/seedsigner/models/seed.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ def _build_bip352_path(self, purpose: int = 352, account: int = 0, is_scan_key:
175175

176176
def _derive_bip352_key(self, is_scan_key: bool = True, network: str = SettingsConstants.MAINNET) -> bip32.HDKey:
177177
"""
178-
Derives the BIP-352 scanning or signing key.
178+
Derive a BIP-352 HD key (scan or spend) from the wallet seed.
179179
180180
see: https://github.com/bitcoin/bips/blob/master/bip-0352.mediawiki#key-derivation
181181
"""

src/seedsigner/views/view.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from typing import Type
44

55
from seedsigner.helpers.l10n import mark_for_translation as _mft
6-
from seedsigner.gui.components import SeedSignerIconConstants, FontAwesomeIconConstants
6+
from seedsigner.gui.components import SeedSignerIconConstants
77
from seedsigner.gui.screens import RET_CODE__POWER_BUTTON, RET_CODE__BACK_BUTTON
88
from seedsigner.gui.screens.screen import BaseScreen, ButtonOption, LargeButtonScreen, WarningScreen, ErrorScreen, QRDisplayScreen
99
from seedsigner.models.settings import Settings, SettingsConstants

0 commit comments

Comments
 (0)