faucet

Documentation

Index

• Constants
• Variables
• type ParametersFaucet

Constants

const (

	// RouteFaucetInfo is the route to give info about the faucet address.
	// GET returns address, balance, bech32HRP and tokenName of the faucet.
	RouteFaucetInfo = "/info"

	// RouteFaucetEnqueue is the route to tell the faucet to pay out some funds to the given address.
	// POST enqueues a new request.
	RouteFaucetEnqueue = "/enqueue"
)

Variables

var (
	CoreComponent *app.CoreComponent
)

var ParamsFaucet = &ParametersFaucet{
	MaxOutputCount: iotago.MaxOutputsCount,
}

Types

type ParametersFaucet

type ParametersFaucet struct {
	Amount            uint64        `default:"1000000000" usage:"the amount of funds the requester receives"`
	SmallAmount       uint64        `` /* 152-byte string literal not displayed */
	MaxAddressBalance uint64        `default:"2000000000" usage:"the maximum allowed amount of funds on the target address"`
	MaxOutputCount    int           `usage:"the maximum output count per faucet message"`
	TagMessage        string        `default:"HORNET FAUCET" usage:"the faucet transaction tag payload"`
	BatchTimeout      time.Duration `default:"2s" usage:"the maximum duration for collecting faucet batches"`
	BindAddress       string        `default:"localhost:8091" usage:"the bind address on which the faucet website can be accessed from"`
	RateLimit         struct {
		Period      time.Duration `default:"5m" usage:"the period for rate limiting"`
		MaxRequests int           `default:"10" usage:"the maximum number of requests per period"`
		MaxBurst    int           `default:"20" usage:"additional requests allowed in the burst period"`
	}
}