Skip to content
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

Clarify hd-key types. #120

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify hd-key types. #120

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
12 changes: 5 additions & 7 deletions papers/bcr-2020-007-hdkey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,25 +117,23 @@ The following specification is written in Concise Data Definition Language [CDDL

```
; An hd-key is either a master key or a derived key.
hd-key = {
master-key / derived-key
}
hd-key = master-key / derived-key

; A master key is always private, has no use or derivation information,
; and always includes a chain code.
master-key = (
master-key = {
is-master: true,
key-data: key-data-bytes,
chain-code: chain-code-bytes
)
}

; A derived key may be private or public, has an optional chain code, and
; may carry additional metadata about its use and derivation.
; To maintain isomorphism with [BIP32] and allow keys to be derived from
; this key `chain-code`, `origin`, and `parent-fingerprint` must be present.
; If `origin` contains only a single derivation step and also contains `source-fingerprint`,
; then `parent-fingerprint` MUST be identical to `source-fingerprint` or may be omitted.
derived-key = (
derived-key = {
? is-private: bool .default false, ; true if key is private, false if public
key-data: key-data-bytes,
? chain-code: chain-code-bytes ; omit if no further keys may be derived from this key
Expand All @@ -145,7 +143,7 @@ derived-key = (
? parent-fingerprint: uint32 .ne 0, ; The fingerprint of this key's direct ancestor, per [BIP32]
? name: text, ; A short name for this key.
? note: text ; An arbtrary amount of text describing the key.
)
}

; If the `use-info` field is omitted, defaults (mainnet BTC key) are assumed.
; If `cointype` and `origin` are both present, then per [BIP44], the second path
Expand Down