dop-stick/dist/utils/documentation/readme-generator.d.ts

Source control tooling for versionable-upgradeable smart contracts

import { DiamondAnalysisJSON } from '../../types/analysis';
import { ContractInfo } from '../info-processors/types';
import { DopStickConfig } from '../../types/config';
export declare class ReadmeGenerator {
    private readonly networkName;
    private readonly diamondAddress;
    private readonly reportsPath;
    private readonly chartColors;
    constructor(networkName: string, diamondAddress: string, config?: DopStickConfig);
    private generateHeader;
    private generateBlockchainSection;
    private getChangeIndicator;
    private getCoverageBadge;
    private generateProcessedFacetsSection;
    private generateFacetDetails;
    private generateComparisonSection;
    private getMutabilityBadge;
    private getDiscrepancyBadge;
    private calculateCoverage;
    private generateVisualizationsSection;
    private generateTimelineSection;
    private generateSummarySection;
    private aggregateFunctionTypes;
    private getImplementationQualityBadge;
    private generateRecommendations;
    private generateSecurityConsiderations;
    private getDocumentationCoverageBadge;
    private getContractHealthBadge;
    private generateOutputPaths;
    private generateTimeHash;
    generateDocumentation(facets: Map<string, ContractInfo>, unknownSelectors: Array<{
        facet: string;
        selector: string;
        reason?: string;
    }>, analysisData: DiamondAnalysisJSON): Promise<{
        markdownPath: string;
        jsonPath: string;
        hash: string;
    }>;
}
//# sourceMappingURL=readme-generator.d.ts.map