Solidity及EVM开发工具介绍
这篇文章将介绍Ethereum开发者的一些实用工具:Foundry除了测试之外的功能及VSCode的SolidityVisualDeveloper插件
Photoby?DanCristianP?dure??on?UnsplashFoundry
Foundry除了提供合约开发、测试和部署,其实还有许多其他实用的功能。
安装Foundry
如果是Linux或macOS,先安装foundryup,接着直接用?foundryup?指令就可以安装。未来要升级foundry也只需要执行?foundryup?就好,非常简单直觉。
//Installfoundryup
curl-Lhttps://foundry.paradigm.xyz|bash
//InstallorupdateFoundry
foundryup
详细可以参考Foundrybook的Installation页面。
AutoCompletion
Foundry安装完后会有forge、cast及?anvil?三个指令,每个指令也都有许多option,这时有AutoCompletion会非常省事。例如产生bash用的AutoCompletionscript:
其他Shellscript的产生方式可以参考Foundrybook的ShellAutocompletion页面。
anvil
其实就和Ganache及?hardhatnode?一样:跑起一个节点。可以是全新的一个本地节点,也可以是背后连上ForkedState的节点。如果你平常都是习惯用来跑一个短暂的全新测试节点就直接下?anvil?即可。
如果你会想在一个ForkedState内实验或测试的话,多加上?--fork-url?和?--fork-block-number?的option。另外可以留意?--compute-units-per-second?这个option,它会控制每秒请求的计算量,避免取ForkedState太频繁导致遇到像是AlchemyRateLimit的问题。
更详细的节点设置可以参考Foundrybook的AnvilReference页面。
cast
cast是用来取链上资料非常好用的工具。因为有很多功能,这里我只会列出我常用及觉得实用的功能。
注:要读取链的状态记得要在foundry.toml档里附上endpointurl或透过?--rpc-url$URL?的方式。
首先是抓取交易资讯:
casttx/receipt:抓取交易或receipt资讯castrun:印出一笔已被收入的交易的executiontrace或进行livedebug,为了得到准确的交易前状态,预设会模拟执行同一区块里在该笔交易前面所有的交易,但这可能很耗时,如果只想看交易执行过程且不需要最精准的执行结果的话,可以加上--quickoption,它会跳过前面交易的模拟,直接把该笔交易当作区块的第一笔交易来执行注:castrun--debug的debug介面可能没有那么好读,如果不需要看到执行过程中的memory/stack/storage等细节时可以直接用ethtx.info或Tenderly,好读很多。
接着是从Etherscan抓取合约资讯:
castetherscan-source:会从Etherscan抓取指定地址的合约,可以加上-doption建立一个新的资料夹来放抓下来的合约们。记得用--etherscan-api-key?附上EtherscanAPIkey
注:如果想直接在浏览器开启VSCode环境来浏览、编辑合约的话,可以使用deth.net。还可以透过书签一键开启,非常方便,请参考这则twitter。
接着是encode/decodeABI的功能:
cast4b/4bd/4be:反查functionselector、calldata或是eventsignature。在手上只有一笔交易或一个event的rawdata时,可以透过这些工具来尝试找出它要执行什么函式或emit了什么eventcastcalldata:用functionsignature及参数组出calldata。在为多签检查或组calldata的时候很方便注:因为functionselector只有4bytes,如果多个functionsignature都是同一个functionselector的话,则反查会回传所有可能functionsignature
最后是一些转换或计算的小工具:
cast—-from-utf8/--to-ascii:在hex或字串之间转换castsig:计算functionselectorcastkeccak:计算keccakhashcastcompute-address:计算CREATE的地址
更多cast功能可以参考Foundrybook的castCommands页面。你可以从中按照你的需求找到对你有帮助的常用指令。
forgeinspect
forge的inspect指令则是用来挖出一个合约更进阶的资讯。它不是去拉链上的资料,而是作用在本地端的档案,所以如果你需要分析其他合约,你需要先把它下载下来。
forgeinspectMyContract...
注:在分析前?forge?会先编译合约,会花一些时间。
首先是列出合约基本资料的功能:
forgeinspectMyContractabi/bytecode/deployedBytecode:列出?MyContract的ABI/编译完的bytecode/实际部署到链上后的bytecode,方便exportABI或是比对部署在链上的bytecodeforgeinspectMyContractmethods/gas:列出?MyContract的function列表/每个function的预估gas消耗。用?cast4b/4bd?其实就能反查特定functionselector,这个功能比较像是能看到一个合约完整的function资讯forgeinspectMyContractstorage:列出?MyContract的storage,包含每个变数的storageslot和offset。但呈现的资料比较丑一点,可以改用slither来分析合约storage或读取合约变数的值,它还可以拉链上的合约来分析,不需要先下载合约下来。接下来是比较进阶的使用:irOptimized,主要是你想再优化你合约的gas消耗时可以采用的方式。
forgeinspectMyContractirOptimized
它会呈现你的合约编译成Yul后的长相。Yul就像assembly,它介于Solidity和EVMopcode之间,它可以让你看到你写的Solidityfunction背后实际上还做了哪些事情,如此你就可以开始删去一些不需要的检查。
这个工具是从这两则twitter发现到的,这边直接引用里面的范例和图片来搭配说明。以一个简单的将?number?变数递增的?Counter?合约为例,里面有一个?setNumber?函式用来设置?number?的值及一个?increment?函式用来把?number?加1。右边则是执行?forgeinspectCounterirOptimized?后所输出Yul版本的?Counter?合约:
source:?https://twitter.com/w1nt3r_eth/status/1579486967963693057
可以看到一个简单的Solidity合约编译完后变得复杂许多。接下来以?increment?函式为例:
source:?https://twitter.com/w1nt3r_eth/status/1579486967963693057
可以发现一个?number++?里面其实包含了很多检查,例如notpayable和overflow。但其实我们知道它只会以一次加?1?的方式递增所以几乎不可能会overflow,然后如果这个函式是可以接受ether的话,那就可以再省掉notpayable的检查:
source:?https://twitter.com/w1nt3r_eth/status/1579486967963693057
可以发现省去了许多执行步骤。
比起原地把Solidity程式码替换成assembly程式码这种比较冒险的优化方式,这是一个新的管道让你能重新完整地检视你的合约,并且可以看出修改前后的对比。但要注意还是以安全为优先,不要为了省一点的gas而拿掉你没有把握的程式码或检查。
其他forgeinspect功能可以参考Foundrybook的forgeinspect页面。
VSCode
最后是介绍一个在review合约时很实用的VSCode插件:SolidityVisualDeveloper
注:以下介绍会是个人使用心得,所以会有特色或功能是没有介绍到的。可以自己下载来试用看看,看能不能发现适合你的用途的功能。
SolidityVisualDeveloper-VisualStudioMarketplace
郑重声明: 本文版权归原作者所有, 转载文章仅为传播更多信息之目的, 如作者信息标记有误, 请第一时间联系我们修改或删除, 多谢。