Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
Component *app.Component
)
View Source
var ParamsProtocol = &ParametersProtocol{}
View Source
var ParamsRestAPI = &ParametersRestAPI{}
Functions ¶
This section is empty.
Types ¶
type ParametersProtocol ¶
type ParametersProtocol struct {
// NetworkID defines the network ID this app operates on
NetworkID string `default:"chrysalis-mainnet" name:"networkID" usage:"the network ID on which this app operates on"`
// Bech32HRP defines the HRP which should be used for Bech32 addresses
Bech32HRP string `default:"iota" name:"bech32HRP" usage:"the HRP which should be used for Bech32 addresses"`
}
ParametersProtocol contains the definition of the parameters used by the protocol.
type ParametersRestAPI ¶
type ParametersRestAPI struct {
// BindAddress defines the bind address on which the chrysalis API HTTP server listens.
BindAddress string `default:"localhost:9094" usage:"the bind address on which the chrysalis API HTTP server listens"`
// AdvertiseAddress defines the address of the chrysalis API HTTP server which is advertised to the INX Server (optional).
AdvertiseAddress string `default:"" usage:"the address of the chrysalis API HTTP server which is advertised to the INX Server (optional)"`
Limits struct {
// the maximum number of characters that the body of an API call may contain
MaxBodyLength string `default:"1M" usage:"the maximum number of characters that the body of an API call may contain"`
// the maximum number of results that may be returned by an endpoint
MaxResults int `default:"1000" usage:"the maximum number of results that may be returned by an endpoint (0 for disabled)"`
}
Caches struct {
// the maximum number of entries in the transaction history LRU cache
TransactionHistorySize int `default:"10000" usage:"the maximum number of entries in the transaction history LRU cache"`
}
// SwaggerEnabled defines whether to provide swagger API documentation under endpoint "/swagger"
SwaggerEnabled bool `default:"false" usage:"whether to provide swagger API documentation under endpoint \"/swagger\""`
// UseGZIP defines whether to use the gzip middleware to compress HTTP responses
UseGZIP bool `default:"true" usage:"use the gzip middleware to compress HTTP responses"`
// DebugRequestLoggerEnabled defines whether the debug logging for requests should be enabled
DebugRequestLoggerEnabled bool `default:"false" usage:"whether the debug logging for requests should be enabled"`
}
ParametersRestAPI contains the definition of the parameters used by the chrysalis API HTTP server.
Click to show internal directories.
Click to hide internal directories.