QuipNetwork/quip-miner:README 来源编辑指南
基于 README、仓库元数据和许可证整理 QuipNetwork/quip-miner 的安装与核验路径。
项目定位
QuipNetwork/quip-miner 的 README 将项目描述为"The quip network mining stack. This includes a coordinator and links all of the official quip network miners."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"quip-miner"下的说明是:> Experimental software. Use at your own risk. No production warranties.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"Installation"和相关条目看,读者可以先判断它是否解决自己的具体问题:dwave-ocean-sdk>=9.0.0, =1.24.0 , Ising sampling。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:substrate-interface>=1.7.4, scalecodec>=1.2 , chain RPC + SCALE。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"quip-miner"等段落中。可确认的线索包括:This is the v0.2 line of the repository (formerly quip-protocol). In v0.1 this codebase shipped its own consensus, P2P (QUIC), block store, REST API, and SPHINCS+ block signer.。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: python3 -m venv .quip source .quip/bin/activate pip install -U pip setuptools wheel pip install -e . 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"Architecture"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"Architecture"段落提到:| module | role | |--------|------| | signer.py | Abstract Signer + Sr25519Signer. Phase 7 adds HybridSigner (sr25519 + ML-DSA-44). | | keystore.py | sr25519 keystore (0o600 JSON; plaintext seed for dev).。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:--node-url ws://... (required) , substrate WS endpoint。
README 能确认的限制
README 能确认的限制比宣传页面更重要。当前来源没有证明QuipNetwork/quip-miner具备固定的兼容矩阵、服务等级、性能基准或长期支持承诺。README 只明确写到"| file | role | |------|------| | quipcli.py | quip-miner CLI dispatch (keygen / bootstrap / cpu / gpu / qpu). |"。这类未知项应在选型记录里列为待验证事项,而不是被改写成肯定句。