feat: improve comments

Author: FedericoAmura

packages/automation/src/lib/state-machine.ts

@@ -140,10 +140,34 @@ export class StateMachine {
     return stateMachine;
   }
 
+  /**
+   * Indicates if the state machine is running
+   */
   get isRunning() {
     return this.status === 'running';
   }
 
+  /**
+   * Returns an ethers Wallet the state machine can use
+   */
+  get signer() {
+    if (!this.privateKey) {
+      throw new AutomationError(
+        {
+          info: {},
+        },
+        `Cannot use state machine signer without a private key. Pass a PK to the machine when creating it`
+      );
+    }
+
+    return new ethers.Wallet(
+      this.privateKey,
+      new ethers.providers.JsonRpcProvider(
+        RPC_URL_BY_NETWORK[this.litNodeClient.config.litNetwork]
+      )
+    );
+  }
+
   /**
    * Adds a custom state to the state machine.
    * @param params The parameters for the state.
@@ -722,7 +746,9 @@ export class StateMachine {
       );
     }
     if (this.currentState === nextState) {
-      console.warn(`State ${stateKey} is already active. Skipping transition.`);
+      console.warn(
+        `State ${stateKey} is already active. Skipping state change.`
+      );
       return;
     }
 

packages/automation/src/lib/transitions/transition.ts

@@ -10,7 +10,7 @@ type Values = (unknown | undefined)[];
  */
 export interface BaseTransitionParams {
   debug?: boolean;
-  listeners?: Listener<any>[]; // should be unknown but that makes callers to cast listeners
+  listeners?: Listener<any>[]; // should be unknown but that demands callers to cast listeners to their correct type
   check?: CheckFn;
   onMatch: resultFn;
   onMismatch?: resultFn;