|
| 1 | +# peersync パッケージ |
| 2 | + |
| 3 | +`github.com/elementsproject/peerswap/peersync` は、PeerSwap ノード間でピア能力情報を同期するための実装を提供します。DDD 風に分割されていた `application`・`domain`・`infrastructure` 層を統合し、機能別にフラットな構成へと整理されています。 |
| 4 | + |
| 5 | +- コアロジックと値オブジェクトはすべて同じパッケージで完結 |
| 6 | +- 最小限のポート／アダプタ（`Store`, `Lightning`, `PolicyService`）を実装するだけでアプリケーションサービスが利用可能 |
| 7 | +- 既存テストは `peersync/*_test.go` にまとまり、モックよりシンプルなスタブ構成 |
| 8 | + |
| 9 | +## 主なファイル |
| 10 | + |
| 11 | +- `peer.go`：ピア・アセット・プレミアムレートなどの値オブジェクト群 |
| 12 | +- `peersync.go`：カスタムメッセージを使った同期ループ (`PeerSync`) |
| 13 | +- `ports.go`：外部と接続するためのインターフェース境界 |
| 14 | +- `supervisor.go`：同期ループを監視するスーパーバイザ |
| 15 | +- `*_test.go`：スタブを使ったユニットテスト |
| 16 | +- `mocks/ports.go`：外部利用者向けに残した gomock 版ポートモック |
| 17 | + |
| 18 | +## 使い方 |
| 19 | + |
| 20 | +1. 任意のバイナリ／プラグインから `peersync` パッケージをインポートします。 |
| 21 | +2. `Store`, `Lightning`, `PolicyService` を満たすアダプタを用意します。 |
| 22 | +3. `NewPeerSync` に各アダプタと `PeerID` を渡し、`Start` を呼び出します。 |
| 23 | +4. 必要であれば `Supervisor` を用いて自動再起動やバックオフ制御を追加できます。 |
| 24 | + |
| 25 | +```go |
| 26 | +package main |
| 27 | + |
| 28 | +import ( |
| 29 | + "context" |
| 30 | + "log" |
| 31 | + |
| 32 | + "github.com/elementsproject/peerswap/peersync" |
| 33 | +) |
| 34 | + |
| 35 | +func main() { |
| 36 | + nodeID, err := peersync.NewPeerID("my-node") |
| 37 | + if err != nil { |
| 38 | + log.Fatalf("invalid peer id: %v", err) |
| 39 | + } |
| 40 | + |
| 41 | + syncer := peersync.NewPeerSync( |
| 42 | + nodeID, |
| 43 | + &myStore{}, // peersync.Store |
| 44 | + &myLightning{}, // peersync.Lightning (custom messages + peers) |
| 45 | + &myPolicyService{}, // peersync.PolicyService |
| 46 | + ) |
| 47 | + |
| 48 | + ctx := context.Background() |
| 49 | + if err := syncer.Start(ctx); err != nil { |
| 50 | + log.Fatalf("sync failed: %v", err) |
| 51 | + } |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +### ポートインターフェース概要 |
| 56 | + |
| 57 | +| インターフェース | 主な役割 | |
| 58 | +|------------------|-----------| |
| 59 | +| `Store` | ピア状態の永続化・取得・クリーンアップ | |
| 60 | +| `Lightning` | Custom message の送受信と接続 peer 列挙（lnd/cln に橋渡し） | |
| 61 | +| `PolicyService` | 通信可否や受信許可のポリシー判定 | |
| 62 | + |
| 63 | +## テスト |
| 64 | + |
| 65 | +`peersync` 配下の変更は下記で検証できます。 |
| 66 | + |
| 67 | +```bash |
| 68 | +go test ./peersync/... |
| 69 | +``` |
| 70 | + |
| 71 | +各テストでは gomock ではなくスタブ実装を用いているため、追加アダプタの例としても参照できます。 |
| 72 | + |
| 73 | +## 参考リンク |
| 74 | + |
| 75 | +- ルート README: [`../README.md`](../README.md) |
| 76 | +- プロトコル仕様ドラフト: [`../docs/peer-protocol.md`](../docs/peer-protocol.md) |
0 commit comments