Skip to content

Feature/Enhancement Request: nomenclature update: replace all mentions of "unlock" and "witness" with "authorization" #35

@k98kurz

Description

@k98kurz

Feature or Enhancement?

  • ( ) New feature
  • (x) Enhancement of existing feature

Description

"Witness" is a borrowing from Bitcoin that does not really fit in this library as its uses are more generalized than the SegWit system -- the more likely use case will be more akin to the original "scriptSig" concept in which the authorization data is embedded directly within a hashed/content-addressed record of some sort. "Unlock" is insufficiently descriptive.

"Authorization" makes the most sense for tapescript as that is its intended purpose. The package should thus be updated:

  • Tool names should be updated, e.g. make_taproot_witness_keyspend -> make_taproot_auth_keyspend.
  • Documentation should be updated to replace "witness" or "unlock" with "authorization".

Additional context

This will be a fairly substantial change that will break backwards compatibility. Maintaining the old tool names with deprecation warnings would be a good idea, but I might skip this and just change things in v0.8.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions