View Source Signet.Util.RecoveryBit (Signet v1.3.8)

There are a number of ways to look at recovery bits. Either:

  • :base: In the range {0,1}, which are the outputs of a signer library
  • :ethereum: In the range {27,28}, as defined in the yellow paper
  • :eip155: In the range {35+chain_id*2,35+chain_id*2+1}, as defined in EIP-155

This module provides tools between switching through these choices.

Summary

Types

rec_type()

Functions

normalize(recovery_bit, rec_type \\ :eip155)

Normalizes a binary-encoded signature to the given requested type, i.e. :base, :ethereum, or :eip155.

normalize_signature(arg, rec_type \\ :eip155)

Normalizes a binary-encoded signature to the given requested type, i.e. :base, :ethereum, or :eip155.

recover_base(v)

Normalizes a recovery bit to be either 0 or 1.

Types

Link to this type

rec_type()

View Source 
@type rec_type() :: :base | :ethereum | :eip155

Functions

Link to this function

normalize(recovery_bit, rec_type \\ :eip155)

View Source 
@spec normalize(non_neg_integer(), rec_type()) :: non_neg_integer() | :no_return

Normalizes a binary-encoded signature to the given requested type, i.e. :base, :ethereum, or :eip155.

Examples 

iex> Signet.Util.RecoveryBit.normalize(28, :eip155)
46

iex> Signet.Util.RecoveryBit.normalize(1, :ethereum)
28

iex> Signet.Util.RecoveryBit.normalize(45, :base)
0
Link to this function

normalize_signature(arg, rec_type \\ :eip155)

View Source 
@spec normalize_signature(Signet.signature(), rec_type()) ::
  Signet.signature() | :no_return

Normalizes a binary-encoded signature to the given requested type, i.e. :base, :ethereum, or :eip155.

Examples 

iex> Signet.Util.RecoveryBit.normalize_signature(<<1::256, 2::256, 28>>, :eip155)
<<1::256, 2::256, 46>>

iex> Signet.Util.RecoveryBit.normalize_signature(<<1::256, 2::256, 1>>, :ethereum)
<<1::256, 2::256, 28>>

iex> Signet.Util.RecoveryBit.normalize_signature(<<1::256, 2::256, 45>>, :base)
<<1::256, 2::256, 0>>
Link to this function

recover_base(v)

View Source 
@spec recover_base(non_neg_integer()) :: 0 | 1 | no_return()

Normalizes a recovery bit to be either 0 or 1.

Examples 

iex> Signet.Util.RecoveryBit.recover_base(0)
0

iex> Signet.Util.RecoveryBit.recover_base(1)
1

iex> Signet.Util.RecoveryBit.recover_base(27)
0

iex> Signet.Util.RecoveryBit.recover_base(28)
1

iex> Signet.Util.RecoveryBit.recover_base(45)
0

iex> Signet.Util.RecoveryBit.recover_base(46)
1

iex> Signet.Util.RecoveryBit.recover_base(47)
** (RuntimeError) Invalid EIP-155 Signature: recovery_bit=47, chain_id=5

iex> Signet.Util.RecoveryBit.recover_base(2)
** (FunctionClauseError) no function clause matching in Signet.Util.RecoveryBit.recover_base/1