fix: accept documented RelayClient constructor aliases - #26
Open
binggao1230 wants to merge 1 commit into
Open
Conversation
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
host,chain, andsignerkeyword aliases inRelayClient.__init__relayer_url,chain_id, andprivate_keyAPI, with existing names taking precedenceFixes #25.
Tests
uv run --with-requirements requirements.txt pytest tests/test_client_deposit_wallet.py -quv run --with-requirements requirements.txt pytest -qNote
Low Risk
Constructor-only compatibility change with explicit validation; no changes to relay execution or auth header logic.
Overview
RelayClient.__init__now accepts documented keyword aliaseshost,chain, andsigner(keyword-only) as fallbacks whenrelayer_url,chain_id, andprivate_keyare omitted. Existing parameter names still win when both are passed.Construction requires a relayer URL and chain id after alias resolution; missing values raise
TypeError.relayer_api_keyandrelayer_api_key_addressare accepted and stored on the client instance.Tests cover alias-based construction (including trailing-slash URL normalization) and precedence of canonical names over aliases.
Reviewed by Cursor Bugbot for commit f7b27a0. Bugbot is set up for automated code reviews on this repo. Configure here.