Merge pull request #43 from logicalmechanism/candidate-for-v0.3.4

Candidate for v0.3.4
logical-mechanism · Dec 19, 2023 · ca49d0e · ca49d0e
2 parents b367c93 + 6f0575c
commit ca49d0e
Show file tree

Hide file tree

Showing 31 changed files with 200 additions and 121 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v0.3.4
+
+- Improved the counting functions to account for datum hashes.
+- Improved documentation.
+
 # v0.3.3
 
 - Added arithmetic circuit and boolean logic

diff --git a/aiken.toml b/aiken.toml
@@ -1,5 +1,5 @@
 name = "aiken-lang/assist"
-version = "0.3.3"
+version = "0.3.4"
 license = "Apache-2.0"
 description = "Aiken Assist Library"
 

diff --git a/docs/assist/addresses.html b/docs/assist/addresses.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -313,7 +313,7 @@ <h1 id="module-name" class="module-name">
 </h1>
 <p>This module incorporates code for generating valid wallet and script 
 addresses, ensuring their correctness. Empty keys are treated as 
-intentional, and address subtypes are not combined or mixed.</p>
+intentional, and address subtypes are not combined nor mixed.</p>
 
 
 
@@ -442,8 +442,8 @@ <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_ad
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/boolean.html b/docs/assist/boolean.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -348,7 +348,7 @@ <h2 id="and_"><pre class="hljs language-aiken">and_(x: Int, y: Int) -&gt; Int</p
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical AND operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>AND</code> operation on two integer values.
 Expects both inputs as binary (0 or 1) and returns 1 if both are 1, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.and_(1, 1)
 </code></pre>
@@ -384,7 +384,7 @@ <h2 id="nand_"><pre class="hljs language-aiken">nand_(x: Int, y: Int) -&gt; Int<
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NAND operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>NAND</code> operation on two integer values.
 Returns 1 if at least one input is 0, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.nand_(1, 1)
 </code></pre>
@@ -402,7 +402,7 @@ <h2 id="nor_"><pre class="hljs language-aiken">nor_(x: Int, y: Int) -&gt; Int</p
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NOR operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>NOR</code> operation on two integer values.
 Returns 1 if both inputs are 0, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.nor_(0, 0)
 </code></pre>
@@ -420,7 +420,7 @@ <h2 id="not_"><pre class="hljs language-aiken">not_(x: Int) -&gt; Int</pre></h2>
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NOT operation on an integer value.
+    <div class="rendered-markdown"><p>Performs a logical <code>NOT</code> operation on an integer value.
 Expects the input as binary (0 or 1) and returns the inverse (1 becomes 0, 0 becomes 1).</p>
 <pre><code class="language-aiken">boolean.not_(1)
 </code></pre>
@@ -438,7 +438,7 @@ <h2 id="or_"><pre class="hljs language-aiken">or_(x: Int, y: Int) -&gt; Int</pre
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical OR operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>OR</code> operation on two integer values.
 Expects both inputs as binary (0 or 1) and returns 1 if at least one input is 1, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.or_(0, 1)
 </code></pre>
@@ -456,7 +456,7 @@ <h2 id="xnor_"><pre class="hljs language-aiken">xnor_(x: Int, y: Int) -&gt; Int<
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical XNOR operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>XNOR</code> operation on two integer values.
 Returns 1 if the inputs are the same, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.xnor_(1, 1)
 </code></pre>
@@ -474,7 +474,7 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int) -&gt; Int</p
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical XOR operation on two integer values.
+    <div class="rendered-markdown"><p>Performs a logical <code>XOR</code> operation on two integer values.
 Expects both inputs as binary (0 or 1) and returns 1 if the inputs are different, otherwise returns 0.</p>
 <pre><code class="language-aiken">boolean.xor_(0, 1)
 </code></pre>
@@ -554,8 +554,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int) -&gt; Int</p
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/certificates.html b/docs/assist/certificates.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -309,6 +309,8 @@ <h2>Functions</h2>
 <h1 id="module-name" class="module-name">
   <a href="#module-name">assist/certificates</a>
 </h1>
+<p>This module incorporates code for generating valid certificates,
+ensuring their correctness. </p>
 
 
 
@@ -416,8 +418,8 @@ <h2 id="create_credential_delegation"><pre class="hljs language-aiken">create_cr
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/circuits.html b/docs/assist/circuits.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -348,7 +348,7 @@ <h2 id="and_"><pre class="hljs language-aiken">and_(x: Int, y: Int, p: Int) -&gt
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical AND operation on two integer values within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>AND</code> operation on two integer values within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.and_(1, 1, p)
 </code></pre>
 </div>
@@ -382,7 +382,7 @@ <h2 id="nand_"><pre class="hljs language-aiken">nand_(x: Int, y: Int, p: Int) -&
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NAND operation on two integer values within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>NAND</code> operation on two integer values within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.nand_(1, 1, p)
 </code></pre>
 </div>
@@ -399,7 +399,7 @@ <h2 id="nor_"><pre class="hljs language-aiken">nor_(x: Int, y: Int, p: Int) -&gt
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NOR operation on two integer values within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>NOR</code> operation on two integer values within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.nor_(0, 0, p)
 </code></pre>
 </div>
@@ -416,7 +416,7 @@ <h2 id="not_"><pre class="hljs language-aiken">not_(x: Int, p: Int) -&gt; Int</p
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical NOT operation on an integer value within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>NOT</code> operation on an integer value within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.not_(1, p)
 </code></pre>
 </div>
@@ -433,7 +433,7 @@ <h2 id="or_"><pre class="hljs language-aiken">or_(x: Int, y: Int, p: Int) -&gt;
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical OR operation on two integer values within an arithmetic circuit..</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>OR</code> operation on two integer values within an arithmetic circuit..</p>
 <pre><code class="language-aiken">circuits.or_(0, 1, p)
 </code></pre>
 </div>
@@ -450,7 +450,7 @@ <h2 id="xnor_"><pre class="hljs language-aiken">xnor_(x: Int, y: Int, p: Int) -&
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical XNOR operation on two integer values within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>XNOR</code> operation on two integer values within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.xnor_(1, 1, p)
 </code></pre>
 </div>
@@ -467,7 +467,7 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int, p: Int) -&gt
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Performs a logical XOR operation on two integer values within an arithmetic circuit.</p>
+    <div class="rendered-markdown"><p>Performs a logical <code>XOR</code> operation on two integer values within an arithmetic circuit.</p>
 <pre><code class="language-aiken">circuits.xor_(0, 1, p)
 </code></pre>
 </div>
@@ -546,8 +546,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int, p: Int) -&gt
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/count.html b/docs/assist/count.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -316,7 +316,7 @@ <h1 id="module-name" class="module-name">
   <a href="#module-name">assist/count</a>
 </h1>
 <p>This module contains code to accurately count the number of inputs and
-outputs in a transaction for a specific address, assuming precise amounts.</p>
+outputs in a transaction containing an address or a datum.</p>
 
 
 
@@ -358,7 +358,7 @@ <h2 id="inputs_by_datum"><pre class="hljs language-aiken">inputs_by_datum(inputs
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Verify that the number of inputs with an inline datum is equal to the
+    <div class="rendered-markdown"><p>Verify that the number of inputs with an inline datum or datum hash is equal to the
 number intended in the contract. The amount must be exactly the counter.</p>
 <pre><code class="language-aiken">count.inputs_by_datum(tx.inputs, 1)
 </code></pre>
@@ -394,7 +394,7 @@ <h2 id="outputs_by_datum"><pre class="hljs language-aiken">outputs_by_datum(outp
       -->
 
     </div>
-    <div class="rendered-markdown"><p>Verify that the number of outputs with an inline datum is equal to the
+    <div class="rendered-markdown"><p>Verify that the number of outputs with an inline datum or datum hash is equal to the
 number intended in the contract. The amount must be exactly the counter.</p>
 <pre><code class="language-aiken">count.outputs_by_datum(tx.outputs, 1)
 </code></pre>
@@ -474,8 +474,8 @@ <h2 id="outputs_by_datum"><pre class="hljs language-aiken">outputs_by_datum(outp
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/credentials.html b/docs/assist/credentials.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -336,7 +336,7 @@ <h2 id="create_stake_credential"><pre class="hljs language-aiken">create_stake_c
     </div>
     <div class="rendered-markdown"><p>Creates a stake credential from the hex encoding of a stake key.
 This can be used to find the reward amount from the withdrawals 
-information inside the transaction of the form Dict&lt;StakeCredential, Int&gt;</p>
+information inside the transaction of the form <code>Dict&lt;StakeCredential, Int&gt;</code>.</p>
 <pre><code class="language-aiken">credentials.create_stake_credential(datum.contract_hash)
 </code></pre>
 </div>
@@ -415,8 +415,8 @@ <h2 id="create_stake_credential"><pre class="hljs language-aiken">create_stake_c
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>
diff --git a/docs/assist/data.html b/docs/assist/data.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.3 </span>
+          <span>v0.3.4 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.3";
+            const currentVersion = "v0.3.4";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -481,8 +481,8 @@ <h2 id="output_datum_by_hash"><pre class="hljs language-aiken">output_datum_by_h
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1702825671"></script>
+    <script src="../js/index.js?v=1702994576"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702825671"></script>
+    <script src="../search-data.js?v=1702994576"></script>
   </body>
 </html>