@tetherto/mdk-react-devkit
Foundation entrypoint — domain components, hooks, and constants (`/foundation`)
The foundation entrypoint (@tetherto/mdk-react-devkit/foundation) provides domain-specific React components, hooks, and constants
assembled from @tetherto/mdk-react-devkit/core. These are higher-level blocks for common Bitcoin mining application use cases.
Generic primitives (buttons, tables, charts) import from /core. Both subpaths ship from @tetherto/mdk-react-devkit. Connected foundation components expect <MdkProvider> from @tetherto/mdk-react-adapter and adapter store hooks.
Prerequisites
- Complete the installation
- Add the dependency to your app's
package.json
{
"dependencies": {
"@tetherto/mdk-react-devkit": "*",
"@tetherto/mdk-react-adapter": "*",
"@tetherto/mdk-ui-core": "*"
}
}Run npm install from the monorepo root after your app is under apps/ so npm links workspace packages.
What's included
| Feature | Description |
|---|---|
| Operations centre | Bitcoin mining operations monitoring and management components |
| Reporting tool | Operational reporting surfaces |
| Settings | Administrative settings views |
| Hooks | Reusable React hooks |
| Constants | Shared constants and configurations |
Operations centre
Domain-specific components for Bitcoin mining operations monitoring and management, including device explorers, vendor container UIs, dashboard widgets, charts, pool management, and data export.
See the operations centre reference for the full component list with demo links.
Settings
Pre-built settings UI for common administrative tasks:
SettingsDashboard: main settings container with accordion sectionsFeatureFlagsSettings: toggle feature flags on/offHeaderControlsSettings: configure header display optionsImportExportSettings: import/export configuration dataRBACControlSettings: role-based access control settings- User management modals: add, manage, and confirm user changes
Hooks
Reusable React hooks for notifications and shell layout and chart/dashboard transforms — see the full Hooks reference.
Constants
Shared constants for consistency across your application: permission definitions, role configurations, settings defaults, and error codes.
Import examples
// Import components
import { SettingsDashboard, FeatureFlagsSettings } from '@tetherto/mdk-react-devkit/foundation'
// Import from domain subpath when you only need settings-domain exports
import { SettingsDashboard } from '@tetherto/mdk-react-devkit/domain'Troubleshooting
npm installwarns aboutengines.npm, ornpm -vis 10.x on Node 22 — Upgrade npm, then rerunnpm installandnpm run buildfrom the monorepo root.
Next steps
Consider the detailed reference material for the foundation entrypoint:
- Constants: permissions, roles, header controls, settings error codes
- Hooks: Components and Hooks: Utilities > Domain transforms
- Types:
Device,Container,Alert,MinerStats, settings shapes - Utilities:
settings-utils(filtering, formatting, import/export)