Update CHANGELOG for v1.0.0

elm-cardano · Dec 15, 2024 · 2190d3c · 2190d3c
1 parent 62ece2d
commit 2190d3c
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,45 @@
 # Changelog
 
-## 2024-12-15
+## v1.0.0 - 2024-12-15
 
 ### Added
 
+#### Bech32.Encode
+
+- ```elm
+  {-| Encode a data payload as Bech32 using the given `prefix`. -}
+  encode : { prefix : String, data : Bytes } -> Result EncodeFailure String
+  ```
+
+- ```elm
+  type EncodeFailure
+      = UnexpectedCharacterInPrefix { culprit : Char }
+      | PrefixTooShort { minimum : Int, currentLength : Int }
+  ```
+
+#### Bech32.Decode
+
+- ```elm
+  {-| Decode a Bech32 string into its internal constituents. -}
+  decode : String -> Result DecodeFailure { prefix : String, data : Bytes }
+  ```
+
+- ```elm
+  type DecodeFailure
+      = DataPayloadTooShort { minimum : Int, currentLength : Int }
+      | PrefixTooShort { minimum : Int, currentLength : Int }
+      | UnexpectedCharacterInPayload { culprit : Char }
+      | UnexpectedCharacterInPrefix { culprit : Char }
+      | InvalidChecksum
+      | MissingSeparator
+      | InternalError WordsToBytesFailure
+  ```
+
+- ```elm
+  type WordsToBytesFailure
+      = ExcessPadding
+      | NonZeroPadding
+  ```
 
 ### Changed
 

diff --git a/elm.json b/elm.json
@@ -1,7 +1,7 @@
 {
     "type": "package",
     "name": "elm-cardano/bech32",
-    "summary": "A BIP173 compatible Bech32 encoding/decoding library.",
+    "summary": "A BIP-0173 compatible Bech32 encoding/decoding library.",
     "license": "Apache-2.0",
     "version": "1.0.0",
     "exposed-modules": [