Merge pull request #44 from logicalmechanism/candidate-for-v0.4.0

candidate for v0.4.0
logical-mechanism · Dec 28, 2023 · 4dcec81 · 4dcec81
2 parents ca49d0e + f359e90
commit 4dcec81
Show file tree

Hide file tree

Showing 38 changed files with 1,840 additions and 295 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+# v0.4.0
+
+*This version is contains breaking changes.*
+
+- General data types from assist are now used in function definitions. See `types.ak`.
+- Refactored how assist types are used in functions.
+- `from_wallet` and `from_token` are now in addresses and values respectively.
+- Added `is_spending_input` to check if an output reference is being spent.
+- `total_token_amount` is moved to `tx.ak` and refactored.
+- Fail messages are more specific to the function.
+- All `&&` and `||` are now `and` and `or`.
+- Added `metadata` to find data from a cip68 metadatum type.
+
 # v0.3.4
 
 - Improved the counting functions to account for datum hashes.

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

diff --git a/docs/assist/addresses.html b/docs/assist/addresses.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>assist/addresses - aiken-lang/assist</title>
+    <title>assist/addresses - logicalmechanism/assist</title>
     <meta name="theme-color" content="#eff1f5" media="(prefers-color-scheme: light)"/>
     <meta name="theme-color" content="#1e1e2e" media="(prefers-color-scheme: dark)"/>
     <link rel="icon" type="image/svg+xml" sizes="any" href="../favicon.svg"/>
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.4 </span>
+          <span>v0.4.0 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.4";
+            const currentVersion = "v0.4.0";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -274,6 +274,18 @@ <h2>Modules</h2>
 
 	  </a></li>
 
+	  <li><a href="../assist/tx.html">
+
+	  assist/tx
+
+	  </a></li>
+
+	  <li><a href="../assist/types.html">
+
+	  assist/types
+
+	  </a></li>
+
 	  <li><a href="../assist/values.html">
 
 	  assist/values
@@ -301,6 +313,8 @@ <h2>Functions</h2>
 
   <li><a href="#create_script_address">create_script_address</a></li>
 
+  <li><a href="#from_wallet">from_wallet</a></li>
+
 </ul>
 
 
@@ -328,10 +342,7 @@ <h1 id="module-functions" class="module-member-kind">
 
   <div class="member">
     <div class="member-name">
-      <h2 id="create_address"><pre class="hljs language-aiken">create_address(
-  pkh: Hash&lt;Blake2b_224, VerificationKey&gt;,
-  sc: Hash&lt;Blake2b_224, VerificationKey&gt;,
-) -&gt; Address</pre></h2>
+      <h2 id="create_address"><pre class="hljs language-aiken">create_address(pkh: PublicKeyHash, sc: PublicKeyHash) -&gt; Address</pre></h2>
 
       <!-- TODO: support source linking
       <a class="member-source" alt="View Source" title="View Source" href="#todo">
@@ -349,10 +360,7 @@ <h2 id="create_address"><pre class="hljs language-aiken">create_address(
 
   <div class="member">
     <div class="member-name">
-      <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_address(
-  pkh: Hash&lt;Blake2b_224, Script&gt;,
-  sc: Hash&lt;Blake2b_224, Script&gt;,
-) -&gt; Address</pre></h2>
+      <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_address(pkh: ValidatorHash, sc: ValidatorHash) -&gt; Address</pre></h2>
 
       <!-- TODO: support source linking
       <a class="member-source" alt="View Source" title="View Source" href="#todo">
@@ -366,6 +374,23 @@ <h2 id="create_script_address"><pre class="hljs language-aiken">create_script_ad
 assumed to be not staked.</p>
 <pre><code class="language-aiken">addresses.create_script_address(datum.script.pkh, datum.script.sc)
 </code></pre>
+</div>
+  </div>
+
+  <div class="member">
+    <div class="member-name">
+      <h2 id="from_wallet"><pre class="hljs language-aiken">from_wallet(wallet: Wallet) -&gt; Address</pre></h2>
+
+      <!-- TODO: support source linking
+      <a class="member-source" alt="View Source" title="View Source" href="#todo">
+        &lt;/&gt;
+      </a>
+      -->
+
+    </div>
+    <div class="rendered-markdown"><p>Creates an address from the wallet type.</p>
+<pre><code class="language-aiken">let addr: Address = types.from_wallet(this_wallet)
+</code></pre>
 </div>
   </div>
 
@@ -442,8 +467,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=1702994576"></script>
+    <script src="../js/index.js?v=1703789625"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702994576"></script>
+    <script src="../search-data.js?v=1703789625"></script>
   </body>
 </html>
diff --git a/docs/assist/boolean.html b/docs/assist/boolean.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>assist/boolean - aiken-lang/assist</title>
+    <title>assist/boolean - logicalmechanism/assist</title>
     <meta name="theme-color" content="#eff1f5" media="(prefers-color-scheme: light)"/>
     <meta name="theme-color" content="#1e1e2e" media="(prefers-color-scheme: dark)"/>
     <link rel="icon" type="image/svg+xml" sizes="any" href="../favicon.svg"/>
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.4 </span>
+          <span>v0.4.0 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.4";
+            const currentVersion = "v0.4.0";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -274,6 +274,18 @@ <h2>Modules</h2>
 
 	  </a></li>
 
+	  <li><a href="../assist/tx.html">
+
+	  assist/tx
+
+	  </a></li>
+
+	  <li><a href="../assist/types.html">
+
+	  assist/types
+
+	  </a></li>
+
 	  <li><a href="../assist/values.html">
 
 	  assist/values
@@ -554,8 +566,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=1702994576"></script>
+    <script src="../js/index.js?v=1703789625"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702994576"></script>
+    <script src="../search-data.js?v=1703789625"></script>
   </body>
 </html>
diff --git a/docs/assist/certificates.html b/docs/assist/certificates.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>assist/certificates - aiken-lang/assist</title>
+    <title>assist/certificates - logicalmechanism/assist</title>
     <meta name="theme-color" content="#eff1f5" media="(prefers-color-scheme: light)"/>
     <meta name="theme-color" content="#1e1e2e" media="(prefers-color-scheme: dark)"/>
     <link rel="icon" type="image/svg+xml" sizes="any" href="../favicon.svg"/>
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.4 </span>
+          <span>v0.4.0 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.4";
+            const currentVersion = "v0.4.0";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -274,6 +274,18 @@ <h2>Modules</h2>
 
 	  </a></li>
 
+	  <li><a href="../assist/tx.html">
+
+	  assist/tx
+
+	  </a></li>
+
+	  <li><a href="../assist/types.html">
+
+	  assist/types
+
+	  </a></li>
+
 	  <li><a href="../assist/values.html">
 
 	  assist/values
@@ -325,10 +337,7 @@ <h1 id="module-functions" class="module-member-kind">
 
   <div class="member">
     <div class="member-name">
-      <h2 id="create_credential_delegation"><pre class="hljs language-aiken">create_credential_delegation(
-  sc: Hash&lt;Blake2b_224, Script&gt;,
-  pool_id: PoolId,
-) -&gt; Certificate</pre></h2>
+      <h2 id="create_credential_delegation"><pre class="hljs language-aiken">create_credential_delegation(sc: ValidatorHash, pool_id: PoolId) -&gt; Certificate</pre></h2>
 
       <!-- TODO: support source linking
       <a class="member-source" alt="View Source" title="View Source" href="#todo">
@@ -418,8 +427,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=1702994576"></script>
+    <script src="../js/index.js?v=1703789625"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702994576"></script>
+    <script src="../search-data.js?v=1703789625"></script>
   </body>
 </html>
diff --git a/docs/assist/circuits.html b/docs/assist/circuits.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>assist/circuits - aiken-lang/assist</title>
+    <title>assist/circuits - logicalmechanism/assist</title>
     <meta name="theme-color" content="#eff1f5" media="(prefers-color-scheme: light)"/>
     <meta name="theme-color" content="#1e1e2e" media="(prefers-color-scheme: dark)"/>
     <link rel="icon" type="image/svg+xml" sizes="any" href="../favicon.svg"/>
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.4 </span>
+          <span>v0.4.0 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.4";
+            const currentVersion = "v0.4.0";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -274,6 +274,18 @@ <h2>Modules</h2>
 
 	  </a></li>
 
+	  <li><a href="../assist/tx.html">
+
+	  assist/tx
+
+	  </a></li>
+
+	  <li><a href="../assist/types.html">
+
+	  assist/types
+
+	  </a></li>
+
 	  <li><a href="../assist/values.html">
 
 	  assist/values
@@ -546,8 +558,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=1702994576"></script>
+    <script src="../js/index.js?v=1703789625"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702994576"></script>
+    <script src="../search-data.js?v=1703789625"></script>
   </body>
 </html>
diff --git a/docs/assist/count.html b/docs/assist/count.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>assist/count - aiken-lang/assist</title>
+    <title>assist/count - logicalmechanism/assist</title>
     <meta name="theme-color" content="#eff1f5" media="(prefers-color-scheme: light)"/>
     <meta name="theme-color" content="#1e1e2e" media="(prefers-color-scheme: dark)"/>
     <link rel="icon" type="image/svg+xml" sizes="any" href="../favicon.svg"/>
@@ -120,13 +120,13 @@
       <h2>
         <a href="../">assist</a>
         <span id="project-version">
-          <span>v0.3.4 </span>
+          <span>v0.4.0 </span>
         </span>
         <script>
           "use strict";
 
           if ("undefined" !== typeof versionNodes) {
-            const currentVersion = "v0.3.4";
+            const currentVersion = "v0.4.0";
             if (! versionNodes.find(element => element.version === currentVersion)) {
               versionNodes.unshift({ version: currentVersion, url: "#" });
             }
@@ -274,6 +274,18 @@ <h2>Modules</h2>
 
 	  </a></li>
 
+	  <li><a href="../assist/tx.html">
+
+	  assist/tx
+
+	  </a></li>
+
+	  <li><a href="../assist/types.html">
+
+	  assist/types
+
+	  </a></li>
+
 	  <li><a href="../assist/values.html">
 
 	  assist/values
@@ -474,8 +486,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=1702994576"></script>
+    <script src="../js/index.js?v=1703789625"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1702994576"></script>
+    <script src="../search-data.js?v=1703789625"></script>
   </body>
 </html>