@primitivefi/hardhat-dodoc/dist/src/dodocTypes.d.ts

Zero-config Hardhat plugin to generate documentation for all your Solidity contracts

import { CompilerOutputContract } from 'hardhat/types';
export interface ErrorDevdocArrayItem {
    details?: string;
    params?: {
        [key: string]: string;
    };
}
declare interface ErrorUserdocArrayItem {
    notice?: string;
}
export interface CompilerOutputContractWithDocumentation extends CompilerOutputContract {
    devdoc?: {
        author?: string;
        details?: string;
        title?: string;
        errors?: {
            [key: string]: ErrorDevdocArrayItem[];
        };
        events?: {
            [key: string]: {
                details: string;
                params: {
                    [key: string]: string;
                };
            };
        };
        methods?: {
            [key: string]: {
                details?: string;
                params: {
                    [key: string]: string;
                };
                returns: {
                    [key: string]: string;
                };
            };
        };
        returns?: {
            [key: string]: {
                details?: string;
                params: {
                    [key: string]: string;
                };
            };
        };
        stateVariables?: {
            [key: string]: {
                details?: string;
                params: {
                    [key: string]: string;
                };
                returns: {
                    [key: string]: string;
                };
            };
        };
    };
    userdoc?: {
        errors?: {
            [key: string]: ErrorUserdocArrayItem[];
        };
        events?: {
            [key: string]: {
                notice: string;
            };
        };
        methods?: {
            [key: string]: {
                notice: string;
            };
        };
        notice?: string;
    };
}
export interface AbiElementPut {
    internalType: string;
    name: string;
    type: string;
    indexed?: boolean;
}
export interface AbiElement {
    type: 'constructor' | 'function' | 'event' | 'error';
    name: string;
    stateMutability?: string;
    inputs: AbiElementPut[];
    outputs: AbiElementPut[];
}
export interface Param {
    type?: string;
    description?: string;
    indexed?: boolean;
}
export interface Method {
    code?: string;
    stateMutability?: string;
    notice?: string;
    details?: string;
    inputs: {
        [key: string]: Param;
    };
    outputs: {
        [key: string]: Param;
    };
}
export interface Event {
    code?: string;
    notice?: string;
    details?: string;
    inputs: {
        [key: string]: Param;
    };
}
export interface Error {
    code?: string;
    description?: string;
    details?: string;
    inputs: {
        [key: string]: Param;
    };
}
export interface Doc {
    path?: string;
    name?: string;
    title?: string;
    notice?: string;
    details?: string;
    author?: string;
    methods: {
        [key: string]: Method;
    };
    events: {
        [key: string]: Event;
    };
    errors: {
        [key: string]: Event;
    };
}
export {};
//# sourceMappingURL=dodocTypes.d.ts.map