Auto generate metadata for TC proposals #900
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomas-waite
force-pushed
the
auto-register-metadata
branch
from
551abac
to
402c3d2
Compare
kryptoklob
reviewed
Jun 14, 2022
| proposalId, | ||
| proposal.description | ||
| ]); | ||
| return `Calldata: ${calldata}\nMetadata Calldata: ${registerMetadataCalldata}\nExecute Calldata: ${executeCalldata}`; |
There was a problem hiding this comment.
It's strange to me that we're returning a formatted string. If we want to log this to console, we should do that explicitly; the string returned should just be the pure calldata, imo.
There was a problem hiding this comment.
This function generates the string of calldata, returns that and it is later logged at the top level. I personally like that so you don't have logging going on several layers of abstraction down, it's clear where it's coming from
There was a problem hiding this comment.
Yep, that's what I'm saying - the logging should happen at the higher level
thomas-waite
changed the title
Joeysantoro
previously approved these changes
Jun 20, 2022
rename to podCalldata rather than timelockCalldata
kryptoklob
approved these changes
Jun 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature: Auto-generate the metadata for TC proposals
Summary
Automatically generates the metadata for registering TC proposals in the
GovernanceMetadataRegistry: https://etherscan.io/address/0xd78Cd3AaE6168BE43B548877aAc68312B9df9AFbContext
Registering proposals in the metadata registry is currently too high friction. It requires a seperate transaction by an engineer after a proposal has been queued on the TC timelock.
Solution
This PR outputs the calldata for the register metadata transaction that should be submitted to the registry at the same time the proposal is queued.
The
podIdis known for the TC (25) and the timelockproposalIDcan be computed deterministically ahead of time locally. Themetadatahuman readable description of what the proposal does is taken from theproposals/description/fip_x.tsproposal.New proposal submission flow
When submitting a TC proposal on the TC safe:
DEPLOY_FILE=fip_x npm run calldataCalldata(which will schedule the proposal) and theMetadata calldata(which will register the human readable description)a. Call to the TC timelock (
0xe0C7DE94395B629860Cbb3c42995F300F56e6d7a) with theCalldatab. Call to the Governance Metadata registry (
0xd78Cd3AaE6168BE43B548877aAc68312B9df9AFb) withMetadata calldataPR Checklist - Feature (Proposal)