|
1 | | -<h1 align="center">Block SDK π§±</h1> |
| 1 | +# β οΈ Block SDK - No Longer Maintained β οΈ |
2 | 2 |
|
3 | | -<!-- markdownlint-disable MD013 --> |
4 | | -<!-- markdownlint-disable MD041 --> |
| 3 | +π¨ **This project is no longer being maintained and will not be supported by current integrators.** If you wish to use this project, we strongly recommend forking and maintaining the code for any dependency or feature improvements you require. π¨ |
5 | 4 |
|
6 | | -<div align="center"> |
7 | | - <a> |
8 | | - <img alt="Logo" src="img/block-sdk.png" width="600"> |
9 | | - </a> |
10 | | -</div> |
| 5 | +--- |
11 | 6 |
|
12 | | -<div align="center"> |
13 | | - <a> |
14 | | - <img alt="Repo Status" src="https://www.repostatus.org/badges/latest/active.svg" /> |
15 | | - </a> |
16 | | - <a> |
17 | | - <img alt="License" src="https://img.shields.io/github/license/skip-mev/block-sdk.svg?style=flat-square" /> |
18 | | - </a> |
19 | | - <a> |
20 | | - <img alt="License" src="https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go" /> |
21 | | - </a> |
22 | | -</div> |
23 | | - |
24 | | -**Please note the status of BlockSDK maintenance:** |
25 | | - |
26 | | -1. This project is no longer being maintained and will not be supported by current integrators. If you wish to use this project, we recommend forking and maintaining the code for any dependency or feature improvements you desire. |
27 | | - |
28 | | -### π€Β What is the Block SDK? |
29 | | - |
30 | | -**π The Block SDK is a toolkit for building customized blocks**. The Block SDK is a set of Cosmos SDK and ABCI++ primitives that allow chains to fully customize blocks to specific use cases. It turns your chain's blocks into a **`highway`** consisting of individual **`lanes`** with their own special functionality. |
| 7 | +## π€ What is the Block SDK? |
31 | 8 |
|
| 9 | +**π The Block SDK is a toolkit for building customized blocks.** The Block SDK is a set of Cosmos SDK and ABCI++ primitives that allow chains to fully customize blocks to specific use cases. It turns your chain's blocks into a **`highway`** consisting of individual **`lanes`** with their own special functionality. |
32 | 10 |
|
33 | 11 | Skip has built out a number of plug-and-play `lanes` on the SDK that your protocol can use, including in-protocol MEV recapture and Oracles! Additionally, the Block SDK can be extended to add **your own custom `lanes`** to configure your blocks to exactly fit your application needs. |
34 | 12 |
|
35 | | -### Release Compatibility Matrix |
| 13 | +## Release Compatibility Matrix |
36 | 14 |
|
37 | 15 | | Block SDK Version | Cosmos SDK | |
38 | 16 | | :---------: | :--------: | |
39 | 17 | | `v1.x.x` | `v0.47.x` | |
40 | 18 | | `v2.x.x` | `v0.50.x` | |
41 | 19 |
|
42 | | - |
43 | | -### π Block SDK Documentation |
| 20 | +## π Block SDK Documentation |
44 | 21 |
|
45 | 22 | To read more about how the Block SDK works, check out the [How it Works](https://docs.skip.money/blocksdk/overview). |
46 | 23 |
|
47 | | -#### πͺ Lane App Store |
| 24 | +### πͺ Lane App Store |
48 | 25 |
|
49 | 26 | To read more about Skip's pre-built `lanes` and how to use them, check out the [Lane App Store](https://docs.skip.money/blocksdk/lanes/existing-lanes/mev). |
50 | 27 |
|
51 | | -#### π¨ Lane Development |
| 28 | +### π¨ Lane Development |
52 | 29 |
|
53 | 30 | To read more about how to build your own custom `lanes`, check out the [Build Your Own Lane](https://docs.skip.money/blocksdk/lanes/build-your-own-lane). |
54 | 31 |
|
55 | | -### Audits |
| 32 | +## Audits |
56 | 33 |
|
57 | 34 | The Block SDK has undergone audits by the following firms: |
58 | 35 |
|
|
0 commit comments