mcpField
O
orderly-sdk-install-dependency

orderly-sdk-install-dependency

github.com/orderlynetwork開発249 回インストール4 日前に更新
リポジトリ

orderly-sdk-install-dependency について

モジュール型のOrderly SDKを導入するReact開発者向けのインストールガイドです。DEX、ウォレット、カスタムUIの用途別にパッケージを整理し、依存関係とViteの設定も説明します。

主な機能

  1. 01モジュール型Orderlyパッケージ一覧
  2. 02取引・ポートフォリオページコンポーネント
  3. 03EVM、Solana、Privyのウォレット接続
  4. 04UIサブパッケージと低レベルパッケージ
  5. 05用途別のインストール手順
  6. 06バージョンとViteの設定案内

活用シーン

  1. 01新しいDEXへのSDK導入
  2. 02既存のReactプロジェクトへのOrderly追加
  3. 03カスタムUI向けのhooksとUIパッケージ選定
  4. 04標準ウォレットまたはPrivyログインの設定

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/orderlynetwork/skills --skill orderly-sdk-install-dependency

インストール後、Claude Code で/orderly-sdk-install-dependencyを入力して読み込まれたか確認します。

詳細

Orderly Network:SDK のインストールと依存関係

このスキルを使用して、Orderly SDK パッケージをプロジェクトに追加します。SDK はモジュール式のため、必要なものだけをインストールしてください。以下のバージョンは、現在の 3.1.x 系のものです。

使用する場面

  • 新しい DEX プロジェクトを開始するとき
  • 既存のプロジェクトに Orderly SDK を追加するとき
  • カスタム統合用に特定のパッケージをインストールするとき
  • ウォレットコネクターをセットアップするとき

前提条件

  • Node.js 20+ がインストールされていること(package.json の engines で必須)
  • npm、yarn、または pnpm パッケージマネージャー
  • React 18+ プロジェクト(UI パッケージ用)

クイックスタート(DEX 全体)

IMPORTANT:機能する DEX には、Orderly パッケージとウォレットコネクターの依存関係の両方が必要です。@orderly.network/wallet-connector では、EVM ウォレットに @web3-onboard/* パッケージ、Solana ウォレットに @solana/wallet-adapter-* パッケージが必要です。実際の DEX では、<WalletConnectorProvider> に設定済みの evmInitial / solanaInitial プロパティを渡す必要があります。これらは省略できません(orderly-sdk-wallet-connection を参照)。

注:@orderly.network/hooks は @orderly.network/react-app の推移的依存関係です。hooks のみを使用する統合パスの場合を除き、個別にインストールする必要はありません。

# Orderly SDK packages (all pinned to the same 3.1.x release)
npm install @orderly.network/react-app \
            @orderly.network/trading \
            @orderly.network/portfolio \
            @orderly.network/markets \
            @orderly.network/wallet-connector \
            @orderly.network/i18n

# REQUIRED: EVM wallet support (MetaMask, WalletConnect, Binance, etc.)
npm install @web3-onboard/injected-wallets @web3-onboard/walletconnect \
            @binance/w3w-blocknative-connector wagmi

# REQUIRED: Solana wallet support (Phantom, Solflare, mobile, etc.)
npm install @solana/wallet-adapter-base @solana/wallet-adapter-wallets \
            @solana-mobile/wallet-adapter-mobile

パッケージリファレンス

コアパッケージ
パッケージ説明主なエクスポート
@orderly.network/react-appメインアプリプロバイダー、設定コンテキストOrderlyAppProvider、useAppContext、useAppConfig
@orderly.network/hooks取引、アカウント、注文、ポジション用の React フックuseAccount、useOrderEntry、usePositionStream、useOrderStream、useDeposit、useWithdraw、useLeverage、useMarkets
@orderly.network/typesTypeScript 型定義と定数API、OrderType、OrderSide、OrderStatus、NetworkId、ChainConfig
@orderly.network/ui基本 UI コンポーネント(ボタン、入力欄、ダイアログ、テーブル)Button、Input、Dialog、Table、Tabs、Select、Tooltip、Modal、Spinner、toast、useScreen、Flex、cn
@orderly.network/i18n国際化(i18n)サポートLocaleProvider、useTranslation、i18n、defaultLanguages
@orderly.network/utilsユーティリティ関数(書式設定、数学、日付)formatNumber、Decimal、dayjs
npm install @orderly.network/react-app @orderly.network/hooks @orderly.network/types @orderly.network/ui @orderly.network/i18n

機能ウィジェット(高レベルページ)

完全な機能を備えた、すぐに使えるページコンポーネントです。以下のエクスポートは、リファレンステンプレートで実際にインポートされる名前です。特に Dashboard.DashboardPage、GeneralLeaderboardWidget、PointSystemPage にご注意ください。

パッケージ説明主なエクスポート(検証済み)
@orderly.network/trading取引ページ全体(チャート、注文板、注文入力、ポジション)TradingPage、OrderBook、LastTrades、AssetView、RiskRate、SplitLayout
@orderly.network/portfolioポートフォリオダッシュボード(ポジション、注文、資産、履歴)OverviewModule、PositionsModule、OrdersModule、AssetsModule、HistoryModule、FeeTierModule、APIManagerModule
@orderly.network/markets価格と統計情報を表示するマーケット一覧ページMarketsHomePage、MarketsProvider、MarketsList、SymbolInfoBar、FundingOverview
@orderly.network/vaultsVault/Earn 商品ページVaultsPage
@orderly.network/affiliate紹介/アフィリエイトプログラムDashboard(Dashboard.DashboardPage を使用)、ReferralProvider
@orderly.network/trading-leaderboard取引コンペティションのランキングGeneralLeaderboardWidget
@orderly.network/trading-pointsポイント/特典プログラムページPointSystemPage
npm install @orderly.network/trading @orderly.network/portfolio @orderly.network/markets @orderly.network/trading-leaderboard @orderly.network/trading-points @orderly.network/affiliate @orderly.network/vaults

@orderly.network/trading-rewards パッケージはありません。ポイント/報酬ページは PointSystemPage をエクスポートする @orderly.network/trading-points です。同様に、@orderly.network/affiliate は AffiliatePage をエクスポートしません。<ReferralProvider> 内で Dashboard.DashboardPage を使用してください。

ウォレットコネクター

ウォレット接続方式を1つ選択してください。

パッケージ説明主なエクスポート
@orderly.network/wallet-connector標準コネクター(Web3-Onboard + Solana アダプター)WalletConnectorProvider
@orderly.network/wallet-connector-privyPrivy コネクター(ソーシャルログイン、埋め込みウォレット)WalletConnectorPrivyProvider

オプション A:標準ウォレットコネクター(推奨)

EVM(MetaMask、WalletConnect、Binance など)と Solana(Phantom、Solflare、Ledger、モバイル)に対応しています。

このコネクターには、基盤となるウォレットパッケージが必要です。evmInitial(インジェクション + WalletConnect コネクター)と solanaInitial(ネットワーク + ウォレットリスト)を作成し、両方をプロパティとして渡してください。walletConfig.ts の全体については orderly-sdk-wallet-connection を参照してください。

npm install @orderly.network/wallet-connector

# EVM wallets
npm install @web3-onboard/injected-wallets @web3-onboard/walletconnect \
            @binance/w3w-blocknative-connector wagmi

# Solana wallets
npm install @solana/wallet-adapter-base @solana/wallet-adapter-wallets \
            @solana-mobile/wallet-adapter-mobile

オプション B:Privy コネクター

ソーシャルログイン(Google、X、メール、パスキー)と埋め込みウォレットに対応しています。

Privy パッケージは @privy-io/cross-app-connect に依存しています(以前の @privy-io/react-auth ではありません)。

npm install @orderly.network/wallet-connector-privy @privy-io/cross-app-connect

UI サブパッケージ(細分化されたコンポーネント)

カスタム統合向けの個別 UI モジュールです。これらは @orderly.network/trading と @orderly.network/portfolio の依存関係ですが、個別にインストールできます。リファレンステンプレートでは、直接インポートするのではなく、@orderly.network/ui と @orderly.network/ui-scaffold の再エクスポートを通じて利用します。

パッケージ説明主なエクスポート
@orderly.network/ui-scaffoldアプリのレイアウト用スキャフォールド、ナビゲーション、アカウントメニューScaffold、MainNavWidget、BottomNavWidget、AccountMenuWidget、ChainMenuWidget、SideNavbarWidget
@orderly.network/ui-order-entry注文入力フォームコンポーネントOrderEntry
@orderly.network/ui-positionsポジションテーブルコンポーネントPositionsView
@orderly.network/ui-orders注文テーブルコンポーネントOrdersView
@orderly.network/ui-transfer入金/出金/振替ダイアログDepositWidget、WithdrawWidget
@orderly.network/ui-leverageレバレッジ選択コンポーネントLeverageWidget
@orderly.network/ui-tpsl利益確定/損切りフォームTPSLWidget
@orderly.network/ui-share損益共有カード生成ツールSharePnL
@orderly.network/ui-chain-selectorチェーン/ネットワーク選択ドロップダウンChainSelector
@orderly.network/ui-connectorウォレット接続ボタンとモーダルConnectWalletButton
@orderly.network/ui-tradingviewTradingView チャートラッパーTradingViewChart
@orderly.network/ui-notification通知センターNotificationWidget
npm install @orderly.network/ui-scaffold @orderly.network/ui

低レベルパッケージ

高度なカスタマイズや React 以外の環境向けです。

パッケージ説明主なエクスポート
@orderly.network/core低レベル API クライアント、署名、キー管理Account、ConfigStore、WalletAdapter、signMessage
@orderly.network/perp無期限取引の計算(証拠金、清算)calcMargin、calcLiqPrice、calcPnL、calcIMR、calcMMR
@orderly.network/netネットワーク/WebSocket レイヤーWebSocketClient、EventEmitter
@orderly.network/default-evm-adapterデフォルトの EVM ウォレットアダプターEVMAdapter
@orderly.network/default-solana-adapterデフォルトの Solana ウォレットアダプターSolanaAdapter
npm install @orderly.network/core @orderly.network/perp

ユースケース別のインストール

最小構成(フックのみ)

フックを使って、完全にカスタムの UI を構築する場合に使用します。

npm install @orderly.network/react-app \
            @orderly.network/hooks \
            @orderly.network/types \
            @orderly.network/wallet-connector
すべての機能を備えたフル DEX

リファレンステンプレートの依存関係を再現します。

npm install @orderly.network/react-app \
            @orderly.network/trading \
            @orderly.network/portfolio \
            @orderly.network/markets \
            @orderly.network/vaults \
            @orderly.network/affiliate \
            @orderly.network/trading-leaderboard \
            @orderly.network/trading-points \
            @orderly.network/wallet-connector \
            @orderly.network/wallet-connector-privy \
            @orderly.network/i18n \
            @orderly.network/types \
            @orderly.network/ui \
            @orderly.network/ui-scaffold

リファレンステンプレートには、woofi-swap-widget-kit(スワップページ用)、wagmi、react-helmet-async(SEO)、react-router-dom(v7、ルーティング)、firebase、zod、ip-range-check、@plausible-analytics/tracker も含まれています。これらの機能をビルドで使用する場合にのみ追加してください。

Privy(ソーシャルログイン)のセットアップ
npm install @orderly.network/react-app \
            @orderly.network/trading \
            @orderly.network/wallet-connector-privy \
            @privy-io/cross-app-connect

ピア依存関係

すべてのパッケージで必要です。

{
  "peerDependencies": {
    "react": ">=18",
    "react-dom": ">=18"
  }
}

Tailwind CSS のセットアップ

UI パッケージには Tailwind CSS が必要です。Orderly プリセットはありません。コンテンツの glob を app/(ソースルート)と @orderly.network パッケージに指定してください。

npm install -D tailwindcss postcss autoprefixer

tailwind.config.ts:

import type { Config } from 'tailwindcss';

export default {
  content: ['./app/**/{**,.client,.server}/**/*.{js,jsx,ts,tsx}'],
  theme: { extend: {} },
  plugins: [],
} satisfies Config;

CSS エントリーファイル:

CSS ファイルを同梱しているのは @orderly.network/ui だけです。trading、portfolio、markets などはこれらの基本スタイルを再利用するため、パッケージごとの CSS を探す必要はありません。

/* app/styles/index.css */
@import '@orderly.network/ui/dist/styles.css';

@tailwind base;
@tailwind components;
@tailwind utilities;

Vite プラグイン(必須)

ウォレットコネクター/Solana パッケージでは Node.js の組み込み機能(Buffer、crypto、stream)を使用しており、一部は CommonJS を同梱しています。ポリフィルは buffer、crypto、stream のみにしてください。util や globals は追加しないでください(ビルドが失敗します)。CommonJS の依存関係には vite-plugin-cjs-interop を使用してください。パスエイリアスは vite-tsconfig-paths を介して tsconfig.json から取得します。

npm install -D vite-plugin-node-polyfills vite-plugin-cjs-interop vite-tsconfig-paths

vite.config.ts:

import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import tsconfigPaths from 'vite-tsconfig-paths';
import { cjsInterop } from 'vite-plugin-cjs-interop';
import { nodePolyfills } from 'vite-plugin-node-polyfills';

export default defineConfig({
  plugins: [
    react(),
    tsconfigPaths(),
    cjsInterop({ dependencies: ['bs58', '@coral-xyz/anchor', 'lodash'] }),
    nodePolyfills({ include: ['buffer', 'crypto', 'stream'] }), // NO util, NO globals
  ],
});

バージョンの互換性

すべての @orderly.network/* パッケージは同じバージョンにする必要があります。例外は @orderly.network/trading-points で、独自のバージョン系列に従います。現在のリファレンスバージョン:

{
  "dependencies": {
    "@orderly.network/react-app": "3.1.6",
    "@orderly.network/trading": "3.1.6",
    "@orderly.network/portfolio": "3.1.6",
    "@orderly.network/hooks": "3.1.6",
    "@orderly.network/ui": "3.1.6",
    "@orderly.network/trading-points": "2.0.2"
  }
}

パッケージマネージャーのコマンド

npm:

npm install <package-name>

yarn:

yarn add <package-name>

pnpm:

pnpm add <package-name>

関連スキル

  • orderly-sdk-dex-architecture - プロジェクト構成とプロバイダーのセットアップ
  • orderly-sdk-wallet-connection - ウォレット統合の詳細
  • orderly-sdk-page-components - 事前構築済みページコンポーネントの使用方法
  • orderly-sdk-trading-workflows - エンドツーエンドの取引実装
  • orderly-sdk-theming - UI の外観のカスタマイズ

コメント