Skip to content

Commit

Permalink
Build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@nielstron
nielstron committed Apr 15, 2024
1 parent 58d3343 commit 6df5454
Show file tree
Hide file tree
Showing 13 changed files with 3,446 additions and 3,443 deletions.
4,626 changes: 2,313 additions & 2,313 deletions docs/index.js
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/opshin/builder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</details>
</dd>
<dt id="opshin.builder.build"><code class="name flex">
<span>def <span class="ident">build</span></span>(<span>contract_file: str, *args: Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData, uplc.ast.Constant], validator_function_name='validator', config=CompilationConfig(compress_patterns=False, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True))</span>
<span>def <span class="ident">build</span></span>(<span>contract_file: str, *args: Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData, uplc.ast.Constant], validator_function_name='validator', config=CompilationConfig(compress_patterns=True, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True))</span>
</code></dt>
<dd>
<div class="desc"><p>Expects a python module and returns the build artifacts from compiling it</p></div>
Expand Down Expand Up @@ -645,7 +645,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</details>
</dd>
<dt id="opshin.builder.compile"><code class="name flex">
<span>def <span class="ident">compile</span></span>(<span>program: ast.Module, contract_filename: Optional[str] = None, validator_function_name='validator', config=CompilationConfig(compress_patterns=False, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True)) ‑> uplc.ast.Program</span>
<span>def <span class="ident">compile</span></span>(<span>program: ast.Module, contract_filename: Optional[str] = None, validator_function_name='validator', config=CompilationConfig(compress_patterns=True, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True)) ‑> uplc.ast.Program</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -930,10 +930,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="opshin.builder.PlutusContract"><code class="flex name class">
<span>class <span class="ident">PlutusContract</span></span>
<span>(</span><span>contract: pycardano.plutus.PlutusV2Script, datum_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, redeemer_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, parameter_types: List[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = &lt;factory&gt;, purpose: Iterable[<a title="opshin.builder.Purpose" href="#opshin.builder.Purpose">Purpose</a>] = (&lt;Purpose.any: &#x27;any&#x27;&gt;,), version: Optional[str] = '1.0.0', title: str = 'validator', description: Optional[str] = 'opshin 0.21.0 Smart Contract', license: Optional[str] = None)</span>
<span>(</span><span>contract: pycardano.plutus.PlutusV2Script, datum_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, redeemer_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, parameter_types: List[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = &lt;factory&gt;, purpose: Iterable[<a title="opshin.builder.Purpose" href="#opshin.builder.Purpose">Purpose</a>] = (&lt;Purpose.any: &#x27;any&#x27;&gt;,), version: Optional[str] = '1.0.0', title: str = 'validator', description: Optional[str] = 'opshin 0.21.1 Smart Contract', license: Optional[str] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>PlutusContract(contract: pycardano.plutus.PlutusV2Script, datum_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, redeemer_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, parameter_types: List[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = <factory>, purpose: Iterable[opshin.builder.Purpose] = (<Purpose.any: 'any'>,), version: Optional[str] = '1.0.0', title: str = 'validator', description: Optional[str] = 'opshin 0.21.0 Smart Contract', license: Optional[str] = None)</p></div>
<div class="desc"><p>PlutusContract(contract: pycardano.plutus.PlutusV2Script, datum_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, redeemer_type: Optional[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = None, parameter_types: List[Tuple[str, Type[Union[pycardano.plutus.PlutusData, dict, int, bytes, pycardano.serialization.IndefiniteList, pycardano.serialization.RawCBOR, pycardano.plutus.RawPlutusData]]]] = <factory>, purpose: Iterable[opshin.builder.Purpose] = (<Purpose.any: 'any'>,), version: Optional[str] = '1.0.0', title: str = 'validator', description: Optional[str] = 'opshin 0.21.1 Smart Contract', license: Optional[str] = None)</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/opshin/compiler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1156,7 +1156,7 @@ <h1 class="title">Module <code>opshin.compiler</code></h1>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="opshin.compiler.compile"><code class="name flex">
<span>def <span class="ident">compile</span></span>(<span>prog: ast.AST, filename=None, validator_function_name='validator', config=CompilationConfig(compress_patterns=False, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True)) ‑> pluthon.pluthon_ast.Program</span>
<span>def <span class="ident">compile</span></span>(<span>prog: ast.AST, filename=None, validator_function_name='validator', config=CompilationConfig(compress_patterns=True, iterative_unfold_patterns=False, constant_index_access_list=True, constant_folding=False, allow_isinstance_anything=False, force_three_params=False, remove_dead_code=True)) ‑> pluthon.pluthon_ast.Program</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/opshin/compiler_config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,16 @@ <h1 class="title">Module <code>opshin.compiler_config</code></h1>
)
OPT_O1_CONFIG = (
CompilationConfig()
.update(pluthon.OPT_O1_CONFIG)
.update(OPT_O0_CONFIG)
.update(pluthon.OPT_O1_CONFIG)
.update(
remove_dead_code=True,
)
)
OPT_O2_CONFIG = (
CompilationConfig()
.update(pluthon.OPT_O2_CONFIG)
.update(OPT_O1_CONFIG)
.update(pluthon.OPT_O2_CONFIG)
.update(
constant_folding=True,
)
Expand Down
18 changes: 9 additions & 9 deletions docs/opshin/fun_impls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -636,12 +636,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="opshin.types.PolymorphicFunction" href="types.html#opshin.types.PolymorphicFunction">PolymorphicFunction</a></li>
<li><a title="opshin.type_impls.PolymorphicFunction" href="type_impls.html#opshin.type_impls.PolymorphicFunction">PolymorphicFunction</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="opshin.fun_impls.LenImpl.impl_from_args"><code class="name flex">
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -673,7 +673,7 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="opshin.fun_impls.LenImpl.type_from_args"><code class="name flex">
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> <a title="opshin.types.FunctionType" href="types.html#opshin.types.FunctionType">FunctionType</a></span>
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> <a title="opshin.type_impls.FunctionType" href="type_impls.html#opshin.type_impls.FunctionType">FunctionType</a></span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -728,12 +728,12 @@ <h3>Methods</h3>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="opshin.types.PolymorphicFunction" href="types.html#opshin.types.PolymorphicFunction">PolymorphicFunction</a></li>
<li><a title="opshin.type_impls.PolymorphicFunction" href="type_impls.html#opshin.type_impls.PolymorphicFunction">PolymorphicFunction</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="opshin.fun_impls.PrintImpl.impl_from_args"><code class="name flex">
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand All @@ -759,7 +759,7 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="opshin.fun_impls.PrintImpl.type_from_args"><code class="name flex">
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> <a title="opshin.types.FunctionType" href="types.html#opshin.types.FunctionType">FunctionType</a></span>
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> <a title="opshin.type_impls.FunctionType" href="type_impls.html#opshin.type_impls.FunctionType">FunctionType</a></span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -1243,12 +1243,12 @@ <h3>Class variables</h3>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="opshin.types.PolymorphicFunction" href="types.html#opshin.types.PolymorphicFunction">PolymorphicFunction</a></li>
<li><a title="opshin.type_impls.PolymorphicFunction" href="type_impls.html#opshin.type_impls.PolymorphicFunction">PolymorphicFunction</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="opshin.fun_impls.ReversedImpl.impl_from_args"><code class="name flex">
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
<span>def <span class="ident">impl_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> pluthon.pluthon_ast.AST</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand All @@ -1273,7 +1273,7 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="opshin.fun_impls.ReversedImpl.type_from_args"><code class="name flex">
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.types.Type" href="types.html#opshin.types.Type">Type</a>]) ‑> <a title="opshin.types.FunctionType" href="types.html#opshin.types.FunctionType">FunctionType</a></span>
<span>def <span class="ident">type_from_args</span></span>(<span>self, args: List[<a title="opshin.type_impls.Type" href="type_impls.html#opshin.type_impls.Type">Type</a>]) ‑> <a title="opshin.type_impls.FunctionType" href="type_impls.html#opshin.type_impls.FunctionType">FunctionType</a></span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
17 changes: 10 additions & 7 deletions docs/opshin/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,10 @@ <h3 id="debugging-artefacts">Debugging artefacts</h3>
<h2 id="contributing">Contributing</h2>
<h3 id="developing-and-technical-documentation">Developing and Technical Documentation</h3>
<p>Generally, all contributions on the code side are very welcome.
To get an overview over the architecture and idea behind OpShin, check out <a href="./ARCHITECTURE.md">the Technical Documentation</a>.</p>
To get an overview over the architecture and idea behind OpShin, check out <a href="./ARCHITECTURE.md">the Technical Documentation</a>.
A bug bounty has been set up and funded by Project Catalyst, which awards <a href="https://github.com/OpShin/opshin/labels/bug%20bounty">Github issue</a> resolution wiht ADA rewards.
This is a great opportunity to get involved and earn some ADA.
Check out the <a href="./BUG_BOUNTY.md">detailed introduction to the bounty program</a> for more information.</p>
<h3 id="sponsoring">Sponsoring</h3>
<p>You can sponsor the development of opshin through GitHub or <a href="https://patreon.com/OpShin">Patreon</a> or just by sending ADA. Drop me a message on social media and let me know what it is for.</p>
<ul>
Expand Down Expand Up @@ -193,7 +196,7 @@ <h3 id="supporters">Supporters</h3>

import warnings

__version__ = &#34;0.21.0&#34;
__version__ = &#34;0.21.1&#34;
__author__ = &#34;nielstron&#34;
__author_email__ = &#34;[email protected]&#34;
__copyright__ = &#34;Copyright (C) 2023 nielstron&#34;
Expand Down Expand Up @@ -257,6 +260,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="opshin.type_impls" href="type_impls.html">opshin.type_impls</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="opshin.type_inference" href="type_inference.html">opshin.type_inference</a></code></dt>
<dd>
<div class="desc"><p>An aggressive type inference based on the work of Aycock [1].
Expand All @@ -267,10 +274,6 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="opshin.types" href="types.html">opshin.types</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="opshin.util" href="util.html">opshin.util</a></code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -373,9 +376,9 @@ <h1>Index</h1>
<li><code><a title="opshin.rewrite" href="rewrite/index.html">opshin.rewrite</a></code></li>
<li><code><a title="opshin.std" href="std/index.html">opshin.std</a></code></li>
<li><code><a title="opshin.tests" href="tests/index.html">opshin.tests</a></code></li>
<li><code><a title="opshin.type_impls" href="type_impls.html">opshin.type_impls</a></code></li>
<li><code><a title="opshin.type_inference" href="type_inference.html">opshin.type_inference</a></code></li>
<li><code><a title="opshin.typed_ast" href="typed_ast.html">opshin.typed_ast</a></code></li>
<li><code><a title="opshin.types" href="types.html">opshin.types</a></code></li>
<li><code><a title="opshin.util" href="util.html">opshin.util</a></code></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 6df5454

Please sign in to comment.