函数类型参考

函数的类型是通过添加装饰器的方式来完成，Vyper 中总共有 6 种装饰器，我们将它分为 3 类：可见性、可变性和重入锁。

1. 可见性

   • external: 用于标识外部函数，这类函数是合约接口的一部分，只能通过交易或从其他合约调用 ​

   • internal: 用于标识内部函数，内部函数只由同一合约内的其他函数中可访问，通常通过 self.f() 对象调用, f()为方法名 ​

2. 可变性

   • view: 表示函数是一个只读函数，可以读取但不修改合约状态

   • pure: 表示函数是一个pure函数，既不会读取也不修改合约状态

   • payable: 表示函数可以接收 ETH，可以读写合约状态. 只有标记为 @payable 的函数才能接收 ETH 转账

3. 重入锁

   • nonreentrant("key"): 用于防止函数的重入，当尝试从外部合约再次调用加锁的函数时，交易会回滚

函数基本结构

一个基本的函数定义包括函数名、参数列表（可选）和返回值（可选）

代码示例：

@external
def my_function(param: uint256) -> bool:
    ...

• @external: 外部函数修饰符

• def: 声明函数时的固定用法，与 Python 类似

• my_function: 函数名，代码风格遵循 Curve.fi 标准

• param: 函数的参数，可选的

• bool: 函数返回值，可选的

1. external & internal

代码示例：

num2: public(uint256)

@internal
def _internal_function(_new_num: uint256):
    self.num2 = _new_num

@external
def call_internal_function(_new_num: uint256):
    self._internal_function(_new_num)

示例中，我们定义了一个内部函数 _internal_function, 每次调用都更新 num2 的值，它只能由合约内部调用。然后我们再定义了一个外部函数 call_internal_function，用来调用内部函数 _internal_function

2. view & pure

• view 表示函数是一个视图函数，可以读取但不修改合约的状态。常用于获取合约的当前状态或计算结果，而不产生任何区块链上的状态变化

• pure 表示函数既不会读取也不会修改合约的状态。通常用于执行纯粹的计算或返回常量值 ​

• view 和 pure 都可以成为为内部函数和外部函数

代码示例：

num1: public(uint256)
num2: public(uint256)

@view
@external
def external_view_function() -> uint256:
    return self.num1

@view
@internal
def _internal_view_function() -> uint256:
    return 99

@view
@external
def view_internal_function() -> uint256:
    return self._internal_view_function()

@external
def call_internal_view_function():
    self.num2 = self._internal_view_function()

@pure
@external
def external_pure_function() -> uint256:
    return 100

3. payable

只有标记为 @payable 的构造函数或者功能函数才能接收 ETH 转账。特殊情况下不想要指定函数接收 ETH，那么可以使用 Vyper 的内置函数 __default__，使用 default 函数表示允许合约接收 ETH，用户可以直接往合约地址里转入 ETH

代码示例：

@payable
@external
def __init__():
    pass

@payable
@external
def receipt_eth():
    pass

@payable
@external
def __default__():
    pass

4. nonreentrant

nonreentrant 修饰符用于防止函数的重入，确保函数在同一交易中不会被重复调用, 非常重要的安全特性，尤其在处理资金交易时。

可重入锁可以分为两种状态: 激活和非激活。当调用标记 nonreentrant 的函数时，状态为：

• 确保不处于活动状态

• 函数设置为激活状态

一旦函数调用结束，状态为：

• 函数设置为非激活状态

通过这种机制，用户可以确保该函数只能在调用结束后才能重新调用，这意味着无论执行什么外部调用都不会发生重入。

代码示例

@nonreentrant("lock")
@external
def sensitive_function():
    pass

总结

在本节中，我们介绍了 Vyper 的函数类型。在开发合约过程中需要根据函数的用途和需要的安全级别来选择合适的类型。

我最近在重新学Vyper，巩固一下细节，也写一个“Vyper极简入门”，供小白们使用（编程大佬可以另找教程），每周更新1-3讲。

推特: @0x77

所有代码和教程开源在github: github.com/WTFAcademy/WTF-Vyper

Vyper 提供对两类变量类型的访问：

1. 值（Value）: 合约中变量的任何使用都将直接传递其值。

2. 引用（Reference）: 合约中变量的任何使用都将传递对内存中地址的引用，而不是值存储在那里。

本节中我们只介绍值类型，引用类型将在第 4 节中详细介绍。

值类型

1. 布尔型

   • bool: true 或 false

2. 数字 - 整型

   • int128: 有符号 128 位整数

   • int256: 有符号 256 位整数

   • uint8: 无符号 8 位整数

   • uint256: 无符号 256 位整数

3. 数字 - 浮点数

   • decimal: 带符号的浮点数，精度为 10 位小数

4. 地址

   • address: 20 字节的十六进制数，带有 0x 前缀。

5. 字节数组

   • bytes32: 32 字节数组，通常用于储存 256 位 keccak 哈希值

   • Bytes[N]: 可变长字节数组，N 是存储的最大字节数组的长度。

6. 字符串

   • String[N]: 保存字母数字字符串的可变长度字符串字节数组，其中 N 是存储的最大字符串的长度

常用的值类型

1. 布尔型

布尔值分为 True 和 False, 布尔值的运算和 Python 一致。在 Vyper 中使用 bool 对变量进行声明时值默认为 False。

is_bool: public(bool)

@payable
@external
def __init__():
    self.is_bool = True

布尔值的运算包括

• not x: 逻辑非

• x and y: 逻辑与

• x or y: 逻辑或

• x == y: 等于

• x != y: 不等于

代码示例：

bool1: bool = True
bool2: bool = not bool1

bool1 and bool2 -> False
bool1 or bool2 -> True
bool1 == bool2 -> False
bool1 != bool2 -> True

2. 整型

常用的整型包括

# 有符号的256位整数，包括负数
number: int256 = -1

# 无符号的256位正整数
number: uint256 = 123456

整型运算包括

• 比较运算符（返回布尔值）： ==, !=, <, >, <=, >=

• 算术运算符: +, -, *, /, **, %

• 按位运算符：&, |, ^, ~

• 移位运算符: <<, >>

Vyper 中，只有相同类型的变量才能进行运算，代码示例：

x: uint256 = 100
y: uint256 = 200

is_bool: bool = x < y
number: uint256 = x + y
number2: uint256 = x & y

3. 地址

Vyper 中的地址类型是一种基本的数据类型，用于存储一个 20 字节的以太坊地址，这些地址通常包括外部账户和合约账户。在 Vyper 中直接使用 address 关键字声明地址变量。

owner: public(address)

self.owner = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE

4. 字节数组

在 Vyper 中，字节数组是用于存储和处理字节序列的数据类型，具体分为定长字节数组(bytesN)和可变字节数组(Bytes[N])。

bytesN 这是一个 N 字节宽的字节数组, 比如 bytes32 是一个固定长度的 32 字节的字节数组。它通常用于存储 256 位的 keccak 哈希值、密钥和其他固定长度的加密数据。bytes4常用于存储函数选择器

代码示例

# 0x4f8b61438cf1d5e6f4f684d62bf496fc8975999b940392b49a2b70e209a69c12
bytes_value: bytes32 = keccak256("Vyper")

method: bytes4 = 0x01abcdef

Bytes[N] 是一个可变长度的字节数组，其中 N 定义了字节数组的最大长度。代码示例:

bytes_string: Bytes[100] = b"\x01"

5. 字符串

String[N] 是一个可变长度的字符串字节数组，其中 N 定义了字符串的最大长度。它是专门用于存储文本数据的类型，与 Bytes[N]类似，但更适合处理纯文本。

代码示例:

example_str: String[100] = "Hello Vyper!"

总结

在本节中，我们介绍了 Vyper 中的 5 种常用的值变量类型，如果想要了解更加详细的类型内容，可以在官方文档中查看。

我最近在重新学Vyper，巩固一下细节，也写一个“Vyper极简入门”，供小白们使用（编程大佬可以另找教程），每周更新1-3讲。

推特: @0x77

所有代码和教程开源在github: github.com/WTFAcademy/WTF-Vyper

Vyper简述

Vyper 是一种面向合约的类似于 Python 的编程语言，专为EVM设计。与Solidity不同，Vyper强调简单性和安全性，而Solidity则提供更多灵活性和复杂特性。

开发环境

与Solidity不同，Remix只支持Vyper 0.2.16 以下的版本，而最新版是Vyper 0.3.10，因此我们不得不转向其他开发环境。

这里，我们主要介绍两个开发环境

1. 本地开发（推荐），需要在本地安装Vyper和ApeWorx。

2. 浏览器IDE：链接

本地开发

1. 安装Vyper

使用 Docker 和 PIP 可安装Vyper。此处使用 PIP，其他安装方法见Vyper官方文档。

pip3 install vyper
# 或
pip3 install vyper==0.3.9

安装的Vyper版本取决于当前Python版本。

2. 安装ApeWorX

ApeWorX是一个与Vyper完全兼容的智能合约开发框架。另一框架brownie已停止更新。ApeWorX官网: ApeWorX。

pip3 install eth-ape

3. 安装插件

开发常用插件包括 hardhat 和 alchemy。使用alchemy需要本地设置key，详情见这里。

4. 初始化项目

ape init

ape-config.yaml 文件示例配置 以 ethereum-fork 为例的配置信息：

name: HelloVyper

plugins:
  - name: alchemy
  - name: etherscan
  - name: hardhat

default_ecosystem: ethereum

ethereum:
  default_network: mainnet-fork
  mainnet_fork:
    default_provider: hardhat
    transaction_acceptance_timeout: 99999999
  mainnet:
    transaction_acceptance_timeout: 99999999

hardhat:
  port: auto
  fork:
    ethereum:
      mainnet:
        upstream_provider: alchemy
        enable_hardhat_deployments: true

test:
  mnemonic: test test test test test test test test test test test junk
  number_of_accounts: 5

遇 PUSH0 错误时，在 ape-config 文件中添加：

vyper:
  evm_version: paris

编写第一个Vyper合约

我们的第一个Vyper合约非常简单，仅包含几行代码：

# @version 0.3.9

greet: public(String[12])

@payable
@external
def __init__():
    self.greet = "Hello Vyper!"

代码逐行分析：

1. 指定Vyper编译器版本 0.3.9 或 >=0.3.9。

2. 声明public变量greet：public(String[12])。

3. @payable 和 @external 装饰器。

4. __init__：合约的构造函数。

5. 设置 greet 变量的初始值。

编译并部署代码

在合约文件夹下输入命令进行编译：

ape compile

1. 进入 ape 控制台，部署到 ethereum-fork。

2. ape 分配测试账户并添加ETH：

from ape import accounts

accounts[0].balance += int(1e18)

contract = accounts[0].deploy(project.HelloVyper)

使用浏览器IDE开发

对于简单的合约，你可以在https://try.vyperlang.org/网站托管的jupyter notebook上进行开发。

首先，你需要导入boa包，它是一个Vyper解释器，支持在jupyter notebook中运行Vyper合约。

# 导入需要的包
import boa; from boa.network import NetworkEnv
%load_ext boa.ipython
from boa.integrations.jupyter import BrowserSigner

第二步，复制粘贴我们的Vyper合约。

%%vyper MyContract

greet: public(String[12])

@payable
@external
def __init__():
    self.greet = "Hello Vyper!"

第三步，部署Vyper合约，并赋值给合约变量c：

# 部署合约
c = MyContract.deploy()

最后一步，与部署好的合约c交互，读取greet变量的值，将输出'Hello Vyper!'。

# 对于public变量，可以通过合约实例直接访问
c.greet()

总结

这一讲，我们介绍了Vyper语言，它的开发环境，并编写和部署第一个合约 HelloVyper。后续我们将更深入的学习Vyper！