zkverifyjs/dist/types/session/managers/domain/index.d.ts

Submit proofs to zkVerify and query proof state with ease using our npm package.

import { ConnectionManager } from '../connection';
import { EventEmitter } from 'events';
import { AggregateTransactionInfo, DomainOptions, DomainTransactionInfo, RegisterDomainTransactionInfo } from '../../../types';
export declare class DomainManager {
    private readonly connectionManager;
    /**
     * Creates an instance of DomainManager.
     * @param {ConnectionManager} connectionManager - The connection manager instance.
     */
    constructor(connectionManager: ConnectionManager);
    /**
     * Registers a new domain with the given configuration.
     *
     * @param aggregationSize - Number of statements per aggregation.
     * @param queueSize - Max number of aggregations in the queue (default is 16).
     * @param domainOptions - options object containing additional params such as destination and security rules.
     * @param signerAccount - Optional address of the account signing the transaction if multiple have been added to the session.
     * @returns {{ events: EventEmitter; transactionResult: Promise<RegisterDomainTransactionInfo> }}
     * An object containing an event emitter and a promise that resolves to a DomainTransactionInfo object when the call completes.
     * @throws {Error} If the session is read-only.
     */
    registerDomain(aggregationSize: number, queueSize: number | undefined, domainOptions: DomainOptions, signerAccount?: string): {
        events: EventEmitter;
        transactionResult: Promise<RegisterDomainTransactionInfo>;
    };
    aggregate(domainId: number, aggregationId: number, signerAccount?: string): {
        events: EventEmitter;
        transactionResult: Promise<AggregateTransactionInfo>;
    };
    /**
     * Places a hold on a domain.
     * @param {number} domainId - The ID of the domain to hold.
     * @param accountAddress - optional address of the account making the transaction
     * @returns {{ events: EventEmitter; transactionResult: Promise<DomainTransactionInfo> }}
     * An object containing an event emitter and a promise that resolves to a DomainTransactionInfo object when the call completes.
     * @throws {Error} If the connection is read-only.
     */
    holdDomain(domainId: number, accountAddress?: string): {
        events: EventEmitter;
        transactionResult: Promise<DomainTransactionInfo>;
    };
    /**
     * Unregisters a domain.
     * @param {number} domainId - The ID of the domain to unregister.
     * @param accountAddress - optional address of the account making the transaction
     * @returns {{ events: EventEmitter; transactionResult: Promise<DomainTransactionInfo> }}
     * An object containing an event emitter and a promise that resolves to a DomainTransactionInfo object when the call completes.
     * @throws {Error} If the connection is read-only.
     */
    unregisterDomain(domainId: number, accountAddress?: string): {
        events: EventEmitter;
        transactionResult: Promise<DomainTransactionInfo>;
    };
    /**
     * Adds submitters to the allowlist for a domain.
     * Only available for domains configured with ProofSecurityRules.OnlyAllowlisted.
     * Requires runtime version 1.3.0 or later.
     * @param {number} domainId - The ID of the domain.
     * @param {string[]} submitters - Array of account addresses to add to the allowlist.
     * @param {string} [signerAccount] - Optional address of the account signing the transaction.
     * @returns {{ events: EventEmitter; transactionResult: Promise<DomainTransactionInfo> }}
     * @throws {Error} If the connection is read-only or runtime version is too old.
     */
    addDomainSubmitters(domainId: number, submitters: string[], signerAccount?: string): {
        events: EventEmitter;
        transactionResult: Promise<DomainTransactionInfo>;
    };
    /**
     * Removes submitters from the allowlist for a domain.
     * Only available for domains configured with ProofSecurityRules.OnlyAllowlisted.
     * Requires runtime version 1.3.0 or later.
     * @param {number} domainId - The ID of the domain.
     * @param {string[]} submitters - Array of account addresses to remove from the allowlist.
     * @param {string} [signerAccount] - Optional address of the account signing the transaction.
     * @returns {{ events: EventEmitter; transactionResult: Promise<DomainTransactionInfo> }}
     * @throws {Error} If the connection is read-only or runtime version is too old.
     */
    removeDomainSubmitters(domainId: number, submitters: string[], signerAccount?: string): {
        events: EventEmitter;
        transactionResult: Promise<DomainTransactionInfo>;
    };
}
//# sourceMappingURL=index.d.ts.map