governance.adoc 257 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035
  1. :github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
  2. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  3. :GovernorVotes: pass:normal[xref:governance.adoc#GovernorVotes[`GovernorVotes`]]
  4. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  5. :GovernorVotesComp: pass:normal[xref:governance.adoc#GovernorVotesComp[`GovernorVotesComp`]]
  6. :ERC20VotesComp: pass:normal[xref:token/ERC20.adoc#ERC20VotesComp[`ERC20VotesComp`]]
  7. :GovernorVotesQuorumFraction: pass:normal[xref:governance.adoc#GovernorVotesQuorumFraction[`GovernorVotesQuorumFraction`]]
  8. :GovernorCountingSimple: pass:normal[xref:governance.adoc#GovernorCountingSimple[`GovernorCountingSimple`]]
  9. :GovernorTimelockControl: pass:normal[xref:governance.adoc#GovernorTimelockControl[`GovernorTimelockControl`]]
  10. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  11. :GovernorTimelockCompound: pass:normal[xref:governance.adoc#GovernorTimelockCompound[`GovernorTimelockCompound`]]
  12. :GovernorCompatibilityBravo: pass:normal[xref:governance.adoc#GovernorCompatibilityBravo[`GovernorCompatibilityBravo`]]
  13. :GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
  14. :GovernorPreventLateQuorum: pass:normal[xref:governance.adoc#GovernorPreventLateQuorum[`GovernorPreventLateQuorum`]]
  15. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  16. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  17. :xref-IGovernor-name--: xref:governance.adoc#IGovernor-name--
  18. :xref-IGovernor-version--: xref:governance.adoc#IGovernor-version--
  19. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  20. :xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-
  21. :xref-IGovernor-state-uint256-: xref:governance.adoc#IGovernor-state-uint256-
  22. :xref-IGovernor-proposalSnapshot-uint256-: xref:governance.adoc#IGovernor-proposalSnapshot-uint256-
  23. :xref-IGovernor-proposalDeadline-uint256-: xref:governance.adoc#IGovernor-proposalDeadline-uint256-
  24. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  25. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  26. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  27. :xref-IGovernor-getVotes-address-uint256-: xref:governance.adoc#IGovernor-getVotes-address-uint256-
  28. :xref-IGovernor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-
  29. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  30. :xref-IGovernor-propose-address---uint256---bytes---string-: xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-
  31. :xref-IGovernor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-
  32. :xref-IGovernor-castVote-uint256-uint8-: xref:governance.adoc#IGovernor-castVote-uint256-uint8-
  33. :xref-IGovernor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-
  34. :xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  35. :xref-IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  36. :xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  37. :xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
  38. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  39. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  40. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  41. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  42. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  43. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  44. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  45. :IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
  46. :IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
  47. :xref-Governor-onlyGovernance--: xref:governance.adoc#Governor-onlyGovernance--
  48. :xref-Governor-constructor-string-: xref:governance.adoc#Governor-constructor-string-
  49. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  50. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  51. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  52. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  53. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  54. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  55. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  56. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  57. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  58. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  59. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  60. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  61. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  62. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  63. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  64. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  65. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  66. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  67. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  68. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  69. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  70. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  71. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  72. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  73. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  74. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  75. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  76. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  77. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  78. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  79. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  80. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  81. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  82. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  83. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  84. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  85. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  86. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  87. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  88. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  89. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  90. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  91. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  92. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  93. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  94. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  95. :GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
  96. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  97. :IGovernor-name: pass:normal[xref:governance.adoc#IGovernor-name--[`IGovernor.name`]]
  98. :IGovernor-version: pass:normal[xref:governance.adoc#IGovernor-version--[`IGovernor.version`]]
  99. :IGovernor-hashProposal: pass:normal[xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`IGovernor.hashProposal`]]
  100. :IGovernor-state: pass:normal[xref:governance.adoc#IGovernor-state-uint256-[`IGovernor.state`]]
  101. :IGovernor-proposalSnapshot: pass:normal[xref:governance.adoc#IGovernor-proposalSnapshot-uint256-[`IGovernor.proposalSnapshot`]]
  102. :IGovernor-proposalDeadline: pass:normal[xref:governance.adoc#IGovernor-proposalDeadline-uint256-[`IGovernor.proposalDeadline`]]
  103. :IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
  104. :IGovernor-execute: pass:normal[xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-[`IGovernor.execute`]]
  105. :IGovernor-ProposalCanceled: pass:normal[xref:governance.adoc#IGovernor-ProposalCanceled-uint256-[`IGovernor.ProposalCanceled`]]
  106. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  107. :IGovernor-getVotesWithParams: pass:normal[xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-[`IGovernor.getVotesWithParams`]]
  108. :IGovernor-castVote: pass:normal[xref:governance.adoc#IGovernor-castVote-uint256-uint8-[`IGovernor.castVote`]]
  109. :IGovernor-castVoteWithReason: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-[`IGovernor.castVoteWithReason`]]
  110. :IGovernor-castVoteWithReasonAndParams: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`IGovernor.castVoteWithReasonAndParams`]]
  111. :IGovernor-castVoteBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`IGovernor.castVoteBySig`]]
  112. :IGovernor-castVoteWithReasonAndParamsBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`IGovernor.castVoteWithReasonAndParamsBySig`]]
  113. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  114. :IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
  115. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  116. :IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
  117. :IERC721Receiver-onERC721Received: pass:normal[xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-[`IERC721Receiver.onERC721Received`]]
  118. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
  119. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
  120. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  121. :xref-GovernorCountingSimple-COUNTING_MODE--: xref:governance.adoc#GovernorCountingSimple-COUNTING_MODE--
  122. :xref-GovernorCountingSimple-hasVoted-uint256-address-: xref:governance.adoc#GovernorCountingSimple-hasVoted-uint256-address-
  123. :xref-GovernorCountingSimple-proposalVotes-uint256-: xref:governance.adoc#GovernorCountingSimple-proposalVotes-uint256-
  124. :xref-GovernorCountingSimple-_quorumReached-uint256-: xref:governance.adoc#GovernorCountingSimple-_quorumReached-uint256-
  125. :xref-GovernorCountingSimple-_voteSucceeded-uint256-: xref:governance.adoc#GovernorCountingSimple-_voteSucceeded-uint256-
  126. :xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-
  127. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  128. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  129. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  130. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  131. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  132. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  133. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  134. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  135. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  136. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  137. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  138. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  139. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  140. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  141. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  142. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  143. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  144. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  145. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  146. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  147. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  148. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  149. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  150. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  151. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  152. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  153. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  154. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  155. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  156. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  157. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  158. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  159. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  160. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  161. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  162. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  163. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  164. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  165. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  166. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  167. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  168. :IGovernor-COUNTING_MODE: pass:normal[xref:governance.adoc#IGovernor-COUNTING_MODE--[`IGovernor.COUNTING_MODE`]]
  169. :IGovernor-hasVoted: pass:normal[xref:governance.adoc#IGovernor-hasVoted-uint256-address-[`IGovernor.hasVoted`]]
  170. :Governor-_quorumReached: pass:normal[xref:governance.adoc#Governor-_quorumReached-uint256-[`Governor._quorumReached`]]
  171. :Governor-_voteSucceeded: pass:normal[xref:governance.adoc#Governor-_voteSucceeded-uint256-[`Governor._voteSucceeded`]]
  172. :Governor-_countVote: pass:normal[xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`Governor._countVote`]]
  173. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  174. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  175. :ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
  176. :xref-GovernorVotes-constructor-contract-IVotes-: xref:governance.adoc#GovernorVotes-constructor-contract-IVotes-
  177. :xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
  178. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  179. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  180. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  181. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  182. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  183. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  184. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  185. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  186. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  187. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  188. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  189. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  190. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  191. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  192. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  193. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  194. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  195. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  196. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  197. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  198. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  199. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  200. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  201. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  202. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  203. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  204. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  205. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  206. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  207. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  208. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  209. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  210. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  211. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  212. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  213. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  214. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  215. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  216. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  217. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  218. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  219. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  220. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  221. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  222. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  223. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  224. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  225. :xref-GovernorVotesQuorumFraction-constructor-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-constructor-uint256-
  226. :xref-GovernorVotesQuorumFraction-quorumNumerator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator--
  227. :xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator-uint256-
  228. :xref-GovernorVotesQuorumFraction-quorumDenominator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumDenominator--
  229. :xref-GovernorVotesQuorumFraction-quorum-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorum-uint256-
  230. :xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-
  231. :xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-
  232. :xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
  233. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  234. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  235. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  236. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  237. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  238. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  239. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  240. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  241. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  242. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  243. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  244. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  245. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  246. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  247. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  248. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  249. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  250. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  251. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  252. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  253. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  254. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  255. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  256. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  257. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  258. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  259. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  260. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  261. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  262. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  263. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  264. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  265. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  266. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  267. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  268. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  269. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  270. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  271. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  272. :xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-
  273. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  274. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  275. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  276. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  277. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  278. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  279. :xref-GovernorVotesComp-constructor-contract-ERC20VotesComp-: xref:governance.adoc#GovernorVotesComp-constructor-contract-ERC20VotesComp-
  280. :xref-GovernorVotesComp-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotesComp-_getVotes-address-uint256-bytes-
  281. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  282. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  283. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  284. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  285. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  286. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  287. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  288. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  289. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  290. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  291. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  292. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  293. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  294. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  295. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  296. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  297. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  298. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  299. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  300. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  301. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  302. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  303. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  304. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  305. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  306. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  307. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  308. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  309. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  310. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  311. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  312. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  313. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  314. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  315. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  316. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  317. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  318. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  319. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  320. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  321. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  322. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  323. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  324. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  325. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  326. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  327. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  328. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  329. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  330. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  331. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  332. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  333. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  334. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  335. :xref-GovernorTimelockControl-constructor-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-constructor-contract-TimelockController-
  336. :xref-GovernorTimelockControl-supportsInterface-bytes4-: xref:governance.adoc#GovernorTimelockControl-supportsInterface-bytes4-
  337. :xref-GovernorTimelockControl-state-uint256-: xref:governance.adoc#GovernorTimelockControl-state-uint256-
  338. :xref-GovernorTimelockControl-timelock--: xref:governance.adoc#GovernorTimelockControl-timelock--
  339. :xref-GovernorTimelockControl-proposalEta-uint256-: xref:governance.adoc#GovernorTimelockControl-proposalEta-uint256-
  340. :xref-GovernorTimelockControl-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-queue-address---uint256---bytes---bytes32-
  341. :xref-GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-
  342. :xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-
  343. :xref-GovernorTimelockControl-_executor--: xref:governance.adoc#GovernorTimelockControl-_executor--
  344. :xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-updateTimelock-contract-TimelockController-
  345. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  346. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  347. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  348. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  349. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  350. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  351. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  352. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  353. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  354. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  355. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  356. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  357. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  358. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  359. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  360. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  361. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  362. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  363. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  364. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  365. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  366. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  367. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  368. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  369. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  370. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  371. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  372. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  373. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  374. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  375. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  376. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  377. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  378. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  379. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  380. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  381. :xref-GovernorTimelockControl-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockControl-TimelockChange-address-address-
  382. :xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
  383. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  384. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  385. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  386. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  387. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  388. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  389. :Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
  390. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  391. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  392. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  393. :GovernorTimelockCompound-__acceptAdmin: pass:normal[xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--[`GovernorTimelockCompound.__acceptAdmin`]]
  394. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  395. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  396. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  397. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  398. :xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-
  399. :xref-GovernorTimelockCompound-supportsInterface-bytes4-: xref:governance.adoc#GovernorTimelockCompound-supportsInterface-bytes4-
  400. :xref-GovernorTimelockCompound-state-uint256-: xref:governance.adoc#GovernorTimelockCompound-state-uint256-
  401. :xref-GovernorTimelockCompound-timelock--: xref:governance.adoc#GovernorTimelockCompound-timelock--
  402. :xref-GovernorTimelockCompound-proposalEta-uint256-: xref:governance.adoc#GovernorTimelockCompound-proposalEta-uint256-
  403. :xref-GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-
  404. :xref-GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-
  405. :xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-
  406. :xref-GovernorTimelockCompound-_executor--: xref:governance.adoc#GovernorTimelockCompound-_executor--
  407. :xref-GovernorTimelockCompound-__acceptAdmin--: xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--
  408. :xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-
  409. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  410. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  411. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  412. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  413. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  414. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  415. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  416. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  417. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  418. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  419. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  420. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  421. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  422. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  423. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  424. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  425. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  426. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  427. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  428. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  429. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  430. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  431. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  432. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  433. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  434. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  435. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  436. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  437. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  438. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  439. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  440. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  441. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  442. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  443. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  444. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  445. :xref-GovernorTimelockCompound-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockCompound-TimelockChange-address-address-
  446. :xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
  447. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  448. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  449. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  450. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  451. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  452. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  453. :Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
  454. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  455. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  456. :xref-GovernorSettings-constructor-uint256-uint256-uint256-: xref:governance.adoc#GovernorSettings-constructor-uint256-uint256-uint256-
  457. :xref-GovernorSettings-votingDelay--: xref:governance.adoc#GovernorSettings-votingDelay--
  458. :xref-GovernorSettings-votingPeriod--: xref:governance.adoc#GovernorSettings-votingPeriod--
  459. :xref-GovernorSettings-proposalThreshold--: xref:governance.adoc#GovernorSettings-proposalThreshold--
  460. :xref-GovernorSettings-setVotingDelay-uint256-: xref:governance.adoc#GovernorSettings-setVotingDelay-uint256-
  461. :xref-GovernorSettings-setVotingPeriod-uint256-: xref:governance.adoc#GovernorSettings-setVotingPeriod-uint256-
  462. :xref-GovernorSettings-setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-setProposalThreshold-uint256-
  463. :xref-GovernorSettings-_setVotingDelay-uint256-: xref:governance.adoc#GovernorSettings-_setVotingDelay-uint256-
  464. :xref-GovernorSettings-_setVotingPeriod-uint256-: xref:governance.adoc#GovernorSettings-_setVotingPeriod-uint256-
  465. :xref-GovernorSettings-_setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-_setProposalThreshold-uint256-
  466. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  467. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  468. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  469. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  470. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  471. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  472. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  473. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  474. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  475. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  476. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  477. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  478. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  479. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  480. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  481. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  482. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  483. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  484. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  485. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  486. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  487. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  488. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  489. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  490. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  491. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  492. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  493. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  494. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  495. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  496. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  497. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  498. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  499. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  500. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  501. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  502. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  503. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  504. :xref-GovernorSettings-VotingDelaySet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingDelaySet-uint256-uint256-
  505. :xref-GovernorSettings-VotingPeriodSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingPeriodSet-uint256-uint256-
  506. :xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-ProposalThresholdSet-uint256-uint256-
  507. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  508. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  509. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  510. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  511. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  512. :IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
  513. :IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
  514. :Governor-proposalThreshold: pass:normal[xref:governance.adoc#Governor-proposalThreshold--[`Governor.proposalThreshold`]]
  515. :xref-GovernorPreventLateQuorum-constructor-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-constructor-uint64-
  516. :xref-GovernorPreventLateQuorum-proposalDeadline-uint256-: xref:governance.adoc#GovernorPreventLateQuorum-proposalDeadline-uint256-
  517. :xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-
  518. :xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--: xref:governance.adoc#GovernorPreventLateQuorum-lateQuorumVoteExtension--
  519. :xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-
  520. :xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-
  521. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  522. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  523. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  524. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  525. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  526. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  527. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  528. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  529. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  530. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  531. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  532. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  533. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  534. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  535. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  536. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  537. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  538. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  539. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  540. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  541. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  542. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  543. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  544. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  545. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  546. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  547. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  548. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  549. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  550. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  551. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  552. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  553. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  554. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  555. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  556. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  557. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  558. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  559. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  560. :xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-
  561. :xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-
  562. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  563. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  564. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  565. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  566. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  567. :Governor-proposalDeadline: pass:normal[xref:governance.adoc#Governor-proposalDeadline-uint256-[`Governor.proposalDeadline`]]
  568. :Governor-_castVote: pass:normal[xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-[`Governor._castVote`]]
  569. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  570. :IGovernorTimelock: pass:normal[xref:governance.adoc#IGovernorTimelock[`IGovernorTimelock`]]
  571. :xref-GovernorCompatibilityBravo-COUNTING_MODE--: xref:governance.adoc#GovernorCompatibilityBravo-COUNTING_MODE--
  572. :xref-GovernorCompatibilityBravo-propose-address---uint256---bytes---string-: xref:governance.adoc#GovernorCompatibilityBravo-propose-address---uint256---bytes---string-
  573. :xref-GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-: xref:governance.adoc#GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-
  574. :xref-GovernorCompatibilityBravo-queue-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-queue-uint256-
  575. :xref-GovernorCompatibilityBravo-execute-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-execute-uint256-
  576. :xref-GovernorCompatibilityBravo-cancel-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-cancel-uint256-
  577. :xref-GovernorCompatibilityBravo-proposals-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-proposals-uint256-
  578. :xref-GovernorCompatibilityBravo-getActions-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-getActions-uint256-
  579. :xref-GovernorCompatibilityBravo-getReceipt-uint256-address-: xref:governance.adoc#GovernorCompatibilityBravo-getReceipt-uint256-address-
  580. :xref-GovernorCompatibilityBravo-quorumVotes--: xref:governance.adoc#GovernorCompatibilityBravo-quorumVotes--
  581. :xref-GovernorCompatibilityBravo-hasVoted-uint256-address-: xref:governance.adoc#GovernorCompatibilityBravo-hasVoted-uint256-address-
  582. :xref-GovernorCompatibilityBravo-_quorumReached-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-_quorumReached-uint256-
  583. :xref-GovernorCompatibilityBravo-_voteSucceeded-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-_voteSucceeded-uint256-
  584. :xref-GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-
  585. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  586. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  587. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  588. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  589. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  590. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  591. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  592. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  593. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  594. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  595. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  596. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  597. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  598. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  599. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  600. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  601. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  602. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  603. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  604. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  605. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  606. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  607. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  608. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  609. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  610. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  611. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  612. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  613. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  614. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  615. :xref-IGovernorTimelock-timelock--: xref:governance.adoc#IGovernorTimelock-timelock--
  616. :xref-IGovernorTimelock-proposalEta-uint256-: xref:governance.adoc#IGovernorTimelock-proposalEta-uint256-
  617. :xref-IGovernorTimelock-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernorTimelock-queue-address---uint256---bytes---bytes32-
  618. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  619. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  620. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  621. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  622. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  623. :xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
  624. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  625. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  626. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  627. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  628. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  629. :IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
  630. :IGovernorCompatibilityBravo-propose: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-[`IGovernorCompatibilityBravo.propose`]]
  631. :IGovernorCompatibilityBravo-queue: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-queue-uint256-[`IGovernorCompatibilityBravo.queue`]]
  632. :IGovernorCompatibilityBravo-execute: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-execute-uint256-[`IGovernorCompatibilityBravo.execute`]]
  633. :IGovernorCompatibilityBravo-proposals: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-proposals-uint256-[`IGovernorCompatibilityBravo.proposals`]]
  634. :IGovernorCompatibilityBravo-getActions: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-getActions-uint256-[`IGovernorCompatibilityBravo.getActions`]]
  635. :IGovernorCompatibilityBravo-getReceipt: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-getReceipt-uint256-address-[`IGovernorCompatibilityBravo.getReceipt`]]
  636. :IGovernorCompatibilityBravo-quorumVotes: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-quorumVotes--[`IGovernorCompatibilityBravo.quorumVotes`]]
  637. :IGovernor-hasVoted: pass:normal[xref:governance.adoc#IGovernor-hasVoted-uint256-address-[`IGovernor.hasVoted`]]
  638. :Governor-_quorumReached: pass:normal[xref:governance.adoc#Governor-_quorumReached-uint256-[`Governor._quorumReached`]]
  639. :Governor-_voteSucceeded: pass:normal[xref:governance.adoc#Governor-_voteSucceeded-uint256-[`Governor._voteSucceeded`]]
  640. :Governor-_countVote: pass:normal[xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`Governor._countVote`]]
  641. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  642. :xref-GovernorProposalThreshold-propose-address---uint256---bytes---string-: xref:governance.adoc#GovernorProposalThreshold-propose-address---uint256---bytes---string-
  643. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  644. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  645. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  646. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  647. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  648. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  649. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  650. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  651. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  652. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  653. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  654. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  655. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  656. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  657. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  658. :xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
  659. :xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
  660. :xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
  661. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  662. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  663. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  664. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  665. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  666. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  667. :xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
  668. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
  669. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  670. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  671. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  672. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  673. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  674. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  675. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  676. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  677. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  678. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  679. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  680. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  681. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  682. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  683. :xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
  684. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  685. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  686. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  687. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  688. :IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
  689. :ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
  690. :ERC721-balanceOf: pass:normal[xref:token/ERC721.adoc#ERC721-balanceOf-address-[`ERC721.balanceOf`]]
  691. :ERC721-_beforeTokenTransfer: pass:normal[xref:token/ERC721.adoc#ERC721-_beforeTokenTransfer-address-address-uint256-uint256-[`ERC721._beforeTokenTransfer`]]
  692. :xref-Votes-getVotes-address-: xref:governance.adoc#Votes-getVotes-address-
  693. :xref-Votes-getPastVotes-address-uint256-: xref:governance.adoc#Votes-getPastVotes-address-uint256-
  694. :xref-Votes-getPastTotalSupply-uint256-: xref:governance.adoc#Votes-getPastTotalSupply-uint256-
  695. :xref-Votes-_getTotalSupply--: xref:governance.adoc#Votes-_getTotalSupply--
  696. :xref-Votes-delegates-address-: xref:governance.adoc#Votes-delegates-address-
  697. :xref-Votes-delegate-address-: xref:governance.adoc#Votes-delegate-address-
  698. :xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-: xref:governance.adoc#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-
  699. :xref-Votes-_delegate-address-address-: xref:governance.adoc#Votes-_delegate-address-address-
  700. :xref-Votes-_transferVotingUnits-address-address-uint256-: xref:governance.adoc#Votes-_transferVotingUnits-address-address-uint256-
  701. :xref-Votes-_useNonce-address-: xref:governance.adoc#Votes-_useNonce-address-
  702. :xref-Votes-nonces-address-: xref:governance.adoc#Votes-nonces-address-
  703. :xref-Votes-DOMAIN_SEPARATOR--: xref:governance.adoc#Votes-DOMAIN_SEPARATOR--
  704. :xref-Votes-_getVotingUnits-address-: xref:governance.adoc#Votes-_getVotingUnits-address-
  705. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  706. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  707. :xref-IVotes-DelegateChanged-address-address-address-: xref:governance.adoc#IVotes-DelegateChanged-address-address-address-
  708. :xref-IVotes-DelegateVotesChanged-address-uint256-uint256-: xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-
  709. :IVotes-DelegateChanged: pass:normal[xref:governance.adoc#IVotes-DelegateChanged-address-address-address-[`IVotes.DelegateChanged`]]
  710. :IVotes-DelegateVotesChanged: pass:normal[xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-[`IVotes.DelegateVotesChanged`]]
  711. :EIP712: pass:normal[xref:utils.adoc#EIP712[`EIP712`]]
  712. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  713. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  714. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  715. :xref-TimelockController-onlyRoleOrOpenRole-bytes32-: xref:governance.adoc#TimelockController-onlyRoleOrOpenRole-bytes32-
  716. :xref-TimelockController-constructor-uint256-address---address---address-: xref:governance.adoc#TimelockController-constructor-uint256-address---address---address-
  717. :xref-TimelockController-receive--: xref:governance.adoc#TimelockController-receive--
  718. :xref-TimelockController-supportsInterface-bytes4-: xref:governance.adoc#TimelockController-supportsInterface-bytes4-
  719. :xref-TimelockController-isOperation-bytes32-: xref:governance.adoc#TimelockController-isOperation-bytes32-
  720. :xref-TimelockController-isOperationPending-bytes32-: xref:governance.adoc#TimelockController-isOperationPending-bytes32-
  721. :xref-TimelockController-isOperationReady-bytes32-: xref:governance.adoc#TimelockController-isOperationReady-bytes32-
  722. :xref-TimelockController-isOperationDone-bytes32-: xref:governance.adoc#TimelockController-isOperationDone-bytes32-
  723. :xref-TimelockController-getTimestamp-bytes32-: xref:governance.adoc#TimelockController-getTimestamp-bytes32-
  724. :xref-TimelockController-getMinDelay--: xref:governance.adoc#TimelockController-getMinDelay--
  725. :xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-
  726. :xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-
  727. :xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-
  728. :xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-
  729. :xref-TimelockController-cancel-bytes32-: xref:governance.adoc#TimelockController-cancel-bytes32-
  730. :xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-
  731. :xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-
  732. :xref-TimelockController-_execute-address-uint256-bytes-: xref:governance.adoc#TimelockController-_execute-address-uint256-bytes-
  733. :xref-TimelockController-updateDelay-uint256-: xref:governance.adoc#TimelockController-updateDelay-uint256-
  734. :xref-TimelockController-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#TimelockController-onERC721Received-address-address-uint256-bytes-
  735. :xref-TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-
  736. :xref-TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  737. :xref-AccessControl-hasRole-bytes32-address-: xref:access.adoc#AccessControl-hasRole-bytes32-address-
  738. :xref-AccessControl-_checkRole-bytes32-: xref:access.adoc#AccessControl-_checkRole-bytes32-
  739. :xref-AccessControl-_checkRole-bytes32-address-: xref:access.adoc#AccessControl-_checkRole-bytes32-address-
  740. :xref-AccessControl-getRoleAdmin-bytes32-: xref:access.adoc#AccessControl-getRoleAdmin-bytes32-
  741. :xref-AccessControl-grantRole-bytes32-address-: xref:access.adoc#AccessControl-grantRole-bytes32-address-
  742. :xref-AccessControl-revokeRole-bytes32-address-: xref:access.adoc#AccessControl-revokeRole-bytes32-address-
  743. :xref-AccessControl-renounceRole-bytes32-address-: xref:access.adoc#AccessControl-renounceRole-bytes32-address-
  744. :xref-AccessControl-_setupRole-bytes32-address-: xref:access.adoc#AccessControl-_setupRole-bytes32-address-
  745. :xref-AccessControl-_setRoleAdmin-bytes32-bytes32-: xref:access.adoc#AccessControl-_setRoleAdmin-bytes32-bytes32-
  746. :xref-AccessControl-_grantRole-bytes32-address-: xref:access.adoc#AccessControl-_grantRole-bytes32-address-
  747. :xref-AccessControl-_revokeRole-bytes32-address-: xref:access.adoc#AccessControl-_revokeRole-bytes32-address-
  748. :xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-: xref:governance.adoc#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-
  749. :xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-: xref:governance.adoc#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-
  750. :xref-TimelockController-Cancelled-bytes32-: xref:governance.adoc#TimelockController-Cancelled-bytes32-
  751. :xref-TimelockController-MinDelayChange-uint256-uint256-: xref:governance.adoc#TimelockController-MinDelayChange-uint256-uint256-
  752. :xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-: xref:access.adoc#IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-
  753. :xref-IAccessControl-RoleGranted-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleGranted-bytes32-address-address-
  754. :xref-IAccessControl-RoleRevoked-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleRevoked-bytes32-address-address-
  755. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  756. :IERC721Receiver-onERC721Received: pass:normal[xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-[`IERC721Receiver.onERC721Received`]]
  757. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
  758. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
  759. :AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
  760. = Governance
  761. [.readme-notice]
  762. NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/governance
  763. This directory includes primitives for on-chain governance.
  764. == Governor
  765. This modular system of Governor contracts allows the deployment on-chain voting protocols similar to https://compound.finance/docs/governance[Compound's Governor Alpha & Bravo] and beyond, through the ability to easily customize multiple aspects of the protocol.
  766. [TIP]
  767. ====
  768. For a guided experience, set up your Governor contract using https://wizard.openzeppelin.com/#governor[Contracts Wizard].
  769. For a written walkthrough, check out our guide on xref:ROOT:governance.adoc[How to set up on-chain governance].
  770. ====
  771. * {Governor}: The core contract that contains all the logic and primitives. It is abstract and requires choosing one of each of the modules below, or custom ones.
  772. Votes modules determine the source of voting power, and sometimes quorum number.
  773. * {GovernorVotes}: Extracts voting weight from an {ERC20Votes} token.
  774. * {GovernorVotesComp}: Extracts voting weight from a COMP-like or {ERC20VotesComp} token.
  775. * {GovernorVotesQuorumFraction}: Combines with `GovernorVotes` to set the quorum as a fraction of the total token supply.
  776. Counting modules determine valid voting options.
  777. * {GovernorCountingSimple}: Simple voting mechanism with 3 voting options: Against, For and Abstain.
  778. Timelock extensions add a delay for governance decisions to be executed. The workflow is extended to require a `queue` step before execution. With these modules, proposals are executed by the external timelock contract, thus it is the timelock that has to hold the assets that are being governed.
  779. * {GovernorTimelockControl}: Connects with an instance of {TimelockController}. Allows multiple proposers and executors, in addition to the Governor itself.
  780. * {GovernorTimelockCompound}: Connects with an instance of Compound's https://github.com/compound-finance/compound-protocol/blob/master/contracts/Timelock.sol[`Timelock`] contract.
  781. Other extensions can customize the behavior or interface in multiple ways.
  782. * {GovernorCompatibilityBravo}: Extends the interface to be fully `GovernorBravo`-compatible. Note that events are compatible regardless of whether this extension is included or not.
  783. * {GovernorSettings}: Manages some of the settings (voting delay, voting period duration, and proposal threshold) in a way that can be updated through a governance proposal, without requiring an upgrade.
  784. * {GovernorPreventLateQuorum}: Ensures there is a minimum voting period after quorum is reached as a security protection against large voters.
  785. In addition to modules and extensions, the core contract requires a few virtual functions to be implemented to your particular specifications:
  786. * <<Governor-votingDelay-,`votingDelay()`>>: Delay (in number of blocks) since the proposal is submitted until voting power is fixed and voting starts. This can be used to enforce a delay after a proposal is published for users to buy tokens, or delegate their votes.
  787. * <<Governor-votingPeriod-,`votingPeriod()`>>: Delay (in number of blocks) since the proposal starts until voting ends.
  788. * <<Governor-quorum-uint256-,`quorum(uint256 blockNumber)`>>: Quorum required for a proposal to be successful. This function includes a `blockNumber` argument so the quorum can adapt through time, for example, to follow a token's `totalSupply`.
  789. NOTE: Functions of the `Governor` contract do not include access control. If you want to restrict access, you should add these checks by overloading the particular functions. Among these, {Governor-_cancel} is internal by default, and you will have to expose it (with the right access control mechanism) yourself if this function is needed.
  790. === Core
  791. :ProposalState: pass:normal[xref:#IGovernor-ProposalState[`++ProposalState++`]]
  792. :ProposalCreated: pass:normal[xref:#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-[`++ProposalCreated++`]]
  793. :ProposalCanceled: pass:normal[xref:#IGovernor-ProposalCanceled-uint256-[`++ProposalCanceled++`]]
  794. :ProposalExecuted: pass:normal[xref:#IGovernor-ProposalExecuted-uint256-[`++ProposalExecuted++`]]
  795. :VoteCast: pass:normal[xref:#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`++VoteCast++`]]
  796. :VoteCastWithParams: pass:normal[xref:#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-[`++VoteCastWithParams++`]]
  797. :name: pass:normal[xref:#IGovernor-name--[`++name++`]]
  798. :version: pass:normal[xref:#IGovernor-version--[`++version++`]]
  799. :COUNTING_MODE: pass:normal[xref:#IGovernor-COUNTING_MODE--[`++COUNTING_MODE++`]]
  800. :hashProposal: pass:normal[xref:#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
  801. :state: pass:normal[xref:#IGovernor-state-uint256-[`++state++`]]
  802. :proposalSnapshot: pass:normal[xref:#IGovernor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
  803. :proposalDeadline: pass:normal[xref:#IGovernor-proposalDeadline-uint256-[`++proposalDeadline++`]]
  804. :votingDelay: pass:normal[xref:#IGovernor-votingDelay--[`++votingDelay++`]]
  805. :votingPeriod: pass:normal[xref:#IGovernor-votingPeriod--[`++votingPeriod++`]]
  806. :quorum: pass:normal[xref:#IGovernor-quorum-uint256-[`++quorum++`]]
  807. :getVotes: pass:normal[xref:#IGovernor-getVotes-address-uint256-[`++getVotes++`]]
  808. :getVotesWithParams: pass:normal[xref:#IGovernor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
  809. :hasVoted: pass:normal[xref:#IGovernor-hasVoted-uint256-address-[`++hasVoted++`]]
  810. :propose: pass:normal[xref:#IGovernor-propose-address---uint256---bytes---string-[`++propose++`]]
  811. :execute: pass:normal[xref:#IGovernor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
  812. :castVote: pass:normal[xref:#IGovernor-castVote-uint256-uint8-[`++castVote++`]]
  813. :castVoteWithReason: pass:normal[xref:#IGovernor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
  814. :castVoteWithReasonAndParams: pass:normal[xref:#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
  815. :castVoteBySig: pass:normal[xref:#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`++castVoteBySig++`]]
  816. :castVoteWithReasonAndParamsBySig: pass:normal[xref:#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`++castVoteWithReasonAndParamsBySig++`]]
  817. [.contract]
  818. [[IGovernor]]
  819. === `++IGovernor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/IGovernor.sol[{github-icon},role=heading-link]
  820. [.hljs-theme-light.nopadding]
  821. ```solidity
  822. import "@openzeppelin/contracts/governance/IGovernor.sol";
  823. ```
  824. Interface of the {Governor} core.
  825. _Available since v4.3._
  826. [.contract-index]
  827. .Functions
  828. --
  829. * {xref-IGovernor-name--}[`++name()++`]
  830. * {xref-IGovernor-version--}[`++version()++`]
  831. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  832. * {xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  833. * {xref-IGovernor-state-uint256-}[`++state(proposalId)++`]
  834. * {xref-IGovernor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  835. * {xref-IGovernor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  836. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  837. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  838. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  839. * {xref-IGovernor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  840. * {xref-IGovernor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  841. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  842. * {xref-IGovernor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  843. * {xref-IGovernor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  844. * {xref-IGovernor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  845. * {xref-IGovernor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  846. * {xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  847. * {xref-IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  848. * {xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  849. [.contract-subindex-inherited]
  850. .IERC165
  851. * {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  852. --
  853. [.contract-index]
  854. .Events
  855. --
  856. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  857. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  858. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  859. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  860. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  861. [.contract-subindex-inherited]
  862. .IERC165
  863. --
  864. [.contract-item]
  865. [[IGovernor-name--]]
  866. ==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#public#
  867. Name of the governor instance (used in building the ERC712 domain separator).
  868. [.contract-item]
  869. [[IGovernor-version--]]
  870. ==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#public#
  871. Version of the governor instance (used in building the ERC712 domain separator). Default: "1"
  872. [.contract-item]
  873. [[IGovernor-COUNTING_MODE--]]
  874. ==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#
  875. A description of the possible `support` values for {castVote} and the way these votes are counted, meant to
  876. be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of
  877. key-value pairs that each describe one aspect, for example `support=bravo&quorum=for,abstain`.
  878. There are 2 standard keys: `support` and `quorum`.
  879. - `support=bravo` refers to the vote options 0 = Against, 1 = For, 2 = Abstain, as in `GovernorBravo`.
  880. - `quorum=bravo` means that only For votes are counted towards quorum.
  881. - `quorum=for,abstain` means that both For and Abstain votes are counted towards quorum.
  882. If a counting module makes use of encoded `params`, it should include this under a `params` key with a unique
  883. name that describes the behavior. For example:
  884. - `params=fractional` might refer to a scheme where votes are divided fractionally between for/against/abstain.
  885. - `params=erc721` might refer to a scheme where specific NFTs are delegated to vote.
  886. NOTE: The string can be decoded by the standard
  887. https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[`URLSearchParams`]
  888. JavaScript class.
  889. [.contract-item]
  890. [[IGovernor-hashProposal-address---uint256---bytes---bytes32-]]
  891. ==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  892. Hashing function used to (re)build the proposal id from the proposal details..
  893. [.contract-item]
  894. [[IGovernor-state-uint256-]]
  895. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  896. Current state of a proposal, following Compound's convention
  897. [.contract-item]
  898. [[IGovernor-proposalSnapshot-uint256-]]
  899. ==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  900. Block number used to retrieve user's votes and quorum. As per Compound's Comp and OpenZeppelin's
  901. ERC20Votes, the snapshot is performed at the end of this block. Hence, voting for this proposal starts at the
  902. beginning of the following block.
  903. [.contract-item]
  904. [[IGovernor-proposalDeadline-uint256-]]
  905. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  906. Block number at which votes close. Votes close at the end of this block, so it is possible to cast a vote
  907. during this block.
  908. [.contract-item]
  909. [[IGovernor-votingDelay--]]
  910. ==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#
  911. Delay, in number of block, between the proposal is created and the vote starts. This can be increassed to
  912. leave time for users to buy voting power, or delegate it, before the voting of a proposal starts.
  913. [.contract-item]
  914. [[IGovernor-votingPeriod--]]
  915. ==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#
  916. Delay, in number of blocks, between the vote start and vote ends.
  917. NOTE: The {votingDelay} can delay the start of the vote. This must be considered when setting the voting
  918. duration compared to the voting delay.
  919. [.contract-item]
  920. [[IGovernor-quorum-uint256-]]
  921. ==== `[.contract-item-name]#++quorum++#++(uint256 blockNumber) → uint256++` [.item-kind]#public#
  922. Minimum number of cast voted required for a proposal to be successful.
  923. Note: The `blockNumber` parameter corresponds to the snapshot used for counting vote. This allows to scale the
  924. quorum depending on values such as the totalSupply of a token at this block (see {ERC20Votes}).
  925. [.contract-item]
  926. [[IGovernor-getVotes-address-uint256-]]
  927. ==== `[.contract-item-name]#++getVotes++#++(address account, uint256 blockNumber) → uint256++` [.item-kind]#public#
  928. Voting power of an `account` at a specific `blockNumber`.
  929. Note: this can be implemented in a number of ways, for example by reading the delegated balance from one (or
  930. multiple), {ERC20Votes} tokens.
  931. [.contract-item]
  932. [[IGovernor-getVotesWithParams-address-uint256-bytes-]]
  933. ==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 blockNumber, bytes params) → uint256++` [.item-kind]#public#
  934. Voting power of an `account` at a specific `blockNumber` given additional encoded parameters.
  935. [.contract-item]
  936. [[IGovernor-hasVoted-uint256-address-]]
  937. ==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#
  938. Returns whether `account` has cast a vote on `proposalId`.
  939. [.contract-item]
  940. [[IGovernor-propose-address---uint256---bytes---string-]]
  941. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256 proposalId++` [.item-kind]#public#
  942. Create a new proposal. Vote start {IGovernor-votingDelay} blocks after the proposal is created and ends
  943. {IGovernor-votingPeriod} blocks after the voting starts.
  944. Emits a {ProposalCreated} event.
  945. [.contract-item]
  946. [[IGovernor-execute-address---uint256---bytes---bytes32-]]
  947. ==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#public#
  948. Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the
  949. deadline to be reached.
  950. Emits a {ProposalExecuted} event.
  951. Note: some module can modify the requirements for execution, for example by adding an additional timelock.
  952. [.contract-item]
  953. [[IGovernor-castVote-uint256-uint8-]]
  954. ==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256 balance++` [.item-kind]#public#
  955. Cast a vote
  956. Emits a {VoteCast} event.
  957. [.contract-item]
  958. [[IGovernor-castVoteWithReason-uint256-uint8-string-]]
  959. ==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256 balance++` [.item-kind]#public#
  960. Cast a vote with a reason
  961. Emits a {VoteCast} event.
  962. [.contract-item]
  963. [[IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
  964. ==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256 balance++` [.item-kind]#public#
  965. Cast a vote with a reason and additional encoded parameters
  966. Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
  967. [.contract-item]
  968. [[IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-]]
  969. ==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) → uint256 balance++` [.item-kind]#public#
  970. Cast a vote using the user's cryptographic signature.
  971. Emits a {VoteCast} event.
  972. [.contract-item]
  973. [[IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-]]
  974. ==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, string reason, bytes params, uint8 v, bytes32 r, bytes32 s) → uint256 balance++` [.item-kind]#public#
  975. Cast a vote with a reason and additional encoded parameters using the user's cryptographic signature.
  976. Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
  977. [.contract-item]
  978. [[IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-]]
  979. ==== `[.contract-item-name]#++ProposalCreated++#++(uint256 proposalId, address proposer, address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, uint256 startBlock, uint256 endBlock, string description)++` [.item-kind]#event#
  980. Emitted when a proposal is created.
  981. [.contract-item]
  982. [[IGovernor-ProposalCanceled-uint256-]]
  983. ==== `[.contract-item-name]#++ProposalCanceled++#++(uint256 proposalId)++` [.item-kind]#event#
  984. Emitted when a proposal is canceled.
  985. [.contract-item]
  986. [[IGovernor-ProposalExecuted-uint256-]]
  987. ==== `[.contract-item-name]#++ProposalExecuted++#++(uint256 proposalId)++` [.item-kind]#event#
  988. Emitted when a proposal is executed.
  989. [.contract-item]
  990. [[IGovernor-VoteCast-address-uint256-uint8-uint256-string-]]
  991. ==== `[.contract-item-name]#++VoteCast++#++(address voter, uint256 proposalId, uint8 support, uint256 weight, string reason)++` [.item-kind]#event#
  992. Emitted when a vote is cast without params.
  993. Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.
  994. [.contract-item]
  995. [[IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-]]
  996. ==== `[.contract-item-name]#++VoteCastWithParams++#++(address voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)++` [.item-kind]#event#
  997. Emitted when a vote is cast with params.
  998. Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.
  999. `params` are additional encoded parameters. Their intepepretation also depends on the voting module used.
  1000. :BALLOT_TYPEHASH: pass:normal[xref:#Governor-BALLOT_TYPEHASH-bytes32[`++BALLOT_TYPEHASH++`]]
  1001. :EXTENDED_BALLOT_TYPEHASH: pass:normal[xref:#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32[`++EXTENDED_BALLOT_TYPEHASH++`]]
  1002. :ProposalCore: pass:normal[xref:#Governor-ProposalCore[`++ProposalCore++`]]
  1003. :_name: pass:normal[xref:#Governor-_name-string[`++_name++`]]
  1004. :_proposals: pass:normal[xref:#Governor-_proposals-mapping-uint256----struct-Governor-ProposalCore-[`++_proposals++`]]
  1005. :_governanceCall: pass:normal[xref:#Governor-_governanceCall-struct-DoubleEndedQueue-Bytes32Deque[`++_governanceCall++`]]
  1006. :onlyGovernance: pass:normal[xref:#Governor-onlyGovernance--[`++onlyGovernance++`]]
  1007. :constructor: pass:normal[xref:#Governor-constructor-string-[`++constructor++`]]
  1008. :receive: pass:normal[xref:#Governor-receive--[`++receive++`]]
  1009. :supportsInterface: pass:normal[xref:#Governor-supportsInterface-bytes4-[`++supportsInterface++`]]
  1010. :name: pass:normal[xref:#Governor-name--[`++name++`]]
  1011. :version: pass:normal[xref:#Governor-version--[`++version++`]]
  1012. :hashProposal: pass:normal[xref:#Governor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
  1013. :state: pass:normal[xref:#Governor-state-uint256-[`++state++`]]
  1014. :proposalSnapshot: pass:normal[xref:#Governor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
  1015. :proposalDeadline: pass:normal[xref:#Governor-proposalDeadline-uint256-[`++proposalDeadline++`]]
  1016. :proposalThreshold: pass:normal[xref:#Governor-proposalThreshold--[`++proposalThreshold++`]]
  1017. :_quorumReached: pass:normal[xref:#Governor-_quorumReached-uint256-[`++_quorumReached++`]]
  1018. :_voteSucceeded: pass:normal[xref:#Governor-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
  1019. :_getVotes: pass:normal[xref:#Governor-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
  1020. :_countVote: pass:normal[xref:#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
  1021. :_defaultParams: pass:normal[xref:#Governor-_defaultParams--[`++_defaultParams++`]]
  1022. :propose: pass:normal[xref:#Governor-propose-address---uint256---bytes---string-[`++propose++`]]
  1023. :execute: pass:normal[xref:#Governor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
  1024. :_execute: pass:normal[xref:#Governor-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
  1025. :_beforeExecute: pass:normal[xref:#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-[`++_beforeExecute++`]]
  1026. :_afterExecute: pass:normal[xref:#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-[`++_afterExecute++`]]
  1027. :_cancel: pass:normal[xref:#Governor-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  1028. :getVotes: pass:normal[xref:#Governor-getVotes-address-uint256-[`++getVotes++`]]
  1029. :getVotesWithParams: pass:normal[xref:#Governor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
  1030. :castVote: pass:normal[xref:#Governor-castVote-uint256-uint8-[`++castVote++`]]
  1031. :castVoteWithReason: pass:normal[xref:#Governor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
  1032. :castVoteWithReasonAndParams: pass:normal[xref:#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
  1033. :castVoteBySig: pass:normal[xref:#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`++castVoteBySig++`]]
  1034. :castVoteWithReasonAndParamsBySig: pass:normal[xref:#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`++castVoteWithReasonAndParamsBySig++`]]
  1035. :_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-[`++_castVote++`]]
  1036. :_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
  1037. :relay: pass:normal[xref:#Governor-relay-address-uint256-bytes-[`++relay++`]]
  1038. :_executor: pass:normal[xref:#Governor-_executor--[`++_executor++`]]
  1039. :onERC721Received: pass:normal[xref:#Governor-onERC721Received-address-address-uint256-bytes-[`++onERC721Received++`]]
  1040. :onERC1155Received: pass:normal[xref:#Governor-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
  1041. :onERC1155BatchReceived: pass:normal[xref:#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
  1042. [.contract]
  1043. [[Governor]]
  1044. === `++Governor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/Governor.sol[{github-icon},role=heading-link]
  1045. [.hljs-theme-light.nopadding]
  1046. ```solidity
  1047. import "@openzeppelin/contracts/governance/Governor.sol";
  1048. ```
  1049. Core of the governance system, designed to be extended though various modules.
  1050. This contract is abstract and requires several function to be implemented in various modules:
  1051. - A counting module must implement {quorum}, {_quorumReached}, {_voteSucceeded} and {_countVote}
  1052. - A voting module must implement {_getVotes}
  1053. - Additionanly, the {votingPeriod} must also be implemented
  1054. _Available since v4.3._
  1055. [.contract-index]
  1056. .Modifiers
  1057. --
  1058. * {xref-Governor-onlyGovernance--}[`++onlyGovernance()++`]
  1059. --
  1060. [.contract-index]
  1061. .Functions
  1062. --
  1063. * {xref-Governor-constructor-string-}[`++constructor(name_)++`]
  1064. * {xref-Governor-receive--}[`++receive()++`]
  1065. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1066. * {xref-Governor-name--}[`++name()++`]
  1067. * {xref-Governor-version--}[`++version()++`]
  1068. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1069. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1070. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1071. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1072. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1073. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1074. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1075. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  1076. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1077. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1078. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1079. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1080. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  1081. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1082. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1083. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1084. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1085. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1086. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1087. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1088. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1089. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1090. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1091. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1092. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1093. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1094. * {xref-Governor-_executor--}[`++_executor()++`]
  1095. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1096. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1097. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1098. [.contract-subindex-inherited]
  1099. .IERC1155Receiver
  1100. [.contract-subindex-inherited]
  1101. .IERC721Receiver
  1102. [.contract-subindex-inherited]
  1103. .IGovernor
  1104. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1105. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1106. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1107. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  1108. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1109. [.contract-subindex-inherited]
  1110. .EIP712
  1111. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1112. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1113. [.contract-subindex-inherited]
  1114. .ERC165
  1115. [.contract-subindex-inherited]
  1116. .IERC165
  1117. --
  1118. [.contract-index]
  1119. .Events
  1120. --
  1121. [.contract-subindex-inherited]
  1122. .IERC1155Receiver
  1123. [.contract-subindex-inherited]
  1124. .IERC721Receiver
  1125. [.contract-subindex-inherited]
  1126. .IGovernor
  1127. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1128. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1129. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1130. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1131. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1132. [.contract-subindex-inherited]
  1133. .EIP712
  1134. [.contract-subindex-inherited]
  1135. .ERC165
  1136. [.contract-subindex-inherited]
  1137. .IERC165
  1138. --
  1139. [.contract-item]
  1140. [[Governor-onlyGovernance--]]
  1141. ==== `[.contract-item-name]#++onlyGovernance++#++()++` [.item-kind]#modifier#
  1142. Restricts a function so it can only be executed through governance proposals. For example, governance
  1143. parameter setters in {GovernorSettings} are protected using this modifier.
  1144. The governance executing address may be different from the Governor's own address, for example it could be a
  1145. timelock. This can be customized by modules by overriding {_executor}. The executor is only able to invoke these
  1146. functions during the execution of the governor's {execute} function, and not under any other circumstances. Thus,
  1147. for example, additional timelock proposers are not able to change governance parameters without going through the
  1148. governance protocol (since v4.6).
  1149. [.contract-item]
  1150. [[Governor-constructor-string-]]
  1151. ==== `[.contract-item-name]#++constructor++#++(string name_)++` [.item-kind]#internal#
  1152. Sets the value for {name} and {version}
  1153. [.contract-item]
  1154. [[Governor-receive--]]
  1155. ==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#
  1156. Function to receive ETH that will be handled by the governor (disabled if executor is a third party contract)
  1157. [.contract-item]
  1158. [[Governor-supportsInterface-bytes4-]]
  1159. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  1160. See {IERC165-supportsInterface}.
  1161. [.contract-item]
  1162. [[Governor-name--]]
  1163. ==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#public#
  1164. See {IGovernor-name}.
  1165. [.contract-item]
  1166. [[Governor-version--]]
  1167. ==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#public#
  1168. See {IGovernor-version}.
  1169. [.contract-item]
  1170. [[Governor-hashProposal-address---uint256---bytes---bytes32-]]
  1171. ==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1172. See {IGovernor-hashProposal}.
  1173. The proposal id is produced by hashing the ABI encoded `targets` array, the `values` array, the `calldatas` array
  1174. and the descriptionHash (bytes32 which itself is the keccak256 hash of the description string). This proposal id
  1175. can be produced from the proposal data which is part of the {ProposalCreated} event. It can even be computed in
  1176. advance, before the proposal is submitted.
  1177. Note that the chainId and the governor address are not part of the proposal id computation. Consequently, the
  1178. same proposal (with same operation and same description) will have the same id if submitted on multiple governors
  1179. across multiple networks. This also means that in order to execute the same operation twice (on the same
  1180. governor) the proposer will have to change the description in order to avoid proposal id conflicts.
  1181. [.contract-item]
  1182. [[Governor-state-uint256-]]
  1183. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  1184. See {IGovernor-state}.
  1185. [.contract-item]
  1186. [[Governor-proposalSnapshot-uint256-]]
  1187. ==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1188. See {IGovernor-proposalSnapshot}.
  1189. [.contract-item]
  1190. [[Governor-proposalDeadline-uint256-]]
  1191. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1192. See {IGovernor-proposalDeadline}.
  1193. [.contract-item]
  1194. [[Governor-proposalThreshold--]]
  1195. ==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#
  1196. Part of the Governor Bravo's interface: _"The number of votes required in order for a voter to become a proposer"_.
  1197. [.contract-item]
  1198. [[Governor-_quorumReached-uint256-]]
  1199. ==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1200. Amount of votes already cast passes the threshold limit.
  1201. [.contract-item]
  1202. [[Governor-_voteSucceeded-uint256-]]
  1203. ==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1204. Is the proposal successful or not.
  1205. [.contract-item]
  1206. [[Governor-_getVotes-address-uint256-bytes-]]
  1207. ==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 blockNumber, bytes params) → uint256++` [.item-kind]#internal#
  1208. Get the voting weight of `account` at a specific `blockNumber`, for a vote as described by `params`.
  1209. [.contract-item]
  1210. [[Governor-_countVote-uint256-address-uint8-uint256-bytes-]]
  1211. ==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes params)++` [.item-kind]#internal#
  1212. Register a vote for `proposalId` by `account` with a given `support`, voting `weight` and voting `params`.
  1213. Note: Support is generic and can represent various things depending on the voting system used.
  1214. [.contract-item]
  1215. [[Governor-_defaultParams--]]
  1216. ==== `[.contract-item-name]#++_defaultParams++#++() → bytes++` [.item-kind]#internal#
  1217. Default additional encoded parameters used by castVote methods that don't include them
  1218. Note: Should be overridden by specific implementations to use an appropriate value, the
  1219. meaning of the additional params, in the context of that implementation
  1220. [.contract-item]
  1221. [[Governor-propose-address---uint256---bytes---string-]]
  1222. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  1223. See {IGovernor-propose}.
  1224. [.contract-item]
  1225. [[Governor-execute-address---uint256---bytes---bytes32-]]
  1226. ==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1227. See {IGovernor-execute}.
  1228. [.contract-item]
  1229. [[Governor-_execute-uint256-address---uint256---bytes---bytes32-]]
  1230. ==== `[.contract-item-name]#++_execute++#++(uint256, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  1231. Internal execution mechanism. Can be overridden to implement different execution mechanism
  1232. [.contract-item]
  1233. [[Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-]]
  1234. ==== `[.contract-item-name]#++_beforeExecute++#++(uint256, address[] targets, uint256[], bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  1235. Hook before execution is triggered.
  1236. [.contract-item]
  1237. [[Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-]]
  1238. ==== `[.contract-item-name]#++_afterExecute++#++(uint256, address[], uint256[], bytes[], bytes32)++` [.item-kind]#internal#
  1239. Hook after execution is triggered.
  1240. [.contract-item]
  1241. [[Governor-_cancel-address---uint256---bytes---bytes32-]]
  1242. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  1243. Internal cancel mechanism: locks up the proposal timer, preventing it from being re-submitted. Marks it as
  1244. canceled to allow distinguishing it from executed proposals.
  1245. Emits a {IGovernor-ProposalCanceled} event.
  1246. [.contract-item]
  1247. [[Governor-getVotes-address-uint256-]]
  1248. ==== `[.contract-item-name]#++getVotes++#++(address account, uint256 blockNumber) → uint256++` [.item-kind]#public#
  1249. See {IGovernor-getVotes}.
  1250. [.contract-item]
  1251. [[Governor-getVotesWithParams-address-uint256-bytes-]]
  1252. ==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 blockNumber, bytes params) → uint256++` [.item-kind]#public#
  1253. See {IGovernor-getVotesWithParams}.
  1254. [.contract-item]
  1255. [[Governor-castVote-uint256-uint8-]]
  1256. ==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256++` [.item-kind]#public#
  1257. See {IGovernor-castVote}.
  1258. [.contract-item]
  1259. [[Governor-castVoteWithReason-uint256-uint8-string-]]
  1260. ==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256++` [.item-kind]#public#
  1261. See {IGovernor-castVoteWithReason}.
  1262. [.contract-item]
  1263. [[Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
  1264. ==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#public#
  1265. See {IGovernor-castVoteWithReasonAndParams}.
  1266. [.contract-item]
  1267. [[Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-]]
  1268. ==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) → uint256++` [.item-kind]#public#
  1269. See {IGovernor-castVoteBySig}.
  1270. [.contract-item]
  1271. [[Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-]]
  1272. ==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, string reason, bytes params, uint8 v, bytes32 r, bytes32 s) → uint256++` [.item-kind]#public#
  1273. See {IGovernor-castVoteWithReasonAndParamsBySig}.
  1274. [.contract-item]
  1275. [[Governor-_castVote-uint256-address-uint8-string-]]
  1276. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason) → uint256++` [.item-kind]#internal#
  1277. Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
  1278. voting weight using {IGovernor-getVotes} and call the {_countVote} internal function. Uses the _defaultParams().
  1279. Emits a {IGovernor-VoteCast} event.
  1280. [.contract-item]
  1281. [[Governor-_castVote-uint256-address-uint8-string-bytes-]]
  1282. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#
  1283. Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
  1284. voting weight using {IGovernor-getVotes} and call the {_countVote} internal function.
  1285. Emits a {IGovernor-VoteCast} event.
  1286. [.contract-item]
  1287. [[Governor-relay-address-uint256-bytes-]]
  1288. ==== `[.contract-item-name]#++relay++#++(address target, uint256 value, bytes data)++` [.item-kind]#external#
  1289. Relays a transaction or function call to an arbitrary target. In cases where the governance executor
  1290. is some contract other than the governor itself, like when using a timelock, this function can be invoked
  1291. in a governance proposal to recover tokens or Ether that was sent to the governor contract by mistake.
  1292. Note that if the executor is simply the governor itself, use of `relay` is redundant.
  1293. [.contract-item]
  1294. [[Governor-_executor--]]
  1295. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  1296. Address through which the governor executes action. Will be overloaded by module that execute actions
  1297. through another contract such as a timelock.
  1298. [.contract-item]
  1299. [[Governor-onERC721Received-address-address-uint256-bytes-]]
  1300. ==== `[.contract-item-name]#++onERC721Received++#++(address, address, uint256, bytes) → bytes4++` [.item-kind]#public#
  1301. See {IERC721Receiver-onERC721Received}.
  1302. [.contract-item]
  1303. [[Governor-onERC1155Received-address-address-uint256-uint256-bytes-]]
  1304. ==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#
  1305. See {IERC1155Receiver-onERC1155Received}.
  1306. [.contract-item]
  1307. [[Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
  1308. ==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#
  1309. See {IERC1155Receiver-onERC1155BatchReceived}.
  1310. === Modules
  1311. :VoteType: pass:normal[xref:#GovernorCountingSimple-VoteType[`++VoteType++`]]
  1312. :ProposalVote: pass:normal[xref:#GovernorCountingSimple-ProposalVote[`++ProposalVote++`]]
  1313. :_proposalVotes: pass:normal[xref:#GovernorCountingSimple-_proposalVotes-mapping-uint256----struct-GovernorCountingSimple-ProposalVote-[`++_proposalVotes++`]]
  1314. :COUNTING_MODE: pass:normal[xref:#GovernorCountingSimple-COUNTING_MODE--[`++COUNTING_MODE++`]]
  1315. :hasVoted: pass:normal[xref:#GovernorCountingSimple-hasVoted-uint256-address-[`++hasVoted++`]]
  1316. :proposalVotes: pass:normal[xref:#GovernorCountingSimple-proposalVotes-uint256-[`++proposalVotes++`]]
  1317. :_quorumReached: pass:normal[xref:#GovernorCountingSimple-_quorumReached-uint256-[`++_quorumReached++`]]
  1318. :_voteSucceeded: pass:normal[xref:#GovernorCountingSimple-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
  1319. :_countVote: pass:normal[xref:#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
  1320. [.contract]
  1321. [[GovernorCountingSimple]]
  1322. === `++GovernorCountingSimple++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorCountingSimple.sol[{github-icon},role=heading-link]
  1323. [.hljs-theme-light.nopadding]
  1324. ```solidity
  1325. import "@openzeppelin/contracts/governance/extensions/GovernorCountingSimple.sol";
  1326. ```
  1327. Extension of {Governor} for simple, 3 options, vote counting.
  1328. _Available since v4.3._
  1329. [.contract-index]
  1330. .Functions
  1331. --
  1332. * {xref-GovernorCountingSimple-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1333. * {xref-GovernorCountingSimple-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1334. * {xref-GovernorCountingSimple-proposalVotes-uint256-}[`++proposalVotes(proposalId)++`]
  1335. * {xref-GovernorCountingSimple-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1336. * {xref-GovernorCountingSimple-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1337. * {xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, )++`]
  1338. [.contract-subindex-inherited]
  1339. .Governor
  1340. * {xref-Governor-receive--}[`++receive()++`]
  1341. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1342. * {xref-Governor-name--}[`++name()++`]
  1343. * {xref-Governor-version--}[`++version()++`]
  1344. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1345. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1346. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1347. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1348. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1349. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  1350. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1351. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1352. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1353. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  1354. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1355. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1356. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1357. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1358. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1359. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1360. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1361. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1362. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1363. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1364. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1365. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1366. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1367. * {xref-Governor-_executor--}[`++_executor()++`]
  1368. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1369. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1370. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1371. [.contract-subindex-inherited]
  1372. .IERC1155Receiver
  1373. [.contract-subindex-inherited]
  1374. .IERC721Receiver
  1375. [.contract-subindex-inherited]
  1376. .IGovernor
  1377. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1378. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1379. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  1380. [.contract-subindex-inherited]
  1381. .EIP712
  1382. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1383. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1384. [.contract-subindex-inherited]
  1385. .ERC165
  1386. [.contract-subindex-inherited]
  1387. .IERC165
  1388. --
  1389. [.contract-index]
  1390. .Events
  1391. --
  1392. [.contract-subindex-inherited]
  1393. .Governor
  1394. [.contract-subindex-inherited]
  1395. .IERC1155Receiver
  1396. [.contract-subindex-inherited]
  1397. .IERC721Receiver
  1398. [.contract-subindex-inherited]
  1399. .IGovernor
  1400. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1401. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1402. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1403. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1404. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1405. [.contract-subindex-inherited]
  1406. .EIP712
  1407. [.contract-subindex-inherited]
  1408. .ERC165
  1409. [.contract-subindex-inherited]
  1410. .IERC165
  1411. --
  1412. [.contract-item]
  1413. [[GovernorCountingSimple-COUNTING_MODE--]]
  1414. ==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#
  1415. See {IGovernor-COUNTING_MODE}.
  1416. [.contract-item]
  1417. [[GovernorCountingSimple-hasVoted-uint256-address-]]
  1418. ==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#
  1419. See {IGovernor-hasVoted}.
  1420. [.contract-item]
  1421. [[GovernorCountingSimple-proposalVotes-uint256-]]
  1422. ==== `[.contract-item-name]#++proposalVotes++#++(uint256 proposalId) → uint256 againstVotes, uint256 forVotes, uint256 abstainVotes++` [.item-kind]#public#
  1423. Accessor to the internal vote counts.
  1424. [.contract-item]
  1425. [[GovernorCountingSimple-_quorumReached-uint256-]]
  1426. ==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1427. See {Governor-_quorumReached}.
  1428. [.contract-item]
  1429. [[GovernorCountingSimple-_voteSucceeded-uint256-]]
  1430. ==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1431. See {Governor-_voteSucceeded}. In this module, the forVotes must be strictly over the againstVotes.
  1432. [.contract-item]
  1433. [[GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-]]
  1434. ==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes)++` [.item-kind]#internal#
  1435. See {Governor-_countVote}. In this module, the support follows the `VoteType` enum (from Governor Bravo).
  1436. :token: pass:normal[xref:#GovernorVotes-token-contract-IVotes[`++token++`]]
  1437. :constructor: pass:normal[xref:#GovernorVotes-constructor-contract-IVotes-[`++constructor++`]]
  1438. :_getVotes: pass:normal[xref:#GovernorVotes-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
  1439. [.contract]
  1440. [[GovernorVotes]]
  1441. === `++GovernorVotes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorVotes.sol[{github-icon},role=heading-link]
  1442. [.hljs-theme-light.nopadding]
  1443. ```solidity
  1444. import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol";
  1445. ```
  1446. Extension of {Governor} for voting weight extraction from an {ERC20Votes} token, or since v4.5 an {ERC721Votes} token.
  1447. _Available since v4.3._
  1448. [.contract-index]
  1449. .Functions
  1450. --
  1451. * {xref-GovernorVotes-constructor-contract-IVotes-}[`++constructor(tokenAddress)++`]
  1452. * {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, )++`]
  1453. [.contract-subindex-inherited]
  1454. .Governor
  1455. * {xref-Governor-receive--}[`++receive()++`]
  1456. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1457. * {xref-Governor-name--}[`++name()++`]
  1458. * {xref-Governor-version--}[`++version()++`]
  1459. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1460. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1461. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1462. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1463. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1464. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1465. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1466. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1467. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1468. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1469. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1470. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  1471. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1472. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1473. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1474. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1475. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1476. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1477. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1478. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1479. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1480. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1481. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1482. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1483. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1484. * {xref-Governor-_executor--}[`++_executor()++`]
  1485. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1486. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1487. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1488. [.contract-subindex-inherited]
  1489. .IERC1155Receiver
  1490. [.contract-subindex-inherited]
  1491. .IERC721Receiver
  1492. [.contract-subindex-inherited]
  1493. .IGovernor
  1494. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1495. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1496. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1497. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  1498. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1499. [.contract-subindex-inherited]
  1500. .EIP712
  1501. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1502. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1503. [.contract-subindex-inherited]
  1504. .ERC165
  1505. [.contract-subindex-inherited]
  1506. .IERC165
  1507. --
  1508. [.contract-index]
  1509. .Events
  1510. --
  1511. [.contract-subindex-inherited]
  1512. .Governor
  1513. [.contract-subindex-inherited]
  1514. .IERC1155Receiver
  1515. [.contract-subindex-inherited]
  1516. .IERC721Receiver
  1517. [.contract-subindex-inherited]
  1518. .IGovernor
  1519. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1520. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1521. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1522. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1523. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1524. [.contract-subindex-inherited]
  1525. .EIP712
  1526. [.contract-subindex-inherited]
  1527. .ERC165
  1528. [.contract-subindex-inherited]
  1529. .IERC165
  1530. --
  1531. [.contract-item]
  1532. [[GovernorVotes-constructor-contract-IVotes-]]
  1533. ==== `[.contract-item-name]#++constructor++#++(contract IVotes tokenAddress)++` [.item-kind]#internal#
  1534. [.contract-item]
  1535. [[GovernorVotes-_getVotes-address-uint256-bytes-]]
  1536. ==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 blockNumber, bytes) → uint256++` [.item-kind]#internal#
  1537. :_quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-_quorumNumerator-uint256[`++_quorumNumerator++`]]
  1538. :_quorumNumeratorHistory: pass:normal[xref:#GovernorVotesQuorumFraction-_quorumNumeratorHistory-struct-Checkpoints-History[`++_quorumNumeratorHistory++`]]
  1539. :QuorumNumeratorUpdated: pass:normal[xref:#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-[`++QuorumNumeratorUpdated++`]]
  1540. :constructor: pass:normal[xref:#GovernorVotesQuorumFraction-constructor-uint256-[`++constructor++`]]
  1541. :quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator--[`++quorumNumerator++`]]
  1542. :quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator-uint256-[`++quorumNumerator++`]]
  1543. :quorumDenominator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumDenominator--[`++quorumDenominator++`]]
  1544. :quorum: pass:normal[xref:#GovernorVotesQuorumFraction-quorum-uint256-[`++quorum++`]]
  1545. :updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-[`++updateQuorumNumerator++`]]
  1546. :_updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-[`++_updateQuorumNumerator++`]]
  1547. [.contract]
  1548. [[GovernorVotesQuorumFraction]]
  1549. === `++GovernorVotesQuorumFraction++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorVotesQuorumFraction.sol[{github-icon},role=heading-link]
  1550. [.hljs-theme-light.nopadding]
  1551. ```solidity
  1552. import "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";
  1553. ```
  1554. Extension of {Governor} for voting weight extraction from an {ERC20Votes} token and a quorum expressed as a
  1555. fraction of the total supply.
  1556. _Available since v4.3._
  1557. [.contract-index]
  1558. .Functions
  1559. --
  1560. * {xref-GovernorVotesQuorumFraction-constructor-uint256-}[`++constructor(quorumNumeratorValue)++`]
  1561. * {xref-GovernorVotesQuorumFraction-quorumNumerator--}[`++quorumNumerator()++`]
  1562. * {xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-}[`++quorumNumerator(blockNumber)++`]
  1563. * {xref-GovernorVotesQuorumFraction-quorumDenominator--}[`++quorumDenominator()++`]
  1564. * {xref-GovernorVotesQuorumFraction-quorum-uint256-}[`++quorum(blockNumber)++`]
  1565. * {xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-}[`++updateQuorumNumerator(newQuorumNumerator)++`]
  1566. * {xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-}[`++_updateQuorumNumerator(newQuorumNumerator)++`]
  1567. [.contract-subindex-inherited]
  1568. .GovernorVotes
  1569. * {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, )++`]
  1570. [.contract-subindex-inherited]
  1571. .Governor
  1572. * {xref-Governor-receive--}[`++receive()++`]
  1573. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1574. * {xref-Governor-name--}[`++name()++`]
  1575. * {xref-Governor-version--}[`++version()++`]
  1576. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1577. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1578. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1579. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1580. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1581. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1582. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1583. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1584. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1585. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1586. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1587. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  1588. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1589. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1590. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1591. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1592. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1593. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1594. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1595. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1596. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1597. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1598. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1599. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1600. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1601. * {xref-Governor-_executor--}[`++_executor()++`]
  1602. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1603. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1604. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1605. [.contract-subindex-inherited]
  1606. .IERC1155Receiver
  1607. [.contract-subindex-inherited]
  1608. .IERC721Receiver
  1609. [.contract-subindex-inherited]
  1610. .IGovernor
  1611. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1612. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1613. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1614. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1615. [.contract-subindex-inherited]
  1616. .EIP712
  1617. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1618. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1619. [.contract-subindex-inherited]
  1620. .ERC165
  1621. [.contract-subindex-inherited]
  1622. .IERC165
  1623. --
  1624. [.contract-index]
  1625. .Events
  1626. --
  1627. * {xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-}[`++QuorumNumeratorUpdated(oldQuorumNumerator, newQuorumNumerator)++`]
  1628. [.contract-subindex-inherited]
  1629. .GovernorVotes
  1630. [.contract-subindex-inherited]
  1631. .Governor
  1632. [.contract-subindex-inherited]
  1633. .IERC1155Receiver
  1634. [.contract-subindex-inherited]
  1635. .IERC721Receiver
  1636. [.contract-subindex-inherited]
  1637. .IGovernor
  1638. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1639. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1640. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1641. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1642. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1643. [.contract-subindex-inherited]
  1644. .EIP712
  1645. [.contract-subindex-inherited]
  1646. .ERC165
  1647. [.contract-subindex-inherited]
  1648. .IERC165
  1649. --
  1650. [.contract-item]
  1651. [[GovernorVotesQuorumFraction-constructor-uint256-]]
  1652. ==== `[.contract-item-name]#++constructor++#++(uint256 quorumNumeratorValue)++` [.item-kind]#internal#
  1653. Initialize quorum as a fraction of the token's total supply.
  1654. The fraction is specified as `numerator / denominator`. By default the denominator is 100, so quorum is
  1655. specified as a percent: a numerator of 10 corresponds to quorum being 10% of total supply. The denominator can be
  1656. customized by overriding {quorumDenominator}.
  1657. [.contract-item]
  1658. [[GovernorVotesQuorumFraction-quorumNumerator--]]
  1659. ==== `[.contract-item-name]#++quorumNumerator++#++() → uint256++` [.item-kind]#public#
  1660. Returns the current quorum numerator. See {quorumDenominator}.
  1661. [.contract-item]
  1662. [[GovernorVotesQuorumFraction-quorumNumerator-uint256-]]
  1663. ==== `[.contract-item-name]#++quorumNumerator++#++(uint256 blockNumber) → uint256++` [.item-kind]#public#
  1664. Returns the quorum numerator at a specific block number. See {quorumDenominator}.
  1665. [.contract-item]
  1666. [[GovernorVotesQuorumFraction-quorumDenominator--]]
  1667. ==== `[.contract-item-name]#++quorumDenominator++#++() → uint256++` [.item-kind]#public#
  1668. Returns the quorum denominator. Defaults to 100, but may be overridden.
  1669. [.contract-item]
  1670. [[GovernorVotesQuorumFraction-quorum-uint256-]]
  1671. ==== `[.contract-item-name]#++quorum++#++(uint256 blockNumber) → uint256++` [.item-kind]#public#
  1672. Returns the quorum for a block number, in terms of number of votes: `supply * numerator / denominator`.
  1673. [.contract-item]
  1674. [[GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-]]
  1675. ==== `[.contract-item-name]#++updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#external#
  1676. Changes the quorum numerator.
  1677. Emits a {QuorumNumeratorUpdated} event.
  1678. Requirements:
  1679. - Must be called through a governance proposal.
  1680. - New numerator must be smaller or equal to the denominator.
  1681. [.contract-item]
  1682. [[GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-]]
  1683. ==== `[.contract-item-name]#++_updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#internal#
  1684. Changes the quorum numerator.
  1685. Emits a {QuorumNumeratorUpdated} event.
  1686. Requirements:
  1687. - New numerator must be smaller or equal to the denominator.
  1688. [.contract-item]
  1689. [[GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-]]
  1690. ==== `[.contract-item-name]#++QuorumNumeratorUpdated++#++(uint256 oldQuorumNumerator, uint256 newQuorumNumerator)++` [.item-kind]#event#
  1691. :token: pass:normal[xref:#GovernorVotesComp-token-contract-ERC20VotesComp[`++token++`]]
  1692. :constructor: pass:normal[xref:#GovernorVotesComp-constructor-contract-ERC20VotesComp-[`++constructor++`]]
  1693. :_getVotes: pass:normal[xref:#GovernorVotesComp-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
  1694. [.contract]
  1695. [[GovernorVotesComp]]
  1696. === `++GovernorVotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorVotesComp.sol[{github-icon},role=heading-link]
  1697. [.hljs-theme-light.nopadding]
  1698. ```solidity
  1699. import "@openzeppelin/contracts/governance/extensions/GovernorVotesComp.sol";
  1700. ```
  1701. Extension of {Governor} for voting weight extraction from a Comp token.
  1702. _Available since v4.3._
  1703. [.contract-index]
  1704. .Functions
  1705. --
  1706. * {xref-GovernorVotesComp-constructor-contract-ERC20VotesComp-}[`++constructor(token_)++`]
  1707. * {xref-GovernorVotesComp-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, )++`]
  1708. [.contract-subindex-inherited]
  1709. .Governor
  1710. * {xref-Governor-receive--}[`++receive()++`]
  1711. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1712. * {xref-Governor-name--}[`++name()++`]
  1713. * {xref-Governor-version--}[`++version()++`]
  1714. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1715. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1716. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1717. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1718. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1719. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1720. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1721. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1722. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1723. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1724. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1725. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  1726. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1727. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1728. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1729. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1730. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1731. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1732. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1733. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1734. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1735. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1736. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1737. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1738. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1739. * {xref-Governor-_executor--}[`++_executor()++`]
  1740. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1741. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1742. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1743. [.contract-subindex-inherited]
  1744. .IERC1155Receiver
  1745. [.contract-subindex-inherited]
  1746. .IERC721Receiver
  1747. [.contract-subindex-inherited]
  1748. .IGovernor
  1749. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1750. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1751. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1752. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  1753. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1754. [.contract-subindex-inherited]
  1755. .EIP712
  1756. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1757. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1758. [.contract-subindex-inherited]
  1759. .ERC165
  1760. [.contract-subindex-inherited]
  1761. .IERC165
  1762. --
  1763. [.contract-index]
  1764. .Events
  1765. --
  1766. [.contract-subindex-inherited]
  1767. .Governor
  1768. [.contract-subindex-inherited]
  1769. .IERC1155Receiver
  1770. [.contract-subindex-inherited]
  1771. .IERC721Receiver
  1772. [.contract-subindex-inherited]
  1773. .IGovernor
  1774. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1775. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1776. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1777. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1778. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1779. [.contract-subindex-inherited]
  1780. .EIP712
  1781. [.contract-subindex-inherited]
  1782. .ERC165
  1783. [.contract-subindex-inherited]
  1784. .IERC165
  1785. --
  1786. [.contract-item]
  1787. [[GovernorVotesComp-constructor-contract-ERC20VotesComp-]]
  1788. ==== `[.contract-item-name]#++constructor++#++(contract ERC20VotesComp token_)++` [.item-kind]#internal#
  1789. [.contract-item]
  1790. [[GovernorVotesComp-_getVotes-address-uint256-bytes-]]
  1791. ==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 blockNumber, bytes) → uint256++` [.item-kind]#internal#
  1792. === Extensions
  1793. :_timelock: pass:normal[xref:#GovernorTimelockControl-_timelock-contract-TimelockController[`++_timelock++`]]
  1794. :_timelockIds: pass:normal[xref:#GovernorTimelockControl-_timelockIds-mapping-uint256----bytes32-[`++_timelockIds++`]]
  1795. :TimelockChange: pass:normal[xref:#GovernorTimelockControl-TimelockChange-address-address-[`++TimelockChange++`]]
  1796. :constructor: pass:normal[xref:#GovernorTimelockControl-constructor-contract-TimelockController-[`++constructor++`]]
  1797. :supportsInterface: pass:normal[xref:#GovernorTimelockControl-supportsInterface-bytes4-[`++supportsInterface++`]]
  1798. :state: pass:normal[xref:#GovernorTimelockControl-state-uint256-[`++state++`]]
  1799. :timelock: pass:normal[xref:#GovernorTimelockControl-timelock--[`++timelock++`]]
  1800. :proposalEta: pass:normal[xref:#GovernorTimelockControl-proposalEta-uint256-[`++proposalEta++`]]
  1801. :queue: pass:normal[xref:#GovernorTimelockControl-queue-address---uint256---bytes---bytes32-[`++queue++`]]
  1802. :_execute: pass:normal[xref:#GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
  1803. :_cancel: pass:normal[xref:#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  1804. :_executor: pass:normal[xref:#GovernorTimelockControl-_executor--[`++_executor++`]]
  1805. :updateTimelock: pass:normal[xref:#GovernorTimelockControl-updateTimelock-contract-TimelockController-[`++updateTimelock++`]]
  1806. :_updateTimelock: pass:normal[xref:#GovernorTimelockControl-_updateTimelock-contract-TimelockController-[`++_updateTimelock++`]]
  1807. [.contract]
  1808. [[GovernorTimelockControl]]
  1809. === `++GovernorTimelockControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorTimelockControl.sol[{github-icon},role=heading-link]
  1810. [.hljs-theme-light.nopadding]
  1811. ```solidity
  1812. import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol";
  1813. ```
  1814. Extension of {Governor} that binds the execution process to an instance of {TimelockController}. This adds a
  1815. delay, enforced by the {TimelockController} to all successful proposal (in addition to the voting duration). The
  1816. {Governor} needs the proposer (and ideally the executor) roles for the {Governor} to work properly.
  1817. Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
  1818. the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
  1819. inaccessible.
  1820. WARNING: Setting up the TimelockController to have additional proposers besides the governor is very risky, as it
  1821. grants them powers that they must be trusted or known not to use: 1) {onlyGovernance} functions like {relay} are
  1822. available to them through the timelock, and 2) approved governance proposals can be blocked by them, effectively
  1823. executing a Denial of Service attack. This risk will be mitigated in a future release.
  1824. _Available since v4.3._
  1825. [.contract-index]
  1826. .Functions
  1827. --
  1828. * {xref-GovernorTimelockControl-constructor-contract-TimelockController-}[`++constructor(timelockAddress)++`]
  1829. * {xref-GovernorTimelockControl-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1830. * {xref-GovernorTimelockControl-state-uint256-}[`++state(proposalId)++`]
  1831. * {xref-GovernorTimelockControl-timelock--}[`++timelock()++`]
  1832. * {xref-GovernorTimelockControl-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  1833. * {xref-GovernorTimelockControl-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  1834. * {xref-GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, descriptionHash)++`]
  1835. * {xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1836. * {xref-GovernorTimelockControl-_executor--}[`++_executor()++`]
  1837. * {xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-}[`++updateTimelock(newTimelock)++`]
  1838. [.contract-subindex-inherited]
  1839. .Governor
  1840. * {xref-Governor-receive--}[`++receive()++`]
  1841. * {xref-Governor-name--}[`++name()++`]
  1842. * {xref-Governor-version--}[`++version()++`]
  1843. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1844. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1845. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1846. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1847. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1848. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1849. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  1850. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1851. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1852. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1853. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1854. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  1855. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  1856. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  1857. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  1858. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1859. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1860. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1861. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  1862. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  1863. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1864. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1865. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1866. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1867. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1868. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1869. [.contract-subindex-inherited]
  1870. .IERC1155Receiver
  1871. [.contract-subindex-inherited]
  1872. .IERC721Receiver
  1873. [.contract-subindex-inherited]
  1874. .IGovernorTimelock
  1875. [.contract-subindex-inherited]
  1876. .IGovernor
  1877. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1878. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1879. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1880. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  1881. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1882. [.contract-subindex-inherited]
  1883. .EIP712
  1884. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1885. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1886. [.contract-subindex-inherited]
  1887. .ERC165
  1888. [.contract-subindex-inherited]
  1889. .IERC165
  1890. --
  1891. [.contract-index]
  1892. .Events
  1893. --
  1894. * {xref-GovernorTimelockControl-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]
  1895. [.contract-subindex-inherited]
  1896. .Governor
  1897. [.contract-subindex-inherited]
  1898. .IERC1155Receiver
  1899. [.contract-subindex-inherited]
  1900. .IERC721Receiver
  1901. [.contract-subindex-inherited]
  1902. .IGovernorTimelock
  1903. * {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]
  1904. [.contract-subindex-inherited]
  1905. .IGovernor
  1906. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  1907. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1908. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1909. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1910. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1911. [.contract-subindex-inherited]
  1912. .EIP712
  1913. [.contract-subindex-inherited]
  1914. .ERC165
  1915. [.contract-subindex-inherited]
  1916. .IERC165
  1917. --
  1918. [.contract-item]
  1919. [[GovernorTimelockControl-constructor-contract-TimelockController-]]
  1920. ==== `[.contract-item-name]#++constructor++#++(contract TimelockController timelockAddress)++` [.item-kind]#internal#
  1921. Set the timelock.
  1922. [.contract-item]
  1923. [[GovernorTimelockControl-supportsInterface-bytes4-]]
  1924. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  1925. See {IERC165-supportsInterface}.
  1926. [.contract-item]
  1927. [[GovernorTimelockControl-state-uint256-]]
  1928. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  1929. Overridden version of the {Governor-state} function with added support for the `Queued` status.
  1930. [.contract-item]
  1931. [[GovernorTimelockControl-timelock--]]
  1932. ==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#
  1933. Public accessor to check the address of the timelock
  1934. [.contract-item]
  1935. [[GovernorTimelockControl-proposalEta-uint256-]]
  1936. ==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1937. Public accessor to check the eta of a queued proposal
  1938. [.contract-item]
  1939. [[GovernorTimelockControl-queue-address---uint256---bytes---bytes32-]]
  1940. ==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1941. Function to queue a proposal to the timelock.
  1942. [.contract-item]
  1943. [[GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-]]
  1944. ==== `[.contract-item-name]#++_execute++#++(uint256, address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash)++` [.item-kind]#internal#
  1945. Overridden execute function that run the already queued proposal through the timelock.
  1946. [.contract-item]
  1947. [[GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-]]
  1948. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  1949. Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it as already
  1950. been queued.
  1951. [.contract-item]
  1952. [[GovernorTimelockControl-_executor--]]
  1953. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  1954. Address through which the governor executes action. In this case, the timelock.
  1955. [.contract-item]
  1956. [[GovernorTimelockControl-updateTimelock-contract-TimelockController-]]
  1957. ==== `[.contract-item-name]#++updateTimelock++#++(contract TimelockController newTimelock)++` [.item-kind]#external#
  1958. Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
  1959. must be proposed, scheduled, and executed through governance proposals.
  1960. CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.
  1961. [.contract-item]
  1962. [[GovernorTimelockControl-TimelockChange-address-address-]]
  1963. ==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#
  1964. Emitted when the timelock controller used for proposal execution is modified.
  1965. :ProposalTimelock: pass:normal[xref:#GovernorTimelockCompound-ProposalTimelock[`++ProposalTimelock++`]]
  1966. :_timelock: pass:normal[xref:#GovernorTimelockCompound-_timelock-contract-ICompoundTimelock[`++_timelock++`]]
  1967. :_proposalTimelocks: pass:normal[xref:#GovernorTimelockCompound-_proposalTimelocks-mapping-uint256----struct-GovernorTimelockCompound-ProposalTimelock-[`++_proposalTimelocks++`]]
  1968. :TimelockChange: pass:normal[xref:#GovernorTimelockCompound-TimelockChange-address-address-[`++TimelockChange++`]]
  1969. :constructor: pass:normal[xref:#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-[`++constructor++`]]
  1970. :supportsInterface: pass:normal[xref:#GovernorTimelockCompound-supportsInterface-bytes4-[`++supportsInterface++`]]
  1971. :state: pass:normal[xref:#GovernorTimelockCompound-state-uint256-[`++state++`]]
  1972. :timelock: pass:normal[xref:#GovernorTimelockCompound-timelock--[`++timelock++`]]
  1973. :proposalEta: pass:normal[xref:#GovernorTimelockCompound-proposalEta-uint256-[`++proposalEta++`]]
  1974. :queue: pass:normal[xref:#GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-[`++queue++`]]
  1975. :_execute: pass:normal[xref:#GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
  1976. :_cancel: pass:normal[xref:#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  1977. :_executor: pass:normal[xref:#GovernorTimelockCompound-_executor--[`++_executor++`]]
  1978. :__acceptAdmin: pass:normal[xref:#GovernorTimelockCompound-__acceptAdmin--[`++__acceptAdmin++`]]
  1979. :updateTimelock: pass:normal[xref:#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-[`++updateTimelock++`]]
  1980. :_updateTimelock: pass:normal[xref:#GovernorTimelockCompound-_updateTimelock-contract-ICompoundTimelock-[`++_updateTimelock++`]]
  1981. [.contract]
  1982. [[GovernorTimelockCompound]]
  1983. === `++GovernorTimelockCompound++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorTimelockCompound.sol[{github-icon},role=heading-link]
  1984. [.hljs-theme-light.nopadding]
  1985. ```solidity
  1986. import "@openzeppelin/contracts/governance/extensions/GovernorTimelockCompound.sol";
  1987. ```
  1988. Extension of {Governor} that binds the execution process to a Compound Timelock. This adds a delay, enforced by
  1989. the external timelock to all successful proposal (in addition to the voting duration). The {Governor} needs to be
  1990. the admin of the timelock for any operation to be performed. A public, unrestricted,
  1991. {GovernorTimelockCompound-__acceptAdmin} is available to accept ownership of the timelock.
  1992. Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
  1993. the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
  1994. inaccessible.
  1995. _Available since v4.3._
  1996. [.contract-index]
  1997. .Functions
  1998. --
  1999. * {xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-}[`++constructor(timelockAddress)++`]
  2000. * {xref-GovernorTimelockCompound-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2001. * {xref-GovernorTimelockCompound-state-uint256-}[`++state(proposalId)++`]
  2002. * {xref-GovernorTimelockCompound-timelock--}[`++timelock()++`]
  2003. * {xref-GovernorTimelockCompound-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2004. * {xref-GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2005. * {xref-GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(proposalId, targets, values, calldatas, )++`]
  2006. * {xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2007. * {xref-GovernorTimelockCompound-_executor--}[`++_executor()++`]
  2008. * {xref-GovernorTimelockCompound-__acceptAdmin--}[`++__acceptAdmin()++`]
  2009. * {xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-}[`++updateTimelock(newTimelock)++`]
  2010. [.contract-subindex-inherited]
  2011. .Governor
  2012. * {xref-Governor-receive--}[`++receive()++`]
  2013. * {xref-Governor-name--}[`++name()++`]
  2014. * {xref-Governor-version--}[`++version()++`]
  2015. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2016. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2017. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2018. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2019. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2020. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2021. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  2022. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2023. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2024. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2025. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2026. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  2027. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  2028. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  2029. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  2030. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2031. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2032. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2033. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  2034. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  2035. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2036. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2037. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2038. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2039. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2040. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2041. [.contract-subindex-inherited]
  2042. .IERC1155Receiver
  2043. [.contract-subindex-inherited]
  2044. .IERC721Receiver
  2045. [.contract-subindex-inherited]
  2046. .IGovernorTimelock
  2047. [.contract-subindex-inherited]
  2048. .IGovernor
  2049. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2050. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  2051. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  2052. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  2053. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2054. [.contract-subindex-inherited]
  2055. .EIP712
  2056. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2057. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2058. [.contract-subindex-inherited]
  2059. .ERC165
  2060. [.contract-subindex-inherited]
  2061. .IERC165
  2062. --
  2063. [.contract-index]
  2064. .Events
  2065. --
  2066. * {xref-GovernorTimelockCompound-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]
  2067. [.contract-subindex-inherited]
  2068. .Governor
  2069. [.contract-subindex-inherited]
  2070. .IERC1155Receiver
  2071. [.contract-subindex-inherited]
  2072. .IERC721Receiver
  2073. [.contract-subindex-inherited]
  2074. .IGovernorTimelock
  2075. * {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]
  2076. [.contract-subindex-inherited]
  2077. .IGovernor
  2078. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  2079. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2080. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2081. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2082. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2083. [.contract-subindex-inherited]
  2084. .EIP712
  2085. [.contract-subindex-inherited]
  2086. .ERC165
  2087. [.contract-subindex-inherited]
  2088. .IERC165
  2089. --
  2090. [.contract-item]
  2091. [[GovernorTimelockCompound-constructor-contract-ICompoundTimelock-]]
  2092. ==== `[.contract-item-name]#++constructor++#++(contract ICompoundTimelock timelockAddress)++` [.item-kind]#internal#
  2093. Set the timelock.
  2094. [.contract-item]
  2095. [[GovernorTimelockCompound-supportsInterface-bytes4-]]
  2096. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  2097. See {IERC165-supportsInterface}.
  2098. [.contract-item]
  2099. [[GovernorTimelockCompound-state-uint256-]]
  2100. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  2101. Overridden version of the {Governor-state} function with added support for the `Queued` and `Expired` status.
  2102. [.contract-item]
  2103. [[GovernorTimelockCompound-timelock--]]
  2104. ==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#
  2105. Public accessor to check the address of the timelock
  2106. [.contract-item]
  2107. [[GovernorTimelockCompound-proposalEta-uint256-]]
  2108. ==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  2109. Public accessor to check the eta of a queued proposal
  2110. [.contract-item]
  2111. [[GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-]]
  2112. ==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  2113. Function to queue a proposal to the timelock.
  2114. [.contract-item]
  2115. [[GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-]]
  2116. ==== `[.contract-item-name]#++_execute++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  2117. Overridden execute function that run the already queued proposal through the timelock.
  2118. [.contract-item]
  2119. [[GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-]]
  2120. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  2121. Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it as already
  2122. been queued.
  2123. [.contract-item]
  2124. [[GovernorTimelockCompound-_executor--]]
  2125. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  2126. Address through which the governor executes action. In this case, the timelock.
  2127. [.contract-item]
  2128. [[GovernorTimelockCompound-__acceptAdmin--]]
  2129. ==== `[.contract-item-name]#++__acceptAdmin++#++()++` [.item-kind]#public#
  2130. Accept admin right over the timelock.
  2131. [.contract-item]
  2132. [[GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-]]
  2133. ==== `[.contract-item-name]#++updateTimelock++#++(contract ICompoundTimelock newTimelock)++` [.item-kind]#external#
  2134. Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
  2135. must be proposed, scheduled, and executed through governance proposals.
  2136. For security reasons, the timelock must be handed over to another admin before setting up a new one. The two
  2137. operations (hand over the timelock) and do the update can be batched in a single proposal.
  2138. Note that if the timelock admin has been handed over in a previous operation, we refuse updates made through the
  2139. timelock if admin of the timelock has already been accepted and the operation is executed outside the scope of
  2140. governance.
  2141. CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.
  2142. [.contract-item]
  2143. [[GovernorTimelockCompound-TimelockChange-address-address-]]
  2144. ==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#
  2145. Emitted when the timelock controller used for proposal execution is modified.
  2146. :_votingDelay: pass:normal[xref:#GovernorSettings-_votingDelay-uint256[`++_votingDelay++`]]
  2147. :_votingPeriod: pass:normal[xref:#GovernorSettings-_votingPeriod-uint256[`++_votingPeriod++`]]
  2148. :_proposalThreshold: pass:normal[xref:#GovernorSettings-_proposalThreshold-uint256[`++_proposalThreshold++`]]
  2149. :VotingDelaySet: pass:normal[xref:#GovernorSettings-VotingDelaySet-uint256-uint256-[`++VotingDelaySet++`]]
  2150. :VotingPeriodSet: pass:normal[xref:#GovernorSettings-VotingPeriodSet-uint256-uint256-[`++VotingPeriodSet++`]]
  2151. :ProposalThresholdSet: pass:normal[xref:#GovernorSettings-ProposalThresholdSet-uint256-uint256-[`++ProposalThresholdSet++`]]
  2152. :constructor: pass:normal[xref:#GovernorSettings-constructor-uint256-uint256-uint256-[`++constructor++`]]
  2153. :votingDelay: pass:normal[xref:#GovernorSettings-votingDelay--[`++votingDelay++`]]
  2154. :votingPeriod: pass:normal[xref:#GovernorSettings-votingPeriod--[`++votingPeriod++`]]
  2155. :proposalThreshold: pass:normal[xref:#GovernorSettings-proposalThreshold--[`++proposalThreshold++`]]
  2156. :setVotingDelay: pass:normal[xref:#GovernorSettings-setVotingDelay-uint256-[`++setVotingDelay++`]]
  2157. :setVotingPeriod: pass:normal[xref:#GovernorSettings-setVotingPeriod-uint256-[`++setVotingPeriod++`]]
  2158. :setProposalThreshold: pass:normal[xref:#GovernorSettings-setProposalThreshold-uint256-[`++setProposalThreshold++`]]
  2159. :_setVotingDelay: pass:normal[xref:#GovernorSettings-_setVotingDelay-uint256-[`++_setVotingDelay++`]]
  2160. :_setVotingPeriod: pass:normal[xref:#GovernorSettings-_setVotingPeriod-uint256-[`++_setVotingPeriod++`]]
  2161. :_setProposalThreshold: pass:normal[xref:#GovernorSettings-_setProposalThreshold-uint256-[`++_setProposalThreshold++`]]
  2162. [.contract]
  2163. [[GovernorSettings]]
  2164. === `++GovernorSettings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorSettings.sol[{github-icon},role=heading-link]
  2165. [.hljs-theme-light.nopadding]
  2166. ```solidity
  2167. import "@openzeppelin/contracts/governance/extensions/GovernorSettings.sol";
  2168. ```
  2169. Extension of {Governor} for settings updatable through governance.
  2170. _Available since v4.4._
  2171. [.contract-index]
  2172. .Functions
  2173. --
  2174. * {xref-GovernorSettings-constructor-uint256-uint256-uint256-}[`++constructor(initialVotingDelay, initialVotingPeriod, initialProposalThreshold)++`]
  2175. * {xref-GovernorSettings-votingDelay--}[`++votingDelay()++`]
  2176. * {xref-GovernorSettings-votingPeriod--}[`++votingPeriod()++`]
  2177. * {xref-GovernorSettings-proposalThreshold--}[`++proposalThreshold()++`]
  2178. * {xref-GovernorSettings-setVotingDelay-uint256-}[`++setVotingDelay(newVotingDelay)++`]
  2179. * {xref-GovernorSettings-setVotingPeriod-uint256-}[`++setVotingPeriod(newVotingPeriod)++`]
  2180. * {xref-GovernorSettings-setProposalThreshold-uint256-}[`++setProposalThreshold(newProposalThreshold)++`]
  2181. * {xref-GovernorSettings-_setVotingDelay-uint256-}[`++_setVotingDelay(newVotingDelay)++`]
  2182. * {xref-GovernorSettings-_setVotingPeriod-uint256-}[`++_setVotingPeriod(newVotingPeriod)++`]
  2183. * {xref-GovernorSettings-_setProposalThreshold-uint256-}[`++_setProposalThreshold(newProposalThreshold)++`]
  2184. [.contract-subindex-inherited]
  2185. .Governor
  2186. * {xref-Governor-receive--}[`++receive()++`]
  2187. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2188. * {xref-Governor-name--}[`++name()++`]
  2189. * {xref-Governor-version--}[`++version()++`]
  2190. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2191. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2192. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2193. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2194. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2195. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2196. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  2197. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2198. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2199. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2200. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2201. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  2202. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  2203. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  2204. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2205. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  2206. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  2207. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2208. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2209. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2210. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  2211. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  2212. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2213. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2214. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2215. * {xref-Governor-_executor--}[`++_executor()++`]
  2216. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2217. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2218. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2219. [.contract-subindex-inherited]
  2220. .IERC1155Receiver
  2221. [.contract-subindex-inherited]
  2222. .IERC721Receiver
  2223. [.contract-subindex-inherited]
  2224. .IGovernor
  2225. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2226. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  2227. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2228. [.contract-subindex-inherited]
  2229. .EIP712
  2230. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2231. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2232. [.contract-subindex-inherited]
  2233. .ERC165
  2234. [.contract-subindex-inherited]
  2235. .IERC165
  2236. --
  2237. [.contract-index]
  2238. .Events
  2239. --
  2240. * {xref-GovernorSettings-VotingDelaySet-uint256-uint256-}[`++VotingDelaySet(oldVotingDelay, newVotingDelay)++`]
  2241. * {xref-GovernorSettings-VotingPeriodSet-uint256-uint256-}[`++VotingPeriodSet(oldVotingPeriod, newVotingPeriod)++`]
  2242. * {xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-}[`++ProposalThresholdSet(oldProposalThreshold, newProposalThreshold)++`]
  2243. [.contract-subindex-inherited]
  2244. .Governor
  2245. [.contract-subindex-inherited]
  2246. .IERC1155Receiver
  2247. [.contract-subindex-inherited]
  2248. .IERC721Receiver
  2249. [.contract-subindex-inherited]
  2250. .IGovernor
  2251. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  2252. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2253. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2254. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2255. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2256. [.contract-subindex-inherited]
  2257. .EIP712
  2258. [.contract-subindex-inherited]
  2259. .ERC165
  2260. [.contract-subindex-inherited]
  2261. .IERC165
  2262. --
  2263. [.contract-item]
  2264. [[GovernorSettings-constructor-uint256-uint256-uint256-]]
  2265. ==== `[.contract-item-name]#++constructor++#++(uint256 initialVotingDelay, uint256 initialVotingPeriod, uint256 initialProposalThreshold)++` [.item-kind]#internal#
  2266. Initialize the governance parameters.
  2267. [.contract-item]
  2268. [[GovernorSettings-votingDelay--]]
  2269. ==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#
  2270. See {IGovernor-votingDelay}.
  2271. [.contract-item]
  2272. [[GovernorSettings-votingPeriod--]]
  2273. ==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#
  2274. See {IGovernor-votingPeriod}.
  2275. [.contract-item]
  2276. [[GovernorSettings-proposalThreshold--]]
  2277. ==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#
  2278. See {Governor-proposalThreshold}.
  2279. [.contract-item]
  2280. [[GovernorSettings-setVotingDelay-uint256-]]
  2281. ==== `[.contract-item-name]#++setVotingDelay++#++(uint256 newVotingDelay)++` [.item-kind]#public#
  2282. Update the voting delay. This operation can only be performed through a governance proposal.
  2283. Emits a {VotingDelaySet} event.
  2284. [.contract-item]
  2285. [[GovernorSettings-setVotingPeriod-uint256-]]
  2286. ==== `[.contract-item-name]#++setVotingPeriod++#++(uint256 newVotingPeriod)++` [.item-kind]#public#
  2287. Update the voting period. This operation can only be performed through a governance proposal.
  2288. Emits a {VotingPeriodSet} event.
  2289. [.contract-item]
  2290. [[GovernorSettings-setProposalThreshold-uint256-]]
  2291. ==== `[.contract-item-name]#++setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#public#
  2292. Update the proposal threshold. This operation can only be performed through a governance proposal.
  2293. Emits a {ProposalThresholdSet} event.
  2294. [.contract-item]
  2295. [[GovernorSettings-_setVotingDelay-uint256-]]
  2296. ==== `[.contract-item-name]#++_setVotingDelay++#++(uint256 newVotingDelay)++` [.item-kind]#internal#
  2297. Internal setter for the voting delay.
  2298. Emits a {VotingDelaySet} event.
  2299. [.contract-item]
  2300. [[GovernorSettings-_setVotingPeriod-uint256-]]
  2301. ==== `[.contract-item-name]#++_setVotingPeriod++#++(uint256 newVotingPeriod)++` [.item-kind]#internal#
  2302. Internal setter for the voting period.
  2303. Emits a {VotingPeriodSet} event.
  2304. [.contract-item]
  2305. [[GovernorSettings-_setProposalThreshold-uint256-]]
  2306. ==== `[.contract-item-name]#++_setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#internal#
  2307. Internal setter for the proposal threshold.
  2308. Emits a {ProposalThresholdSet} event.
  2309. [.contract-item]
  2310. [[GovernorSettings-VotingDelaySet-uint256-uint256-]]
  2311. ==== `[.contract-item-name]#++VotingDelaySet++#++(uint256 oldVotingDelay, uint256 newVotingDelay)++` [.item-kind]#event#
  2312. [.contract-item]
  2313. [[GovernorSettings-VotingPeriodSet-uint256-uint256-]]
  2314. ==== `[.contract-item-name]#++VotingPeriodSet++#++(uint256 oldVotingPeriod, uint256 newVotingPeriod)++` [.item-kind]#event#
  2315. [.contract-item]
  2316. [[GovernorSettings-ProposalThresholdSet-uint256-uint256-]]
  2317. ==== `[.contract-item-name]#++ProposalThresholdSet++#++(uint256 oldProposalThreshold, uint256 newProposalThreshold)++` [.item-kind]#event#
  2318. :_voteExtension: pass:normal[xref:#GovernorPreventLateQuorum-_voteExtension-uint64[`++_voteExtension++`]]
  2319. :_extendedDeadlines: pass:normal[xref:#GovernorPreventLateQuorum-_extendedDeadlines-mapping-uint256----struct-Timers-BlockNumber-[`++_extendedDeadlines++`]]
  2320. :ProposalExtended: pass:normal[xref:#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-[`++ProposalExtended++`]]
  2321. :LateQuorumVoteExtensionSet: pass:normal[xref:#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-[`++LateQuorumVoteExtensionSet++`]]
  2322. :constructor: pass:normal[xref:#GovernorPreventLateQuorum-constructor-uint64-[`++constructor++`]]
  2323. :proposalDeadline: pass:normal[xref:#GovernorPreventLateQuorum-proposalDeadline-uint256-[`++proposalDeadline++`]]
  2324. :_castVote: pass:normal[xref:#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
  2325. :lateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-lateQuorumVoteExtension--[`++lateQuorumVoteExtension++`]]
  2326. :setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-[`++setLateQuorumVoteExtension++`]]
  2327. :_setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-[`++_setLateQuorumVoteExtension++`]]
  2328. [.contract]
  2329. [[GovernorPreventLateQuorum]]
  2330. === `++GovernorPreventLateQuorum++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorPreventLateQuorum.sol[{github-icon},role=heading-link]
  2331. [.hljs-theme-light.nopadding]
  2332. ```solidity
  2333. import "@openzeppelin/contracts/governance/extensions/GovernorPreventLateQuorum.sol";
  2334. ```
  2335. A module that ensures there is a minimum voting period after quorum is reached. This prevents a large voter from
  2336. swaying a vote and triggering quorum at the last minute, by ensuring there is always time for other voters to react
  2337. and try to oppose the decision.
  2338. If a vote causes quorum to be reached, the proposal's voting period may be extended so that it does not end before at
  2339. least a given number of blocks have passed (the "vote extension" parameter). This parameter can be set by the
  2340. governance executor (e.g. through a governance proposal).
  2341. _Available since v4.5._
  2342. [.contract-index]
  2343. .Functions
  2344. --
  2345. * {xref-GovernorPreventLateQuorum-constructor-uint64-}[`++constructor(initialVoteExtension)++`]
  2346. * {xref-GovernorPreventLateQuorum-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2347. * {xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2348. * {xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--}[`++lateQuorumVoteExtension()++`]
  2349. * {xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-}[`++setLateQuorumVoteExtension(newVoteExtension)++`]
  2350. * {xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-}[`++_setLateQuorumVoteExtension(newVoteExtension)++`]
  2351. [.contract-subindex-inherited]
  2352. .Governor
  2353. * {xref-Governor-receive--}[`++receive()++`]
  2354. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2355. * {xref-Governor-name--}[`++name()++`]
  2356. * {xref-Governor-version--}[`++version()++`]
  2357. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2358. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2359. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2360. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2361. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2362. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2363. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  2364. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2365. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2366. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2367. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2368. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  2369. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  2370. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  2371. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2372. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  2373. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  2374. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2375. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2376. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2377. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  2378. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  2379. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2380. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2381. * {xref-Governor-_executor--}[`++_executor()++`]
  2382. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2383. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2384. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2385. [.contract-subindex-inherited]
  2386. .IERC1155Receiver
  2387. [.contract-subindex-inherited]
  2388. .IERC721Receiver
  2389. [.contract-subindex-inherited]
  2390. .IGovernor
  2391. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2392. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  2393. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  2394. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  2395. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2396. [.contract-subindex-inherited]
  2397. .EIP712
  2398. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2399. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2400. [.contract-subindex-inherited]
  2401. .ERC165
  2402. [.contract-subindex-inherited]
  2403. .IERC165
  2404. --
  2405. [.contract-index]
  2406. .Events
  2407. --
  2408. * {xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-}[`++ProposalExtended(proposalId, extendedDeadline)++`]
  2409. * {xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-}[`++LateQuorumVoteExtensionSet(oldVoteExtension, newVoteExtension)++`]
  2410. [.contract-subindex-inherited]
  2411. .Governor
  2412. [.contract-subindex-inherited]
  2413. .IERC1155Receiver
  2414. [.contract-subindex-inherited]
  2415. .IERC721Receiver
  2416. [.contract-subindex-inherited]
  2417. .IGovernor
  2418. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  2419. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2420. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2421. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2422. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2423. [.contract-subindex-inherited]
  2424. .EIP712
  2425. [.contract-subindex-inherited]
  2426. .ERC165
  2427. [.contract-subindex-inherited]
  2428. .IERC165
  2429. --
  2430. [.contract-item]
  2431. [[GovernorPreventLateQuorum-constructor-uint64-]]
  2432. ==== `[.contract-item-name]#++constructor++#++(uint64 initialVoteExtension)++` [.item-kind]#internal#
  2433. Initializes the vote extension parameter: the number of blocks that are required to pass since a proposal
  2434. reaches quorum until its voting period ends. If necessary the voting period will be extended beyond the one set
  2435. at proposal creation.
  2436. [.contract-item]
  2437. [[GovernorPreventLateQuorum-proposalDeadline-uint256-]]
  2438. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  2439. Returns the proposal deadline, which may have been extended beyond that set at proposal creation, if the
  2440. proposal reached quorum late in the voting period. See {Governor-proposalDeadline}.
  2441. [.contract-item]
  2442. [[GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-]]
  2443. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#
  2444. Casts a vote and detects if it caused quorum to be reached, potentially extending the voting period. See
  2445. {Governor-_castVote}.
  2446. May emit a {ProposalExtended} event.
  2447. [.contract-item]
  2448. [[GovernorPreventLateQuorum-lateQuorumVoteExtension--]]
  2449. ==== `[.contract-item-name]#++lateQuorumVoteExtension++#++() → uint64++` [.item-kind]#public#
  2450. Returns the current value of the vote extension parameter: the number of blocks that are required to pass
  2451. from the time a proposal reaches quorum until its voting period ends.
  2452. [.contract-item]
  2453. [[GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-]]
  2454. ==== `[.contract-item-name]#++setLateQuorumVoteExtension++#++(uint64 newVoteExtension)++` [.item-kind]#public#
  2455. Changes the {lateQuorumVoteExtension}. This operation can only be performed by the governance executor,
  2456. generally through a governance proposal.
  2457. Emits a {LateQuorumVoteExtensionSet} event.
  2458. [.contract-item]
  2459. [[GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-]]
  2460. ==== `[.contract-item-name]#++_setLateQuorumVoteExtension++#++(uint64 newVoteExtension)++` [.item-kind]#internal#
  2461. Changes the {lateQuorumVoteExtension}. This is an internal function that can be exposed in a public function
  2462. like {setLateQuorumVoteExtension} if another access control mechanism is needed.
  2463. Emits a {LateQuorumVoteExtensionSet} event.
  2464. [.contract-item]
  2465. [[GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-]]
  2466. ==== `[.contract-item-name]#++ProposalExtended++#++(uint256 proposalId, uint64 extendedDeadline)++` [.item-kind]#event#
  2467. Emitted when a proposal deadline is pushed back due to reaching quorum late in its voting period.
  2468. [.contract-item]
  2469. [[GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-]]
  2470. ==== `[.contract-item-name]#++LateQuorumVoteExtensionSet++#++(uint64 oldVoteExtension, uint64 newVoteExtension)++` [.item-kind]#event#
  2471. Emitted when the {lateQuorumVoteExtension} parameter is changed.
  2472. :VoteType: pass:normal[xref:#GovernorCompatibilityBravo-VoteType[`++VoteType++`]]
  2473. :ProposalDetails: pass:normal[xref:#GovernorCompatibilityBravo-ProposalDetails[`++ProposalDetails++`]]
  2474. :_proposalDetails: pass:normal[xref:#GovernorCompatibilityBravo-_proposalDetails-mapping-uint256----struct-GovernorCompatibilityBravo-ProposalDetails-[`++_proposalDetails++`]]
  2475. :COUNTING_MODE: pass:normal[xref:#GovernorCompatibilityBravo-COUNTING_MODE--[`++COUNTING_MODE++`]]
  2476. :propose: pass:normal[xref:#GovernorCompatibilityBravo-propose-address---uint256---bytes---string-[`++propose++`]]
  2477. :propose: pass:normal[xref:#GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-[`++propose++`]]
  2478. :queue: pass:normal[xref:#GovernorCompatibilityBravo-queue-uint256-[`++queue++`]]
  2479. :execute: pass:normal[xref:#GovernorCompatibilityBravo-execute-uint256-[`++execute++`]]
  2480. :cancel: pass:normal[xref:#GovernorCompatibilityBravo-cancel-uint256-[`++cancel++`]]
  2481. :_encodeCalldata: pass:normal[xref:#GovernorCompatibilityBravo-_encodeCalldata-string---bytes---[`++_encodeCalldata++`]]
  2482. :_storeProposal: pass:normal[xref:#GovernorCompatibilityBravo-_storeProposal-address-address---uint256---string---bytes---string-[`++_storeProposal++`]]
  2483. :proposals: pass:normal[xref:#GovernorCompatibilityBravo-proposals-uint256-[`++proposals++`]]
  2484. :getActions: pass:normal[xref:#GovernorCompatibilityBravo-getActions-uint256-[`++getActions++`]]
  2485. :getReceipt: pass:normal[xref:#GovernorCompatibilityBravo-getReceipt-uint256-address-[`++getReceipt++`]]
  2486. :quorumVotes: pass:normal[xref:#GovernorCompatibilityBravo-quorumVotes--[`++quorumVotes++`]]
  2487. :hasVoted: pass:normal[xref:#GovernorCompatibilityBravo-hasVoted-uint256-address-[`++hasVoted++`]]
  2488. :_quorumReached: pass:normal[xref:#GovernorCompatibilityBravo-_quorumReached-uint256-[`++_quorumReached++`]]
  2489. :_voteSucceeded: pass:normal[xref:#GovernorCompatibilityBravo-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
  2490. :_countVote: pass:normal[xref:#GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
  2491. [.contract]
  2492. [[GovernorCompatibilityBravo]]
  2493. === `++GovernorCompatibilityBravo++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/compatibility/GovernorCompatibilityBravo.sol[{github-icon},role=heading-link]
  2494. [.hljs-theme-light.nopadding]
  2495. ```solidity
  2496. import "@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol";
  2497. ```
  2498. Compatibility layer that implements GovernorBravo compatibility on to of {Governor}.
  2499. This compatibility layer includes a voting system and requires a {IGovernorTimelock} compatible module to be added
  2500. through inheritance. It does not include token bindings, not does it include any variable upgrade patterns.
  2501. NOTE: When using this module, you may need to enable the Solidity optimizer to avoid hitting the contract size limit.
  2502. _Available since v4.3._
  2503. [.contract-index]
  2504. .Functions
  2505. --
  2506. * {xref-GovernorCompatibilityBravo-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2507. * {xref-GovernorCompatibilityBravo-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2508. * {xref-GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-}[`++propose(targets, values, signatures, calldatas, description)++`]
  2509. * {xref-GovernorCompatibilityBravo-queue-uint256-}[`++queue(proposalId)++`]
  2510. * {xref-GovernorCompatibilityBravo-execute-uint256-}[`++execute(proposalId)++`]
  2511. * {xref-GovernorCompatibilityBravo-cancel-uint256-}[`++cancel(proposalId)++`]
  2512. * {xref-GovernorCompatibilityBravo-proposals-uint256-}[`++proposals(proposalId)++`]
  2513. * {xref-GovernorCompatibilityBravo-getActions-uint256-}[`++getActions(proposalId)++`]
  2514. * {xref-GovernorCompatibilityBravo-getReceipt-uint256-address-}[`++getReceipt(proposalId, voter)++`]
  2515. * {xref-GovernorCompatibilityBravo-quorumVotes--}[`++quorumVotes()++`]
  2516. * {xref-GovernorCompatibilityBravo-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2517. * {xref-GovernorCompatibilityBravo-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2518. * {xref-GovernorCompatibilityBravo-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2519. * {xref-GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, )++`]
  2520. [.contract-subindex-inherited]
  2521. .Governor
  2522. * {xref-Governor-receive--}[`++receive()++`]
  2523. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2524. * {xref-Governor-name--}[`++name()++`]
  2525. * {xref-Governor-version--}[`++version()++`]
  2526. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2527. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2528. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2529. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2530. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2531. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  2532. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2533. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2534. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  2535. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  2536. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  2537. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2538. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  2539. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  2540. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2541. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2542. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2543. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  2544. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  2545. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2546. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2547. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2548. * {xref-Governor-_executor--}[`++_executor()++`]
  2549. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2550. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2551. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2552. [.contract-subindex-inherited]
  2553. .IERC1155Receiver
  2554. [.contract-subindex-inherited]
  2555. .IERC721Receiver
  2556. [.contract-subindex-inherited]
  2557. .IGovernorCompatibilityBravo
  2558. [.contract-subindex-inherited]
  2559. .IGovernorTimelock
  2560. * {xref-IGovernorTimelock-timelock--}[`++timelock()++`]
  2561. * {xref-IGovernorTimelock-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2562. * {xref-IGovernorTimelock-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2563. [.contract-subindex-inherited]
  2564. .IGovernor
  2565. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  2566. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  2567. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  2568. [.contract-subindex-inherited]
  2569. .EIP712
  2570. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2571. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2572. [.contract-subindex-inherited]
  2573. .ERC165
  2574. [.contract-subindex-inherited]
  2575. .IERC165
  2576. --
  2577. [.contract-index]
  2578. .Events
  2579. --
  2580. [.contract-subindex-inherited]
  2581. .Governor
  2582. [.contract-subindex-inherited]
  2583. .IERC1155Receiver
  2584. [.contract-subindex-inherited]
  2585. .IERC721Receiver
  2586. [.contract-subindex-inherited]
  2587. .IGovernorCompatibilityBravo
  2588. [.contract-subindex-inherited]
  2589. .IGovernorTimelock
  2590. * {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]
  2591. [.contract-subindex-inherited]
  2592. .IGovernor
  2593. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  2594. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2595. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2596. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2597. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2598. [.contract-subindex-inherited]
  2599. .EIP712
  2600. [.contract-subindex-inherited]
  2601. .ERC165
  2602. [.contract-subindex-inherited]
  2603. .IERC165
  2604. --
  2605. [.contract-item]
  2606. [[GovernorCompatibilityBravo-COUNTING_MODE--]]
  2607. ==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#
  2608. A description of the possible `support` values for {castVote} and the way these votes are counted, meant to
  2609. be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of
  2610. key-value pairs that each describe one aspect, for example `support=bravo&quorum=for,abstain`.
  2611. There are 2 standard keys: `support` and `quorum`.
  2612. - `support=bravo` refers to the vote options 0 = Against, 1 = For, 2 = Abstain, as in `GovernorBravo`.
  2613. - `quorum=bravo` means that only For votes are counted towards quorum.
  2614. - `quorum=for,abstain` means that both For and Abstain votes are counted towards quorum.
  2615. If a counting module makes use of encoded `params`, it should include this under a `params` key with a unique
  2616. name that describes the behavior. For example:
  2617. - `params=fractional` might refer to a scheme where votes are divided fractionally between for/against/abstain.
  2618. - `params=erc721` might refer to a scheme where specific NFTs are delegated to vote.
  2619. NOTE: The string can be decoded by the standard
  2620. https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[`URLSearchParams`]
  2621. JavaScript class.
  2622. [.contract-item]
  2623. [[GovernorCompatibilityBravo-propose-address---uint256---bytes---string-]]
  2624. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  2625. See {IGovernor-propose}.
  2626. [.contract-item]
  2627. [[GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-]]
  2628. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  2629. See {IGovernorCompatibilityBravo-propose}.
  2630. [.contract-item]
  2631. [[GovernorCompatibilityBravo-queue-uint256-]]
  2632. ==== `[.contract-item-name]#++queue++#++(uint256 proposalId)++` [.item-kind]#public#
  2633. See {IGovernorCompatibilityBravo-queue}.
  2634. [.contract-item]
  2635. [[GovernorCompatibilityBravo-execute-uint256-]]
  2636. ==== `[.contract-item-name]#++execute++#++(uint256 proposalId)++` [.item-kind]#public#
  2637. See {IGovernorCompatibilityBravo-execute}.
  2638. [.contract-item]
  2639. [[GovernorCompatibilityBravo-cancel-uint256-]]
  2640. ==== `[.contract-item-name]#++cancel++#++(uint256 proposalId)++` [.item-kind]#public#
  2641. Cancels a proposal only if sender is the proposer, or proposer delegates dropped below proposal threshold.
  2642. [.contract-item]
  2643. [[GovernorCompatibilityBravo-proposals-uint256-]]
  2644. ==== `[.contract-item-name]#++proposals++#++(uint256 proposalId) → uint256 id, address proposer, uint256 eta, uint256 startBlock, uint256 endBlock, uint256 forVotes, uint256 againstVotes, uint256 abstainVotes, bool canceled, bool executed++` [.item-kind]#public#
  2645. See {IGovernorCompatibilityBravo-proposals}.
  2646. [.contract-item]
  2647. [[GovernorCompatibilityBravo-getActions-uint256-]]
  2648. ==== `[.contract-item-name]#++getActions++#++(uint256 proposalId) → address[] targets, uint256[] values, string[] signatures, bytes[] calldatas++` [.item-kind]#public#
  2649. See {IGovernorCompatibilityBravo-getActions}.
  2650. [.contract-item]
  2651. [[GovernorCompatibilityBravo-getReceipt-uint256-address-]]
  2652. ==== `[.contract-item-name]#++getReceipt++#++(uint256 proposalId, address voter) → struct IGovernorCompatibilityBravo.Receipt++` [.item-kind]#public#
  2653. See {IGovernorCompatibilityBravo-getReceipt}.
  2654. [.contract-item]
  2655. [[GovernorCompatibilityBravo-quorumVotes--]]
  2656. ==== `[.contract-item-name]#++quorumVotes++#++() → uint256++` [.item-kind]#public#
  2657. See {IGovernorCompatibilityBravo-quorumVotes}.
  2658. [.contract-item]
  2659. [[GovernorCompatibilityBravo-hasVoted-uint256-address-]]
  2660. ==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#
  2661. See {IGovernor-hasVoted}.
  2662. [.contract-item]
  2663. [[GovernorCompatibilityBravo-_quorumReached-uint256-]]
  2664. ==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  2665. See {Governor-_quorumReached}. In this module, only forVotes count toward the quorum.
  2666. [.contract-item]
  2667. [[GovernorCompatibilityBravo-_voteSucceeded-uint256-]]
  2668. ==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  2669. See {Governor-_voteSucceeded}. In this module, the forVotes must be scritly over the againstVotes.
  2670. [.contract-item]
  2671. [[GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-]]
  2672. ==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes)++` [.item-kind]#internal#
  2673. See {Governor-_countVote}. In this module, the support follows Governor Bravo.
  2674. === Deprecated
  2675. :propose: pass:normal[xref:#GovernorProposalThreshold-propose-address---uint256---bytes---string-[`++propose++`]]
  2676. [.contract]
  2677. [[GovernorProposalThreshold]]
  2678. === `++GovernorProposalThreshold++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/extensions/GovernorProposalThreshold.sol[{github-icon},role=heading-link]
  2679. [.hljs-theme-light.nopadding]
  2680. ```solidity
  2681. import "@openzeppelin/contracts/governance/extensions/GovernorProposalThreshold.sol";
  2682. ```
  2683. Extension of {Governor} for proposal restriction to token holders with a minimum balance.
  2684. _Available since v4.3._
  2685. _Deprecated since v4.4._
  2686. [.contract-index]
  2687. .Functions
  2688. --
  2689. * {xref-GovernorProposalThreshold-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2690. [.contract-subindex-inherited]
  2691. .Governor
  2692. * {xref-Governor-receive--}[`++receive()++`]
  2693. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2694. * {xref-Governor-name--}[`++name()++`]
  2695. * {xref-Governor-version--}[`++version()++`]
  2696. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2697. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2698. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2699. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2700. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2701. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2702. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2703. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, blockNumber, params)++`]
  2704. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2705. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2706. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2707. * {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
  2708. * {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
  2709. * {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
  2710. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2711. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, blockNumber)++`]
  2712. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, blockNumber, params)++`]
  2713. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2714. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2715. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2716. * {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
  2717. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
  2718. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2719. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2720. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2721. * {xref-Governor-_executor--}[`++_executor()++`]
  2722. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2723. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2724. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2725. [.contract-subindex-inherited]
  2726. .IERC1155Receiver
  2727. [.contract-subindex-inherited]
  2728. .IERC721Receiver
  2729. [.contract-subindex-inherited]
  2730. .IGovernor
  2731. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2732. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  2733. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  2734. * {xref-IGovernor-quorum-uint256-}[`++quorum(blockNumber)++`]
  2735. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2736. [.contract-subindex-inherited]
  2737. .EIP712
  2738. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2739. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2740. [.contract-subindex-inherited]
  2741. .ERC165
  2742. [.contract-subindex-inherited]
  2743. .IERC165
  2744. --
  2745. [.contract-index]
  2746. .Events
  2747. --
  2748. [.contract-subindex-inherited]
  2749. .Governor
  2750. [.contract-subindex-inherited]
  2751. .IERC1155Receiver
  2752. [.contract-subindex-inherited]
  2753. .IERC721Receiver
  2754. [.contract-subindex-inherited]
  2755. .IGovernor
  2756. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, startBlock, endBlock, description)++`]
  2757. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2758. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2759. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2760. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2761. [.contract-subindex-inherited]
  2762. .EIP712
  2763. [.contract-subindex-inherited]
  2764. .ERC165
  2765. [.contract-subindex-inherited]
  2766. .IERC165
  2767. --
  2768. [.contract-item]
  2769. [[GovernorProposalThreshold-propose-address---uint256---bytes---string-]]
  2770. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  2771. See {IGovernor-propose}.
  2772. == Utils
  2773. :_DELEGATION_TYPEHASH: pass:normal[xref:#Votes-_DELEGATION_TYPEHASH-bytes32[`++_DELEGATION_TYPEHASH++`]]
  2774. :_delegation: pass:normal[xref:#Votes-_delegation-mapping-address----address-[`++_delegation++`]]
  2775. :_delegateCheckpoints: pass:normal[xref:#Votes-_delegateCheckpoints-mapping-address----struct-Checkpoints-History-[`++_delegateCheckpoints++`]]
  2776. :_totalCheckpoints: pass:normal[xref:#Votes-_totalCheckpoints-struct-Checkpoints-History[`++_totalCheckpoints++`]]
  2777. :_nonces: pass:normal[xref:#Votes-_nonces-mapping-address----struct-Counters-Counter-[`++_nonces++`]]
  2778. :getVotes: pass:normal[xref:#Votes-getVotes-address-[`++getVotes++`]]
  2779. :getPastVotes: pass:normal[xref:#Votes-getPastVotes-address-uint256-[`++getPastVotes++`]]
  2780. :getPastTotalSupply: pass:normal[xref:#Votes-getPastTotalSupply-uint256-[`++getPastTotalSupply++`]]
  2781. :_getTotalSupply: pass:normal[xref:#Votes-_getTotalSupply--[`++_getTotalSupply++`]]
  2782. :delegates: pass:normal[xref:#Votes-delegates-address-[`++delegates++`]]
  2783. :delegate: pass:normal[xref:#Votes-delegate-address-[`++delegate++`]]
  2784. :delegateBySig: pass:normal[xref:#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-[`++delegateBySig++`]]
  2785. :_delegate: pass:normal[xref:#Votes-_delegate-address-address-[`++_delegate++`]]
  2786. :_transferVotingUnits: pass:normal[xref:#Votes-_transferVotingUnits-address-address-uint256-[`++_transferVotingUnits++`]]
  2787. :_moveDelegateVotes: pass:normal[xref:#Votes-_moveDelegateVotes-address-address-uint256-[`++_moveDelegateVotes++`]]
  2788. :_add: pass:normal[xref:#Votes-_add-uint256-uint256-[`++_add++`]]
  2789. :_subtract: pass:normal[xref:#Votes-_subtract-uint256-uint256-[`++_subtract++`]]
  2790. :_useNonce: pass:normal[xref:#Votes-_useNonce-address-[`++_useNonce++`]]
  2791. :nonces: pass:normal[xref:#Votes-nonces-address-[`++nonces++`]]
  2792. :DOMAIN_SEPARATOR: pass:normal[xref:#Votes-DOMAIN_SEPARATOR--[`++DOMAIN_SEPARATOR++`]]
  2793. :_getVotingUnits: pass:normal[xref:#Votes-_getVotingUnits-address-[`++_getVotingUnits++`]]
  2794. [.contract]
  2795. [[Votes]]
  2796. === `++Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/utils/Votes.sol[{github-icon},role=heading-link]
  2797. [.hljs-theme-light.nopadding]
  2798. ```solidity
  2799. import "@openzeppelin/contracts/governance/utils/Votes.sol";
  2800. ```
  2801. This is a base abstract contract that tracks voting units, which are a measure of voting power that can be
  2802. transferred, and provides a system of vote delegation, where an account can delegate its voting units to a sort of
  2803. "representative" that will pool delegated voting units from different accounts and can then use it to vote in
  2804. decisions. In fact, voting units _must_ be delegated in order to count as actual votes, and an account has to
  2805. delegate those votes to itself if it wishes to participate in decisions and does not have a trusted representative.
  2806. This contract is often combined with a token contract such that voting units correspond to token units. For an
  2807. example, see {ERC721Votes}.
  2808. The full history of delegate votes is tracked on-chain so that governance protocols can consider votes as distributed
  2809. at a particular block number to protect against flash loans and double voting. The opt-in delegate system makes the
  2810. cost of this history tracking optional.
  2811. When using this module the derived contract must implement {_getVotingUnits} (for example, make it return
  2812. {ERC721-balanceOf}), and can use {_transferVotingUnits} to track a change in the distribution of those units (in the
  2813. previous example, it would be included in {ERC721-_beforeTokenTransfer}).
  2814. _Available since v4.5._
  2815. [.contract-index]
  2816. .Functions
  2817. --
  2818. * {xref-Votes-getVotes-address-}[`++getVotes(account)++`]
  2819. * {xref-Votes-getPastVotes-address-uint256-}[`++getPastVotes(account, blockNumber)++`]
  2820. * {xref-Votes-getPastTotalSupply-uint256-}[`++getPastTotalSupply(blockNumber)++`]
  2821. * {xref-Votes-_getTotalSupply--}[`++_getTotalSupply()++`]
  2822. * {xref-Votes-delegates-address-}[`++delegates(account)++`]
  2823. * {xref-Votes-delegate-address-}[`++delegate(delegatee)++`]
  2824. * {xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-}[`++delegateBySig(delegatee, nonce, expiry, v, r, s)++`]
  2825. * {xref-Votes-_delegate-address-address-}[`++_delegate(account, delegatee)++`]
  2826. * {xref-Votes-_transferVotingUnits-address-address-uint256-}[`++_transferVotingUnits(from, to, amount)++`]
  2827. * {xref-Votes-_useNonce-address-}[`++_useNonce(owner)++`]
  2828. * {xref-Votes-nonces-address-}[`++nonces(owner)++`]
  2829. * {xref-Votes-DOMAIN_SEPARATOR--}[`++DOMAIN_SEPARATOR()++`]
  2830. * {xref-Votes-_getVotingUnits-address-}[`++_getVotingUnits()++`]
  2831. [.contract-subindex-inherited]
  2832. .EIP712
  2833. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2834. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2835. [.contract-subindex-inherited]
  2836. .IVotes
  2837. --
  2838. [.contract-index]
  2839. .Events
  2840. --
  2841. [.contract-subindex-inherited]
  2842. .EIP712
  2843. [.contract-subindex-inherited]
  2844. .IVotes
  2845. * {xref-IVotes-DelegateChanged-address-address-address-}[`++DelegateChanged(delegator, fromDelegate, toDelegate)++`]
  2846. * {xref-IVotes-DelegateVotesChanged-address-uint256-uint256-}[`++DelegateVotesChanged(delegate, previousBalance, newBalance)++`]
  2847. --
  2848. [.contract-item]
  2849. [[Votes-getVotes-address-]]
  2850. ==== `[.contract-item-name]#++getVotes++#++(address account) → uint256++` [.item-kind]#public#
  2851. Returns the current amount of votes that `account` has.
  2852. [.contract-item]
  2853. [[Votes-getPastVotes-address-uint256-]]
  2854. ==== `[.contract-item-name]#++getPastVotes++#++(address account, uint256 blockNumber) → uint256++` [.item-kind]#public#
  2855. Returns the amount of votes that `account` had at the end of a past block (`blockNumber`).
  2856. Requirements:
  2857. - `blockNumber` must have been already mined
  2858. [.contract-item]
  2859. [[Votes-getPastTotalSupply-uint256-]]
  2860. ==== `[.contract-item-name]#++getPastTotalSupply++#++(uint256 blockNumber) → uint256++` [.item-kind]#public#
  2861. Returns the total supply of votes available at the end of a past block (`blockNumber`).
  2862. NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
  2863. Votes that have not been delegated are still part of total supply, even though they would not participate in a
  2864. vote.
  2865. Requirements:
  2866. - `blockNumber` must have been already mined
  2867. [.contract-item]
  2868. [[Votes-_getTotalSupply--]]
  2869. ==== `[.contract-item-name]#++_getTotalSupply++#++() → uint256++` [.item-kind]#internal#
  2870. Returns the current total supply of votes.
  2871. [.contract-item]
  2872. [[Votes-delegates-address-]]
  2873. ==== `[.contract-item-name]#++delegates++#++(address account) → address++` [.item-kind]#public#
  2874. Returns the delegate that `account` has chosen.
  2875. [.contract-item]
  2876. [[Votes-delegate-address-]]
  2877. ==== `[.contract-item-name]#++delegate++#++(address delegatee)++` [.item-kind]#public#
  2878. Delegates votes from the sender to `delegatee`.
  2879. [.contract-item]
  2880. [[Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-]]
  2881. ==== `[.contract-item-name]#++delegateBySig++#++(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s)++` [.item-kind]#public#
  2882. Delegates votes from signer to `delegatee`.
  2883. [.contract-item]
  2884. [[Votes-_delegate-address-address-]]
  2885. ==== `[.contract-item-name]#++_delegate++#++(address account, address delegatee)++` [.item-kind]#internal#
  2886. Delegate all of `account`'s voting units to `delegatee`.
  2887. Emits events {IVotes-DelegateChanged} and {IVotes-DelegateVotesChanged}.
  2888. [.contract-item]
  2889. [[Votes-_transferVotingUnits-address-address-uint256-]]
  2890. ==== `[.contract-item-name]#++_transferVotingUnits++#++(address from, address to, uint256 amount)++` [.item-kind]#internal#
  2891. Transfers, mints, or burns voting units. To register a mint, `from` should be zero. To register a burn, `to`
  2892. should be zero. Total supply of voting units will be adjusted with mints and burns.
  2893. [.contract-item]
  2894. [[Votes-_useNonce-address-]]
  2895. ==== `[.contract-item-name]#++_useNonce++#++(address owner) → uint256 current++` [.item-kind]#internal#
  2896. Consumes a nonce.
  2897. Returns the current value and increments nonce.
  2898. [.contract-item]
  2899. [[Votes-nonces-address-]]
  2900. ==== `[.contract-item-name]#++nonces++#++(address owner) → uint256++` [.item-kind]#public#
  2901. Returns an address nonce.
  2902. [.contract-item]
  2903. [[Votes-DOMAIN_SEPARATOR--]]
  2904. ==== `[.contract-item-name]#++DOMAIN_SEPARATOR++#++() → bytes32++` [.item-kind]#external#
  2905. Returns the contract's {EIP712} domain separator.
  2906. [.contract-item]
  2907. [[Votes-_getVotingUnits-address-]]
  2908. ==== `[.contract-item-name]#++_getVotingUnits++#++(address) → uint256++` [.item-kind]#internal#
  2909. Must return the voting units held by an account.
  2910. == Timelock
  2911. In a governance system, the {TimelockController} contract is in charge of introducing a delay between a proposal and its execution. It can be used with or without a {Governor}.
  2912. :TIMELOCK_ADMIN_ROLE: pass:normal[xref:#TimelockController-TIMELOCK_ADMIN_ROLE-bytes32[`++TIMELOCK_ADMIN_ROLE++`]]
  2913. :PROPOSER_ROLE: pass:normal[xref:#TimelockController-PROPOSER_ROLE-bytes32[`++PROPOSER_ROLE++`]]
  2914. :EXECUTOR_ROLE: pass:normal[xref:#TimelockController-EXECUTOR_ROLE-bytes32[`++EXECUTOR_ROLE++`]]
  2915. :CANCELLER_ROLE: pass:normal[xref:#TimelockController-CANCELLER_ROLE-bytes32[`++CANCELLER_ROLE++`]]
  2916. :_DONE_TIMESTAMP: pass:normal[xref:#TimelockController-_DONE_TIMESTAMP-uint256[`++_DONE_TIMESTAMP++`]]
  2917. :_timestamps: pass:normal[xref:#TimelockController-_timestamps-mapping-bytes32----uint256-[`++_timestamps++`]]
  2918. :_minDelay: pass:normal[xref:#TimelockController-_minDelay-uint256[`++_minDelay++`]]
  2919. :CallScheduled: pass:normal[xref:#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-[`++CallScheduled++`]]
  2920. :CallExecuted: pass:normal[xref:#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-[`++CallExecuted++`]]
  2921. :Cancelled: pass:normal[xref:#TimelockController-Cancelled-bytes32-[`++Cancelled++`]]
  2922. :MinDelayChange: pass:normal[xref:#TimelockController-MinDelayChange-uint256-uint256-[`++MinDelayChange++`]]
  2923. :constructor: pass:normal[xref:#TimelockController-constructor-uint256-address---address---address-[`++constructor++`]]
  2924. :onlyRoleOrOpenRole: pass:normal[xref:#TimelockController-onlyRoleOrOpenRole-bytes32-[`++onlyRoleOrOpenRole++`]]
  2925. :receive: pass:normal[xref:#TimelockController-receive--[`++receive++`]]
  2926. :supportsInterface: pass:normal[xref:#TimelockController-supportsInterface-bytes4-[`++supportsInterface++`]]
  2927. :isOperation: pass:normal[xref:#TimelockController-isOperation-bytes32-[`++isOperation++`]]
  2928. :isOperationPending: pass:normal[xref:#TimelockController-isOperationPending-bytes32-[`++isOperationPending++`]]
  2929. :isOperationReady: pass:normal[xref:#TimelockController-isOperationReady-bytes32-[`++isOperationReady++`]]
  2930. :isOperationDone: pass:normal[xref:#TimelockController-isOperationDone-bytes32-[`++isOperationDone++`]]
  2931. :getTimestamp: pass:normal[xref:#TimelockController-getTimestamp-bytes32-[`++getTimestamp++`]]
  2932. :getMinDelay: pass:normal[xref:#TimelockController-getMinDelay--[`++getMinDelay++`]]
  2933. :hashOperation: pass:normal[xref:#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-[`++hashOperation++`]]
  2934. :hashOperationBatch: pass:normal[xref:#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-[`++hashOperationBatch++`]]
  2935. :schedule: pass:normal[xref:#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-[`++schedule++`]]
  2936. :scheduleBatch: pass:normal[xref:#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-[`++scheduleBatch++`]]
  2937. :_schedule: pass:normal[xref:#TimelockController-_schedule-bytes32-uint256-[`++_schedule++`]]
  2938. :cancel: pass:normal[xref:#TimelockController-cancel-bytes32-[`++cancel++`]]
  2939. :execute: pass:normal[xref:#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-[`++execute++`]]
  2940. :executeBatch: pass:normal[xref:#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-[`++executeBatch++`]]
  2941. :_execute: pass:normal[xref:#TimelockController-_execute-address-uint256-bytes-[`++_execute++`]]
  2942. :_beforeCall: pass:normal[xref:#TimelockController-_beforeCall-bytes32-bytes32-[`++_beforeCall++`]]
  2943. :_afterCall: pass:normal[xref:#TimelockController-_afterCall-bytes32-[`++_afterCall++`]]
  2944. :updateDelay: pass:normal[xref:#TimelockController-updateDelay-uint256-[`++updateDelay++`]]
  2945. :onERC721Received: pass:normal[xref:#TimelockController-onERC721Received-address-address-uint256-bytes-[`++onERC721Received++`]]
  2946. :onERC1155Received: pass:normal[xref:#TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
  2947. :onERC1155BatchReceived: pass:normal[xref:#TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
  2948. [.contract]
  2949. [[TimelockController]]
  2950. === `++TimelockController++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.1/contracts/governance/TimelockController.sol[{github-icon},role=heading-link]
  2951. [.hljs-theme-light.nopadding]
  2952. ```solidity
  2953. import "@openzeppelin/contracts/governance/TimelockController.sol";
  2954. ```
  2955. Contract module which acts as a timelocked controller. When set as the
  2956. owner of an `Ownable` smart contract, it enforces a timelock on all
  2957. `onlyOwner` maintenance operations. This gives time for users of the
  2958. controlled contract to exit before a potentially dangerous maintenance
  2959. operation is applied.
  2960. By default, this contract is self administered, meaning administration tasks
  2961. have to go through the timelock process. The proposer (resp executor) role
  2962. is in charge of proposing (resp executing) operations. A common use case is
  2963. to position this {TimelockController} as the owner of a smart contract, with
  2964. a multisig or a DAO as the sole proposer.
  2965. _Available since v3.3._
  2966. [.contract-index]
  2967. .Modifiers
  2968. --
  2969. * {xref-TimelockController-onlyRoleOrOpenRole-bytes32-}[`++onlyRoleOrOpenRole(role)++`]
  2970. --
  2971. [.contract-index]
  2972. .Functions
  2973. --
  2974. * {xref-TimelockController-constructor-uint256-address---address---address-}[`++constructor(minDelay, proposers, executors, admin)++`]
  2975. * {xref-TimelockController-receive--}[`++receive()++`]
  2976. * {xref-TimelockController-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2977. * {xref-TimelockController-isOperation-bytes32-}[`++isOperation(id)++`]
  2978. * {xref-TimelockController-isOperationPending-bytes32-}[`++isOperationPending(id)++`]
  2979. * {xref-TimelockController-isOperationReady-bytes32-}[`++isOperationReady(id)++`]
  2980. * {xref-TimelockController-isOperationDone-bytes32-}[`++isOperationDone(id)++`]
  2981. * {xref-TimelockController-getTimestamp-bytes32-}[`++getTimestamp(id)++`]
  2982. * {xref-TimelockController-getMinDelay--}[`++getMinDelay()++`]
  2983. * {xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-}[`++hashOperation(target, value, data, predecessor, salt)++`]
  2984. * {xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-}[`++hashOperationBatch(targets, values, payloads, predecessor, salt)++`]
  2985. * {xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-}[`++schedule(target, value, data, predecessor, salt, delay)++`]
  2986. * {xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-}[`++scheduleBatch(targets, values, payloads, predecessor, salt, delay)++`]
  2987. * {xref-TimelockController-cancel-bytes32-}[`++cancel(id)++`]
  2988. * {xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-}[`++execute(target, value, payload, predecessor, salt)++`]
  2989. * {xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-}[`++executeBatch(targets, values, payloads, predecessor, salt)++`]
  2990. * {xref-TimelockController-_execute-address-uint256-bytes-}[`++_execute(target, value, data)++`]
  2991. * {xref-TimelockController-updateDelay-uint256-}[`++updateDelay(newDelay)++`]
  2992. * {xref-TimelockController-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2993. * {xref-TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2994. * {xref-TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2995. [.contract-subindex-inherited]
  2996. .IERC1155Receiver
  2997. [.contract-subindex-inherited]
  2998. .IERC721Receiver
  2999. [.contract-subindex-inherited]
  3000. .AccessControl
  3001. * {xref-AccessControl-hasRole-bytes32-address-}[`++hasRole(role, account)++`]
  3002. * {xref-AccessControl-_checkRole-bytes32-}[`++_checkRole(role)++`]
  3003. * {xref-AccessControl-_checkRole-bytes32-address-}[`++_checkRole(role, account)++`]
  3004. * {xref-AccessControl-getRoleAdmin-bytes32-}[`++getRoleAdmin(role)++`]
  3005. * {xref-AccessControl-grantRole-bytes32-address-}[`++grantRole(role, account)++`]
  3006. * {xref-AccessControl-revokeRole-bytes32-address-}[`++revokeRole(role, account)++`]
  3007. * {xref-AccessControl-renounceRole-bytes32-address-}[`++renounceRole(role, account)++`]
  3008. * {xref-AccessControl-_setupRole-bytes32-address-}[`++_setupRole(role, account)++`]
  3009. * {xref-AccessControl-_setRoleAdmin-bytes32-bytes32-}[`++_setRoleAdmin(role, adminRole)++`]
  3010. * {xref-AccessControl-_grantRole-bytes32-address-}[`++_grantRole(role, account)++`]
  3011. * {xref-AccessControl-_revokeRole-bytes32-address-}[`++_revokeRole(role, account)++`]
  3012. [.contract-subindex-inherited]
  3013. .ERC165
  3014. [.contract-subindex-inherited]
  3015. .IERC165
  3016. [.contract-subindex-inherited]
  3017. .IAccessControl
  3018. --
  3019. [.contract-index]
  3020. .Events
  3021. --
  3022. * {xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-}[`++CallScheduled(id, index, target, value, data, predecessor, delay)++`]
  3023. * {xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-}[`++CallExecuted(id, index, target, value, data)++`]
  3024. * {xref-TimelockController-Cancelled-bytes32-}[`++Cancelled(id)++`]
  3025. * {xref-TimelockController-MinDelayChange-uint256-uint256-}[`++MinDelayChange(oldDuration, newDuration)++`]
  3026. [.contract-subindex-inherited]
  3027. .IERC1155Receiver
  3028. [.contract-subindex-inherited]
  3029. .IERC721Receiver
  3030. [.contract-subindex-inherited]
  3031. .AccessControl
  3032. [.contract-subindex-inherited]
  3033. .ERC165
  3034. [.contract-subindex-inherited]
  3035. .IERC165
  3036. [.contract-subindex-inherited]
  3037. .IAccessControl
  3038. * {xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-}[`++RoleAdminChanged(role, previousAdminRole, newAdminRole)++`]
  3039. * {xref-IAccessControl-RoleGranted-bytes32-address-address-}[`++RoleGranted(role, account, sender)++`]
  3040. * {xref-IAccessControl-RoleRevoked-bytes32-address-address-}[`++RoleRevoked(role, account, sender)++`]
  3041. --
  3042. [.contract-item]
  3043. [[TimelockController-onlyRoleOrOpenRole-bytes32-]]
  3044. ==== `[.contract-item-name]#++onlyRoleOrOpenRole++#++(bytes32 role)++` [.item-kind]#modifier#
  3045. Modifier to make a function callable only by a certain role. In
  3046. addition to checking the sender's role, `address(0)` 's role is also
  3047. considered. Granting a role to `address(0)` is equivalent to enabling
  3048. this role for everyone.
  3049. [.contract-item]
  3050. [[TimelockController-constructor-uint256-address---address---address-]]
  3051. ==== `[.contract-item-name]#++constructor++#++(uint256 minDelay, address[] proposers, address[] executors, address admin)++` [.item-kind]#public#
  3052. Initializes the contract with the following parameters:
  3053. - `minDelay`: initial minimum delay for operations
  3054. - `proposers`: accounts to be granted proposer and canceller roles
  3055. - `executors`: accounts to be granted executor role
  3056. - `admin`: optional account to be granted admin role; disable with zero address
  3057. IMPORTANT: The optional admin can aid with initial configuration of roles after deployment
  3058. without being subject to delay, but this role should be subsequently renounced in favor of
  3059. administration through timelocked proposals. Previous versions of this contract would assign
  3060. this admin to the deployer automatically and should be renounced as well.
  3061. [.contract-item]
  3062. [[TimelockController-receive--]]
  3063. ==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#
  3064. Contract might receive/hold ETH as part of the maintenance process.
  3065. [.contract-item]
  3066. [[TimelockController-supportsInterface-bytes4-]]
  3067. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  3068. See {IERC165-supportsInterface}.
  3069. [.contract-item]
  3070. [[TimelockController-isOperation-bytes32-]]
  3071. ==== `[.contract-item-name]#++isOperation++#++(bytes32 id) → bool registered++` [.item-kind]#public#
  3072. Returns whether an id correspond to a registered operation. This
  3073. includes both Pending, Ready and Done operations.
  3074. [.contract-item]
  3075. [[TimelockController-isOperationPending-bytes32-]]
  3076. ==== `[.contract-item-name]#++isOperationPending++#++(bytes32 id) → bool pending++` [.item-kind]#public#
  3077. Returns whether an operation is pending or not.
  3078. [.contract-item]
  3079. [[TimelockController-isOperationReady-bytes32-]]
  3080. ==== `[.contract-item-name]#++isOperationReady++#++(bytes32 id) → bool ready++` [.item-kind]#public#
  3081. Returns whether an operation is ready or not.
  3082. [.contract-item]
  3083. [[TimelockController-isOperationDone-bytes32-]]
  3084. ==== `[.contract-item-name]#++isOperationDone++#++(bytes32 id) → bool done++` [.item-kind]#public#
  3085. Returns whether an operation is done or not.
  3086. [.contract-item]
  3087. [[TimelockController-getTimestamp-bytes32-]]
  3088. ==== `[.contract-item-name]#++getTimestamp++#++(bytes32 id) → uint256 timestamp++` [.item-kind]#public#
  3089. Returns the timestamp at with an operation becomes ready (0 for
  3090. unset operations, 1 for done operations).
  3091. [.contract-item]
  3092. [[TimelockController-getMinDelay--]]
  3093. ==== `[.contract-item-name]#++getMinDelay++#++() → uint256 duration++` [.item-kind]#public#
  3094. Returns the minimum delay for an operation to become valid.
  3095. This value can be changed by executing an operation that calls `updateDelay`.
  3096. [.contract-item]
  3097. [[TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-]]
  3098. ==== `[.contract-item-name]#++hashOperation++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) → bytes32 hash++` [.item-kind]#public#
  3099. Returns the identifier of an operation containing a single
  3100. transaction.
  3101. [.contract-item]
  3102. [[TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-]]
  3103. ==== `[.contract-item-name]#++hashOperationBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt) → bytes32 hash++` [.item-kind]#public#
  3104. Returns the identifier of an operation containing a batch of
  3105. transactions.
  3106. [.contract-item]
  3107. [[TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-]]
  3108. ==== `[.contract-item-name]#++schedule++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#
  3109. Schedule an operation containing a single transaction.
  3110. Emits a {CallScheduled} event.
  3111. Requirements:
  3112. - the caller must have the 'proposer' role.
  3113. [.contract-item]
  3114. [[TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-]]
  3115. ==== `[.contract-item-name]#++scheduleBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#
  3116. Schedule an operation containing a batch of transactions.
  3117. Emits one {CallScheduled} event per transaction in the batch.
  3118. Requirements:
  3119. - the caller must have the 'proposer' role.
  3120. [.contract-item]
  3121. [[TimelockController-cancel-bytes32-]]
  3122. ==== `[.contract-item-name]#++cancel++#++(bytes32 id)++` [.item-kind]#public#
  3123. Cancel an operation.
  3124. Requirements:
  3125. - the caller must have the 'canceller' role.
  3126. [.contract-item]
  3127. [[TimelockController-execute-address-uint256-bytes-bytes32-bytes32-]]
  3128. ==== `[.contract-item-name]#++execute++#++(address target, uint256 value, bytes payload, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#
  3129. Execute an (ready) operation containing a single transaction.
  3130. Emits a {CallExecuted} event.
  3131. Requirements:
  3132. - the caller must have the 'executor' role.
  3133. [.contract-item]
  3134. [[TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-]]
  3135. ==== `[.contract-item-name]#++executeBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#
  3136. Execute an (ready) operation containing a batch of transactions.
  3137. Emits one {CallExecuted} event per transaction in the batch.
  3138. Requirements:
  3139. - the caller must have the 'executor' role.
  3140. [.contract-item]
  3141. [[TimelockController-_execute-address-uint256-bytes-]]
  3142. ==== `[.contract-item-name]#++_execute++#++(address target, uint256 value, bytes data)++` [.item-kind]#internal#
  3143. Execute an operation's call.
  3144. [.contract-item]
  3145. [[TimelockController-updateDelay-uint256-]]
  3146. ==== `[.contract-item-name]#++updateDelay++#++(uint256 newDelay)++` [.item-kind]#external#
  3147. Changes the minimum timelock duration for future operations.
  3148. Emits a {MinDelayChange} event.
  3149. Requirements:
  3150. - the caller must be the timelock itself. This can only be achieved by scheduling and later executing
  3151. an operation where the timelock is the target and the data is the ABI-encoded call to this function.
  3152. [.contract-item]
  3153. [[TimelockController-onERC721Received-address-address-uint256-bytes-]]
  3154. ==== `[.contract-item-name]#++onERC721Received++#++(address, address, uint256, bytes) → bytes4++` [.item-kind]#public#
  3155. See {IERC721Receiver-onERC721Received}.
  3156. [.contract-item]
  3157. [[TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-]]
  3158. ==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#
  3159. See {IERC1155Receiver-onERC1155Received}.
  3160. [.contract-item]
  3161. [[TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
  3162. ==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#
  3163. See {IERC1155Receiver-onERC1155BatchReceived}.
  3164. [.contract-item]
  3165. [[TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-]]
  3166. ==== `[.contract-item-name]#++CallScheduled++#++(bytes32 id, uint256 index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)++` [.item-kind]#event#
  3167. Emitted when a call is scheduled as part of operation `id`.
  3168. [.contract-item]
  3169. [[TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-]]
  3170. ==== `[.contract-item-name]#++CallExecuted++#++(bytes32 id, uint256 index, address target, uint256 value, bytes data)++` [.item-kind]#event#
  3171. Emitted when a call is performed as part of operation `id`.
  3172. [.contract-item]
  3173. [[TimelockController-Cancelled-bytes32-]]
  3174. ==== `[.contract-item-name]#++Cancelled++#++(bytes32 id)++` [.item-kind]#event#
  3175. Emitted when operation `id` is cancelled.
  3176. [.contract-item]
  3177. [[TimelockController-MinDelayChange-uint256-uint256-]]
  3178. ==== `[.contract-item-name]#++MinDelayChange++#++(uint256 oldDuration, uint256 newDuration)++` [.item-kind]#event#
  3179. Emitted when the minimum delay for future operations is modified.
  3180. [[timelock-terminology]]
  3181. ==== Terminology
  3182. * *Operation:* A transaction (or a set of transactions) that is the subject of the timelock. It has to be scheduled by a proposer and executed by an executor. The timelock enforces a minimum delay between the proposition and the execution (see xref:access-control.adoc#operation_lifecycle[operation lifecycle]). If the operation contains multiple transactions (batch mode), they are executed atomically. Operations are identified by the hash of their content.
  3183. * *Operation status:*
  3184. ** *Unset:* An operation that is not part of the timelock mechanism.
  3185. ** *Pending:* An operation that has been scheduled, before the timer expires.
  3186. ** *Ready:* An operation that has been scheduled, after the timer expires.
  3187. ** *Done:* An operation that has been executed.
  3188. * *Predecessor*: An (optional) dependency between operations. An operation can depend on another operation (its predecessor), forcing the execution order of these two operations.
  3189. * *Role*:
  3190. ** *Admin:* An address (smart contract or EOA) that is in charge of granting the roles of Proposer and Executor.
  3191. ** *Proposer:* An address (smart contract or EOA) that is in charge of scheduling (and cancelling) operations.
  3192. ** *Executor:* An address (smart contract or EOA) that is in charge of executing operations once the timelock has expired. This role can be given to the zero address to allow anyone to execute operations.
  3193. [[timelock-operation]]
  3194. ==== Operation structure
  3195. Operation executed by the xref:api:governance.adoc#TimelockController[`TimelockController`] can contain one or multiple subsequent calls. Depending on whether you need to multiple calls to be executed atomically, you can either use simple or batched operations.
  3196. Both operations contain:
  3197. * *Target*, the address of the smart contract that the timelock should operate on.
  3198. * *Value*, in wei, that should be sent with the transaction. Most of the time this will be 0. Ether can be deposited before-end or passed along when executing the transaction.
  3199. * *Data*, containing the encoded function selector and parameters of the call. This can be produced using a number of tools. For example, a maintenance operation granting role `ROLE` to `ACCOUNT` can be encoded using web3js as follows:
  3200. ```javascript
  3201. const data = timelock.contract.methods.grantRole(ROLE, ACCOUNT).encodeABI()
  3202. ```
  3203. * *Predecessor*, that specifies a dependency between operations. This dependency is optional. Use `bytes32(0)` if the operation does not have any dependency.
  3204. * *Salt*, used to disambiguate two otherwise identical operations. This can be any random value.
  3205. In the case of batched operations, `target`, `value` and `data` are specified as arrays, which must be of the same length.
  3206. [[timelock-operation-lifecycle]]
  3207. ==== Operation lifecycle
  3208. Timelocked operations are identified by a unique id (their hash) and follow a specific lifecycle:
  3209. `Unset` -> `Pending` -> `Pending` + `Ready` -> `Done`
  3210. * By calling xref:api:governance.adoc#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-[`schedule`] (or xref:api:governance.adoc#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-[`scheduleBatch`]), a proposer moves the operation from the `Unset` to the `Pending` state. This starts a timer that must be longer than the minimum delay. The timer expires at a timestamp accessible through the xref:api:governance.adoc#TimelockController-getTimestamp-bytes32-[`getTimestamp`] method.
  3211. * Once the timer expires, the operation automatically gets the `Ready` state. At this point, it can be executed.
  3212. * By calling xref:api:governance.adoc#TimelockController-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-[`execute`] (or xref:api:governance.adoc#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-[`executeBatch`]), an executor triggers the operation's underlying transactions and moves it to the `Done` state. If the operation has a predecessor, it has to be in the `Done` state for this transition to succeed.
  3213. * xref:api:governance.adoc#TimelockController-TimelockController-cancel-bytes32-[`cancel`] allows proposers to cancel any `Pending` operation. This resets the operation to the `Unset` state. It is thus possible for a proposer to re-schedule an operation that has been cancelled. In this case, the timer restarts when the operation is re-scheduled.
  3214. Operations status can be queried using the functions:
  3215. * xref:api:governance.adoc#TimelockController-isOperationPending-bytes32-[`isOperationPending(bytes32)`]
  3216. * xref:api:governance.adoc#TimelockController-isOperationReady-bytes32-[`isOperationReady(bytes32)`]
  3217. * xref:api:governance.adoc#TimelockController-isOperationDone-bytes32-[`isOperationDone(bytes32)`]
  3218. [[timelock-roles]]
  3219. ==== Roles
  3220. [[timelock-admin]]
  3221. ===== Admin
  3222. The admins are in charge of managing proposers and executors. For the timelock to be self-governed, this role should only be given to the timelock itself. Upon deployment, the admin role can be granted to any address (in addition to the timelock itself). After further configuration and testing, this optional admin should renounce its role such that all further maintenance operations have to go through the timelock process.
  3223. This role is identified by the *TIMELOCK_ADMIN_ROLE* value: `0x5f58e3a2316349923ce3780f8d587db2d72378aed66a8261c916544fa6846ca5`
  3224. [[timelock-proposer]]
  3225. ===== Proposer
  3226. The proposers are in charge of scheduling (and cancelling) operations. This is a critical role, that should be given to governing entities. This could be an EOA, a multisig, or a DAO.
  3227. WARNING: *Proposer fight:* Having multiple proposers, while providing redundancy in case one becomes unavailable, can be dangerous. As proposer have their say on all operations, they could cancel operations they disagree with, including operations to remove them for the proposers.
  3228. This role is identified by the *PROPOSER_ROLE* value: `0xb09aa5aeb3702cfd50b6b62bc4532604938f21248a27a1d5ca736082b6819cc1`
  3229. [[timelock-executor]]
  3230. ===== Executor
  3231. The executors are in charge of executing the operations scheduled by the proposers once the timelock expires. Logic dictates that multisig or DAO that are proposers should also be executors in order to guarantee operations that have been scheduled will eventually be executed. However, having additional executors can reduce the cost (the executing transaction does not require validation by the multisig or DAO that proposed it), while ensuring whoever is in charge of execution cannot trigger actions that have not been scheduled by the proposers. Alternatively, it is possible to allow _any_ address to execute a proposal once the timelock has expired by granting the executor role to the zero address.
  3232. This role is identified by the *EXECUTOR_ROLE* value: `0xd8aa0f3194971a2a116679f7c2090f6939c8d4e01a2a8d7e41d55e5351469e63`
  3233. WARNING: A live contract without at least one proposer and one executor is locked. Make sure these roles are filled by reliable entities before the deployer renounces its administrative rights in favour of the timelock contract itself. See the {AccessControl} documentation to learn more about role management.