https://github.com/skip-mev/block-sdk

🎨 Programmable Block Builder for Cosmos Chains
https://github.com/skip-mev/block-sdk

Last synced: 4 days ago
JSON representation

🎨 Programmable Block Builder for Cosmos Chains

• Host: GitHub
• URL: https://github.com/skip-mev/block-sdk
• Owner: skip-mev
• License: apache-2.0
• Created: 2023-08-17T19:45:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-01T12:00:44.000Z (4 months ago)
• Last Synced: 2024-07-01T17:06:59.376Z (4 months ago)
• Language: Go
• Homepage: https://docs.skip.money/blocksdk/overview/
• Size: 3.64 MB
• Stars: 65
• Watchers: 3
• Forks: 18
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audits/ottersec_sept_9_2023.pdf
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-ccamel - skip-mev/block-sdk - 🎨 Programmable Block Builder for Cosmos Chains (Go)

README

        
Block SDK 🧱




  

      

  





  

    

  

  

    

  

    

    

  



### 🤔 What is the Block SDK?

> **Note**: The BlockSDK is open source software that Skip maintains. We strive to be responsive to questions and issues within 1-2 weeks - please ask in our [#block-sdk-support discord](https://discord.com/invite/hFeHVAE26P) channel, or open a GitHub issue!

**Please note the status of BlockSDK maintenance:**

1. We are not currently providing hands-on support for new integrations.

2. We have not yet completed our entire testing process for the FreeLane. We recommend integrators who want to have the best experience utilize the MEV Lane and the Default Lane only at this time.

3. Integrators are responsible for the design, testing, and correctness of custom lanes they build.

**🌐 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.

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.

### Release Compatibility Matrix

| Block SDK Version | Cosmos SDK |

| :---------: | :--------: |

|   `v1.x.x`    |  `v0.47.x`   |

|   `v2.x.x`    |  `v0.50.x`   |

### 📚 Block SDK Documentation

To read more about how the Block SDK works, check out the [How it Works](https://docs.skip.money/blocksdk/overview).

#### 🏪 Lane App Store

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).

#### 🎨 Lane Development

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).

### Audits 

The Block SDK has undergone audits by the following firms:

* [OtterSec (Sept 9th, 2023)](audits/ottersec_sept_9_2023.pdf): Post audit code released as [v1.2.0](https://github.com/skip-mev/block-sdk/releases/tag/v1.2.0) and [v2.0.0](https://github.com/skip-mev/block-sdk/releases/tag/v2.0.0) for the `v1.x.x` and `v2.x.x` release families, respectively.