o1js/dist/node/lib/mina/v1/mina.d.ts

TypeScript framework for zk-SNARKs and zkApps

import { Types } from '../../../bindings/mina-transaction/v1/types.js';
import { NetworkId } from '../../../mina-signer/src/types.js';
import { PublicKey } from '../../provable/crypto/signature.js';
import { LocalBlockchain, TestPublicKey } from './local-blockchain.js';
import { Mina, activeInstance, currentSlot, fetchActions, fetchEvents, getAccount, getActions, getBalance, getNetworkConstants, getNetworkId, getNetworkState, getProofsEnabled, hasAccount, setActiveInstance, type ActionStates, type FeePayerSpec, type NetworkConstants } from './mina-instance.js';
import { currentTransaction } from './transaction-context.js';
import { filterGroups } from './transaction-validation.js';
import { Transaction, transaction, type IncludedTransaction, type PendingTransaction, type PendingTransactionPromise, type PendingTransactionStatus, type RejectedTransaction } from './transaction.js';
export { ActionStates, FeePayerSpec, LocalBlockchain, Network, TestPublicKey, Transaction, activeInstance, currentSlot, currentTransaction, faucet, fetchActions, fetchEvents, filterGroups, getAccount, getActions, getBalance, getNetworkConstants, getNetworkId, getNetworkState, getProofsEnabled, hasAccount, sender, setActiveInstance, transaction, waitForFunding, type IncludedTransaction, type NetworkConstants, type PendingTransaction, type PendingTransactionPromise, type PendingTransactionStatus, type RejectedTransaction, };
/**
 * Represents the Mina blockchain running on a real network
 */
declare function Network(graphqlEndpoint: string): Mina;
declare function Network(options: {
    networkId?: NetworkId;
    mina: string | string[];
    archive?: string | string[];
    lightnetAccountManager?: string;
    bypassTransactionLimits?: boolean;
    minaDefaultHeaders?: HeadersInit;
    archiveDefaultHeaders?: HeadersInit;
}): Mina;
/**
 * Returns the public key of the current transaction's sender account.
 *
 * Throws an error if not inside a transaction, or the sender wasn't passed in.
 */
declare function sender(): Types.PublicKey;
declare function waitForFunding(address: string, network: string, headers?: HeadersInit): Promise<void>;
/**
 * Requests the [testnet faucet](https://faucet.minaprotocol.com/api/v1/faucet) to fund a public key.
 *
 * Solves a ZK captcha challenge (sum-to-100 proof) before submitting the funding request.
 * The first call compiles the ZK circuit (~30-60s), subsequent calls reuse the cached circuit.
 *
 * @param pub - The public key to fund.
 * @param network - The network to fund on: `devnet` (default) or `mesa`.
 * @param headers - Optional headers passed to `fetchAccount` when polling for funding confirmation.
 *
 * @throws `rate-limit` — The address has already been funded on this network (one funding per address).
 * @throws `rate-limit-ip` — Too many faucet requests from this IP (max 5/hour, 10/day).
 * @throws `forbidden` — The faucet rejected the request origin.
 * @throws `challenge-required` — The ZK challenge proof was invalid or expired.
 *
 * @example
 * ```ts
 * // Fund on Devnet (default)
 * await Mina.faucet(myPublicKey);
 *
 * // Fund on Mesa
 * await Mina.faucet(myPublicKey, 'mesa');
 * ```
 */
declare function faucet(pub: PublicKey, network?: string, headers?: HeadersInit): Promise<void>;