113 lines
4.5 KiB
Go
113 lines
4.5 KiB
Go
package types
|
|
|
|
// AnteHandler authenticates transactions, before their internal messages are handled.
|
|
// If newCtx.IsZero(), ctx is used instead.
|
|
type AnteHandler func(ctx Context, tx Tx, simulate bool) (newCtx Context, err error)
|
|
|
|
// PostHandler like AnteHandler but it executes after RunMsgs. Runs on success
|
|
// or failure and enables use cases like gas refunding.
|
|
type PostHandler func(ctx Context, tx Tx, simulate, success bool) (newCtx Context, err error)
|
|
|
|
// AnteDecorator wraps the next AnteHandler to perform custom pre-processing.
|
|
type AnteDecorator interface {
|
|
AnteHandle(ctx Context, tx Tx, simulate bool, next AnteHandler) (newCtx Context, err error)
|
|
}
|
|
|
|
// PostDecorator wraps the next PostHandler to perform custom post-processing.
|
|
type PostDecorator interface {
|
|
PostHandle(ctx Context, tx Tx, simulate, success bool, next PostHandler) (newCtx Context, err error)
|
|
}
|
|
|
|
// ChainAnteDecorators chains AnteDecorators together with each AnteDecorator
|
|
// wrapping over the decorators further along chain and returns a single AnteHandler.
|
|
//
|
|
// NOTE: The first element is outermost decorator, while the last element is innermost
|
|
// decorator. Decorator ordering is critical since some decorators will expect
|
|
// certain checks and updates to be performed (e.g. the Context) before the decorator
|
|
// is run. These expectations should be documented clearly in a CONTRACT docline
|
|
// in the decorator's godoc.
|
|
//
|
|
// NOTE: Any application that uses GasMeter to limit transaction processing cost
|
|
// MUST set GasMeter with the FIRST AnteDecorator. Failing to do so will cause
|
|
// transactions to be processed with an infinite gasmeter and open a DOS attack vector.
|
|
// Use `ante.SetUpContextDecorator` or a custom Decorator with similar functionality.
|
|
// Returns nil when no AnteDecorator are supplied.
|
|
func ChainAnteDecorators(chain ...AnteDecorator) AnteHandler {
|
|
if len(chain) == 0 {
|
|
return nil
|
|
}
|
|
|
|
handlerChain := make([]AnteHandler, len(chain)+1)
|
|
// set the terminal AnteHandler decorator
|
|
handlerChain[len(chain)] = func(ctx Context, tx Tx, simulate bool) (Context, error) {
|
|
return ctx, nil
|
|
}
|
|
for i := range chain {
|
|
ii := i
|
|
handlerChain[ii] = func(ctx Context, tx Tx, simulate bool) (Context, error) {
|
|
return chain[ii].AnteHandle(ctx, tx, simulate, handlerChain[ii+1])
|
|
}
|
|
}
|
|
|
|
return handlerChain[0]
|
|
}
|
|
|
|
// ChainPostDecorators chains PostDecorators together with each PostDecorator
|
|
// wrapping over the decorators further along chain and returns a single PostHandler.
|
|
//
|
|
// NOTE: The first element is outermost decorator, while the last element is innermost
|
|
// decorator. Decorator ordering is critical since some decorators will expect
|
|
// certain checks and updates to be performed (e.g. the Context) before the decorator
|
|
// is run. These expectations should be documented clearly in a CONTRACT docline
|
|
// in the decorator's godoc.
|
|
func ChainPostDecorators(chain ...PostDecorator) PostHandler {
|
|
if len(chain) == 0 {
|
|
return nil
|
|
}
|
|
|
|
handlerChain := make([]PostHandler, len(chain)+1)
|
|
// set the terminal PostHandler decorator
|
|
handlerChain[len(chain)] = func(ctx Context, tx Tx, simulate, success bool) (Context, error) {
|
|
return ctx, nil
|
|
}
|
|
for i := range chain {
|
|
ii := i
|
|
handlerChain[ii] = func(ctx Context, tx Tx, simulate, success bool) (Context, error) {
|
|
return chain[ii].PostHandle(ctx, tx, simulate, success, handlerChain[ii+1])
|
|
}
|
|
}
|
|
return handlerChain[0]
|
|
}
|
|
|
|
// Terminator AnteDecorator will get added to the chain to simplify decorator code
|
|
// Don't need to check if next == nil further up the chain
|
|
//
|
|
// ______
|
|
// <((((((\\\
|
|
// / . }\
|
|
// ;--..--._|}
|
|
// (\ '--/\--' )
|
|
// \\ | '-' :'|
|
|
// \\ . -==- .-|
|
|
// \\ \.__.' \--._
|
|
// [\\ __.--| // _/'--.
|
|
// \ \\ .'-._ ('-----'/ __/ \
|
|
// \ \\ / __>| | '--. |
|
|
// \ \\ | \ | / / /
|
|
// \ '\ / \ | | _/ /
|
|
// \ \ \ | | / /
|
|
// snd \ \ \ /
|
|
//
|
|
// Deprecated: Terminator is retired (ref https://github.com/cosmos/cosmos-sdk/pull/16076).
|
|
type Terminator struct{}
|
|
|
|
// AnteHandle returns the provided Context and nil error
|
|
func (t Terminator) AnteHandle(ctx Context, _ Tx, _ bool, _ AnteHandler) (Context, error) {
|
|
return ctx, nil
|
|
}
|
|
|
|
// PostHandle returns the provided Context and nil error
|
|
func (t Terminator) PostHandle(ctx Context, _ Tx, _, _ bool, _ PostHandler) (Context, error) {
|
|
return ctx, nil
|
|
}
|