contrib: add facilitator outage runbook - #347
Merged
davedumto merged 1 commit intoAug 31, 2026
Merged
Conversation
Adds a runbook describing how to detect and respond to a degraded or unreachable vellar-facilitator service: detection signals (both consumer-side symptoms and what is NOT an outage), consumer-facing guidance including the SDK/mcp-x402-payer error types expected during an outage and what to do about them, and escalation steps with maintainer contacts. closes Vellar-Wallet#286
|
@Elizabethxxx Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@Elizabethxxx is attempting to deploy a commit to the david's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a runbook describing how consumers and maintainers should respond when the vellar-facilitator service is degraded or unreachable.
closes #286
What's included
transactionsignature described inmcp-x402-payer's own README, discovery/quote timeouts, malformed challenges) and a table of look-alike symptoms that are explicitly not a facilitator outage (over-budget, disallowed asset, session ceiling, on-chain policy rejection, a single terminal settlement failure), so on-call doesn't misattribute a local configuration issue to a service outage.mcp-x402-payererror types during an outage (SettlementFailedError,IndeterminateSettlementError,NoUsablePaymentOptionError,InvalidRequirementsError, generic network errors), cross-checked against the actual error classes insrc/x402-types.tsandpackages/mcp-x402-payer/src/errors.ts, plus concrete dos and don'ts (don't retry aggressively on top of the built-in retries, don't widen budgets to force a payment through, check on-chain state before manually retrying an indeterminate settlement, fall back to non-x402 flows where possible).CONTRIBUTING.md), plus a note not to open avellar-sdkissue for a facilitator-side incident.Placement note
The issue asks for this runbook to live alongside
CONTRIBUTING.mdat the repo root. Contributor PRs may only touchcontrib/, so it's submitted atcontrib/examples/issue-286-facilitator-outage-runbook/FACILITATOR-OUTAGE-RUNBOOK.mdwith a placement note at the top of the file; a maintainer can move it to the repo root when merging.Test plan
Documentation only — no code changes. Reviewed the referenced error classes and the settlement failure taxonomy in
packages/mcp-x402-payer/README.mdagainst the currentdevbranch to keep the guidance accurate.