mimc

Documentation

Overview

Package mimc provides a ZKP-circuit function to compute a MiMC hash.

Index

• type MiMC
  • func NewMiMC(api frontend.API) (MiMC, error)
  • func (h *MiMC) Reset()
  • func (h *MiMC) Sum() frontend.Variable
  • func (h *MiMC) Write(data ...frontend.Variable)

Types

type MiMC

type MiMC struct {
	// contains filtered or unexported fields
}

MiMC contains the params of the Mimc hash func and the curves on which it is implemented

func NewMiMC

func NewMiMC(api frontend.API) (MiMC, error)

NewMiMC returns a MiMC instance, than can be used in a gnark circuit

func (*MiMC) Reset

func (h *MiMC) Reset()

Reset resets the Hash to its initial state.

func (*MiMC) Sum

func (h *MiMC) Sum() frontend.Variable

Sum hash (in r1cs form) using Miyaguchi–Preneel: https://en.wikipedia.org/wiki/One-way_compression_function The XOR operation is replaced by field addition. See github.com/consensys/gnark-crypto for reference implementation.

func (*MiMC) Write

func (h *MiMC) Write(data ...frontend.Variable)

Write adds more data to the running hash.