@secondlayer/cli 0.3.10 → 1.1.0

package/dist/index.d.ts

@@ -16,7 +16,7 @@ interface ContractSource {
 	*/
 	name?: string;
 }
-interface StacksConfig {
+interface SecondLayerConfig {
 	/**
 	* Contracts to generate interfaces for (optional - plugins can provide these)
 	*/
@@ -57,7 +57,7 @@ interface ResolvedContract {
 /**
 * Core plugin interface that all plugins must implement
 */
-interface StacksCodegenPlugin {
+interface SecondLayerPlugin {
 	/** Plugin name (should be unique) */
 	name: string;
 	/** Plugin version */
@@ -80,13 +80,13 @@ interface StacksCodegenPlugin {
 /**
 * User configuration (before plugin transformations)
 */
-type UserConfig = StacksConfig;
+type UserConfig = SecondLayerConfig;
 /**
 * Resolved configuration (after plugin transformations)
 */
-interface ResolvedConfig extends StacksConfig {
+interface ResolvedConfig extends SecondLayerConfig {
 	/** Resolved plugins array */
-	plugins: StacksCodegenPlugin[];
+	plugins: SecondLayerPlugin[];
 }
 /**
 * Contract configuration that can be transformed by plugins
@@ -187,7 +187,7 @@ interface PluginUtils {
 /**
 * Plugin factory function type for creating plugins with options
 */
-type PluginFactory<TOptions = any> = (options?: TOptions) => StacksCodegenPlugin;
+type PluginFactory<TOptions = any> = (options?: TOptions) => SecondLayerPlugin;
 /**
 * Plugin options base interface
 */
@@ -224,11 +224,11 @@ declare class PluginManager {
 	/**
 	* Register a plugin
 	*/
-	register(plugin: StacksCodegenPlugin): void;
+	register(plugin: SecondLayerPlugin): void;
 	/**
 	* Get all registered plugins
 	*/
-	getPlugins(): StacksCodegenPlugin[];
+	getPlugins(): SecondLayerPlugin[];
 	/**
 	* Transform user config through all plugins
 	*/
@@ -240,7 +240,7 @@ declare class PluginManager {
 	/**
 	* Execute lifecycle hooks
 	*/
-	executeHook(hookName: keyof StacksCodegenPlugin, context: any): Promise<void>;
+	executeHook(hookName: keyof SecondLayerPlugin, context: any): Promise<void>;
 	/**
 	* Execute generation phase with full context
 	*/
@@ -303,6 +303,8 @@ interface ActionsPluginOptions {
 	excludeFunctions?: string[];
 	/** Enable debug output */
 	debug?: boolean;
+	/** Environment variable name for default sender key (default: "STX_SENDER_KEY") */
+	senderKeyEnv?: string;
 }
 /**
 * Actions plugin factory
@@ -352,5 +354,5 @@ declare function filterByOptions<T extends {
 /**
 * Utility function to create a simple plugin
 */
-declare function createPlugin(name: string, version: string, implementation: Partial<StacksCodegenPlugin>): StacksCodegenPlugin;
-export { testing, react, hasClarinetProject, filterByOptions, createPlugin, clarinet, actions, TestingPluginOptions, StacksCodegenPlugin, ReactPluginOptions, PluginUtils, PluginOptions, PluginManager, PluginFactory, PluginContext, Logger, GenerateContext, ClarinetPluginOptions, BasePluginOptions, ActionsPluginOptions };
+declare function createPlugin(name: string, version: string, implementation: Partial<SecondLayerPlugin>): SecondLayerPlugin;
+export { testing, react, hasClarinetProject, filterByOptions, createPlugin, clarinet, actions, TestingPluginOptions, SecondLayerPlugin, ReactPluginOptions, PluginUtils, PluginOptions, PluginManager, PluginFactory, PluginContext, Logger, GenerateContext, ClarinetPluginOptions, BasePluginOptions, ActionsPluginOptions };

package/dist/index.js

@@ -1174,6 +1174,7 @@ function generateReadHelpers(contract, options) {
 function generateWriteHelpers(contract, options) {
   const { abi, name } = contract;
   const functions = abi.functions || [];
+  const envVarName = options.senderKeyEnv ?? "STX_SENDER_KEY";
   const publicFunctions = functions.filter((f) => f.access === "public");
   if (publicFunctions.length === 0) {
     return "";
@@ -1194,8 +1195,7 @@ function generateWriteHelpers(contract, options) {
     const methodName = toCamelCase4(func.name);
     const argsSignature = generateArgsSignature(func.args);
     const clarityArgs = generateClarityArgs(func.args, name);
-    return `async ${methodName}(${argsSignature}options: {
-      senderKey: string;
+    return `async ${methodName}(${argsSignature}senderKey?: string, options?: {
       network?: 'mainnet' | 'testnet' | 'devnet';
       fee?: string | number | undefined;
       nonce?: bigint;
@@ -1203,14 +1203,18 @@ function generateWriteHelpers(contract, options) {
       postConditions?: PostCondition[];
       validateWithAbi?: boolean;
     }) {
-      const { senderKey, network = 'mainnet', ...txOptions } = options;
-      
+      const resolvedSenderKey = senderKey ?? process.env.${envVarName};
+      if (!resolvedSenderKey) {
+        throw new Error('senderKey required: pass as argument or set ${envVarName} env var');
+      }
+      const { network = 'mainnet', ...txOptions } = options ?? {};
+
       return await makeContractCall({
         contractAddress: '${contract.address}',
         contractName: '${contract.contractName}',
         functionName: '${func.name}',
         functionArgs: [${clarityArgs}],
-        senderKey,
+        senderKey: resolvedSenderKey,
         network,
         validateWithAbi: true,
         ...txOptions
@@ -1331,16 +1335,16 @@ ${indentedHelpersCode}
 init_format();
 async function generateProvider() {
   const code = `/**
- * Generated Stacks React Provider
+ * Generated SecondLayer React Provider
  * DO NOT EDIT MANUALLY
  */
 
 import React, { createContext, useContext } from 'react'
 
 /**
- * Stacks configuration interface
+ * SecondLayer configuration interface
  */
-export interface StacksReactConfig {
+export interface SecondLayerReactConfig {
   /**
    * Network to use for API calls
    */
@@ -1365,21 +1369,21 @@ export interface StacksReactConfig {
 /**
  * Provider component props
  */
-export interface StacksProviderProps {
+export interface SecondLayerProviderProps {
   children: React.ReactNode
-  config: StacksReactConfig
+  config: SecondLayerReactConfig
 }
 
 /**
- * React context for Stacks configuration
+ * React context for SecondLayer configuration
  */
-const StacksContext = createContext<StacksReactConfig | undefined>(undefined)
-StacksContext.displayName = 'StacksContext'
+const SecondLayerContext = createContext<SecondLayerReactConfig | undefined>(undefined)
+SecondLayerContext.displayName = 'SecondLayerContext'
 
 /**
- * Create a Stacks React configuration with defaults
+ * Create a SecondLayer React configuration with defaults
  */
-export function createStacksConfig(config: StacksReactConfig): StacksReactConfig {
+export function createSecondLayerConfig(config: SecondLayerReactConfig): SecondLayerReactConfig {
   return {
     network: config.network,
     apiKey: config.apiKey,
@@ -1389,31 +1393,31 @@ export function createStacksConfig(config: StacksReactConfig): StacksReactConfig
 }
 
 /**
- * Provider component that makes Stacks configuration available to hooks
+ * Provider component that makes SecondLayer configuration available to hooks
  */
-export function StacksProvider({ children, config }: StacksProviderProps) {
-  const resolvedConfig = createStacksConfig(config)
+export function SecondLayerProvider({ children, config }: SecondLayerProviderProps) {
+  const resolvedConfig = createSecondLayerConfig(config)
 
   return (
-    <StacksContext.Provider value={resolvedConfig}>
+    <SecondLayerContext.Provider value={resolvedConfig}>
       {children}
-    </StacksContext.Provider>
+    </SecondLayerContext.Provider>
   )
 }
 
 /**
- * Hook to access the Stacks configuration
+ * Hook to access the SecondLayer configuration
  */
-export function useStacksConfig(): StacksReactConfig {
-  const context = useContext(StacksContext)
-  
+export function useSecondLayerConfig(): SecondLayerReactConfig {
+  const context = useContext(SecondLayerContext)
+
   if (context === undefined) {
     throw new Error(
-      'useStacksConfig must be used within a StacksProvider. ' +
-      'Make sure to wrap your app with <StacksProvider config={{...}}>'
+      'useSecondLayerConfig must be used within a SecondLayerProvider. ' +
+      'Make sure to wrap your app with <SecondLayerProvider config={{...}}>'
     )
   }
-  
+
   return context
 }`;
   return formatCode(code);
@@ -1440,7 +1444,7 @@ async function generateGenericHooks(excludeList = []) {
   const hooksToGenerate = GENERIC_HOOKS.filter((hookName) => !excludeList.includes(hookName));
   const imports = `import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query'
 import { useState, useCallback } from 'react'
-import { useStacksConfig } from './provider'
+import { useSecondLayerConfig } from './provider'
 import { connect, disconnect, isConnected, request, openContractCall as stacksOpenContractCall, openSTXTransfer, openSignatureRequestPopup, openContractDeploy } from '@stacks/connect'
 import { Cl, validateStacksAddress } from '@stacks/transactions'
 import type { PostCondition } from '@stacks/transactions'
@@ -1490,7 +1494,7 @@ function generateGenericHook(hookName) {
   switch (hookName) {
     case "useAccount":
       return `export function useAccount() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['stacks-account', config.network],
@@ -1633,7 +1637,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useNetwork":
       return `export function useNetwork() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['stacks-network', config.network],
@@ -1660,7 +1664,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useContract":
       return `export function useContract() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   const queryClient = useQueryClient()
   const [isRequestPending, setIsRequestPending] = useState(false)
   
@@ -1955,7 +1959,7 @@ function generateGenericHook(hookName) {
   network?: 'mainnet' | 'testnet' | 'devnet';
   enabled?: boolean;
 }) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery<TResult>({
     queryKey: ['read-contract', params.contractAddress, params.contractName, params.functionName, params.args, params.network || config.network],
@@ -1993,7 +1997,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useTransaction":
       return `export function useTransaction(txId?: string) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['transaction', txId, config.network],
@@ -2007,7 +2011,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useBlock":
       return `export function useBlock(height?: number) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['block', height, config.network],
@@ -2021,7 +2025,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useAccountTransactions":
       return `export function useAccountTransactions(address?: string) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['account-transactions', address, config.network],
@@ -2035,7 +2039,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useWaitForTransaction":
       return `export function useWaitForTransaction(txId?: string) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   return useQuery({
     queryKey: ['wait-for-transaction', txId, config.network],
@@ -2059,7 +2063,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useOpenSTXTransfer":
       return `export function useOpenSTXTransfer() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   const queryClient = useQueryClient()
   
   const mutation = useMutation({
@@ -2125,7 +2129,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useSignMessage":
       return `export function useSignMessage() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   
   const mutation = useMutation({
     mutationFn: async (params: {
@@ -2180,7 +2184,7 @@ function generateGenericHook(hookName) {
 }`;
     case "useDeployContract":
       return `export function useDeployContract() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   const queryClient = useQueryClient()
   
   const mutation = useMutation({
@@ -2299,7 +2303,7 @@ function generateObjectArgs(args) {
 async function generateContractHooks(contracts, excludeList = []) {
   const imports = `import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query'
 import { useCallback } from 'react'
-import { useStacksConfig } from './provider'
+import { useSecondLayerConfig } from './provider'
 import { request, openContractCall as stacksOpenContractCall } from '@stacks/connect'
 import type { PostCondition } from '@stacks/transactions'
 import { ${contracts.map((c) => c.name).join(", ")} } from './contracts'`;
@@ -2375,7 +2379,7 @@ function generateReadHook(func, contractName) {
   const enabledParam = func.args.length > 0 ? ", options?: { enabled?: boolean }" : "options?: { enabled?: boolean }";
   const returnType = clarityTypeToTS(func.outputs);
   return `export function ${hookName}(${argsSignature}${enabledParam}) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
 
   return useQuery<${returnType}>({
     queryKey: ['${func.name}', ${contractName}.address, ${generateQueryKeyArgs(func.args)}],
@@ -2392,7 +2396,7 @@ function generateWriteHook(func, contractName) {
   const hookName = `use${capitalize(contractName)}${capitalize(toCamelCase5(func.name))}`;
   const argsType = generateArgsType(func.args);
   return `export function ${hookName}() {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
   const queryClient = useQueryClient()
   
   const mutation = useMutation({
@@ -2485,7 +2489,7 @@ function generateMapHook(map, contractVarName, _address, _contractName) {
   const keyType = clarityTypeToTS(map.key);
   const valueType = clarityTypeToTS(map.value);
   return `export function ${hookName}(key: ${keyType}, options?: { enabled?: boolean }) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
 
   return useQuery<${valueType} | null>({
     queryKey: ['${contractVarName}', '${map.name}', 'map', key, config.network],
@@ -2500,7 +2504,7 @@ function generateVarHook(variable, contractVarName, _address, _contractName) {
   const hookName = `use${capitalize(contractVarName)}${capitalize(toCamelCase5(variable.name))}`;
   const valueType = clarityTypeToTS(variable.type);
   return `export function ${hookName}(options?: { enabled?: boolean }) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
 
   return useQuery<${valueType}>({
     queryKey: ['${contractVarName}', '${variable.name}', 'var', config.network],
@@ -2515,7 +2519,7 @@ function generateConstantHook(constant, contractVarName, _address, _contractName
   const hookName = `use${capitalize(contractVarName)}${capitalize(toCamelCase5(constant.name))}`;
   const valueType = clarityTypeToTS(constant.type);
   return `export function ${hookName}(options?: { enabled?: boolean }) {
-  const config = useStacksConfig()
+  const config = useSecondLayerConfig()
 
   return useQuery<${valueType}>({
     queryKey: ['${contractVarName}', '${constant.name}', 'constant', config.network],
@@ -2979,5 +2983,5 @@ export {
   PluginManager
 };
 
-//# debugId=FE7B5594AE67250064756E2164756E21
+//# debugId=DBBDDA8E89A55EA464756E2164756E21
 //# sourceMappingURL=index.js.map