[sui/metadata] The enum structure returned by metadata is not the same as the enum struct set in the contract.

[vladilen11]

The enum variants field returned by metadata is sorted and is not in the same order as the contract settings.

this is my contract

  module monster_hunter::terrain_type {

  public enum TerrainType has copy, drop , store {
                                None,TallGrass,Boulder
                        }

  public fun new_none(): TerrainType {
    TerrainType::None
  }

  public fun new_tall_grass(): TerrainType {
    TerrainType::TallGrass
  }

  public fun new_boulder(): TerrainType {
    TerrainType::Boulder
  }
}

this is the metadata of my contract:

  "terrain_type": {
    "fileFormatVersion": 7,
    "address": "0x85f95a4253621cac22ebfc27ec67b903c153e7b1bea5a2813c71fa62016746c7",
    "name": "terrain_type",
    "friends": [],
    "structs": {},
    "enums": {
      "TerrainType": {
        "abilities": { "abilities": ["Copy", "Drop", "Store"] },
        "typeParameters": [],
        "variants": { "Boulder": [], "None": [], "TallGrass": [] }
      }
    },

This will cause a problem, the developer can't get the correct structure of the enums in the contract through the metadata, and can't construct the correct bcs struct through the metadata.

To summarise, we want metadata to return information that is consistent with the contract code. In the current scenario, the corresponding metadata would be:

"enums": {
      "TerrainType": {
        "abilities": { "abilities": ["Copy", "Drop", "Store"] },
        "typeParameters": [],
        "variants": { ""None": [], "TallGrass": [], Boulder": [] }
      }
    },

[github-actions]

Thank you for opening this issue, a team member will review it shortly. Until then, please do not interact with any users that claim to be from Sui support and do not click on any links!

[stefan-mysten]

Thanks for this report. @tzakian any idea here?