o1js/dist/web/index.d.ts

TypeScript framework for zk-SNARKs and zkApps

export { TupleN } from './lib/util/types.js';
export type { ProvablePure } from './lib/provable/types/provable-intf.js';
export { Ledger, initializeBindings } from './bindings.js';
export { Field, Bool, Group, Scalar } from './lib/provable/wrapped.js';
export { createForeignField, ForeignField, AlmostForeignField, CanonicalForeignField, } from './lib/provable/foreign-field.js';
export { createForeignCurve, ForeignCurve, toPoint } from './lib/provable/crypto/foreign-curve.js';
export type { FlexiblePoint } from './lib/provable/crypto/foreign-curve.js';
export { createEcdsa, EcdsaSignature } from './lib/provable/crypto/foreign-ecdsa.js';
export { ScalarField } from './lib/provable/scalar-field.js';
export { Poseidon, TokenSymbol, ProvableHashable } from './lib/provable/crypto/poseidon.js';
export { Keccak } from './lib/provable/crypto/keccak.js';
export { Hash } from './lib/provable/crypto/hash.js';
export { assert } from './lib/provable/gadgets/common.js';
export * from './lib/provable/crypto/signature.js';
export type { ProvableExtended, FlexibleProvable, FlexibleProvablePure, InferProvable, } from './lib/provable/types/struct.js';
export { provableFromClass } from './lib/provable/types/provable-derivers.js';
export type { ProvablePureExtended } from './lib/provable/types/struct.js';
export { From, InferValue, InferJson, IsPure } from './bindings/lib/provable-generic.js';
export { ProvableType } from './lib/provable/types/provable-intf.js';
export { provable, provablePure } from './lib/provable/types/provable-derivers.js';
export { Struct } from './lib/provable/types/struct.js';
export { Unconstrained } from './lib/provable/types/unconstrained.js';
export { Provable } from './lib/provable/provable.js';
export { Circuit, Keypair, public_, circuitMain } from './lib/proof-system/circuit.js';
export { UInt32, UInt64, Int64, Sign, UInt8 } from './lib/provable/int.js';
export { Bytes, FlexibleBytes } from './lib/provable/wrapped-classes.js';
export { Packed, Hashed } from './lib/provable/packed.js';
export { Gadgets } from './lib/provable/gadgets/gadgets.js';
export { Types } from './bindings/mina-transaction/v1/types.js';
export { DynamicArray } from './lib/provable/dynamic-array.js';
export { MerkleList, MerkleListIterator } from './lib/provable/merkle-list.js';
import { IndexedMerkleMapBase } from './lib/provable/merkle-tree-indexed.js';
export { Option } from './lib/provable/option.js';
export * as Mina from './lib/mina/v1/mina.js';
export { Transaction, type TransactionPromise, type PendingTransaction, type IncludedTransaction, type RejectedTransaction, type PendingTransactionPromise, } from './lib/mina/v1/transaction.js';
export type { DeployArgs } from './lib/mina/v1/zkapp.js';
export { SmartContract, method, declareMethods } from './lib/mina/v1/zkapp.js';
export { Reducer } from './lib/mina/v1/actions/reducer.js';
export { state, State, declareState } from './lib/mina/v1/state.js';
export type { JsonProof } from './lib/proof-system/zkprogram.js';
export { SelfProof, verify, Empty, Undefined, Void } from './lib/proof-system/zkprogram.js';
export { VerificationKey } from './lib/proof-system/verification-key.js';
export { type ProofBase, Proof, DynamicProof } from './lib/proof-system/proof.js';
export { FeatureFlags } from './lib/proof-system/feature-flags.js';
export { Cache, CacheHeader } from './lib/proof-system/cache.js';
export { Account } from './lib/mina/v1/account.js';
export { TokenId, AccountUpdate, Permissions, ZkappPublicInput, TransactionVersion, AccountUpdateForest, AccountUpdateTree, } from './lib/mina/v1/account-update.js';
export { TokenAccountUpdateIterator } from './lib/mina/v1/token/forest-iterator.js';
export { TokenContract } from './lib/mina/v1/token/token-contract.js';
export type { TransactionStatus } from './lib/mina/v1/graphql.js';
export { fetchAccount, fetchLastBlock, fetchTransactionStatus, checkZkappTransaction, fetchEvents, addCachedAccount, setGraphqlEndpoint, setGraphqlEndpoints, setArchiveGraphqlEndpoint, sendZkapp, Lightnet, } from './lib/mina/v1/fetch.js';
export * as Encryption from './lib/provable/crypto/encryption.js';
export * as Encoding from './bindings/lib/encoding.js';
export { Character, CircuitString } from './lib/provable/string.js';
export { MerkleTree, MerkleWitness } from './lib/provable/merkle-tree.js';
export { MerkleMap, MerkleMapWitness } from './lib/provable/merkle-map.js';
export { Nullifier } from './lib/provable/crypto/nullifier.js';
export { ZkProgram } from './lib/proof-system/zkprogram.js';
export { Crypto } from './lib/provable/crypto/crypto.js';
export type { NetworkId } from './mina-signer/mina-signer.js';
export { setNumberOfWorkers } from './lib/proof-system/workers.js';
import * as OffchainState_ from './lib/mina/v1/actions/offchain-state.js';
import * as BatchReducer_ from './lib/mina/v1/actions/batch-reducer.js';
import { Actionable } from './lib/mina/v1/actions/offchain-state-serialization.js';
import { InferProvable } from './lib/provable/types/struct.js';
import { Recursive as Recursive_ } from './lib/proof-system/recursive.js';
import { ProvableBigInt as ProvableBigInt_, createProvableBigInt as createProvableBigInt_ } from './lib/provable/bigint.js';
export { Experimental };
import * as V2_ from './lib/mina/v2/index.js';
import { Field } from './lib/provable/wrapped.js';
/**
 * This module exposes APIs that are unstable, in the sense that the API surface is expected to change.
 * (Not unstable in the sense that they are less functional or tested than other parts.)
 */
declare namespace Experimental {
    let V2: typeof V2_;
    namespace V2 {
        type MinaProgramEnv<State extends V2_.StateLayout> = V2_.MinaProgramEnv<State>;
        type StateLayout = V2_.StateLayout;
        type MinaProgramMethodReturn<State extends V2_.StateLayout = 'GenericState', Event = Field[], Action = Field[]> = V2_.MinaProgramMethodReturn<State, Event, Action>;
        type StateDefinition<State extends V2_.StateLayout> = V2_.StateDefinition<State>;
        type ZkappCommandAuthorizationEnvironment = V2_.ZkappCommandAuthorizationEnvironment;
        type MinaProgram<State extends StateLayout, Event, Action, MethodPrivateInputs extends {
            [key: string]: V2_.ProvableTuple;
        }> = V2_.MinaProgram<State, Event, Action, MethodPrivateInputs>;
        type DynamicProvable<P> = V2_.DynamicProvable<P>;
    }
    let memoizeWitness: typeof import("./lib/provable/provable.js").memoizeWitness;
    let Recursive: typeof Recursive_;
    let ProvableBigInt: typeof ProvableBigInt_;
    let createProvableBigInt: typeof createProvableBigInt_;
    let IndexedMerkleMap: typeof import("./lib/provable/merkle-tree-indexed.js").IndexedMerkleMap;
    type IndexedMerkleMap = IndexedMerkleMapBase;
    let OffchainState: typeof OffchainState_.OffchainState;
    /**
     * Commitments that keep track of the current state of an offchain Merkle tree constructed from actions.
     * Intended to be stored on-chain.
     *
     * Fields:
     * - `root`: The root of the current Merkle tree
     * - `actionState`: The hash pointing to the list of actions that have been applied to form the current Merkle tree
     */
    class OffchainStateCommitments extends OffchainState_.OffchainStateCommitments {
    }
    /**
     * A reducer to process actions in fixed-size batches.
     *
     * ```ts
     * let batchReducer = new BatchReducer({ actionType: Action, batchSize: 5 });
     *
     * // in contract: concurrent dispatching of actions
     * batchReducer.dispatch(action);
     *
     * // reducer logic
     * // outside contract: prepare a list of { batch, proof } objects which cover all pending actions
     * let batches = await batchReducer.prepareBatches();
     *
     * // in contract: process a single batch
     * // create one transaction that does this for each batch!
     * batchReducer.processBatch({ batch, proof }, (action, isDummy) => {
     *   // ...
     * });
     * ```
     */
    class BatchReducer<ActionType extends Actionable<any>, BatchSize extends number = number, Action = InferProvable<ActionType>> extends BatchReducer_.BatchReducer<ActionType, BatchSize, Action> {
    }
    /**
     * Provable type that represents a batch of actions.
     */
    let ActionBatch: typeof BatchReducer_.ActionBatch;
    type ActionBatch<Action> = BatchReducer_.ActionBatch<Action>;
}
export * as Core from './bindings/index.js';