search

bitcoinerlab / descriptors

A TypeScript library for parsing Bitcoin Descriptors, including Miniscript-based ones. Streamlines creating Partially Signed Bitcoin Transactions (PSBTs) from Descriptors. Features BIP32, single-signature, and Hardware Wallet signing capabilities, and facilitates finalizing transactions.
https://bitcoinerlab.com/modules/descriptors
41 stars 14 forks source link

Documentation TODO #2

Open landabaso opened 1 year ago

landabaso commented 1 year ago

Mention it uses BigInt (for checksums)

If BigInt support is not possible, then remove the checksum before passing the descriptor to the parse function.

landabaso commented 1 year ago

Document that it supports all SCRIPT expressions, including also all possible miniscript, but it does not support raw(), combo(), sortedmulti(), tr(), multi_ (taproot), sortedmulti_a (taproot), rawtr (taproot)

no need to mention multi_a or sortedmulti_a since they must be inside tr( anyway

landabaso commented 1 year ago

~document we do not support multiple wildcards yet (not sufficiently specified in official docs).~

landabaso commented 1 year ago

document we do not support bare multi. In fact, it may lead to several resource limitation probs. Better to use multi within sh or wsh, sh(wsh anyway.

landabaso commented 1 year ago

document the test/tools folder (generate bitcoin core fixtures)