org.ethereum.crypto.zksnark.Fp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ethereumj-core Show documentation
Java implementation of the Ethereum protocol adapted to use for Hedera Smart Contract Service
The newest version!
/*
 * Copyright (c) [2016] [  ]
 * This file is part of the ethereumJ library.
 *
 * The ethereumJ library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The ethereumJ library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the ethereumJ library. If not, see .
 */
package org.ethereum.crypto.zksnark;

import java.math.BigInteger;

import static org.ethereum.crypto.zksnark.Params.P;

/**
 * Arithmetic in F_p, p = 21888242871839275222246405745257275088696311157297823662689037894645226208583
 *
 * @author Mikhail Kalinin
 * @since 01.09.2017
 */
public class Fp implements Field {

    static final Fp ZERO = new Fp(BigInteger.ZERO);
    static final Fp _1 = new Fp(BigInteger.ONE);
    static final Fp NON_RESIDUE = new Fp(new BigInteger("21888242871839275222246405745257275088696311157297823662689037894645226208582"));

    static final Fp _2_INV = new Fp(BigInteger.valueOf(2).modInverse(P));

    BigInteger v;

    Fp(BigInteger v) { this.v = v; }

    @Override public Fp add(Fp o) { return new Fp(this.v.add(o.v).mod(P)); }
    @Override public Fp mul(Fp o) { return new Fp(this.v.multiply(o.v).mod(P)); }
    @Override public Fp sub(Fp o) { return new Fp(this.v.subtract(o.v).mod(P)); }
    @Override public Fp squared() { return new Fp(v.multiply(v).mod(P)); }
    @Override public Fp dbl() { return new Fp(v.add(v).mod(P)); }
    @Override public Fp inverse() { return new Fp(v.modInverse(P)); }
    @Override public Fp negate() { return new Fp(v.negate().mod(P)); }
    @Override public boolean isZero() { return v.compareTo(BigInteger.ZERO) == 0; }

    /**
     * Checks if provided value is a valid Fp member
     */
    @Override
    public boolean isValid() {
        return v.compareTo(P) < 0;
    }

    Fp2 mul(Fp2 o) { return new Fp2(o.a.mul(this), o.b.mul(this)); }

    static Fp create(byte[] v) {
        return new Fp(new BigInteger(1, v));
    }

    static Fp create(BigInteger v) {
        return new Fp(v);
    }

    public byte[] bytes() {
        return v.toByteArray();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Fp fp = (Fp) o;

        return !(v != null ? v.compareTo(fp.v) != 0 : fp.v != null);
    }

    @Override
    public String toString() {
        return v.toString();
    }
}