在過去的幾個月,Filecoin Specification(規範)及其網站修訂取得了巨大進展!規格比以前精確了6倍以上,達到了出色的85%完整性評分。
Spec網站已整合開發人員、實施人員、研究人員創建出色平臺所需的所有功能。此外,還降低了更新規範內容所需的複雜性,應用了結構化的依存關係管理,添加了確保整個規範一致性的功能,增加了對新工具的支持等等!網站已全面翻新,歡迎訪問:https ://spec.filecoin.io/
新的Filecoin規範貢獻工作流程
現在,更新規範內容變得更加簡單和有趣,涉及在文件中進行「單觸」編輯。後端機制負責其餘的工作,並自動更新目錄(ToC)和文檔結構!更新後的站點最值得注意的功能分為以下幾類:
除了這些背景變化之外,該網站也進行了改版!
在內容方面,我們在更新協議說明方面付出了巨大的努力。Filecoin是一個巨大的項目。從透視的角度來看,如果將其印刷,該協議的規範將是一本約400頁的教科書!
Filecoin規範與實現無關,這意味著該文本很好地描述了使網絡正常運行的算法和協議交互,而沒有涉及實現細節。該規範提供了開發人員以任何語言實現Filecoin所需的所有必需詳細信息。僅在需要時提供對Lotus實現的引用。
測量進度
在為期3個月的Spec Project歷程中,開放了300多個GitHub問題,並合併了200多個PR。
如今,規範站點已更新了84%。為了跟蹤我們自己的進度以及站點和協議的「健康」狀態,我們結合了三種出色的工具:
1、明亮的儀錶板,以「不正確」、「在制品/草稿」,「可靠」和「穩定」的範圍顯示規範各部分的狀態。我們在spec markdown文件中集成了前端物質屬性,以將這些值自動輸入到儀錶板中,而無需執行任何其他操作。還值得注意的是,儀錶板是從ToC自動生成和更新的。無需編輯單獨的文件即可更新儀錶板!
2、「審核完成」指示符作為儀錶板的單獨列,以顯示協議的特定組件是否已被審核。如果有審計報告,則存在指向該報告(或以前的報告列表)的連結以及進行審計的日期。
3、穩定進度條,用於總結整個規範的狀態。
4、一個單獨的「實施狀態」儀錶板,其中包含所有不同Filecoin實現的狀態信息:Lotus,Fuhon,Forest和go-filecoin。儀錶板集成了掛鈎,以無縫地從相應的存儲庫中提取信息,並報告CI測試成功/失敗以及測試覆蓋率。
FIP整合
經過幾輪測試和兩次令人印象深刻的太空競賽之後,該協議現已進行了微調,可以開始發射了!從現在起,將通過Filecoin改進提案(FIP)對協議進行更改。建議對協議進行的更改必須經過明確指定的過程,該過程在FIP存儲庫中進行了詳細說明。
在大多數情況下,FIP將需要更新協議規範,因此,我們正在進行的工作之一包括將Filecoin Spec與FIP流程無縫集成。
下一步是什麼?
我們還集成了規範版本控制,以創建規範本身的Time Machine,以便您可以及時查看協議更新之前的規範。最後但同樣重要的是,我們正在集成工具以通過API代理從遠程源中提取數據。這將實現與FIP的無縫集成,但也將使我們能夠擴展儀錶板,使其包括「一致性測試」的狀態。
在兩輪太空競賽中,協議及其規範已取得重大進展,並進行了升級,因此,現在需要付出更多的努力才能將Filecoin的所有規格儀錶板單元塗成藍色(完成既定工作計劃)!我們計劃在接下來的幾周內擁有90%的可靠內容,並在接下來的幾個月內擁有100%的穩定內容。
END
註:本文內容僅供學習參考,不構成投資建議。如有任何疑問請加官方客服微信號HQAL001諮詢。