Sui开发人员备忘录

最新推荐文章于 2024-09-10 19:45:10 发布

Sui_Network

最新推荐文章于 2024-09-10 19:45:10 发布

阅读量195

点赞数

分类专栏： Sui 文章标签：安全区块链智能合约开发语言

本文链接：https://blog.csdn.net/Sui_Network/article/details/130487014

版权

Sui 专栏收录该内容

422 篇文章 4 订阅

订阅专栏

Sui是基于第一原理重新设计和构建而成的L1公有链，旨在为创作者和开发者提供能够承载Web3中下一个十亿用户的开发平台。Sui上的应用基于Move智能合约语言，并具有水平可扩展性，让开发者能够快速且低成本支持广泛的应用开发。Sui主网已于2023年5月3日正式上线。

本文将为开发人员在Sui Network上的最佳实践做快速参考。

Move

常规知识

阅读有关包升级的详细信息并编写对升级友好的代码

包是不可变的，有漏洞的包代码可以永远调用，解决方案是在对象层面添加保护。
如果将包从P升级到P’，依赖于P的其他包和客户端将继续使用P，而不是自动更新到P’。因此，依赖于包和客户端的代码都必须更新以明确地指向P’。
期望被依赖包扩展的包，可以通过提供符合所有版本标准的（不变的）接口，来避免每次升级时破坏它们之前的扩展。以Wormhole跨链桥为例，通过Wormhole作为桥梁发送消息，要想生成发送消息的扩展包，可以使用任意版本Wormhole包中的prepare_message指令来生成MessageTicket，而发送消息的客户端代码必须将该MessageTicket传递到最新版本包中的publish_message。
public函数不能删除或更改，但public(friend)函数可以。您可以自由地使用public(friend)或仅自己可见功能，除非您要将现在的库函数永远公开。
不能删除struct类型、不能添加新字段（尽管您可以添加动态字段）或通过升级新功能。添加新类型时请谨慎思考，一旦添加后将永远存在！

使用vector支持的集合（如vector、VecSet、VecMap、PriorityQueue），最多不超过1000个数据项。

使用动态字段支持的集合（如Table、Bag、ObjectBag、ObjectTable、LinkedTable）用于任何允许第三方添加的集合、更大的集合和未知大小的集合。
Sui Move对象最大为250KB — — 任何创建更大对象的尝试都将导致事务中止，请确保您的对象没有不断增长大过vector支持的集合。

如果您的函数f需要来自调用者的付款，例如使用SUI ，请使用fun f(payment: Coin<SUI>)函数而不是fun f(payment: &mut Coin<SUI>, amount: u64)函数。这对调用者来说更安全，因为他们可以准确地知道具体支付数额，并且不需要依靠函数f来提取正确的数额。

不需要小幅度优化gas消耗。在Sui上计算花费成本时，使用四舍五入的方法计算出其最接近的bucket，因此只有非常剧烈的波动才会导致gas的变化。特别是，如果您的交易已经在最低成本范围内，那就不能更便宜了。详情请参照下图。

遵循Move编码惯例（Move coding conventions）来获得统一的式样。

可组合性

使用display标准自定义您的对象在钱包、应用程序和浏览器中的显示方式。
避免使用“自我转移”功能 — — 任何时候都有可能，从当前函数返回obj，而不是写入transfer::transfer(obj, tx_context::sender(ctx))，这允许调用者或可编程交易块（programmable transaction block）使用obj。

测试

使用sui::test_scenario`模拟多次交易和多位发送者的测试场景
使用sui::test_utilsmodule通过assert_eq测试获得更好的纠错消息，通过print调试打印，以及通过destroy进行test-only销毁。
使用sui move test — coverage计算测试时代码覆盖的信息，使用sui move coverage source — module <name>查看以红色突出显示的未覆盖行。如果可行，建议将覆盖率设置为100%。

应用程序

为了获得最佳性能和数据一致性，应用程序应该在同一个全节点上提交写入和读取请求。在TS SDK中，这意味着应用程序应使用钱包的signTransactionBlock API，然后通过调用应用程序全节点上的execute_transactionBlock来提交交易，而不是使用钱包的signAndExecuteTransactionBlock API。这确保了先写后读的一致性 — — 从应用程序的全节点读取将立即反映事务的写入，而不是等待checkpoint。
为了降低延迟，如果您的应用程序需要知道交易已确认，但不需要立即查看交易效果或读取交易写入的对象/事件，请使用带有”showEffects”: false和”showEvents”: false的executeTransactionBlock。
应用程序应该将频繁读取的数据本地缓存，而不是从全节点频繁抓取。
尽可能地使用可编程交易块（programmable transaction blocks）来组合现有的链上功能，而不是发布新的智能合约代码。可编程交易块允许大规模批次处理和异构组合，进一步降低已经很低的gas费。
应用程序应该将对gas预算、gas价格和coin选择权留给钱包，这将为钱包提供了更大的灵活性，并且钱包有责任试运行交易以确保交易不会失败。

签名

永远不要签署两笔触及同一独享对象的并发交易，要么单独使用独享对象，要么等待一笔交易结束后再发送下一笔交易。违反此规则可能会导致客户端模棱两可，从而同时锁定两个交易中涉及的独享对象，直到当前epoch结束。
任何发起交易的sui client命令（例如sui client publish、sui client call）都可以接受 — serialize-output标志以输出要签名的base64交易。
Sui支持多种签名方案（signature schemes）进行交易签名，包括包括本机多重签名。