@clarigen/cli 2.1.1 → 2.1.2

package/dist/index.d.cts

@@ -0,0 +1,444 @@
+import { ClarityAbi, ClarityAbiFunction, ClarityAbiMap, ClarityAbiVariable, ClarityAbiArg, ClarityAbiType } from '@clarigen/core';
+import { z } from 'zod';
+import { Simnet } from '@hirosystems/clarinet-sdk';
+import { inspect, InspectOptions } from 'util';
+
+interface SessionContract {
+    contract_id: string;
+    contract_interface: ClarityAbi;
+    source: string;
+}
+type EpochType = ClarityAbi;
+type SessionAccount = {
+    address: string;
+    balance: string;
+    name: string;
+};
+interface Session {
+    session_id: number;
+    accounts: SessionAccount[];
+    contracts: SessionContract[];
+}
+interface SessionWithVariables extends Session {
+    variables: string[];
+}
+
+declare const ClarinetConfigSchema: z.ZodObject<{
+    project: z.ZodObject<{
+        requirements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            contract_id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            contract_id: string;
+        }, {
+            contract_id: string;
+        }>, "many">>;
+        cache_location: z.ZodOptional<z.ZodObject<{
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+        }, {
+            path: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        requirements?: {
+            contract_id: string;
+        }[] | undefined;
+        cache_location?: {
+            path: string;
+        } | undefined;
+    }, {
+        requirements?: {
+            contract_id: string;
+        }[] | undefined;
+        cache_location?: {
+            path: string;
+        } | undefined;
+    }>;
+    contracts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+    }, {
+        path: string;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    project: {
+        requirements?: {
+            contract_id: string;
+        }[] | undefined;
+        cache_location?: {
+            path: string;
+        } | undefined;
+    };
+    contracts?: Record<string, {
+        path: string;
+    }> | undefined;
+}, {
+    project: {
+        requirements?: {
+            contract_id: string;
+        }[] | undefined;
+        cache_location?: {
+            path: string;
+        } | undefined;
+    };
+    contracts?: Record<string, {
+        path: string;
+    }> | undefined;
+}>;
+type ClarinetConfig = z.infer<typeof ClarinetConfigSchema>;
+declare function getClarinetConfig(path: string): Promise<ClarinetConfig>;
+
+declare const CONFIG_FILE: "Clarigen.toml";
+declare enum OutputType {
+    ESM = "types",
+    ESM_OLD = "esm",
+    Docs = "docs"
+}
+declare const ConfigFileSchema: z.ZodObject<{
+    clarinet: z.ZodString;
+    types: z.ZodOptional<z.ZodObject<{
+        output: z.ZodOptional<z.ZodString>;
+        outputs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        include_accounts: z.ZodOptional<z.ZodBoolean>;
+        after: z.ZodOptional<z.ZodString>;
+        include_boot_contracts: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    }, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    }>>;
+    esm: z.ZodOptional<z.ZodObject<{
+        output: z.ZodOptional<z.ZodString>;
+        outputs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        include_accounts: z.ZodOptional<z.ZodBoolean>;
+        after: z.ZodOptional<z.ZodString>;
+        include_boot_contracts: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    }, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    }>>;
+    docs: z.ZodOptional<z.ZodObject<{
+        output: z.ZodOptional<z.ZodString>;
+        outputs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        exclude: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        after: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    }, {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    clarinet: string;
+    types?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | undefined;
+    esm?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | undefined;
+    docs?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    } | undefined;
+}, {
+    clarinet: string;
+    types?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | undefined;
+    esm?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | undefined;
+    docs?: {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    } | undefined;
+}>;
+type ConfigFile = z.infer<typeof ConfigFileSchema>;
+declare const defaultConfigFile: ConfigFile;
+declare class Config {
+    configFile: ConfigFile;
+    clarinet: ClarinetConfig;
+    cwd: string;
+    constructor(config: ConfigFile, clarinet: ClarinetConfig, cwd?: string);
+    static load(cwd?: string): Promise<Config>;
+    getOutputs(type: OutputType): string[];
+    outputResolve(type: OutputType, filePath?: string): string[] | null;
+    writeOutput(type: OutputType, contents: string, filePath?: string): Promise<string[] | null>;
+    supports(type: OutputType): boolean;
+    type(type: OutputType): {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    } | undefined;
+    get esm(): {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        include_accounts?: boolean | undefined;
+        after?: string | undefined;
+        include_boot_contracts?: boolean | undefined;
+    } | undefined;
+    get docs(): {
+        output?: string | undefined;
+        outputs?: string[] | undefined;
+        exclude?: string[] | undefined;
+        after?: string | undefined;
+    } | undefined;
+    clarinetFile(): string;
+    joinFromClarinet(filePath: string): string;
+}
+declare function configFilePath(cwd?: string): string;
+declare function saveConfig(config: ConfigFile): Promise<void>;
+declare function getConfig(cwd?: string): Promise<ConfigFile>;
+
+declare const FN_TYPES: readonly ["read-only", "public", "private"];
+declare const VAR_TYPES: readonly ["map", "data-var", "constant"];
+type ClarityAbiItem = ClarityAbiFunction | ClarityAbiMap | ClarityAbiVariable;
+type ClaridocItemType<T extends ClarityAbiItem> = {
+    abi: T;
+    comments: Comments;
+    startLine: number;
+    source: string[];
+};
+type ClaridocFunction = ClaridocItemType<ClarityAbiFunction>;
+type ClaridocMap = ClaridocItemType<ClarityAbiMap>;
+type ClaridocVariable = ClaridocItemType<ClarityAbiVariable>;
+interface ClaridocItem {
+    abi: ClarityAbiItem;
+    comments: Comments;
+    startLine: number;
+    source: string[];
+}
+interface Comments {
+    params: Record<string, ClaridocParam>;
+    text: string[];
+}
+interface ClaridocContract {
+    functions: ClaridocFunction[];
+    maps: ClaridocMap[];
+    variables: ClaridocVariable[];
+    comments: string[];
+}
+interface ClaridocParam {
+    abi: ClarityAbiArg;
+    comments: string[];
+}
+declare function createContractDocInfo({ contractSrc, abi, }: {
+    contractSrc: string;
+    abi: ClarityAbi;
+}): ClaridocContract;
+declare function isComment(line: string): boolean;
+declare function getFnName(line: string): string | undefined;
+declare function traceParens(line: string, count: number): number;
+declare function parseComments(comments: string[], abi: ClarityAbiItem): Comments;
+declare function afterDocs(config: Config): Promise<void>;
+
+declare function generateMarkdown({ contract, contractFile, withToc, }: {
+    contract: SessionContract;
+    contractFile?: string;
+    withToc?: boolean;
+}): string;
+declare function markdownFunction(fn: ClaridocFunction, contractFile?: string): string;
+declare function generateReadme(session: Session, excluded: Record<string, boolean>): string;
+
+declare function generateDocs({ session, config, }: {
+    session: SessionWithVariables;
+    config: Config;
+}): Promise<void>;
+
+declare function getVariablesV2(contract: SessionContract, simnet: Simnet, verbose?: boolean): any;
+declare function mapVariables(session: Session, simnet: Simnet): string[];
+
+declare function generateContractMeta(contract: SessionContract, constants: string): string;
+declare const TYPE_IMPORTS = "import type { TypedAbiArg, TypedAbiFunction, TypedAbiMap, TypedAbiVariable, Response } from '@clarigen/core';";
+declare function generateBaseFile(session: SessionWithVariables): string;
+declare function encodeVariables(variables: ClarityAbiVariable[]): string[];
+declare global {
+    interface Uint8Array {
+        [inspect.custom](depth: number, options: InspectOptions): string;
+    }
+}
+declare function serialize(obj: any): string;
+
+interface EmulatedContractPublishTransaction {
+    'emulated-contract-publish': {
+        'contract-name': string;
+        'emulated-sender': string;
+        path: string;
+    };
+}
+interface RequirementPublishTransaction {
+    'requirement-publish': {
+        'contract-id': string;
+        'remap-sender': string;
+        'remap-principals': Record<string, string>;
+        path: string;
+    };
+}
+interface ContractPublishTransaction {
+    'contract-publish': {
+        'contract-name': string;
+        'expected-sender': string;
+        path: string;
+    };
+}
+interface ContractCallTransaction {
+    'contract-call': {
+        'contract-id': string;
+        'expected-sender': string;
+        parameters: Readonly<string[]>;
+        method: string;
+    };
+}
+interface EmulatedContractCallTransaction {
+    'emulated-contract-call': {
+        'contract-id': string;
+        'emulated-sender': string;
+        parameters: Readonly<string[]>;
+        method: string;
+    };
+}
+interface BtcTransferTransaction {
+    'btc-transfer': {
+        'expected-sender': string;
+        recipient: string;
+        'sats-per-byte': string;
+        'sats-amount': string;
+    };
+}
+type Transaction = EmulatedContractPublishTransaction | RequirementPublishTransaction | ContractPublishTransaction | EmulatedContractCallTransaction | BtcTransferTransaction | ContractCallTransaction;
+type ContractTransaction = EmulatedContractPublishTransaction | RequirementPublishTransaction | ContractPublishTransaction;
+interface Batch<T extends Transaction> {
+    id: number;
+    transactions: Readonly<T[]>;
+}
+interface SimnetAccount {
+    address: string;
+    name: string;
+    balance: string;
+}
+interface SimnetAccountDeployer extends SimnetAccount {
+    name: 'deployer';
+}
+interface SimnetDeploymentPlan {
+    network: 'simnet';
+    genesis: {
+        wallets: Readonly<[SimnetAccountDeployer, ...SimnetAccount[]]>;
+        contracts: Readonly<string[]>;
+    };
+    plan: {
+        batches: Readonly<Batch<EmulatedContractPublishTransaction | EmulatedContractCallTransaction>[]>;
+    };
+}
+interface DevnetDeploymentPlan {
+    network: 'devnet';
+    plan: {
+        batches: Readonly<Batch<RequirementPublishTransaction | ContractPublishTransaction | ContractCallTransaction | BtcTransferTransaction>[]>;
+    };
+}
+type TestnetDeploymentPlan = Omit<DevnetDeploymentPlan, 'network'> & {
+    network: 'testnet';
+};
+interface MainnetDeploymentPlan {
+    network: 'mainnet';
+    plan: {
+        batches: Readonly<Batch<ContractPublishTransaction | ContractCallTransaction | BtcTransferTransaction>[]>;
+    };
+}
+type DeploymentPlan = SimnetDeploymentPlan | DevnetDeploymentPlan | TestnetDeploymentPlan | MainnetDeploymentPlan;
+declare function flatBatch<T extends Transaction>(batches: Batch<T>[]): T[];
+declare function getContractTxs(batches: Batch<Transaction>[]): ContractTransaction[];
+declare function getDeploymentContract(contractName: string, deployment: DeploymentPlan): ContractTransaction;
+declare function getDeploymentTxPath(tx: ContractTransaction): string;
+declare function getIdentifier(tx: ContractTransaction): string;
+declare function isContractTx(tx: Transaction): tx is ContractTransaction;
+
+declare function parseDeployment(path: string): Promise<Plan>;
+declare const DEPLOYMENT_NETWORKS: readonly ["devnet", "simnet", "testnet", "mainnet"];
+type DeploymentNetwork = (typeof DEPLOYMENT_NETWORKS)[number];
+type Plan = DeploymentPlan | undefined;
+type DeploymentsMap = {
+    [key in DeploymentNetwork]: Plan;
+};
+declare function getDeployments(config: Config): Promise<DeploymentsMap>;
+declare function generateESMFile({ baseFile, session, config, }: {
+    baseFile: string;
+    session: Session;
+    config: Config;
+}): Promise<string>;
+type ContractDeployments = {
+    [key in DeploymentNetwork]: string | null;
+};
+type FullContractDeployments = {
+    [contractName: string]: ContractDeployments;
+};
+declare function collectContractDeployments(session: Session, deployments: DeploymentsMap, config: Config): FullContractDeployments;
+declare function collectDeploymentFiles(deployments: DeploymentsMap, clarinetFolder: string, cwd: string): {
+    identifier: string;
+    file: string;
+}[];
+declare function afterESM(config: Config): Promise<void>;
+
+declare const jsTypeFromAbiType: (val: ClarityAbiType, isArgument?: boolean) => string;
+declare function abiArgType(arg: ClarityAbiArg): string;
+declare function abiFunctionType(abiFunction: ClarityAbiFunction): string;
+declare function getArgName(name: string): string;
+
+declare function encodeVariableName(name: string): string;
+declare function fileExists(filename: string): Promise<boolean>;
+declare function writeFile(path: string, contents: string): Promise<string>;
+declare function cwdRelative(path: string): string;
+declare function sortContracts<T extends {
+    contract_id: string;
+}>(contracts: T[]): T[];
+
+export { type Batch, CONFIG_FILE, type ClaridocContract, type ClaridocFunction, type ClaridocItem, type ClaridocMap, type ClaridocParam, type ClaridocVariable, type ClarinetConfig, ClarinetConfigSchema, type Comments, Config, type ConfigFile, ConfigFileSchema, type ContractDeployments, type ContractTransaction, DEPLOYMENT_NETWORKS, type DeploymentNetwork, type DeploymentPlan, type DevnetDeploymentPlan, type EpochType, FN_TYPES, type FullContractDeployments, type MainnetDeploymentPlan, OutputType, type Session, type SessionAccount, type SessionContract, type SessionWithVariables, type SimnetAccountDeployer, type SimnetDeploymentPlan, TYPE_IMPORTS, type TestnetDeploymentPlan, type Transaction, VAR_TYPES, abiArgType, abiFunctionType, afterDocs, afterESM, collectContractDeployments, collectDeploymentFiles, configFilePath, createContractDocInfo, cwdRelative, defaultConfigFile, encodeVariableName, encodeVariables, fileExists, flatBatch, generateBaseFile, generateContractMeta, generateDocs, generateESMFile, generateMarkdown, generateReadme, getArgName, getClarinetConfig, getConfig, getContractTxs, getDeploymentContract, getDeploymentTxPath, getDeployments, getFnName, getIdentifier, getVariablesV2, isComment, isContractTx, jsTypeFromAbiType, mapVariables, markdownFunction, parseComments, parseDeployment, saveConfig, serialize, sortContracts, traceParens, writeFile };

package/dist/index.d.ts

@@ -441,4 +441,4 @@ declare function sortContracts<T extends {
     contract_id: string;
 }>(contracts: T[]): T[];
 
-export { Batch, CONFIG_FILE, ClaridocContract, ClaridocFunction, ClaridocItem, ClaridocMap, ClaridocParam, ClaridocVariable, ClarinetConfig, ClarinetConfigSchema, Comments, Config, ConfigFile, ConfigFileSchema, ContractDeployments, ContractTransaction, DEPLOYMENT_NETWORKS, DeploymentNetwork, DeploymentPlan, DevnetDeploymentPlan, EpochType, FN_TYPES, FullContractDeployments, MainnetDeploymentPlan, OutputType, Session, SessionAccount, SessionContract, SessionWithVariables, SimnetAccountDeployer, SimnetDeploymentPlan, TYPE_IMPORTS, TestnetDeploymentPlan, Transaction, VAR_TYPES, abiArgType, abiFunctionType, afterDocs, afterESM, collectContractDeployments, collectDeploymentFiles, configFilePath, createContractDocInfo, cwdRelative, defaultConfigFile, encodeVariableName, encodeVariables, fileExists, flatBatch, generateBaseFile, generateContractMeta, generateDocs, generateESMFile, generateMarkdown, generateReadme, getArgName, getClarinetConfig, getConfig, getContractTxs, getDeploymentContract, getDeploymentTxPath, getDeployments, getFnName, getIdentifier, getVariablesV2, isComment, isContractTx, jsTypeFromAbiType, mapVariables, markdownFunction, parseComments, parseDeployment, saveConfig, serialize, sortContracts, traceParens, writeFile };
+export { type Batch, CONFIG_FILE, type ClaridocContract, type ClaridocFunction, type ClaridocItem, type ClaridocMap, type ClaridocParam, type ClaridocVariable, type ClarinetConfig, ClarinetConfigSchema, type Comments, Config, type ConfigFile, ConfigFileSchema, type ContractDeployments, type ContractTransaction, DEPLOYMENT_NETWORKS, type DeploymentNetwork, type DeploymentPlan, type DevnetDeploymentPlan, type EpochType, FN_TYPES, type FullContractDeployments, type MainnetDeploymentPlan, OutputType, type Session, type SessionAccount, type SessionContract, type SessionWithVariables, type SimnetAccountDeployer, type SimnetDeploymentPlan, TYPE_IMPORTS, type TestnetDeploymentPlan, type Transaction, VAR_TYPES, abiArgType, abiFunctionType, afterDocs, afterESM, collectContractDeployments, collectDeploymentFiles, configFilePath, createContractDocInfo, cwdRelative, defaultConfigFile, encodeVariableName, encodeVariables, fileExists, flatBatch, generateBaseFile, generateContractMeta, generateDocs, generateESMFile, generateMarkdown, generateReadme, getArgName, getClarinetConfig, getConfig, getContractTxs, getDeploymentContract, getDeploymentTxPath, getDeployments, getFnName, getIdentifier, getVariablesV2, isComment, isContractTx, jsTypeFromAbiType, mapVariables, markdownFunction, parseComments, parseDeployment, saveConfig, serialize, sortContracts, traceParens, writeFile };