Utilities for golang development on Conflux blockchain, especially for backend service.
| Module | Description |
|---|---|
| Alert | Send notification messages to DingTalk, Telegram, SMTP email or PagerDuty. |
| API | REST API utilities based on gin. |
| Blockchain/sync | Utilities to sync blockchain data. |
| Channel | Provides more powerful channels. |
| Cmd | Utilities for CLI tools. |
| Config | Initialize all modules. |
| DLock | Utilities for distributed lock. |
| Health | Utilities for health management. |
| HTTP | Provides common used middlewares，e.g. remote address, API key and rate limit. |
| Log | Based on logrus and integrated with Alert. |
| Metrics | To monitor system runtime. |
| Parallel | Utilities for parallel execution. |
| Pprof | To enable pprof server based on configuration. |
| Rate Limit | Utilities to limit request rate, along with HTTP handler middlewares |
| Store | Provides utilities to initialize database. |
| Viper | Initialize the original viper in common and fix some issues. |
Intervals for periodic tasks must be positive. When a constructor or initialization
entry point applies defaults, a zero interval uses the configured default. A
default struct tag alone does not apply defaults when a configuration is created
directly.
Negative intervals are unsupported. Invalid configurations may return an error or
panic during initialization or use; the exact failure point is not guaranteed
unless documented by the API. Field-specific documentation takes precedence.
This convention does not apply to all time.Duration values: for example, some
timeout settings use nonpositive values to disable timeouts.