align more with original comments

Author: dev-dist

data-streams/getting-started/hardhat/tasks/emitLog.ts

@@ -17,10 +17,11 @@ export const emitLog = task(
       { logEmitter }: { logEmitter: string },
       hre: HardhatRuntimeEnvironment
     ) => {
-      // Connect to network and get the contract instance
       const { viem } = await hre.network.connect();
       const publicClient = await viem.getPublicClient();
-      const logEmitterContract = await viem.getContractAt(
+
+      // Create an instance of the LogEmitter contract at the specified address.
+      const LogEmitterContract = await viem.getContractAt(
         "LogEmitter",
         logEmitter as `0x${string}`
       );
@@ -29,14 +30,16 @@ export const emitLog = task(
       spinner.start("Emitting a log...");
 
       try {
-        // Call the emitLog function of the LogEmitter contract
-        const hash = await logEmitterContract.write.emitLog();
+        // Call the emitLog function of the LogEmitter contract to emit a log event.
+        const tx = await LogEmitterContract.write.emitLog();
 
-        // Wait for the transaction to be mined
-        await publicClient.waitForTransactionReceipt({ hash });
+        // Wait for the transaction to be mined to ensure the log has been emitted.
+        await publicClient.waitForTransactionReceipt({ hash: tx });
 
-        spinner.succeed(`Log emitted successfully in transaction: ${hash}`);
+        // Stop the spinner with a success message, including the transaction hash.
+        spinner.succeed(`Log emitted successfully in transaction: ${tx}`);
       } catch (error) {
+        // In case of error, stop the spinner with a failure message.
         spinner.fail("Failed to emit log.");
         throw error;
       }

data-streams/getting-started/hardhat/tasks/getLastRetrievedPrice.ts

@@ -25,16 +25,18 @@ export const getLastPrice = task(
         `Retrieving the last price from StreamsUpkeep at ${streamsUpkeep}...`
       );
 
-      // Retrieve an instance of the StreamsUpkeep contract
+      // Retrieve an instance of the StreamsUpkeep contract using the provided address.
+      // This enables interaction with the contract's functions.
       const { viem } = await hre.network.connect();
-      const contract = await viem.getContractAt(
+      const StreamsUpkeepContract = await viem.getContractAt(
         "StreamsUpkeepRegistrar",
         streamsUpkeep as `0x${string}`
       );
 
       try {
-        // Call the automatically generated getter function for the lastDecodedPrice public state variable
-        const lastDecodedPrice = await contract.read.lastDecodedPrice();
+        // Call the automatically generated getter function for the lastDecodedPrice public state variable.
+        const lastDecodedPrice =
+          await StreamsUpkeepContract.read.lastDecodedPrice();
         spinner.succeed(`Last Retrieved Price: ${lastDecodedPrice}`);
       } catch (error) {
         spinner.fail("Failed to retrieve the last price.");

data-streams/getting-started/hardhat/tasks/registerAndFundLogUpkeep.ts

@@ -31,45 +31,47 @@ export const registerUpkeep = task(
       }: { streamsUpkeep: string; logEmitter: string },
       hre: HardhatRuntimeEnvironment
     ) => {
-      // Connect to network and get wallet client
       const { viem } = await hre.network.connect();
       const [walletClient] = await viem.getWalletClients();
-      const account = walletClient.account.address;
 
-      // Define registration parameters for the upkeep
-      const name = "Prog. Streams Upkeep";
-      const encryptedEmail = "0x" as `0x${string}`;
-      const gasLimit = 500000;
-      const triggerType = 1; // Log Trigger
-      const checkData = "0x" as `0x${string}`;
-      const offchainConfig = "0x" as `0x${string}`;
-      const amount = parseEther("1"); // 1 LINK
+      // Retrieve the deployer's (admin's) signer object to sign transactions.
+      const admin = walletClient.account.address;
 
-      // Event signature hash and placeholder topics for the LogEmitter trigger
+      // Define registration parameters for the upkeep.
+      // See more information on https://docs.chain.link/chainlink-automation/guides/register-upkeep-in-contract.
+      const name = "Prog. Streams Upkeep"; // Name of the upkeep registration.
+      const encryptedEmail = "0x" as `0x${string}`; // Placeholder for an encrypted email (optional).
+      const gasLimit = 500000; // Maximum gas allowance for the upkeep execution.
+      const triggerType = 1; // Type of trigger, where `1` represents a Log Trigger.
+      const checkData = "0x" as `0x${string}`; // Data passed to checkUpkeep; placeholder in this context.
+      const offchainConfig = "0x" as `0x${string}`; // Off-chain configuration data; placeholder in this context.
+      const amount = parseEther("1"); // Funding amount in LINK tokens.
+
+      // Event signature hash and placeholder topics for the LogEmitter trigger.
       const topic0 =
-        "0xb8a00d6d8ca1be30bfec34d8f97e55f0f0fd9eeb7fb46e030516363d4cfe1ad6";
+        "0xb8a00d6d8ca1be30bfec34d8f97e55f0f0fd9eeb7fb46e030516363d4cfe1ad6"; // Event signature hash.
       const topic1 =
-        "0x0000000000000000000000000000000000000000000000000000000000000000";
+        "0x0000000000000000000000000000000000000000000000000000000000000000"; // Placeholder topics.
       const topic2 =
         "0x0000000000000000000000000000000000000000000000000000000000000000";
       const topic3 =
         "0x0000000000000000000000000000000000000000000000000000000000000000";
 
-      // ABI-encode the trigger configuration data
+      // ABI-encode the trigger configuration data.
       const triggerConfig = encodeAbiParameters(
         parseAbiParameters(
           "address, uint8, bytes32, bytes32, bytes32, bytes32"
         ),
         [logEmitter as `0x${string}`, 0, topic0, topic1, topic2, topic3]
       );
 
-      // Construct the parameters for registration
+      // Construct the parameters for registration, combining all previously defined values.
       const params = {
         name,
         encryptedEmail,
         upkeepContract: streamsUpkeep as `0x${string}`,
         gasLimit,
-        adminAddress: account,
+        adminAddress: admin,
         triggerType,
         checkData,
         triggerConfig,
@@ -78,18 +80,17 @@ export const registerUpkeep = task(
       };
 
       const spinner = spin();
+      // Interact with the deployed StreamsUpkeep contract to register the upkeep.
       spinner.start(
-        `Registering upkeep with Chainlink Automation using account: ${account}`
+        `Registering upkeep with Chainlink Automation using account: ${admin}`
       );
-
-      // Interact with the deployed StreamsUpkeep contract to register the upkeep
-      const streamsUpkeepContract = await viem.getContractAt(
+      const StreamsUpkeepContract = await viem.getContractAt(
         "StreamsUpkeepRegistrar",
         streamsUpkeep as `0x${string}`
       );
 
       try {
-        await streamsUpkeepContract.write.registerAndPredictID([params]);
+        await StreamsUpkeepContract.write.registerAndPredictID([params]);
         spinner.succeed(
           "Upkeep registered and funded with 1 LINK successfully."
         );