BSV.PrivKey (BSV v2.0.0) View Source

A PrivKey is a data structure representing a Bitcoin private key.

Internally, a private key is a secret 256-bit integer within the range of the ECDSA secp256k1 parmaeters. Each private key corresponds to a public key which is a coordinate on the secp256k1 curve.

Link to this section Summary

Types

privkey_bin()

Private key 256-bit binary

privkey_wif()

Wallet Import Format private key

t()

Private key struct

Functions

from_binary(privkey, opts \\ [])

Parses the given binary into a BSV.PrivKey.t/0.

from_binary!(privkey, opts \\ [])

Parses the given binary into a BSV.PrivKey.t/0.

from_wif(wif)

Decodes the given BSV.PrivKey.privkey_wif/0 into a BSV.PrivKey.t/0.

from_wif!(wif)

Decodes the given BSV.PrivKey.privkey_wif/0 into a BSV.PrivKey.t/0.

new(opts \\ [])

Generates and returns a new BSV.PrivKey.t/0.

to_binary(priv_key, opts \\ [])

Serialises the given BSV.PrivKey.t/0 into a binary.

to_wif(priv_key)

Encodes the given BSV.PrivKey.t/0 as a BSV.PrivKey.privkey_wif/0.

Link to this section Types

privkey_bin()

Specs

privkey_bin() :: <<_::256>>

Private key 256-bit binary

privkey_wif()

Specs

privkey_wif() :: String.t()

Wallet Import Format private key

WIF encoded keys is a common way to represent private Keys in Bitcoin. WIF encoded keys are shorter and include a built-in error checking and a type byte.

t()

Specs

t() :: %BSV.PrivKey{compressed: boolean(), d: privkey_bin()}

Private key struct

Link to this section Functions

from_binary(privkey, opts \\ [])

Specs

from_binary(binary(), keyword()) :: {:ok, t()} | {:error, term()}

Parses the given binary into a BSV.PrivKey.t/0.

Returns the result in an :ok / :error tuple pair.

Options

The accepted options are:

:compressed - Denotes whether the correspding BSV.PubKey.t/0 is compressed on not. Defaults true.
:encoding - Optionally decode the binary with either the :base64 or :hex encoding scheme.

Examples

iex> PrivKey.from_binary("3cff04633088622e4599dc2ebf843f82cef3463b910d34a752a13622abae379b", encoding: :hex)
{:ok, %PrivKey{
  d: <<60, 255, 4, 99, 48, 136, 98, 46, 69, 153, 220, 46, 191, 132, 63, 130, 206, 243, 70, 59, 145, 13, 52, 167, 82, 161, 54, 34, 171, 174, 55, 155>>
}}

from_binary!(privkey, opts \\ [])

Specs

from_binary!(binary(), keyword()) :: t()

Parses the given binary into a BSV.PrivKey.t/0.

As from_binary/2 but returns the result or raises an exception.

from_wif(wif)

Specs

from_wif(privkey_wif()) :: {:ok, t()} | {:error, term()}

Decodes the given BSV.PrivKey.privkey_wif/0 into a BSV.PrivKey.t/0.

Returns the result in an :ok / :error tuple pair.

Examples

iex> PrivKey.from_wif("KyGHAK8MNohVPdeGPYXveiAbTfLARVrQuJVtd3qMqN41UEnTWDkF")
{:ok, %PrivKey{
  d: <<60, 255, 4, 99, 48, 136, 98, 46, 69, 153, 220, 46, 191, 132, 63, 130, 206, 243, 70, 59, 145, 13, 52, 167, 82, 161, 54, 34, 171, 174, 55, 155>>
}}

from_wif!(wif)

Specs

from_wif!(privkey_wif()) :: t()

Decodes the given BSV.PrivKey.privkey_wif/0 into a BSV.PrivKey.t/0.

As from_wif/1 but returns the result or raises an exception.

new(opts \\ [])

Specs

new(keyword()) :: t()

Generates and returns a new BSV.PrivKey.t/0.

Options

The accepted options are:

:compressed - Denotes whether the correspding BSV.PubKey.t/0 is compressed on not. Defaults true.

to_binary(priv_key, opts \\ [])

Serialises the given BSV.PrivKey.t/0 into a binary.

Options

The accepted options are:

:encoding - Optionally encode the binary with either the :base64 or :hex encoding scheme.

Examples

iex> PrivKey.to_binary(@privkey, encoding: :hex)
"3cff04633088622e4599dc2ebf843f82cef3463b910d34a752a13622abae379b"

to_wif(priv_key)

Specs

to_wif(t()) :: privkey_wif()

Encodes the given BSV.PrivKey.t/0 as a BSV.PrivKey.privkey_wif/0.

Examples

iex> PrivKey.to_wif(@privkey)
"KyGHAK8MNohVPdeGPYXveiAbTfLARVrQuJVtd3qMqN41UEnTWDkF"