Bitcoin.Protocol.Key

Encoding/decoding of public and private keys

private keys

newtype PrivKey

The private key is a random number in the interval [1,n-1] (n being secp256k1_n)

Constructors

PrivKey

Fields

• fromPrivKey :: Integer

Instances

Eq PrivKey

Methods

(==) :: PrivKey -> PrivKey -> Bool

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

Show PrivKey

Methods

showsPrec :: Int -> PrivKey -> ShowS

show :: PrivKey -> String

showList :: [PrivKey] -> ShowS

generatePrivKeyIO :: IO PrivKey

Generates a private key with the built-in random generator.

WARNING: this probably doesn't have enough entropy, use only for testing!

generatePrivKey :: RandomGen gen => gen -> (PrivKey, gen)

Generates a private key using the supplied random generator.

WARNING! You are responsible for the random generator having enough entropy! (be careful not to have a constant seed, for example...)

encodePrivKey32 :: PrivKey -> ByteString

Simple 32 byte big-endian integer format

decodePrivKey32 :: ByteString -> PrivKey

Simple 32 byte big-endian integer format

wallet import format for private keys

newtype WIF

Wallet Import Format

Constructors

WIF

Fields

• unWIF :: String

Instances

Eq WIF

Methods

(==) :: WIF -> WIF -> Bool

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

Show WIF

Methods

showsPrec :: Int -> WIF -> ShowS

show :: WIF -> String

showList :: [WIF] -> ShowS

privKeyWIFEncode :: PubKeyFormat -> PrivKey -> WIF

Encode to Wallet Import Format (WIF)

privKeyWIFDecode :: WIF -> Maybe (PubKeyFormat, PrivKey)

Decode from Wallet Import Format (WIF)

public keys

data PubKey

The public key (which is the point priv*G on the curve, G being the generator), either in long format (both coordinates) or short format (x coordinate plus parity of y)

Constructors

FullPubKey !Integer !Integer

x y

ComprPubKey !Word8 !Integer

only x; the single byte encodes the parity of y (then we have the curve equation)

Instances

Eq PubKey

Methods

(==) :: PubKey -> PubKey -> Bool

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

Show PubKey

Methods

showsPrec :: Int -> PubKey -> ShowS

show :: PubKey -> String

showList :: [PubKey] -> ShowS

data PubKeyFormat

Unfortunately there is this mess with compressed/uncompressed formats :(

See http://bitcoin.stackexchange.com/questions/7299/when-importing-private-keys-will-compressed-or-uncompressed-format-be-used

Constructors

Uncompressed

Compressed

Instances

Eq PubKeyFormat

Methods

(==) :: PubKeyFormat -> PubKeyFormat -> Bool

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

Show PubKeyFormat

Methods

showsPrec :: Int -> PubKeyFormat -> ShowS

show :: PubKeyFormat -> String

showList :: [PubKeyFormat] -> ShowS

pubKeyFormat :: PubKey -> PubKeyFormat

newtype PubKeyHash

The 160-bit hash of a public key

Constructors

PubKeyHash

Fields

• fromPubKeyHash :: Hash160

Instances

Eq PubKeyHash

Methods

(==) :: PubKeyHash -> PubKeyHash -> Bool

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

Show PubKeyHash

Methods

showsPrec :: Int -> PubKeyHash -> ShowS

show :: PubKeyHash -> String

showList :: [PubKeyHash] -> ShowS

OctetStream PubKeyHash

Methods

toByteString :: PubKeyHash -> ByteString

toWord8List :: PubKeyHash -> [Word8]

unsafeToCharList :: PubKeyHash -> [Char]

toIntegerLE :: PubKeyHash -> Integer

toIntegerBE :: PubKeyHash -> Integer

fromByteString :: ByteString -> PubKeyHash

fromWord8List :: [Word8] -> PubKeyHash

fromCharList :: [Char] -> PubKeyHash

fromIntegerLE :: Integer -> PubKeyHash

fromIntegerBE :: Integer -> PubKeyHash

pubKeyHash :: PubKey -> PubKeyHash

decodePubKey :: OctetStream a => a -> Maybe PubKey

Decode public key from 3365 bytes long (compresseduncompressed) octet streams

encodePubKeyNative :: PubKey -> ByteString

Encodes the public key as it is represented (either compressed 33 bytes or uncompressed 65 bytes)

encodePubKey' :: PubKeyFormat -> PubKey -> ByteString

Encodes a public key according to the specified format

encodePubKeyLong :: PubKey -> ByteString

Encodes a public key as a 65 byte ByteString (uncompressed)

encodePubKeyShort :: PubKey -> ByteString

Encodes a public key as a 33 byte ByteString (compressed)

computations on keys

computePubKey :: PubKeyFormat -> PrivKey -> PubKey

Computes the public key in the given format

computeFullPubKey :: PrivKey -> PubKey

isValidPubKey :: PubKey -> Bool

formatPubKey :: PubKeyFormat -> PubKey -> PubKey

Changes a pubkey to the given format

uncompressPubKey :: PubKey -> Maybe PubKey

Uncompresses a public key. This may actually fail if there is no point (x,y) on the curve for any y.

compressPubKey :: PubKey -> PubKey

Compresses a public key