SDP-1926: add Troubleshooting page #2151
Conversation
- payment error
- receiver not getting the invitation
- receiver not getting otp
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive troubleshooting guide for the Stellar Disbursement Platform (SDP) to help administrators diagnose and resolve common operational issues.
Key Changes:
- New troubleshooting documentation covering payment issues, receiver communications, and channel account management
- Quick reference table for common symptoms with direct links to solutions
- Detailed diagnostic procedures with example error messages and command-line solutions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|  | ||
|
|
There was a problem hiding this comment.
The image reference 'SDP45.png' is being used in this documentation. Since the monitoring documentation references images like SDP42.png, SDP43.png, and SDP44.png, this appears to follow the same naming pattern. Please verify that the SDP45.png file has been added to the static/assets/SDP/ directory (or wherever the SDP assets are stored). If the image doesn't exist, this will result in a broken image link in the documentation.
|  |
| <TabItem value="destination" label="Destination Account Missing"> | ||
|
|
||
| The receiver's account hasn't been created on the Stellar network. The account must be funded with the minimum balance (currently 1 XLM on mainnet) before it can receive payments. | ||
|
|
||
| </TabItem> | ||
| <TabItem value="channel" label="Channel Accounts Missing"> | ||
|
|
||
| Channel accounts may disappear after testnet resets. See [Recreating Channel Accounts](#recreating-channel-accounts) below. | ||
|
|
||
| </TabItem> |
There was a problem hiding this comment.
The content inside the TabItem tags should not be indented. The current indentation (8 spaces) is inconsistent with the documentation conventions used elsewhere in this repository. The content should start at the left margin, immediately after the opening TabItem tag.
| <details> | ||
| <summary>Example error: "Resource Missing"</summary> | ||
|
|
||
| ``` | ||
| time="2025-12-19T18:43:37.017Z" level=error msg="[DRY_RUN Crash Reporter] unexpected TSS error: preparing bundle for processing: building transaction: horizon response error: getting account detail: horizon error: \"Resource Missing\" - check horizon.Error.Problem for more information" app_version=6.0.1 asset=XLM channel_account=GBKEVxxxx ... | ||
| ``` | ||
|
|
||
| </details> |
There was a problem hiding this comment.
The content inside the details tags should use 2-space indentation to match the convention used elsewhere in the documentation. Currently, 4 spaces are being used, which is inconsistent with the pattern seen in other files like docs/build/smart-contracts/overview.mdx.
| <details> | ||
| <summary>Full error message</summary> | ||
|
|
||
| ``` | ||
| horizon response error: StatusCode=400, Type=https://stellar.org/horizon-errors/transaction_failed, | ||
| Title=Transaction Failed, Detail=The transaction failed when submitted to the stellar network. | ||
| The `extras.result_codes` field on this response contains further details. | ||
| Descriptions of each code can be found at: https://developers.stellar.org/docs/data/apis/horizon/api-reference/errors/http-status-codes/horizon-specific/transaction-failed/, | ||
| Extras=transaction: tx_fee_bump_inner_failed - inner transaction: tx_failed - operation codes: [ op_no_trust ] | ||
| ``` | ||
|
|
||
| </details> |
There was a problem hiding this comment.
The content inside the details tags should use 2-space indentation to match the convention used elsewhere in the documentation. Currently, 4 spaces are being used, which is inconsistent with the pattern seen in other files like docs/build/smart-contracts/overview.mdx.
| 2. **Note the exact error message** and when it started occurring | ||
| 3. **Check for recent changes** to configuration, environment, or network (e.g., testnet reset) | ||
|
|
||
| Contact us either by opening an issue on our [Backend GitHub repository](https://github.com/stellar/stellar-disbursement-platform-backend/issues) or [Front-end GitHub repository](https://github.com/stellar/stellar-disbursement-platform-frontend/issues) with the details above and the version of SDP you're running. We'll help you troubleshoot further! We're also available on Discord in the [#bulk-disbursements](https://discord.com/channels/897514728459468821/1310800776331006002) channel. |
There was a problem hiding this comment.
The term "Front-end" should be "Frontend" (one word, no hyphen) to match the convention used for "Backend" in the same sentence and to align with the repository naming convention (stellar-disbursement-platform-frontend).
| Contact us either by opening an issue on our [Backend GitHub repository](https://github.com/stellar/stellar-disbursement-platform-backend/issues) or [Front-end GitHub repository](https://github.com/stellar/stellar-disbursement-platform-frontend/issues) with the details above and the version of SDP you're running. We'll help you troubleshoot further! We're also available on Discord in the [#bulk-disbursements](https://discord.com/channels/897514728459468821/1310800776331006002) channel. | |
| Contact us either by opening an issue on our [Backend GitHub repository](https://github.com/stellar/stellar-disbursement-platform-backend/issues) or [Frontend GitHub repository](https://github.com/stellar/stellar-disbursement-platform-frontend/issues) with the details above and the version of SDP you're running. We'll help you troubleshoot further! We're also available on Discord in the [#bulk-disbursements](https://discord.com/channels/897514728459468821/1310800776331006002) channel. |
|
Preview is available here: |
|
Preview is available here: |
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| # Troubleshooting |
There was a problem hiding this comment.
strictly speaking from a docusaurus standpoint, this starting h1 line isn't necessary. Since the title frontmatter is present, if you just start the file with the imports and then This guide helps you ..., an h1 will be inserted with the title you've provided.
Source: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#title
There was a problem hiding this comment.
won't hurt anything to keep it, though. totally fine either way
No description provided.