air-script.d.ts

declare module '@guildofweavers/air-script' {

    // IMPORTS AND RE-EXPORTS
    // --------------------------------------------------------------------------------------------
    import { FiniteField } from '@guildofweavers/galois';
    export { FiniteField } from '@guildofweavers/galois';

    // INTERFACES
    // --------------------------------------------------------------------------------------------
    export interface StarkLimits {
        maxSteps                : number;
        maxMutableRegisters     : number;
        maxReadonlyRegisters    : number;
        maxConstraintCount      : number;
        maxConstraintDegree     : number;
        maxExtensionFactor      : number;
    }

    export interface AirObject {

        readonly name                   : string;
        readonly field                  : FiniteField;
        readonly stateWidth             : number;
        readonly publicInputCount       : number;
        readonly secretInputCount       : number;
        readonly constraintCount        : number;
        readonly maxConstraintDegree    : number;
        readonly extensionFactor        : number;

        createContext(publicInputs: bigint[][]): VerificationContext;
        createContext(publicInputs: bigint[][], secretInputs: bigint[][]): ProofContext;

        generateExecutionTrace(initValues: bigint[], ctx: ProofContext): bigint[][];
        evaluateExtendedTrace(extendedTrace: bigint[][], ctx: ProofContext): bigint[][];
        evaluateConstraintsAt(x: bigint, rValues: bigint[], nValues: bigint[], sValues: bigint[], ctx: VerificationContext): bigint[];
    }

    export class AirScriptError {
        readonly errors: any[];
        constructor(errors: any[]);
    }

    // CONTEXTS
    // --------------------------------------------------------------------------------------------
    export interface EvaluationContext {
        readonly field              : FiniteField
        readonly traceLength        : number;
        readonly extensionFactor    : number;
        readonly rootOfUnity        : bigint;
        readonly executionDomain?   : bigint[];
        readonly evaluationDomain?  : bigint[];
    }

    export interface VerificationContext extends EvaluationContext {
        readonly stateWidth         : number;
        readonly secretInputCount   : number;
        readonly publicInputCount   : number;
        readonly constraints        : ConstraintSpecs[];
        readonly kRegisters         : ReadonlyRegister[];
        readonly pRegisters         : ReadonlyRegister[];
    }

    export interface ProofContext extends VerificationContext {
        readonly sRegisters         : ReadonlyRegister[];
        readonly executionDomain    : bigint[];
        readonly evaluationDomain   : bigint[];
    }

    export interface ReadonlyRegister {
        getTraceValue(step: number): bigint;
        getEvaluation(position: number): bigint;
        getEvaluationAt(x: bigint): bigint;
    }

    export interface ConstraintSpecs {
        degree  : number;
    }

    // PUBLIC FUNCTIONS
    // --------------------------------------------------------------------------------------------
    export function parseScript(script: string, limits?: Partial<StarkLimits>, extensionFactor?: number): AirObject;
}