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 channel, or open a GitHub issue!
Please note, we are not currently providing hands-on support for new integrations.
🌐 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.
📚 Block SDK Documentation
To read more about how the Block SDK works, check out the How it Works.
🏪 Lane App Store
To read more about Skip's pre-built lanes and how to use them, check out the Lane App Store.
🎨 Lane Development
To read more about how to build your own custom lanes, check out the Build Your Own Lane.
Audits
The Block SDK has undergone audits by the following firms:
- OtterSec (Sept 9th, 2023): Post audit code released as [v1.2.0](https://github.com/skip-mev/block-sdk/releases/tag/v1.2.0 and v2.0.0 for the
v1.x.xandv2.x.xrelease families, respectively.
Directories
¶
| Path | Synopsis |
|---|---|
|
adapters
|
|
|
api
|
|
|
sdk/auction/module/v1
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
sdk/auction/v1
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
service/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
lanes
|
|
|
tests
|
|
|
keeper
Package keeper provides methods to initialize SDK keepers with local storage for test purposes
|
Package keeper provides methods to initialize SDK keepers with local storage for test purposes |
|
networksuite
Package networksuite provides a base test suite for tests that need a local network instance
|
Package networksuite provides a base test suite for tests that need a local network instance |
|
x
|
|
|
auction/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |