forked from stratum-mining/stratum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix spacing with emoji add missing#, uppercase SV2
attempt to fix getting started link
- Loading branch information
Showing
1 changed file
with
36 additions
and
36 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,26 +21,26 @@ Stratum V2 Reference Implementation (SRI) | |
| ## 💼 Table of Contents | ||
|
|
||
| <p align="center"> | ||
| <a href="#introduction">Introduction</a> • | ||
| <a href="#getting-started">Getting Started</a> • | ||
| <a href="#use-cases">Use Cases</a> • | ||
| <a href="#roadmap">Roadmap</a> • | ||
| <a href="#contribute">Contribute</a> • | ||
| <a href="#support">Support</a> • | ||
| <a href="#donate">Donate</a> • | ||
| <a href="#supporters">Supporters</a> • | ||
| <a href="#license">License</a> | ||
| <a href="msrv">MSRV</a> | ||
| <a href="#-introduction">Introduction</a> • | ||
| <a href="#%EF%B8%8F-getting-started">Getting Started</a> • | ||
| <a href="#-use-cases">Use Cases</a> • | ||
| <a href="#-roadmap">Roadmap</a> • | ||
| <a href="#-contribute">Contribute</a> • | ||
| <a href="#-support">Support</a> • | ||
| <a href="#-donate">Donate</a> • | ||
| <a href="#-supporters">Supporters</a> • | ||
| <a href="#-license">License</a> | ||
| <a href="#-msrv">MSRV</a> | ||
| </p> | ||
|
|
||
| ## 👋Introduction | ||
| ## 👋 Introduction | ||
|
|
||
| Welcome to the official GitHub repository for the **SRI - Stratum V2 Reference Implementation**. | ||
|
|
||
| [Stratum V2](https://stratumprotocol.org) is a next-generation bitcoin mining protocol designed to enhance the efficiency, security, flexibility and decentralization. | ||
| SRI is fully open-source, community-developed, independent of any single entity, aiming to be fully compatible with [Stratum V2 Specification](https://github.com/stratum-mining/sv2-spec). | ||
|
|
||
| ## ⛏️Getting Started | ||
| ## ⛏️ Getting Started | ||
|
|
||
| To get started with the Stratum V2 Reference Implementation (SRI), please follow the detailed setup instructions available on the official website: | ||
|
|
||
|
|
@@ -52,77 +52,77 @@ This guide provides all the necessary information on prerequisites, installation | |
|
|
||
| The library is modular to address different use-cases and desired functionality. Examples include: | ||
|
|
||
| ### 👷Miners | ||
| ### 👷 Miners | ||
|
|
||
| - Sv1 Miners can use the translator proxy (`roles/translator`) to connect with a Sv2-compatible pool. | ||
| - Sv1 mining farms mining to a Sv2-compatible pool gain some of the security and efficiency improvements Sv2 offers over Stratum V1 (Sv1). The Sv1<->Sv2 translator proxy does not support _all_ the features of Sv2, but works as a temporary measure before upgrading completely to Sv2-compatible firmware. (The Sv1<->Sv2 translation proxy implementation is a work in progress.) | ||
| - SV1 Miners can use the translator proxy (`roles/translator`) to connect with a SV2-compatible pool. | ||
| - SV1 mining farms mining to a SV2-compatible pool gain some of the security and efficiency improvements SV2 offers over Stratum V1 (SV1). The SV1<->SV2 translator proxy does not support _all_ the features of SV2, but works as a temporary measure before upgrading completely to SV2-compatible firmware. (The SV1<->SV2 translation proxy implementation is a work in progress.) | ||
|
|
||
| ### 🛠️Pools | ||
| ### 🛠️ Pools | ||
|
|
||
| - Pools supporting Sv2 can deploy the open source binary crate (`roles/pool`) to offer their clients (miners participating in said pool) an Sv2-compatible pool. | ||
| - The Rust helper library provides a suite of tools for mining pools to build custom Sv2 compatible pool implementations. | ||
| - The C library provides a set of FFI bindings to the Rust helper library for miners to integrate Sv2 into their existing firmware stack. | ||
| - Pools supporting SV2 can deploy the open source binary crate (`roles/pool`) to offer their clients (miners participating in said pool) an SV2-compatible pool. | ||
| - The Rust helper library provides a suite of tools for mining pools to build custom SV2 compatible pool implementations. | ||
| - The C library provides a set of FFI bindings to the Rust helper library for miners to integrate SV2 into their existing firmware stack. | ||
|
|
||
| ## 🛣Roadmap | ||
| ## 🛣 Roadmap | ||
|
|
||
| Our roadmap is publicly available, outlining current and future plans. Decisions on the roadmap are made through a consensus-driven approach, through participation on dev meetings, Discord or GitHub. | ||
|
|
||
| [View the SRI Roadmap](https://github.com/orgs/stratum-mining/projects/5) | ||
|
|
||
| ### 🎯Goals | ||
| ### 🎯 Goals | ||
|
|
||
| The goals of this project are to provide: | ||
|
|
||
| 1. A robust set of Stratum V2 (Sv2) primitives as Rust library crates which anyone can use | ||
| 1. A robust set of Stratum V2 (SV2) primitives as Rust library crates which anyone can use | ||
| to expand the protocol or implement a role. For example: | ||
| - Pools supporting Sv2 | ||
| - Mining-device/hashrate producers integrating Sv2 into their firmware | ||
| - Pools supporting SV2 | ||
| - Mining-device/hashrate producers integrating SV2 into their firmware | ||
| - Bitcoin nodes implementing Template Provider to build the `blocktemplate` | ||
| 2. The above Rust primitives as a C library available for use in other languages via FFI. | ||
| 3. A set of helpers built on top of the above primitives and the external Bitcoin-related Rust crates for anyone to implement the Sv2 roles. | ||
| 4. An open-source implementation of a Sv2 proxy for miners. | ||
| 5. An open-source implementation of a Sv2 pool for mining pool operators. | ||
| 3. A set of helpers built on top of the above primitives and the external Bitcoin-related Rust crates for anyone to implement the SV2 roles. | ||
| 4. An open-source implementation of a SV2 proxy for miners. | ||
| 5. An open-source implementation of a SV2 pool for mining pool operators. | ||
|
|
||
| ## 💻Contribute | ||
| ## 💻 Contribute | ||
|
|
||
| If you are a developer looking to help, but you're not sure where to begin, check the [good first issue label](https://github.com/stratum-mining/stratum/labels/good%20first%20issue), which contains small pieces of work that have been specifically flagged as being friendly to new contributors. | ||
|
|
||
| Contributors looking to do something a bit more challenging, before opening a pull request, please join [our community chat](ttps://discord.gg/fsEW23wFYs) or [start a GitHub issue](https://github.com/stratum-mining/stratum/issues) to get early feedback, discuss the best ways to tackle the problem, and ensure there is no work duplication and consensus. | ||
|
|
||
| ## 🤝Support | ||
| ## 🤝 Support | ||
|
|
||
| Join our Discord community to get help, share your ideas, or discuss anything related to Stratum V2 and its refference implementation. | ||
|
|
||
| Whether you're looking for technical support, want to contribute, or are just interested in learning more about the project, our community is the place to be. | ||
|
|
||
| [Join the Stratum V2 Discord Community](https://discord.gg/fsEW23wFYs) | ||
|
|
||
| ## 🎁Donate | ||
| ## 🎁 Donate | ||
|
|
||
| ### 👤Individual Donations | ||
| ### 👤 Individual Donations | ||
| If you wish to support the development and maintenance of the Stratum V2 Reference Implementation, individual donations are greatly appreciated. You can donate through OpenSats, a 501(c)(3) public charity dedicated to supporting open-source Bitcoin projects. | ||
|
|
||
| [Donate through OpenSats](https://opensats.org/projects/stratumv2) | ||
|
|
||
| ### 🏢Corporate Donations | ||
| ### 🏢 Corporate Donations | ||
| For corporate entities interested in providing more substantial support, such as grants to SRI contributors, please get in touch with us directly. Your support can make a significant difference in accelerating development, research, and innovation. | ||
|
|
||
| Email us at: [email protected] | ||
|
|
||
| ## 🙏Supporters | ||
| ## 🙏 Supporters | ||
|
|
||
| SRI contributors are independently, financually supported by following entities: | ||
| SRI contributors are independently, financially supported by following entities: | ||
|
|
||
| <p float="left"> | ||
| <a href="https://hrf.org"><img src="https://raw.githubusercontent.com/stratum-mining/stratumprotocol.org/main/src/.vuepress/public/assets/hrf-logo-boxed.svg" width="250" /></a> | ||
| <a href="https://spiral.xyz"><img src="https://raw.githubusercontent.com/stratum-mining/stratumprotocol.org/main/src/.vuepress/public/assets/Spiral-logo-boxed.svg" width="250" /></a> | ||
| <a href="https://opensats.org/"><img src="https://raw.githubusercontent.com/stratum-mining/stratumprotocol.org/main/src/.vuepress/public/assets/opensats-logo-boxed.svg" width="250" /></a> | ||
| </p> | ||
|
|
||
| ## 📖License | ||
| ## 📖 License | ||
| This software is licensed under Apache 2.0 or MIT, at your option. | ||
|
|
||
| ## 🦀MSRV | ||
| ## 🦀 MSRV | ||
| Minimum Supported Rust Version: 1.75.0 | ||
|
|
||
| --- | ||
|
|
||