From 006b6cd56ba4d0f9679f69caf8ed1b1806521259 Mon Sep 17 00:00:00 2001 From: Passi0n1 <181446367+Passi0n1@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:31:19 +0800 Subject: [PATCH] Update Passi0n1.md --- Passi0n1.md | 311 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 311 insertions(+) diff --git a/Passi0n1.md b/Passi0n1.md index 9d4ff361..ed3cdc15 100644 --- a/Passi0n1.md +++ b/Passi0n1.md @@ -1324,5 +1324,316 @@ function flash( - **balance 0 After** 这个默认情况下会给人造成一个误解会让认为是对于每个客户的一个金额变化的记录工具，实际不是这样的。因为本身这种 flash 是原子性的，一个交易内借出，一个交易内换回去，所以这个的金额是整体的全局金额进行了。 + +### 2024.10.16 +#### 学习笔记 + + +## 代理合约如何运行 + +代理合约就存在数据，而逻辑合约作为实际合约运行各种程序。 + +image + + + +~~合约既然是固定的，那么怎么修改 delegate 指向的的合约~~ WTF 这里，给的代码不够全面，只给了一个 `fallback` 函数的实现。 + +## 代理合约的框架 +```solidity +// SPDX-License-Identifier: MIT + +pragma solidity >=0.4.22 <0.9.0; + + + +contract Proxy { + +// 存储地址的状态变量，它将用于引用我们的逻辑合约。 + +address internal _implementation; + + + +function implementation() public view returns (address) { + +return _implementation; + +} + + + +// 提供一个构造函数，以便我们在部署代理时可以设置逻辑合约的地址。 + +constructor(address implementation_) { + +_implementation = implementation_; + +} + + + +// 代理合约包含一个fallback函数。它是一个无名函数，当代理合约收到一个外部调用无法匹配的函数名时，这个函数会被触发。 + +fallback () external payable { + +address localImpl = _implementation; + +assembly { + +let ptr := mload(0x40) + +calldatacopy(ptr, 0, calldatasize()) + +let result := delegatecall(gas(), localImpl, ptr, calldatasize(), 0, 0) + +let size := returndatasize() + +returndatacopy(ptr, 0, size) + + + +switch result + +case 0 {revert(ptr, size)} + +default {return(ptr, size)} + +} + +} + +} +``` + + + + + +因为 `implementation` 变量用来存放不同的逻辑合约，所以每次都可以通过部署新的逻辑合约来实现合约的升级 +```solidity +contract Proxy { + address public implementation; // 逻辑合约地址。implementation合约同一个位置的状态变量类型必须和Proxy合约的相同，不然会报错。 + + /** + * @dev 初始化逻辑合约地址 + */ + constructor(address implementation_){ + implementation = implementation_; + } +``` + + + +## 代理合约&可升级合约 +这两部分的概念不应该分开记忆，这两块是一个整体。可升级合约是依托于代理模式来实现的。 +（怪不得我看 WTF 的合约的时候给我看的想不明白。不过也正常，WTF 只放了一个 fallback 函数的实现，没有修改接口的位置。） + + + + +## 代理模式 +### **透明代理模式** +Transparent +这个就是最基础的代理合约模式，通过修改代理合约中的地址来实现代理合约的更换。 + +在透明模式中，除了代理合约和实现合约还有一个专门用来升级的合约的合约 `proxyadmin`。 + +在调用 `proxyadmin` 前会验证是否是管理员，举个验证的例子： +```solidity +modifier ifAdmin() { + if (msg.sender == _getAdmin()) { + _; + } else { + _fallback(); + } +} + +``` + + +下图是透明模式的运行逻辑图 +image + +#### Implementation 的地址存放位置 + +由于是 `delegatecall()` 是使用的代理合约的上下文，这个时候存放实现合约的地址应当较为注意，不然可能会出现 slot 冲突的情况。 + +而存放的位置越靠后，碰撞的可能性越小，所以出现了一个计算存放位置的规范： +```solidity +在openzeppelin给出的代码中，选用的存放位置是: + +bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1) + +对于transparent合约而言，还需要存放ProxyAdmin的地址 + +bytes32(uint256(keccak256("eip1967.proxy.admin")) - 1) +``` +#### 初始化 + + +代理模式下的初始化特点： +由于一般情况下变量的初始化是通过构造函数初始话的，而这个时候会把变量定义到实现合约的 `storage` 中，而我们都知道实现合约是只用来存储代码逻辑的，如果一旦更换存储的实现合约那么数据的迁移就会很麻烦。 + +所以我们务必要将数据都放在代理合约上，为了达到这个目标我们就使用的 `delegatecall` ，而还要考虑的就有通过构造函数初始话变量的，这个时候我们就可以通过一个专门的函数来初始话变量，这样的话变量就会使用代理合约的上下文。 + +比如下面的这个例子： + +当然，也不是随随便便一个函数就可以作为初始化的，还需要使用 `initializer` 修饰符表明只初始化一次。 +```solidity +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.4; + +import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; + +contract TransparentV1 is Initializable { + event IncreaseV1(); + + uint public val; + + /// @custom:oz-upgrades-unsafe-allow constructor + constructor() { + _disableInitializers(); + } + + function initialize(uint _val) public initializer { + val = _val; // set initial value in initializer + } + + function increase() public { + val += 1; + emit IncreaseV1(); + } +} + +``` + +**疑问：** + +难道使用 `delegatecall` 调用的合约可以使用构造函数把变量存储在自己合约的上下文么？那这样如果调用合约和被调用合约有相同变量名的话，那么在被调用合约中的函数调用这个变量的时候是调用的哪里的变量呢？ + +不是的，在思考这个问题的时候忽略了一点：无论代理合约怎么调用实现合约，都需要在实现合约部署之后才去调用的。而构造函数是在部署合约的时候就执行的，所以这个时候对于变量的初始化是在实现合约内部的。 + +同时，由于构造函数只会在部署合约的时候执行一次，所以就不用考虑在 `deleagate` 之后再调用构造函数来去把变量存在本地了。 + +### **UUPS 代理模式** +举例一个 UUPS 代理模式的可升级合约的大概例子 + + + +好吧，其实没那么难。透明模式是因为无论谁都可以调用代理合约且升级函数的地方在，所以增加了一个 `proxyadmin`，而如果是放在实现合约中的话就不需要一个额外的合约了。 +当时，进行修改的时候做一下验证就可以了。 + +image + + +```solidity +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.4; + +import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol"; +import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; +import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol"; + +contract UUPSV1 is Initializable, OwnableUpgradeable, UUPSUpgradeable { + event IncreaseV1(); + + uint public val; + + /// @custom:oz-upgrades-unsafe-allow constructor + constructor() { + _disableInitializers(); + } + + function initialize(uint _val) initializer public { + val = _val; + __Ownable_init(); + __UUPSUpgradeable_init(); + } + + function _authorizeUpgrade(address newImplementation) + internal + onlyOwner + override + {} + + function increase() public { + val += 1; + emit IncreaseV1(); + } +} + +contract UUPSV2 is Initializable, OwnableUpgradeable , UUPSUpgradeable { + event IncreaseV2(); + + uint public val; + + function _authorizeUpgrade(address newImplementation) + internal + onlyOwner + override + {} + + function increase() public { + val += 2; + emit IncreaseV2(); + } +} + + +``` + + +至于为什么说 UUPS 可以在升级之后就停止升级是在于在升级的时候可以指向一直新的实现合约，而这个合约如果没有用来升级的函数那不就是不刻意再升级了。 + + +### **Beacon 代理模式** +这个就是将逻辑合约复用的情况。 +以透明模式为基础，先指向 beacon，然后再指向实际的逻辑合约。 +运行逻辑如下图： + +image + +### Diamond Pattern + + +为什么会有这样的说法 +``` +initialize()函数通常被“initializer”修饰符保护，以限制该函数只能被调用一次。在调用initialize()函数后，从代理合约的角度看，逻辑合约被初始化了。 + +然而，从逻辑合约的角度来看，逻辑合约并没有被初始化，因为initialize()并没有在逻辑合约中被直接调用。鉴于逻辑合约本身未被初始化，任何人都可以调用initialize()函数来初始化它，将状态变量设置为一个恶意的值，并有可能接管逻辑合约。 +``` + + +## 代理合约&插槽冲突 +为什么在实现代理合约和可升级合约的时候要做防止插槽冲突呢 ？ + +因为在代理合约中，实现代理委托的方法是 `delegatecall` 而其特点就是实现调用的时候运行的上下文不变，还是在原本的代理合约中，这个时候就容易出现插槽冲突的情况。 + +image + + + +为什么呢——————因为 `delegatecall` +``` +在一个可升级的合约系统中，代理合约不会声明状态变量，而是使用伪随机存储槽来存储重要数据。 + +代理合约将逻辑合约状态变量的值保存在它们被声明的相对位置。如果代理合约声明了它自己的状态变量，这时代理和逻辑合约都试图使用同一个存储槽，就会发生存储冲突。 + +OpenZeppelin库提供的代理合约不会在合约中声明状态变量，而是基于EIP 1967标准，将需要存储的数值（如管理地址）保存到特定的存储槽中，以防止冲突。 +``` + + +## 代理合约&内联汇编 +实现代理合约的时候一定要使用内联汇编么？ + +不是的，只是 WTF 使用了内联汇编作为接口。 + + +## 代理合约在&fallback 函数 + +因为 fallback 出现于调用者调用了一个其合约中没有的函数的时候就调用 fallbahc 函数来实现。 +其实这个时候就类似于调用了一个无限包容的路由或者是强制跳转。 +从而将请求转发到逻辑路由。