gov/v1beta1/proposal doesn't handle correctly new SoftwareUpgradeProposal #14334

robert-zaremba · 2022-12-16T00:14:47Z

Summary of Bug

ping.pub and Kepler explorer crash when opening a governance page, when there is a new SoftwareUpgradeProposal (submitted as a new tx gov submit-proposal) as well as any new proposal gov message. The exception in the browser console is: TypeError: t.p.contents is null. Example.
Probably other explorers (mintscan...) will crash as well.

The reason is that gov/v1beta1/proposals endpoint doesn't set Content for the new Proposal types.
The problem is that today, explorers use gov/v1beta1/proposals and expect Proposal.Content.

Ecosystem bugs:

It makes one of the most important features: gov almost unusable without a frontend.
Without that, literally nobody should use new gov system (they should be marked experimental, until ecosystem adoption is achieved, rather then deprecating the "working" solutions).
We need an ecosystem push for tooling update.

Version

v0.46.7
I guess, v0.47-alpha2 has same issue.

Steps to Reproduce

Start simd

Make proposal upgrade:

 simd tx gov submit-proposal p.json \
   --from w1 --chain-id $CHAINID  -y --keyring-backend test --home $APP_HOME --fees 5000$DENOM -b block

wait until upgrade, and start new binary with compiled upgrade plan, and API server enabled
Open ping pug gov page - it will break
You won't be able to see details of any new gov proposal, until explorer will start supporting gov/v1

Open 127.0.0.1:1317/cosmos/gov/v1/proposals/1, you will see correct response:

{
  "proposal": {
    "id": "1",
    "messages": [
      {
        "@type": "/cosmos.upgrade.v1beta1.MsgSoftwareUpgrade",
        "authority": "cosmos10d07y265gmmuvt4z0w9aw880jnsr700j6zn9kn",
        "plan": {
          "name": "v3.0.0",
          "time": "0001-01-01T00:00:00Z",
          "height": "45",
          "info": "",
          "upgraded_client_state": null
        }
      }
    ],
    "status": "PROPOSAL_STATUS_PASSED",
    "final_tally_result": {
      "yes_count": "1090000000000",
      "abstain_count": "0",
      "no_count": "0",
      "no_with_veto_count": "0"
    },
    "submit_time": "2022-12-15T23:20:00.636433951Z",
    "deposit_end_time": "2022-12-15T23:21:00.636433951Z",
    "total_deposit": [
      {
        "denom": "stake",
        "amount": "10000000"
      }
    ],
    "voting_start_time": "2022-12-15T23:20:00.636433951Z",
    "voting_end_time": "2022-12-15T23:20:20.636433951Z",
    "metadata": ""
  }
}

open 127.0.0.1:1317/cosmos/gov/v1beta1/proposals/1, you will see response with null content

{
  "proposal": {
    "proposal_id": "1",
    "content": null,
    "status": "PROPOSAL_STATUS_PASSED",
    "final_tally_result": {
      "yes": "1090000000000",
      "abstain": "0",
      "no": "0",
      "no_with_veto": "0"
    },
    "submit_time": "2022-12-15T23:20:00.636433951Z",
    "deposit_end_time": "2022-12-15T23:21:00.636433951Z",
    "total_deposit": [
      {
        "denom": "stake",
        "amount": "10000000"
      }
    ],
    "voting_start_time": "2022-12-15T23:20:00.636433951Z",
    "voting_end_time": "2022-12-15T23:20:20.636433951Z"
  }
}

The text was updated successfully, but these errors were encountered:

robert-zaremba · 2022-12-16T01:11:02Z

In fact the same problem is with all "new" proposals. For example, we created a "new" proposal for one of our custom modules, and it also breaks the explorer, because the content is missing.

tac0turtle · 2022-12-16T02:44:34Z

@AmauryM can lend some help, but v1 is a breaking change and was expected to cause some breaking changes. We can look into what can be done, but also a nil check on explorers can be done.

julienrbrt · 2022-12-16T08:56:53Z

Changes for gov v1 always needed to be implemented by explorers. For instance, they need to implement metadata changes: #11301

dogemos · 2022-12-16T12:40:38Z

Keplr Dashboard already supports the v1beta1 endpoint. Released an update allowing content to be null so this should be no issue on the Keplr side now.

robert-zaremba · 2022-12-16T13:08:33Z

Great news @dogemos . Is there a roadmap for gov/v1 support?

robert-zaremba · 2022-12-16T13:12:02Z

BTW, @dogemos , I don't think handling null content is the final solution. Users won't see proposal (name, description, ...) details unless you start supporting gov/v1.

dogemos · 2022-12-16T16:17:43Z

Hey Robert, Noted. I think I misunderstood the issue as being an endpoint formatting issue. Seems like this is more around the breaking changes on gov/v1. This will take a little bit more time, but I've notified the team and we will work on getting gov/v1 supported.

minxylynx · 2022-12-16T17:02:35Z

I think the biggest issue is that the gov/v1 stuff no longer has a static title and description. It relies on the goodwill of the proposer to format and upload the Metadata matching the "recommended" format.

Just something to keep in mind, as I've had to deal with the switch as well.

robert-zaremba · 2022-12-16T17:51:16Z

I am preparing a fix for v1beta1. However, nevertheless let's start supporting v1 endpoints.

robert-zaremba · 2022-12-16T17:53:01Z

I think the biggest issue is that the gov/v1 stuff no longer has a static title and description. It relies on the goodwill of the proposer to format and upload the Metadata matching the "recommended" format.

Good observation @minxylynx , it's a big issue. The Title / Description is ensured on the interface level, which obviously won't work on the proto level.

minxylynx · 2022-12-16T17:59:15Z

I think the biggest issue is that the gov/v1 stuff no longer has a static title and description. It relies on the goodwill of the proposer to format and upload the Metadata matching the "recommended" format.

Good observation @minxylynx , it's a big issue. The Title / Description is ensured on the interface level, which obviously won't work on the proto level.

I spent about 2 weeks updating the Provenance Explorer to handle the new changes. That was a big point of frustration. If the metadata doesnt exist, there is no title or description. So I had to handle that case with defaults, which are not a nice as a true title.

I understand why it was moved into a freeform field, but that leaves it open to being ignored.

On the same note, I do parse out the legacy content, if present, to pull the old title and description fields. That at least works for some of the time.

robert-zaremba · 2022-12-16T18:02:03Z

yeah, I spent this week debuging various things, previously we spent few weeks doing migrations and creating new v1 proposals, so I understand your pain. I would like to avoid rolling back that work.

liangping · 2022-12-16T23:16:44Z

@robert-zaremba I think we have patched the null content issue, You need put a sdk version >0.46.6 in the chain.json. let me know if it still not work.

Regarding the metadata, We haven't figured out what is a practical way to implement, Because there are some common issues (availability, cors) on parsing contents the external link.

The only thing I would suggest is putting title out of the metadata, using a separated field and storing it on chain. that keep minimum necessary info about the proposal. also help display on front-end, especially for iteration.

robert-zaremba · 2022-12-16T23:19:55Z

@liangping how does 0.46.7 change anything here (compared to 46.0)?

robert-zaremba · 2022-12-16T23:21:31Z

@liangping if you don't support gov/v1 endpoint then you won't show title and description (however I've prepared a patch to handle that for messages with explicit title and description content).

liangping · 2022-12-16T23:25:38Z

we only handle null content when version> 0.46.6, Because osmosis(current 0.46.1) adapted the gov to previous version, while others did not. so we added a version compare.

liangping · 2022-12-16T23:31:06Z

@liangping if you don't support gov/v1 endpoint then you won't show title and description (however I've prepared a patch to handle that for messages with explicit title and description content).

Welcome to push a request.

hxrts · 2022-12-17T21:15:04Z

fyi, the reason it title/description was removed was because groups was added and that needed to be off-chain so it didn't blow up state. gov was changed so gov/groups would conform.

We did our best to document this and I went around to major wallets/explorers to notify them of the change months ago.

robert-zaremba · 2022-12-19T23:34:56Z

@hxrts group/v1.Proposal != gov/v1.Proposal. In fact, group proto doesn't even import gov.

robert-zaremba · 2022-12-19T23:38:57Z

Is there any explorer which already handle gov metadata?
cc: @dogemos , @liangping ... (can anyone ping mintscan, bigdipper, atomscan.com ....)?

liangping · 2022-12-19T23:42:08Z

Is there any explorer which already handle gov metadata?
cc: @dogemos , @liangping ... (can anyone ping mintscan, bigdipper, atomscan.com ....)?

Haven't.

minxylynx · 2022-12-19T23:51:40Z

@robert-zaremba

https://explorer.provenance.io/dashboard
https://github.com/provenance-io/explorer-service/blob/main/service/src/main/kotlin/io/provenance/explorer/service/GovService.kt#L729-L746

i handle it in a generic way, for now

carameleon · 2022-12-20T12:48:45Z

Mintscan is looking into it and will prepare against this issues.

thanks for ping us. @hxrts

Is there any explorer which already handle gov metadata? cc: @dogemos , @liangping ... (can anyone ping mintscan, bigdipper, atomscan.com ....)?

robert-zaremba added T:Bug C:x/gov labels Dec 16, 2022

This was referenced Dec 16, 2022

Update agd to gaia Rho Agoric/agoric-sdk#5986

Closed

Cosmos upgrade handler for vaults release Agoric/agoric-sdk#6685

Closed

julienrbrt removed the T:Bug label Dec 16, 2022

robert-zaremba mentioned this issue Dec 16, 2022

feat(gov): support v1.Proposal in v1beta1.Proposal.Content #14347

Merged

19 tasks

robert-zaremba closed this as completed in #14347 Dec 22, 2022

robert-zaremba mentioned this issue Jan 4, 2023

Regen Ledger v5.0 upgrade proposal regen-network/governance#16

Merged

mhagel mentioned this issue Apr 3, 2023

Kyve-network proposals not loading / support Gov v1 hicommonwealth/commonwealth#3159

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gov/v1beta1/proposal doesn't handle correctly new SoftwareUpgradeProposal #14334

gov/v1beta1/proposal doesn't handle correctly new SoftwareUpgradeProposal #14334

robert-zaremba commented Dec 16, 2022 •

edited

Loading

robert-zaremba commented Dec 16, 2022

tac0turtle commented Dec 16, 2022

julienrbrt commented Dec 16, 2022

dogemos commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

dogemos commented Dec 16, 2022 •

edited

Loading

minxylynx commented Dec 16, 2022 •

edited

Loading

robert-zaremba commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

minxylynx commented Dec 16, 2022 •

edited

Loading

robert-zaremba commented Dec 16, 2022

liangping commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022 •

edited

Loading

robert-zaremba commented Dec 16, 2022

liangping commented Dec 16, 2022

liangping commented Dec 16, 2022

hxrts commented Dec 17, 2022 •

edited

Loading

robert-zaremba commented Dec 19, 2022

robert-zaremba commented Dec 19, 2022

liangping commented Dec 19, 2022

minxylynx commented Dec 19, 2022 •

edited

Loading

carameleon commented Dec 20, 2022

gov/v1beta1/proposal doesn't handle correctly new SoftwareUpgradeProposal #14334

gov/v1beta1/proposal doesn't handle correctly new SoftwareUpgradeProposal #14334

Comments

robert-zaremba commented Dec 16, 2022 • edited Loading

Summary of Bug

Version

Steps to Reproduce

robert-zaremba commented Dec 16, 2022

tac0turtle commented Dec 16, 2022

julienrbrt commented Dec 16, 2022

dogemos commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

dogemos commented Dec 16, 2022 • edited Loading

minxylynx commented Dec 16, 2022 • edited Loading

robert-zaremba commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022

minxylynx commented Dec 16, 2022 • edited Loading

robert-zaremba commented Dec 16, 2022

liangping commented Dec 16, 2022

robert-zaremba commented Dec 16, 2022 • edited Loading

robert-zaremba commented Dec 16, 2022

liangping commented Dec 16, 2022

liangping commented Dec 16, 2022

hxrts commented Dec 17, 2022 • edited Loading

robert-zaremba commented Dec 19, 2022

robert-zaremba commented Dec 19, 2022

liangping commented Dec 19, 2022

minxylynx commented Dec 19, 2022 • edited Loading

carameleon commented Dec 20, 2022

robert-zaremba commented Dec 16, 2022 •

edited

Loading

dogemos commented Dec 16, 2022 •

edited

Loading

minxylynx commented Dec 16, 2022 •

edited

Loading

minxylynx commented Dec 16, 2022 •

edited

Loading

robert-zaremba commented Dec 16, 2022 •

edited

Loading

hxrts commented Dec 17, 2022 •

edited

Loading

minxylynx commented Dec 19, 2022 •

edited

Loading