src/config/Config.ts - develop - ton-org/blueprint

src/config/Config.ts

67 строк2 KB

Aliaksandr Bahdanau

feat: add possibility to specify custom manifestUrl (#242)

29 май 2025, 12:37

29 май 2025, 12:37efff103

import { CustomNetwork } from './CustomNetwork';
import { Plugin } from './Plugin';

export interface Config {
    /**
     * Optional array of plugins to extend or customize the behavior.
     * Plugins can provide additional tooling.
     *
     * @example
     * import { Config } from '@ton/blueprint';
     * import { ScaffoldPlugin } from 'blueprint-scaffold';
     *
     * export const config: Config = {
     *     plugins: [new ScaffoldPlugin()],
     * };
     */
    plugins?: Plugin[];

    /**
     * Specifies the target network for deployment or interaction.
     *
     * @example Custom network
     * import { Config } from '@ton/blueprint';
     *
     * export const config: Config = {
     *     network: {
     *         endpoint: 'https://toncenter.com/api/v2/jsonRPC',
     *         type: 'mainnet',
     *         version: 'v2',
     *         key: 'YOUR_API_KEY',
     *     },
     * };
     */
    network?: 'mainnet' | 'testnet' | CustomNetwork;

    /**
     * If true, keeps compilable files (`*.compile.ts`) in a separate directory `compilables`.
     * When false or unset, compilables are stored in `wrappers` directory.
     *
     * @default false
     */
    separateCompilables?: boolean;

    /**
     * HTTP request timeout in milliseconds.
     *
     * @example
     * export const config: Config = {
     *     requestTimeout: 10000 // 10 seconds
     * };
     */
    requestTimeout?: number;

    /**
     * If true, the `wrappers`/`compilables` directory will be searched recursively for contracts.
     *
     * @default false
     */
    recursiveWrappers?: boolean;

    /**
     * Manifest url passed to TonConnect provider.
     *
     * @default https://raw.githubusercontent.com/ton-org/blueprint/main/tonconnect/manifest.json
     */
    manifestUrl?: string;
}