wallet

Documentation

Overview

Package wallet implements go-perun's wallet interface for the ethereum backend. It makes use of go-ethereum's keystore module for storing, reading, and generating keys, as well as signing.

Index

• Constants
• func AsEthAddr(a wallet.Address) common.Address
• func DecodeSig(r io.Reader) (wallet.Sig, error)
• func PrefixedHash(data []byte) []byte
• func VerifySignature(msg []byte, sig wallet.Sig, a wallet.Address) (bool, error)
• type Address
  • func AsWalletAddr(addr common.Address) *Address
  • func (a *Address) Cmp(addr wallet.Address) int
  • func (a *Address) Equal(addr wallet.Address) bool
  • func (a *Address) MarshalBinary() ([]byte, error)
  • func (a *Address) String() string
  • func (a *Address) UnmarshalBinary(data []byte) error
• type Backend
  • func (*Backend) DecodeSig(r io.Reader) (wallet.Sig, error)
  • func (b *Backend) NewAddress() wallet.Address
  • func (*Backend) VerifySignature(msg []byte, sig wallet.Sig, a wallet.Address) (bool, error)

Constants

const AddressBinaryLen = common.AddressLength

AddressBinaryLen is the length of the binary representation of Address, in bytes.

const SigLen = 65

SigLen length of a signature in byte. ref https://godoc.org/github.com/ethereum/go-ethereum/crypto/secp256k1#Sign ref https://github.com/ethereum/go-ethereum/blob/54b271a86dd748f3b0bcebeaf678dc34e0d6177a/crypto/signature_cgo.go#L66

Functions

func AsEthAddr

func AsEthAddr(a wallet.Address) common.Address

AsEthAddr is a helper function to convert an address interface back into an ethereum address.

func DecodeSig

func DecodeSig(r io.Reader) (wallet.Sig, error)

DecodeSig reads a []byte with length of an ethereum signature.

func PrefixedHash

func PrefixedHash(data []byte) []byte

PrefixedHash adds an ethereum specific prefix to the hash of given data, rehashes the results and returns it.

func VerifySignature

func VerifySignature(msg []byte, sig wallet.Sig, a wallet.Address) (bool, error)

VerifySignature verifies if a signature was made by this account.

Types

type Address

type Address common.Address

Address represents an ethereum address as a perun address.

func AsWalletAddr

func AsWalletAddr(addr common.Address) *Address

AsWalletAddr is a helper function to convert an ethereum address to an address interface.

func (*Address) Cmp

func (a *Address) Cmp(addr wallet.Address) int

Cmp checks ordering of two addresses.

0 if a==b,

-1 if a < b, +1 if a > b. https://godoc.org/bytes#Compare

Panics if the input is not of the same type as the receiver.

func (*Address) Equal

func (a *Address) Equal(addr wallet.Address) bool

Equal checks the equality of two addresses. The implementation must be equivalent to checking `Address.Cmp(Address) == 0`.

func (*Address) MarshalBinary

func (a *Address) MarshalBinary() ([]byte, error)

MarshalBinary marshals the address into its binary representation. Error will always be nil, it is for implementing BinaryMarshaler.

func (*Address) String

func (a *Address) String() string

String converts this address to a string.

func (*Address) UnmarshalBinary

func (a *Address) UnmarshalBinary(data []byte) error

UnmarshalBinary unmarshals the address from its binary representation.

type Backend

type Backend struct{}

Backend implements the utility interface defined in the wallet package.

func (*Backend) DecodeSig

func (*Backend) DecodeSig(r io.Reader) (wallet.Sig, error)

DecodeSig reads a []byte with length of an ethereum signature.

func (*Backend) NewAddress

func (b *Backend) NewAddress() wallet.Address

NewAddress returns a variable of type Address, which can be used for unmarshalling an address from its binary representation.

func (*Backend) VerifySignature

func (*Backend) VerifySignature(msg []byte, sig wallet.Sig, a wallet.Address) (bool, error)

VerifySignature verifies a signature.