github.com/consensys/gnark-crypto@v0.14.0/field/goff/main.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  // Package goff (go finite field) is a library that generates fast field arithmetic code for a given modulus.
    16  //
    17  // Generated code is optimized for x86 (amd64) targets, and most methods do not allocate memory on the heap.
    18  //
    19  // Example usage:
    20  //
    21  //	goff -m 0xffffffff00000001 -o ./goldilocks/ -p goldilocks -e Element
    22  //
    23  // # Warning
    24  //
    25  // The generated code has not been audited for all moduli (only bn254 and bls12-381) and is provided as-is. In particular, there is no security guarantees such as constant time implementation or side-channel attack resistance.
    26  package main
    27  
    28  import "github.com/consensys/gnark-crypto/field/goff/cmd"
    29  
    30  func main() {
    31  	cmd.Execute()
    32  }