middleware

Documentation

Overview

package middleare contains all the middleware function to use in the API.

package middleare contains all the middleware function to use in the API.

package middleare contains all the middleware function to use in the API.

Index

• func ErrorHandler(ctx *fiber.Ctx, err error) error
• func ExtractEmitterAddr(c *fiber.Ctx, l *zap.Logger) (*vaa.Address, error)
• func ExtractEmitterChainID(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, error)
• func ExtractGuardianAddress(c *fiber.Ctx, l *zap.Logger) (string, error)
• func ExtractObservationHash(c *fiber.Ctx, l *zap.Logger) (string, error)
• func ExtractObservationSigner(c *fiber.Ctx, l *zap.Logger) (*vaa.Address, error)
• func ExtractPagination(ctx *fiber.Ctx) (*pagination.Pagination, error)
• func ExtractSequence(c *fiber.Ctx, l *zap.Logger) (uint64, error)
• func ExtractTargetChainID(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, error)
• func ExtractTransactionId(c *fiber.Ctx, l *zap.Logger) (string, error)
• func ExtractVAAChainIDEmitter(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, error)
• func ExtractVAAEmitterAndTargetChainId(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, vaa.ChainID, error)
• func ExtractVAAParams(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, vaa.ChainID, uint64, error)

Functions

func ErrorHandler

func ErrorHandler(ctx *fiber.Ctx, err error) error

ErrorHandler define a fiber custom error handler. This function process all errors returned from any handlers in the stack.

To setup this function we must set the ErrorHandler field of the fiber.Config struct with this function and create a new fiber with this config.

example: fiber.New(fiber.Config{ErrorHandler: errs.APIErrorHandler}

func ExtractEmitterAddr

func ExtractEmitterAddr(c *fiber.Ctx, l *zap.Logger) (*vaa.Address, error)

ExtractEmitterAddr get emitter parameter from route path.

func ExtractEmitterChainID

func ExtractEmitterChainID(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, error)

ExtractEmitterChainID get chain parameter from route path.

func ExtractGuardianAddress

func ExtractGuardianAddress(c *fiber.Ctx, l *zap.Logger) (string, error)

ExtractGuardianAddress get guardian address from route path.

func ExtractObservationHash

func ExtractObservationHash(c *fiber.Ctx, l *zap.Logger) (string, error)

ExtractObservationHash get a hash from route path.

func ExtractObservationSigner

func ExtractObservationSigner(c *fiber.Ctx, l *zap.Logger) (*vaa.Address, error)

ExtractObservationSigner get signer from route path.

func ExtractPagination

func ExtractPagination(ctx *fiber.Ctx) (*pagination.Pagination, error)

func ExtractSequence

func ExtractSequence(c *fiber.Ctx, l *zap.Logger) (uint64, error)

ExtractSequence get sequence parameter from route path.

func ExtractTargetChainID

func ExtractTargetChainID(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, error)

ExtractTargetChainID get chain parameter from route path.

func ExtractTransactionId

func ExtractTransactionId(c *fiber.Ctx, l *zap.Logger) (string, error)

func ExtractVAAChainIDEmitter

func ExtractVAAChainIDEmitter(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, error)

ExtractVAAParams get VAA chain, address from route path.

func ExtractVAAEmitterAndTargetChainId

func ExtractVAAEmitterAndTargetChainId(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, vaa.ChainID, error)

func ExtractVAAParams

func ExtractVAAParams(c *fiber.Ctx, l *zap.Logger) (vaa.ChainID, *vaa.Address, vaa.ChainID, uint64, error)

ExtractVAAParams get VAAA chain, address and sequence from route path.