[#miniscript]
= miniscript
:mrdocs:

Miniscript: a structured representation of Bitcoin Scripts.

== Description

Provides the node types, the fragment/Type type system, and the availability enums used to build, analyze, and satisfy Miniscript expressions under the P2WSH and Tapscript contexts.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:miniscript/Node.adoc[`Node`] 
| A node in a miniscript expression.
| xref:miniscript/Type.adoc[`Type`] 
| This type encapsulates the miniscript type system properties.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:miniscript/Opcode.adoc[`Opcode`] 
| A single script opcode together with any immediate data it pushes.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:miniscript/Availability.adoc[`Availability`] 
| Three‐valued result for whether a satisfaction or dissatisfaction is available.
| xref:miniscript/Fragment.adoc[`Fragment`] 
| The different node types in miniscript.
| xref:miniscript/MiniscriptContext.adoc[`MiniscriptContext`] 
| The script context a Miniscript is used under.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:miniscript/Compare.adoc[`Compare`] 
| Compare two miniscript subtrees, using a non‐recursive algorithm.
| xref:miniscript/ForEachNode.adoc[`ForEachNode`] 
| Unordered traversal of a miniscript node tree.
| xref:miniscript/FromScript.adoc[`FromScript`] 
| Decodes a Miniscript from a Bitcoin Script.
| xref:miniscript/FromString.adoc[`FromString`] 
| Parses a Miniscript from its textual (policy‐language) representation.
| xref:miniscript/IsTapscript.adoc[`IsTapscript`] 
| Whether the context Tapscript, ensuring the only other possibility is P2WSH.
| xref:miniscript/operator_mst.adoc[`operator""_mst`] 
| The only way to publicly construct a Type is using this literal operator.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#