Skip to content

Polish Python cryptocurrency onboarding, documentation and security defaults - #1

Closed
saloscoin wants to merge 2 commits into
mainfrom
docs/discoverability-security
Closed

saloscoin wants to merge 2 commits into
mainfrom
docs/discoverability-security

Conversation

@saloscoin

@saloscoin saloscoin commented Oct 11, 2026 •

Copy link
Copy Markdown
Owner

Summary

README → platform setup → offline walkthrough → component/API guides
                         → independent coin/network customization
Contributors → issue/PR templates → core CI → manual Linux CLI build
Security → explicit wallet limitations + hardened RPC/exchange defaults

Present the MIT-licensed project as a Bitcoin-like Python cryptocurrency implementation with a usable first-run experience. Add Linux/macOS and Windows setup, a documentation index, troubleshooting and API/component guides, an offline example, changelog, issue/PR templates and documentation link checks. Rework CI around core dependencies and five platform/Python jobs; retain Linux CLI packaging as a separate manual workflow rather than coupling it to optional GPU/GUI installs. No automatic release, Ethereum compatibility, production audit or live-service claims.

Evidence

  • Before: README advertised enterprise readiness without evidence; onboarding installed optional GPU/GUI/server dependencies and provided no offline walkthrough. Wallet encryption only set flags while saving plaintext keys; unlock ignored passwords. Exchange RPC/REST bound publicly, used default credentials and printed the password.
    After: runnable temporary-wallet/signature/block-header example, platform setup and focused core CI. Encryption and legacy unlock fail explicitly; flagged wallet saves are blocked. Wallet saves use owner-only atomic replacement on POSIX; unsupported HD passphrase creation is rejected. RPC rejects partial/empty credentials and unauthenticated non-loopback binds, strictly decodes Basic headers and compares credentials in constant time. Exchange RPC/REST bind locally, require explicit credentials and omit password logging. RPC shutdown uses the matching serve_forever loop.
  • Fresh Python 3.12 environment: core dependencies installed successfully; pip check passed; 74 tests passed including security and offline/no-network behavior; example output matched the README; documentation file links, compilation, three CLI help commands, YAML parsing and whitespace checks passed.
  • All five GitHub-hosted CI jobs passed on this commit: Ubuntu/Python 3.10, 3.12 and 3.13; Windows/Python 3.12; macOS/Python 3.12. Optional GPU/GUI, public-network behavior and manual Linux packaging are not certified by these checks. Earlier suppressed audit/type-check commands are not represented as passing quality gates.

Merge Danger

Door: two-way

No consensus parameters or historical commits changed. Legacy wallet files are preserved. Intentional compatibility changes: encryption/unlock no longer pretend to work; new HD extra-passphrase creation is blocked; exchange credentials are mandatory and public RPC/REST bindings removed. Remote exchange access needs a restricted proxy/tunnel. CI now runs focused core checks; executable builds require manual dispatch, with mnemonic wordlist included in the daemon bundle.

Blast Radius: developers/operators

Wallet keys remain plaintext and REST unauthenticated. Genesis mismatch substitution, incomplete testnet isolation, dependency locking and optional-component deployment remain documented limitations. The new coin guide is an engineering checklist, not a verified one-command network generator. Founder privacy and existing attribution are preserved.

GitHub About/topics remain unchanged: the connector exposes no metadata-write tool and the available CLI account lacked access. Suggested metadata was provided in the chat deliverable.

@saloscoin saloscoin changed the title Improve Bitcoin-like Python project discoverability and harden security defaults Polish Python cryptocurrency onboarding, documentation and security defaults Oct 11, 2026
@saloscoin saloscoin closed this Oct 11, 2026
@saloscoin
saloscoin deleted the docs/discoverability-security branch October 11, 2026 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant