o1js/dist/web/lib/provable/bool.d.ts

TypeScript framework for zk-SNARKs and zkApps

import { Field } from './field.js';
import { FieldVar, FieldConst, FieldType } from './core/fieldvar.js';
import { NonNegativeInteger } from '../../bindings/crypto/non-negative.js';
export { BoolVar, Bool };
type BoolVar = FieldVar;
type ConstantBoolVar = [FieldType.Constant, FieldConst];
/**
 * A boolean value. You can use it like this:
 *
 * ```
 * const x = new Bool(true);
 * ```
 *
 * You can also combine multiple booleans via [[`not`]], [[`and`]], [[`or`]].
 *
 * Use [[assertEquals]] to enforce the value of a Bool.
 */
declare class Bool {
    value: BoolVar;
    constructor(x: boolean | Bool | BoolVar);
    isConstant(): this is {
        value: ConstantBoolVar;
    };
    /**
     * Converts a {@link Bool} to a {@link Field}. `false` becomes 0 and `true` becomes 1.
     */
    toField(): Field;
    /**
     * @returns a new {@link Bool} that is the negation of this {@link Bool}.
     */
    not(): Bool;
    /**
     * @param y A {@link Bool} to AND with this {@link Bool}.
     * @returns a new {@link Bool} that is set to true only if
     * this {@link Bool} and `y` are also true.
     */
    and(y: Bool | boolean): Bool;
    /**
     * @param y a {@link Bool} to OR with this {@link Bool}.
     * @returns a new {@link Bool} that is set to true if either
     * this {@link Bool} or `y` is true.
     */
    or(y: Bool | boolean): Bool;
    /**
     * Whether this Bool implies another Bool `y`.
     *
     * This is the same as `x.not().or(y)`: if `x` is true, then `y` must be true for the implication to be true.
     *
     * @example
     * ```ts
     * let isZero = x.equals(0);
     * let lessThan10 = x.lessThan(10);
     * assert(isZero.implies(lessThan10), 'x = 0 implies x < 10');
     * ```
     */
    implies(y: Bool | boolean): Bool;
    /**
     * Proves that this {@link Bool} is equal to `y`.
     * @param y a {@link Bool}.
     */
    assertEquals(y: Bool | boolean, message?: string): void;
    /**
     * Proves that this {@link Bool} is `true`.
     */
    assertTrue(message?: string): void;
    /**
     * Proves that this {@link Bool} is `false`.
     */
    assertFalse(message?: string): void;
    /**
     * Returns true if this {@link Bool} is equal to `y`.
     * @param y a {@link Bool}.
     */
    equals(y: Bool | boolean): Bool;
    /**
     * Returns the size of this type.
     */
    sizeInFields(): number;
    /**
     * Serializes this {@link Bool} into {@link Field} elements.
     */
    toFields(): Field[];
    /**
     * Serialize the {@link Bool} to a string, e.g. for printing.
     * This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field.
     */
    toString(): string;
    /**
     * Serialize the {@link Bool} to a JSON string.
     * This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field.
     */
    toJSON(): boolean;
    /**
     * This converts the {@link Bool} to a JS `boolean`.
     * This can only be called on non-witness values.
     */
    toBoolean(): boolean;
    static toField(x: Bool | boolean): Field;
    /**
     * Boolean negation.
     */
    static not(x: Bool | boolean): Bool;
    /**
     * Boolean AND operation.
     */
    static and(x: Bool | boolean, y: Bool | boolean): Bool;
    /**
     * Boolean OR operation.
     */
    static or(x: Bool | boolean, y: Bool | boolean): Bool;
    /**
     * Boolean AND operation across a list of booleans, returns `Bool(true)` if all elements in the list are true.
     */
    static allTrue(list: (Bool | boolean)[]): Bool;
    /**
     * Boolean OR operation across a list of booleans, returns `Bool(true)` if any element in the list is true.
     */
    static anyTrue(list: (Bool | boolean)[]): Bool;
    /**
     * Asserts if both {@link Bool} are equal.
     */
    static assertEqual(x: Bool, y: Bool | boolean): void;
    /**
     * Checks two {@link Bool} for equality.
     */
    static equal(x: Bool | boolean, y: Bool | boolean): Bool;
    /**
     * Static method to serialize a {@link Bool} into an array of {@link Field} elements.
     */
    static toFields(x: Bool): Field[];
    /**
     * Static method to serialize a {@link Bool} into its auxiliary data.
     */
    static toAuxiliary(_?: Bool): [];
    /**
     * Creates a data structure from an array of serialized {@link Field} elements.
     */
    static fromFields(fields: Field[]): Bool;
    /**
     * `Provable<Bool>.toValue()`
     */
    static toValue(x: Bool): boolean;
    /**
     * `Provable<Bool>.fromValue()`
     */
    static fromValue(b: boolean | Bool): Bool;
    /**
     * Serialize a {@link Bool} to a JSON string.
     * This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field.
     */
    static toJSON(x: Bool): boolean;
    /**
     * Deserialize a JSON structure into a {@link Bool}.
     * This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field.
     */
    static fromJSON(b: boolean): Bool;
    /**
     * Returns the size of this type.
     */
    static sizeInFields(): number;
    static empty(): Bool;
    static toInput(x: Bool): {
        packed: [Field, number][];
    };
    static toBytes(b: Bool): number[];
    static fromBytes(bytes: number[]): Bool;
    static readBytes<N extends number>(bytes: number[], offset: NonNegativeInteger<N>): [value: Bool, offset: number];
    static sizeInBytes: number;
    static check(x: Bool): void;
    static Unsafe: {
        /**
         * Converts a {@link Field} into a {@link Bool}. This is an **unsafe** operation
         * as it assumes that the field element is either 0 or 1 (which might not be true).
         *
         * Only use this if you have already constrained the Field element to be 0 or 1.
         *
         * @param x a {@link Field}
         */
        fromField(x: Field): Bool;
    };
}