如何在Solidity 0.4.17中声明可跨合约访问的文件级常量？

问题背景 #

你尝试在Solidity 0.4.17中声明文件级全局常量，编写的合约如下：

pragma solidity ^0.4.17;

uint256 constant MY_CONSTANT = 3;

contract MyContract {
  constructor() public {}
}

搭配的truffle-config.js配置：

module.exports = {
  networks: {
     development: {
      host: "127.0.0.1",
      port: 9545,
      network_id: "*",
     },
  },
  compilers: {
    solc: {
      version: "^0.4.17"
    }
  }
};

执行truffle compile时出现编译错误：

Compiling your contracts...
===========================
> Compiling ./contracts/MyContract.sol-bin. Attempt #1

CompileError: project:/contracts/MyContract.sol:4:1: ParserError: Expected pragma, import directive or contract/interface/library definition.
uint256 constant MY_CONSTANT = 3;
^-----^

Compilation failed. See above.
    at /home/thaiminhpv/.nvm/versions/node/v16.18.1/lib/node_modules/truffle/build/webpack:/packages/compile-solidity/dist/run.js:95:1
    at Generator.next (<anonymous>)
    at fulfilled (/home/thaiminhpv/.nvm/versions/node/v16.18.1/lib/node_modules/truffle/build/webpack:/packages/compile-solidity/dist/run.js:28:43)
Truffle v5.6.4 (core: 5.6.4)
Node v16.18.1

将Solidity版本改为0.8.17后编译正常，需要解决在0.4.17中声明可跨合约访问常量的问题。

原因说明 #

Solidity 0.4.x版本不支持文件级别的全局常量声明，文件顶层仅允许放置pragma指令、import导入语句，以及合约（contract）、接口（interface）、库（library）的定义。0.8.x版本才引入了文件级常量的语法支持，因此更换高版本编译器可以正常编译。

解决方案 #

在Solidity 0.4.17中，可通过以下两种方式实现跨合约访问的常量：

1. 使用库（Library）存放常量 #

创建单独的库文件存储共享常量，其他合约通过导入库来访问：

Constants.sol

pragma solidity ^0.4.17;

library Constants {
    uint256 constant MY_CONSTANT = 3;
}

MyContract.sol

pragma solidity ^0.4.17;

import "./Constants.sol";

contract MyContract {
    constructor() public {}

    // 示例：访问常量
    function getConstant() public pure returns (uint256) {
        return Constants.MY_CONSTANT;
    }
}

说明：库中的constant常量会在编译时被内联到调用处，不会产生额外的合约调用开销，适合存放共享的固定值。

2. 使用接口（Interface）存放常量 #

接口中可以定义public常量，其他合约通过继承或直接引用接口来访问：

IConstants.sol

pragma solidity ^0.4.17;

interface IConstants {
    uint256 constant MY_CONSTANT = 3;
}

MyContract.sol

pragma solidity ^0.4.17;

import "./IConstants.sol";

contract MyContract is IConstants {
    constructor() public {}

    // 示例：访问常量
    function getConstant() public pure returns (uint256) {
        return MY_CONSTANT;
    }
}

说明：接口中的常量默认是public可见性，合约继承接口后可直接使用，其他合约也能通过IConstants.MY_CONSTANT的方式访问该常量。

验证 #

保持truffle-config.js中的solc版本为^0.4.17，执行truffle compile即可正常编译上述合约。

内容的提问来源于stack exchange，提问作者Thaiminhpv