Vyper语言模块系统详解：从基础使用到高级特性-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00335/article/details/148507844

Vyper语言模块系统详解：从基础使用到高级特性

vyper Pythonic Smart Contract Language for the EVM 项目地址: https://gitcode.com/gh_mirrors/vy/vyper

什么是Vyper模块

在Vyper智能合约语言中，模块是一组函数定义和变量声明的集合，它提供了一种代码复用的机制。与Solidity等语言不同，Vyper更倾向于通过组合(composition)而非继承(inheritance)来实现代码复用。模块可以封装从类型定义、函数声明到状态变量的所有内容，形成一个独立的可复用单元。

模块的基本使用

创建模块

在Vyper中，任何合约本身就是一个有效的模块。例如，下面是一个简单的所有权管理模块：

# ownable.vy

owner: address

@deploy
def __init__():
    self.owner = msg.sender

def _check_owner():
    assert self.owner == msg.sender

@pure
def _times_two(x: uint256) -> uint256:
    return x * 2

@external
def update_owner(new_owner: address):
    self._check_owner()
    self.owner = new_owner

这个模块提供了两个主要功能：

内部辅助函数_check_owner()用于验证调用者是否为所有者
外部函数update_owner()允许所有者更新合约所有权

导入模块

Vyper支持多种导入语法，以下是等效的导入方式：

import ownable                # 通过ownable访问
import ownable as ow          # 通过ow访问
from . import ownable         # 通过ownable访问
from . import ownable as ow   # 通过ow访问

对于纯函数(不依赖状态的函数)，可以直接使用：

import ownable as helper

@external
def my_function(x: uint256) -> uint256:
    return helper._times_two(x)

模块状态管理

模块初始化

要使用模块的状态变量，必须首先初始化模块。这通过initializes关键字实现：

import ownable

initializes: ownable

@deploy
def __init__():
    ownable.__init__()

@external
def my_access_controlled_function():
    ownable._check_owner()  # 只有owner可以调用
    # 其他操作...

初始化时需要注意：

模块的__init__()函数只能调用一次
模块状态变量通过模块名.变量名访问

作为接口使用

模块也可以作为接口使用，通过__at__语法：

import ownable

an_ownable: ownable.__interface__

def call_ownable(addr: address):
    self.an_ownable = ownable.__at__(addr)
    self.an_ownable.transfer_ownership(...)

高级模块特性

`uses`语句

uses语句允许模块使用另一个模块的状态而不直接初始化它，这种设计通常用于库开发：

# ownable_2step.vy
import ownable

uses: ownable

pending_owner: address

@deploy
def __init__():
    self.pending_owner = empty(address)

@external
def begin_transfer(new_owner: address):
    ownable._check_owner()
    self.pending_owner = new_owner

@external
def accept_transfer():
    assert msg.sender == self.pending_owner
    ownable.owner = new_owner
    self.pending_owner = empty(address)

带依赖的模块初始化

当模块有依赖关系时，需要使用特殊的:=语法：

import ownable
import ownable_2step

initializes: ownable
initializes: ownable_2step[ownable := ownable]

@deploy
def __init__():
    ownable.__init__()
    ownable_2step.__init__()

函数导出机制

Vyper中，外部函数不会自动包含在最终合约中，必须显式导出：

# 导出单个函数
exports: ownable_2step.transfer_ownership

# 导出多个函数
exports: (
    ownable_2step.transfer_ownership,
    ownable_2step.accept_ownership,
)

# 导出整个接口
exports: base_token.IERC20

# 导出模块所有外部函数
exports: ownable_2step.__interface__