github.com/consensys/gnark-crypto@v0.14.0/ecc/bn254/fp/hash_to_field/doc.go (about)

     1  // Copyright 2020 Consensys Software Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated by consensys/gnark-crypto DO NOT EDIT
    16  
    17  // Package htf provides hasher based on RFC 9380 Section 5.
    18  //
    19  // The [RFC 9380] defines a method for hashing bytes to elliptic curves. Section
    20  // 5 of the RFC describes a method for uniformly hashing bytes into a field
    21  // using a domain separation. The hashing is implemented in [fp], but this
    22  // package provides a wrapper for the method which implements [hash.Hash] for
    23  // using the method recursively.
    24  //
    25  // [RFC 9380]: https://datatracker.ietf.org/doc/html/rfc9380
    26  package hash_to_field
    27  
    28  import (
    29  	_ "hash"
    30  
    31  	_ "github.com/consensys/gnark-crypto/ecc/bn254/fp"
    32  )