diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for bitcoin-compact-filters + +## 0.1.0.0 -- 2020-09-14 + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,30 @@ +Copyright (c) 2020, Bitnomial, Inc. + +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the name of Ian Shipman nor the names of other + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/bitcoin-compact-filters.cabal b/bitcoin-compact-filters.cabal new file mode 100644 --- /dev/null +++ b/bitcoin-compact-filters.cabal @@ -0,0 +1,63 @@ +cabal-version: 2.2 +name: bitcoin-compact-filters +version: 0.1.0.0 +synopsis: BIP 158 compact block filters + +copyright: 2020 Bitnomial, Inc. +license: BSD-3-Clause +license-file: LICENSE +author: Ian Shipman +maintainer: ics@gambolingpangolin.com + +build-type: Simple +extra-source-files: CHANGELOG.md +data-files: + examples/*.json + +common core + default-language: Haskell2010 + ghc-options: -Wall + build-depends: + base >=4.12 && <4.15 + , bytestring ^>=0.10 + , cereal ^>=0.5 + , haskoin-core >=0.13 && <0.16 + , text ^>=1.2 + + +library + import: core + hs-source-dirs: src + + exposed-modules: + Bitcoin.CompactFilter + + build-depends: + bitstream ^>=0.3.0.1 + , transformers ^>=0.5 + , memory ^>=0.15 + + +test-suite bitcoin-cf-tests + import: core + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Main.hs + + other-modules: + Test.CompactFilter + Test.Examples.Bip + Test.Examples.Mainnet + Test.Util + + Paths_bitcoin_compact_filters + + autogen-modules: + Paths_bitcoin_compact_filters + + build-depends: + aeson >=1.0 && <1.6 + , bitcoin-compact-filters + , tasty >=1.0 && <1.4 + , tasty-hunit >=0.9 && <0.11 + , tasty-quickcheck >=0.8.1 && <0.11 diff --git a/examples/examples.json b/examples/examples.json new file mode 100644 # file too large to diff: examples/examples.json diff --git a/examples/testnet-19.json b/examples/testnet-19.json new file mode 100644 --- /dev/null +++ b/examples/testnet-19.json @@ -0,0 +1,12 @@ +[ +[0,"000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943","0100000000000000000000000000000000000000000000000000000000000000000000003ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4adae5494dffff001d1aa4ae180101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff4d04ffff001d0104455468652054696d65732030332f4a616e2f32303039204368616e63656c6c6f72206f6e206272696e6b206f66207365636f6e64206261696c6f757420666f722062616e6b73ffffffff0100f2052a01000000434104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5fac00000000",[],"0000000000000000000000000000000000000000000000000000000000000000","019dfca8","21584579b7eb08997773e5aeff3a7f932700042d0ed2a6129012b7d7ae81b750","Genesis block"], +[2,"000000006c02c8ea6e4ff69651f7fcde348fb9d557a06e6957b65552002a7820","0100000006128e87be8b1b4dea47a7247d5528d2702c96826c7a648497e773b800000000e241352e3bec0a95a6217e10c3abb54adfa05abb12c126695595580fb92e222032e7494dffff001d00d235340101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0e0432e7494d010e062f503253482fffffffff0100f2052a010000002321038a7f6ef1c8ca0c588aa53fa860128077c9e6c11e6830f4d7ee4e763a56b7718fac00000000",[],"d7bdac13a59d745b1add0d2ce852f1a0442e8945fc1bf3848d3cbffd88c24fe1","0174a170","186afd11ef2b5e7e3504f2e8cbf8df28a1fd251fe53d60dff8b1467d1b386cf0",""], +[3,"000000008b896e272758da5297bcd98fdc6d97c9b765ecec401e286dc1fdbe10","0100000020782a005255b657696ea057d5b98f34defcf75196f64f6eeac8026c0000000041ba5afc532aae03151b8aa87b65e1594f97504a768e010c98c0add79216247186e7494dffff001d058dc2b60101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0e0486e7494d0151062f503253482fffffffff0100f2052a01000000232103f6d9ff4c12959445ca5549c811683bf9c88e637b222dd2e0311154c4c85cf423ac00000000",[],"186afd11ef2b5e7e3504f2e8cbf8df28a1fd251fe53d60dff8b1467d1b386cf0","016cf7a0","8d63aadf5ab7257cb6d2316a57b16f517bff1c6388f124ec4c04af1212729d2a",""], +[15007,"0000000038c44c703bae0f98cdd6bf30922326340a5996cc692aaae8bacf47ad","0100000002394092aa378fe35d7e9ac79c869b975c4de4374cd75eb5484b0e1e00000000eb9b8670abd44ad6c55cee18e3020fb0c6519e7004b01a16e9164867531b67afc33bc94fffff001d123f10050101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0e04c33bc94f0115062f503253482fffffffff0100f2052a01000000232103f268e9ae07e0f8cb2f6e901d87c510d650b97230c0365b021df8f467363cafb1ac00000000",[],"18b5c2b0146d2d09d24fb00ff5b52bd0742f36c9e65527abdb9de30c027a4748","013c3710","07384b01311867949e0c046607c66b7a766d338474bb67f66c8ae9dbd454b20e","Tx has non-standard OP_RETURN output followed by opcodes"], +[49291,"0000000018b07dca1b28b4b5a119f6d6e71698ce1ed96f143f54179ce177a19c","02000000abfaf47274223ca2fea22797e44498240e482cb4c2f2baea088962f800000000604b5b52c32305b15d7542071d8b04e750a547500005d4010727694b6e72a776e55d0d51ffff001d211806480201000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0d038bc0000102062f503253482fffffffff01a078072a01000000232102971dd6034ed0cf52450b608d196c07d6345184fcb14deb277a6b82d526a6163dac0000000001000000081cefd96060ecb1c4fbe675ad8a4f8bdc61d634c52b3a1c4116dee23749fe80ff000000009300493046022100866859c21f306538152e83f115bcfbf59ab4bb34887a88c03483a5dff9895f96022100a6dfd83caa609bf0516debc2bf65c3df91813a4842650a1858b3f61cfa8af249014730440220296d4b818bb037d0f83f9f7111665f49532dfdcbec1e6b784526e9ac4046eaa602204acf3a5cb2695e8404d80bf49ab04828bcbe6fc31d25a2844ced7a8d24afbdff01ffffffff1cefd96060ecb1c4fbe675ad8a4f8bdc61d634c52b3a1c4116dee23749fe80ff020000009400483045022100e87899175991aa008176cb553c6f2badbb5b741f328c9845fcab89f8b18cae2302200acce689896dc82933015e7230e5230d5cff8a1ffe82d334d60162ac2c5b0c9601493046022100994ad29d1e7b03e41731a4316e5f4992f0d9b6e2efc40a1ccd2c949b461175c502210099b69fdc2db00fbba214f16e286f6a49e2d8a0d5ffc6409d87796add475478d601ffffffff1e4a6d2d280ea06680d6cf8788ac90344a9c67cca9b06005bbd6d3f6945c8272010000009500493046022100a27400ba52fd842ce07398a1de102f710a10c5599545e6c95798934352c2e4df022100f6383b0b14c9f64b6718139f55b6b9494374755b86bae7d63f5d3e583b57255a01493046022100fdf543292f34e1eeb1703b264965339ec4a450ec47585009c606b3edbc5b617b022100a5fbb1c8de8aaaa582988cdb23622838e38de90bebcaab3928d949aa502a65d401ffffffff1e4a6d2d280ea06680d6cf8788ac90344a9c67cca9b06005bbd6d3f6945c8272020000009400493046022100ac626ac3051f875145b4fe4cfe089ea895aac73f65ab837b1ac30f5d875874fa022100bc03e79fa4b7eb707fb735b95ff6613ca33adeaf3a0607cdcead4cfd3b51729801483045022100b720b04a5c5e2f61b7df0fcf334ab6fea167b7aaede5695d3f7c6973496adbf1022043328c4cc1cdc3e5db7bb895ccc37133e960b2fd3ece98350f774596badb387201ffffffff23a8733e349c97d6cd90f520fdd084ba15ce0a395aad03cd51370602bb9e5db3010000004a00483045022100e8556b72c5e9c0da7371913a45861a61c5df434dfd962de7b23848e1a28c86ca02205d41ceda00136267281be0974be132ac4cda1459fe2090ce455619d8b91045e901ffffffff6856d609b881e875a5ee141c235e2a82f6b039f2b9babe82333677a5570285a6000000006a473044022040a1c631554b8b210fbdf2a73f191b2851afb51d5171fb53502a3a040a38d2c0022040d11cf6e7b41fe1b66c3d08f6ada1aee07a047cb77f242b8ecc63812c832c9a012102bcfad931b502761e452962a5976c79158a0f6d307ad31b739611dac6a297c256ffffffff6856d609b881e875a5ee141c235e2a82f6b039f2b9babe82333677a5570285a601000000930048304502205b109df098f7e932fbf71a45869c3f80323974a826ee2770789eae178a21bfc8022100c0e75615e53ee4b6e32b9bb5faa36ac539e9c05fa2ae6b6de5d09c08455c8b9601483045022009fb7d27375c47bea23b24818634df6a54ecf72d52e0c1268fb2a2c84f1885de022100e0ed4f15d62e7f537da0d0f1863498f9c7c0c0a4e00e4679588c8d1a9eb20bb801ffffffffa563c3722b7b39481836d5edfc1461f97335d5d1e9a23ade13680d0e2c1c371f030000006c493046022100ecc38ae2b1565643dc3c0dad5e961a5f0ea09cab28d024f92fa05c922924157e022100ebc166edf6fbe4004c72bfe8cf40130263f98ddff728c8e67b113dbd621906a601210211a4ed241174708c07206601b44a4c1c29e5ad8b1f731c50ca7e1d4b2a06dc1fffffffff02d0223a00000000001976a91445db0b779c0b9fa207f12a8218c94fc77aff504588ac80f0fa02000000000000000000",["5221033423007d8f263819a2e42becaaf5b06f34cb09919e06304349d950668209eaed21021d69e2b68c3960903b702af7829fadcd80bd89b158150c85c4a75b2c8cb9c39452ae","52210279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f8179821021d69e2b68c3960903b702af7829fadcd80bd89b158150c85c4a75b2c8cb9c39452ae","522102a7ae1e0971fc1689bd66d2a7296da3a1662fd21a53c9e38979e0f090a375c12d21022adb62335f41eb4e27056ac37d462cda5ad783fa8e0e526ed79c752475db285d52ae","52210279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f8179821022adb62335f41eb4e27056ac37d462cda5ad783fa8e0e526ed79c752475db285d52ae","512103b9d1d0e2b4355ec3cdef7c11a5c0beff9e8b8d8372ab4b4e0aaf30e80173001951ae","76a9149144761ebaccd5b4bbdc2a35453585b5637b2f8588ac","522103f1848b40621c5d48471d9784c8174ca060555891ace6d2b03c58eece946b1a9121020ee5d32b54d429c152fdc7b1db84f2074b0564d35400d89d11870f9273ec140c52ae","76a914f4fa1cc7de742d135ea82c17adf0bb9cf5f4fb8388ac"],"ed47705334f4643892ca46396eb3f4196a5e30880589e4009ef38eae895d4a13","0afbc2920af1b027f31f87b592276eb4c32094bb4d3697021b4c6380","b6d98692cec5145f67585f3434ec3c2b3030182e1cb3ec58b855c5c164dfaaa3","Tx pays to empty output script"], +[180480,"00000000fd3ceb2404ff07a785c7fdcc76619edc8ed61bd25134eaa22084366a","020000006058aa080a655aa991a444bd7d1f2defd9a3bbe68aabb69030cf3b4e00000000d2e826bfd7ef0beaa891a7eedbc92cd6a544a6cb61c7bdaa436762eb2123ef9790f5f552ffff001d0002c90f0501000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0e0300c102024608062f503253482fffffffff01c0c6072a01000000232102e769e60137a4df6b0df8ebd387cca44c4c57ae74cc0114a8e8317c8f3bfd85e9ac00000000010000000381a0802911a01ffb025c4dea0bc77963e8c1bb46313b71164c53f72f37fe5248010000000151ffffffffc904b267833d215e2128bd9575242232ac2bc311550c7fc1f0ef6f264b40d14c010000000151ffffffffdf0915666649dba81886519c531649b7b02180b4af67d6885e871299e9d5f775000000000151ffffffff0180817dcb00000000232103bb52138972c48a132fc1f637858c5189607dd0f7fe40c4f20f6ad65f2d389ba4ac0000000001000000018da38b434fba82d66052af74fc5e4e94301b114d9bc03f819dc876398404c8b4010000006c493046022100fe738b7580dc5fb5168e51fc61b5aed211125eb71068031009a22d9bbad752c5022100be5086baa384d40bcab0fa586e4f728397388d86e18b66cc417dc4f7fa4f9878012103f233299455134caa2687bdf15cb0becdfb03bd0ff2ff38e65ec6b7834295c34fffffffff022ebc1400000000001976a9147779b7fba1c1e06b717069b80ca170e8b04458a488ac9879c40f000000001976a9142a0307cd925dbb66b534c4db33003dd18c57015788ac0000000001000000026139a62e3422a602de36c873a225c1d3ca5aeee598539ceecb9f0dc8d1ad0f83010000006b483045022100ad9f32b4a0a2ddc19b5a74eba78123e57616f1b3cfd72ce68c03ea35a3dda1f002200dbd22aa6da17213df5e70dfc3b2611d40f70c98ed9626aa5e2cde9d97461f0a012103ddb295d2f1e8319187738fb4b230fdd9aa29d0e01647f69f6d770b9ab24eea90ffffffff983c82c87cf020040d671956525014d5c2b28c6d948c85e1a522362c0059eeae010000006b4830450221009ca544274c786d30a5d5d25e17759201ea16d3aedddf0b9e9721246f7ef6b32e02202cfa5564b6e87dfd9fd98957820e4d4e6238baeb0f65fe305d91506bb13f5f4f012103c99113deac0d5d044e3ac0346abc02501542af8c8d3759f1382c72ff84e704f7ffffffff02c0c62d00000000001976a914ae19d27efe12f5a886dc79af37ad6805db6f922d88ac70ce2000000000001976a9143b8d051d37a07ea1042067e93efe63dbf73920b988ac000000000100000002be566e8cd9933f0c75c4a82c027f7d0c544d5c101d0607ef6ae5d07b98e7f1dc000000006b483045022036a8cdfd5ea7ebc06c2bfb6e4f942bbf9a1caeded41680d11a3a9f5d8284abad022100cacb92a5be3f39e8bc14db1710910ef7b395fa1e18f45d41c28d914fcdde33be012102bf59abf110b5131fae0a3ce1ec379329b4c896a6ae5d443edb68529cc2bc7816ffffffff96cf67645b76ceb23fe922874847456a15feee1655082ff32d25a6bf2c0dfc90000000006a47304402203471ca2001784a5ac0abab583581f2613523da47ec5f53df833c117b5abd81500220618a2847723d57324f2984678db556dbca1a72230fc7e39df04c2239942ba942012102925c9794fd7bb9f8b29e207d5fc491b1150135a21f505041858889fa4edf436fffffffff026c840f00000000001976a914797fb8777d7991d8284d88bfd421ce520f0f843188ac00ca9a3b000000001976a9146d10f3f592699265d10b106eda37c3ce793f7a8588ac00000000",["","","","76a9142903b138c24be9e070b3e73ec495d77a204615e788ac","76a91433a1941fd9a37b9821d376f5a51bd4b52fa50e2888ac","76a914e4374e8155d0865742ca12b8d4d14d41b57d682f88ac","76a914001fa7459a6cfc64bdc178ba7e7a21603bb2568f88ac","76a914f6039952bc2b307aeec5371bfb96b66078ec17f688ac"],"d34ef98386f413769502808d4bac5f20f8dfd5bffc9eedafaa71de0eb1f01489","0db414c859a07e8205876354a210a75042d0463404913d61a8e068e58a3ae2aa080026","c582d51c0ca365e3fcf36c51cb646d7f83a67e867cb4743fd2128e3e022b700c","Tx spends from empty output script"], +[926485,"000000000000015d6077a411a8f5cc95caf775ccf11c54e27df75ce58d187313","0000002060bbab0edbf3ef8a49608ee326f8fd75c473b7e3982095e2d100000000000000c30134f8c9b6d2470488d7a67a888f6fa12f8692e0c3411fbfb92f0f68f67eedae03ca57ef13021acc22dc4105010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff2f0315230e0004ae03ca57043e3d1e1d0c8796bf579aef0c0000000000122f4e696e6a61506f6f6c2f5345475749542fffffffff038427a112000000001976a914876fbb82ec05caa6af7a3b5e5a983aae6c6cc6d688ac0000000000000000266a24aa21a9ed5c748e121c0fe146d973a4ac26fa4a68b0549d46ee22d25f50a5e46fe1b377ee00000000000000002952534b424c4f434b3acd16772ad61a3c5f00287480b720f6035d5e54c9efc71be94bb5e3727f10909001200000000000000000000000000000000000000000000000000000000000000000000000000100000000010145310e878941a1b2bc2d33797ee4d89d95eaaf2e13488063a2aa9a74490f510a0100000023220020b6744de4f6ec63cc92f7c220cdefeeb1b1bed2b66c8e5706d80ec247d37e65a1ffffffff01002d3101000000001976a9143ebc40e411ed3c76f86711507ab952300890397288ac0400473044022001dd489a5d4e2fbd8a3ade27177f6b49296ba7695c40dbbe650ea83f106415fd02200b23a0602d8ff1bdf79dee118205fc7e9b40672bf31563e5741feb53fb86388501483045022100f88f040e90cc5dc6c6189d04718376ac19ed996bf9e4a3c29c3718d90ffd27180220761711f16c9e3a44f71aab55cbc0634907a1fa8bb635d971a9a01d368727bea10169522103b3623117e988b76aaabe3d63f56a4fc88b228a71e64c4cc551d1204822fe85cb2103dd823066e096f72ed617a41d3ca56717db335b1ea47a1b4c5c9dbdd0963acba621033d7c89bd9da29fa8d44db7906a9778b53121f72191184a9fee785c39180e4be153ae00000000010000000120925534261de4dcebb1ed5ab1b62bfe7a3ef968fb111dc2c910adfebc6e3bdf010000006b483045022100f50198f5ae66211a4f485190abe4dc7accdabe3bc214ebc9ea7069b97097d46e0220316a70a03014887086e335fc1b48358d46cd6bdc9af3b57c109c94af76fc915101210316cff587a01a2736d5e12e53551b18d73780b83c3bfb4fcf209c869b11b6415effffffff0220a10700000000001976a91450333046115eaa0ac9e0216565f945070e44573988ac2e7cd01a000000001976a914c01a7ca16b47be50cbdbc60724f701d52d75156688ac00000000010000000203a25f58630d7a1ea52550365fd2156683f56daf6ca73a4b4bbd097e66516322010000006a47304402204efc3d70e4ca3049c2a425025edf22d5ca355f9ec899dbfbbeeb2268533a0f2b02204780d3739653035af4814ea52e1396d021953f948c29754edd0ee537364603dc012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffff03a25f58630d7a1ea52550365fd2156683f56daf6ca73a4b4bbd097e66516322000000006a47304402202d96defdc5b4af71d6ba28c9a6042c2d5ee7bc6de565d4db84ef517445626e03022022da80320e9e489c8f41b74833dfb6a54a4eb5087cdb46eb663eef0b25caa526012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffff0200e1f5050000000017a914b7e6f7ff8658b2d1fb107e3d7be7af4742e6b1b3876f88fc00000000001976a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac0000000001000000043ffd60d3818431c495b89be84afac205d5d1ed663009291c560758bbd0a66df5010000006b483045022100f344607de9df42049688dcae8ff1db34c0c7cd25ec05516e30d2bc8f12ac9b2f022060b648f6a21745ea6d9782e17bcc4277b5808326488a1f40d41e125879723d3a012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffffa5379401cce30f84731ef1ba65ce27edf2cc7ce57704507ebe8714aa16a96b92010000006a473044022020c37a63bf4d7f564c2192528709b6a38ab8271bd96898c6c2e335e5208661580220435c6f1ad4d9305d2c0a818b2feb5e45d443f2f162c0f61953a14d097fd07064012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffff70e731e193235ff12c3184510895731a099112ffca4b00246c60003c40f843ce000000006a473044022053760f74c29a879e30a17b5f03a5bb057a5751a39f86fa6ecdedc36a1b7db04c022041d41c9b95f00d2d10a0373322a9025dba66c942196bc9d8adeb0e12d3024728012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffff66b7a71b3e50379c8e85fc18fe3f1a408fc985f257036c34702ba205cef09f6f000000006a4730440220499bf9e2db3db6e930228d0661395f65431acae466634d098612fd80b08459ee022040e069fc9e3c60009f521cef54c38aadbd1251aee37940e6018aadb10f194d6a012103f7a897e4dbecab2264b21917f90664ea8256189ea725d28740cf7ba5d85b5763ffffffff0200e1f5050000000017a9148fc37ad460fdfbd2b44fe446f6e3071a4f64faa6878f447f0b000000001976a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac00000000",["a914feb8a29635c56d9cd913122f90678756bf23887687","76a914c01a7ca16b47be50cbdbc60724f701d52d75156688ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac","76a914913bcc2be49cb534c20474c4dee1e9c4c317e7eb88ac"],"8f13b9a9c85611635b47906c3053ac53cfcec7211455d4cb0d63dc9acc13d472","09027acea61b6cc3fb33f5d52f7d088a6b2f75d234e89ca800","546c574a0472144bcaf9b6aeabf26372ad87c7af7d1ee0dbfae5e099abeae49c","Duplicate pushdata 913bcc2be49cb534c20474c4dee1e9c4c317e7eb"], +[987876,"0000000000000c00901f2049055e2a437c819d79a3d54fd63e6af796cd7b8a79","000000202694f74969fdb542090e95a56bc8aa2d646e27033850e32f1c5f000000000000f7e53676b3f12d5beb524ed617f2d25f5a93b5f4f52c1ba2678260d72712f8dd0a6dfe5740257e1a4b1768960101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff1603e4120ff9c30a1c216900002f424d4920546573742fffffff0001205fa012000000001e76a914c486de584a735ec2f22da7cd9681614681f92173d83d0aa68688ac00000000",[],"fe4d230dbb0f4fec9bed23a5283e08baf996e3f32b93f52c7de1f641ddfd04ad","010c0b40","0965a544743bbfa36f254446e75630c09404b3d164a261892372977538928ed5","Coinbase tx has unparseable output script"], +[1263442,"000000006f27ddfe1dd680044a34548f41bed47eba9e6f0b310da21423bc5f33","000000201c8d1a529c39a396db2db234d5ec152fa651a2872966daccbde028b400000000083f14492679151dbfaa1a825ef4c18518e780c1f91044180280a7d33f4a98ff5f45765aaddc001d38333b9a02010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff230352471300fe5f45765afe94690a000963676d696e6572343208000000000000000000ffffffff024423a804000000001976a914f2c25ac3d59f3d674b1d1d0a25c27339aaac0ba688ac0000000000000000266a24aa21a9edcb26cb3052426b9ebb4d19c819ef87c19677bbf3a7c46ef0855bd1b2abe83491012000000000000000000000000000000000000000000000000000000000000000000000000002000000000101d20978463906ba4ff5e7192494b88dd5eb0de85d900ab253af909106faa22cc5010000000004000000014777ff000000000016001446c29eabe8208a33aa1023c741fa79aa92e881ff0347304402207d7ca96134f2bcfdd6b536536fdd39ad17793632016936f777ebb32c22943fda02206014d2fb8a6aa58279797f861042ba604ebd2f8f61e5bddbd9d3be5a245047b201004b632103eeaeba7ce5dc2470221e9517fb498e8d6bd4e73b85b8be655196972eb9ccd5566754b2752103a40b74d43df244799d041f32ce1ad515a6cd99501701540e38750d883ae21d3a68ac00000000",["002027a5000c7917f785d8fc6e5a55adfca8717ecb973ebb7743849ff956d896a7ed"],"31d66d516a9eda7de865df29f6ef6cb8e4bf9309e5dac899968a9a62a5df61e3","0385acb4f0fe889ef0","4e6d564c2a2452065c205dd7eb2791124e0c4e0dbb064c410c24968572589dec","Includes witness data"], +[1414221,"0000000000000027b2b3b3381f114f674f481544ff2be37ae3788d7e078383b1","000000204ea88307a7959d8207968f152bedca5a93aefab253f1fb2cfb032a400000000070cebb14ec6dbc27a9dfd066d9849a4d3bac5f674665f73a5fe1de01a022a0c851fda85bf05f4c19a779d1450102000000010000000000000000000000000000000000000000000000000000000000000000ffffffff18034d94154d696e6572476174653030310d000000f238f401ffffffff01c817a804000000000000000000",[],"5e5e12d90693c8e936f01847859404c67482439681928353ca1296982042864e","00","021e8882ef5a0ed932edeebbecfeda1d7ce528ec7b3daa27641acf1189d7b5dc","Empty data"] +] diff --git a/src/Bitcoin/CompactFilter.hs b/src/Bitcoin/CompactFilter.hs new file mode 100644 --- /dev/null +++ b/src/Bitcoin/CompactFilter.hs @@ -0,0 +1,269 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE LambdaCase #-} +{-# OPTIONS_GHC -Wno-type-defaults #-} + +module Bitcoin.CompactFilter + ( BlockFilter + , blockFilter + , BlockFilterHeader + , blockFilterHeader + , filterHeaderToHex + , filterHeaderFromHex + , genesisHeader + , filterContents + , encodeFilter + , isMember + ) where + +import Control.Monad (replicateM, (>=>)) +import Control.Monad.Trans.Class (lift) +import Control.Monad.Trans.State.Strict (StateT, evalStateT) +import qualified Control.Monad.Trans.State.Strict as St +import Data.Bits (shiftL, shiftR, testBit) +import Data.Bitstream (Bitstream, Right) +import qualified Data.Bitstream as BiS +import Data.Bool (bool) +import Data.ByteArray.Hash (SipHash (..), SipKey (..), + sipHash) +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS +import Data.Foldable (foldl') +import Data.List (sort) +import Data.Serialize (Get, Serialize (..), decode, + encode, getWord16le, + getWord32le, getWord64le, + getWord8, putByteString, + putWord16le, putWord32le, + putWord64le, putWord8, + runGet) +import Data.Text (Text) +import Data.Word (Word64, Word8) +import Haskoin.Block (Block, BlockHash, + blockHeader, blockTxns, + headerHash) +import Haskoin.Crypto (Hash256, doubleSHA256) +import Haskoin.Script (Script (..), ScriptOp (..)) +import Haskoin.Transaction (scriptOutput, txOut) +import Haskoin.Util (decodeHex, encodeHex) + + +paramP :: Int +paramP = 19 + + +paramM :: Word64 +paramM = 784931 + + +-- | Hashes of scripts in the block +newtype BlockFilter = BlockFilter { blockFilter :: [Word64] } deriving (Eq, Show) + + +blockFilterSize :: BlockFilter -> CompactSize +blockFilterSize = CompactSize . length . blockFilter + + +newtype BlockFilterHeader = BlockFilterHeader { getBFHeader :: Hash256 } + deriving (Eq, Show, Ord, Serialize) + + +filterHeaderToHex :: BlockFilterHeader -> Text +filterHeaderToHex = encodeHex . BS.reverse . encode . getBFHeader + + +filterHeaderFromHex :: Text -> Either String BlockFilterHeader +filterHeaderFromHex = maybe (Left "Invalid hex") Right . decodeHex >=> decode . BS.reverse + + +genesisHeader :: BlockFilterHeader +Right genesisHeader = BlockFilterHeader <$> decode (BS.replicate 32 0x0) + + +blockFilterHeader :: BlockFilterHeader -> BlockFilter -> BlockFilterHeader +blockFilterHeader prev bf + = BlockFilterHeader . doubleSHA256 + $ (encode . doubleSHA256) (encode bf) <> encode (getBFHeader prev) + + +instance Serialize BlockFilter where + put bf = put (blockFilterSize bf) >> putByteString (constructGCS paramP $ blockFilter bf) + get = get >>= fmap BlockFilter . getGolombRiceSet paramP . unCompactSize + + +-- | Scripts in the block which belong in the BIP158 block filter +filterContents + :: [ByteString] + -- ^ previous output scripts spent in this block + -> Block + -> [ByteString] +filterContents prev b = filter scriptFilter prev <> these + where + these = filter scriptFilter . fmap scriptOutput $ blockTxns b >>= txOut + scriptFilter scr = not (BS.null scr) && contentFilter scr + + contentFilter bs = case decode bs of + Right (Script (OP_RETURN : _)) -> False + _ -> True + + +-- | Construct a BIP158 filter from a block +encodeFilter :: [ByteString] -> Block -> BlockFilter +encodeFilter os b = BlockFilter s + where + h = headerHash $ blockHeader b + bs = toSet $ filterContents os b + s = hashedSetConstruct (sipKey h) paramM (length bs) bs + + +-- | Test membership +isMember :: BlockHash -> [ByteString] -> BlockFilter -> Bool +isMember h bs (BlockFilter bf) = orderedScan hs bf + where + k = sipKey h + hs = hashedSetConstruct k paramM (length bf) bs + + +orderedScan :: [Word64] -> [Word64] -> Bool +orderedScan xs@(x : xs') hs@(h : hs') + | x > h = orderedScan xs hs' + | x < h = orderedScan xs' hs + | otherwise = True +orderedScan _ _ = False + + +type GetBits = StateT [Bool] Get + + +getGolombRiceSet :: Int -> Int -> Get [Word64] +getGolombRiceSet p n = fmap unDiffs . evalBitstream $ replicateM n getEncoded + where + getEncoded = do + q <- unaryPart + r <- fromBits <$> getBits p + return $ q * 2^p + r + + +unaryPart :: GetBits Word64 +unaryPart = go 0 + where + go q = getBit >>= bool (return q) (go $ q + 1) + getBit = head <$> getBits 1 + + +evalBitstream :: GetBits a -> Get a +evalBitstream = (`evalStateT` mempty) + + +getBits :: Int -> GetBits [Bool] +getBits n = do + bs <- St.get + let l = length bs + (q, r) = (n - l) `quotRem` 8 + + combine m t = bs <> mconcat m <> t + + lastByte + | r > 0 = getBs >>= takeSome r + | otherwise = mempty <$ St.put mempty + + getBs = byteBits <$> lift getWord8 + takeSome m xs = take m xs <$ St.put (drop m xs) + + if n < l + then takeSome n bs + else combine <$> replicateM q getBs <*> lastByte + + +sipKey :: BlockHash -> SipKey +sipKey h = SipKey k1 k2 + where + Right (k1, k2) = runGet word64Pair $ encode h + word64Pair = (,) <$> getWord64le <*> getWord64le + + +hashToRange :: Word64 -> SipKey -> ByteString -> Word64 +hashToRange f k bs = v + where + SipHash h = sipHash k bs + v = remap (fromIntegral f) (fromIntegral h) + + remap :: Integer -> Integer -> Word64 + remap x y = fromIntegral $ (x * y) `shiftR` 64 + + +hashedSetConstruct :: SipKey -> Word64 -> Int -> [ByteString] -> [Word64] +hashedSetConstruct k m n bs = toSet $ hashToRange f k <$> bs + where + f = fromIntegral n * m + + +toSet :: Ord a => [a] -> [a] +toSet = dedup . sort + where + dedup = \case + (x0 : xs@(x1 : _)) + | x0 == x1 -> dedup xs + | otherwise -> x0 : dedup xs + xs -> xs + + +constructGCS + :: Int + -- ^ modulus + -> [Word64] + -- ^ sorted list of input values + -> ByteString +constructGCS p + = BiS.toByteString + . foldMap (golombRiceEncode p) + . diffs + + +diffs :: Num a => [a] -> [a] +diffs xs = zipWith (-) xs (0 : xs) + + +unDiffs :: Num a => [a] -> [a] +unDiffs (x : xs) = scanl (+) x xs +unDiffs [] = [] + + +golombRiceEncode :: Int -> Word64 -> Bitstream Right +golombRiceEncode p v = x <> BiS.singleton False <> y + where + q = fromIntegral $ v `shiftR` p + x = BiS.replicate q True + y = BiS.fromNBits p v + + +fromBits :: Num a => [Bool] -> a +fromBits = foldl' onBit 0 + where + onBit n b = 2 * n + bool 0 1 b + + +byteBits :: Word8 -> [Bool] +byteBits b = testBit b <$> reverse [0 .. 7] + + +newtype CompactSize = CompactSize { unCompactSize :: Int } deriving (Eq, Ord, Enum, Num, Real, Integral) + + +instance Serialize CompactSize where + get = CompactSize <$> (getWord8 >>= getCS) + where + getCS s + | s < 253 = return $ fromIntegral s + | s == 253 = fromIntegral <$> getWord16le + | s == 254 = fromIntegral <$> getWord32le + | otherwise = fromIntegral <$> getWord64le + + put (CompactSize n) + | n < 0 = error $ "Invalid CompactSize: " <> show n + | n < 253 = putWord8 (fromIntegral n) + | n < bound16 = putWord8 253 >> putWord16le (fromIntegral n) + | n < bound32 = putWord8 254 >> putWord32le (fromIntegral n) + | otherwise = putWord8 255 >> putWord64le (fromIntegral n) + where + bound16 = 1 `shiftL` 16 + bound32 = 1 `shiftL` 32 diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,56 @@ +module Main where + +import Data.Serialize (decode, encode) +import Haskoin.Block (blockHeader, headerHash) +import Test.Tasty (TestTree, defaultMain, testGroup) +import Test.Tasty.HUnit (testCase, (@?=)) +import Test.Tasty.QuickCheck (elements, forAll, testProperty, (===)) + +import Bitcoin.CompactFilter (blockFilterHeader, encodeFilter, + filterContents, isMember) +import Test.CompactFilter (genBlockFilter) +import qualified Test.Examples.Bip as BIP +import qualified Test.Examples.Mainnet as Mainnet +import Test.Util (Example (..)) + + +main :: IO () +main = do + bipExamples <- BIP.examples + mainnetExamples <- Mainnet.examples + defaultMain . testGroup "bip158 unit tests" $ + [ testGroup "Serialization" [testRoundtrip] + , testGroup "Filter" + [ testGroup "BIP 158" $ testFilter <$> bipExamples + , testGroup "Mainnet" $ testFilter <$> mainnetExamples + ] + ] + + +testRoundtrip :: TestTree +testRoundtrip = testProperty "serialization round trip" . forAll genBlockFilter $ \bf -> + decode (encode bf) === Right bf + + +testFilter :: Example -> TestTree +testFilter v = testGroup (testLabel v) $ [ construction ] <> [ membership | not (null ss) ] + + where + + construction = testCase "Construction" $ do + ourFilter @?= exampleFilter v + ourHeader @?= exampleHeader v + + membership = testProperty "Filter membership" $ forAll (elements ss) $ \s -> + isMember bh [s] ourFilter + + ourFilter = encodeFilter (examplePrevOuts v) block + ourHeader = blockFilterHeader (examplePrevHeader v) ourFilter + bh = headerHash $ blockHeader block + ss = filterContents (examplePrevOuts v) block + + block = exampleBlock v + + +testLabel :: Example -> String +testLabel e = "Block " <> show (exampleHeight e) diff --git a/test/Test/CompactFilter.hs b/test/Test/CompactFilter.hs new file mode 100644 --- /dev/null +++ b/test/Test/CompactFilter.hs @@ -0,0 +1,19 @@ +module Test.CompactFilter + ( genBlockFilter + ) where + +import Control.Monad (replicateM) +import Haskoin.Constants (btc) +import Haskoin.Util.Arbitrary.Block (arbitraryBlock) +import Haskoin.Util.Arbitrary.Util (arbitraryBS1) +import Test.Tasty.QuickCheck (Gen, choose) + +import Bitcoin.CompactFilter (BlockFilter, encodeFilter) + + +genBlockFilter :: Gen BlockFilter +genBlockFilter = encodeFilter <$> scripts <*> arbitraryBlock btc + where + scripts = do + n <- choose (1, 100) + replicateM n arbitraryBS1 diff --git a/test/Test/Examples/Bip.hs b/test/Test/Examples/Bip.hs new file mode 100644 --- /dev/null +++ b/test/Test/Examples/Bip.hs @@ -0,0 +1,33 @@ +{-# OPTIONS_GHC -Wno-type-defaults #-} + +module Test.Examples.Bip + ( examples + ) where + +import Data.Aeson (eitherDecodeFileStrict) +import Data.Text (Text) +import Haskoin.Block (BlockHeight) + +import Bitcoin.CompactFilter (filterHeaderFromHex) +import Paths_bitcoin_compact_filters (getDataFileName) +import Test.Util (Example (..), decodeFromHex, + parseHex) + + +examples :: IO [Example] +examples + = getDataFileName "examples/testnet-19.json" + >>= eitherDecodeFileStrict + >>= either error return . (>>= traverse interpretRawVector) + + +interpretRawVector + :: (BlockHeight, Text, Text, [Text], Text, Text, Text, Text) + -> Either String Example +interpretRawVector (n, h, b, ss, ph, f, fh, _) + = Example n <$> decodeFromHex h + <*> decodeFromHex b + <*> traverse parseHex ss + <*> decodeFromHex f + <*> filterHeaderFromHex ph + <*> filterHeaderFromHex fh diff --git a/test/Test/Examples/Mainnet.hs b/test/Test/Examples/Mainnet.hs new file mode 100644 --- /dev/null +++ b/test/Test/Examples/Mainnet.hs @@ -0,0 +1,12 @@ +module Test.Examples.Mainnet + ( examples + ) where + +import Data.Aeson (eitherDecodeFileStrict) + +import Paths_bitcoin_compact_filters (getDataFileName) +import Test.Util (Example) + + +examples :: IO [Example] +examples = getDataFileName "examples/examples.json" >>= eitherDecodeFileStrict >>= either error return diff --git a/test/Test/Util.hs b/test/Test/Util.hs new file mode 100644 --- /dev/null +++ b/test/Test/Util.hs @@ -0,0 +1,54 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Test.Util + ( Example (..) + , decodeFromHex + , parseHex + ) where + +import Control.Monad ((>=>)) +import Data.Aeson (FromJSON (..), withObject, (.:)) +import Data.Aeson.Types (Parser) +import Data.ByteString (ByteString) +import Data.Serialize (Serialize, decode) +import Data.Text (Text) +import Haskoin.Block (Block, BlockHash, BlockHeight) +import qualified Haskoin.Util as U + +import Bitcoin.CompactFilter (BlockFilter, BlockFilterHeader, + filterHeaderFromHex) + + +decodeFromHex :: Serialize a => Text -> Either String a +decodeFromHex = parseHex >=> decode + + +parseHex :: Text -> Either String ByteString +parseHex = maybe (Left "Bad hex") Right . U.decodeHex + + +data Example = Example + { exampleHeight :: BlockHeight + , exampleBlockHash :: BlockHash + , exampleBlock :: Block + , examplePrevOuts :: [ByteString] + , exampleFilter :: BlockFilter + , examplePrevHeader :: BlockFilterHeader + , exampleHeader :: BlockFilterHeader + } deriving (Eq, Show) + + +instance FromJSON Example where + parseJSON = withObject "Example" $ \obj -> + Example + <$> obj .: "height" + <*> (fromHex =<< obj .: "block_hash") + <*> (fromHex =<< obj .: "block") + <*> (either fail return . traverse parseHex =<< obj .: "prev_outs") + <*> (fromHex =<< obj .: "filter") + <*> (either fail return . filterHeaderFromHex =<< obj .: "prev_filter_header") + <*> (either fail return . filterHeaderFromHex =<< obj .: "filter_header") + + +fromHex :: Serialize a => Text -> Parser a +fromHex = either fail return . decodeFromHex