Skip to content

Commit

Permalink
Update gh-pages
Browse files Browse the repository at this point in the history
Store path: /nix/store/zf7q5lzk9rcjn4wrpgps6gi9laa4ffk2-combine-haddock/share/doc
  • Loading branch information
hercules-ci[bot] committed Jun 3, 2024
1 parent 8480782 commit 7ab8f18
Show file tree
Hide file tree
Showing 22 changed files with 695 additions and 812 deletions.
2 changes: 1 addition & 1 deletion doc-index.html

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions doc-index.json
Original file line number Diff line number Diff line change
Expand Up @@ -232614,22 +232614,22 @@
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Helper.html#v:yieldingHelper"
},
{
"display_html": "<a href=\"#v:compileYieldingValidator\">compileYieldingValidator</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text (HexStringScript &quot;YieldingValidator&quot;)",
"name": "compileYieldingValidator",
"module": "Cardano.YTxP.Control.Yielding.Validator",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Validator.html#v:compileYieldingValidator"
"display_html": "<a href=\"#v:compileYieldingMP\">compileYieldingMP</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural\" title=\"Numeric.Natural\">Natural</a> -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text Script",
"name": "compileYieldingMP",
"module": "Cardano.YTxP.Control.Yielding.Scripts",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Scripts.html#v:compileYieldingMP"
},
{
"display_html": "<a href=\"#v:compileYieldingSV\">compileYieldingSV</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural\" title=\"Numeric.Natural\">Natural</a> -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text (HexStringScript &quot;YieldingSV&quot;)",
"name": "compileYieldingSV",
"module": "Cardano.YTxP.Control.Yielding.StakingValidator",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-StakingValidator.html#v:compileYieldingSV"
"display_html": "<a href=\"#v:compileYieldingValidator\">compileYieldingValidator</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text Script",
"name": "compileYieldingValidator",
"module": "Cardano.YTxP.Control.Yielding.Scripts",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Scripts.html#v:compileYieldingValidator"
},
{
"display_html": "<a href=\"#v:compileYieldingMP\">compileYieldingMP</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural\" title=\"Numeric.Natural\">Natural</a> -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text (HexStringScript &quot;YieldingMP&quot;)",
"name": "compileYieldingMP",
"module": "Cardano.YTxP.Control.Yielding.MintingPolicy",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-MintingPolicy.html#v:compileYieldingMP"
"display_html": "<a href=\"#v:compileYieldingSV\">compileYieldingSV</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural\" title=\"Numeric.Natural\">Natural</a> -&gt; <a href=\"file:///nix/store/j9hczqgi3fnqdc6im8ixicdrqq6vi7p7-ghc-9.6.5-doc/share/doc/ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either\" title=\"Data.Either\">Either</a> Text Script",
"name": "compileYieldingSV",
"module": "Cardano.YTxP.Control.Yielding.Scripts",
"link": "ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Scripts.html#v:compileYieldingSV"
},
{
"display_html": "<span class=\"keyword\">data</span> <a href=\"#t:YieldingScripts\">YieldingScripts</a>",
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title></title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption empty">&nbsp;</span><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="description"><h1></h1><div class="doc"><h1>YTxP Documentation</h1><p>Documentation of the onchain implementation of the YTxP library</p></div></div><div id="module-list"><p class="caption">Packages</p><div id="module-list"><p class="caption">ytxp-plutarch-0.1.0</p><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1">Cardano</span><details id="n.2..1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1.1">YTxP</span><details id="n.2..1.1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1.1.1">Control</span><details id="n.2..1.1.1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Parameters.html">Cardano.YTxP.Control.Parameters</a></span> Data required to work with the compiled control scripts</li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Stubs.html">Cardano.YTxP.Control.Stubs</a></span> Development stubs. Use these when you don't</li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Vendored.html">Cardano.YTxP.Control.Vendored</a></span></li><li><span class="module"><span class="details-toggle-control details-toggle" data-details-id="n.2..1.1.1.4">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding.html">Cardano.YTxP.Control.Yielding</a></span> TODO<details id="n.2..1.1.1.4" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Helper.html">Cardano.YTxP.Control.Yielding.Helper</a></span></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-MintingPolicy.html">Cardano.YTxP.Control.Yielding.MintingPolicy</a></span></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-StakingValidator.html">Cardano.YTxP.Control.Yielding.StakingValidator</a></span></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Validator.html">Cardano.YTxP.Control.Yielding.Validator</a></span></li></ul></details></li></ul></details></li></ul></details></li></ul></details></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Utils.html">Utils</a></span></li></ul></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.29.2</p></div></body></html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title></title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption empty">&nbsp;</span><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="description"><h1></h1><div class="doc"><h1>YTxP Documentation</h1><p>Documentation of the onchain implementation of the YTxP library</p></div></div><div id="module-list"><p class="caption">Packages</p><div id="module-list"><p class="caption">ytxp-plutarch-0.1.0</p><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1">Cardano</span><details id="n.2..1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1.1">YTxP</span><details id="n.2..1.1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module details-toggle-control details-toggle" data-details-id="n.2..1.1.1">Control</span><details id="n.2..1.1.1" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Parameters.html">Cardano.YTxP.Control.Parameters</a></span> Data required to work with the compiled control scripts</li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Stubs.html">Cardano.YTxP.Control.Stubs</a></span> Development stubs. Use these when you don't</li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Vendored.html">Cardano.YTxP.Control.Vendored</a></span></li><li><span class="module"><span class="details-toggle-control details-toggle" data-details-id="n.2..1.1.1.4">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding.html">Cardano.YTxP.Control.Yielding</a></span> TODO<details id="n.2..1.1.1.4" open="open"><summary class="hide-when-js-enabled">Submodules</summary><ul><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Helper.html">Cardano.YTxP.Control.Yielding.Helper</a></span></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Scripts.html">Cardano.YTxP.Control.Yielding.Scripts</a></span></li></ul></details></li></ul></details></li></ul></details></li></ul></details></li><li><span class="module"><span class="noexpander">&nbsp;</span><a href="./ytxp-plutarch/html/Utils.html">Utils</a></span></li></ul></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.29.2</p></div></body></html>

This file was deleted.

6 changes: 6 additions & 0 deletions ytxp-plutarch/html/Cardano-YTxP-Control-Yielding-Scripts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Cardano.YTxP.Control.Yielding.Scripts</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">ytxp-plutarch-0.1.0: Control scripts, types, and utilities for the YTxP architecture</span><ul class="links" id="page-menu"><li><a href="src/Cardano.YTxP.Control.Yielding.Scripts.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Cardano.YTxP.Control.Yielding.Scripts</p></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:compileYieldingMP">compileYieldingMP</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural" title="Numeric.Natural">Natural</a> -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script</li><li class="src short"><a href="#v:compileYieldingValidator">compileYieldingValidator</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script</li><li class="src short"><a href="#v:compileYieldingSV">compileYieldingSV</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural" title="Numeric.Natural">Natural</a> -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:compileYieldingMP" class="def">compileYieldingMP</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural" title="Numeric.Natural">Natural</a> -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script <a href="src/Cardano.YTxP.Control.Yielding.Scripts.html#compileYieldingMP" class="link">Source</a> <a href="#v:compileYieldingMP" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:compileYieldingValidator" class="def">compileYieldingValidator</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script <a href="src/Cardano.YTxP.Control.Yielding.Scripts.html#compileYieldingValidator" class="link">Source</a> <a href="#v:compileYieldingValidator" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:compileYieldingSV" class="def">compileYieldingSV</a> :: Config -&gt; AuthorisedScriptsSTCS -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Numeric-Natural.html#t:Natural" title="Numeric.Natural">Natural</a> -&gt; <a href="../../ghc-9.6.5/html/libraries/base-4.18.2.1/Data-Either.html#t:Either" title="Data.Either">Either</a> Text Script <a href="src/Cardano.YTxP.Control.Yielding.Scripts.html#compileYieldingSV" class="link">Source</a> <a href="#v:compileYieldingSV" class="selflink">#</a></p><div class="doc"><p>Compile a yielding staking validator that has been nonced.
The nonce is required because each staking validator can only
be delegated to a single pool; the inclusion of the nonce will change the
script hash.
Since SVs and MPs share the same signature they share the same implementation,
this function is only provided for semantic clarity</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.29.2</p></div></body></html>
Loading

0 comments on commit 7ab8f18

Please sign in to comment.