Crypto.Multihash.Weak

Multihash library built on top of haskell cryptonite crypto package Multihash is a protocol for encoding the hash algorithm and digest length at the start of the digest, see the official multihash poroposal github repo.

The Weak module contains a weaker implementation of the MultihashDigest type that allows to deserialize multihashes and to work with different algorithms at the same type. The API interface is almost identical to the one exposed by Multihash. The notable differences are:

• the hash algorithms is no longer a type
• the type returned by the multihash constructors is an Either (see weakMultihash and weakMultihashlazy)
• there is a function toWeakMultihash to deserialise multihashes

For additional informations refer to the README.md or the gihub repository.

Weak Multihash Types

data WeakMultihashDigest

Weak Multihash Digest container

Instances

Eq WeakMultihashDigest

Show WeakMultihashDigest

Encodable WeakMultihashDigest

data Base

Base usable to encode the digest

Constructors

Base2

Binary form

Base16

Hex encoding

Base32

Avoid. Wait for this issue to resolve

Base58

Bitcoin base58 encoding

Base64

Base64 encoding

Instances

Eq Base

Show Base

class Encodable a where

Minimal complete definition

encode, check

Methods

encode :: IsString s => Base -> a -> Either String s

Safe encoder for Encodable.

encode' :: IsString s => Base -> a -> s

Unsafe encoder for Encodable. Throws an error if there are encoding issues.

check :: (IsString s, ConvertibleStrings s ByteString) => s -> a -> Either String Bool

Safely check the correctness of an encoded Encodable against a plain Encodable.

check' :: (IsString s, ConvertibleStrings s ByteString) => s -> a -> Bool

Unsafe version of check. Throws on encoding/decoding errors instead of returning an Either type.

Instances

Encodable WeakMultihashDigest

(HashAlgorithm a, Codable a) => Encodable (MultihashDigest a)

Weak Multihash Helpers

weakMultihash :: ByteArrayAccess bs => ByteString -> bs -> Either String WeakMultihashDigest

Helper to multihash a ByteArrayAccess (e.g. a ByteString) using a supported hash algorithm. Uses hash for hashing.

weakMultihash' :: ByteArrayAccess bs => ByteString -> bs -> WeakMultihashDigest

Unsafe equivalent of weakMultihash. Throws on creation errors.

weakMultihashlazy :: ByteString -> ByteString -> Either String WeakMultihashDigest

Helper to multihash a lazy ByteString using a supported hash algorithm. Uses hashlazy for hashing.

weakMultihashlazy' :: ByteString -> ByteString -> WeakMultihashDigest

Unsafe equivalent of weakMultihashlazy. Throws on creation errors.

truncatedWeakMultihash :: ByteArrayAccess bs => Int -> ByteString -> bs -> Either String WeakMultihashDigest

Helper to multihash a ByteArrayAccess using a supported hash algorithm. Uses hash for hashing and truncates the hash to the lenght specified (must be positive and not longer than the digest length).

truncatedWeakMultihash' :: ByteArrayAccess bs => Int -> ByteString -> bs -> WeakMultihashDigest

Unsafe helper to multihash a ByteArrayAccess using a supported hash algorithm. Uses hash for hashing and truncates the hash to the lenght specified (must be positive and not longer than the digest length, otherwise the function will throw an error).

toWeakMultihash :: ByteString -> Either String WeakMultihashDigest

Imports a multihash into a WeahMultihashDigest if possible.

checkWeakMultihash :: (IsString s, ConvertibleStrings s ByteString, ByteArrayAccess bs) => s -> bs -> Either String Bool

Safely check the correctness of an encoded Encodable against the corresponding data.

checkWeakMultihash' :: (IsString s, ConvertibleStrings s ByteString, ByteArrayAccess bs) => s -> bs -> Bool

Unsafe version of checkWeakMultihash. Throws on encoding/decoding errors instead of returning an Either type.

getBase :: ByteString -> Either String Base

Infer the Base encoding function from an encoded BinaryString. Supports only Base16, bitcoin Base58 and Base64 for the moment. NOTE: it can fail or _infer the wrong encoding_ if the string is too short or if it is encoded using a different standard.