Haskoin.Network.Bloom

Bloom filters are used to reduce data transfer when synchronizing thin cients. When bloom filters are used a client will obtain filtered blocks that only contain transactions that pass the bloom filter. Transactions announced via inv messages also pass the filter.

Bloom Filters

data BloomFlags

The bloom flags are used to tell the remote peer how to auto-update the provided bloom filter.

Constructors

BloomUpdateNone

never update

BloomUpdateAll

auto-update on all outputs

BloomUpdateP2PubKeyOnly

auto-update on pay-to-pubkey or pay-to-multisig (default)

Instances

Eq BloomFlags

Defined in Haskoin.Network.Bloom

Methods

(==) :: BloomFlags -> BloomFlags -> Bool

(/=) :: BloomFlags -> BloomFlags -> Bool

Read BloomFlags

Defined in Haskoin.Network.Bloom

Methods

readsPrec :: Int -> ReadS BloomFlags

readList :: ReadS [BloomFlags]

readPrec :: ReadPrec BloomFlags

readListPrec :: ReadPrec [BloomFlags]

Show BloomFlags

Defined in Haskoin.Network.Bloom

Methods

showsPrec :: Int -> BloomFlags -> ShowS

show :: BloomFlags -> String

showList :: [BloomFlags] -> ShowS

Generic BloomFlags

Defined in Haskoin.Network.Bloom

Associated Types

type Rep BloomFlags :: Type -> Type

Methods

from :: BloomFlags -> Rep BloomFlags x

to :: Rep BloomFlags x -> BloomFlags

Binary BloomFlags

Defined in Haskoin.Network.Bloom

Methods

put :: BloomFlags -> Put

get :: Get BloomFlags

putList :: [BloomFlags] -> Put

Serial BloomFlags

Defined in Haskoin.Network.Bloom

Methods

serialize :: MonadPut m => BloomFlags -> m ()

deserialize :: MonadGet m => m BloomFlags

Serialize BloomFlags

Defined in Haskoin.Network.Bloom

Methods

put :: Putter BloomFlags

get :: Get BloomFlags

NFData BloomFlags

Defined in Haskoin.Network.Bloom

Methods

rnf :: BloomFlags -> ()

type Rep BloomFlags

Defined in Haskoin.Network.Bloom

type Rep BloomFlags = D1 ('MetaData "BloomFlags" "Haskoin.Network.Bloom" "haskoin-core-0.21.2-inplace" 'False) (C1 ('MetaCons "BloomUpdateNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BloomUpdateAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BloomUpdateP2PubKeyOnly" 'PrefixI 'False) (U1 :: Type -> Type)))

data BloomFilter

A bloom filter is a probabilistic data structure that SPV clients send to other peers to filter the set of transactions received from them. Bloom filters can have false positives but not false negatives. Some transactions that pass the filter may not be relevant to the receiving peer. By controlling the false positive rate, SPV nodes can trade off bandwidth versus privacy.

Constructors

BloomFilter

Fields

• bloomData :: !(Seq Word8)

  bloom filter data

• bloomHashFuncs :: !Word32

  number of hash functions for this filter

• bloomTweak :: !Word32

  hash function random nonce

• bloomFlags :: !BloomFlags

  bloom filter auto-update flags

Instances

Eq BloomFilter

Defined in Haskoin.Network.Bloom

Methods

(==) :: BloomFilter -> BloomFilter -> Bool

(/=) :: BloomFilter -> BloomFilter -> Bool

Read BloomFilter

Defined in Haskoin.Network.Bloom

Methods

readsPrec :: Int -> ReadS BloomFilter

readList :: ReadS [BloomFilter]

readPrec :: ReadPrec BloomFilter

readListPrec :: ReadPrec [BloomFilter]

Show BloomFilter

Defined in Haskoin.Network.Bloom

Methods

showsPrec :: Int -> BloomFilter -> ShowS

show :: BloomFilter -> String

showList :: [BloomFilter] -> ShowS

Generic BloomFilter

Defined in Haskoin.Network.Bloom

Associated Types

type Rep BloomFilter :: Type -> Type

Methods

from :: BloomFilter -> Rep BloomFilter x

to :: Rep BloomFilter x -> BloomFilter

Binary BloomFilter

Defined in Haskoin.Network.Bloom

Methods

put :: BloomFilter -> Put

get :: Get BloomFilter

putList :: [BloomFilter] -> Put

Serial BloomFilter

Defined in Haskoin.Network.Bloom

Methods

serialize :: MonadPut m => BloomFilter -> m ()

deserialize :: MonadGet m => m BloomFilter

Serialize BloomFilter

Defined in Haskoin.Network.Bloom

Methods

put :: Putter BloomFilter

get :: Get BloomFilter

NFData BloomFilter

Defined in Haskoin.Network.Bloom

Methods

rnf :: BloomFilter -> ()

type Rep BloomFilter

Defined in Haskoin.Network.Bloom

type Rep BloomFilter = D1 ('MetaData "BloomFilter" "Haskoin.Network.Bloom" "haskoin-core-0.21.2-inplace" 'False) (C1 ('MetaCons "BloomFilter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bloomData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Seq Word8)) :*: S1 ('MetaSel ('Just "bloomHashFuncs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "bloomTweak") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "bloomFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BloomFlags))))

newtype FilterLoad

Set a new bloom filter on the peer connection.

Constructors

FilterLoad

Fields

• filterLoadBloomFilter :: BloomFilter

Instances

Eq FilterLoad

Defined in Haskoin.Network.Bloom

Methods

(==) :: FilterLoad -> FilterLoad -> Bool

(/=) :: FilterLoad -> FilterLoad -> Bool

Read FilterLoad

Defined in Haskoin.Network.Bloom

Methods

readsPrec :: Int -> ReadS FilterLoad

readList :: ReadS [FilterLoad]

readPrec :: ReadPrec FilterLoad

readListPrec :: ReadPrec [FilterLoad]

Show FilterLoad

Defined in Haskoin.Network.Bloom

Methods

showsPrec :: Int -> FilterLoad -> ShowS

show :: FilterLoad -> String

showList :: [FilterLoad] -> ShowS

Generic FilterLoad

Defined in Haskoin.Network.Bloom

Associated Types

type Rep FilterLoad :: Type -> Type

Methods

from :: FilterLoad -> Rep FilterLoad x

to :: Rep FilterLoad x -> FilterLoad

Binary FilterLoad

Defined in Haskoin.Network.Bloom

Methods

put :: FilterLoad -> Put

get :: Get FilterLoad

putList :: [FilterLoad] -> Put

Serial FilterLoad

Defined in Haskoin.Network.Bloom

Methods

serialize :: MonadPut m => FilterLoad -> m ()

deserialize :: MonadGet m => m FilterLoad

Serialize FilterLoad

Defined in Haskoin.Network.Bloom

Methods

put :: Putter FilterLoad

get :: Get FilterLoad

NFData FilterLoad

Defined in Haskoin.Network.Bloom

Methods

rnf :: FilterLoad -> ()

type Rep FilterLoad

Defined in Haskoin.Network.Bloom

type Rep FilterLoad = D1 ('MetaData "FilterLoad" "Haskoin.Network.Bloom" "haskoin-core-0.21.2-inplace" 'True) (C1 ('MetaCons "FilterLoad" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterLoadBloomFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BloomFilter)))

newtype FilterAdd

Add the given data element to the connections current filter without requiring a completely new one to be set.

Constructors

FilterAdd

Fields

• getFilterData :: ByteString

Instances

Eq FilterAdd

Defined in Haskoin.Network.Bloom

Methods

(==) :: FilterAdd -> FilterAdd -> Bool

(/=) :: FilterAdd -> FilterAdd -> Bool

Read FilterAdd

Defined in Haskoin.Network.Bloom

Methods

readsPrec :: Int -> ReadS FilterAdd

readList :: ReadS [FilterAdd]

readPrec :: ReadPrec FilterAdd

readListPrec :: ReadPrec [FilterAdd]

Show FilterAdd

Defined in Haskoin.Network.Bloom

Methods

showsPrec :: Int -> FilterAdd -> ShowS

show :: FilterAdd -> String

showList :: [FilterAdd] -> ShowS

Generic FilterAdd

Defined in Haskoin.Network.Bloom

Associated Types

type Rep FilterAdd :: Type -> Type

Methods

from :: FilterAdd -> Rep FilterAdd x

to :: Rep FilterAdd x -> FilterAdd

Binary FilterAdd

Defined in Haskoin.Network.Bloom

Methods

put :: FilterAdd -> Put

get :: Get FilterAdd

putList :: [FilterAdd] -> Put

Serial FilterAdd

Defined in Haskoin.Network.Bloom

Methods

serialize :: MonadPut m => FilterAdd -> m ()

deserialize :: MonadGet m => m FilterAdd

Serialize FilterAdd

Defined in Haskoin.Network.Bloom

Methods

put :: Putter FilterAdd

get :: Get FilterAdd

NFData FilterAdd

Defined in Haskoin.Network.Bloom

Methods

rnf :: FilterAdd -> ()

type Rep FilterAdd

Defined in Haskoin.Network.Bloom

type Rep FilterAdd = D1 ('MetaData "FilterAdd" "Haskoin.Network.Bloom" "haskoin-core-0.21.2-inplace" 'True) (C1 ('MetaCons "FilterAdd" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFilterData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

bloomCreate

Arguments

:: Int

number of elements

-> Double

false positive rate

-> Word32

random nonce (tweak) for the hash function

-> BloomFlags

bloom filter flags

-> BloomFilter

bloom filter

Build a bloom filter that will provide the given false positive rate when the given number of elements have been inserted.

bloomInsert

Arguments

:: BloomFilter

Original bloom filter

-> ByteString

New data to insert

-> BloomFilter

Bloom filter containing the new data

Insert arbitrary data into a bloom filter. Returns the new bloom filter containing the new data.

bloomContains

Arguments

:: BloomFilter

Bloom filter

-> ByteString

Data that will be checked against the given bloom filter

-> Bool

Returns True if the data matches the filter

Tests if some arbitrary data matches the filter. This can be either because the data was inserted into the filter or because it is a false positive.

isBloomValid

Arguments

:: BloomFilter

Bloom filter to test

-> Bool

True if the given filter is valid

Tests if a given bloom filter is valid.

isBloomEmpty :: BloomFilter -> Bool

Returns True if the filter is empty (all bytes set to 0x00)

isBloomFull :: BloomFilter -> Bool

Returns True if the filter is full (all bytes set to 0xff)

acceptsFilters :: Word64 -> Bool

Does the peer with these version services accept bloom filters?

bloomRelevantUpdate

Arguments

:: BloomFilter

Bloom filter

-> Tx

Tx that may (or may not) have relevant outputs

-> Maybe BloomFilter

Returns an updated bloom filter adding relevant output

Checks if any of the outputs of a tx is in the current bloom filter. If it is, add the txid and vout as an outpoint (i.e. so that a future tx that spends the output won't be missed).