fast-bech32 (empty) → 1.0.0
raw patch · 8 files changed
+1008/−0 lines, 8 filesdep +QuickCheckdep +basedep +base16
Dependencies added: QuickCheck, base, base16, bech32, bytestring, criterion, fast-bech32, hspec, random-bytestring, relude, text
Files
- CHANGELOG.md +16/−0
- LICENSE +373/−0
- README.md +32/−0
- bench/Encoding.hs +50/−0
- fast-bech32.cabal +190/−0
- src/Data/ByteString/Bech32.hs +273/−0
- test/unit/Data/ByteString/Bech32Spec.hs +69/−0
- test/unit/Spec.hs +5/−0
+ CHANGELOG.md view
@@ -0,0 +1,16 @@+# Changelog++## [1.0.0] -- 2021-03-18++### Added++- Initial release, only covering the bech32 encoding+- Provide benchmarks for comparing with the existing bech32 library as well as an optimized base32 library.++### Changed ++N/A++### Removed++N/A
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,32 @@+# fast-bech32++## Overview ++An optimized implementation of the [bech32](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) encoding format (checksumed base32 with human-readable prefixes). ++## Usage+++```hs+import Data.ByteString.Bech32 + ( HumanReadablePart(..), encodeBech32 )++encodeAddress :: ByteString -> Text+encodeAddress = encodeBech32 (HumanReadablePart "addr") +```++<hr/>++## Benchmarks++| Bytestring length (bytes) | [bech32](https://hackage.haskell.org/package/bech32) | [fast-bech32](https://hackage.haskell.org/package/fast-bech32) |+| --- | --- | --- |+| 10 | 8.085μs | 0.875μs |+| 100 | 60.83μs | 2.181μs |+| 1000 | 664.1μs | 33.05μs |++<p align="center">+ <a href="https://github.com/CardanoSolutions/ogmios/blob/master/CONTRIBUTING.md">:gift: Contributing</a>+ |+ <a href="https://github.com/CardanoSolutions/ogmios/blob/master/server/modules/fast-bech32/CHANGELOG.md">:floppy_disk: Changelog</a>+</p>
+ bench/Encoding.hs view
@@ -0,0 +1,50 @@+-- This Source Code Form is subject to the terms of the Mozilla Public+-- License, v. 2.0. If a copy of the MPL was not distributed with this+-- file, You can obtain one at http://mozilla.org/MPL/2.0/.++{-# OPTIONS_GHC -fno-warn-incomplete-uni-patterns #-}++module Main where++import Prelude++import Criterion+ ( bench, bgroup, env, whnf )+import Criterion.Main+ ( defaultMain )+import Data.ByteString.Bech32+ ( HumanReadablePart (..), encodeBech32 )+import Data.ByteString.Random+ ( random )++import qualified Codec.Binary.Bech32 as Bech32++main :: IO ()+main = defaultMain+ [ env cases $ \ ~(_10, _100, _1000) -> do+ bgroup "encode"+ [ bgroup "10"+ [ bench "bech32" $ whnf bech32 _10+ , bench "fast-bech32" $ whnf fastBech32 _10+ ]+ , bgroup "100"+ [ bench "bech32" $ whnf bech32 _100+ , bench "fast-bech32" $ whnf fastBech32 _100+ ]+ , bgroup "1000"+ [ bench "bech32" $ whnf bech32 _1000+ , bench "fast-bech32" $ whnf fastBech32 _1000+ ]+ ]+ ]+ where+ Right hrp = Bech32.humanReadablePartFromText "bench_"+ bech32 = Bech32.encode hrp . Bech32.dataPartFromBytes++ fastBech32 = encodeBech32 hrp'+ hrp' = HumanReadablePart "bench_"++ cases = (,,)+ <$> random 10+ <*> random 100+ <*> random 1000
+ fast-bech32.cabal view
@@ -0,0 +1,190 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.34.4.+--+-- see: https://github.com/sol/hpack+--+-- hash: c90aa64d9b573bd74e26c606bccc9065e63e43f351c94f930b404bfa961fc685++name: fast-bech32+version: 1.0.0+synopsis: Fast implementation of the Bech32 encoding format.+description: Please see the README on GitHub at <https://github.com/cardanosolutions/ogmios/tree/master/server/modules/fast-bech32>+category: Codec+homepage: https://github.com/cardanosolutions/ogmios#readme+bug-reports: https://github.com/cardanosolutions/ogmios/issues+author: KtorZ <matthias.benkort@gmail.com>+maintainer: matthias.benkort@gmail.com+copyright: 2021 KtorZ+license: MPL-2.0+license-file: LICENSE+build-type: Simple+extra-source-files:+ LICENSE+ README.md+ CHANGELOG.md++source-repository head+ type: git+ location: https://github.com/cardanosolutions/ogmios++library+ exposed-modules:+ Data.ByteString.Bech32+ other-modules:+ Paths_fast_bech32+ hs-source-dirs:+ src+ default-extensions:+ BangPatterns+ BinaryLiterals+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveDataTypeable+ DeriveFoldable+ DeriveFunctor+ DeriveGeneric+ DeriveTraversable+ EmptyDataDecls+ ExistentialQuantification+ FlexibleContexts+ FlexibleInstances+ FunctionalDependencies+ GADTs+ InstanceSigs+ KindSignatures+ LambdaCase+ MultiParamTypeClasses+ MultiWayIf+ NamedFieldPuns+ NoImplicitPrelude+ NumericUnderscores+ OverloadedStrings+ PartialTypeSignatures+ PatternGuards+ RankNTypes+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeFamilies+ TypeSynonymInstances+ ViewPatterns+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints -Wunused-packages+ build-depends:+ base >=4.7 && <5+ , bytestring+ , relude+ , text+ if true+ ghc-options: -O2+ default-language: Haskell2010++test-suite unit+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ Data.ByteString.Bech32Spec+ Paths_fast_bech32+ hs-source-dirs:+ test/unit+ default-extensions:+ BangPatterns+ BinaryLiterals+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveDataTypeable+ DeriveFoldable+ DeriveFunctor+ DeriveGeneric+ DeriveTraversable+ EmptyDataDecls+ ExistentialQuantification+ FlexibleContexts+ FlexibleInstances+ FunctionalDependencies+ GADTs+ InstanceSigs+ KindSignatures+ LambdaCase+ MultiParamTypeClasses+ MultiWayIf+ NamedFieldPuns+ NoImplicitPrelude+ NumericUnderscores+ OverloadedStrings+ PartialTypeSignatures+ PatternGuards+ RankNTypes+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeFamilies+ TypeSynonymInstances+ ViewPatterns+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints -Wunused-packages -threaded -rtsopts -with-rtsopts=-N+ build-tool-depends:+ hspec-discover:hspec-discover+ build-depends:+ QuickCheck+ , base >=4.7 && <5+ , base16+ , bech32+ , bytestring+ , fast-bech32+ , hspec+ , text+ default-language: Haskell2010++benchmark encoding+ type: exitcode-stdio-1.0+ main-is: Encoding.hs+ other-modules:+ Paths_fast_bech32+ hs-source-dirs:+ bench+ default-extensions:+ BangPatterns+ BinaryLiterals+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveDataTypeable+ DeriveFoldable+ DeriveFunctor+ DeriveGeneric+ DeriveTraversable+ EmptyDataDecls+ ExistentialQuantification+ FlexibleContexts+ FlexibleInstances+ FunctionalDependencies+ GADTs+ InstanceSigs+ KindSignatures+ LambdaCase+ MultiParamTypeClasses+ MultiWayIf+ NamedFieldPuns+ NoImplicitPrelude+ NumericUnderscores+ OverloadedStrings+ PartialTypeSignatures+ PatternGuards+ RankNTypes+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeFamilies+ TypeSynonymInstances+ ViewPatterns+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints -Wunused-packages -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ base >=4.7 && <5+ , bech32+ , bytestring+ , criterion+ , fast-bech32+ , random-bytestring+ default-language: Haskell2010
+ src/Data/ByteString/Bech32.hs view
@@ -0,0 +1,273 @@+-- This Source Code Form is subject to the terms of the Mozilla Public+-- License, v. 2.0. If a copy of the MPL was not distributed with this+-- file, You can obtain one at http://mozilla.org/MPL/2.0/.++{-# LANGUAGE MagicHash #-}+{-# LANGUAGE PatternSynonyms #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE ViewPatterns #-}++-- | This package provides an implementation of the bech32 encoding. In essence,+-- this encoding is comprised of three parts:+--+-- - A human readable prefix+-- - A base32-encoded payload (with a modified alphabet to avoid similar letters)+-- - A checksum calculated on the prefix and the encoded payload+--+-- The implementation is optimized on mainly three aspects:+--+-- - Low-level memory manipulation with typed pointers is used to traverse the+-- input string and to write the encoded value. Each byte is encoded+-- on-the-fly, which requires keeping track of a residue (since we encode from+-- 8 bit to 5 bit, but can only read 8 bit at the same, the remainder is+-- stored and passed to the next builder loop).+--+-- - Since the checksum is calculated by folding over the encoded bytestring, it+-- can be computed in-place, as the string is being encoded. This is exactly+-- what this implementation does as well. In such way that once the string is+-- encoded, the checksum is already calculated and only need to be base32+-- encoded in turn.+--+-- - The first part of the checksum is pre-computed during the construction of the+-- HRP. It is indeed quite common for a single HRP to encode many payload. To+-- calculate the checksum, one must first expand the HRP which is in itself an+-- already 'costly' operation. Pre-calculating the expansion and the beginning+-- of the checksum shaves off some time .+--+module Data.ByteString.Bech32+ ( -- * Encoding+ encodeBech32++ -- * HumanReadablePart+ , HumanReadablePart(HumanReadablePart)+ , unHumanReadablePart+ ) where++import Relude++import Data.Bits+ ( Bits, testBit, unsafeShiftL, unsafeShiftR, (.&.), (.|.) )+import Data.ByteString.Internal+ ( ByteString (..) )+import Foreign.ForeignPtr+ ( withForeignPtr )+import Foreign.Ptr+ ( Ptr, plusPtr )+import Foreign.Storable+ ( peek, poke )+import GHC.Exts+ ( Addr#, indexWord8OffAddr#, word2Int# )+import GHC.ForeignPtr+ ( mallocPlainForeignPtrBytes )+import GHC.Word+ ( Word8 (..) )+import System.IO.Unsafe+ ( unsafeDupablePerformIO )++import qualified Data.ByteString as BS+import qualified Data.Text as T+import qualified Data.Text.Encoding as T++-- | Encode some binary data to bech32 using the given human readable prefix.+encodeBech32 :: HumanReadablePart -> ByteString -> Text+encodeBech32 hrp bytes = mconcat+ [ prefix hrp+ , "1"+ , encodeDataPart "qpzry9x8gf2tvdw0s3jn54khce6mua7l"# (checksum hrp) bytes+ ]++--+-- HumanReadablePart+--++data HumanReadablePart = HumanReadablePartConstr+ { prefix :: !Text+ , checksum :: !Checksum+ } deriving Show++-- | Construct a human readable part from a text string, and pre-calculate the+-- checksum corresponding to it.+pattern HumanReadablePart :: Text -> HumanReadablePart+pattern HumanReadablePart { unHumanReadablePart } <-+ HumanReadablePartConstr unHumanReadablePart _+ where+ HumanReadablePart prefix =+ let+ checksum =+ foldl' (flip polymodStep) (Checksum 1) $ expand (T.unpack prefix)++ expand :: [Char] -> [Word5]+ expand xs =+ [ coerce @Word8 (fromIntegral (ord x) .>>. 5) | x <- xs ]+ +++ [ coerce @Word8 0 ]+ +++ [ coerce @Word8 (fromIntegral (ord x) .&. 31) | x <- xs ]+ in+ HumanReadablePartConstr {prefix,checksum}+{-# COMPLETE HumanReadablePart #-}++--+-- Main encoding loop+--++encodeDataPart :: Addr# -> Checksum -> ByteString -> Text+encodeDataPart !alphabet !chk0 =+ T.decodeUtf8 . withAllocatedPointers (base32 0 (Residue 0) chk0)+ where+ withAllocatedPointers+ :: (Int -> Ptr Word8 -> Ptr Word8 -> IO Checksum)+ -> ByteString+ -> ByteString+ withAllocatedPointers _fn "" = ""+ withAllocatedPointers fn (PS !inputForeignPtr !_ !inputLen) =+ let (!q, !r) = (inputLen * 8) `quotRem` 5 in+ let !resultLen = q + if r == 0 then 0 else 1 in+ unsafeDupablePerformIO $ do+ resultForeignPtr <- mallocPlainForeignPtrBytes resultLen+ withForeignPtr resultForeignPtr $ \resultPtr ->+ withForeignPtr inputForeignPtr $ \inputPtr -> do+ chk' <- fn (resultLen - 1) inputPtr resultPtr+ return $ (PS resultForeignPtr 0 resultLen)+ <> (encodeChecksum alphabet chk')++ base32 :: Int -> Residue -> Checksum -> Int -> Ptr Word8 -> Ptr Word8 -> IO Checksum+ base32 !n !r !chk !maxN !inputPtr !resultPtr+ | n >= maxN = do+ let !w = coerce r+ poke resultPtr (alphabet `lookupWord5` w)+ return $ polymodStep w chk+ | otherwise = do+ (w, r', inputPtr') <- peekWord5 n r inputPtr+ poke resultPtr (alphabet `lookupWord5` w)+ let !chk' = polymodStep w chk+ base32 (n+1) r' chk' maxN inputPtr' (plusPtr resultPtr 1)++--+-- Checksum+--++newtype Checksum = Checksum Word64 deriving Show++encodeChecksum :: Addr# -> Checksum -> ByteString+encodeChecksum !alphabet !chk =+ [ alphabet `lookupWord5` word5 (polymod .>>. i)+ | i <- [25, 20 .. 0 ]+ ] & BS.pack+ where+ polymod =+ let z = coerce @Word8 0+ in (coerce (foldl' (flip polymodStep) chk [z,z,z,z,z,z]) .&. 0x3fffffff) `xor` 1++ word5 :: Word64 -> Word5+ word5 = coerce . fromIntegral @Word64 @Word8 . (.&. 31)+ {-# INLINE word5 #-}++polymodStep :: Word5 -> Checksum -> Checksum+polymodStep (Word5 !v) (Checksum !chk) =+ let chk' = (chk .<<. 5) `xor` fromIntegral v in+ Checksum+ ( xor (if testBit chk 29 then 0x2a1462b3 else 0)+ ( xor (if testBit chk 28 then 0x3d4233dd else 0)+ ( xor (if testBit chk 27 then 0x1ea119fa else 0)+ ( xor (if testBit chk 26 then 0x26508e6d else 0)+ ( xor (if testBit chk 25 then 0x3b6a57b2 else 0)+ chk'+ )+ )+ )+ )+ )++--+-- Base32+--++newtype Word5 = Word5 Word8 deriving Show++newtype Residue = Residue Word8 deriving Show++-- | Lookup a Word5 using the given pointer and a previous 'Residue'. Returns+-- the looked up 'Word5', a 'Residue' and the pointer advanced to the next+-- word;+--+-- NOTE: @n = i .&. 7@ is a fast modulo equivalent to @n = i `mod` 8@+peekWord5 :: Int -> Residue -> Ptr Word8 -> IO (Word5, Residue, Ptr Word8)+peekWord5 !((.&. 7) -> !n) (Residue !r) !ptr+ | n == 0 = do+ w <- peek ptr+ return+ ( coerce (w .>>. 3)+ , coerce ((w .&. 0b00000111) .<<. 2)+ , plusPtr ptr 1+ )+ | n == 1 = do+ w <- peek ptr+ return+ ( coerce ((w .>>. 6) .|. r)+ , coerce (w .&. 0b00111111)+ , plusPtr ptr 1+ )+ | n == 2 = do+ return+ ( coerce (r .>>. 1)+ , coerce ((r .&. 0b11000001) .<<. 4)+ , ptr+ )+ | n == 3 = do+ w <- peek ptr+ return+ ( coerce ((w .>>. 4) .|. r)+ , coerce ((w .&. 0b00001111) .<<. 1)+ , plusPtr ptr 1+ )+ | n == 4 = do+ w <- peek ptr+ return+ ( coerce ((w .>>. 7) .|. r)+ , coerce (w .&. 0b01111111)+ , plusPtr ptr 1+ )+ | n == 5 = do+ return+ ( coerce (r .>>. 2)+ , coerce ((r .&. 0b10000011) .<<. 3)+ , ptr+ )+ | n == 6 = do+ w <- peek ptr+ return+ ( coerce ((w .>>. 5) .|. r)+ , coerce (w .&. 0b00011111)+ , plusPtr ptr 1+ )+ | otherwise = do+ return+ ( coerce r+ , coerce @Word8 0+ , ptr+ )++--+-- Bit Manipulation / Conversions+--++(.>>.) :: Bits a => a -> Int -> a+(.>>.) = unsafeShiftR+{-# SPECIALIZE INLINE (.>>.) :: Word8 -> Int -> Word8 #-}+{-# SPECIALIZE INLINE (.>>.) :: Word -> Int -> Word #-}++(.<<.) :: Bits a => a -> Int -> a+(.<<.) = unsafeShiftL+{-# SPECIALIZE INLINE (.<<.) :: Word8 -> Int -> Word8 #-}+{-# SPECIALIZE INLINE (.<<.) :: Word -> Int -> Word #-}++--+-- Dictionnary+--++-- | Fast array lookup of a word5 in an unboxed bytestring.+lookupWord5 :: Addr# -> Word5 -> Word8+lookupWord5 table (coerce -> (W8# i)) =+ W8# (indexWord8OffAddr# table (word2Int# i))+{-# INLINE lookupWord5 #-}
+ test/unit/Data/ByteString/Bech32Spec.hs view
@@ -0,0 +1,69 @@+-- This Source Code Form is subject to the terms of the Mozilla Public+-- License, v. 2.0. If a copy of the MPL was not distributed with this+-- file, You can obtain one at http://mozilla.org/MPL/2.0/.++module Data.ByteString.Bech32Spec+ ( spec+ ) where++import Prelude++import Data.ByteString+ ( ByteString )+import Data.ByteString.Base16+ ( encodeBase16 )+import Data.ByteString.Bech32+ ( HumanReadablePart (..), encodeBech32 )+import GHC.Stack+ ( HasCallStack )+import Test.Hspec+ ( Spec, describe )+import Test.Hspec.QuickCheck+ ( prop )+import Test.QuickCheck+ ( Gen, Property, choose, elements, forAll, vector, withMaxSuccess, (===) )++import qualified Codec.Binary.Bech32 as Oracle+import qualified Data.ByteString as BS+import qualified Data.Text as T++spec :: Spec+spec = describe "encodeBech32" $+ prop "oracle with existing bech32's library" $+ withMaxSuccess 5000 $+ forAll genBytes $ \bytes ->+ forAll genHrp $ prop_matchOracle bytes++prop_matchOracle :: Bytes -> HumanReadablePart -> Property+prop_matchOracle (Bytes bytes) (HumanReadablePart hrp) = do+ let hrp' = unsafeFromRight $ Oracle.humanReadablePartFromText hrp+ let oracle = Oracle.encodeLenient hrp' $ Oracle.dataPartFromBytes bytes+ let ours = encodeBech32 (HumanReadablePart hrp) bytes+ oracle === ours++--+-- Generators+--++newtype Bytes = Bytes { unBytes :: ByteString }++instance Show Bytes where+ show = T.unpack . encodeBase16 . unBytes++genBytes :: Gen Bytes+genBytes =+ Bytes . BS.pack <$> (choose (1, 100) >>= vector)++genHrp :: Gen HumanReadablePart+genHrp = elements+ [ HumanReadablePart "test_"+ , HumanReadablePart "addr"+ , HumanReadablePart "?!?"+ ]++--+-- Helpers+--++unsafeFromRight :: (HasCallStack, Show e) => Either e a -> a+unsafeFromRight = either (error . show) id
+ test/unit/Spec.hs view
@@ -0,0 +1,5 @@+-- This Source Code Form is subject to the terms of the Mozilla Public+-- License, v. 2.0. If a copy of the MPL was not distributed with this+-- file, You can obtain one at http://mozilla.org/MPL/2.0/.++{-# OPTIONS_GHC -F -pgmF hspec-discover #-}