@relayerfi/widget-kit-core
v0.1.0
Published
Core logic for Relayer.fi widgets
Maintainers
Readme
@relayerfi/widget-kit-core
Framework-agnostic runtime for Relayer widgets. Handles widget directory management, metadata fetching, URL security classification, and proxy communication.
This package is used internally by @relayerfi/widget-kit-react. Most integrators should install that package instead.
Install
pnpm add @relayerfi/widget-kit-coreWhat It Does
- WidgetDirectory - Classifies widget URLs as trusted, malicious, or unknown
- Metadata fetching - Resolves action metadata from widget URLs via the Relayer proxy
- Error types - Structured
WidgetErrorwith factory methods - Utilities - URL formatting, client-key management, proxy endpoint builders
Key Exports
import { WidgetDirectory, WidgetError, PROXY_URL } from '@relayerfi/widget-kit-core';
const directory = WidgetDirectory.getInstance();
await directory.init();
const state = directory.lookup('https://app.relayer.fi');Related Packages
| Package | Purpose |
|---------|---------|
| @relayerfi/action-kit | Action type definitions, validators, executors |
| @relayerfi/widget-kit-react | React components for rendering widgets |
License
MIT
