Starknet改進語法全解讀

StarkNet 中文｜2023-07-11 15:11

Cairo 編譯器的第2 版對Starknet 語法進行了更改，使代碼更加明確和安全。智能合約公共接口是使用特徵定義的，並且對存儲的訪問是通過ContractState 特徵完成的。私有方法必須使用與公共接口不同的實現來定義。事件現在定義為枚舉，其中每個變體都是同名的結構。

原文：Improved Starknet Syntax

翻譯及校對：「Starknet 中文社區」

Starknet改進語法全解讀

概要

免責聲明：此處使用的術語指的是Cairo 編譯器的不同版本，其語法是臨時的，因為Starknet 社區仍在討論哪些是最好用的術語。一旦確定，本文將進行相應更新。

The Compiler v2

就在上週，Cairo 編譯器的新的主要版本2.0.0-rc0 在Github 上發布。新的編譯器對Starknet 插件進行了重大改進，使我們的代碼更安全、更明確、更可重複使用。請注意， Starknet 測試網或主網尚不支持這個新版本的編譯器，因為它仍在集成環境中進行。

本文的目標是向您展示如何將為Cairo 編譯器版本1.x 創建的Starknet 智能合約重寫為與編譯器版本2.x 兼容的智能合約。我們的起點是上一篇文章中創建的Ownable 智能合約，它與Cario 編譯器版本1.x 兼容。

#[contract]mod Ownable {use starknet::ContractAddress;use starknet::get_caller_address;

#[event]fn OwnershipTransferred(previous_owner: ContractAddress, new_owner: ContractAddress) {}

struct Storage {owner: ContractAddress,}

#[constructor]fn constructor() {let deployer = get_caller_address();owner::write(deployer);}

#[view]fn get_owner() -> ContractAddress {owner::read()}

#[external]fn transfer_ownership(new_owner: ContractAddress) {only_owner();let previous_owner = owner::read();owner::write(new_owner);OwnershipTransferred(previous_owner, new_owner);}

fn only_owner() {let caller = get_caller_address();assert(caller == owner::read(), 'Caller is not the owner');}}

項目設置

由於Protostar 尚不支持編譯器v2，因此本文將依賴支持它的Scarb 預發行版本（版本0.5.0-alpha.1）。要安裝該特定版本的Scarb，您可以使用以下命令。

$ curl --proto '=https' --tlsv1.2 -sSf | bash -s -- -v 0.5.0-alpha.1

安裝完成後，驗證您是否獲得了正確的版本。

$ scarb --version>>>scarb 0.5.0-alpha.1 (546dad33d 2023-06-19)cairo:2.0.0-rc3()

現在可以創建一個Scarb 項目。

$ scarb new cairo1_v2$cdcairo1_v2

您應該得到如下所示的文件夾結構。

$ tree .>>>.├── Scarb.toml└── src└──lib.cairo

為了讓Scarb 編譯Starknet 智能合約，需要啟用Starknet 插件作為依賴項。

// Scarb.toml...[dependencies]starknet="2.0.0-rc3"

設置完成後，我們可以前往src/lib.cairo 開始編寫智能合約。

存儲與構造器

在Cairo 編譯器的版本2 中，智能合約仍然由帶有contract 屬性註釋的模塊定義，只是這次該屬性以定義它的插件的名稱命名，在本例中為starknet。

#[starknet::contract]mod Ownable {}

內部存儲仍然定義為一個必須稱為Storage 的結構，只是這次必須使用一個存儲屬性來註釋它。

#[starknet::contract]mod Ownable {use super::ContractAddress; #[storage]struct Storage {owner: ContractAddress,}}

為了定義構造函數，我們使用構造函數屬性來註釋函數，就像在v1 中所做的那樣，優點是現在函數可以具有任何名稱，不需要像v1 中那樣被稱為“構造函數”。儘管這不是必需的，但出於習慣，我仍然會將該函數稱為“構造函數”，但您可以以不同的方式調用它。

另一個重要的變化是，現在構造函數會自動傳遞對ContractState 的引用，該引用充當存儲變量的中介，在本例中為“所有者”。

#[starknet::contract]mod Ownable {use super::ContractAddress; #[storage]struct Storage {owner: ContractAddress,} #[constructor]fn constructor(ref self: ContractState) {let deployer = get_caller_address();self. owner.write(deployer);}}

請注意，寫入和讀取存儲的語法自v1 以來已發生變化。之前我們執行owner::write()，而現在執行self.owner.write()。這同樣適用於從存儲中讀取。

順便說一下，ContractState 這個類型不需要手動進入作用域，它已包含在前奏中。

公共方法

與Cairo 編譯器版本1 的一個重要區別是，現在我們需要使用帶有starknet::interface 屬性註釋的特徵來明確定義智能合約的公共接口。

use starknet::ContractAddress;

#[starknet::interface]trait OwnableTrait { fn transfer_ownership(ref self: T, new_owner: ContractAddress); fn get_owner(self: @T) -> ContractAddress;}

#[starknet::contract]mod Ownable { ...}

如果您還記得v1 中的原始代碼，我們的智能合約有兩個「公共」方法（get_owner 和transfer_ownership）和一個「私有」方法（only_owner）。這一特徵僅處理公共方法，而不依賴於「外部」或「視圖」屬性來表示哪個方法可以修改合約的狀態，哪個方法不允許。相反，現在通過參數self 的類型來明確這一點。

如果一個方法需要引用ContractStorage（一旦實現，通用T 就是這樣），該方法就能夠修改智能合約的內部狀態。這就是我們過去所說的“外部”方法。另一方面，如果一個方法需要ContractStorage 的快照，那麼它只能讀取它，而不能修改。這就是我們過去所說的“視圖”方法。

現在，我們可以使用關鍵字impl 為剛剛定義的特徵創建一個實現。請記住，Cairo 與Rust 的不同之處在於，實現是具備名稱的。

use starknet::ContractAddress;

#[starknet::interface]trait OwnableTrait { fn transfer_ownership(ref self: T, new_owner: ContractAddress); fn get_owner(self: @T) -> ContractAddress;}

#[starknet::contract]mod Ownable { ... #[external(v0)] impl OwnableImpl of super::OwnableTrait { fn transfer_ownership(ref self: ContractState, new_owner: ContractAddress) { let prev_owner = self.owner.read( ); self.owner.write(new_owner); }

fn get_owner(self: @ContractState) -> ContractAddress { self.owner.read() } }}

我們在定義智能合約的模塊內為我們的特徵創建了一個實現，將類型ContractState 作為通用類型T 傳遞，這樣就可以像構造函數那樣訪問存儲。

我們的實現用屬性external(v0) 進行註釋。屬性中的版本0 意味著選擇器僅從方法名稱派生，就像過去的情況一樣。缺點是，如果您為您的智能合約定義了另一個不同特徵的實現，並且兩個特徵碰巧對它其中一個方法使用相同的名稱，則編譯器會因為選擇器的重複而拋出錯誤。

該屬性的未來版本可能會添加一種新的方法來計算選擇器，以防止衝突，但目前還不能使用。目前，我們只能使用外部屬性的版本0。

私有方法

我們還需要為智能合約定義另一種方法，only_owner。此方法檢查調用它的人是否應該是智能合約的所有者。

因為這是一個不允許從外部調用的私有方法，所以不能將其定義為OwnableTrait（智能合約的公共接口）的一部分。相反，我們將使用generate_trait 屬性創建自動生成特徵的新實現。

...#[starknet::contract]mod Ownable { ... #[generate_trait] impl PrivateMethods of PrivateMethodsTrait { fn only_owner(self: @ContractState) { let caller = get_caller_address(); assert(caller == self.owner. read(), 'Caller is not the owner'); } }}

現在可以通過在需要的地方調用self.only_owner() 來使用only_owner 方法。

#[generate_trait] impl PrivateMethods of PrivateMethodsTrait { fn only_owner(self: @ContractState) { ... } }}

事件

在Cairo v1 中，事件只是一個沒有主體的函數，並用事件（event）屬性進行註釋，而在v2 版本中，事件是一個用相同屬性註釋的枚舉（enum），但現在使用派生（derive）實現了一些附加特徵。

...#[starknet::contract]mod Ownable { ... #[event] #[derive(Drop, starknet::Event)] enum Event { OwnershipTransferred: OwnershipTransferred, }

#[derive(Drop, starknet::Event)] struct OwnershipTransferred { #[key] prev_owner: ContractAddress, #[key] new_owner: ContractAddress, }}

事件枚舉的每個變體都必須是同名的結構體。在該結構中，使用可選的key 屬性定義想要發出的所有值，來通知系統我們希望Starknet 索引哪些值，以便索引器更快地搜索和檢索。在本例中，我們希望對兩個值（prev_owner 和new_owner）建立索引。

ContractState 特徵定義了一個發出方法，可以用來發出事件。

...#[starknet::contract]mod Ownable { ... #[external(v0)] impl OwnableImpl of super::OwnableTrait { fn transfer_ownership(ref self: ContractState, new_owner: ContractAddress) { ... self.emit (Event::OwnershipTransferred(OwnershipTransferred { prev_owner: prev_owner, new_owner: new_owner, })); } ... } ...}

通過這個最終功能，我們已經完成了Ownable 智能合約從v1 到v2 的遷移。完整代碼如下所示。

use starknet::ContractAddress;

#[starknet::interface]trait OwnableTrait { fn transfer_ownership(ref self: T, new_owner: ContractAddress); fn get_owner(self: @T) -> ContractAddress;}

#[starknet::contract]mod Ownable { use super::ContractAddress; use starknet::get_caller_address;

#[event] #[derive(Drop, starknet::Event)] enum Event { OwnershipTransferred: OwnershipTransferred, }

#[derive(Drop, starknet::Event)] struct OwnershipTransferred { #[key] prev_owner: ContractAddress, #[key] new_owner: ContractAddress, }

#[storage] struct Storage { owner: ContractAddress, }

#[constructor] fn constructor(ref self: ContractState) { let deployer = get_caller_address(); self.owner.write(deployer); }

#[external(v0)] impl OwnableImpl of super::OwnableTrait { fn transfer_ownership(ref self: ContractState, new_owner: ContractAddress) { self.only_owner(); let prev_owner = self.owner.read(); self.owner.write (new_owner); self.emit(Event::OwnershipTransferred(OwnershipTransferred { prev_owner: prev_owner, new_owner: new_owner, })); }

fn get_owner(self: @ContractState) -> ContractAddress { self.owner.read() } }

#[generate_trait] impl PrivateMethods of PrivateMethodsTrait { fn only_owner(self: @ContractState) { let caller = get_caller_address(); assert(caller == self.owner.read(), 'Caller is not the owner'); } }}

您也可以在Github 上找到這段代碼。