Feat/auth providers - #432
Merged
Merged
Conversation
spartan124
marked this pull request as ready for review
July 28, 2026 20:22
Contributor
Author
|
Totally unrelated. But when should we expect rewards? |
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.
Pluggable Authentication Provider Architecture
Description
This PR introduces a pluggable authentication architecture via a new
AuthenticationProviderinterface, allowing the SDK to support future authentication methods (like OAuth, JWTs, SIWE, etc.) without tightly coupling them to theHttpClientorGuildPassClient.Changes
AuthenticationProviderInterface: Introduced theAuthenticationProviderinterface to abstract token injection and refresh logic.ApiKeyAuthenticationProvider: Extracted the legacy API key injection logic into its own provider, ensuring backward compatibility.HttpClient: Refactored theHttpClientto consumeAuthenticationProviderinstead of a raw API key.onUnauthorizedhook toAuthenticationProvider, which theHttpClientcalls automatically when it receives a 401 response, allowing the provider to fetch a new token and trigger a request retry.GuildPassClientBuilder: Exposed.withAuthProvider(provider)for clean provider registration.docs/authentication.mdoutlining how to build and register custom authentication providers.AuthenticationProvidercorrectly injects headers, triggers token refreshes on 401 Unauthorized responses, and that the SDK correctly falls back to legacyapiKeybehavior when configured.Motivation & Context
Fixes #352
Previously,
HttpClientdirectly injected theX-API-Keyheader into outgoing requests. As the ecosystem expands, clients will need to authenticate using diverse strategies (e.g. Bearer tokens, wallet signatures). This refactor extracts authentication concerns from the HTTP transport layer, providing a modular design that is both backwards-compatible and future-proof.How Has This Been Tested?
apiKeyconfigurations inGuildPassClientcorrectly map toApiKeyAuthenticationProviderinternally without breaking existing integrations.X-API-Keybehavior and verifying the newonUnauthorizedretry loops.npm run lint,npm run typecheck, andnpm run test:runlocally to ensure no regressions.