ariestools-sdk

Aries Tools SDK

権威ある情報源。 このスキルは ariestools/ariestools-skills でのみ保守されています。インストール済みのコピーではなく、そちらを編集してください。

ariestools/sdk-js の有効なパッケージを @ariestools/* スコープで使用してください。新規作業で廃止済みの @xylabs/* ユーティリティ名をインストールしないでください。また、npm の非推奨通知に示されている、凍結された @ariestools/{indexed-db,mongo,vitest-matchers,vitest-extended} 8.0.3 パッケージもインストールしないでください。既存のリポジトリ依存関係とバージョンを優先し、利用するリポジトリに応じてバージョンを固定してください。

対象範囲。 対象は sdk-js から公開されるパッケージのみです。@ariestools/sdk-react* を使用する React の作業は ariestools-sdk-react が対象です。アクター、プロバイダー、およびそれらの CLI とブラウザーホスト（@ariestools/actor*、@ariestools/provider*、@ariestools/cli-kit*、@ariestools/browser-kit*）は ariestools-actor が対象です。どちらも aries オペレーター CLI である @ariestools/cli は対象に含みません。ツールチェーンと設定パッケージは xy-toolchain が対象です。

ランタイム。 このスキルでは sdk-js 9.x について説明します。このバージョンのパッケージが宣言する engines.node >=26 は、ツールチェーン自体が必要とする Node 22 を上回ります。ランタイムの基準を参照してください。

スキルの識別情報。 計画、受領確認、または完了の概要を提示する際は、参考にしたスキルを ariestools-sdk v<version> の形式で示し、このパック内にあるほかの有効なスキルもそれぞれ同じ形式で列挙してください。バージョンは例ではなく、このファイルの metadata.version から取得してください。

参考資料

概要とインストール

アンブレラパッケージと専門パッケージのどちらを選ぶか、@ariestools/sdk（ルートのバレルが実行時に読み込む zod と @opentelemetry/api を含む）をインストールする方法、Node >= 26 のランタイムの基準を確認する方法、または廃止済みの @xylabs/* と凍結された 8.x の @ariestools/* 名を移行マップを使って置き換える方法を確認するときに、最初に読んでください。

アンブレラモジュール

@ariestools/sdk 内のユーティリティ（assert、delay、fetch、forget、hex、promise、retry、storage、typeof、logger など）を選ぶとき、モジュールのサブパスや /model 型を調べるとき、またはプラットフォーム条件付きモジュール（platform、url、subtle）を使うときに読んでください。

専門パッケージ

Express ヘルパー、IndexedDB／Mongo アダプター、スレッド／ワーカー、テスト用マッチャー、テレメトリー、暗号認証、eth-address（EthAddressWrapper）、pixel、json-rpc-engine、または sdk-meta（サーバーサイドの HTML head／OpenGraph／Twitter メタデータ）が必要な場合に読んでください。これらのパッケージは、メインのアンブレラパッケージをインストールするだけでは完全には置き換えられません。各パッケージのランタイム（Node、ブラウザー、または両方）と依存関係の配置についても説明しています。

Fetch と HTTP

fetchJson／FetchClient の呼び出し、リクエストオプションの設定、結果や FetchError の処理、レスポンスの読み取りの制限やキャンセル（maxResponseBytes、signal、クライアントの timeout、readResponseText）、カスタムフェッチャーの注入、または Undici を使った Node の HTTP キャッシュの設定（利用側が管理）を行うときに読んでください。

規約

インポート形式（ルートのバレルとサブパス）、ESM のみの対応、ツリーシェイキング、非推奨事項（テレメトリーの再エクスポート、@ariestools/crypto、廃止済みの 8.x パッケージ名、API レベルの非推奨事項）、このモノレポと xy ツールチェーンの関係（メンテナー向けのモノリス構成を含む）、利用側でのテスト、新しいコードのチェックリストについて確認してください。

関連スキル

• xy-development — TypeScript、Git、テストの原則、完了の定義を扱います。このスキルはこれを基盤としています。インストール：npx skills add ariestools/ariestools-skills --skill xy-development。
• xy-toolchain — sdk-js のパッケージとその利用側が使用する xy CLI、設定、Vitest、deplint、パッケージポリシーを扱います。このスキルはこれを基盤としています。インストール：npx skills add ariestools/ariestools-skills --skill xy-toolchain。
• ariestools-sdk-react — @ariestools/sdk-react* を使用する React UI を扱います。この UI は、この SDK のルートバレルを宣言せずにインポートし、@ariestools/pixel と @ariestools/eth-address を使用します。このスキルは本スキルを基盤としています。インストール：npx skills add ariestools/ariestools-skills --skill ariestools-sdk-react。
• ariestools-actor — actor-kit のアクター、プロバイダー、アクターエンジンを扱います。これらは cli-kit または browser-kit によってホストされ、この SDK の creatable とロガーユーティリティを基盤としています。このスキルは本スキルを基盤としています。インストール：npx skills add ariestools/ariestools-skills --skill ariestools-actor。

リンク先のスキルがインストールされていない場合は、npx skills add ariestools/ariestools-skills --skill <name> で追加してください。