routes

Documentation

Index

• Constants
• Variables
• func ProvideMiddlewares(provider interface{}, additionalAnnotations ...fx.Annotation) fx.Option
• func ProvidePerLedgerMiddleware(provider interface{}, additionalAnnotations ...fx.Annotation) fx.Option
• type Routes
  • func NewRoutes(globalMiddlewares []gin.HandlerFunc, perLedgerMiddlewares []gin.HandlerFunc, ...) *Routes
  • func (r *Routes) Engine() *gin.Engine
• type UseScopes

Constants

const (
	ScopeTransactionsRead  = "transactions:read"
	ScopeTransactionsWrite = "transactions:write"
	ScopeAccountsRead      = "accounts:read"
	ScopeAccountsWrite     = "accounts:write"
	ScopeMappingRead       = "mapping:read"
	ScopeMappingWrite      = "mapping:write"
	ScopesInfoRead         = "info"
	ScopesStatsRead        = "stats"
	ScopesLogsRead         = "logs"
)

const GlobalMiddlewaresKey = `name:"_routesGlobalMiddlewares" optional:"true"`

const PerLedgerMiddlewaresKey = `name:"_perLedgerMiddlewares" optional:"true"`

Variables

var AllScopes = []string{
	ScopeTransactionsRead,
	ScopeAccountsWrite,
	ScopeTransactionsWrite,
	ScopeAccountsRead,
	ScopeMappingRead,
	ScopeMappingWrite,
	ScopesInfoRead,
	ScopesStatsRead,
	ScopesLogsRead,
}

var Module = fx.Options(
	fx.Provide(
		fx.Annotate(NewRoutes, fx.ParamTags(GlobalMiddlewaresKey, PerLedgerMiddlewaresKey)),
	),
)

Functions

func ProvideMiddlewares

func ProvideMiddlewares(provider interface{}, additionalAnnotations ...fx.Annotation) fx.Option

func ProvidePerLedgerMiddleware

func ProvidePerLedgerMiddleware(provider interface{}, additionalAnnotations ...fx.Annotation) fx.Option

Types

type Routes

type Routes struct {
	// contains filtered or unexported fields
}

func NewRoutes

func NewRoutes(
	globalMiddlewares []gin.HandlerFunc,
	perLedgerMiddlewares []gin.HandlerFunc,
	resolver *ledger.Resolver,
	ledgerMiddleware middlewares.LedgerMiddleware,
	configController controllers.ConfigController,
	ledgerController controllers.LedgerController,
	scriptController controllers.ScriptController,
	accountController controllers.AccountController,
	balanceController controllers.BalanceController,
	transactionController controllers.TransactionController,
	mappingController controllers.MappingController,
	healthController *health.HealthController,
	useScopes UseScopes,
	idempotencyStore storage.Driver[idempotency.Store],
	locker middlewares.Locker,
) *Routes

func (*Routes) Engine

func (r *Routes) Engine() *gin.Engine

type UseScopes

type UseScopes bool