deploy: 009c387

haddock/hydra-node/Hydra-Chain-Direct-Tx.html

@@ -26,7 +26,9 @@
  containing PTs.</p></div></div><a href="#g:2" id="g:2"><h1>Observe Hydra Head transactions</h1></a><div class="top"><p class="src"><a id="v:observeInitTx" class="def">observeInitTx</a> :: <a href="Hydra-Party.html#t:Party" title="Hydra.Party">Party</a> -&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>) <a href="#v:observeInitTx" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:convertParty" class="def">convertParty</a> :: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-plutus-0.1.0/doc/html/hydra-plutus/Hydra-Data-Party.html#t:Party" title="Hydra.Data.Party">Party</a> -&gt; <a href="Hydra-Party.html#t:Party" title="Hydra.Party">Party</a> <a href="#v:convertParty" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:observeCommitTx" class="def">observeCommitTx</a> :: ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>) <a href="#v:observeCommitTx" class="selflink">#</a></p><div class="doc"><p>Identify a commit tx by looking for an output which pays to v_commit.</p></div></div><div class="top"><p class="src"><a id="v:observeCollectComTx" class="def">observeCollectComTx</a> <a href="#v:observeCollectComTx" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)</td><td class="doc"><p>A Utxo set to lookup tx inputs</p></td></tr><tr><td class="src">-&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Identify a collectCom tx by lookup up the input spending the Head output
  and decoding its redeemer.</p></div></div><div class="top"><p class="src"><a id="v:observeCloseTx" class="def">observeCloseTx</a> <a href="#v:observeCloseTx" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)</td><td class="doc"><p>A Utxo set to lookup tx inputs</p></td></tr><tr><td class="src">-&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Identify a close tx by lookup up the input spending the Head output and
  decoding its redeemer.</p></div></div><div class="top"><p class="src"><a id="v:observeFanoutTx" class="def">observeFanoutTx</a> <a href="#v:observeFanoutTx" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)</td><td class="doc"><p>A Utxo set to lookup tx inputs</p></td></tr><tr><td class="src">-&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Identify a fanout tx by lookup up the input spending the Head output and
- decoding its redeemer.</p></div></div><div class="top"><p class="src"><a id="v:observeAbortTx" class="def">observeAbortTx</a> <a href="#v:observeAbortTx" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)</td><td class="doc"><p>A Utxo set to lookup tx inputs</p></td></tr><tr><td class="src">-&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Identify an abort tx by looking up the input spending the Head output and
+ decoding its redeemer.</p><p>TODO: Ideally, the fanout does not produce any state-machine output. That
+ means, to observe it, we need to look for a transaction with an input spent
+ from a known script (the head state machine script) with a &quot;fanout&quot; redeemer.</p></div></div><div class="top"><p class="src"><a id="v:observeAbortTx" class="def">observeAbortTx</a> <a href="#v:observeAbortTx" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)</td><td class="doc"><p>A Utxo set to lookup tx inputs</p></td></tr><tr><td class="src">-&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (<a href="Hydra-Chain.html#t:OnChainTx" title="Hydra.Chain">OnChainTx</a> <a href="Hydra-Ledger-Cardano.html#t:CardanoTx" title="Hydra.Ledger.Cardano">CardanoTx</a>, <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Identify an abort tx by looking up the input spending the Head output and
  decoding its redeemer.</p></div></div><a href="#g:3" id="g:3"><h1>Functions related to OnChainHeadState</h1></a><div class="top"><p class="src"><a id="v:knownUtxo" class="def">knownUtxo</a> :: <a href="Hydra-Chain-Direct-Tx.html#t:OnChainHeadState" title="Hydra.Chain.Direct.Tx">OnChainHeadState</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:knownUtxo" class="selflink">#</a></p><div class="doc"><p>Provide a UTXO map for given OnChainHeadState. Used by the TinyWallet and
  the direct chain component to lookup inputs for balancing / constructing txs.
  XXX(SN): This is a hint that we might want to track the Utxo directly?</p></div></div><div class="top"><p class="src"><a id="v:ownInitial" class="def">ownInitial</a> :: <a href="Hydra-Chain-Direct-Util.html#t:VerificationKey" title="Hydra.Chain.Direct.Util">VerificationKey</a> -&gt; [(TxIn StandardCrypto, TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>, Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>)] -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (TxIn StandardCrypto, PubKeyHash) <a href="#v:ownInitial" class="selflink">#</a></p><div class="doc"><p>Look for the &quot;initial&quot; which corresponds to given cardano verification key.</p></div></div><a href="#g:4" id="g:4"><h1>Helpers</h1></a><div class="top"><p class="src"><a id="v:mkUnsignedTx" class="def">mkUnsignedTx</a> :: TxBody <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; TxDats <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; Redeemers <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (ScriptHash StandardCrypto) (Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) -&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> <a href="#v:mkUnsignedTx" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:scriptAddr" class="def">scriptAddr</a> :: Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; Addr StandardCrypto <a href="#v:scriptAddr" class="selflink">#</a></p><div class="doc"><p>Get the ledger address for a given plutus script.</p></div></div><div class="top"><p class="src"><a id="v:plutusScript" class="def">plutusScript</a> :: Script -&gt; Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> <a href="#v:plutusScript" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:withDataHash" class="def">withDataHash</a> :: Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; (DataHash StandardCrypto, Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:withDataHash" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:withScriptHash" class="def">withScriptHash</a> :: Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; (ScriptHash StandardCrypto, Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:withScriptHash" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:datumsFromList" class="def">datumsFromList</a> :: [Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>] -&gt; TxDats <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> <a href="#v:datumsFromList" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:redeemersFromList" class="def">redeemersFromList</a> :: [(StrictMaybe RdmrPtr, (Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>, ExUnits))] -&gt; Redeemers <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> <a href="#v:redeemersFromList" class="selflink">#</a></p><div class="doc"><p>Slightly unsafe, as it drops <code>SNothing</code> values from the list silently.</p></div></div><div class="top"><p class="src"><a id="v:lookupDatum" class="def">lookupDatum</a> :: TxWitness <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (Data <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:lookupDatum" class="selflink">#</a></p><div class="doc"><p>Lookup included datum of given <code>TxOut</code>.</p></div></div><div class="top"><p class="src"><a id="v:getRedeemerSpending" class="def">getRedeemerSpending</a> :: FromData a =&gt; ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; TxIn StandardCrypto -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> a <a href="#v:getRedeemerSpending" class="selflink">#</a></p><div class="doc"><p>Lookup and decode redeemer which is spending a given <code>TxIn</code>.</p></div></div><div class="top"><p class="src"><a id="v:findScriptOutput" class="def">findScriptOutput</a> :: <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) -&gt; Script <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Maybe" title="Hydra.Prelude">Maybe</a> (TxIn StandardCrypto, TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:findScriptOutput" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:utxoFromTx" class="def">utxoFromTx</a> :: ValidatedTx <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a> -&gt; <a href="file:///home/runner/work/hydra-poc/hydra-poc/dist-newstyle/build/x86_64-linux/ghc-8.10.7/hydra-prelude-0.1.0/doc/html/hydra-prelude/Hydra-Prelude.html#t:Map" title="Hydra.Prelude">Map</a> (TxIn StandardCrypto) (TxOut <a href="Hydra-Chain-Direct-Util.html#t:Era" title="Hydra.Chain.Direct.Util">Era</a>) <a href="#v:utxoFromTx" class="selflink">#</a></p><div class="doc"><p>Get the Utxo set created by given transaction.