Documentation
¶
Index ¶
- type ApiOptions
- type ContractsOptions
- type DbOptions
- type GenerateKeyOptions
- type GetAllNodesOptions
- type GetPubKeyOptions
- type LogOptions
- type MetricsOptions
- type MlsValidationOptions
- type PayerOptions
- type ReflectionOptions
- type RegisterNodeOptions
- type ServerOptions
- type SignerOptions
- type TracingOptions
- type UpdateAddressOptions
- type UpdateHealthOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiOptions ¶
type ApiOptions struct {
Port int `short:"p" long:"port" description:"Port to listen on" env:"XMTPD_API_PORT" default:"5050"`
}
type ContractsOptions ¶
type ContractsOptions struct { RpcUrl string `long:"rpc-url" env:"XMTPD_CONTRACTS_RPC_URL" description:"Blockchain RPC URL"` NodesContractAddress string `long:"nodes-address" env:"XMTPD_CONTRACTS_NODES_ADDRESS" description:"Node contract address"` MessagesContractAddress string `long:"messages-address" env:"XMTPD_CONTRACTS_MESSAGES_ADDRESS" description:"Message contract address"` IdentityUpdatesContractAddress string `` /* 126-byte string literal not displayed */ ChainID int `` /* 148-byte string literal not displayed */ RefreshInterval time.Duration `` /* 146-byte string literal not displayed */ }
type DbOptions ¶
type DbOptions struct { ReaderConnectionString string `long:"reader-connection-string" env:"XMTPD_DB_READER_CONNECTION_STRING" description:"Reader connection string"` WriterConnectionString string `` /* 148-byte string literal not displayed */ ReadTimeout time.Duration `` /* 162-byte string literal not displayed */ WriteTimeout time.Duration `` /* 162-byte string literal not displayed */ MaxOpenConns int `` /* 161-byte string literal not displayed */ WaitForDB time.Duration `` /* 132-byte string literal not displayed */ }
type GenerateKeyOptions ¶
type GenerateKeyOptions struct{}
type GetAllNodesOptions ¶
type GetAllNodesOptions struct{}
type GetPubKeyOptions ¶
type GetPubKeyOptions struct {
PrivateKey string `long:"private-key" description:"Private key you want the public key for" required:"true"`
}
type LogOptions ¶
type MetricsOptions ¶
type MetricsOptions struct { Enable bool `long:"enable" env:"XMTPD_METRICS_ENABLE" description:"Enable the metrics server"` Address string `` /* 134-byte string literal not displayed */ Port int `` /* 129-byte string literal not displayed */ }
MetricsOptions are settings used to start a prometheus server
type MlsValidationOptions ¶
type MlsValidationOptions struct {
GrpcAddress string `long:"grpc-address" env:"XMTPD_MLS_VALIDATION_GRPC_ADDRESS" description:"Address of the MLS validation service"`
}
type PayerOptions ¶
type PayerOptions struct {
PrivateKey string `` /* 127-byte string literal not displayed */
}
type ReflectionOptions ¶
type ReflectionOptions struct {
Enable bool `long:"enable" env:"XMTPD_REFLECTION_ENABLE" description:"Enable GRPC reflection"`
}
ReflectionOptions are settings controlling collection of GRPC reflection settings.
type RegisterNodeOptions ¶
type RegisterNodeOptions struct { HttpAddress string `long:"http-address" description:"HTTP address to register for the node" required:"true"` OwnerAddress string `long:"owner-address" description:"Blockchain address of the intended owner of the registration NFT" required:"true"` AdminPrivateKey string `long:"admin-private-key" description:"Private key of the admin to register the node" required:"true"` SigningKeyPub string `long:"signing-key-pub" description:"Signing key of the node to register" required:"true"` }
type ServerOptions ¶
type ServerOptions struct { API ApiOptions `group:"API Options" namespace:"api"` DB DbOptions `group:"Database Options" namespace:"db"` Contracts ContractsOptions `group:"Contracts Options" namespace:"contracts"` Metrics MetricsOptions `group:"Metrics Options" namespace:"metrics"` Payer PayerOptions `group:"Payer Options" namespace:"payer"` Reflection ReflectionOptions `group:"Reflection Options" namespace:"reflection"` Tracing TracingOptions `group:"DD APM Tracing Options" namespace:"tracing"` MlsValidation MlsValidationOptions `group:"MLS Validation Options" namespace:"mls-validation"` Log LogOptions `group:"Log Options" namespace:"log"` Signer SignerOptions `group:"Signer Options" namespace:"signer"` Version bool `` /* 127-byte string literal not displayed */ }
type SignerOptions ¶
type SignerOptions struct {
PrivateKey string `long:"private-key" env:"XMTPD_SIGNER_PRIVATE_KEY" description:"Private key used to sign messages" required:"true"`
}
type TracingOptions ¶
type TracingOptions struct {
Enable bool `long:"enable" env:"XMTPD_TRACING_ENABLE" description:"Enable DD APM trace collection"`
}
TracingOptions are settings controlling collection of DD APM traces and error tracking.
type UpdateAddressOptions ¶
type UpdateHealthOptions ¶
Click to show internal directories.
Click to hide internal directories.