diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# ChangeLog for `bech32-th` + +## 1.0.2 -- 2020-02-19 + ++ Initial release adapted from https://github.com/input-output-hk/cardano-wallet diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright © 2019-2020 IOHK + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/bech32-th.cabal b/bech32-th.cabal new file mode 100644 --- /dev/null +++ b/bech32-th.cabal @@ -0,0 +1,78 @@ +name: bech32-th +version: 1.0.2 +synopsis: Template Haskell extensions to the Bech32 library. +description: Template Haskell extensions to the Bech32 library, including + quasi-quoters for compile-time checking of Bech32 string + literals. +author: IOHK Engineering Team +maintainer: operations@iohk.io, erikd@mega-nerd.com, jonathan.knowles@iohk.io +copyright: 2020 IOHK +license: Apache-2.0 +license-file: LICENSE +homepage: https://github.com/input-output-hk/bech32 +bug-reports: https://github.com/input-output-hk/bech32/issues +category: Web +build-type: Simple +extra-source-files: ChangeLog.md +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/input-output-hk/bech32.git + +flag werror + description: Enable `-Werror` + default: False + manual: True + +library + default-language: + Haskell2010 + default-extensions: + NoImplicitPrelude + OverloadedStrings + ghc-options: + -Wall + -Wcompat + -fwarn-redundant-constraints + if (flag(werror)) + ghc-options: + -Werror + build-depends: + base + , bech32 >= 1.0.2 + , template-haskell + , text + hs-source-dirs: + src + exposed-modules: + Codec.Binary.Bech32.TH + +test-suite bech32-th-test + default-language: + Haskell2010 + default-extensions: + NoImplicitPrelude + OverloadedStrings + type: + exitcode-stdio-1.0 + hs-source-dirs: + test + ghc-options: + -threaded -rtsopts -with-rtsopts=-N + -Wall + if (flag(werror)) + ghc-options: + -Werror + build-depends: + base < 4.14 + , bech32 + , bech32-th + , hspec + , template-haskell + build-tools: + hspec-discover + main-is: + Main.hs + other-modules: + Codec.Binary.Bech32.THSpec diff --git a/src/Codec/Binary/Bech32/TH.hs b/src/Codec/Binary/Bech32/TH.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Bech32/TH.hs @@ -0,0 +1,74 @@ +{-# LANGUAGE TemplateHaskell #-} + +-- | +-- Copyright: © 2020 IOHK +-- License: Apache-2.0 +-- +-- This module contains Template-Haskell-specific extensions to the +-- [Bech32 library](https://github.com/input-output-hk/bech32). + +module Codec.Binary.Bech32.TH + ( + -- ** Quasi-Quotation Support + humanReadablePart + ) where + +import Prelude + +import Codec.Binary.Bech32 + ( HumanReadablePart, humanReadablePartFromText, humanReadablePartToText ) +import Control.Exception + ( throw ) +import Data.Text + ( Text ) +import Language.Haskell.TH.Quote + ( QuasiQuoter (..) ) +import Language.Haskell.TH.Syntax + ( Exp, Q ) + +import qualified Data.Text as T + +-- | A quasiquoter for Bech32 human-readable prefixes. +-- +-- This quasiquoter makes it possible to construct values of type +-- 'HumanReadablePart' at compile time, using string literals. +-- +-- Failure to parse a string literal will result in a __compile-time error__. +-- +-- See 'Codec.Binary.Bech32.HumanReadablePartError' for the set of possible +-- errors that can be raised. +-- +-- Example: +-- +-- >>> :set -XQuasiQuotes +-- >>> import Codec.Binary.Bech32 +-- >>> import Codec.Binary.Bech32.TH +-- >>> let addrPrefix = [humanReadablePart|addr|] +-- >>> addrPrefix +-- HumanReadablePart "addr" +-- >>> :t addrPrefix +-- addrPrefix :: HumanReadablePart +-- +humanReadablePart :: QuasiQuoter +humanReadablePart = QuasiQuoter + { quoteExp = quoteHumanReadablePart + , quotePat = notHandled "patterns" + , quoteType = notHandled "types" + , quoteDec = notHandled "declarations" + } + where + notHandled things = + error $ things <> + " are not handled by the Bech32 humanReadablePart quasiquoter." + +quoteHumanReadablePart :: String -> Q Exp +quoteHumanReadablePart = quote + . T.unpack + . humanReadablePartToText + . unsafeHumanReadablePart + . T.pack + where + quote t = [| unsafeHumanReadablePart t |] + +unsafeHumanReadablePart :: Text -> HumanReadablePart +unsafeHumanReadablePart = either throw id . humanReadablePartFromText diff --git a/test/Codec/Binary/Bech32/THSpec.hs b/test/Codec/Binary/Bech32/THSpec.hs new file mode 100644 --- /dev/null +++ b/test/Codec/Binary/Bech32/THSpec.hs @@ -0,0 +1,92 @@ +module Codec.Binary.Bech32.THSpec + ( spec + ) where + +import Prelude + +import Codec.Binary.Bech32 + ( CharPosition (..) + , HumanReadablePartError (..) + , humanReadableCharMaxBound + , humanReadableCharMinBound + , humanReadablePartMaxLength + , humanReadablePartMinLength + ) +import Codec.Binary.Bech32.TH + ( humanReadablePart ) +import Control.Monad + ( forM_ ) +import Language.Haskell.TH.Quote + ( QuasiQuoter (quoteExp) ) +import Language.Haskell.TH.Syntax + ( Exp (..), runQ ) +import Test.Hspec + ( Spec, describe, it, shouldSatisfy, shouldThrow ) + +spec :: Spec +spec = + describe "Quasi-Quotations" $ + + describe "Human-Readable Prefixes" $ do + let mkHumanReadablePartExp = runQ . quoteExp humanReadablePart + + describe "Parsing valid human-readable prefixes should succeed." $ + forM_ validHumanReadableParts $ \hrp -> + it (show hrp) $ + mkHumanReadablePartExp hrp >>= + (`shouldSatisfy` isAppE) + + describe "Parsing invalid human-readable prefixes should fail." $ + forM_ invalidHumanReadableParts $ \(hrp, expectedError) -> + it (show hrp) $ + mkHumanReadablePartExp hrp + `shouldThrow` (== expectedError) + +-- | Matches only function application expressions. +-- +isAppE :: Exp -> Bool +isAppE AppE {} = True +isAppE _ = False + +-- | A selection of valid human-readable prefixes, that when parsed with the +-- 'humanReadablePart' quasiquoter should not result in an exception. +-- +-- Note that this is not by any means intended to be an exhaustive list. +-- The underlying parsing logic, provided by `humanReadablePartFromText`, +-- is already tested in the `bech32` package. +-- +validHumanReadableParts :: [String] +validHumanReadableParts = + [ replicate humanReadablePartMinLength humanReadableCharMinBound + , replicate humanReadablePartMaxLength humanReadableCharMaxBound + , "addr" + ] + +-- | A selection of invalid human-readable prefixes, along with the errors that +-- we expect to see if we attempt to parse them with the 'humanReadablePart' +-- quasi-quoter. +-- +-- Note that this is not by any means intended to be an exhaustive list. +-- The underlying parsing logic, provided by `humanReadablePartFromText`, +-- is already tested in the `bech32` package. +-- +invalidHumanReadableParts :: [(String, HumanReadablePartError)] +invalidHumanReadableParts = + [ ( replicate (pred minLen) minChar + , HumanReadablePartTooShort + ) + , ( replicate (succ maxLen) maxChar + , HumanReadablePartTooLong + ) + , ( replicate (succ minLen) (pred minChar) + , HumanReadablePartContainsInvalidChars (CharPosition <$> [0 .. minLen]) + ) + , ( replicate (succ minLen) (succ maxChar) + , HumanReadablePartContainsInvalidChars (CharPosition <$> [0 .. minLen]) + ) + ] + where + minChar = humanReadableCharMinBound + maxChar = humanReadableCharMaxBound + minLen = humanReadablePartMinLength + maxLen = humanReadablePartMaxLength diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}