1k-feature-guides

機能開発ガイド

OneKey アプリの機能を拡張するための包括的なガイドです。

クイックリファレンス

機能	ガイド	主なファイル
ブロックチェーンのチェーンを追加	adding-chains.md	packages/core/src/chains/
WebSocket イベントを追加	adding-socket-events.md	packages/shared/types/socket.ts
プッシュ通知	notification-system.md	packages/kit-bg/src/services/ServiceNotification/
ページとルート	page-and-route.md	packages/kit/src/routes/

新しいチェーンの追加

参照先：references/rules/adding-chains.md

主な手順：

1. packages/core/src/chains/mychain/ にチェーンのコアロジックを実装します
2. packages/shared/src/config/chains/ にチェーンの設定を追加します
3. チェーン固有の機能に合わせて UI コンポーネントを更新します
4. 包括的なテストを追加します

参考実装：

• EVM チェーン：packages/core/src/chains/evm/
• Bitcoin：packages/core/src/chains/btc/
• Solana：packages/core/src/chains/sol/

WebSocket イベントの追加

参照先：references/rules/adding-socket-events.md

主な手順：

1. EAppSocketEventNames enum にイベント名を定義します
2. msgId: string を含むペイロード型のインターフェースを定義します
3. PushProviderWebSocket.initWebSocket() にイベントハンドラーを追加します
4. ackNotificationMessage を使って必ずメッセージを確認応答します

this.socket.on(EAppSocketEventNames.myEvent, (payload: IMyPayload) => {
  void this.backgroundApi.serviceNotification.ackNotificationMessage({
    msgId: payload.msgId,
    action: ENotificationPushMessageAckAction.arrived,
  });
  void this.backgroundApi.someService.handleEvent(payload);
});

通知システム

参照先：references/rules/notification-system.md

通知モード：

モード	アクション
1 (page)	指定したページに移動
2 (dialog)	ダイアログを表示
3 (openInBrowser)	外部ブラウザーで URL を開く
4 (openInApp)	アプリ内ブラウザーで URL を開く
5 (openInDapp)	DApp ブラウザーで URL を開く

主なファイル：

• サービス：packages/kit-bg/src/services/ServiceNotification/ServiceNotification.ts
• ユーティリティ：packages/shared/src/utils/notificationsUtils.ts
• 型：packages/shared/types/notification.ts

ページとルート

参照先：references/rules/page-and-route.md

ページの種類：

種類	説明
modal	モーダルオーバーレイページ
stack	タブルートページ
onboarding	全画面のオンボーディングページ

ルート設定の場所：

• モーダルルート：packages/kit/src/routes/Modal/router.tsx
• タブルート：packages/kit/src/routes/Tab/router.ts
• オンボーディング：packages/kit/src/views/Onboardingv2/router/index.tsx

重要：

• ⚠️ ページを削除しないでください - 非推奨のルートにはリダイレクトパターンを使用します
• ⚠️ ルートパスはアプリケーション全体で一意である必要があります
• ⚠️ navigation.navigate では必ず pop: true を使用してください

関連スキル

• /1k-coding-patterns - React と TypeScript のベストプラクティス
• /1k-architecture - プロジェクト構成とインポートのルール
• /1k-state-management - Jotai atom のパターン