ethereum

Documentation

Overview

Package ethereum provides cryptographic operations used in go-dvote related to ethereum.

Index

• Constants
• func AddrFromPublicKey(pub []byte) (ethcommon.Address, error)
• func AddrFromSignature(message, signature []byte) (ethcommon.Address, error)
• func BuildVocdoniMessage(message []byte) []byte
• func BuildVocdoniTransaction(txData []byte, chainID string) []byte
• func CompressPubKey(pubHexDec string) (string, error)
• func DecompressPubKey(pubComp types.HexBytes) (types.HexBytes, error)
• func Hash(data []byte) []byte
• func HashRaw(data []byte) []byte
• func PubKeyFromPrivateKey(privHex string) (string, error)
• func PubKeyFromSignature(message, signature []byte) ([]byte, error)
• type SignKeys
  • func NewSignKeys() *SignKeys
  • func (k *SignKeys) AddAuthKey(address ethcommon.Address)
  • func (k *SignKeys) AddHexKey(privHex string) error
  • func (k *SignKeys) Address() ethcommon.Address
  • func (k *SignKeys) AddressString() string
  • func (k *SignKeys) Generate() error
  • func (k *SignKeys) HexString() (string, string)
  • func (k *SignKeys) PrivateKey() types.HexBytes
  • func (k *SignKeys) PublicKey() types.HexBytes
  • func (k *SignKeys) SignEthereum(message []byte) ([]byte, error)
  • func (k *SignKeys) SignVocdoniMsg(message []byte) ([]byte, error)
  • func (k *SignKeys) SignVocdoniTx(txData []byte, chainID string) ([]byte, error)
  • func (k *SignKeys) VerifySender(message, signature []byte) (bool, ethcommon.Address, error)

Constants

const PubKeyLengthBytes = 33

PubKeyLengthBytes is the size of a Public Key

const PubKeyLengthBytesUncompressed = 65

PubKeyLengthBytesUncompressed is the size of a uncompressed Public Key

const SignatureLength = ethcrypto.SignatureLength

SignatureLength is the size of an ECDSA signature in hexString format

const SigningPrefix = "\u0019Ethereum Signed Message:\n"

SigningPrefix is the prefix added when hashing

Functions

func AddrFromPublicKey

func AddrFromPublicKey(pub []byte) (ethcommon.Address, error)

AddrFromPublicKey standaolone function to obtain the Ethereum address from a ECDSA public key

func AddrFromSignature

func AddrFromSignature(message, signature []byte) (ethcommon.Address, error)

AddrFromSignature recovers the Ethereum address that created the signature of a message

func BuildVocdoniMessage

func BuildVocdoniMessage(message []byte) []byte

BuildVocdoniMessage builds the payload of a vocdoni message ready to be signed

func BuildVocdoniTransaction

func BuildVocdoniTransaction(txData []byte, chainID string) []byte

BuildVocdoniTransaction builds the payload of a vochain transaction (txData) ready to be signed

func CompressPubKey

func CompressPubKey(pubHexDec string) (string, error)

CompressPubKey returns the compressed public key in hexString format

func DecompressPubKey

func DecompressPubKey(pubComp types.HexBytes) (types.HexBytes, error)

DecompressPubKey takes a compressed public key and returns it descompressed. If already decompressed, returns the same key.

func Hash

func Hash(data []byte) []byte

Hash data adding Ethereum prefix

func HashRaw

func HashRaw(data []byte) []byte

HashRaw hashes data with no prefix

func PubKeyFromPrivateKey

func PubKeyFromPrivateKey(privHex string) (string, error)

PubKeyFromPrivateKey returns the hex public key given a hex private key

func PubKeyFromSignature

func PubKeyFromSignature(message, signature []byte) ([]byte, error)

PubKeyFromSignature recovers the ECDSA public key that created the signature of a message public key is hex encoded

Types

type SignKeys

type SignKeys struct {
	Public     ecdsa.PublicKey
	Private    ecdsa.PrivateKey
	Authorized map[ethcommon.Address]bool
	Lock       sync.RWMutex
}

SignKeys represents an ECDSA pair of keys for signing. Authorized addresses is a list of Ethereum like addresses which are checked on Verify

func NewSignKeys

func NewSignKeys() *SignKeys

NewSignKeys creates an ECDSA pair of keys for signing and initializes the map for authorized keys

func (*SignKeys) AddAuthKey

func (k *SignKeys) AddAuthKey(address ethcommon.Address)

AddAuthKey adds a new authorized address key

func (*SignKeys) AddHexKey

func (k *SignKeys) AddHexKey(privHex string) error

AddHexKey imports a private hex key

func (*SignKeys) Address

func (k *SignKeys) Address() ethcommon.Address

Address returns the SignKeys ethereum address

func (*SignKeys) AddressString

func (k *SignKeys) AddressString() string

AddressString returns the ethereum Address as string

func (*SignKeys) Generate

func (k *SignKeys) Generate() error

Generate generates new keys

func (*SignKeys) HexString

func (k *SignKeys) HexString() (string, string)

HexString returns the public compressed and private keys as hex strings

func (*SignKeys) PrivateKey

func (k *SignKeys) PrivateKey() types.HexBytes

PrivateKey returns the private key

func (*SignKeys) PublicKey

func (k *SignKeys) PublicKey() types.HexBytes

PublicKey returns the compressed public key

func (*SignKeys) SignEthereum

func (k *SignKeys) SignEthereum(message []byte) ([]byte, error)

SignEthereum signs a message. Message is a normal string (no HexString nor a Hash)

func (*SignKeys) SignVocdoniMsg

func (k *SignKeys) SignVocdoniMsg(message []byte) ([]byte, error)

SignVocdoniMsg signs a vocdoni message. Message is the full payload (no HexString nor a Hash)

func (*SignKeys) SignVocdoniTx

func (k *SignKeys) SignVocdoniTx(txData []byte, chainID string) ([]byte, error)

SignVocdoniTx signs a vocdoni transaction. TxData is the full transaction payload (no HexString nor a Hash)

func (*SignKeys) VerifySender

func (k *SignKeys) VerifySender(message, signature []byte) (bool, ethcommon.Address, error)

VerifySender verifies if a message is sent by some Authorized address key