refactoring: deduplicate wallet, rate source, and API handler logic by olegsta · Pull Request #237 · vsys-host/shkeeper.io

olegsta · 2026-06-25T08:39:10Z

Extract shared UTXO HTTP wallet logic into UtxoHttpWallet for BTC, LTC, and DOGE
Consolidate EVM chain classes (ETH, Polygon, Arbitrum, Optimism, BNB, Avalanche, Solana, TON, XRP) into configurable Ethereum base with chain-specific attributes and hooks
Simplify Binance, Coinbase, Kraken, and KuCoin rate providers to use shared normalization
Add api/helpers.py with resolve_available_crypto(), api_error_response(), verify_backend_key(), and handle_request_error()
Refactor api_v1 endpoints to use shared helpers and remove duplicated error/backend-key handling

- Extract shared UTXO HTTP wallet logic into UtxoHttpWallet for BTC, LTC, and DOGE - Consolidate EVM chain classes (ETH, Polygon, Arbitrum, Optimism, BNB, Avalanche, Solana, TON, XRP) into configurable Ethereum base with chain-specific attributes and hooks - Move rate symbol normalization into RateSource.normalize_symbols(), including MATIC→POL and optional TON→GRAM mappings - Simplify Binance, Coinbase, Kraken, and KuCoin rate providers to use shared normalization - Add api/helpers.py with resolve_available_crypto(), api_error_response(), verify_backend_key(), and handle_request_error() - Refactor api_v1 endpoints to use shared helpers and remove duplicated error/backend-key handling - Register inject_theme once at app level in create_app() instead of duplicating it in auth and wallet blueprints

dmytro-samoylenko · 2026-07-07T12:40:41Z

+        if error := verify_backend_key():
+            return error

+        Crypto.instances[crypto_name]


I removed the variable because it was unused. Here we only need to validate that crypto_name exists in Crypto.instances; direct access Crypto.instances[crypto_name] is enough and keeps the intent explicit (raise Exception).

dmytro-samoylenko · 2026-07-07T12:52:18Z

        try:
-            crypto = Crypto.instances[crypto_name]
-            bkey = environ.get(f"SHKEEPER_BTC_BACKEND_KEY", "shkeeper")
+            Crypto.instances[crypto_name]


I removed the variable because it was unused. Here we only need to validate that crypto_name exists in Crypto.instances; direct access Crypto.instances[crypto_name] is enough and keeps the intent explicit (raise KeyError if missing).

dmytro-samoylenko · 2026-07-07T12:54:27Z

-            bkey = environ.get(f"SHKEEPER_BTC_BACKEND_KEY", "shkeeper")
+            Crypto.instances[crypto_name]
+            bkey = environ.get("SHKEEPER_BTC_BACKEND_KEY", "shkeeper")
            if request.headers["X-Shkeeper-Backend-Key"] != bkey:


why not use verify_backend_key() ?

Changed to verify_backend_key

Copilot

Pull request overview

Refactors the wallet, rate-source, and API layers to centralize repeated logic and make chain/provider-specific behavior configurable via shared base classes and helpers.

Changes:

Introduces UtxoHttpWallet for BTC/LTC/DOGE and refactors those coin classes to inherit from it.
Consolidates multiple chain classes into the Ethereum base by moving host/creds/status/payout logic into overridable hooks + chain-specific attributes.
Centralizes rate-symbol normalization in RateSource and API error/backend-key handling in shkeeper/api/helpers.py, then refactors api_v1 endpoints to use them.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
shkeeper/wallet.py	Removes blueprint-level theme injection (now app-level).
shkeeper/auth.py	Removes blueprint-level theme injection (now app-level).
shkeeper/init.py	Adds app-wide `inject_theme()` context processor.
shkeeper/api/helpers.py	Adds shared API helpers (crypto resolution, backend key, error wrapping).
shkeeper/api_v1.py	Refactors endpoints to use shared API helpers.
shkeeper/modules/classes/utxo_http_wallet.py	Adds shared HTTP wallet implementation for UTXO coins.
shkeeper/modules/classes/btc.py	Switches BTC to `UtxoHttpWallet` and enables tx logging.
shkeeper/modules/classes/ltc.py	Switches LTC to `UtxoHttpWallet`.
shkeeper/modules/classes/doge.py	Switches DOGE to `UtxoHttpWallet`.
shkeeper/modules/classes/ethereum.py	Adds configurable env prefixes/host + hook points for status/payout logic.
shkeeper/modules/classes/arbitrum.py	Converts Arbitrum to Ethereum-configured subclass.
shkeeper/modules/classes/avalanche.py	Converts Avalanche to Ethereum-configured subclass.
shkeeper/modules/classes/bnb.py	Converts BNB to Ethereum-configured subclass.
shkeeper/modules/classes/optimism.py	Converts Optimism to Ethereum-configured subclass with distinct creds prefix.
shkeeper/modules/classes/polygon.py	Converts Polygon to Ethereum-configured subclass.
shkeeper/modules/classes/solana.py	Converts Solana to Ethereum-configured subclass with status tuning.
shkeeper/modules/classes/ton.py	Converts TON to Ethereum-configured subclass with float block interval + lag multiplier.
shkeeper/modules/classes/xrp.py	Converts XRP to Ethereum-configured subclass with timestamp/fee hooks.
shkeeper/modules/classes/rate_source.py	Adds shared symbol normalization + USDT/USD parity handling.
shkeeper/modules/rates/binance.py	Uses shared normalization helper.
shkeeper/modules/rates/coinbase.py	Uses shared normalization helper.
shkeeper/modules/rates/kraken.py	Uses shared normalization helper (including parity shortcut).
shkeeper/modules/rates/kucoin.py	Uses shared normalization helper with KuCoin-specific options.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

olegsta · 2026-07-08T08:26:56Z

+    def _subtract_payout_fee(self, amount, fee):
+        # 10 XRP need to keep the fee-deposit account active
+        return amount - fee - 10


I fixed it, but that logic was already in the master branch

olegsta · 2026-07-08T08:48:40Z

+            block_interval = self.block_interval
+            if delta < block_interval * self.sync_lag_multiplier:
                return "Synced"
            else:
                return "Sync In Progress (%d blocks behind)" % (delta // block_interval)


The logic is the same as in master. This MR only refactors the code without changing its behavior

Copilot

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.

- Change log text - Change subtractpayout fee logic

olegsta changed the title ~~refactor: deduplicate wallet, rate source, and API handler logic~~ refactoring: deduplicate wallet, rate source, and API handler logic Jun 25, 2026

dmytro-samoylenko reviewed Jul 7, 2026

View reviewed changes

dmytro-samoylenko requested a review from Copilot July 7, 2026 13:17

Copilot started reviewing on behalf of dmytro-samoylenko July 7, 2026 13:17 View session

Copilot AI reviewed Jul 7, 2026

View reviewed changes

olegsta force-pushed the features/refact_code branch from 3026528 to 5d55a0b Compare July 8, 2026 09:51

olegsta requested a review from Copilot July 8, 2026 09:52

Copilot started reviewing on behalf of olegsta July 8, 2026 09:53 View session

Copilot AI reviewed Jul 8, 2026

View reviewed changes

Comment thread shkeeper/api_v1.py

Comment thread shkeeper/api_v1.py Outdated

fix(copilot): fix reviews comments

b3db839

- Change log text - Change subtractpayout fee logic

olegsta force-pushed the features/refact_code branch from 5d55a0b to b3db839 Compare July 8, 2026 10:46

olegsta requested a review from Copilot July 8, 2026 10:56

Copilot started reviewing on behalf of olegsta July 8, 2026 10:56 View session

This comment was marked as resolved.

Sign in to view

Uh oh!

Conversation

olegsta commented Jun 25, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants