如何解决Solidity中返回含嵌套mapping的struct时的报错问题

Solidity 不支持 public/external 函数直接返回包含嵌套 mapping 的结构体，不需要完全把结构体扁平化，有成熟的替代方案可以实现需求。

• mapping 是仅存在于合约存储（storage）的稀疏键值结构，没有原生方法可以遍历全部键，也无法完整拷贝到内存（memory）中，所以无法构造出包含完整 mapping 数据的 memory 结构体实例用于返回。
• 带有 mapping 的结构体的 storage 指针仅允许作为 internal 或 library 函数的参数/返回值，public/external 函数的返回值需要序列化后供外部调用，storage 指针是合约内部的存储偏移量，对外部调用无意义，编译器会直接抛出你遇到的报错。

方案1：拆分查询接口 #

把结构体的基础属性和 mapping 下的子结构分为两个接口分别查询，适合子结构查询频率低、不需要批量获取的场景：

pragma solidity ^0.8.0;

contract Nested {
    struct Parent {
        string parentPropertyA;
        mapping(uint => Child) childProperty;
    }

    struct Child {
       string childPropertyA;
    }

    mapping(uint => Parent) public parents;

    // 仅返回Parent的非mapping基础属性
    function getParentBase(uint parentId) public view returns (string memory) {
        return parents[parentId].parentPropertyA;
    }

    // 单独查询指定parent下的指定child数据
    function getChild(uint parentId, uint childId) public view returns (Child memory) {
        return parents[parentId].childProperty[childId];
    }
}

方案2：新增计数字段实现批量返回 #

如果需要一次性返回某个Parent下的所有Child，可在结构体中新增计数字段记录有效子元素数量，遍历读取子元素构造内存数组返回：

pragma solidity ^0.8.0;

contract Nested {
    struct Parent {
        string parentPropertyA;
        uint childCount; // 记录当前Parent下的Child总数，新增Child时同步更新
        mapping(uint => Child) childProperty;
    }

    struct Child {
       string childPropertyA;
    }

    mapping(uint => Parent) public parents;

    // 新增Child的示例方法，需同步更新childCount
    function addChild(uint parentId, string calldata childProp) external {
        uint childId = parents[parentId].childCount;
        parents[parentId].childProperty[childId] = Child(childProp);
        parents[parentId].childCount++;
    }

    // 一次性返回Parent基础信息+所有Child列表
    function getParentFull(uint parentId) public view returns (string memory parentProp, Child[] memory children) {
        Parent storage parent = parents[parentId];
        parentProp = parent.parentPropertyA;
        children = new Child[](parent.childCount);
        for (uint i = 0; i < parent.childCount; i++) {
            children[i] = parent.childProperty[i];
        }
    }
}

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