Repository navigation
docs,fix: overhaul README and docs for Python 3.11-3.13, prune deps, and harden config/runtime defaults - #67
Open
TrezorHannes wants to merge 1 commit into
Open
TrezorHannes wants to merge 1 commit into
TrezorHannes wants to merge 1 commit into
Conversation
…and harden config/runtime defaults
🛡️⚡ TunnelSentinel Code ReviewVerdict: Latest commit: Executive Summary
Verification & Edge-Case Analysis
Review history
|
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
Overhauls
README.md, secondary documentation, configuration templates, dependency hygiene, and fresh-clone runtime safety across the repository:README.mdOverhaul (Python3.11/3.12/3.13):3.11 | 3.12 | 3.13.lncli addinvoiceinMagma/magma_sale_process.py,0_fee.txtcharge-lndexport inLNDg/channel_fee-pull.py, PostgreSQL CLI summary inLNDg/offline_summary.py, non-broadcasting command builder inOther/lnd_utxo_consolidator.py).Magma/magma_sale.md,Other/fee_adjuster.md,Other/swap_out-loop.md,Peerswap/README.md) and automatedsystemdtimer installer scripts (Other/install_fee_adjuster_service.sh,LNBits/install_pocketmoney_service.sh).config.ini.example,Magma/magma_config.ini.example,feeConfig.json.example,wallets.json.example) andrequirements-dev.txttest/coverage commands.requirements.txtPruning:configparser==7.3.0(configparseris part of the Python 3 standard library).telebot>=0.0.5(pyTelegramBotAPI>=4.37.1already providesimport telebot; PyPItelebotis an unused third-party router package).Configuration & URL Normalization Fixes (
config.ini.example,LNBits/pocketmoney.py,Other/fee_adjuster.py,LNDg/amboss_pull.py):/api/v1/api/v1URL bug inconfig.ini.example(base_url = https://yourdomain.com) and addsnormalize_lnbits_base_url()+ fail-closedvalidate_runtime_config()inLNBits/pocketmoney.py.charge_lnd_pathunder[paths](with~expansion and fallback infee_adjuster.pyandamboss_pull.py) and optional[database]settings forLNDg/offline_summary.py.Magma/magma_config.initoMagma/magma_config.ini.example+.gitignoreentry so local Magma offer edits do not dirtygit statusor conflict ongit pull.Fresh-Clone Directory Safety & Import Hygiene:
logs/,data/, andcharge-lndoutput directories are created viaos.makedirs(..., exist_ok=True)acrossLNBits/pocketmoney.py,Other/fee_adjuster.py,Other/rebalance_guard.py,LNDg/*, andPeerswap/*.get_lbtc_balance()subprocess call on import inPeerswap/ps_peers.py.Secondary Docs & Policy Deduplication:
.github/SECURITY.mdsymlink/duplicate (retaining canonical rootSECURITY.md).Magma/magma_sale.MDtoMagma/magma_sale.mdand updatesvenv,requirements.txt, and/processmagmaordersinstructions..agents/agents.md,Other/fee_adjuster.md, andPeerswap/README.mdwith current modules, config paths, and test suite.Verification & Code Review Gate
pytest tests/ -v --cov=LNDg --cov=Magma --cov=Other --cov=Peerswap --cov=LNBits:147 passed(coverage increased from28%to30%, with new regression coverage intests/test_repo_hygiene.py).not_connected); code review runs viaTunnelSentinel(/provide-codereview) and self-review.