Solidity 编码规范

已于 2024-02-28 16:41:03 修改
阅读量1.2k 收藏 18
点赞数 24
文章标签： 区块链
于 2024-02-28 16:36:21 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_28053637/article/details/136348627
版权
本文详细阐述了Solidity编程语言的编码规范，包括源文件编码、缩进规则、空行使用、代码行长度、函数和控制结构的格式、命名约定等，以提升代码质量和可维护性。
摘要由CSDN通过智能技术生成

本文目的是约定 solidity 代码的编码规范，保持代码的 一致性，方便阅读和理解。下面是官方推荐及总结的规范和风格。

另外本人也在找【合约开发】方面的工作，有公司内推的朋友可以和我说说哈

一、源文件编码格式

首选 UTF-8 或 ASCII 编码。

二、代码结构

缩进

        - 每个缩进级别使用4个空格。

制表符或空格

        -空格是首选的缩进方法。

        -应该避免混合使用制表符和空格。

空行

        在 solidity 源码中合约声明之间留出两个空行。

正确写法:

contract A {
    ...
}


contract B {
    ...
}


contract C {
    ...
}

错误写法:

contract A {
    ...
}
contract B {
    ...
}

contract C {
    ...
}

在一个合约中的函数声明之间留有一个空行。在相关联的各组单行语句之间可以省略空行。（例如抽象合约的 stub 函数）

正确写法:

contract A {
    function spam() public;
    function ham() public;
}


contract B is A {
    function spam() public {
        ...
    }

    function ham() public {
        ...
    }
}

错误写法:

contract A {
    function spam() public {
        ...
    }
    function ham() public {
        ...
    }
}

代码行的最大长度

将代码行的字符长度控制在 79（或 99）字符容易阅读代码。

折行时应该遵从以下指引：

  • 第一个参数不应该紧跟在左括号后边

  • 用一个、且只用一个缩进

  • 每个函数应该单起一行

  • 结束符号 ); 应该单独放在最后一行

函数调用

正确写法:

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3
);

错误写法:

thisFunctionCallIsReallyLong(longArgument1,
                              longArgument2,
                              longArgument3
);

thisFunctionCallIsReallyLong(longArgument1,
    longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1, longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3);

赋值语句

正确写法:

thisIsALongNestedMapping[being][set][to_some_value] = someFunction(    argument1,    argument2,    argument3,    argument4);

错误写法:

thisIsALongNestedMapping[being][set][to_some_value] = someFunction(argument1,
                                                                   argument2,
                                                                   argument3,
                                                                   argument4);

事件定义和事件发生

正确写法:

event LongAndLotsOfArgs(
    adress sender,
    adress recipient,
    uint256 publicKey,
    uint256 amount,
    bytes32[] options
);

LongAndLotsOfArgs(
    sender,
    recipient,
    publicKey,
    amount,
    options
);

错误写法:

event LongAndLotsOfArgs(adress sender,
                        adress recipient,
                        uint256 publicKey,
                        uint256 amount,
                        bytes32[] options);

LongAndLotsOfArgs(sender,
                  recipient,
                  publicKey,
                  amount,
                  options);

三、Imports 规范

Import 语句应始终放在文件的顶部

import "owned";


contract A {
    ...
}


contract B is owned {
    ...
}

四、函数顺序

排序有助于识别他们可以调用哪些函数，并更容易地找到构造函数和 fallback 函数的定义。

函数应根据其可见性和顺序进行分组：

  • 构造函数

  • fallback 函数（如果存在）

  • 外部函数

  • 公共函数

  • 内部函数和变量

  • 私有函数和变量

在一个分组中，把 view 和 pure 函数放在最后。

正确写法:

contract A {
    function A() public {
        ...
    }

    function() public {
        ...
    }

    // 外部函数
    // ...

    // 外部的view函数
    // ...

    // 外部的pure函数
    // ...

    // 公共函数
    // ...

    // 内部函数
    // ...

    // 私有函数
    // ...
}

五、表达式中的空格

在以下情况下避免无关的空格：

除单行函数声明外，紧接着小括号，中括号或者大括号的内容应该避免使用空格。

正确写法:

spam(ham[1], Coin({name: "ham"}));

错误写法:

spam( ham[ 1 ], Coin( { name: "ham" } ) );

除外:

function singleLine() public { spam(); }

赋值或其他操作符两边多于一个的空格：

正确写法:

x = 1;y = 2;long_variable = 3;

错误写法:

x             = 1;
y             = 2;
long_variable = 3;

fallback 函数中不要包含空格

正确写法:

function() public {
    ...
}

错误写法:

function () public {
    ...
}

六、控制结构

用大括号表示一个合约，库、函数和结构。对于控制结构 if， else， while， for 的实施同样的建议。

  •  开括号与声明应在同一行。

  •  闭括号在与之前函数声明对应的开括号保持同一缩进级别上另起一行。

  •  开括号前应该有一个空格。

正确写法:

contract Coin {
    struct Bank {
        address owner;
        uint balance;
    }
}

错误写法:

contract Coin
{
    struct Bank {
        address owner;
        uint balance;
    }
}

对于控制结构， 如果 其主体内容只包含一行，则可以省略括号。

正确写法:

if (x < 10)
    x += 1;

错误写法:

if (x < 10)
    someArray.push(Coin({
        name: 'spam',
        value: 42
    }));

对于具有 else 或 else if 子句的 if 块， else 应该是与 if 的闭大括号放在同一行上。这一规则区别于 其他块状结构。

正确写法:

if (x < 3) {
    x += 1;
} else if (x > 7) {
    x -= 1;
} else {
    x = 5;
}


if (x < 3)
    x += 1;
else
    x -= 1;

错误写法:

if (x < 3) {
    x += 1;
}
else {
    x -= 1;
}

七、函数声明

对于简短的函数声明，建议函数体的开括号与函数声明保持在同一行。

闭大括号应该与函数声明的缩进级别相同。

开大括号之前应该有一个空格。

正确写法:

function increment(uint x) public pure returns (uint) {
    return x + 1;
}

function increment(uint x) public pure onlyowner returns (uint) {
    return x + 1;
}

错误写法:

function increment(uint x) public pure returns (uint)
{
    return x + 1;
}

function increment(uint x) public pure returns (uint){
    return x + 1;
}

function increment(uint x) public pure returns (uint) {
    return x + 1;
    }

function increment(uint x) public pure returns (uint) {
    return x + 1;}

严格地标示所有函数的可见性，包括构造函数。

正确写法:

function explicitlyPublic(uint val) public {    doSomething();}

错误写法:

​​​​​​​

function implicitlyPublic(uint val) {    doSomething();}

函数的可见性修饰符应该出现在任何自定义修饰符之前。

正确写法:​​​​​​​

function kill() public onlyowner {    selfdestruct(owner);}

错误写法:​​​​​​​

function kill() onlyowner public {    selfdestruct(owner);}

对于长函数声明，建议将每个参数独立一行并与函数体保持相同的缩进级别。闭括号和开括号也应该 独立一行并保持与函数声明相同的缩进级别。

正确写法:

function thisFunctionHasLotsOfArguments(
    address a,
    address b,
    address c,
    address d,
    address e,
    address f
)
    public
{
    doSomething();
}

错误写法:

function thisFunctionHasLotsOfArguments(address a, address b, address c,
    address d, address e, address f) public {
    doSomething();
}

function thisFunctionHasLotsOfArguments(address a,
                                        address b,
                                        address c,
                                        address d,
                                        address e,
                                        address f) public {
    doSomething();
}

function thisFunctionHasLotsOfArguments(
    address a,
    address b,
    address c,
    address d,
    address e,
    address f) public {
    doSomething();
}

如果一个长函数声明有修饰符，那么每个修饰符应该下沉到独立的一行。

正确写法:

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public
    onlyowner
    priced
    returns (address)
{
    doSomething();
}

function thisFunctionNameIsReallyLong(
    address x,
    address y,
    address z,
)
    public
    onlyowner
    priced
    returns (address)
{
    doSomething();
}

错误写法:

function thisFunctionNameIsReallyLong(address x, address y, address z)
                                      public
                                      onlyowner
                                      priced
                                      returns (address) {
    doSomething();
}

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public onlyowner priced returns (address)
{
    doSomething();
}

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public
    onlyowner
    priced
    returns (address) {
    doSomething();
}

八、变量声明

数组变量的声明在变量类型和括号之间不应该有空格。

正确写法:

uint[] x;

错误写法:

uint [] x;

九、其他建议

    字符串应该用双引号而不是单引号。

正确写法:​​​​​​​

str = "foo";str = "Hamlet says, 'To be or not to be...'";

错误写法:

str = 'bar';str = '"Be yourself; everyone else is already taken." -Oscar Wilde';

操作符两边应该各有一个空格。

正确写法:

x = 3;
x = 100 / 10;
x += 3 + 4;
x |= y && z;

错误写法:

x=3;x = 100/10;x += 3+4;x |= y&&z;

为了表示优先级，高优先级操作符两边可以省略空格。这样可以提高复杂语句的可读性。

你应该在操作符两边总是使用相同的空格数：

正确写法:​​​​​​​

x = 2**3 + 5;x = 2*y + 3*z;x = (a+b) * (a-b);

错误写法:​​​​​​​

x = 2** 3 + 5;x = y+z;x +=1;

十、命名规范

为了避免混淆，下面的名字用来指明不同的命名方式。

  • b (单个小写字母)

  • B (单个大写字母)

  • lowercase （小写）

  • lower_case_with_underscores （小写和下划线）

  • UPPERCASE （大写）

  • UPPER_CASE_WITH_UNDERSCORES （大写和下划线）

  • CapitalizedWords  (驼峰式，首字母大写）

  • mixedCase (混合式，与驼峰式的区别在于首字母小写！)

  • Capitalized_Words_With_Underscores (首字母大写和下划线)

合约和库名称

合约和库名称应该使用驼峰式风格。比如：

SimpleToken，

SmartBank，

CertificateHashRepository，

Player。

结构体名称

结构体名称应该使用驼峰式风格。比如：MyCoin，Position，PositionXY。

事件名称

事件名称应该使用驼峰式风格。比如：Deposit，Transfer，Approval，BeforeTransfer，AfterTransfer。

函数名称

函数名称不同于结构，应该使用混合式命名风格。比如：getBalance，transfer，verifyOwner，addMember，changeOwner。

函数参数命名

函数参数命名应该使用混合式命名风格。比如：initialSupply，account，recipientAddress，senderAddress，newOwner。在编写操作自定义结构的库函数时，这个结构体应该作为函数的第一个参数，并且应该始终命名为 self。

局部变量和状态变量名称

使用混合式命名风格。比如：totalSupply，remainingSupply，balancesOf，creatorAddress，isPreSale，tokenExchangeRate。

常量命名

常量应该全都使用大写字母书写，并用下划线分割单词。比如：MAX_BLOCKS，TOKEN_NAME，TOKEN_TICKER，CONTRACT_VERSION。

修饰符命名

使用混合式命名风格。比如：onlyBy，onlyAfter，onlyDuringThePreSale。

枚举变量命名

在声明简单类型时，枚举应该使用驼峰式风格。比如：TokenGroup，Frame，HashStyle，CharacterLocation。

避免命名冲突

  • single_trailing_underscore_

当所起名称与内建或保留关键字相冲突时，建议照此惯例在名称后边添加下划线。

solidity编码规范
我不是大牛
08-13 1145
命名规范 文件、合约、库、事件、枚举及结构体命名 当文件里只包含一个合约时，文件命名应该与合约命名相同。 当文件里包含不只一个合约时，文件命名应该根据项目内容合理命名。 合约、库、事件及结构体命名应该使用单词首字母大写的方式，这个方式也称为：驼峰式命名法，比如：SimpleToken， SmartBank， CertificateHashRepository，Player。 函数...
Solidity编码规范
FingerNFT的博客
10-17 1740
1、命名规范 避免使用 小写的L，大写的I，大写的O 应该避免在命名中单独出现，因为很容易产生混淆。 合约、库、事件、枚举及结构体命名——大驼峰 合约、库、事件及结构体命名应该使用单词首字母大写的方式。 比如：SimpleToken， SmartBank， CertificateHashRepository，Player。
Solidity代码规范（官方建议）
Metaverse
01-04 2440
Style Guide The goal of this guide is not to be the right way or the best way to write solidity code. 本指南的目标并不是编写稳定性代码的正确方法或最佳方法。 1. 在一个solidity源文件中，合约与合约（或库、接口等）空两行。 // SPDX-License-Identifier: GPL-3.0 pragma solidity >=0.4.0 <0.9.0; contract A {
模拟第一部分5
Baicon的博客
12-02 1531
go
Solidity 代码安全和质量标准
08-22 165
Solidity 代码安全和质量标准 常规审查方法 阅读项目的文档、规范和白皮书，了解智能合约的作用。 在查看代码之前，先构建一个期望中的合约架构模型。 快速浏览一遍合约，感受项目架构，可以利用Surya这类工具。 将项目架构与期望中的合约架构模型进行比较，仔细检查不符合预期的部分。 创建威胁模型并列出理论上的高级攻击向量。 查看与价值交换相关的地方，尤其是transfer，transferFrom，send，call，delegatecall，和 selfdestruct。优先检查它们，确保安全。 查看
Solidity之文件结构
程序员大凯的博客
05-16 757
在正式开始之前，我们先来了解一下Solidity这门语言。 Solidity占据现有的智能合约编程语言的榜首。虽然目前智能合约编程的前沿已经转向Web Assembly，但是在可预见的将来，Solidity仍将在智能合约编程领域占有举足轻重的地位。Solidity的文件后缀名为.sol。 一个完整的sol文件由以下六部分组成 编译开关“pragma solidity ^0.4.20”表明编译器版本要高于0.4.20才可以编译。“ ^ ”表明如果编译器版本低于0.4.20，那么不可编译。我们也可以指定编译器的
solidity编程规范
mongo_node的专栏
04-30 755
编程规范 概述 本指南用于提供编写Solidity的编码规范，本指南会随着后续需求不断修改演进，可能会增加新的更合适的规范，旧的不适合的规范会被废弃。 当然，很多项目可能有自己的编码规范，如果存在冲突，请参考项目的编码规范。 本指南的结构及规范建议大都来自于python的pep8编码规范。 本指南不是说必须完全按照指南的要求进行solidity编码，而是提供一个总体的一致性要求，这个...
Solidity高级教程：编码规范与合约开发技巧
"solidity进阶学习文档涵盖了编码规范、合约开发技巧、合约升级思路、底层代码调用、外部调用以及工厂设计模式等关键知识点，适用于深入理解以太坊区块链上的智能合约开发。" 在深入学习Solidity时，遵循良好的编码...
智能合约最佳实践 之 Solidity 编码规范
曾经的你_的博客
06-01 211
..
dapper_solidity
05-10
5. **最佳实践**：遵循的Solidity编码规范和最佳实践，如避免使用suicide指令，使用SafeERC20接口等。 6. **交互接口**：可能有一个简单的前端界面，通过JavaScript（标签所示）与智能合约进行交互。 7. **版本...
Solidity格式
weixin_42094659的博客
03-08 292
合约之间间隔 在 solidity 源码中合约声明之间留出两个空行。 contract A { ... } contract B { ... } contract C { ... } 在一个合约中的函数声明之间留有一个空行。在相关联的各组单行语句之间可以省略空行。（例如抽象合约的 stub 函数）。 pragma solidity ^0.6.0; abstract contract A { function spam() public virtual pu
智能合约编程语言-solidity快速入门（下）
weixin_34406061的博客
02-19 273
上一篇：智能合约编程语言-solidity快速入门（上） solidity区块及交易属性 在介绍区块及交易属性之前，我们需要先知道solidity中自带了一些全局变量和函数，这些变量和函数可以认为是solidity提供的API，这些 API 主要表现为Solidity 内置的特殊的变量及函数，它们存在于全局命名空间里，主要分为以下几类： 有关区块和交易的属性 ABI编码函数 有关错误处理 有关...
Solidity语法规范整理
热门推荐
taojin12的博客
08-16 1万+
一、Solidity 是什么 Solidity是一门面向合约的、为实现智能合约而创建的高级编程语言。这门语言受到了C++，Python和JavaScript语言的影响，设计的目的是能在以太坊虚拟机(EVM）上运行。 Solidity 是静态类型语言，支持继承、库和复杂的用户定义类型等特性。 内含的类型除了常见的编程语言的标准类型，还包括address等以太坊独有的类型，Solidity源码文件通常以sol作为扩展名。 目前尝试Solidity编程最好的方式是使用Remix。Remis是一个基于Web
prettier-plugin-solidity：用于Solidity的更漂亮的插件
02-05
更漂亮的插件坚固性 一个用于自动格式化您的代码。 如果您喜欢这个项目，请考虑为我们的捐款捐款！ 安装及使用 安装prettier和prettier-plugin-solidity ： npm install --save-dev prettier prettier-plugin-solidity 在您的合同中更漂亮： npx prettier --write 'contracts/**/*.sol' 您可以添加脚本以在所有合同上运行更漂亮的脚本： "prettier": "prettier --write 'contracts/**/*.sol'" 或者，您可以将其用作衬里的一部分，
使用编译器——Solidity中文文档（8）
HiBlock的博客
08-03 666
写在前面：HiBlock区块链社区成立了翻译小组，翻译区块链相关的技术文档及资料，本文为Solidity文档翻译的第八部分《使用编译器》，特发布出来邀请solidity爱好者、开发者做公开的审校，您可以添加微信baobaotalk_com，验证输入“solidity”，然后将您的意见和建议发送给我们，也可以在文末“留言”区留言，有效的建议我们会采纳及合并进下一版本，同时将送一份小礼物给您以示感...
区块链研究实验室|Solidity Linting和Formatting的使用教程
baidu_39383304的博客
08-29 376
​ 以太坊开发人员社区开始开发一些非常棒的工具，让我们更加接近自动化的工作流和开发人员的“cockpit”，例如我们现在使用的比较成熟的语言：javascript或go。 其中有两个工具是触及了开发人员工作流程最核心的部分编写代码： •linters自动分析代码是否存在可能的编程样式错误（常见示例：eslint for javascript） •Formatters根据预定义的规则和缩进默认值自动...
【Solidity】8. 杂项 - 深入理解Solidity
weixin_33762130的博客
09-18 428
索引 【Solidity】1.一个Solidity源文件的布局 【Solidity】2.合约的结构体 【Solidity】3.类型 【Solidity】4.单位和全局可变量 【Solidity】5.表达式和控制结构 【Solidity】6. 合约 【Solidity】7. 部件 【Solidity】8. 杂项 ...
Lumoz主网启航：为ETH3.0、ZK和AI提供无穷算力
QiJublockchain的博客
12-18 654
而兼具模块化算力和RaaS双重优势的Lumoz，目前市值虽为2753.6万美元，但凭借其灵活、高效和低成本的特点，以及技术与市场的独特定位，Lumoz的增长潜力不容小觑。在算力方面，为以太坊3.0的到来提供更高效的解决方案，在RaaS方面，将大力提升「一键发链」的能力，为生态开发者提供更加完善的发链服务。12 月9日，Lumoz主网的正式上线为生态系统注入了强大的潜力，并为未来的技术发展、市场拓展和社区建设提供了坚实的基础，开启了项目长期价值体现的新纪元。AI领域的算力需求呈现出多样化和高频次的特点。
加密货币地址的基本概念
最新发布
2301_77604523的博客
12-22 331
在日常生活中，地址可能指房屋、电子邮件或Bitget官网的位置，用来精确定位在系统中的特定位置或端点。在加密货币领域，地址也起着类似的基础作用，只不过是在数字环境中。加密货币地址是区块链网络中使用的唯一标识符，用于方便加密货币的发送和接收。它由一串字母数字字符组成，是交易的数字目的地。每个地址都与区块链上的一个特定钱包相对应，并且是公开的，任何人都可以查看与之相关的交易历史，但除非另行披露，否则所有者的身份仍然是匿名的。这种地址的功能类似于银行账号，可确保资金在区块链的去中心化框架内安全地在各方之间转移。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值
>