From e5079e725052d22334cf6802cf841f31380b90ff Mon Sep 17 00:00:00 2001 From: thedriftofwords Date: Thu, 22 Feb 2024 17:18:31 -0500 Subject: [PATCH 1/3] Add Automation debugging script --- .../reference/debugging-errors.mdx | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/content/chainlink-automation/reference/debugging-errors.mdx b/src/content/chainlink-automation/reference/debugging-errors.mdx index 227ef83893d..63fb266ecd1 100644 --- a/src/content/chainlink-automation/reference/debugging-errors.mdx +++ b/src/content/chainlink-automation/reference/debugging-errors.mdx @@ -16,7 +16,7 @@ Given an upkeep ID, this page contains different methods of understanding and fi ## Underfunded upkeeps -In the Chainlink Automation app, you can see the registration details of the upkeep, alongside the balance required and `performUpkeep` history. If the upkeep is underfunded, you’ll see a warning on top of the page. Underfunded upkeeps will not be performed. +In the Chainlink Automation app, you can see the registration details of the upkeep, alongside the balance required and `performUpkeep` history. If the upkeep is underfunded, you'll see a warning on top of the page. Underfunded upkeeps will not be performed. @@ -30,13 +30,13 @@ If the amount of computation in your checkUpkeep exceeds our checkGasLimit, your ## Paused upkeeps -If your upkeep is paused, your upkeep will not be performed. Please unpause it via the UI.. +If your upkeep is paused, your upkeep will not be performed. Please unpause it in the [Chainlink Automation app](https://automation.chain.link/). ## StreamsLookup ### Upkeep has not been allowlisted -Once you registered your upkeep, you need to ask the Data Streams team to allowlist your upkeepID and specify the feeds you will need to access. If your upkeepID has not been added to the allow list it will not perform an upkeep. +Once you registered your upkeep, you need to [ask the Data Streams team to allowlist your upkeepID](https://chainlinkcommunity.typeform.com/datastreams?#ref_id=docs) and specify the feeds you will need to access. If your upkeepID has not been added to the allow list it will not perform an upkeep. ### Requesting multiple feeds where one is not valid @@ -44,10 +44,10 @@ It is possible to request multiple feeds by specifying the feeds in a string arr ## Etherscan -You can view the registry/user's upkeep address on [Etherscan](https://etherscan.io/) to view transaction history. There are three types of information you can find on Ehterscan: +You can view the registry or user's upkeep address on [Etherscan](https://etherscan.io/) to view transaction history. There are three types of information you can find on Etherscan: - **All transactions on registry**: This shows all the perform upkeeps on the registry. You can view a specific `perfomUpkeep` transaction to debug more. -- **Specific `performUpkeep` transaction**: By diving deep in the logs, you can check the upkeep ID within UpkeepPerformed log. +- **Specific `performUpkeep` transaction**: By diving deep in the logs, you can check the upkeep ID within the UpkeepPerformed log. - **Target's internal transactions**: For a particular target contract, you can view its internal transactions which contains `performUpkeep` transactions for that contract by using the registry address as the filter for _from_ address. _Note_: internal transactions are only visible on Etherscan. ## Tenderly @@ -61,3 +61,7 @@ You can use [Tenderly](https://tenderly.co/) to simulate `checkUpkeep` and/or `p 1. Enter the ID of your Upkeep. You can find this in the [Chainlink Automation app](https://automation.chain.link/). 1. You can either enter a block number to simulate a past action or use a pending block number to view the current state of an action and view the end result of an of an action. 1. Once the simulation is complete, you will see the result. This will be either a _success_ or an _error_. To understand errors, view information under the **Debug** tab. **Note**: if the `performUpkeep` is failing while the check is succeeding, Chainlink Automation will not broadcast transactions. + +## Automation debugging script + +You can use the [Automation debugging script](https://github.com/smartcontractkit/chainlink/blob/cla-debugger-docs/core/scripts/chaincli/DEBUGGING.md) to debug and diagnose possible issues with registered upkeeps in Automation 2.0 registries. The script can debug custom logic upkeeps, log trigger upkeeps, and upkeeps that use StreamsLookup. From c91474da5d58e88d6d432a636f750996c069f925 Mon Sep 17 00:00:00 2001 From: thedriftofwords Date: Thu, 22 Feb 2024 19:16:00 -0500 Subject: [PATCH 2/3] Move to top --- .../chainlink-automation/reference/debugging-errors.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/content/chainlink-automation/reference/debugging-errors.mdx b/src/content/chainlink-automation/reference/debugging-errors.mdx index 63fb266ecd1..032822eff05 100644 --- a/src/content/chainlink-automation/reference/debugging-errors.mdx +++ b/src/content/chainlink-automation/reference/debugging-errors.mdx @@ -14,6 +14,10 @@ import { ClickToZoom } from "@components" Given an upkeep ID, this page contains different methods of understanding and fixing issues with Upkeeps. +## Automation debugging script + +You can use the [Automation debugging script](https://github.com/smartcontractkit/chainlink/blob/cla-debugger-docs/core/scripts/chaincli/DEBUGGING.md) to debug and diagnose possible issues with registered upkeeps in Automation 2.1 registries. The script can debug custom logic upkeeps, log trigger upkeeps, and upkeeps that use StreamsLookup. + ## Underfunded upkeeps In the Chainlink Automation app, you can see the registration details of the upkeep, alongside the balance required and `performUpkeep` history. If the upkeep is underfunded, you'll see a warning on top of the page. Underfunded upkeeps will not be performed. @@ -61,7 +65,3 @@ You can use [Tenderly](https://tenderly.co/) to simulate `checkUpkeep` and/or `p 1. Enter the ID of your Upkeep. You can find this in the [Chainlink Automation app](https://automation.chain.link/). 1. You can either enter a block number to simulate a past action or use a pending block number to view the current state of an action and view the end result of an of an action. 1. Once the simulation is complete, you will see the result. This will be either a _success_ or an _error_. To understand errors, view information under the **Debug** tab. **Note**: if the `performUpkeep` is failing while the check is succeeding, Chainlink Automation will not broadcast transactions. - -## Automation debugging script - -You can use the [Automation debugging script](https://github.com/smartcontractkit/chainlink/blob/cla-debugger-docs/core/scripts/chaincli/DEBUGGING.md) to debug and diagnose possible issues with registered upkeeps in Automation 2.0 registries. The script can debug custom logic upkeeps, log trigger upkeeps, and upkeeps that use StreamsLookup. From 19d6c05639365d80b0731bc574e83e51e17fffc9 Mon Sep 17 00:00:00 2001 From: Crystal Gomes Date: Thu, 22 Feb 2024 19:26:06 -0500 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Dwight Lyle --- .../chainlink-automation/reference/debugging-errors.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/chainlink-automation/reference/debugging-errors.mdx b/src/content/chainlink-automation/reference/debugging-errors.mdx index 032822eff05..910408d85dd 100644 --- a/src/content/chainlink-automation/reference/debugging-errors.mdx +++ b/src/content/chainlink-automation/reference/debugging-errors.mdx @@ -16,11 +16,11 @@ Given an upkeep ID, this page contains different methods of understanding and fi ## Automation debugging script -You can use the [Automation debugging script](https://github.com/smartcontractkit/chainlink/blob/cla-debugger-docs/core/scripts/chaincli/DEBUGGING.md) to debug and diagnose possible issues with registered upkeeps in Automation 2.1 registries. The script can debug custom logic upkeeps, log trigger upkeeps, and upkeeps that use StreamsLookup. +You can use the [Automation debugging script](https://github.com/smartcontractkit/chainlink/blob/cla-debugger-docs/core/scripts/chaincli/DEBUGGING.md) to debug and diagnose possible issues with registered upkeeps in Automation 2.1 registries. The script can debug custom logic upkeeps, log trigger upkeeps, and upkeeps that use `StreamsLookup`. ## Underfunded upkeeps -In the Chainlink Automation app, you can see the registration details of the upkeep, alongside the balance required and `performUpkeep` history. If the upkeep is underfunded, you'll see a warning on top of the page. Underfunded upkeeps will not be performed. +In the Chainlink Automation app, you can see the registration details of the upkeep, alongside the balance required and `performUpkeep` history. If the upkeep is underfunded, you will see a warning on top of the page. Underfunded upkeeps will not be performed.