Merge pull request #58 from logicalmechanism/candidate-for-v0.4.2

updating v0.4.1 to v0.4.2
logical-mechanism · Jan 22, 2024 · ef37859 · ef37859
2 parents caad8f4 + 294a71e
commit ef37859
Show file tree

Hide file tree

Showing 28 changed files with 139 additions and 113 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # v0.x.y
 
+# v0.4.2
+
 - Updated moment `is_contained` to check if a validity range is inside a moment.
 - Wrote additional tests for moment and payout
 - Updated README

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -32,7 +32,7 @@
 
    Please add an entry into [CHANGELOG.md](./CHANGELOG.md) when submitting changes. New entries should go into the top `# v0.x.y` section. This let's us keep track of unreleased changes for use in release notes.
 
-   Once a release is ready `# v0.x.y` gets replaced with a version number, i.e. `# v0.4.2`. Usually the maintainers will handle the section renaming along with creating a new empty `# v0.x.y` section at the top of the changelog.
+   Once a release is ready `# v0.x.y` gets replaced with a version number, i.e. `# v0.4.0`. Usually the maintainers will handle the section renaming along with creating a new empty `# v0.x.y` section at the top of the changelog.
 
    Example: 
 

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ To start using the library, follow these steps:
 ```toml
 [[dependencies]]
 name = "logicalmechanism/assist"
-version = "v0.4.1"
+version = "v0.4.2"
 source = "github"
 ```
 
@@ -26,7 +26,7 @@ rm -fr build || true
 aiken check
 ```
 
-- Stay up to date by updating the version to the newest tag when applicable, i.e. `v0.4.1` -> `v0.4.x`.
+- Stay up to date by updating the version to the newest tag when applicable, i.e. `v0.4.2` -> `v0.4.x`.
 
 ## Usage
 

diff --git a/aiken.toml b/aiken.toml
@@ -1,5 +1,5 @@
 name = "logicalmechanism/assist"
-version = "0.4.1"
+version = "0.4.2"
 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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -376,15 +376,16 @@ <h2 id="create_address"><pre class="hljs language-aiken">create_address(pkh: Pub
 
     </div>
     <div class="rendered-markdown"><p>Creates a enterprise or base address from the public key hash and stake
-credential. An empty sc means enterpise address by default.</p>
+credential. An empty sc means enterpise address by default. This function
+assumes proper key lengths for <code>pkh</code> and <code>sc</code>.</p>
 <pre><code class="language-aiken">addresses.create_address(datum.wallet.pkh, datum.wallet.sc)
 </code></pre>
 </div>
   </div>
 
   <div class="member">
     <div class="member-name">
-      <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_address(pkh: ValidatorHash, sc: ValidatorHash) -&gt; Address</pre></h2>
+      <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_address(vkh: ValidatorHash, sc: ValidatorHash) -&gt; Address</pre></h2>
 
       <!-- TODO: support source linking
       <a class="member-source" alt="View Source" title="View Source" href="#todo">
@@ -395,8 +396,9 @@ <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_ad
     </div>
     <div class="rendered-markdown"><p>Creates a script address for a smart contract. The type does not mix address
 types. Staked smart contracts are contracts as well. An empty sc is
-assumed to be not staked.</p>
-<pre><code class="language-aiken">addresses.create_script_address(datum.script.pkh, datum.script.sc)
+assumed to be not staked. This function assumes proper key lengths for <code>vkh</code>
+and <code>sc</code>.</p>
+<pre><code class="language-aiken">addresses.create_script_address(datum.script.vkh, datum.script.sc)
 </code></pre>
 </div>
   </div>
@@ -491,8 +493,8 @@ <h2 id="from_wallet"><pre class="hljs language-aiken">from_wallet(wallet: Wallet
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -590,8 +590,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=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -451,8 +451,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=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -582,8 +582,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=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -536,8 +536,8 @@ <h2 id="single_input_with_bypass"><pre class="hljs language-aiken">single_input_
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -451,8 +451,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=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></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.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -538,8 +538,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=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></script>
   </body>
 </html>
diff --git a/docs/assist/find.html b/docs/assist/find.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -691,8 +691,8 @@ <h2 id="stake_reward_by_sc"><pre class="hljs language-aiken">stake_reward_by_sc(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></script>
   </body>
 </html>
diff --git a/docs/assist/maths.html b/docs/assist/maths.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -714,8 +714,8 @@ <h2 id="to_int"><pre class="hljs language-aiken">to_int(self: ByteArray) -&gt; I
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></script>
   </body>
 </html>
diff --git a/docs/assist/minting.html b/docs/assist/minting.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -510,8 +510,8 @@ <h2 id="is_occurring"><pre class="hljs language-aiken">is_occurring(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></script>
   </body>
 </html>
diff --git a/docs/assist/payout.html b/docs/assist/payout.html
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.4.1 </span>
+          <span>v0.4.2 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.4.1";
+            const currentVersion = "v0.4.2";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -499,8 +499,8 @@ <h2 id="exact"><pre class="hljs language-aiken">exact(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.21-alpha"></script>
-    <script src="../js/index.js?v=1705877441"></script>
+    <script src="../js/index.js?v=1705952101"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1705877441"></script>
+    <script src="../search-data.js?v=1705952101"></script>
   </body>
 </html>