#close 129 feat: add validatePocketPayConfig helper for early SDK configuration validation#233
Merged
El-swaggerito merged 3 commits intoJul 23, 2026
Conversation
Contributor
|
This PR cannot be merged automatically because it has merge conflicts. Please update the branch with the latest base branch and resolve the conflicts. After the conflicts are resolved and checks pass, the automation can review it again. |
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
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 non-throwing configuration validation helper (
validatePocketPayConfig) to allow consumers to validate SDK configuration settings early before initiating network or transaction operations.Solution
Implemented
validatePocketPayConfigwhich evaluates configuration options and returns a structuredConfigValidationResultcontaining:valid:boolean(truewhen zero errors exist)errors: Array of fatal configuration issueswarnings: Array of non-fatal advisory issues (e.g., insecure HTTP URLs, network/endpoint mismatches, extreme timeouts)issues: Complete list of all errors and warningsconfig: ResolvedSDKConfig(populated whenvalidistrue)Key Changes
src/types/index.ts): AddedConfigIssueSeverity,ConfigValidationIssue, andConfigValidationResult.src/config/index.ts): AddedvalidatePocketPayConfig()and integratedsanitizeValue/redactSensitiveso sensitive patterns (e.g., Stellar secret keysS...) are sanitized in validation output (S[REDACTED]).src/index.ts): Re-exportedvalidatePocketPayConfigand configuration validation result types from the package root.tests/config-validation.test.ts): Added tests covering default testnet configuration, explicit valid overrides, malformed/invalid parameters, advisory warnings, and secret key redaction.docs/configuration.md): Added an "Early Configuration Validation" guide with structured return types and TypeScript usage examples.Usage Example