routes

package

v1.10.3 Latest Latest Go to latest Published: Jul 4, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/numary/ledger

Links

Open Source Insights

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 ¶

View Source

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"
)

View Source

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

View Source

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

Variables ¶

View Source

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

View Source

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

Functions ¶

func ProvideMiddlewares ¶ added in v1.0.4

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 ¶ added in v1.3.2

type UseScopes bool

Source Files ¶

View all Source files

routes.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL