Merge pull request #101 from logical-mechanism/fixing-docs-for-registry

Fixing docs for registry

.github/workflows/continuous-integration.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: aiken-lang/setup-aiken@v1
         with:
-          version: v1.1.4
+          version: v1.1.5
       - run: aiken fmt --check
       - run: aiken check -D
       - run: aiken build

CHANGELOG.md

@@ -1,5 +1,9 @@
 # v0.x.y
 
+- Cleaning up registry documentation
+- Fiat Shamir transform is now public
+- The blake2b_224 hash is now used for the fiat shamir transform
+
 # v0.5.1
 
 *This version is contains breaking changes.*

README.md

@@ -6,7 +6,7 @@ The **Aiken Assist Library** is a collection of specialized functions for [Aiken
 
 aiken's version | assist's version
 ---             | ---
-`v1.1.4`        | `>= v0.5.1`
+`v1.1.5`        | `>= v0.5.1`
 `v1.0.29-alpha` | `== v0.4.11`
 
 Assist library `v0.5.x+` will be Plutus V3+. For Plutus V2 contracts use the `v0.4.11` branch.

docs/cardano/addresses.html

@@ -598,9 +598,9 @@ <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_ad
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/cardano/certificates.html

@@ -548,9 +548,9 @@ <h2 id="delegate_credential"><pre class="hljs language-aiken">delegate_credentia
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/cardano/datum.html

@@ -617,9 +617,9 @@ <h2 id="output_datum_by_hash"><pre class="hljs language-aiken">output_datum_by_h
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/cardano/minting.html

@@ -634,9 +634,9 @@ <h2 id="quantity_of"><pre class="hljs language-aiken">quantity_of(
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/cardano/tx.html

@@ -669,9 +669,9 @@ <h2 id="total_token_amount"><pre class="hljs language-aiken">total_token_amount(
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/cardano/value.html

@@ -709,9 +709,9 @@ <h2 id="prove_exact_nft"><pre class="hljs language-aiken">prove_exact_nft(
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/index.html

@@ -380,7 +380,7 @@ <h1>Aiken Assist Library</h1>
 <p>The <strong>Aiken Assist Library</strong> is a collection of specialized functions for <a href="https://github.com/aiken-lang/aiken">Aiken</a>. This library extends the default functionality of <a href="https://github.com/aiken-lang/stdlib">stdlib</a> and provides routines that facilitate quick development of smart contracts on Cardano.</p>
 <h2>Compatibility</h2>
 <table><thead><tr><th>aiken’s version</th><th>assist’s version</th></tr></thead><tbody>
-<tr><td><code>v1.1.4</code></td><td><code>&gt;= v0.5.1</code></td></tr>
+<tr><td><code>v1.1.5</code></td><td><code>&gt;= v0.5.1</code></td></tr>
 <tr><td><code>v1.0.29-alpha</code></td><td><code>== v0.4.11</code></td></tr>
 </tbody></table>
 <p>Assist library <code>v0.5.x+</code> will be Plutus V3+. For Plutus V2 contracts use the <code>v0.4.11</code> branch.</p>
@@ -536,9 +536,9 @@ <h2>License</h2>
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="./js/lunr.min.js?v=1.1.5"></script>
-    <script src="./js/index.js?v=1731094584"></script>
+    <script src="./js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=1731094584"></script>
+    <script src="./search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/maths/boolean.html

@@ -694,9 +694,9 @@ <h2 id="imply_"><pre class="hljs language-aiken">imply_(x: Int, y: Int) -&gt; In
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/maths/circuits.html

@@ -686,9 +686,9 @@ <h2 id="imply_"><pre class="hljs language-aiken">imply_(x: Int, y: Int, p: Int)
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/maths/constants.html

@@ -539,9 +539,9 @@ <h2 id="large_prime"><pre class="hljs language-aiken">large_prime: Int = 0x1a011
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/maths/routines.html

@@ -613,9 +613,9 @@ <h2 id="from_int"><pre class="hljs language-aiken">from_int(self: Int) -&gt; Byt
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/tests/fake_tx.html

@@ -856,9 +856,9 @@ <h2 id="test_tx"><pre class="hljs language-aiken">test_tx() -&gt; Transaction</p
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/cip68.html

@@ -681,9 +681,9 @@ <h2 id="version"><pre class="hljs language-aiken">version(metadata: CIP68) -&gt;
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/moment.html

@@ -703,9 +703,9 @@ <h2 id="is_before"><pre class="hljs language-aiken">is_before(m: Moment, vr: Val
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/prefixes.html

@@ -565,9 +565,9 @@ <h2 id="seed"><pre class="hljs language-aiken">seed: ByteArray = #&quot;5eed0e1f
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/registry.html

@@ -203,20 +203,9 @@ <h2>Functions</h2>
 <ul>
 
 
-        <li data-heading="1"><a href="#%2297f1d3a73197d7942695638c4fa9ac0fc3688c4f9774b905a14e3a3f171bac586c55e83ff97a1aeffb3af00adb22c6bb%22%2C">&quot;97f1d3a73197d7942695638c4fa9ac0fc3688c4f9774b905a14e3a3f171bac586c55e83ff97a1aeffb3af00adb22c6bb&quot;,</a></li>
-
-
-
-        <li data-heading="1"><a href="#%2281b223cea171a87feba9b7749a2df7601c5a75ae01155fadc124a2ac49099a514cf1e7d9cdc769dceab14a95bd6cb0bd%22%2C">&quot;81b223cea171a87feba9b7749a2df7601c5a75ae01155fadc124a2ac49099a514cf1e7d9cdc769dceab14a95bd6cb0bd&quot;,</a></li>
-
-
-
-        <li data-heading="1"><a href="#%22a09d99e02f7200526dc55ef722cc171e7aa14fc732614c02ac58d59d7026a7eb18d8798f6928ea2b513f3a4feb0c94d1%22%2C">&quot;a09d99e02f7200526dc55ef722cc171e7aa14fc732614c02ac58d59d7026a7eb18d8798f6928ea2b513f3a4feb0c94d1&quot;,</a></li>
-
-
-
-        <li data-heading="1"><a href="#%22acab%22%2C">&quot;acab&quot;,</a></li>
-
+        <li><a href="#fiat_shamir_heuristic">fiat_shamir_heuristic</a></li>
+
+
 
 
         <li><a href="#prove">prove</a></li>
@@ -473,28 +462,26 @@ <h1 id="module-functions" class="module-member-kind">
   </h1>
 
 
-
-        <h2 id="%2297f1d3a73197d7942695638c4fa9ac0fc3688c4f9774b905a14e3a3f171bac586c55e83ff97a1aeffb3af00adb22c6bb%22%2C" class="module-heading"><a href="#%2297f1d3a73197d7942695638c4fa9ac0fc3688c4f9774b905a14e3a3f171bac586c55e83ff97a1aeffb3af00adb22c6bb%22%2C">&quot;97f1d3a73197d7942695638c4fa9ac0fc3688c4f9774b905a14e3a3f171bac586c55e83ff97a1aeffb3af00adb22c6bb&quot;,</a></h2>
-
-
-
-
-
-        <h2 id="%2281b223cea171a87feba9b7749a2df7601c5a75ae01155fadc124a2ac49099a514cf1e7d9cdc769dceab14a95bd6cb0bd%22%2C" class="module-heading"><a href="#%2281b223cea171a87feba9b7749a2df7601c5a75ae01155fadc124a2ac49099a514cf1e7d9cdc769dceab14a95bd6cb0bd%22%2C">&quot;81b223cea171a87feba9b7749a2df7601c5a75ae01155fadc124a2ac49099a514cf1e7d9cdc769dceab14a95bd6cb0bd&quot;,</a></h2>
-
-
-
-
-
-        <h2 id="%22a09d99e02f7200526dc55ef722cc171e7aa14fc732614c02ac58d59d7026a7eb18d8798f6928ea2b513f3a4feb0c94d1%22%2C" class="module-heading"><a href="#%22a09d99e02f7200526dc55ef722cc171e7aa14fc732614c02ac58d59d7026a7eb18d8798f6928ea2b513f3a4feb0c94d1%22%2C">&quot;a09d99e02f7200526dc55ef722cc171e7aa14fc732614c02ac58d59d7026a7eb18d8798f6928ea2b513f3a4feb0c94d1&quot;,</a></h2>
-
-
-
-
-
-        <h2 id="%22acab%22%2C" class="module-heading"><a href="#%22acab%22%2C">&quot;acab&quot;,</a></h2>
-
-
+      <div class="member">
+        <div class="member-name">
+          <h2 id="fiat_shamir_heuristic"><pre class="hljs language-aiken">fiat_shamir_heuristic(
+  g_b: ByteArray,
+  g_r_b: ByteArray,
+  u_b: ByteArray,
+  b: ByteArray,
+) -&gt; ByteArray</pre></h2>
+
+      	    <a class="member-source" alt="view source" title="view source" target="_blank" href="https://github.com/logical-mechanism/Assist/blob/v0.5.1/lib/types/registry.ak#L59-L76"></a>
+
+        </div>
+        <div class="rendered-markdown"><p>A bytearray of a value for the challenge c. This process should act like a
+random oracle providing a large challenge value for the user. The inputs
+should be compressed g1 elements but they can also be compressed integers.</p>
+<pre><code class="language-aiken">registry.fiat_shamir_heuristic(g_b, g_r_b, u_b, b)
+</code></pre>
+</div>
+      </div>
+
 
 
       <div class="member">
@@ -506,7 +493,7 @@ <h2 id="prove"><pre class="hljs language-aiken">prove(
   bound: ByteArray,
 ) -&gt; Bool</pre></h2>
 
-      	    <a class="member-source" alt="view source" title="view source" target="_blank" href="https://github.com/logical-mechanism/Assist/blob/v0.5.1/lib/types/registry.ak#L108-L130"></a>
+      	    <a class="member-source" alt="view source" title="view source" target="_blank" href="https://github.com/logical-mechanism/Assist/blob/v0.5.1/lib/types/registry.ak#L99-L121"></a>
 
         </div>
         <div class="rendered-markdown"><p>A Schnorr proof to prove knowledge of the secret value x without revealing
@@ -641,9 +628,9 @@ <h2 id="prove"><pre class="hljs language-aiken">prove(
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/token.html

@@ -831,9 +831,9 @@ <h2 id="contains"><pre class="hljs language-aiken">contains(total: Tokens, targe
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/types/wallet.html

@@ -639,9 +639,9 @@ <h2 id="is_valid"><pre class="hljs language-aiken">is_valid(wallet: Wallet) -&gt
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/validation/count.html

@@ -680,9 +680,9 @@ <h2 id="single_input_with_bypass"><pre class="hljs language-aiken">single_input_
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/validation/find.html

@@ -818,9 +818,9 @@ <h2 id="input_by_nft"><pre class="hljs language-aiken">input_by_nft(inputs: List
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {

docs/validation/payout.html

@@ -577,9 +577,9 @@ <h2 id="at_least"><pre class="hljs language-aiken">at_least(
     <script src="https://unpkg.com/@popperjs/core@2"></script>
     <script src="https://unpkg.com/tippy.js@6"></script>
     <script src="../js/lunr.min.js?v=1.1.5"></script>
-    <script src="../js/index.js?v=1731094584"></script>
+    <script src="../js/index.js?v=1731262126"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1731094584"></script>
+    <script src="../search-data.js?v=1731262126"></script>
     <script>
       void function() {
         if (typeof tippy !== "undefined") {