Transaction builder

elm.json

@@ -8,6 +8,7 @@
         "Bytes.Comparable",
         "Bytes.Crc8",
         "Bytes.Map",
+        "Cardano",
         "Cardano.Address",
         "Cardano.Cip30",
         "Cardano.Cip67",
@@ -33,7 +34,8 @@
         "elm/core": "1.0.5 <= v < 2.0.0",
         "elm/json": "1.1.3 <= v < 2.0.0",
         "elm-toulouse/cbor": "4.0.1 <= v < 5.0.0",
-        "jxxcarlson/hex": "4.0.0 <= v < 5.0.0"
+        "jxxcarlson/hex": "4.0.0 <= v < 5.0.0",
+        "turboMaCk/any-dict": "2.6.0 <= v < 3.0.0"
     },
     "test-dependencies": {
         "elm-community/result-extra": "2.4.0 <= v < 3.0.0",

examples/ogmios/elm.json

@@ -15,7 +15,8 @@
             "elm/html": "1.0.0",
             "elm/json": "1.1.3",
             "elm-toulouse/cbor": "4.0.1",
-            "jxxcarlson/hex": "4.0.0"
+            "jxxcarlson/hex": "4.0.0",
+            "turboMaCk/any-dict": "2.6.0"
         },
         "indirect": {
             "elm/time": "1.0.0",

examples/txbuild/.gitignore

@@ -0,0 +1 @@
+main.js

examples/txbuild/Main.elm

@@ -0,0 +1,40 @@
+module Main exposing (main)
+
+import Browser
+import Cardano
+import Html exposing (Html, div, text)
+
+
+main : Program () () ()
+main =
+    Browser.element
+        { init = \_ -> ( (), Cmd.none )
+        , update = \_ _ -> ( (), Cmd.none )
+        , subscriptions = \_ -> Sub.none
+        , view = view
+        }
+
+
+example ex =
+    case ex () of
+        Err error ->
+            error
+
+        Ok tx ->
+            Cardano.prettyTx tx
+
+
+
+-- VIEW
+
+
+view : () -> Html ()
+view _ =
+    div []
+        [ div [] [ text "Example transaction 1: send 1 ada from me to you" ]
+        , Html.pre [] [ text <| example Cardano.example1 ]
+        , div [] [ text "Example transaction 2: mint dog & burn 1 cat" ]
+        , Html.pre [] [ text <| example Cardano.example2 ]
+        , div [] [ text "Example transaction 3: spend 1 ada from a plutus script with 2 ada" ]
+        , Html.pre [] [ text <| example Cardano.example3 ]
+        ]

examples/txbuild/README.md

@@ -0,0 +1,3 @@
+```sh
+npx elm-watch hot
+```

examples/txbuild/elm-cardano.js

@@ -0,0 +1,84 @@
+function initElmCardanoJs(app) {
+    app.ports.toWallet.subscribe(async (value) => {
+        console.log("Received value destined to wallet:", value)
+        try {
+            if (value.requestType == "cip30-discover") {
+                const wallets = await concurrentHandleCip30Discover()
+                app.ports.fromWallet.send({responseType: "cip30-discover", wallets})
+            } else if (value.requestType == "cip30-enable") {
+                const {descriptor, api, walletHandle} = await enableCip30Wallet(value.id, value.extensions)
+                app.ports.fromWallet.send({responseType: "cip30-enable", descriptor, api, walletHandle})
+            } else if (value.requestType == "cip30-api") {
+                const apiResponse = await handleApiRequest(value)
+                app.ports.fromWallet.send(apiResponse)
+            }
+        } catch (error) {
+            app.ports.fromWallet.send({responseType: "cip30-error", error: error})
+        }
+    })
+
+    async function concurrentHandleCip30Discover() {
+        const wallets = []
+        if ("cardano" in window) {
+            const startTime = performance.now()
+            const walletsPromises = Object.keys(window.cardano).map(walletDescriptor)
+            const results = await Promise.allSettled(walletsPromises)
+            results.forEach(result => { if (result.status === 'fulfilled') {
+                wallets.push(result.value)
+            }});
+            const endTime = performance.now()
+            console.log(`Cardano CIP30 wallets discovered in ${endTime - startTime} ms:`, wallets)
+        } else {
+            console.log("Well there isn't any Cardano wallet here ^^")
+        }
+        return wallets
+    }
+
+    async function walletDescriptor(walletId) {
+        const startTime = performance.now()
+        const wallet = window.cardano[walletId]
+        for (const key of ["name", "icon", "apiVersion", "isEnabled"]) {
+            if (!(key in wallet)) throw new Error(`Missing expected key in wallet '${walletId}': ${key}`)
+        }
+        const descriptor = {
+            id : walletId,
+            name : wallet.name,
+            icon : wallet.icon,
+            apiVersion : wallet.apiVersion,
+            supportedExtensions : wallet.supportedExtensions || [],
+            isEnabled : await wallet.isEnabled(),
+        }
+        const endTime = performance.now()
+        console.log(`${walletId} discovered in ${endTime - startTime} ms:`)
+        return descriptor
+    }
+
+    async function enableCip30Wallet(walletId, extensionsIds) {
+        const extensions = extensionsIds.map((cipId) => ({cip: cipId}))
+        if (walletId in window.cardano) {
+            const walletHandle = window.cardano[walletId]
+            // const api = await walletHandle.enable({extensions}) // Eternl incorrect handle of CIP30 enable
+            const api = await walletHandle.enable(extensions) // Eternl incorrect handle of CIP30 enable
+            const descriptor = await walletDescriptor(walletId)
+            return {descriptor, api, walletHandle}
+        } else {
+            throw new Error("Wallet ID does not correspond to any installed wallet: " + walletId)
+        }
+    }
+
+    async function handleApiRequest({id, api, method, args}) {
+        if (id in window.cardano) {
+            // Replace "null" by "undefined" in the args array
+            correctArgs = args.map(item => item === null ? undefined : item)
+            const response = await api[method](...correctArgs)
+            return {
+                responseType: "cip30-api",
+                walletId: id,
+                method,
+                response,
+            }
+        } else {
+            throw new Error("Wallet ID does not correspond to any installed wallet: " + walletId)
+        }
+    }
+}

examples/txbuild/elm-watch.json

@@ -0,0 +1,11 @@
+{
+    "serve": ".",
+    "targets": {
+        "main": {
+            "inputs": [
+                "Main.elm"
+            ],
+            "output": "main.js"
+        }
+    }
+}

examples/txbuild/elm.json

@@ -0,0 +1,33 @@
+{
+    "type": "application",
+    "source-directories": [
+        ".",
+        "../../src"
+    ],
+    "elm-version": "0.19.1",
+    "dependencies": {
+        "direct": {
+            "dwayne/elm-integer": "1.0.0",
+            "dwayne/elm-natural": "1.1.1",
+            "elm/browser": "1.0.2",
+            "elm/bytes": "1.0.8",
+            "elm/core": "1.0.5",
+            "elm/html": "1.0.0",
+            "elm/json": "1.1.3",
+            "elm-toulouse/cbor": "4.0.1",
+            "jxxcarlson/hex": "4.0.0",
+            "turboMaCk/any-dict": "2.6.0"
+        },
+        "indirect": {
+            "elm/time": "1.0.0",
+            "elm/url": "1.0.0",
+            "elm/virtual-dom": "1.0.3",
+            "elm-community/list-extra": "8.7.0",
+            "elm-toulouse/float16": "1.0.1"
+        }
+    },
+    "test-dependencies": {
+        "direct": {},
+        "indirect": {}
+    }
+}

examples/txbuild/index.html

@@ -0,0 +1,19 @@
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Main</title>
+        <script src="main.js"></script>
+        <script src="elm-cardano.js"></script>
+    </head>
+
+    <body>
+        <div id="myapp"></div>
+        <script>
+            var app = Elm.Main.init({
+                node: document.getElementById("myapp"),
+                flags: null,
+            });
+            // initElmCardanoJs(app)
+        </script>
+    </body>
+</html>

examples/wallet-cip30/elm.json

@@ -15,7 +15,8 @@
             "elm/html": "1.0.0",
             "elm/json": "1.1.3",
             "elm-toulouse/cbor": "4.0.1",
-            "jxxcarlson/hex": "4.0.0"
+            "jxxcarlson/hex": "4.0.0",
+            "turboMaCk/any-dict": "2.6.0"
         },
         "indirect": {
             "elm/time": "1.0.0",

src/Bytes/Comparable.elm

@@ -2,17 +2,21 @@ module Bytes.Comparable exposing
     ( Bytes
     , Any, toAny
     , chunksOf, width, isEmpty
-    , bytes, fromBytes, fromString, fromStringUnchecked
-    , toBytes, toString, toCbor, toU8
+    , bytes, fromBytes, fromString, fromStringUnchecked, fromText
+    , toBytes, toString, toText, toCbor, toU8
     )
 
 {-| Comparable Bytes
 
+-- TODO: Because we rely on the sorting of the hex string,
+-- it is super important to check that we only use
+-- lower case OR upper case letters, but no mix
+
 @docs Bytes
 @docs Any, toAny
 @docs chunksOf, width, isEmpty
-@docs bytes, fromBytes, fromString, fromStringUnchecked
-@docs toBytes, toString, toCbor, toU8
+@docs bytes, fromBytes, fromString, fromStringUnchecked, fromText
+@docs toBytes, toString, toText, toCbor, toU8
 
 -}
 
@@ -82,6 +86,13 @@ fromStringUnchecked =
     Bytes
 
 
+{-| Create a [Bytes] with some text encoded as UTF8.
+-}
+fromText : String -> Bytes a
+fromText str =
+    E.encode (E.string str) |> fromBytes
+
+
 {-| Create a [Bytes] object from an elm/bytes [Bytes.Bytes].
 -}
 fromBytes : Bytes.Bytes -> Bytes a
@@ -96,6 +107,13 @@ toString (Bytes str) =
     str
 
 
+{-| Convert [Bytes] into a UTF8 String.
+-}
+toText : Bytes a -> Maybe String
+toText bs =
+    D.decode (D.string <| width bs) (toBytes bs)
+
+
 {-| Convert [Bytes] into elm/bytes [Bytes.Bytes].
 -}
 toBytes : Bytes a -> Bytes.Bytes