Merge pull request #25 from CicadaBank/release/v0.1.2

Release/v0.1.2

Author: ercdude

.github/workflows/test.yml

@@ -1,5 +1,5 @@
 # from https://github.com/Flexiana/framework/blob/main/.github/workflows/test.yml
-name: Clojure CI
+name: Test Library CI
 
 on:
   push:
@@ -45,3 +45,17 @@ jobs:
 
     - name: Run tests
       run: clojure -M:run/test
+
+    - name: Generate Package
+      run: clojure -T:generator jar
+
+    - name: Set TAG env variable
+      run: echo "TAG=$(grep :version release.edn | awk -F" " '{print $2}' | tr -d "\"")" >> $GITHUB_ENV
+
+    - name: Test Package
+      run: cp -r test target/ && cd target && clojure -Sforce -Sverbose -Sdeps '
+                   {:deps {com.cicadabank/bips {:local/root "bips-${{env.TAG}}.jar"},
+                           clj-async-test/clj-async-test {:mvn/version "0.0.5"},
+                           io.github.cognitect-labs/test-runner {:git/tag "v0.5.0"
+                                                                 :git/sha "b3fd0d2"}},
+                    :paths ["test/"]}' -m cognitect.test-runner

README.md

@@ -242,6 +242,14 @@ index 0) of the Bitcoin coin type (coin type "BTC").
 ;; => "m/44'/0'/0'/0/0"
 ```
 
+A second version of `derivation-path` takes only 2 arguments a
+`coin-type` and an `account` index to derive an account address.
+
+```clojure
+(derivation-path "BTC" 0)
+;; => "m/44'/0'/0'"
+```
+
 Reference
 ---------
 

release.edn

@@ -1,4 +1,4 @@
 {:group-id "com.cicadabank"
  :artifact-id "bips"
- :version "0.1.1"
+ :version "0.1.2"
  :scm-url "https://github.com/CicadaBank/bips"}

src/bips/bip32.clj

@@ -119,7 +119,7 @@
   {:public-key (compress-public-key
                  (.toString
                    (private->public-key
-                     (BigInteger. (apply str k-par) 16)) 16))
+                     (BigInteger. k-par 16)) 16))
    :chain-code c-par
    :index index
    :depth depth})
@@ -133,20 +133,25 @@
   :index 1000000000,
   :depth 5}`"
   [seed chain-path key-type]
-  (let [path-parts (str/split chain-path #"/")]
-    (loop [current-node (if (= "m" (first path-parts))
-                          `(derive-master-node ~seed)
-                          (throw (Exception.
-                                   (str "Invalid path: " (first path-parts)))))
-           parts (rest path-parts)]
-      (if (seq parts)
-        (let [part (first parts)
-              index (if (hardened? part)
-                      (hardened (Integer/parseInt (subs part 0 (- (count part) 1))))
-                      (Integer/parseInt part))]
-          (recur
-            `(CKDpriv ~current-node ~index)
-            (rest parts)))
-        (if (= :public key-type)
-          `(N ~current-node)
-          current-node)))))
+  (let [path-parts (gensym 'path-parts)
+        part (gensym 'part)
+        parts (gensym 'parts)
+        current-node (gensym 'current-node)
+        index (gensym 'index)]
+    `(let [~path-parts (str/split ~chain-path #"/")]
+       (loop [~current-node (if (= "m" (first ~path-parts))
+                              (derive-master-node ~seed)
+                              (throw (Exception.
+                                       (str "Invalid path: " (first ~path-parts)))))
+              ~parts (rest ~path-parts)]
+         (if (seq ~parts)
+           (let [~part (first ~parts)
+                 ~index (if (hardened? ~part)
+                          (hardened (Integer/parseInt (subs ~part 0 (- (count ~part) 1))))
+                          (Integer/parseInt ~part))]
+             (recur
+               (CKDpriv ~current-node ~index)
+               (rest ~parts)))
+           (if (= :public ~key-type)
+             (N ~current-node)
+             ~current-node))))))

src/bips/bip32_utils.clj

@@ -85,7 +85,7 @@
   (str (if (= 0 (mod (nth (codecs/hex->bytes (pad-leading-zeros 128 K)) 63) 2))
          "02"
          "03")
-       (apply str (take 64 K))))
+       (apply str (take 64 (pad-leading-zeros 128 K)))))
 
 (defn decompressKey
   "Decompress a compressed public key (x co-ord and low-bit of y-coord).

src/bips/bip44.clj

@@ -22,18 +22,24 @@
     [bips.constants :as const]))
 
 (defn derivation-path
-  "The derivation-path function takes four arguments: a `coin-type`, an
-  `account`, a `chain`, and an `address`.  It uses these values to
-  construct a string representing a path to a specific wallet address.
-  Throws an exception with an error message if the `coin-type` in not
-  found in `coin_types.edn`."
-  [coin-type account chain address]
-  (if-let [matching-coin-type (first (filter #(= (:symbol %) coin-type)
-                                             const/coin-types))]
-    (str "m/44'/" (:coin-type matching-coin-type)
-         "'/" account "'/" (get const/chain-map chain) "/" address)
-    (throw (Exception. (str "Coin type " coin-type " not found in coin_types.edn file.")))))
+  "The derivation-path multi-arity function. The first version takes
+  four arguments: a `coin-type`, an `account` index, a `chain` type,
+  and an `address` index.  It uses these values to construct a string
+  representing a path to a specific wallet address.  Throws an
+  exception with an error message if the `coin-type` in not found in
+  `coin_types.edn`.  A second version taking two arguments is used to
+  derive an account address from a `coin-type` and an `account`
+  index."
+  ([coin-type account chain address]
+   (str (derivation-path coin-type account) "/" (get const/chain-map chain) "/" address))
+  ([coin-type account]
+   (if-let [matching-coin-type (first (filter #(= (:symbol %) coin-type)
+                                              const/coin-types))]
+     (str "m/44'/" (:coin-type matching-coin-type)
+          "'/" account "'")
+     (throw (Exception. (str "Coin type " coin-type " not found in coin_types.edn file."))))))
 
 (comment
   (derivation-path "BTC" 0 :external 0)
-  (derivation-path "XMR" 0 :change 0))
+  (derivation-path "XMR" 0 :change 0)
+  (derivation-path "BTC" 0))

test/bips/bip32_test.clj

@@ -78,8 +78,8 @@
        (doseq [i# (range (count (:derived-keys ~tv)))]
          (let [derived-key# (nth (:derived-keys ~tv) i#)
                path# (:path derived-key#)
-               extended-private-key# (eval `(derive-path ~seed# ~path# :private))
-               extended-public-key# (eval `(derive-path ~seed# ~path# :public))
+               extended-private-key# (derive-path seed# path# :private)
+               extended-public-key# (derive-path seed# path# :public)
                bip32-xprvkey# (:bip32-xprvkey derived-key#)
                bip32-xpubkey# (:bip32-xpubkey derived-key#)
                identifier# (:identifier derived-key#)
@@ -643,14 +643,22 @@
     ;; Chain: m/44H/0H
     (is (= "xprv9vsUaQydQJbS21eDwfKv3WYoU9cr1JcFxt252mQneUB4ABBQScW5sx7ZjJ5HMGDGy1coR5Cvit6YWio3Nj4fSiBAfJFJMMWHNdBB3FEowpt"
            bip32-xprv-grandchild-private-key))
-    (is (= "xpub69rpyvWXEg9jEVih3grvQeVY2BTLQmL7L6wfq9pQCoi32yWYz9pLRkS3aZhG1fvxPKjwWPUqoLFvTdGAjuUeNdYWRWFu9BdivDFrWHjwiVZ"
+    (is (= "xpub69rpyvWXEg9jEVih3grvQeVY2BTLQmL7L6wfq9pQCoi32yWYz9pLRkS3aYXrkHLgUia7Fx9XkNJmYtdJM2HYPvXftMeL6KKaRCaemYiBBfZ"
            bip32-xpub-grandchild-public-key))
-    (is (= "8809de7d" (format "%x" grandchild-node-fingerprint)))
+    (is (= "6ebca719" (format "%x" grandchild-node-fingerprint)))
     ;; Chain: m/44H/0H/0H
-    (is (= "xprv9yfQqFhGvzYGeZvyLrdwHSreqxRQEXPjJzstFgGNwV6wT1ueWfU9Dyt4yBCZo45Zt5fEMTh3wEp8nyUnjsDMYHVNN9bmtcQZt6ouQxGCcGJ"
+    (is (= "xprv9yUdDyYgknA92Cb4xfsqSXxQzGtELBm1kvXVvmp5MpW3UwjevPGEX29pjR9MAL13UTE1ZDfCwZ7Y3Uwpqv5BGP4cvdkS6DSTbvdYK7RicHk"
            bip32-xprv-grand-grandchild-private-key))
-    (is (= "xpub6CemEmEAmN6Zs41SStAweaoPPzFtdz7agDoV44fzVpdvKpEo4CnPmnCYpTLNuT55NfJG6DDGWhcK7XA6xP1XrqfRtscmhcFSkbHNLRW6Wxt"
+    (is (= "xpub6CTydV5ab9iSEgfY4hQqofu9YJiijeUs89T6jADgvA32Mk4oTvaV4pUJahHAGizYy2s3HyBRX1uiN2d94RsMawEgTMmRuDHLUR71EayS34i"
            bip32-xpub-grand-grandchild-public-key))))
 
+(deftest threading-macro-works-with-derive-path
+  (is (= (let [key "000102030405060708090a0b0c0d0e0f"
+               path "m/0H/1/2H/2/1000000000"
+               key-type :private]
+           (-> key
+               (derive-path path key-type)))
+         (derive-path "000102030405060708090a0b0c0d0e0f" "m/0H/1/2H/2/1000000000" :private))))
+
 (comment
   (clojure.test/run-all-tests))