free

README

🏗️ Free Lane Setup

📦 Dependencies

The Block SDK is built on top of the Cosmos SDK. The Block SDK is currently compatible with Cosmos SDK versions greater than or equal to v0.47.0.

📥 Installation

To install the Block SDK, run the following command:

$ go install github.com/skip-mev/block-sdk

📚 Usage

Note: Please visit app.go to see a sample base app set up.

1. First determine the set of lanes that you want to use in your application. The available lanes can be found in our Lane App Store. In your base application, you will need to create a LanedMempool composed of the lanes you want to use. The free lane should not exist on its own. At minimum, it is recommended that the free lane is paired with the default lane.
2. Next, order the lanes by priority. The first lane is the highest priority lane and the last lane is the lowest priority lane.
3. Set up your FeeDeductorDecorator to ignore the free lane where ever you initialize your AnteHandler. This will ensure that the free lane is not subject to deducting transaction fees.
4. You will also need to create a PrepareProposalHandler and a ProcessProposalHandler that will be responsible for preparing and processing proposals respectively. Configure the order of the lanes in the PrepareProposalHandler and ProcessProposalHandler to match the order of the lanes in the LanedMempool.

NOTE: This example walks through setting up the Free and Default lanes.

import (
    "github.com/skip-mev/block-sdk/abci"
    "github.com/skip-mev/block-sdk/block/base"
    defaultlane "github.com/skip-mev/block-sdk/lanes/base"
    freelane "github.com/skip-mev/block-sdk/lanes/free"
)

...

func NewApp() {
    ...
    // 1. Create the lanes.
    //
    // NOTE: The lanes are ordered by priority. The first lane is the highest priority
    // lane and the last lane is the lowest priority lane.
    //
    // For more information on how to utilize the LaneConfig please
    // visit the README in docs.skip.money/chains/lanes/build-your-own-lane#-lane-config.
    //
    // Set up the configuration of the free lane and instantiate it.
    freeConfig := base.LaneConfig{
        Logger:        app.Logger(),
        TxEncoder:     app.txConfig.TxEncoder(),
        TxDecoder:     app.txConfig.TxDecoder(),
        MaxBlockSpace: math.LegacyZeroDec(),
        MaxTxs:        0,
    }
    freeLane := freelane.NewFreeLane(freeConfig, base.DefaultTxPriority(), freelane.DefaultMatchHandler())
    
    // Default lane accepts all transactions.
    defaultConfig := base.LaneConfig{
        Logger:        app.Logger(),
        TxEncoder:     app.txConfig.TxEncoder(),
        TxDecoder:     app.txConfig.TxDecoder(),
        MaxBlockSpace: math.LegacyZeroDec(),
        MaxTxs:        0,
    }
    defaultLane := defaultlane.NewDefaultLane(defaultConfig, base.DefaultMatchHandler())

    // 2. Set up the relative priority of lanes
    lanes := []block.Lane{
        freeLane,
        defaultLane,
    }
    mempool := block.NewLanedMempool(app.Logger(), lanes)
    app.App.SetMempool(mempool)

    ...

    // 3. Set up the ante handler.
    //
    // This will allow any transaction that matches the to the free lane to 
    // be processed without paying any fees.
    anteDecorators := []sdk.AnteDecorator{
		ante.NewSetUpContextDecorator(),
        ...
		utils.NewIgnoreDecorator(
			ante.NewDeductFeeDecorator(
				options.BaseOptions.AccountKeeper,
				options.BaseOptions.BankKeeper,
				options.BaseOptions.FeegrantKeeper,
				options.BaseOptions.TxFeeChecker,
			),
			options.FreeLane,
		),
        ...
	}

    anteHandler := sdk.ChainAnteDecorators(anteDecorators...)

    // Set the lane ante handlers on the lanes.
    //
    // NOTE: This step is very important. Without the antehandlers, lanes will not
    // be able to verify transactions.
    for _, lane := range lanes {
        lane.SetAnteHandler(anteHandler)
    }
    app.App.SetAnteHandler(anteHandler)

    // 4. Set the abci handlers on base app
    proposalHandler := abci.NewProposalHandler(
        app.Logger(),
        app.TxConfig().TxDecoder(),
        mempool,
    )
    app.App.SetPrepareProposal(proposalHandler.PrepareProposalHandler())
    app.App.SetProcessProposal(proposalHandler.ProcessProposalHandler())

    ...
}

Documentation

Index

• Constants
• func DefaultMatchHandler() base.MatchHandler
• func NewFreeLane[C comparable](cfg base.LaneConfig, txPriority base.TxPriority[C], matchFn base.MatchHandler) *base.BaseLane

Constants

const (
	// LaneName defines the name of the free lane.
	LaneName = "free"
)

Functions

func DefaultMatchHandler

func DefaultMatchHandler() base.MatchHandler

DefaultMatchHandler returns the default match handler for the free lane. The default implementation matches transactions that are staking related. In particular, any transaction that is a MsgDelegate, MsgBeginRedelegate, or MsgCancelUnbondingDelegation.

func NewFreeLane

func NewFreeLane[C comparable](
	cfg base.LaneConfig,
	txPriority base.TxPriority[C],
	matchFn base.MatchHandler,
) *base.BaseLane

NewFreeLane returns a new free lane.