BitcoinLib v0.4.7

View Source BitcoinLib.Key.PublicKey.Serialization (BitcoinLib v0.4.7)

Extended public key serialization module

To test the results, use https://www.npmjs.com/package/@swan-bitcoin/xpub-cli Serialization types: https://github.com/satoshilabs/slips/blob/master/slip-0132.md

Link to this section Summary

Functions

serialize(pub_key, arg2, arg3)

Serialization of a master public key into an exportable version

Link to this section Functions

Link to this function

serialize(pub_key, arg2, arg3)

View Source 
@spec serialize(
  BitcoinLib.Key.PublicKey.t(),
  :mainnet | :testnet,
  :bip32 | :bip49 | :bip84
) ::
  {:ok, binary()} | {:error, binary()}

Serialization of a master public key into an exportable version

values from https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#test-vector-1

examples

 Examples 

iex> %BitcoinLib.Key.PublicKey{
...>   key: <<0x339A36013301597DAEF41FBE593A02CC513D0B55527EC2DF1050E2E8FF49C85C2::264>>,
...>   chain_code: <<0x873DFF81C02F525623FD1FE5167EAC3A55A049DE3D314BB42EE227FFED37D508::256>>,
...>   depth: 0,
...>   index: 0,
...>   parent_fingerprint: <<0::32>>
...> }
...> |> BitcoinLib.Key.PublicKey.Serialization.serialize(:mainnet, :bip32)
{
  :ok,
  "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
}