Function satisfier

Parameters

• miniscript: string

  A miniscript expression.

• Optional options: {
      unknowns: string[];
      knowns: string[];
  } = {}

  • unknowns: string[]

    An array with the pieces of information that cannot be used to construct solutions because they are unknown.

    For example, if a honest user cannot sign with key, doesn't know the preimage of H and the preimage of e946029032eae1752e181bebab65de15cf0b93aaac4ee0ffdcfccb683c874d43 then unknown must be:

    [
      '<sig(key)>',
      '<ripemd160_preimage(H)>',
      '<sha256_preimage(e946029032eae1752e181bebab65de15cf0b93aaac4ee0ffdcfccb683c874d43)>'
    ]
    Copy

    Note that an expression will allways be NOT sane if it is NOT sane at the the miniscript top level as per Wuille's algorithm.

    For example; if a miniscript is NOT sane at the top level because it can be satisfyed using only preimages, then setting preimages as unknowns will not change this behaviour.

    The reason for this limitation is that the satisfier uses an unmodified version of Wuille's algorithm as an initial precondition before finding solutions. If the miniscript is sane, then unknowns can be set to produce more possible solutions, including preimages, as described above.

  • knowns: string[]

    An array with the only pieces of information that can be used to build satisfactions. This is the complimentary to unknowns. Only knowns or unknowns must be passed.

    If neither knowns and unknowns is passed then it is assumed that there are no unknowns, in other words, that all pieces of information are known.