第四課 - 智能合約|Starknet開發實戰訓練營二期

TinTinLand
5粉絲
2024年12月17日
☄ 本次課程是由TinTinLand 、Starknet聯合Scaffold-Stark、Starknet中文社區 聯合推出
💎 免費報名進入共學群:https://wj.qq.com/s2/15087814/e3f3/
📱歡迎添加Adam(ID:WinniWinni1)加入技術社區,瞭解更多課程內容。
第四課- 智能合約:
00:00 課程介紹
00:25 安裝開發工具和依賴
05:08 實戰:開發一個合約並部署
—————————————————————
🏠 關注渠道
1️⃣ Discord: https://discord.gg/kmPnTDSFu8
2️⃣ Twitter: https://twitter.com/OurTinTinLand
3️⃣ Medium: https://medium.com/@tintin.land2021
4️⃣ Bilibili: https://space.bilibili.com/1152852334
大家好
歡迎來到Stacknet中文課程訓練營第四課
今天我們講合約
如何在Stacknet上開發合約
課程計劃包括兩個部分
首先
我們需要安裝開發編譯以及部署所需要的工具和依賴
然後我們跟着官方的Counter Workshop去開發一個合約
並部署到測試網
關於依賴的安裝
這裏是我們今天要安裝的工具
建議使用Mac
如果是Windows電腦的話
可以使用Windows Linux子系統
首先我們需要有Rust的環境
建議使用Rustup
Rust的安裝和管理是通過Rustup這個工具去管理的
如果已經安裝了Rustup
我們只需要運行Rustup update
去更新到最新的Rust的編譯環境
下面我們去驗證一下我們本地的Rust
Rustc-v
這是我本機已經安裝好的Rust的版本
用可以用Rustup update去更新
那麼接下來我們去安裝ASDF
ASDF是一個工具版本管理器
可以將工具的版本定義在一個文件
並且杆維件可以放到項目的存儲庫中與團隊共享
確保每個人都使用相同版本的工具
需要注意的是ASDF僅適用於Mac OS和Linux
確保我們本機已經安裝了Git
通過Git下載ASDF
那我的電腦上已經下載過了
接着根據你的系統去選擇如何去配置ASDF
那我用的是Mac
而新版的Mac使用的Cell是ZSH
我們往下看一下
在這兒ZSH
我們將這個腳本添加到這個文件當中
可以使用nano這個命令
可以看到我這兒已經添加了
這樣ASDF就安裝成功了
接着我們去安裝SCUB
SCUB是Caro的包管理器
SCUB會下載Caro包的依賴
編譯項目
並作爲其他工具
例如Stacknet Foundry和IDE處理代碼的入口
類似於Cargo對於Rust的作用
SCUB團隊維護了一個ASDF的官方插件
用於管理多個SCUB的安裝
那麼我們看一下SCUB如何安裝
首先利用sdf-plugin-add-scub去管理插件
然後通過listall這個命令
去查看所有SCUB的版本
那麼當前的最新版本是2.9.2
我們還可以利用asdf-list-scub
查看我們本機已經安裝的
那麼2.9.2我已經安裝過了
而且正在使用的就是這個版本
利用這個命令去安裝最新版本的SCUB
或者指定SCUB的版本
最後我們利用global這個命令
去全局默認的去使用SCUB的最新版本
這裏可以用scub-latest
或者是用2.2.2
那麼再看一下我們當前的版本
信號這裏指的就是我們全局在使用的版本
最後呢我們去安裝方嘴
Stacknet方嘴是用於開發Stacknet
智能合約的工具
它有助於編寫部署和測試智能合約
在文檔裏有提示
安裝Stacknet的方嘴需要有SCUB以及RUST
那麼安裝Stacknet方嘴的方式有兩個
我們可以安裝SN方嘴up
利用這個管理工具去安裝Stacknet方嘴
或者利用SDF
那我們用SDF去安裝試一下
首先還是要去添加Stacknet方嘴的插件
然後我們看一下Stacknet方嘴的版本
最新的是0.34.0
我們本機已經安裝好的Stacknet方嘴
是0.34.0是最新的
如果要安裝的話
我們就可以用SDFinstallStacknet方嘴
可以指定版本號去安裝
最後我們用SDFglobal去指定Stacknet方嘴
我們可以利用SNforce去檢查一下
是否配置成功
OK
這樣我們所有的依賴就安裝成功了
下面呢
我們跟着Content Workshop去學習如何編寫一個Stacknet智能合約
我們將分步創建一個Stacknet合約
並將其部署到Stacknet的測試網Supply
通過官方提供的Content Workshop
我們可以學習到如何創建簡單的Stacknet智能合約
實現公共的函數事件
以及如何訪問外部合約
還有集成外部合約的組件
首先我們需要將代碼克隆到我們本地
克隆到本地
進入到項目內部
看一下項目結構
然後瞭解一下我們需要做的事情
我們可以用Docker或者不用Docker
如果不用Docker的話
我們首先要安裝這些工具和依賴
有SDF, SCAP, Stacknet Foundry, Rust
還有OS Code
那麼這些我們都已經安裝成功了
下面的話我們跟着步驟
一步一步的去實現這個合約
第一步
第一步我們要檢出這個分支
目標是使用SCAP包管理器
初始化克隆的代碼庫中的項目結構
並啓用Stacknet Contracts編譯
需要使用SCAP初始化項目
並且將我們的包命名爲Workshop
在Source目錄下創建一個Carol文件
命名爲counter.carol
最後在lab.carol文件中刪除默認代碼
並定義我們的技術器模塊
也就是counter這個模塊
最後通過scap build這個命令
去驗證我們是否成功完成上述的步驟
首先
檢出到這個branch
用OS Code打開我們的代碼
用scap initial
指定名稱Workshop
初始化項目結構
可以看到True Versions這個文件裏面
指定了我們SCAP的版本是2.8.5
我們可以用最新的2.9.2把它改過來
然後Foundry的版本是
0.30.0
保存一下
再來運行命令
用默認的Stacknet Foundry
這樣我們這個Workshop package就初始化好了
下一步是在Source創建一個Carol文件
叫counter.carol
把這段提供的代碼複製進去
這裏我們定義了一個Module counter contract
然後利用Stacknet contract
去聲明它是一個合約類
合約內部我們創建了一個Storage結構體
來存持我們的合約狀態
然後我們看一下scaptomo這個文件
在這裏我們將要啓用Stacknet contract這個target
它將允許我們將包構建爲Stacknet contract
它搜索包中的所有合約類
併爲每個找到的類構建一個單獨的
已編譯的json文件
那我們添加target.stacknet.contract
這個target
我們還要聲明Stacknet的依賴
Stacknet等於
大約等於2.9.2
最後我們通過scapt build
去驗證上述的步驟是否成功完成
可以看到這裏有一個新創建的target文件夾
裏面是我們編譯後的Stacknet artifacts
接着我們來到第二步
切換到這個分支
目標是在scaptomo文件中
添加snforge作爲依賴項
允許使用Stacknet foundry執行測試
需求是在Stacknet tomo文件中
將snforge std這個包
聲明爲項目的依賴項
並啓用chasm的合約類生成
然後在scaptomo文件中
定義一個test腳本
以便運行snforge test的命令
最後在scaptomo文件中
將addition指向202301
完成上述步驟後
使用scaptest去進行驗證
先切換到新的分支
將當前分支的代碼
進行commit
然後切換
切換分支以後
記得去更新一下
TrueVersion裏面的版本號
當然我們也可以使用
workshop指定的版本
這樣我們就不需要
每次再切換到一個新的分支後
去更新這個版本號了
我們用sdf去安裝一下
這兩個版本
首先我們將snforge
聲明爲項目依賴
下面指明
指定snforge std
等於0.33.0
然後啓用chasm的
合約類層層
在這個下面
添加asm等於true
然後添加一個腳本
這樣當我們運行
scab test的時候
就會運行snforge test
最後我們再
將addition設置爲
2023-01
關於這個設置是
carol prelude的設置
prelude是常用的
模塊 函數 數據類型和特徵的集合
這些模塊 函數 數據類型和特徵
會自動納入carol create中的
每個模塊的範圍
而無需顯示的導入
prelude提供了開發人員
啓動carol程序和編寫
智能合約所需的基本構建塊
其中包括我們常見的數據類型
像總數型
多爾型 數組 字典等
還有一些算術運算符
像邏輯運算符
還有位運算符
以及一些實用的函數
在這裏我們根據提示的要求
選擇2023-01
好 最後我們運行
scab test
去驗證一下
因爲我們這兒使用的版本
變化了 所以這兒
我們也要改一下版本號
這樣可以看到測試已經通過
並且在我們運行test的時候
進行了重新的編譯
下面繼續我們第三步的開發
第三步需要切換到step3
這個分支 目標是
實現構造函數來
初始化輸入 並在合約中
存儲一個名爲counter的變量
需要是我們這個counter變量的
類型是
無符號整形的32位
並且要定義在storage
這個結構體中
在構造函數中使用
給定的數值去初始化counter
這個變量 構造函數中的
變量名爲initial value
最後通過scab test進行驗證
這裏提到的構造函數
是一種特殊類型的函數
僅在部署合約時
運行一次
可用於初始化合約的狀態
構造函數必須將self
作爲第一個參數
對應於合約的狀態
通常通過引用傳遞
使用ref關鍵詞
以便能夠修改合約的狀態
首先切換到新的分支
在counter.carrow文件當中
新建一個counter變量
類型爲32位的
無符號整形
下面寫構造函數
constructor
接收一個輸入變量
initial value
利用初始化counter的詞
self.counter.write
initial value
像我們剛纔講到的
構造函數只會運行一次
在合約部署的時候
並且我們這裏利用到了self
作爲第一個參數去修改合約的狀態
最後我們利用scab test
去測試一下
這裏有一個錯誤
我們忘記在
lab文件裏面去
聲明我們的新的合約
使用mode counter
再運行一下測試
好,測試通過
接着看第四步
需要切換到
step4這個分支
目標是爲包含
get counter
的函數實現一個接口
此函數應該返回合約中
存儲的counter的變量的值
get counter這個函數必須位於
icounter的合約接口內
最後使用scab test去
完成驗證,先切換到新的分支
在counter.taro文件中
新建一個
circle interface
我們把它命名爲
icounter
還有一個函數叫get
counter,返回的是
counter的值,定一個
self參數,下面我們去
實現這個接口
解釋一下我們的代碼
要創建接口,我們要
定一個命名爲icounter的特徵
並使用stocknet interface
屬性去標記該特徵
contract state我們使用的是
快召進行傳遞
僅允許對存儲變量進行讀取
訪問而不能修改它
編譯器會阻止直接通過
self進行任何
狀態修改,運行scab test
次次通過
我們看下一步
在step5這個分支
目標是在上一步中
創建的同一接口中
實現一個名爲
increase counter的函數
每次調用該函數,該函數都可以
將counter的值加1
需求是實現這個函數
並將其值加1
且increase counter這個函數
必須位於icounter的合約接口內
最後使用scab test
進行驗證
回到counter這個文件中
我們定一個新的函數
叫increase counter
它沒有任何返回值
它的參數是
contract state
且因爲它要去改變
合約的狀態
所以不能用快召
要用ref
要用ref這個關鍵字去聲明
下面我們去實現這個函數
increase counter
也稱爲web函數
它可以去更新
我們在storage中的值
contract state是通過ref
這個關鍵字去引用傳遞的
公開了對純屬變量的寫入權限
允許直接通過self
修改合約的狀態
我們還沒有切換到新的分支
OK,運行一下
OK,測試通過
看一下第六步
切換到w這個分支
我們先切換一下
然後目標呢
是實現一個名爲
counter increase的
事件
每當counter的變量的值增加的時候
該事件都會發出
該值,需求是在
invent美舉中定一個
名爲counter increase的變體
在該變體中
的結構中定義
value的變量,一旦counter值增加
就使用新值在
increase counter的函數中
發出事件,完成後使用
scalp test進行驗證
先定義invent的enum
變體是
counter increased
創建這個counter increased
還有一個
屬性稱爲value
最後使用self emit
去發出這個事件
我們定一個新的變量
用self
.emit
counter increased
事件
是智能合約向外界通報
其執行過程中發生的任何變化的
一種方式,它們在
智能合約與現實世界應用的
集成中起着至關重要的作用
接下來我們用scalp test
去進行測試,驗證成功
我們進入step7
首先需要切換到step7這個分支
目標是在此步驟中
我們引入一個web的智能合約
充當一個特定功能的
中指開關,任務是將
web的qswitch合約添加
爲項目的依賴項,需要是在
scalp tomo文件中將
qswitch包聲明爲
依賴,在scalp文件中需要
允許編譯web的合約
完成後使用scalp test進行
驗證,我們先切換到新的
分支,先添加
qswitch的依賴
然後在stagnet contract
這個target下面
允許該合約的編譯
在依賴下面
添加所需的包的名稱
運行scalp build
scalp將獲取新的依賴項
及所有的依賴,然後
它將使用這些包來
編譯你的包,勾籤的過程當中
下載指定的依賴
默認情況下
不會編譯依賴項中定義的
合約,因此我們需要使用
build external contracts
使其編譯依賴中的合約
它可以接受一個字符串的列表
每個字符串都對應
依賴項中定義的合約的
引用,最後運行scalp test
進行測試,好,測試通過
下面進入第八步
首先切換到
step8這個分支
step8的目標是通過將
給出的合約地址作爲輸入
變量,存儲在構造函數中
用來初始化qswitch的合約
存儲一個名爲qswitch的變量
更新構造函數以初始化
qswitch的變量
那麼在storage中
我們新增一個變量qswitch
它的類型是contractor
address
引入contractor address的類型
在構造函數中
初始化它的詞
叫qswitch
address
scalp.q
switch.
address
qswitch.address
最後通過scalp test
進行驗證
ok,測試通過
待不久,先切換到
這個分支
這一步的目標是通過
調用qswitch合約中的
isActive函數
來實現increase counter中的
qswitch機制
如果
qswitch合約中的函數isActive
返回false
則允許increase counter函數
遞增,否則不增加
這裏我們需要先把
qswitch的接口定義複製過來
看一下qswitch的
源碼
這裏可以看到
qswitch的代碼倉庫
那麼在source文件夾下
內部文件裏面
我們把qswitch的
接口定義複製過來
接着我們可以導入
qswitch的
dispatcher
下面我們在
increase counter函數里面
去調用qswitch的
isActive方法
如果isActive返回false
則允許該值加1
命名一個dispatcher變量
dispatcher
它的合約地址是
我們初始化的qswitch地址
如果
isActive
是false
則執行
下面的
數字更新
這裏我們導入了
qswitch的dispatcher和dispatcher trait
這些調度程序是由
編譯器自動創建和導出的
然後我們可以通過
qswitch dispatcher
合約調度程序去訪問
isActive函數
最後我們用scab test去
進行驗證
驗證成功
我們進入到下一步
首先切換到step10
該步驟的目標是
如果啓用了qswitch機制
則需要通過撤銷交易
來保護increase counter的功能
我們將在撤銷交易中
返回消息
qswitch isActive
撤銷交易
我們可以使用assert同
如果不滿足
則返回
消息
qswitch isActive
接着我們用scab test
進行測試
好,測試通過
我們看下一步
切換到step11認知
目標是將
open zeppelin合約添加爲項目中的
依賴項,需要在scab tomo文件中
將open zeppelin
聲明爲依賴項
這裏提示我們使用版本
0.19.0
好,那我們在scab tomo文件的
依賴下面
添加open zeppelin
等於0.19.0
進行scab test
測試
測試通過
我們看一下step12
首先切換到step12認知
step12的目標
是從open zeppelin合約初始化
ownable這個組件
組件封裝了可重複使用的邏輯
存儲和事件
可將其合併到多個合約中
它們可用於擴展合約的功能
並且不需要
重複實現相同的邏輯
組件是一個單獨的模塊
可以包含存儲事件和函數
與合約不同的是
組件無法聲明或部署
它的邏輯必須嵌入到
其他的合約內
可以跟着這個教程
去走一遍這個邏輯
首先我們要聲明一個component
這個宏
然後指定組件的路徑
合約的存儲指向組件的存儲
我們可以使用名字ownable
在你的合約內的
事件指向
組件中的事件
我們可以使用ownable event
首先呢我們先去引入
open zeppelin的這個ownable
component
然後使用component的宏
去聲明這個合約內部的組件
接着去寫impel
分別將
存儲和事件的
路徑添加到
storage和event當中
最後我們去調用
ownable這個component的方法
assert only owner
最後執行scalp test
測試通過
接下來我們看一下step 13
首先切換到相應的分支
目標是修改
構造函數以調用ownable組件
內的initializer函數
來初始化所有者
構造函數的輸入變量命名爲
initial owner
我們在構造函數內部
添加一個新的變量
initial owner
調用
ownable組件的
initial owner方法
這裏應該是
initializer方法
下面我們運行測試
測試通過
我們看一下step 14
step 14的目標
是保護increase counter
這個函數
以便只有合約的所有者才能調用它
需求是調用
ownable組件中的assert only owner
函數
那麼在increase counter
下面去調用ownable組件的
assert only owner這個函數
記得切換分支
使用scalp test測試
好
測試通過
我們看一下最後一個步驟
step 15
我們先切換到相應的分支
目標是使用
scripts文件中的deploy
ts腳本將賬戶合約
部署到stacknet的測試網
首先我們需要安裝elite
接着我們去
創建一個錢包
可以用argent或bravo
使用水龍頭
爲錢包充值
那今天我們用argent
去作爲演示
我已經在使用argent
創建了一個新的錢包地址
進入faucet
我們可以去水龍頭
領取一些代幣
作爲gatsby
或者是從以太坊的sapolia
橋接到我們的stacknet網絡上來
接着我們在
項目當中創建一個.in
把我們錢包的
私鑰固定在這個地方
還有我們的公鑰地址
以及一個公共的
RPC地址
在執行這個腳本之前我們去
確認一下在deploy.ts中
構造函數的值
在我們代碼中的
構造函數
參數是keoswitch.address
所以在deploy
這個地方要把keoswitch
改成我們定義的變量名
然後運行腳本
可以看到我們的
合約已經部署成功了
我們可以通過區塊瀏覽器
去檢查一下這個地址
切換到sapolia
這裏可以看到我們的合約
已經部署成功
並且可以從這裏去調用
合約比結讀取這個字
今天的課程就到這裏
我們下期課再見
