關於 enum value ，我們在網路上蒐集到這些相關的討論、資訊與評價

📜 [專欄新文章] 可升級合約介紹 - 鑽石合約（EIP-2535 Diamond standard）
✍️ Kimi Wu
📥 歡迎投稿： https://medium.com/taipei-ethereum-meetup #徵技術分享文 #使用心得 #教學文 #medium

Photo by Evie S. on Unsplash

前言

可升級合約簡單來說是透過 proxy contract（代理合約）來達成，藉由代理合約去呼叫欲執行的合約，若要升級，則把代理合約中的指向的地址換為新的合約地址即可。而執行的方式則是透過 delegateCall，但 delegateCall 不會更動目標合約的狀態。所以要怎麼處理變數，就是一門學問了。

舉例來說，contract B 有個變數 uint256 x，初始值為 0， 而 function setX(uint256)，可以改變 x 的值。proxy contract A 使用 delegatecall 呼叫 contract B 的 setX(10)，交易結束後，contract B中的 x 依然還是 0。

OpenZeppelin 提出了三種實作方式，可以做到可升級合約，細節可參考 Proxy Patterns，而最終的實作選用了 Unstructured Storage的這個方式，這種方式對於開發較友善，開發時不需特別處理 state variables（不過升級時就需要特別注意了）。而這篇主要是介紹 Diamond standard，OpenZeppelin 的可升級合約就不多做介紹。

USDC V2 : Upgrading a multi-billion dollar ERC-20 token 詳細地介紹代理合約跟變數儲存之間的關係，不了解升級合約的原理，建議先看看。

鑽石合約

名詞介紹

diamond：合約本體，是一個代理合約，無商業邏輯

facet：延伸的合約（實際商業邏輯實作的合約）

loupe：也是一個 facet，負責查詢的功能。可查詢此 diamond所提供的 facet與facet所提供的函式

diamondCut：一組函式，用來管理（增加/取代/減少）此 diamond合約所支援的功能

Loupe

直接來看 loupe的介面，從宣告就能很清楚暸解 diamond合約的實作方式，loupe宣告了一個結構 Facet，Facet結構包含一個地址及 function selector 陣列，所以我們只需要記錄一個 Facet陣列就可以得知這個 diamond 合約有多少個延伸合約及所支援的功能（loupe只定義結構，而實際變數是存在diamon合約中的）。也就是 diamond合約中只記錄延伸合約的地址及其支援的 function selectors，及少數 diamond合約的管理邏輯，並無商業邏輯，因此可以外掛非常非常多的合約上去（就像一個Hub），也就可以突破一個合約只有２４Ｋ的限制。

// A loupe is a small magnifying glass used to look at diamonds.interface IDiamondLoupe { struct Facet { address facetAddress; bytes4[] functionSelectors; } function facets() external view returns (Facet[] memory facets_); function facetFunctionSelectors(address _facet) external view returns (bytes4[] memory facetFunctionSelectors_); function facetAddresses() external view returns (address[] memory facetAddresses_); function facetAddress(bytes4 _functionSelector) external view returns (address facetAddress_);}

DiamondCut

至於 facet在 diamond合約上的註冊或是修改，就由 diamondCut負責，從以下程式碼可以清楚瞭解其功能（EIP中有規範，每次改變都需要發送DiamondCut事件）

interface IDiamondCut { enum FacetCutAction {Add, Replace, Remove} // Add=0, Replace=1, Remove=2 struct FacetCut { address facetAddress; FacetCutAction action; bytes4[] functionSelectors; } function diamondCut( FacetCut[] calldata _diamondCut, address _init, bytes calldata _calldata ) external; event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);}

Diamond合約

接下來就是最核心的部分 — diamond本體合約。以下是官方的範例，方法上跟 OpenZeppelin 一樣使用 fallback 函式跟 delegateCall 。

呼叫合約所不支援的函式，就會去執行 fallback 函式，fallback 函式中再透過 delegateCall 呼叫 facet 合約相對應的函式

fallback() external payable { address facet = selectorTofacet[msg.sig]; require(facet != address(0)); // Execute external function from facet using delegatecall and return any value. assembly { calldatacopy(0, 0, calldatasize()) let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0) returndatacopy(0, 0, returndatasize()) switch result case 0 {revert(0, returndatasize())} default {return (0, returndatasize())} }}

主要的差異在於變數的處理，OpenZepplin 是針對單一合約設計的代理合約（也就是每個合約都有自己的代理合約），所以無法處理單一代理合約儲存多個合約的變數（state variables）的狀況（後有圖例）。先由官方的範例程式來了解是怎麼處理變數的

在官方的範例中，都是以更改合約 owner 為例子

首先看到 DimaondStorage這個結構，結構中的前面三個變數都是在維持 diamond合約的運作（同上面loupe的範例），最後一個變數 contractOwner就是我們商業邏輯中所需的變數。
接著看到 function diamondStorage()，取變數的方式就跟OpenZeppelin 儲存特定變數方式一樣（EIP-1967），是把變數存到一個遠方不會跟其他變數碰撞到的位置，在這裡就是從 DIMOND_STORAGE_POSITION 這個 storage slot 讀取。
在實作上就可以有 LibDiamond1 ，宣告DIMOND_STORAGE_POSITION1=keccak256("diamond.standard.diamond.storage1") ，負責處理另一組的變數。藉由這種方式讓每個 facet合約有屬於自己合約的變數， facet合約間就不會互相影響。而最下方的 setContractOwner 是實際使用的範例。

library LibDiamond {

bytes32 constant DIAMOND_STORAGE_POSITION = keccak256("diamond.standard.diamond.storage");

struct FacetAddressAndSelectorPosition { address facetAddress; uint16 selectorPosition; }

struct DiamondStorage { mapping(bytes4 => FacetAddressAndSelectorPosition) facetAddressAndSelectorPosition; bytes4[] selectors; mapping(bytes4 => bool) supportedInterfaces; // owner of the contract address contractOwner; }

function diamondStorage() internal pure returns (DiamondStorage storage ds) { bytes32 position = DIAMOND_STORAGE_POSITION; assembly { ds.slot := position } }

function setContractOwner(address _newOwner) internal { DiamondStorage storage ds = diamondStorage(); address previousOwner = ds.contractOwner; ds.contractOwner = _newOwner; emit OwnershipTransferred(previousOwner, _newOwner); }

每個 library 處理了一組或多組變數的存取， facet 合約透過 library 對變數做操作。也就是把變數存在diamond主體合約，延伸的 facet合約只處理邏輯，是透過 library 去操作變數。

下面圖中清楚地解釋了 facet合約，function selectors 與變數之間的關係，從最左上這邊有個 facets 的 map，紀錄了哪個 selector 在哪個合約中，例如func1, func2是 FacetA的函式。左下角宣告了變數，每組變數的存取如同上述 library 的方式處理。

https://eips.ethereum.org/EIPS/eip-2535#diagrams

在 diamond的設計中，每個 facet合約都是獨立的，因此可以重複使用（跟library 的概念一樣）

https://eips.ethereum.org/EIPS/eip-2535#diagrams

小結

diamond合約使用不同的設計來達成合約的可升級性，藉由這種Hub方式可隨時擴充/移除功能，讓合約不再受限於24KB的限制，此外充分的模組化，讓每次升級的範圍可以很小。最後，因為跟library一樣只處理邏輯，並無狀態儲存，所以可以重複被不同的diamond合約所使用。

雖然又不少好處，也是有些缺點。首先，術語名詞太多，facet, diamondCut, loupe等等（其實還有好幾個，不過沒有介紹到那些部分，所以沒有寫出來）。開發上不直覺，把變數跟邏輯拆開，若要再加上合約之間的繼承關係，容易搞混，不易維護。最後，gas的花費，在函式的讀取、呼叫，變數的存取、傳遞都會有不少的額外支出。Trail of Bits 專欄中有點出更多的缺陷 Good idea, bad design: How the Diamond standard falls short，不過作者也有反擊 Addressing Josselin Feist’s Concern’s of EIP-2535 Diamond Standard，有興趣的讀者可以自行看看、比較。

為了模組化及彈性，diamond合約在設計上有點太複雜（over engineering），會造成可讀性越差（這點也是Vyper誕生的原因之一），而可讀性越差就越容易產生bug、也越不容易抓到bug，而在defi專案中，一個小小的bug通常代表著大筆金額的損失 😱😱😱。

雖然如此，筆者還是覺得很酷，有些設計的思維仍然可以使用在自己的專案

ref:
EIP 2535
Diamond 實作
Addressing Josselin Feist’s Concern’s of EIP-2535 Diamond Standard
OpenZeppelin upgradeable contract

可升級合約介紹 - 鑽石合約（EIP-2535 Diamond standard） was originally published in Taipei Ethereum Meetup on Medium, where people are continuing the conversation by highlighting and responding to this story.

👏 歡迎轉載分享鼓掌

[熱門文章] 程式設計、重構、與其它任何東西的終極問答

"The Ultimate Question of Programming, Refactoring, and Everything"
網頁版： http://goo.gl/6jIcIp
PDF 版： https://yadi.sk/i/pBZqebxsr5Wyg
#Craftmanships #SoftwareEngineering #CPP #Refactoring #ProgrammingSkills

好的！遲交比不交好，今天的推薦文來了（笑）～

今天介紹這篇，是過去一個禮拜在國外鄉民聚集地 Reddit 程式設計版瘋傳的文章。標題很臭屁「The Ultimate Question of Programming, Refactoring, and Everything」（沒錯！我就在意它最後一個字 "Everything"。咬我啊！ XD）。因為轉載的人實在太多，讓我不禁努力地把它看完了。

其實這篇文章講的是 C/C++ 程式寫作者應該注意、或建議遵守的 42 個小訣竅。既不「Ultimate（終極）」，也不是涵蓋「Everthing」。不過裡面還是有不少中肯的建議，所以我還是將它介紹給大家。

為了讓英文苦手的朋友也能稍微感受一下這篇文章在講什麼，所以我不負責任地快速翻譯了每個標題一下。如果對哪個主題有興趣的，就麻煩大家直接對照標題號碼去看原文解說。原文有些標題用「戲謔」或「隱晦」寫法，我若直接翻譯，大家可能不知道原作者想表達什麼。所以我會將某些標題，用比較易懂的中文重新表達。一切以「標題編號（1~42）」為準。

接下來就請享用我這個不負責任的翻譯了。有會錯原文意思的，還請各位留言在下方、然後鞭小力一點 XD。我會馬上修正的：

1. 不要去做編譯器會做的事情
如：用迴圈能存取 a[0] ~ a[9]，就不要用「拷貝貼上」a[0], a[1], a[2]..., a[9] 來存取裡面的內容值。

2. 大於 0 不代表它等於 1
若文件告訴你某函數執行成功會傳回「大於0」的值、但目前這個大於0的值是「1」。請你寫程式的時候不要自作聰明地偵測「傳回值 == 1」當成成功，請乖乖遵照規格書用「傳回值 > 0」等於成功。因為將來的版本有可能還會傳回 2, 3...等其他值。

3. 當你拷貝貼上一段程式碼，記得檢查它的副本兩遍
有時候你拷貝貼上一段程式碼，會忘了去修改裡面一些不同的小數字，導致花了大把時間去檢查錯誤到底出現在哪裡。

4. 小心使用「? :」運算子。並記得多加括號
「? :」是 C/C++ 內常用的運算子。若您寫了一段這樣的原始碼「a - b?0:1」，您可能以為它是這樣運作的「a - (b?0:1)」，事實上，它是這樣運作的「(a-b)?0:1」。結論是，多加括號保平安。

5. 多用市面上有的工具來分析您的原始碼
市面上有些工具，如：原始碼靜態分析工具、原始碼排列工具...可以幫您在把原始碼送入編譯器前，就抓到錯誤。不過作者也提到，別以為倚賴這些工具，錯誤就不會發生。真正要減少錯誤還是得靠多讀規格書，增加程式寫作經驗才辦得到。

6. 確認您所有的指標，都已經轉型成整數型態
作者擔心，某些使用 64 bits 當成指標變數寬度的系統，到 32 bits 的機器內重新編譯時，會產生高位元組被截斷的慘劇。某些編譯器提供「uintptr_t」這個專門給指標變數使用的型態，會隨著編譯器所在的環境，自動調整指標寬度。

7. 別在迴圈內呼叫「alloca()」這個函數
萬一迴圈失控，alloca() 函數會霸佔大量記憶體無法釋放。建議事先在迴圈外霸佔一大塊足夠的記憶體，然後在迴圈內慢慢蠶食之。

8. 在「解構函數（Destructor）」內使用「例外處理（Exception）」是很危險的！
作者認為，在負責釋放記憶體、收尾等工作的解構函數，還去霸佔新記憶體作事情是不好的。若真的發生例外（Exception），直接「吃掉（Supress）」不要讓它出現在使用者面前可能還比較好。

9. 若你要比對字串結尾，請用 '\0' 代表
有些程式設計師因為 '\0' 其實就是數字 0，而在比對字串結尾時，直接使用 0 來比對字串結尾。作者認為這個習慣不好。

10. 請勿濫用 # ifdef
# ifdef 很好用，但很容易讓原始碼雜亂難讀。作者不會建議大家不要用，但他反對連可以用 if ~ else 解決的場合，都濫用 # ifdef。

11. 別把一堆運算子全都擠在同一列
多分成幾列，Debugger 可以比較容易指出發生錯誤的是在哪個環節。

12. 當你「拷貝貼上」程式碼時，特別注意「最後一列效應」
作者還是不太建議濫用拷貝貼上，他認為需要重複使用一段程式碼，不如好好考慮寫成稍有彈性的函數，然後重複叫用。此外，他建議大家去看「最後一列效應」這篇文章（連結在本文），並了解最後一列效應在拷貝貼上程式碼內，所扮演的角色。

13. 程式碼若很長，盡量多折幾列，然後排成像表格般一樣整齊（Table-style）

14. 好編譯器 + 好的寫碼習慣是不夠的
內文舉了個後括號「)」括錯位置，但編譯器抓不出來的例子。

15. 若有一堆意義相關的常數，請用 enum 括住它們

16. 「看我能把程式碼寫得這麼屌！」的炫耀寫碼心態不可取
寫程式碼要以「穩」「易讀」為主，不是把一些剛學不久，覺得很酷，但三個月後會忘個精光的技術用進程式碼內。

17. 想用程式碼把一塊資料清乾淨，最好把清除程式碼獨立拉出來成一個專屬函數
18. 你在一個語言行得通的方法，在另一個語言不一定行得通
19. 盡量用技巧避免在同一個類別內，建構函數彼此呼叫的情況
20. 讀檔時，只檢查有沒有讀到檔尾（EOF）似乎是不夠的
21. 正確檢查 EOF 的方法
22. 有比使用 # pragma warning(...) 來印錯誤訊息更好的方法，勿濫用
23. 如果你想取得字串長度，用函數自動幫你算，別用手算然後硬填數字上去
24. 請多使用 "override" 與 "final"，它們會是你的好朋友
25. 別再把 "this" 指標跟 "nullptr"（空指標）拿來作比較
26. 小心使用 VARIANT_BOOL 這個陰險狡猾的東西
27. BSTR（Binary STRing）這個用於微軟 COM/Automation 技術中的資料型態，請小心使用
28. 能用函數把一段程式碼包起來重複用，就別用巨集包它（使用巨集函數的缺點多於優點）
29. 在迴圈或迭代程式碼間，使用 ++i，來取代 i++（i++ 編譯後的執行效能稍微差那麼一點）
30. wprintf() 函數的使用陷阱：Win32 印寬字元字串要用 %S（大寫），Win64 要用 %s（小寫）。
31. 陣列在 C/C++ 傳給函數時，並非是「傳值呼叫」（Call by Value）
32. 要把檔案內的文字直接印在螢幕上時，請不要直接使用 printf() （怕檔案內夾雜 % 開頭的字，這些字對 printf 是有特殊意義的）
33. 想對一個指標取值（亦即：*p），記得檢查它是否為 NULL。否則你對 NULL 取值會導致系統出錯的
34. 別以為 int 的上限 21億+ 很多，在 64 bits 系統中，這個數字很容易爆掉
35. 若您把 enum 常數與 switch~case 連用，增加新元素進 enum 時也別忘了加新 case 進 switch
36. 如果有怎麼抓都抓不出來的 bugs，記得往「記憶體」的方向去思考（32bits vs. 64bits 之類的問題）
37. 在 do~while() 內用 continue 指令要小心，有可能會跳過你放在底部的「更新條件」，導致無窮迴圈
38. 對於指標，請用 nullptr 代替 NULL，這是新的 C++ 規格書希望您遵循的
39. 試著別把一列式子搞得太複雜，這樣比較不會有「咦？為何這段寫錯的程式碼居然可以運作」的問題出現
40. 開始使用「原始碼靜態分析工具」吧！
41. 別為了要使用某函式庫的一個函式，而引進整個函式庫。如果只用了一個函式，建議自己寫比較容易維護。
42. 別再用 empty 這個曖昧的字眼當函數名稱了。用 erase(), clear() 都比 empty() 好。

如果您覺得小弟翻譯了這麼多，沒有功勞也有苦勞，那就麻煩按個讚犒賞小弟一下吧！當然歡迎轉發給您 Facebook 的朋友共同討論。最後提醒一句，上述 42 點別把它們全都當聖旨，親身體會驗證才是最重要的喔！

祝福大家假期愉快！

*** 列舉相同類型的選項可以用enum。Swift 的 enum 除了列舉，還可以設定 Raw Value，與Associated Value，甚至加入方法...
*** 完整線上中文 iPhone 開發教學： https://www.udemy.com/iphone-app-zh/?couponCode=thomasblog#/