Filecoin大規模スペックアップグレードについて
ここ数ヶ月の間に、私たちはFilecoinの仕様とウェブサイトを刷新するための大規模なアップグレードを行いました。スペックは以前よりも6倍以上になり、現時点で85%完了しています。また、新しいワークフロー、ステータスバッジ、検索などにより仕様書も劇的に改善されました。
最近Filecoin Specのサイトをご覧になっていない方は、https://spec.filecoin.io/ をご覧ください。
Specのウェブサイトは、Filecoin開発者、実装者、研究者、エコシステム開発者のための素晴らしいプラットフォームを作成する方に必要なすべての機能を統合するために、いくつかの「デザイン→実装→デプロイ」を経てきました。さらに、仕様内容の更新に必要な複雑さを減らし、構造化された関係管理を適用し、仕様全体の一貫性を確保するための機能を追加し、新しいツールのサポートを追加しました。
具体的に説明します。
■新しいFilecoin仕様の貢献ワークフロー
スペックコンテンツの更新は、マークダウンファイルでの “シングルタッチ “編集を含むよりシンプルで使いやすくなりました。バックエンドの仕組みにより、目次とドキュメント構造を自動的に更新してくれます。スペックのrepo README*ファイルで必要なすべての簡単な手順を確認できます。
*https://github.com/filecoin-project/specs/blob/master/README.md
更新されたサイトの最も注目すべき機能は、以下のカテゴリに分かれています。
■ツールと構文
１．ツールと構文: npmとGoモジュールによる依存関係のシームレスな制御
２．katexによるシームレスな数学・関数サポート
３．コンテンツのマークダウンの一貫性を確保するために、いくつかのカスタムlintルールを持つ新しいマークダウンリンター
■ダイアグラムとコードブロック
１．Marmaidとドット処理のパイプライン（将来的に追加するオプションあり）は、開発とコンテンツ編集のためにHugoサーバーと統合されます。
２．シンボルショートコードを使って仕様書からコードを参照できるので、コードベース自体が変更された場合でも、正しいコードブロックが参照され、それぞれのリポジトリから引き出されます。
■ドキュメント階層
１．セクション番号付けは目次から自動的に更新されます。同期させるために別のファイルを編集する必要はありません。
２．セクションのディープリンクが統合されました。
３．シングルページのレンダリングが安定し、セクション構造が目次に反映されるようになりました。
これらの変更に加えて、ウェブサイトも改善されました。
コンテンツでは、プロトコルの説明を更新するために膨大な努力をしてきました。Filecoinは巨大なプロジェクトです。もし印刷された場合、プロトコルの仕様は400ページにもなるでしょう。
Filecoinの仕様は、実装にとらわれない仕様になっています。つまり、実装の詳細には触れずに、ネットワークを動作させるアルゴリズムとプロトコルの相互作用の説明を提供しているということです。この仕様は、どの言語でもFilecoinを実装するために開発者が必要とするすべての必要な詳細を提供しています。Lotusの実装への参照は、必要な場合にのみ提供されています。
■進捗状況
3ヶ月間のSpec Projectの旅では、300以上の GitHub課題が提出され、200以上のPR(修正や機能追加)がマージされました。
現在、仕様サイトは84％が最新の状態になっています。私たち自身の進捗状況とサイトやプロトコルの「健全性」の状態を把握するために、私たちは3つの素晴らしいツールを導入しました。
１．仕様の各セクションの状態を “Incorrect”、”WIP/Draft”、”Reliable”、”Stable “で表示するダッシュボードです。仕様マークダウンファイルにフロントマターのプロパティを統合し、余分なアクションを必要とせずに自動的にダッシュボードに値を反映します。ダッシュボードは目次から自動的生成及び更新されます。ダッシュボードを更新するために別のファイルを編集する必要はありません。
２．ダッシュボードの別の列に、プロトコルの特定のコンポーネントが監査されたかどうかを示す「監査完了」インジケータが表示されます。監査報告書がある場合は、監査が行われた日付とともに、報告書（または過去の報告書のリスト）へのリンクが表示されます。
３．Lotus、Fuhon、Forest、go-filecoinのFilecoin実装のステータス情報を持つ別の「実装ステータス」ダッシュボードの改善。ダッシュボードには、対応するリポジトリからシームレスに情報を引き出すためのフックが統合されており、CIテストの成功/失敗やテストカバレッジをレポートします。
■FIP統合
数回のテストラウンドと2回の印象的なスペースレース大会を経て、プロトコルは現在、微調整されています。
いくつかのテストラウンドと2つのスペースレースを経て、プロトコルは微調整され、リフトオフの準備が整いました。今後、プロトコルの変更は、Filecoin Improvement Proposals (FIPs)*を通じて行われます。プロトコルへの変更提案は、明確に指定されたプロセスを経る必要があり、FIPリポジトリに詳細が記載されています。
*https://github.com/filecoin-project/fips
ほとんどの場合、FIPはプロトコル仕様の更新を必要とするため、現在進行中の取り組みの流れの1つとして、Filecoin仕様とFIPプロセスのシームレスな統合が含まれています。
今後の予定についてです。我々は仕様のバージョン管理を統合して、仕様自体のタイムマシンを作成し、プロトコル更新前の仕様を過去に遡って見ることができるようにしています。最後に、APIプロキシを介してリモートソースからデータを引き出すためのツールを統合しています。これにより、FIPとのシームレスな統合が可能になり、ダッシュボードに”Conformance Tests “のステータスを含めるように拡張することも可能になります。
もしあなたがFilecoinの開発者、研究者、採掘者、ユーザーであれば、ぜひ下記ご協力をお願いします。
１．仕様に貢献していただける方
２．サイトや仕様の更新プロセスに関するご意見・ご感想
３．ユーザー体験をさらに向上させるためのアイデア
スペースレースの間にプロトコルと仕様に大きな進歩とアップグレードがありました。次の数週間で90％の信頼性の高いコンテンツを、次の数ヶ月で100％の安定したコンテンツを目指しています。
※発信元
コメント