governance.adoc 359 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780
  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. :ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
  6. :GovernorVotesQuorumFraction: pass:normal[xref:governance.adoc#GovernorVotesQuorumFraction[`GovernorVotesQuorumFraction`]]
  7. :GovernorCountingSimple: pass:normal[xref:governance.adoc#GovernorCountingSimple[`GovernorCountingSimple`]]
  8. :GovernorTimelockAccess: pass:normal[xref:governance.adoc#GovernorTimelockAccess[`GovernorTimelockAccess`]]
  9. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  10. :GovernorTimelockControl: pass:normal[xref:governance.adoc#GovernorTimelockControl[`GovernorTimelockControl`]]
  11. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  12. :GovernorTimelockCompound: pass:normal[xref:governance.adoc#GovernorTimelockCompound[`GovernorTimelockCompound`]]
  13. :GovernorStorage: pass:normal[xref:governance.adoc#GovernorStorage[`GovernorStorage`]]
  14. :GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
  15. :GovernorPreventLateQuorum: pass:normal[xref:governance.adoc#GovernorPreventLateQuorum[`GovernorPreventLateQuorum`]]
  16. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  17. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  18. :xref-IGovernor-name--: xref:governance.adoc#IGovernor-name--
  19. :xref-IGovernor-version--: xref:governance.adoc#IGovernor-version--
  20. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  21. :xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-
  22. :xref-IGovernor-state-uint256-: xref:governance.adoc#IGovernor-state-uint256-
  23. :xref-IGovernor-proposalThreshold--: xref:governance.adoc#IGovernor-proposalThreshold--
  24. :xref-IGovernor-proposalSnapshot-uint256-: xref:governance.adoc#IGovernor-proposalSnapshot-uint256-
  25. :xref-IGovernor-proposalDeadline-uint256-: xref:governance.adoc#IGovernor-proposalDeadline-uint256-
  26. :xref-IGovernor-proposalProposer-uint256-: xref:governance.adoc#IGovernor-proposalProposer-uint256-
  27. :xref-IGovernor-proposalEta-uint256-: xref:governance.adoc#IGovernor-proposalEta-uint256-
  28. :xref-IGovernor-proposalNeedsQueuing-uint256-: xref:governance.adoc#IGovernor-proposalNeedsQueuing-uint256-
  29. :xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
  30. :xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
  31. :xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
  32. :xref-IGovernor-getVotes-address-uint256-: xref:governance.adoc#IGovernor-getVotes-address-uint256-
  33. :xref-IGovernor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-
  34. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  35. :xref-IGovernor-propose-address---uint256---bytes---string-: xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-
  36. :xref-IGovernor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-queue-address---uint256---bytes---bytes32-
  37. :xref-IGovernor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-
  38. :xref-IGovernor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-cancel-address---uint256---bytes---bytes32-
  39. :xref-IGovernor-castVote-uint256-uint8-: xref:governance.adoc#IGovernor-castVote-uint256-uint8-
  40. :xref-IGovernor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-
  41. :xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  42. :xref-IGovernor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-address-bytes-
  43. :xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  44. :xref-IERC6372-clock--: xref:interfaces.adoc#IERC6372-clock--
  45. :xref-IERC6372-CLOCK_MODE--: xref:interfaces.adoc#IERC6372-CLOCK_MODE--
  46. :xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
  47. :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-
  48. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  49. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  50. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  51. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  52. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  53. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  54. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  55. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  56. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  57. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  58. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  59. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  60. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  61. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  62. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  63. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  64. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  65. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  66. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  67. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  68. :IERC6372-clock: pass:normal[xref:interfaces.adoc#IERC6372-clock--[`IERC6372.clock`]]
  69. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  70. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  71. :IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
  72. :IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
  73. :Governor-_encodeStateBitmap: pass:normal[xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-[`Governor._encodeStateBitmap`]]
  74. :IERC1271-isValidSignature: pass:normal[xref:interfaces.adoc#IERC1271-isValidSignature-bytes32-bytes-[`IERC1271.isValidSignature`]]
  75. :xref-Governor-onlyGovernance--: xref:governance.adoc#Governor-onlyGovernance--
  76. :xref-Governor-constructor-string-: xref:governance.adoc#Governor-constructor-string-
  77. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  78. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  79. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  80. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  81. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  82. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  83. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  84. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  85. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  86. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  87. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  88. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  89. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  90. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  91. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  92. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  93. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  94. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  95. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  96. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  97. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  98. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  99. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  100. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  101. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  102. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  103. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  104. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  105. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  106. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  107. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  108. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  109. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  110. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  111. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  112. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  113. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  114. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  115. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  116. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  117. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  118. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  119. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  120. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  121. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  122. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  123. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  124. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  125. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  126. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  127. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  128. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  129. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  130. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  131. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  132. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  133. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  134. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  135. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  136. :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-
  137. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  138. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  139. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  140. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  141. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  142. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  143. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  144. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  145. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  146. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  147. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  148. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  149. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  150. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  151. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  152. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  153. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  154. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  155. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  156. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  157. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  158. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  159. :GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
  160. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  161. :IGovernor-name: pass:normal[xref:governance.adoc#IGovernor-name--[`IGovernor.name`]]
  162. :IGovernor-version: pass:normal[xref:governance.adoc#IGovernor-version--[`IGovernor.version`]]
  163. :IGovernor-hashProposal: pass:normal[xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`IGovernor.hashProposal`]]
  164. :IGovernor-state: pass:normal[xref:governance.adoc#IGovernor-state-uint256-[`IGovernor.state`]]
  165. :IGovernor-proposalThreshold: pass:normal[xref:governance.adoc#IGovernor-proposalThreshold--[`IGovernor.proposalThreshold`]]
  166. :IGovernor-proposalSnapshot: pass:normal[xref:governance.adoc#IGovernor-proposalSnapshot-uint256-[`IGovernor.proposalSnapshot`]]
  167. :IGovernor-proposalDeadline: pass:normal[xref:governance.adoc#IGovernor-proposalDeadline-uint256-[`IGovernor.proposalDeadline`]]
  168. :IGovernor-proposalProposer: pass:normal[xref:governance.adoc#IGovernor-proposalProposer-uint256-[`IGovernor.proposalProposer`]]
  169. :IGovernor-proposalEta: pass:normal[xref:governance.adoc#IGovernor-proposalEta-uint256-[`IGovernor.proposalEta`]]
  170. :IGovernor-proposalNeedsQueuing: pass:normal[xref:governance.adoc#IGovernor-proposalNeedsQueuing-uint256-[`IGovernor.proposalNeedsQueuing`]]
  171. :IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
  172. :IGovernor-ProposalCreated: pass:normal[xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-[`IGovernor.ProposalCreated`]]
  173. :IGovernor-queue: pass:normal[xref:governance.adoc#IGovernor-queue-address---uint256---bytes---bytes32-[`IGovernor.queue`]]
  174. :IGovernor-execute: pass:normal[xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-[`IGovernor.execute`]]
  175. :IGovernor-cancel: pass:normal[xref:governance.adoc#IGovernor-cancel-address---uint256---bytes---bytes32-[`IGovernor.cancel`]]
  176. :IGovernor-ProposalCanceled: pass:normal[xref:governance.adoc#IGovernor-ProposalCanceled-uint256-[`IGovernor.ProposalCanceled`]]
  177. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  178. :IGovernor-getVotesWithParams: pass:normal[xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-[`IGovernor.getVotesWithParams`]]
  179. :IGovernor-castVote: pass:normal[xref:governance.adoc#IGovernor-castVote-uint256-uint8-[`IGovernor.castVote`]]
  180. :IGovernor-castVoteWithReason: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-[`IGovernor.castVoteWithReason`]]
  181. :IGovernor-castVoteWithReasonAndParams: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`IGovernor.castVoteWithReasonAndParams`]]
  182. :IGovernor-castVoteBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-address-bytes-[`IGovernor.castVoteBySig`]]
  183. :IGovernor-castVoteWithReasonAndParamsBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-[`IGovernor.castVoteWithReasonAndParamsBySig`]]
  184. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  185. :IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
  186. :IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
  187. :IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
  188. :IERC721Receiver-onERC721Received: pass:normal[xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-[`IERC721Receiver.onERC721Received`]]
  189. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
  190. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
  191. :IERC6372-clock: pass:normal[xref:interfaces.adoc#IERC6372-clock--[`IERC6372.clock`]]
  192. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  193. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  194. :xref-GovernorCountingSimple-COUNTING_MODE--: xref:governance.adoc#GovernorCountingSimple-COUNTING_MODE--
  195. :xref-GovernorCountingSimple-hasVoted-uint256-address-: xref:governance.adoc#GovernorCountingSimple-hasVoted-uint256-address-
  196. :xref-GovernorCountingSimple-proposalVotes-uint256-: xref:governance.adoc#GovernorCountingSimple-proposalVotes-uint256-
  197. :xref-GovernorCountingSimple-_quorumReached-uint256-: xref:governance.adoc#GovernorCountingSimple-_quorumReached-uint256-
  198. :xref-GovernorCountingSimple-_voteSucceeded-uint256-: xref:governance.adoc#GovernorCountingSimple-_voteSucceeded-uint256-
  199. :xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-
  200. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  201. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  202. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  203. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  204. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  205. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  206. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  207. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  208. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  209. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  210. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  211. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  212. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  213. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  214. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  215. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  216. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  217. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  218. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  219. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  220. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  221. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  222. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  223. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  224. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  225. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  226. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  227. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  228. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  229. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  230. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  231. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  232. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  233. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  234. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  235. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  236. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  237. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  238. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  239. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  240. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  241. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  242. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  243. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  244. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  245. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  246. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  247. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  248. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  249. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  250. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  251. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  252. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  253. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  254. :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-
  255. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  256. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  257. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  258. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  259. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  260. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  261. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  262. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  263. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  264. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  265. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  266. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  267. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  268. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  269. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  270. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  271. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  272. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  273. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  274. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  275. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  276. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  277. :IGovernor-COUNTING_MODE: pass:normal[xref:governance.adoc#IGovernor-COUNTING_MODE--[`IGovernor.COUNTING_MODE`]]
  278. :IGovernor-hasVoted: pass:normal[xref:governance.adoc#IGovernor-hasVoted-uint256-address-[`IGovernor.hasVoted`]]
  279. :Governor-_quorumReached: pass:normal[xref:governance.adoc#Governor-_quorumReached-uint256-[`Governor._quorumReached`]]
  280. :Governor-_voteSucceeded: pass:normal[xref:governance.adoc#Governor-_voteSucceeded-uint256-[`Governor._voteSucceeded`]]
  281. :Governor-_countVote: pass:normal[xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`Governor._countVote`]]
  282. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  283. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  284. :ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
  285. :xref-GovernorVotes-constructor-contract-IVotes-: xref:governance.adoc#GovernorVotes-constructor-contract-IVotes-
  286. :xref-GovernorVotes-token--: xref:governance.adoc#GovernorVotes-token--
  287. :xref-GovernorVotes-clock--: xref:governance.adoc#GovernorVotes-clock--
  288. :xref-GovernorVotes-CLOCK_MODE--: xref:governance.adoc#GovernorVotes-CLOCK_MODE--
  289. :xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
  290. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  291. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  292. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  293. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  294. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  295. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  296. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  297. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  298. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  299. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  300. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  301. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  302. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  303. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  304. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  305. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  306. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  307. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  308. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  309. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  310. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  311. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  312. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  313. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  314. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  315. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  316. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  317. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  318. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  319. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  320. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  321. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  322. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  323. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  324. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  325. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  326. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  327. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  328. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  329. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  330. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  331. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  332. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  333. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  334. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  335. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  336. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  337. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  338. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  339. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  340. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  341. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  342. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  343. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  344. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  345. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  346. :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-
  347. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  348. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  349. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  350. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  351. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  352. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  353. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  354. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  355. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  356. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  357. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  358. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  359. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  360. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  361. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  362. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  363. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  364. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  365. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  366. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  367. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  368. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  369. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  370. :ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
  371. :xref-GovernorVotesQuorumFraction-constructor-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-constructor-uint256-
  372. :xref-GovernorVotesQuorumFraction-quorumNumerator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator--
  373. :xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator-uint256-
  374. :xref-GovernorVotesQuorumFraction-quorumDenominator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumDenominator--
  375. :xref-GovernorVotesQuorumFraction-quorum-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorum-uint256-
  376. :xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-
  377. :xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-
  378. :xref-GovernorVotes-token--: xref:governance.adoc#GovernorVotes-token--
  379. :xref-GovernorVotes-clock--: xref:governance.adoc#GovernorVotes-clock--
  380. :xref-GovernorVotes-CLOCK_MODE--: xref:governance.adoc#GovernorVotes-CLOCK_MODE--
  381. :xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
  382. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  383. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  384. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  385. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  386. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  387. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  388. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  389. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  390. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  391. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  392. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  393. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  394. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  395. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  396. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  397. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  398. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  399. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  400. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  401. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  402. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  403. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  404. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  405. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  406. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  407. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  408. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  409. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  410. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  411. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  412. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  413. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  414. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  415. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  416. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  417. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  418. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  419. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  420. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  421. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  422. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  423. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  424. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  425. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  426. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  427. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  428. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  429. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  430. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  431. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  432. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  433. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  434. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  435. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  436. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  437. :xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-
  438. :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-
  439. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  440. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  441. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  442. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  443. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  444. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  445. :xref-GovernorVotesQuorumFraction-GovernorInvalidQuorumFraction-uint256-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-GovernorInvalidQuorumFraction-uint256-uint256-
  446. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  447. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  448. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  449. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  450. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  451. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  452. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  453. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  454. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  455. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  456. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  457. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  458. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  459. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  460. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  461. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  462. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  463. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  464. :GovernorTimelockControl: pass:normal[xref:governance.adoc#GovernorTimelockControl[`GovernorTimelockControl`]]
  465. :GovernorTimelockCompound: pass:normal[xref:governance.adoc#GovernorTimelockCompound[`GovernorTimelockCompound`]]
  466. :AccessManager-execute: pass:normal[xref:access.adoc#AccessManager-execute-address-bytes-[`AccessManager.execute`]]
  467. :xref-GovernorTimelockAccess-constructor-address-uint32-: xref:governance.adoc#GovernorTimelockAccess-constructor-address-uint32-
  468. :xref-GovernorTimelockAccess-accessManager--: xref:governance.adoc#GovernorTimelockAccess-accessManager--
  469. :xref-GovernorTimelockAccess-baseDelaySeconds--: xref:governance.adoc#GovernorTimelockAccess-baseDelaySeconds--
  470. :xref-GovernorTimelockAccess-setBaseDelaySeconds-uint32-: xref:governance.adoc#GovernorTimelockAccess-setBaseDelaySeconds-uint32-
  471. :xref-GovernorTimelockAccess-_setBaseDelaySeconds-uint32-: xref:governance.adoc#GovernorTimelockAccess-_setBaseDelaySeconds-uint32-
  472. :xref-GovernorTimelockAccess-isAccessManagerIgnored-address-bytes4-: xref:governance.adoc#GovernorTimelockAccess-isAccessManagerIgnored-address-bytes4-
  473. :xref-GovernorTimelockAccess-setAccessManagerIgnored-address-bytes4---bool-: xref:governance.adoc#GovernorTimelockAccess-setAccessManagerIgnored-address-bytes4---bool-
  474. :xref-GovernorTimelockAccess-_setAccessManagerIgnored-address-bytes4-bool-: xref:governance.adoc#GovernorTimelockAccess-_setAccessManagerIgnored-address-bytes4-bool-
  475. :xref-GovernorTimelockAccess-proposalExecutionPlan-uint256-: xref:governance.adoc#GovernorTimelockAccess-proposalExecutionPlan-uint256-
  476. :xref-GovernorTimelockAccess-proposalNeedsQueuing-uint256-: xref:governance.adoc#GovernorTimelockAccess-proposalNeedsQueuing-uint256-
  477. :xref-GovernorTimelockAccess-propose-address---uint256---bytes---string-: xref:governance.adoc#GovernorTimelockAccess-propose-address---uint256---bytes---string-
  478. :xref-GovernorTimelockAccess-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockAccess-_queueOperations-uint256-address---uint256---bytes---bytes32-
  479. :xref-GovernorTimelockAccess-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockAccess-_executeOperations-uint256-address---uint256---bytes---bytes32-
  480. :xref-GovernorTimelockAccess-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockAccess-_cancel-address---uint256---bytes---bytes32-
  481. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  482. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  483. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  484. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  485. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  486. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  487. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  488. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  489. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  490. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  491. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  492. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  493. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  494. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  495. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  496. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  497. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  498. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  499. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  500. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  501. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  502. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  503. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  504. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  505. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  506. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  507. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  508. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  509. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  510. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  511. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  512. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  513. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  514. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  515. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  516. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  517. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  518. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  519. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  520. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  521. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  522. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  523. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  524. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  525. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  526. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  527. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  528. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  529. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  530. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  531. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  532. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  533. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  534. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  535. :xref-GovernorTimelockAccess-BaseDelaySet-uint32-uint32-: xref:governance.adoc#GovernorTimelockAccess-BaseDelaySet-uint32-uint32-
  536. :xref-GovernorTimelockAccess-AccessManagerIgnoredSet-address-bytes4-bool-: xref:governance.adoc#GovernorTimelockAccess-AccessManagerIgnoredSet-address-bytes4-bool-
  537. :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-
  538. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  539. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  540. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  541. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  542. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  543. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  544. :xref-GovernorTimelockAccess-GovernorUnmetDelay-uint256-uint256-: xref:governance.adoc#GovernorTimelockAccess-GovernorUnmetDelay-uint256-uint256-
  545. :xref-GovernorTimelockAccess-GovernorMismatchedNonce-uint256-uint256-uint256-: xref:governance.adoc#GovernorTimelockAccess-GovernorMismatchedNonce-uint256-uint256-uint256-
  546. :xref-GovernorTimelockAccess-GovernorLockedIgnore--: xref:governance.adoc#GovernorTimelockAccess-GovernorLockedIgnore--
  547. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  548. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  549. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  550. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  551. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  552. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  553. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  554. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  555. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  556. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  557. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  558. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  559. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  560. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  561. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  562. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  563. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  564. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  565. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  566. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  567. :AccessManager: pass:normal[xref:access.adoc#AccessManager[`AccessManager`]]
  568. :IGovernor-proposalNeedsQueuing: pass:normal[xref:governance.adoc#IGovernor-proposalNeedsQueuing-uint256-[`IGovernor.proposalNeedsQueuing`]]
  569. :IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
  570. :AccessManager-execute: pass:normal[xref:access.adoc#AccessManager-execute-address-bytes-[`AccessManager.execute`]]
  571. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  572. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  573. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  574. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  575. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  576. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  577. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  578. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  579. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  580. :Governor-relay: pass:normal[xref:governance.adoc#Governor-relay-address-uint256-bytes-[`Governor.relay`]]
  581. :AccessManager-schedule: pass:normal[xref:access.adoc#AccessManager-schedule-address-bytes-uint48-[`AccessManager.schedule`]]
  582. :xref-GovernorTimelockControl-constructor-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-constructor-contract-TimelockController-
  583. :xref-GovernorTimelockControl-state-uint256-: xref:governance.adoc#GovernorTimelockControl-state-uint256-
  584. :xref-GovernorTimelockControl-timelock--: xref:governance.adoc#GovernorTimelockControl-timelock--
  585. :xref-GovernorTimelockControl-proposalNeedsQueuing-uint256-: xref:governance.adoc#GovernorTimelockControl-proposalNeedsQueuing-uint256-
  586. :xref-GovernorTimelockControl-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_queueOperations-uint256-address---uint256---bytes---bytes32-
  587. :xref-GovernorTimelockControl-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_executeOperations-uint256-address---uint256---bytes---bytes32-
  588. :xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-
  589. :xref-GovernorTimelockControl-_executor--: xref:governance.adoc#GovernorTimelockControl-_executor--
  590. :xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-updateTimelock-contract-TimelockController-
  591. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  592. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  593. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  594. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  595. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  596. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  597. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  598. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  599. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  600. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  601. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  602. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  603. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  604. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  605. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  606. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  607. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  608. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  609. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  610. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  611. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  612. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  613. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  614. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  615. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  616. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  617. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  618. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  619. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  620. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  621. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  622. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  623. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  624. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  625. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  626. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  627. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  628. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  629. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  630. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  631. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  632. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  633. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  634. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  635. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  636. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  637. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  638. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  639. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  640. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  641. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  642. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  643. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  644. :xref-GovernorTimelockControl-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockControl-TimelockChange-address-address-
  645. :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-
  646. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  647. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  648. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  649. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  650. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  651. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  652. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  653. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  654. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  655. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  656. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  657. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  658. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  659. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  660. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  661. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  662. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  663. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  664. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  665. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  666. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  667. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  668. :Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
  669. :IGovernor-proposalNeedsQueuing: pass:normal[xref:governance.adoc#IGovernor-proposalNeedsQueuing-uint256-[`IGovernor.proposalNeedsQueuing`]]
  670. :Governor-_executeOperations: pass:normal[xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-[`Governor._executeOperations`]]
  671. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  672. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  673. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  674. :GovernorTimelockCompound-__acceptAdmin: pass:normal[xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--[`GovernorTimelockCompound.__acceptAdmin`]]
  675. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  676. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  677. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  678. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  679. :xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-
  680. :xref-GovernorTimelockCompound-state-uint256-: xref:governance.adoc#GovernorTimelockCompound-state-uint256-
  681. :xref-GovernorTimelockCompound-timelock--: xref:governance.adoc#GovernorTimelockCompound-timelock--
  682. :xref-GovernorTimelockCompound-proposalNeedsQueuing-uint256-: xref:governance.adoc#GovernorTimelockCompound-proposalNeedsQueuing-uint256-
  683. :xref-GovernorTimelockCompound-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_queueOperations-uint256-address---uint256---bytes---bytes32-
  684. :xref-GovernorTimelockCompound-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_executeOperations-uint256-address---uint256---bytes---bytes32-
  685. :xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-
  686. :xref-GovernorTimelockCompound-_executor--: xref:governance.adoc#GovernorTimelockCompound-_executor--
  687. :xref-GovernorTimelockCompound-__acceptAdmin--: xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--
  688. :xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-
  689. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  690. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  691. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  692. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  693. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  694. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  695. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  696. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  697. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  698. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  699. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  700. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  701. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  702. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  703. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  704. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  705. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  706. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  707. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  708. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  709. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  710. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  711. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  712. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  713. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  714. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  715. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  716. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  717. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  718. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  719. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  720. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  721. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  722. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  723. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  724. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  725. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  726. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  727. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  728. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  729. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  730. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  731. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  732. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  733. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  734. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  735. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  736. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  737. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  738. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  739. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  740. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  741. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  742. :xref-GovernorTimelockCompound-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockCompound-TimelockChange-address-address-
  743. :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-
  744. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  745. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  746. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  747. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  748. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  749. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  750. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  751. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  752. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  753. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  754. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  755. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  756. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  757. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  758. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  759. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  760. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  761. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  762. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  763. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  764. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  765. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  766. :Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
  767. :IGovernor-proposalNeedsQueuing: pass:normal[xref:governance.adoc#IGovernor-proposalNeedsQueuing-uint256-[`IGovernor.proposalNeedsQueuing`]]
  768. :Governor-_executeOperations: pass:normal[xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-[`Governor._executeOperations`]]
  769. :Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
  770. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  771. :xref-GovernorSettings-constructor-uint48-uint32-uint256-: xref:governance.adoc#GovernorSettings-constructor-uint48-uint32-uint256-
  772. :xref-GovernorSettings-votingDelay--: xref:governance.adoc#GovernorSettings-votingDelay--
  773. :xref-GovernorSettings-votingPeriod--: xref:governance.adoc#GovernorSettings-votingPeriod--
  774. :xref-GovernorSettings-proposalThreshold--: xref:governance.adoc#GovernorSettings-proposalThreshold--
  775. :xref-GovernorSettings-setVotingDelay-uint48-: xref:governance.adoc#GovernorSettings-setVotingDelay-uint48-
  776. :xref-GovernorSettings-setVotingPeriod-uint32-: xref:governance.adoc#GovernorSettings-setVotingPeriod-uint32-
  777. :xref-GovernorSettings-setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-setProposalThreshold-uint256-
  778. :xref-GovernorSettings-_setVotingDelay-uint48-: xref:governance.adoc#GovernorSettings-_setVotingDelay-uint48-
  779. :xref-GovernorSettings-_setVotingPeriod-uint32-: xref:governance.adoc#GovernorSettings-_setVotingPeriod-uint32-
  780. :xref-GovernorSettings-_setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-_setProposalThreshold-uint256-
  781. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  782. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  783. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  784. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  785. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  786. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  787. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  788. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  789. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  790. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  791. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  792. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  793. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  794. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  795. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  796. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  797. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  798. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  799. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  800. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  801. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  802. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  803. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  804. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  805. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  806. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  807. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  808. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  809. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  810. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  811. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  812. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  813. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  814. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  815. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  816. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  817. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  818. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  819. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  820. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  821. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  822. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  823. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  824. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  825. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  826. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  827. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  828. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  829. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  830. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  831. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  832. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  833. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  834. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  835. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  836. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  837. :xref-GovernorSettings-VotingDelaySet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingDelaySet-uint256-uint256-
  838. :xref-GovernorSettings-VotingPeriodSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingPeriodSet-uint256-uint256-
  839. :xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-ProposalThresholdSet-uint256-uint256-
  840. :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-
  841. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  842. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  843. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  844. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  845. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  846. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  847. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  848. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  849. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  850. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  851. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  852. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  853. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  854. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  855. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  856. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  857. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  858. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  859. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  860. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  861. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  862. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  863. :IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
  864. :IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
  865. :Governor-proposalThreshold: pass:normal[xref:governance.adoc#Governor-proposalThreshold--[`Governor.proposalThreshold`]]
  866. :xref-GovernorPreventLateQuorum-constructor-uint48-: xref:governance.adoc#GovernorPreventLateQuorum-constructor-uint48-
  867. :xref-GovernorPreventLateQuorum-proposalDeadline-uint256-: xref:governance.adoc#GovernorPreventLateQuorum-proposalDeadline-uint256-
  868. :xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-
  869. :xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--: xref:governance.adoc#GovernorPreventLateQuorum-lateQuorumVoteExtension--
  870. :xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint48-: xref:governance.adoc#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint48-
  871. :xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint48-: xref:governance.adoc#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint48-
  872. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  873. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  874. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  875. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  876. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  877. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  878. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  879. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  880. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  881. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  882. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  883. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  884. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  885. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  886. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  887. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  888. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  889. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  890. :xref-Governor-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#Governor-_propose-address---uint256---bytes---string-address-
  891. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  892. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  893. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  894. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  895. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  896. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  897. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  898. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  899. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  900. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  901. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  902. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  903. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  904. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  905. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  906. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  907. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  908. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  909. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  910. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  911. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  912. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  913. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  914. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  915. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  916. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  917. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  918. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  919. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  920. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  921. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  922. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  923. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  924. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  925. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  926. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  927. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  928. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  929. :xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-
  930. :xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-
  931. :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-
  932. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  933. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  934. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  935. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  936. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  937. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  938. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  939. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  940. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  941. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  942. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  943. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  944. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  945. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  946. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  947. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  948. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  949. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  950. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  951. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  952. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  953. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  954. :Governor-proposalDeadline: pass:normal[xref:governance.adoc#Governor-proposalDeadline-uint256-[`Governor.proposalDeadline`]]
  955. :Governor-_castVote: pass:normal[xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-[`Governor._castVote`]]
  956. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  957. :Governor-queue: pass:normal[xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-[`Governor.queue`]]
  958. :Governor-execute: pass:normal[xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-[`Governor.execute`]]
  959. :xref-GovernorStorage-_propose-address---uint256---bytes---string-address-: xref:governance.adoc#GovernorStorage-_propose-address---uint256---bytes---string-address-
  960. :xref-GovernorStorage-queue-uint256-: xref:governance.adoc#GovernorStorage-queue-uint256-
  961. :xref-GovernorStorage-execute-uint256-: xref:governance.adoc#GovernorStorage-execute-uint256-
  962. :xref-GovernorStorage-cancel-uint256-: xref:governance.adoc#GovernorStorage-cancel-uint256-
  963. :xref-GovernorStorage-proposalCount--: xref:governance.adoc#GovernorStorage-proposalCount--
  964. :xref-GovernorStorage-proposalDetails-uint256-: xref:governance.adoc#GovernorStorage-proposalDetails-uint256-
  965. :xref-GovernorStorage-proposalDetailsAt-uint256-: xref:governance.adoc#GovernorStorage-proposalDetailsAt-uint256-
  966. :xref-Governor-receive--: xref:governance.adoc#Governor-receive--
  967. :xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
  968. :xref-Governor-name--: xref:governance.adoc#Governor-name--
  969. :xref-Governor-version--: xref:governance.adoc#Governor-version--
  970. :xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
  971. :xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
  972. :xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
  973. :xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
  974. :xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
  975. :xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
  976. :xref-Governor-proposalEta-uint256-: xref:governance.adoc#Governor-proposalEta-uint256-
  977. :xref-Governor-proposalNeedsQueuing-uint256-: xref:governance.adoc#Governor-proposalNeedsQueuing-uint256-
  978. :xref-Governor-_checkGovernance--: xref:governance.adoc#Governor-_checkGovernance--
  979. :xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
  980. :xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
  981. :xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
  982. :xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
  983. :xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
  984. :xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
  985. :xref-Governor-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-queue-address---uint256---bytes---bytes32-
  986. :xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-
  987. :xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
  988. :xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-
  989. :xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
  990. :xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
  991. :xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
  992. :xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
  993. :xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
  994. :xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
  995. :xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
  996. :xref-Governor-castVoteBySig-uint256-uint8-address-bytes-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-address-bytes-
  997. :xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-
  998. :xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
  999. :xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
  1000. :xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
  1001. :xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
  1002. :xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
  1003. :xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
  1004. :xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  1005. :xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-: xref:governance.adoc#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-
  1006. :xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
  1007. :xref-Governor-clock--: xref:governance.adoc#Governor-clock--
  1008. :xref-Governor-CLOCK_MODE--: xref:governance.adoc#Governor-CLOCK_MODE--
  1009. :xref-Governor-votingDelay--: xref:governance.adoc#Governor-votingDelay--
  1010. :xref-Governor-votingPeriod--: xref:governance.adoc#Governor-votingPeriod--
  1011. :xref-Governor-quorum-uint256-: xref:governance.adoc#Governor-quorum-uint256-
  1012. :xref-Governor-BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-BALLOT_TYPEHASH-bytes32
  1013. :xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32: xref:governance.adoc#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32
  1014. :xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
  1015. :xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
  1016. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  1017. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  1018. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  1019. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  1020. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  1021. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  1022. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  1023. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  1024. :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-
  1025. :xref-IGovernor-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernor-ProposalQueued-uint256-uint256-
  1026. :xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
  1027. :xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
  1028. :xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
  1029. :xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
  1030. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  1031. :xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-
  1032. :xref-IGovernor-GovernorAlreadyCastVote-address-: xref:governance.adoc#IGovernor-GovernorAlreadyCastVote-address-
  1033. :xref-IGovernor-GovernorDisabledDeposit--: xref:governance.adoc#IGovernor-GovernorDisabledDeposit--
  1034. :xref-IGovernor-GovernorOnlyProposer-address-: xref:governance.adoc#IGovernor-GovernorOnlyProposer-address-
  1035. :xref-IGovernor-GovernorOnlyExecutor-address-: xref:governance.adoc#IGovernor-GovernorOnlyExecutor-address-
  1036. :xref-IGovernor-GovernorNonexistentProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNonexistentProposal-uint256-
  1037. :xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-: xref:governance.adoc#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-
  1038. :xref-IGovernor-GovernorInvalidVotingPeriod-uint256-: xref:governance.adoc#IGovernor-GovernorInvalidVotingPeriod-uint256-
  1039. :xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-: xref:governance.adoc#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-
  1040. :xref-IGovernor-GovernorRestrictedProposer-address-: xref:governance.adoc#IGovernor-GovernorRestrictedProposer-address-
  1041. :xref-IGovernor-GovernorInvalidVoteType--: xref:governance.adoc#IGovernor-GovernorInvalidVoteType--
  1042. :xref-IGovernor-GovernorQueueNotImplemented--: xref:governance.adoc#IGovernor-GovernorQueueNotImplemented--
  1043. :xref-IGovernor-GovernorNotQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorNotQueuedProposal-uint256-
  1044. :xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-: xref:governance.adoc#IGovernor-GovernorAlreadyQueuedProposal-uint256-
  1045. :xref-IGovernor-GovernorInvalidSignature-address-: xref:governance.adoc#IGovernor-GovernorInvalidSignature-address-
  1046. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  1047. :IGovernor-execute: pass:normal[xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-[`IGovernor.execute`]]
  1048. :IGovernor-cancel: pass:normal[xref:governance.adoc#IGovernor-cancel-address---uint256---bytes---bytes32-[`IGovernor.cancel`]]
  1049. :ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
  1050. :ERC721-balanceOf: pass:normal[xref:token/ERC721.adoc#ERC721-balanceOf-address-[`ERC721.balanceOf`]]
  1051. :ERC721-_update: pass:normal[xref:token/ERC721.adoc#ERC721-_update-address-uint256-address-[`ERC721._update`]]
  1052. :xref-Votes-clock--: xref:governance.adoc#Votes-clock--
  1053. :xref-Votes-CLOCK_MODE--: xref:governance.adoc#Votes-CLOCK_MODE--
  1054. :xref-Votes-getVotes-address-: xref:governance.adoc#Votes-getVotes-address-
  1055. :xref-Votes-getPastVotes-address-uint256-: xref:governance.adoc#Votes-getPastVotes-address-uint256-
  1056. :xref-Votes-getPastTotalSupply-uint256-: xref:governance.adoc#Votes-getPastTotalSupply-uint256-
  1057. :xref-Votes-_getTotalSupply--: xref:governance.adoc#Votes-_getTotalSupply--
  1058. :xref-Votes-delegates-address-: xref:governance.adoc#Votes-delegates-address-
  1059. :xref-Votes-delegate-address-: xref:governance.adoc#Votes-delegate-address-
  1060. :xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-: xref:governance.adoc#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-
  1061. :xref-Votes-_delegate-address-address-: xref:governance.adoc#Votes-_delegate-address-address-
  1062. :xref-Votes-_transferVotingUnits-address-address-uint256-: xref:governance.adoc#Votes-_transferVotingUnits-address-address-uint256-
  1063. :xref-Votes-_numCheckpoints-address-: xref:governance.adoc#Votes-_numCheckpoints-address-
  1064. :xref-Votes-_checkpoints-address-uint32-: xref:governance.adoc#Votes-_checkpoints-address-uint32-
  1065. :xref-Votes-_getVotingUnits-address-: xref:governance.adoc#Votes-_getVotingUnits-address-
  1066. :xref-Nonces-nonces-address-: xref:utils.adoc#Nonces-nonces-address-
  1067. :xref-Nonces-_useNonce-address-: xref:utils.adoc#Nonces-_useNonce-address-
  1068. :xref-Nonces-_useCheckedNonce-address-uint256-: xref:utils.adoc#Nonces-_useCheckedNonce-address-uint256-
  1069. :xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
  1070. :xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
  1071. :xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
  1072. :xref-EIP712-_EIP712Name--: xref:utils.adoc#EIP712-_EIP712Name--
  1073. :xref-EIP712-_EIP712Version--: xref:utils.adoc#EIP712-_EIP712Version--
  1074. :xref-IVotes-DelegateChanged-address-address-address-: xref:governance.adoc#IVotes-DelegateChanged-address-address-address-
  1075. :xref-IVotes-DelegateVotesChanged-address-uint256-uint256-: xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-
  1076. :xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
  1077. :xref-Votes-ERC6372InconsistentClock--: xref:governance.adoc#Votes-ERC6372InconsistentClock--
  1078. :xref-Votes-ERC5805FutureLookup-uint256-uint48-: xref:governance.adoc#Votes-ERC5805FutureLookup-uint256-uint48-
  1079. :xref-IVotes-VotesExpiredSignature-uint256-: xref:governance.adoc#IVotes-VotesExpiredSignature-uint256-
  1080. :xref-Nonces-InvalidAccountNonce-address-uint256-: xref:utils.adoc#Nonces-InvalidAccountNonce-address-uint256-
  1081. :IVotes-DelegateChanged: pass:normal[xref:governance.adoc#IVotes-DelegateChanged-address-address-address-[`IVotes.DelegateChanged`]]
  1082. :IVotes-DelegateVotesChanged: pass:normal[xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-[`IVotes.DelegateVotesChanged`]]
  1083. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  1084. :Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
  1085. :TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
  1086. :xref-TimelockController-onlyRoleOrOpenRole-bytes32-: xref:governance.adoc#TimelockController-onlyRoleOrOpenRole-bytes32-
  1087. :xref-TimelockController-constructor-uint256-address---address---address-: xref:governance.adoc#TimelockController-constructor-uint256-address---address---address-
  1088. :xref-TimelockController-receive--: xref:governance.adoc#TimelockController-receive--
  1089. :xref-TimelockController-supportsInterface-bytes4-: xref:governance.adoc#TimelockController-supportsInterface-bytes4-
  1090. :xref-TimelockController-isOperation-bytes32-: xref:governance.adoc#TimelockController-isOperation-bytes32-
  1091. :xref-TimelockController-isOperationPending-bytes32-: xref:governance.adoc#TimelockController-isOperationPending-bytes32-
  1092. :xref-TimelockController-isOperationReady-bytes32-: xref:governance.adoc#TimelockController-isOperationReady-bytes32-
  1093. :xref-TimelockController-isOperationDone-bytes32-: xref:governance.adoc#TimelockController-isOperationDone-bytes32-
  1094. :xref-TimelockController-getTimestamp-bytes32-: xref:governance.adoc#TimelockController-getTimestamp-bytes32-
  1095. :xref-TimelockController-getOperationState-bytes32-: xref:governance.adoc#TimelockController-getOperationState-bytes32-
  1096. :xref-TimelockController-getMinDelay--: xref:governance.adoc#TimelockController-getMinDelay--
  1097. :xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-
  1098. :xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-
  1099. :xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-
  1100. :xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-
  1101. :xref-TimelockController-cancel-bytes32-: xref:governance.adoc#TimelockController-cancel-bytes32-
  1102. :xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-
  1103. :xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-
  1104. :xref-TimelockController-_execute-address-uint256-bytes-: xref:governance.adoc#TimelockController-_execute-address-uint256-bytes-
  1105. :xref-TimelockController-updateDelay-uint256-: xref:governance.adoc#TimelockController-updateDelay-uint256-
  1106. :xref-TimelockController-_encodeStateBitmap-enum-TimelockController-OperationState-: xref:governance.adoc#TimelockController-_encodeStateBitmap-enum-TimelockController-OperationState-
  1107. :xref-TimelockController-PROPOSER_ROLE-bytes32: xref:governance.adoc#TimelockController-PROPOSER_ROLE-bytes32
  1108. :xref-TimelockController-EXECUTOR_ROLE-bytes32: xref:governance.adoc#TimelockController-EXECUTOR_ROLE-bytes32
  1109. :xref-TimelockController-CANCELLER_ROLE-bytes32: xref:governance.adoc#TimelockController-CANCELLER_ROLE-bytes32
  1110. :xref-ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-
  1111. :xref-ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
  1112. :xref-ERC721Holder-onERC721Received-address-address-uint256-bytes-: xref:token/ERC721.adoc#ERC721Holder-onERC721Received-address-address-uint256-bytes-
  1113. :xref-AccessControl-hasRole-bytes32-address-: xref:access.adoc#AccessControl-hasRole-bytes32-address-
  1114. :xref-AccessControl-_checkRole-bytes32-: xref:access.adoc#AccessControl-_checkRole-bytes32-
  1115. :xref-AccessControl-_checkRole-bytes32-address-: xref:access.adoc#AccessControl-_checkRole-bytes32-address-
  1116. :xref-AccessControl-getRoleAdmin-bytes32-: xref:access.adoc#AccessControl-getRoleAdmin-bytes32-
  1117. :xref-AccessControl-grantRole-bytes32-address-: xref:access.adoc#AccessControl-grantRole-bytes32-address-
  1118. :xref-AccessControl-revokeRole-bytes32-address-: xref:access.adoc#AccessControl-revokeRole-bytes32-address-
  1119. :xref-AccessControl-renounceRole-bytes32-address-: xref:access.adoc#AccessControl-renounceRole-bytes32-address-
  1120. :xref-AccessControl-_setRoleAdmin-bytes32-bytes32-: xref:access.adoc#AccessControl-_setRoleAdmin-bytes32-bytes32-
  1121. :xref-AccessControl-_grantRole-bytes32-address-: xref:access.adoc#AccessControl-_grantRole-bytes32-address-
  1122. :xref-AccessControl-_revokeRole-bytes32-address-: xref:access.adoc#AccessControl-_revokeRole-bytes32-address-
  1123. :xref-AccessControl-DEFAULT_ADMIN_ROLE-bytes32: xref:access.adoc#AccessControl-DEFAULT_ADMIN_ROLE-bytes32
  1124. :xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-: xref:governance.adoc#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-
  1125. :xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-: xref:governance.adoc#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-
  1126. :xref-TimelockController-CallSalt-bytes32-bytes32-: xref:governance.adoc#TimelockController-CallSalt-bytes32-bytes32-
  1127. :xref-TimelockController-Cancelled-bytes32-: xref:governance.adoc#TimelockController-Cancelled-bytes32-
  1128. :xref-TimelockController-MinDelayChange-uint256-uint256-: xref:governance.adoc#TimelockController-MinDelayChange-uint256-uint256-
  1129. :xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-: xref:access.adoc#IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-
  1130. :xref-IAccessControl-RoleGranted-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleGranted-bytes32-address-address-
  1131. :xref-IAccessControl-RoleRevoked-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleRevoked-bytes32-address-address-
  1132. :xref-TimelockController-TimelockInvalidOperationLength-uint256-uint256-uint256-: xref:governance.adoc#TimelockController-TimelockInvalidOperationLength-uint256-uint256-uint256-
  1133. :xref-TimelockController-TimelockInsufficientDelay-uint256-uint256-: xref:governance.adoc#TimelockController-TimelockInsufficientDelay-uint256-uint256-
  1134. :xref-TimelockController-TimelockUnexpectedOperationState-bytes32-bytes32-: xref:governance.adoc#TimelockController-TimelockUnexpectedOperationState-bytes32-bytes32-
  1135. :xref-TimelockController-TimelockUnexecutedPredecessor-bytes32-: xref:governance.adoc#TimelockController-TimelockUnexecutedPredecessor-bytes32-
  1136. :xref-TimelockController-TimelockUnauthorizedCaller-address-: xref:governance.adoc#TimelockController-TimelockUnauthorizedCaller-address-
  1137. :xref-IAccessControl-AccessControlUnauthorizedAccount-address-bytes32-: xref:access.adoc#IAccessControl-AccessControlUnauthorizedAccount-address-bytes32-
  1138. :xref-IAccessControl-AccessControlBadConfirmation--: xref:access.adoc#IAccessControl-AccessControlBadConfirmation--
  1139. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
  1140. :AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
  1141. = Governance
  1142. [.readme-notice]
  1143. NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/governance
  1144. This directory includes primitives for on-chain governance.
  1145. == Governor
  1146. 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.
  1147. [TIP]
  1148. ====
  1149. For a guided experience, set up your Governor contract using https://wizard.openzeppelin.com/#governor[Contracts Wizard].
  1150. For a written walkthrough, check out our guide on xref:ROOT:governance.adoc[How to set up on-chain governance].
  1151. ====
  1152. * {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.
  1153. Votes modules determine the source of voting power, and sometimes quorum number.
  1154. * {GovernorVotes}: Extracts voting weight from an {ERC20Votes}, or since v4.5 an {ERC721Votes} token.
  1155. * {GovernorVotesQuorumFraction}: Combines with `GovernorVotes` to set the quorum as a fraction of the total token supply.
  1156. Counting modules determine valid voting options.
  1157. * {GovernorCountingSimple}: Simple voting mechanism with 3 voting options: Against, For and Abstain.
  1158. 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.
  1159. * {GovernorTimelockAccess}: Connects with an instance of an {AccessManager}. This allows restrictions (and delays) enforced by the manager to be considered by the Governor and integrated into the AccessManager's "schedule + execute" workflow.
  1160. * {GovernorTimelockControl}: Connects with an instance of {TimelockController}. Allows multiple proposers and executors, in addition to the Governor itself.
  1161. * {GovernorTimelockCompound}: Connects with an instance of Compound's https://github.com/compound-finance/compound-protocol/blob/master/contracts/Timelock.sol[`Timelock`] contract.
  1162. Other extensions can customize the behavior or interface in multiple ways.
  1163. * {GovernorStorage}: Stores the proposal details onchain and provides enumerability of the proposals. This can be useful for some L2 chains where storage is cheap compared to calldata.
  1164. * {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.
  1165. * {GovernorPreventLateQuorum}: Ensures there is a minimum voting period after quorum is reached as a security protection against large voters.
  1166. In addition to modules and extensions, the core contract requires a few virtual functions to be implemented to your particular specifications:
  1167. * <<Governor-votingDelay-,`votingDelay()`>>: Delay (in EIP-6372 clock) 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.
  1168. * <<Governor-votingPeriod-,`votingPeriod()`>>: Delay (in EIP-6372 clock) since the proposal starts until voting ends.
  1169. * <<Governor-quorum-uint256-,`quorum(uint256 timepoint)`>>: Quorum required for a proposal to be successful. This function includes a `timepoint` argument (see EIP-6372) so the quorum can adapt through time, for example, to follow a token's `totalSupply`.
  1170. 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.
  1171. === Core
  1172. :ProposalState: pass:normal[xref:#IGovernor-ProposalState[`++ProposalState++`]]
  1173. :GovernorInvalidProposalLength: pass:normal[xref:#IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-[`++GovernorInvalidProposalLength++`]]
  1174. :GovernorAlreadyCastVote: pass:normal[xref:#IGovernor-GovernorAlreadyCastVote-address-[`++GovernorAlreadyCastVote++`]]
  1175. :GovernorDisabledDeposit: pass:normal[xref:#IGovernor-GovernorDisabledDeposit--[`++GovernorDisabledDeposit++`]]
  1176. :GovernorOnlyProposer: pass:normal[xref:#IGovernor-GovernorOnlyProposer-address-[`++GovernorOnlyProposer++`]]
  1177. :GovernorOnlyExecutor: pass:normal[xref:#IGovernor-GovernorOnlyExecutor-address-[`++GovernorOnlyExecutor++`]]
  1178. :GovernorNonexistentProposal: pass:normal[xref:#IGovernor-GovernorNonexistentProposal-uint256-[`++GovernorNonexistentProposal++`]]
  1179. :GovernorUnexpectedProposalState: pass:normal[xref:#IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-[`++GovernorUnexpectedProposalState++`]]
  1180. :GovernorInvalidVotingPeriod: pass:normal[xref:#IGovernor-GovernorInvalidVotingPeriod-uint256-[`++GovernorInvalidVotingPeriod++`]]
  1181. :GovernorInsufficientProposerVotes: pass:normal[xref:#IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-[`++GovernorInsufficientProposerVotes++`]]
  1182. :GovernorRestrictedProposer: pass:normal[xref:#IGovernor-GovernorRestrictedProposer-address-[`++GovernorRestrictedProposer++`]]
  1183. :GovernorInvalidVoteType: pass:normal[xref:#IGovernor-GovernorInvalidVoteType--[`++GovernorInvalidVoteType++`]]
  1184. :GovernorQueueNotImplemented: pass:normal[xref:#IGovernor-GovernorQueueNotImplemented--[`++GovernorQueueNotImplemented++`]]
  1185. :GovernorNotQueuedProposal: pass:normal[xref:#IGovernor-GovernorNotQueuedProposal-uint256-[`++GovernorNotQueuedProposal++`]]
  1186. :GovernorAlreadyQueuedProposal: pass:normal[xref:#IGovernor-GovernorAlreadyQueuedProposal-uint256-[`++GovernorAlreadyQueuedProposal++`]]
  1187. :GovernorInvalidSignature: pass:normal[xref:#IGovernor-GovernorInvalidSignature-address-[`++GovernorInvalidSignature++`]]
  1188. :ProposalCreated: pass:normal[xref:#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-[`++ProposalCreated++`]]
  1189. :ProposalQueued: pass:normal[xref:#IGovernor-ProposalQueued-uint256-uint256-[`++ProposalQueued++`]]
  1190. :ProposalExecuted: pass:normal[xref:#IGovernor-ProposalExecuted-uint256-[`++ProposalExecuted++`]]
  1191. :ProposalCanceled: pass:normal[xref:#IGovernor-ProposalCanceled-uint256-[`++ProposalCanceled++`]]
  1192. :VoteCast: pass:normal[xref:#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`++VoteCast++`]]
  1193. :VoteCastWithParams: pass:normal[xref:#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-[`++VoteCastWithParams++`]]
  1194. :name: pass:normal[xref:#IGovernor-name--[`++name++`]]
  1195. :version: pass:normal[xref:#IGovernor-version--[`++version++`]]
  1196. :COUNTING_MODE: pass:normal[xref:#IGovernor-COUNTING_MODE--[`++COUNTING_MODE++`]]
  1197. :hashProposal: pass:normal[xref:#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
  1198. :state: pass:normal[xref:#IGovernor-state-uint256-[`++state++`]]
  1199. :proposalThreshold: pass:normal[xref:#IGovernor-proposalThreshold--[`++proposalThreshold++`]]
  1200. :proposalSnapshot: pass:normal[xref:#IGovernor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
  1201. :proposalDeadline: pass:normal[xref:#IGovernor-proposalDeadline-uint256-[`++proposalDeadline++`]]
  1202. :proposalProposer: pass:normal[xref:#IGovernor-proposalProposer-uint256-[`++proposalProposer++`]]
  1203. :proposalEta: pass:normal[xref:#IGovernor-proposalEta-uint256-[`++proposalEta++`]]
  1204. :proposalNeedsQueuing: pass:normal[xref:#IGovernor-proposalNeedsQueuing-uint256-[`++proposalNeedsQueuing++`]]
  1205. :votingDelay: pass:normal[xref:#IGovernor-votingDelay--[`++votingDelay++`]]
  1206. :votingPeriod: pass:normal[xref:#IGovernor-votingPeriod--[`++votingPeriod++`]]
  1207. :quorum: pass:normal[xref:#IGovernor-quorum-uint256-[`++quorum++`]]
  1208. :getVotes: pass:normal[xref:#IGovernor-getVotes-address-uint256-[`++getVotes++`]]
  1209. :getVotesWithParams: pass:normal[xref:#IGovernor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
  1210. :hasVoted: pass:normal[xref:#IGovernor-hasVoted-uint256-address-[`++hasVoted++`]]
  1211. :propose: pass:normal[xref:#IGovernor-propose-address---uint256---bytes---string-[`++propose++`]]
  1212. :queue: pass:normal[xref:#IGovernor-queue-address---uint256---bytes---bytes32-[`++queue++`]]
  1213. :execute: pass:normal[xref:#IGovernor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
  1214. :cancel: pass:normal[xref:#IGovernor-cancel-address---uint256---bytes---bytes32-[`++cancel++`]]
  1215. :castVote: pass:normal[xref:#IGovernor-castVote-uint256-uint8-[`++castVote++`]]
  1216. :castVoteWithReason: pass:normal[xref:#IGovernor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
  1217. :castVoteWithReasonAndParams: pass:normal[xref:#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
  1218. :castVoteBySig: pass:normal[xref:#IGovernor-castVoteBySig-uint256-uint8-address-bytes-[`++castVoteBySig++`]]
  1219. :castVoteWithReasonAndParamsBySig: pass:normal[xref:#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-[`++castVoteWithReasonAndParamsBySig++`]]
  1220. [.contract]
  1221. [[IGovernor]]
  1222. === `++IGovernor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/IGovernor.sol[{github-icon},role=heading-link]
  1223. [.hljs-theme-light.nopadding]
  1224. ```solidity
  1225. import "@openzeppelin/contracts/governance/IGovernor.sol";
  1226. ```
  1227. Interface of the {Governor} core.
  1228. [.contract-index]
  1229. .Functions
  1230. --
  1231. * {xref-IGovernor-name--}[`++name()++`]
  1232. * {xref-IGovernor-version--}[`++version()++`]
  1233. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1234. * {xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1235. * {xref-IGovernor-state-uint256-}[`++state(proposalId)++`]
  1236. * {xref-IGovernor-proposalThreshold--}[`++proposalThreshold()++`]
  1237. * {xref-IGovernor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1238. * {xref-IGovernor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1239. * {xref-IGovernor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  1240. * {xref-IGovernor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  1241. * {xref-IGovernor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing(proposalId)++`]
  1242. * {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
  1243. * {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
  1244. * {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
  1245. * {xref-IGovernor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  1246. * {xref-IGovernor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  1247. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1248. * {xref-IGovernor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1249. * {xref-IGovernor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  1250. * {xref-IGovernor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1251. * {xref-IGovernor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  1252. * {xref-IGovernor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1253. * {xref-IGovernor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1254. * {xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1255. * {xref-IGovernor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  1256. * {xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  1257. [.contract-subindex-inherited]
  1258. .IERC6372
  1259. * {xref-IERC6372-clock--}[`++clock()++`]
  1260. * {xref-IERC6372-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  1261. [.contract-subindex-inherited]
  1262. .IERC165
  1263. * {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1264. --
  1265. [.contract-index]
  1266. .Events
  1267. --
  1268. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  1269. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  1270. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1271. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1272. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1273. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1274. [.contract-subindex-inherited]
  1275. .IERC6372
  1276. [.contract-subindex-inherited]
  1277. .IERC165
  1278. --
  1279. [.contract-index]
  1280. .Errors
  1281. --
  1282. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  1283. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  1284. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  1285. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  1286. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  1287. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  1288. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  1289. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  1290. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  1291. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  1292. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  1293. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  1294. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  1295. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  1296. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  1297. [.contract-subindex-inherited]
  1298. .IERC6372
  1299. [.contract-subindex-inherited]
  1300. .IERC165
  1301. --
  1302. [.contract-item]
  1303. [[IGovernor-name--]]
  1304. ==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#external#
  1305. Name of the governor instance (used in building the ERC712 domain separator).
  1306. [.contract-item]
  1307. [[IGovernor-version--]]
  1308. ==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#external#
  1309. Version of the governor instance (used in building the ERC712 domain separator). Default: "1"
  1310. [.contract-item]
  1311. [[IGovernor-COUNTING_MODE--]]
  1312. ==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#external#
  1313. A description of the possible `support` values for {castVote} and the way these votes are counted, meant to
  1314. be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of
  1315. key-value pairs that each describe one aspect, for example `support=bravo&quorum=for,abstain`.
  1316. There are 2 standard keys: `support` and `quorum`.
  1317. - `support=bravo` refers to the vote options 0 = Against, 1 = For, 2 = Abstain, as in `GovernorBravo`.
  1318. - `quorum=bravo` means that only For votes are counted towards quorum.
  1319. - `quorum=for,abstain` means that both For and Abstain votes are counted towards quorum.
  1320. If a counting module makes use of encoded `params`, it should include this under a `params` key with a unique
  1321. name that describes the behavior. For example:
  1322. - `params=fractional` might refer to a scheme where votes are divided fractionally between for/against/abstain.
  1323. - `params=erc721` might refer to a scheme where specific NFTs are delegated to vote.
  1324. NOTE: The string can be decoded by the standard
  1325. https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[`URLSearchParams`]
  1326. JavaScript class.
  1327. [.contract-item]
  1328. [[IGovernor-hashProposal-address---uint256---bytes---bytes32-]]
  1329. ==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#external#
  1330. Hashing function used to (re)build the proposal id from the proposal details..
  1331. [.contract-item]
  1332. [[IGovernor-state-uint256-]]
  1333. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#external#
  1334. Current state of a proposal, following Compound's convention
  1335. [.contract-item]
  1336. [[IGovernor-proposalThreshold--]]
  1337. ==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#external#
  1338. The number of votes required in order for a voter to become a proposer.
  1339. [.contract-item]
  1340. [[IGovernor-proposalSnapshot-uint256-]]
  1341. ==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#external#
  1342. Timepoint used to retrieve user's votes and quorum. If using block number (as per Compound's Comp), the
  1343. snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the
  1344. following block.
  1345. [.contract-item]
  1346. [[IGovernor-proposalDeadline-uint256-]]
  1347. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#external#
  1348. Timepoint at which votes close. If using block number, votes close at the end of this block, so it is
  1349. possible to cast a vote during this block.
  1350. [.contract-item]
  1351. [[IGovernor-proposalProposer-uint256-]]
  1352. ==== `[.contract-item-name]#++proposalProposer++#++(uint256 proposalId) → address++` [.item-kind]#external#
  1353. The account that created a proposal.
  1354. [.contract-item]
  1355. [[IGovernor-proposalEta-uint256-]]
  1356. ==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#external#
  1357. The time when a queued proposal becomes executable ("ETA"). Unlike {proposalSnapshot} and
  1358. {proposalDeadline}, this doesn't use the governor clock, and instead relies on the executor's clock which may be
  1359. different. In most cases this will be a timestamp.
  1360. [.contract-item]
  1361. [[IGovernor-proposalNeedsQueuing-uint256-]]
  1362. ==== `[.contract-item-name]#++proposalNeedsQueuing++#++(uint256 proposalId) → bool++` [.item-kind]#external#
  1363. Whether a proposal needs to be queued before execution.
  1364. [.contract-item]
  1365. [[IGovernor-votingDelay--]]
  1366. ==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#external#
  1367. Delay, between the proposal is created and the vote starts. The unit this duration is expressed in depends
  1368. on the clock (see EIP-6372) this contract uses.
  1369. This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a
  1370. proposal starts.
  1371. NOTE: While this interface returns a uint256, timepoints are stored as uint48 following the ERC-6372 clock type.
  1372. Consequently this value must fit in a uint48 (when added to the current clock). See {IERC6372-clock}.
  1373. [.contract-item]
  1374. [[IGovernor-votingPeriod--]]
  1375. ==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#external#
  1376. Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock
  1377. (see EIP-6372) this contract uses.
  1378. NOTE: The {votingDelay} can delay the start of the vote. This must be considered when setting the voting
  1379. duration compared to the voting delay.
  1380. NOTE: This value is stored when the proposal is submitted so that possible changes to the value do not affect
  1381. proposals that have already been submitted. The type used to save it is a uint32. Consequently, while this
  1382. interface returns a uint256, the value it returns should fit in a uint32.
  1383. [.contract-item]
  1384. [[IGovernor-quorum-uint256-]]
  1385. ==== `[.contract-item-name]#++quorum++#++(uint256 timepoint) → uint256++` [.item-kind]#external#
  1386. Minimum number of cast voted required for a proposal to be successful.
  1387. NOTE: The `timepoint` parameter corresponds to the snapshot used for counting vote. This allows to scale the
  1388. quorum depending on values such as the totalSupply of a token at this timepoint (see {ERC20Votes}).
  1389. [.contract-item]
  1390. [[IGovernor-getVotes-address-uint256-]]
  1391. ==== `[.contract-item-name]#++getVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#external#
  1392. Voting power of an `account` at a specific `timepoint`.
  1393. Note: this can be implemented in a number of ways, for example by reading the delegated balance from one (or
  1394. multiple), {ERC20Votes} tokens.
  1395. [.contract-item]
  1396. [[IGovernor-getVotesWithParams-address-uint256-bytes-]]
  1397. ==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#external#
  1398. Voting power of an `account` at a specific `timepoint` given additional encoded parameters.
  1399. [.contract-item]
  1400. [[IGovernor-hasVoted-uint256-address-]]
  1401. ==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#external#
  1402. Returns whether `account` has cast a vote on `proposalId`.
  1403. [.contract-item]
  1404. [[IGovernor-propose-address---uint256---bytes---string-]]
  1405. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256 proposalId++` [.item-kind]#external#
  1406. Create a new proposal. Vote start after a delay specified by {IGovernor-votingDelay} and lasts for a
  1407. duration specified by {IGovernor-votingPeriod}.
  1408. Emits a {ProposalCreated} event.
  1409. [.contract-item]
  1410. [[IGovernor-queue-address---uint256---bytes---bytes32-]]
  1411. ==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#external#
  1412. Queue a proposal. Some governors require this step to be performed before execution can happen. If queuing
  1413. is not necessary, this function may revert.
  1414. Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.
  1415. Emits a {ProposalQueued} event.
  1416. [.contract-item]
  1417. [[IGovernor-execute-address---uint256---bytes---bytes32-]]
  1418. ==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#external#
  1419. Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the
  1420. deadline to be reached. Depending on the governor it might also be required that the proposal was queued and
  1421. that some delay passed.
  1422. Emits a {ProposalExecuted} event.
  1423. NOTE: Some modules can modify the requirements for execution, for example by adding an additional timelock.
  1424. [.contract-item]
  1425. [[IGovernor-cancel-address---uint256---bytes---bytes32-]]
  1426. ==== `[.contract-item-name]#++cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#external#
  1427. Cancel a proposal. A proposal is cancellable by the proposer, but only while it is Pending state, i.e.
  1428. before the vote starts.
  1429. Emits a {ProposalCanceled} event.
  1430. [.contract-item]
  1431. [[IGovernor-castVote-uint256-uint8-]]
  1432. ==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256 balance++` [.item-kind]#external#
  1433. Cast a vote
  1434. Emits a {VoteCast} event.
  1435. [.contract-item]
  1436. [[IGovernor-castVoteWithReason-uint256-uint8-string-]]
  1437. ==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256 balance++` [.item-kind]#external#
  1438. Cast a vote with a reason
  1439. Emits a {VoteCast} event.
  1440. [.contract-item]
  1441. [[IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
  1442. ==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256 balance++` [.item-kind]#external#
  1443. Cast a vote with a reason and additional encoded parameters
  1444. Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
  1445. [.contract-item]
  1446. [[IGovernor-castVoteBySig-uint256-uint8-address-bytes-]]
  1447. ==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, address voter, bytes signature) → uint256 balance++` [.item-kind]#external#
  1448. Cast a vote using the voter's signature, including ERC-1271 signature support.
  1449. Emits a {VoteCast} event.
  1450. [.contract-item]
  1451. [[IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-]]
  1452. ==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, address voter, string reason, bytes params, bytes signature) → uint256 balance++` [.item-kind]#external#
  1453. Cast a vote with a reason and additional encoded parameters using the voter's signature,
  1454. including ERC-1271 signature support.
  1455. Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
  1456. [.contract-item]
  1457. [[IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-]]
  1458. ==== `[.contract-item-name]#++ProposalCreated++#++(uint256 proposalId, address proposer, address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, uint256 voteStart, uint256 voteEnd, string description)++` [.item-kind]#event#
  1459. Emitted when a proposal is created.
  1460. [.contract-item]
  1461. [[IGovernor-ProposalQueued-uint256-uint256-]]
  1462. ==== `[.contract-item-name]#++ProposalQueued++#++(uint256 proposalId, uint256 etaSeconds)++` [.item-kind]#event#
  1463. Emitted when a proposal is queued.
  1464. [.contract-item]
  1465. [[IGovernor-ProposalExecuted-uint256-]]
  1466. ==== `[.contract-item-name]#++ProposalExecuted++#++(uint256 proposalId)++` [.item-kind]#event#
  1467. Emitted when a proposal is executed.
  1468. [.contract-item]
  1469. [[IGovernor-ProposalCanceled-uint256-]]
  1470. ==== `[.contract-item-name]#++ProposalCanceled++#++(uint256 proposalId)++` [.item-kind]#event#
  1471. Emitted when a proposal is canceled.
  1472. [.contract-item]
  1473. [[IGovernor-VoteCast-address-uint256-uint8-uint256-string-]]
  1474. ==== `[.contract-item-name]#++VoteCast++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason)++` [.item-kind]#event#
  1475. Emitted when a vote is cast without params.
  1476. Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.
  1477. [.contract-item]
  1478. [[IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-]]
  1479. ==== `[.contract-item-name]#++VoteCastWithParams++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)++` [.item-kind]#event#
  1480. Emitted when a vote is cast with params.
  1481. Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.
  1482. `params` are additional encoded parameters. Their interpepretation also depends on the voting module used.
  1483. [.contract-item]
  1484. [[IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-]]
  1485. ==== `[.contract-item-name]#++GovernorInvalidProposalLength++#++(uint256 targets, uint256 calldatas, uint256 values)++` [.item-kind]#error#
  1486. Empty proposal or a mismatch between the parameters length for a proposal call.
  1487. [.contract-item]
  1488. [[IGovernor-GovernorAlreadyCastVote-address-]]
  1489. ==== `[.contract-item-name]#++GovernorAlreadyCastVote++#++(address voter)++` [.item-kind]#error#
  1490. The vote was already cast.
  1491. [.contract-item]
  1492. [[IGovernor-GovernorDisabledDeposit--]]
  1493. ==== `[.contract-item-name]#++GovernorDisabledDeposit++#++()++` [.item-kind]#error#
  1494. Token deposits are disabled in this contract.
  1495. [.contract-item]
  1496. [[IGovernor-GovernorOnlyProposer-address-]]
  1497. ==== `[.contract-item-name]#++GovernorOnlyProposer++#++(address account)++` [.item-kind]#error#
  1498. The `account` is not a proposer.
  1499. [.contract-item]
  1500. [[IGovernor-GovernorOnlyExecutor-address-]]
  1501. ==== `[.contract-item-name]#++GovernorOnlyExecutor++#++(address account)++` [.item-kind]#error#
  1502. The `account` is not the governance executor.
  1503. [.contract-item]
  1504. [[IGovernor-GovernorNonexistentProposal-uint256-]]
  1505. ==== `[.contract-item-name]#++GovernorNonexistentProposal++#++(uint256 proposalId)++` [.item-kind]#error#
  1506. The `proposalId` doesn't exist.
  1507. [.contract-item]
  1508. [[IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-]]
  1509. ==== `[.contract-item-name]#++GovernorUnexpectedProposalState++#++(uint256 proposalId, enum IGovernor.ProposalState current, bytes32 expectedStates)++` [.item-kind]#error#
  1510. The current state of a proposal is not the required for performing an operation.
  1511. The `expectedStates` is a bitmap with the bits enabled for each ProposalState enum position
  1512. counting from right to left.
  1513. NOTE: If `expectedState` is `bytes32(0)`, the proposal is expected to not be in any state (i.e. not exist).
  1514. This is the case when a proposal that is expected to be unset is already initiated (the proposal is duplicated).
  1515. See {Governor-_encodeStateBitmap}.
  1516. [.contract-item]
  1517. [[IGovernor-GovernorInvalidVotingPeriod-uint256-]]
  1518. ==== `[.contract-item-name]#++GovernorInvalidVotingPeriod++#++(uint256 votingPeriod)++` [.item-kind]#error#
  1519. The voting period set is not a valid period.
  1520. [.contract-item]
  1521. [[IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-]]
  1522. ==== `[.contract-item-name]#++GovernorInsufficientProposerVotes++#++(address proposer, uint256 votes, uint256 threshold)++` [.item-kind]#error#
  1523. The `proposer` does not have the required votes to create a proposal.
  1524. [.contract-item]
  1525. [[IGovernor-GovernorRestrictedProposer-address-]]
  1526. ==== `[.contract-item-name]#++GovernorRestrictedProposer++#++(address proposer)++` [.item-kind]#error#
  1527. The `proposer` is not allowed to create a proposal.
  1528. [.contract-item]
  1529. [[IGovernor-GovernorInvalidVoteType--]]
  1530. ==== `[.contract-item-name]#++GovernorInvalidVoteType++#++()++` [.item-kind]#error#
  1531. The vote type used is not valid for the corresponding counting module.
  1532. [.contract-item]
  1533. [[IGovernor-GovernorQueueNotImplemented--]]
  1534. ==== `[.contract-item-name]#++GovernorQueueNotImplemented++#++()++` [.item-kind]#error#
  1535. Queue operation is not implemented for this governor. Execute should be called directly.
  1536. [.contract-item]
  1537. [[IGovernor-GovernorNotQueuedProposal-uint256-]]
  1538. ==== `[.contract-item-name]#++GovernorNotQueuedProposal++#++(uint256 proposalId)++` [.item-kind]#error#
  1539. The proposal hasn't been queued yet.
  1540. [.contract-item]
  1541. [[IGovernor-GovernorAlreadyQueuedProposal-uint256-]]
  1542. ==== `[.contract-item-name]#++GovernorAlreadyQueuedProposal++#++(uint256 proposalId)++` [.item-kind]#error#
  1543. The proposal has already been queued.
  1544. [.contract-item]
  1545. [[IGovernor-GovernorInvalidSignature-address-]]
  1546. ==== `[.contract-item-name]#++GovernorInvalidSignature++#++(address voter)++` [.item-kind]#error#
  1547. The provided signature is not valid for the expected `voter`.
  1548. If the `voter` is a contract, the signature is not valid using {IERC1271-isValidSignature}.
  1549. :BALLOT_TYPEHASH: pass:normal[xref:#Governor-BALLOT_TYPEHASH-bytes32[`++BALLOT_TYPEHASH++`]]
  1550. :EXTENDED_BALLOT_TYPEHASH: pass:normal[xref:#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32[`++EXTENDED_BALLOT_TYPEHASH++`]]
  1551. :ProposalCore: pass:normal[xref:#Governor-ProposalCore[`++ProposalCore++`]]
  1552. :onlyGovernance: pass:normal[xref:#Governor-onlyGovernance--[`++onlyGovernance++`]]
  1553. :constructor: pass:normal[xref:#Governor-constructor-string-[`++constructor++`]]
  1554. :receive: pass:normal[xref:#Governor-receive--[`++receive++`]]
  1555. :supportsInterface: pass:normal[xref:#Governor-supportsInterface-bytes4-[`++supportsInterface++`]]
  1556. :name: pass:normal[xref:#Governor-name--[`++name++`]]
  1557. :version: pass:normal[xref:#Governor-version--[`++version++`]]
  1558. :hashProposal: pass:normal[xref:#Governor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
  1559. :state: pass:normal[xref:#Governor-state-uint256-[`++state++`]]
  1560. :proposalThreshold: pass:normal[xref:#Governor-proposalThreshold--[`++proposalThreshold++`]]
  1561. :proposalSnapshot: pass:normal[xref:#Governor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
  1562. :proposalDeadline: pass:normal[xref:#Governor-proposalDeadline-uint256-[`++proposalDeadline++`]]
  1563. :proposalProposer: pass:normal[xref:#Governor-proposalProposer-uint256-[`++proposalProposer++`]]
  1564. :proposalEta: pass:normal[xref:#Governor-proposalEta-uint256-[`++proposalEta++`]]
  1565. :proposalNeedsQueuing: pass:normal[xref:#Governor-proposalNeedsQueuing-uint256-[`++proposalNeedsQueuing++`]]
  1566. :_checkGovernance: pass:normal[xref:#Governor-_checkGovernance--[`++_checkGovernance++`]]
  1567. :_quorumReached: pass:normal[xref:#Governor-_quorumReached-uint256-[`++_quorumReached++`]]
  1568. :_voteSucceeded: pass:normal[xref:#Governor-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
  1569. :_getVotes: pass:normal[xref:#Governor-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
  1570. :_countVote: pass:normal[xref:#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
  1571. :_defaultParams: pass:normal[xref:#Governor-_defaultParams--[`++_defaultParams++`]]
  1572. :propose: pass:normal[xref:#Governor-propose-address---uint256---bytes---string-[`++propose++`]]
  1573. :_propose: pass:normal[xref:#Governor-_propose-address---uint256---bytes---string-address-[`++_propose++`]]
  1574. :queue: pass:normal[xref:#Governor-queue-address---uint256---bytes---bytes32-[`++queue++`]]
  1575. :_queueOperations: pass:normal[xref:#Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-[`++_queueOperations++`]]
  1576. :execute: pass:normal[xref:#Governor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
  1577. :_executeOperations: pass:normal[xref:#Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-[`++_executeOperations++`]]
  1578. :cancel: pass:normal[xref:#Governor-cancel-address---uint256---bytes---bytes32-[`++cancel++`]]
  1579. :_cancel: pass:normal[xref:#Governor-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  1580. :getVotes: pass:normal[xref:#Governor-getVotes-address-uint256-[`++getVotes++`]]
  1581. :getVotesWithParams: pass:normal[xref:#Governor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
  1582. :castVote: pass:normal[xref:#Governor-castVote-uint256-uint8-[`++castVote++`]]
  1583. :castVoteWithReason: pass:normal[xref:#Governor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
  1584. :castVoteWithReasonAndParams: pass:normal[xref:#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
  1585. :castVoteBySig: pass:normal[xref:#Governor-castVoteBySig-uint256-uint8-address-bytes-[`++castVoteBySig++`]]
  1586. :castVoteWithReasonAndParamsBySig: pass:normal[xref:#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-[`++castVoteWithReasonAndParamsBySig++`]]
  1587. :_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-[`++_castVote++`]]
  1588. :_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
  1589. :relay: pass:normal[xref:#Governor-relay-address-uint256-bytes-[`++relay++`]]
  1590. :_executor: pass:normal[xref:#Governor-_executor--[`++_executor++`]]
  1591. :onERC721Received: pass:normal[xref:#Governor-onERC721Received-address-address-uint256-bytes-[`++onERC721Received++`]]
  1592. :onERC1155Received: pass:normal[xref:#Governor-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
  1593. :onERC1155BatchReceived: pass:normal[xref:#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
  1594. :_encodeStateBitmap: pass:normal[xref:#Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-[`++_encodeStateBitmap++`]]
  1595. :_isValidDescriptionForProposer: pass:normal[xref:#Governor-_isValidDescriptionForProposer-address-string-[`++_isValidDescriptionForProposer++`]]
  1596. :clock: pass:normal[xref:#Governor-clock--[`++clock++`]]
  1597. :CLOCK_MODE: pass:normal[xref:#Governor-CLOCK_MODE--[`++CLOCK_MODE++`]]
  1598. :votingDelay: pass:normal[xref:#Governor-votingDelay--[`++votingDelay++`]]
  1599. :votingPeriod: pass:normal[xref:#Governor-votingPeriod--[`++votingPeriod++`]]
  1600. :quorum: pass:normal[xref:#Governor-quorum-uint256-[`++quorum++`]]
  1601. [.contract]
  1602. [[Governor]]
  1603. === `++Governor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/Governor.sol[{github-icon},role=heading-link]
  1604. [.hljs-theme-light.nopadding]
  1605. ```solidity
  1606. import "@openzeppelin/contracts/governance/Governor.sol";
  1607. ```
  1608. Core of the governance system, designed to be extended through various modules.
  1609. This contract is abstract and requires several functions to be implemented in various modules:
  1610. - A counting module must implement {quorum}, {_quorumReached}, {_voteSucceeded} and {_countVote}
  1611. - A voting module must implement {_getVotes}
  1612. - Additionally, {votingPeriod} must also be implemented
  1613. [.contract-index]
  1614. .Modifiers
  1615. --
  1616. * {xref-Governor-onlyGovernance--}[`++onlyGovernance()++`]
  1617. --
  1618. [.contract-index]
  1619. .Functions
  1620. --
  1621. * {xref-Governor-constructor-string-}[`++constructor(name_)++`]
  1622. * {xref-Governor-receive--}[`++receive()++`]
  1623. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  1624. * {xref-Governor-name--}[`++name()++`]
  1625. * {xref-Governor-version--}[`++version()++`]
  1626. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  1627. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  1628. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  1629. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  1630. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  1631. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  1632. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  1633. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  1634. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  1635. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  1636. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  1637. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  1638. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  1639. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  1640. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  1641. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  1642. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  1643. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  1644. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  1645. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  1646. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  1647. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  1648. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  1649. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  1650. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  1651. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  1652. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  1653. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  1654. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  1655. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  1656. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  1657. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  1658. * {xref-Governor-_executor--}[`++_executor()++`]
  1659. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  1660. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  1661. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  1662. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  1663. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  1664. * {xref-Governor-clock--}[`++clock()++`]
  1665. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  1666. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  1667. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  1668. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  1669. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  1670. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  1671. [.contract-subindex-inherited]
  1672. .IERC1155Receiver
  1673. [.contract-subindex-inherited]
  1674. .IERC721Receiver
  1675. [.contract-subindex-inherited]
  1676. .IGovernor
  1677. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  1678. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  1679. [.contract-subindex-inherited]
  1680. .IERC6372
  1681. [.contract-subindex-inherited]
  1682. .Nonces
  1683. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  1684. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  1685. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  1686. [.contract-subindex-inherited]
  1687. .EIP712
  1688. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  1689. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  1690. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  1691. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  1692. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  1693. [.contract-subindex-inherited]
  1694. .IERC5267
  1695. [.contract-subindex-inherited]
  1696. .ERC165
  1697. [.contract-subindex-inherited]
  1698. .IERC165
  1699. --
  1700. [.contract-index]
  1701. .Events
  1702. --
  1703. [.contract-subindex-inherited]
  1704. .IERC1155Receiver
  1705. [.contract-subindex-inherited]
  1706. .IERC721Receiver
  1707. [.contract-subindex-inherited]
  1708. .IGovernor
  1709. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  1710. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  1711. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  1712. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  1713. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  1714. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  1715. [.contract-subindex-inherited]
  1716. .IERC6372
  1717. [.contract-subindex-inherited]
  1718. .Nonces
  1719. [.contract-subindex-inherited]
  1720. .EIP712
  1721. [.contract-subindex-inherited]
  1722. .IERC5267
  1723. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  1724. [.contract-subindex-inherited]
  1725. .ERC165
  1726. [.contract-subindex-inherited]
  1727. .IERC165
  1728. --
  1729. [.contract-index]
  1730. .Errors
  1731. --
  1732. [.contract-subindex-inherited]
  1733. .IERC1155Receiver
  1734. [.contract-subindex-inherited]
  1735. .IERC721Receiver
  1736. [.contract-subindex-inherited]
  1737. .IGovernor
  1738. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  1739. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  1740. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  1741. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  1742. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  1743. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  1744. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  1745. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  1746. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  1747. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  1748. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  1749. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  1750. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  1751. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  1752. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  1753. [.contract-subindex-inherited]
  1754. .IERC6372
  1755. [.contract-subindex-inherited]
  1756. .Nonces
  1757. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  1758. [.contract-subindex-inherited]
  1759. .EIP712
  1760. [.contract-subindex-inherited]
  1761. .IERC5267
  1762. [.contract-subindex-inherited]
  1763. .ERC165
  1764. [.contract-subindex-inherited]
  1765. .IERC165
  1766. --
  1767. [.contract-item]
  1768. [[Governor-onlyGovernance--]]
  1769. ==== `[.contract-item-name]#++onlyGovernance++#++()++` [.item-kind]#modifier#
  1770. Restricts a function so it can only be executed through governance proposals. For example, governance
  1771. parameter setters in {GovernorSettings} are protected using this modifier.
  1772. The governance executing address may be different from the Governor's own address, for example it could be a
  1773. timelock. This can be customized by modules by overriding {_executor}. The executor is only able to invoke these
  1774. functions during the execution of the governor's {execute} function, and not under any other circumstances. Thus,
  1775. for example, additional timelock proposers are not able to change governance parameters without going through the
  1776. governance protocol (since v4.6).
  1777. [.contract-item]
  1778. [[Governor-constructor-string-]]
  1779. ==== `[.contract-item-name]#++constructor++#++(string name_)++` [.item-kind]#internal#
  1780. Sets the value for {name} and {version}
  1781. [.contract-item]
  1782. [[Governor-receive--]]
  1783. ==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#
  1784. Function to receive ETH that will be handled by the governor (disabled if executor is a third party contract)
  1785. [.contract-item]
  1786. [[Governor-supportsInterface-bytes4-]]
  1787. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  1788. See {IERC165-supportsInterface}.
  1789. [.contract-item]
  1790. [[Governor-name--]]
  1791. ==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#public#
  1792. See {IGovernor-name}.
  1793. [.contract-item]
  1794. [[Governor-version--]]
  1795. ==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#public#
  1796. See {IGovernor-version}.
  1797. [.contract-item]
  1798. [[Governor-hashProposal-address---uint256---bytes---bytes32-]]
  1799. ==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1800. See {IGovernor-hashProposal}.
  1801. The proposal id is produced by hashing the ABI encoded `targets` array, the `values` array, the `calldatas` array
  1802. and the descriptionHash (bytes32 which itself is the keccak256 hash of the description string). This proposal id
  1803. can be produced from the proposal data which is part of the {ProposalCreated} event. It can even be computed in
  1804. advance, before the proposal is submitted.
  1805. Note that the chainId and the governor address are not part of the proposal id computation. Consequently, the
  1806. same proposal (with same operation and same description) will have the same id if submitted on multiple governors
  1807. across multiple networks. This also means that in order to execute the same operation twice (on the same
  1808. governor) the proposer will have to change the description in order to avoid proposal id conflicts.
  1809. [.contract-item]
  1810. [[Governor-state-uint256-]]
  1811. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  1812. See {IGovernor-state}.
  1813. [.contract-item]
  1814. [[Governor-proposalThreshold--]]
  1815. ==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#
  1816. See {IGovernor-proposalThreshold}.
  1817. [.contract-item]
  1818. [[Governor-proposalSnapshot-uint256-]]
  1819. ==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1820. See {IGovernor-proposalSnapshot}.
  1821. [.contract-item]
  1822. [[Governor-proposalDeadline-uint256-]]
  1823. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1824. See {IGovernor-proposalDeadline}.
  1825. [.contract-item]
  1826. [[Governor-proposalProposer-uint256-]]
  1827. ==== `[.contract-item-name]#++proposalProposer++#++(uint256 proposalId) → address++` [.item-kind]#public#
  1828. See {IGovernor-proposalProposer}.
  1829. [.contract-item]
  1830. [[Governor-proposalEta-uint256-]]
  1831. ==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  1832. See {IGovernor-proposalEta}.
  1833. [.contract-item]
  1834. [[Governor-proposalNeedsQueuing-uint256-]]
  1835. ==== `[.contract-item-name]#++proposalNeedsQueuing++#++(uint256) → bool++` [.item-kind]#public#
  1836. See {IGovernor-proposalNeedsQueuing}.
  1837. [.contract-item]
  1838. [[Governor-_checkGovernance--]]
  1839. ==== `[.contract-item-name]#++_checkGovernance++#++()++` [.item-kind]#internal#
  1840. Reverts if the `msg.sender` is not the executor. In case the executor is not this contract
  1841. itself, the function reverts if `msg.data` is not whitelisted as a result of an {execute}
  1842. operation. See {onlyGovernance}.
  1843. [.contract-item]
  1844. [[Governor-_quorumReached-uint256-]]
  1845. ==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1846. Amount of votes already cast passes the threshold limit.
  1847. [.contract-item]
  1848. [[Governor-_voteSucceeded-uint256-]]
  1849. ==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  1850. Is the proposal successful or not.
  1851. [.contract-item]
  1852. [[Governor-_getVotes-address-uint256-bytes-]]
  1853. ==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#internal#
  1854. Get the voting weight of `account` at a specific `timepoint`, for a vote as described by `params`.
  1855. [.contract-item]
  1856. [[Governor-_countVote-uint256-address-uint8-uint256-bytes-]]
  1857. ==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes params)++` [.item-kind]#internal#
  1858. Register a vote for `proposalId` by `account` with a given `support`, voting `weight` and voting `params`.
  1859. Note: Support is generic and can represent various things depending on the voting system used.
  1860. [.contract-item]
  1861. [[Governor-_defaultParams--]]
  1862. ==== `[.contract-item-name]#++_defaultParams++#++() → bytes++` [.item-kind]#internal#
  1863. Default additional encoded parameters used by castVote methods that don't include them
  1864. Note: Should be overridden by specific implementations to use an appropriate value, the
  1865. meaning of the additional params, in the context of that implementation
  1866. [.contract-item]
  1867. [[Governor-propose-address---uint256---bytes---string-]]
  1868. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  1869. See {IGovernor-propose}. This function has opt-in frontrunning protection, described in {_isValidDescriptionForProposer}.
  1870. [.contract-item]
  1871. [[Governor-_propose-address---uint256---bytes---string-address-]]
  1872. ==== `[.contract-item-name]#++_propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description, address proposer) → uint256 proposalId++` [.item-kind]#internal#
  1873. Internal propose mechanism. Can be overridden to add more logic on proposal creation.
  1874. Emits a {IGovernor-ProposalCreated} event.
  1875. [.contract-item]
  1876. [[Governor-queue-address---uint256---bytes---bytes32-]]
  1877. ==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1878. See {IGovernor-queue}.
  1879. [.contract-item]
  1880. [[Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-]]
  1881. ==== `[.contract-item-name]#++_queueOperations++#++(uint256, address[], uint256[], bytes[], bytes32) → uint48++` [.item-kind]#internal#
  1882. Internal queuing mechanism. Can be overridden (without a super call) to modify the way queuing is
  1883. performed (for example adding a vault/timelock).
  1884. This is empty by default, and must be overridden to implement queuing.
  1885. This function returns a timestamp that describes the expected ETA for execution. If the returned value is 0
  1886. (which is the default value), the core will consider queueing did not succeed, and the public {queue} function
  1887. will revert.
  1888. NOTE: Calling this function directly will NOT check the current state of the proposal, or emit the
  1889. `ProposalQueued` event. Queuing a proposal should be done using {queue}.
  1890. [.contract-item]
  1891. [[Governor-execute-address---uint256---bytes---bytes32-]]
  1892. ==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1893. See {IGovernor-execute}.
  1894. [.contract-item]
  1895. [[Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-]]
  1896. ==== `[.contract-item-name]#++_executeOperations++#++(uint256, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  1897. Internal execution mechanism. Can be overridden (without a super call) to modify the way execution is
  1898. performed (for example adding a vault/timelock).
  1899. NOTE: Calling this function directly will NOT check the current state of the proposal, set the executed flag to
  1900. true or emit the `ProposalExecuted` event. Executing a proposal should be done using {execute} or {_execute}.
  1901. [.contract-item]
  1902. [[Governor-cancel-address---uint256---bytes---bytes32-]]
  1903. ==== `[.contract-item-name]#++cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#
  1904. See {IGovernor-cancel}.
  1905. [.contract-item]
  1906. [[Governor-_cancel-address---uint256---bytes---bytes32-]]
  1907. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  1908. Internal cancel mechanism with minimal restrictions. A proposal can be cancelled in any state other than
  1909. Canceled, Expired, or Executed. Once cancelled a proposal can't be re-submitted.
  1910. Emits a {IGovernor-ProposalCanceled} event.
  1911. [.contract-item]
  1912. [[Governor-getVotes-address-uint256-]]
  1913. ==== `[.contract-item-name]#++getVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#public#
  1914. See {IGovernor-getVotes}.
  1915. [.contract-item]
  1916. [[Governor-getVotesWithParams-address-uint256-bytes-]]
  1917. ==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#public#
  1918. See {IGovernor-getVotesWithParams}.
  1919. [.contract-item]
  1920. [[Governor-castVote-uint256-uint8-]]
  1921. ==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256++` [.item-kind]#public#
  1922. See {IGovernor-castVote}.
  1923. [.contract-item]
  1924. [[Governor-castVoteWithReason-uint256-uint8-string-]]
  1925. ==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256++` [.item-kind]#public#
  1926. See {IGovernor-castVoteWithReason}.
  1927. [.contract-item]
  1928. [[Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
  1929. ==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#public#
  1930. See {IGovernor-castVoteWithReasonAndParams}.
  1931. [.contract-item]
  1932. [[Governor-castVoteBySig-uint256-uint8-address-bytes-]]
  1933. ==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, address voter, bytes signature) → uint256++` [.item-kind]#public#
  1934. See {IGovernor-castVoteBySig}.
  1935. [.contract-item]
  1936. [[Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-]]
  1937. ==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, address voter, string reason, bytes params, bytes signature) → uint256++` [.item-kind]#public#
  1938. See {IGovernor-castVoteWithReasonAndParamsBySig}.
  1939. [.contract-item]
  1940. [[Governor-_castVote-uint256-address-uint8-string-]]
  1941. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason) → uint256++` [.item-kind]#internal#
  1942. Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
  1943. voting weight using {IGovernor-getVotes} and call the {_countVote} internal function. Uses the _defaultParams().
  1944. Emits a {IGovernor-VoteCast} event.
  1945. [.contract-item]
  1946. [[Governor-_castVote-uint256-address-uint8-string-bytes-]]
  1947. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#
  1948. Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
  1949. voting weight using {IGovernor-getVotes} and call the {_countVote} internal function.
  1950. Emits a {IGovernor-VoteCast} event.
  1951. [.contract-item]
  1952. [[Governor-relay-address-uint256-bytes-]]
  1953. ==== `[.contract-item-name]#++relay++#++(address target, uint256 value, bytes data)++` [.item-kind]#external#
  1954. Relays a transaction or function call to an arbitrary target. In cases where the governance executor
  1955. is some contract other than the governor itself, like when using a timelock, this function can be invoked
  1956. in a governance proposal to recover tokens or Ether that was sent to the governor contract by mistake.
  1957. Note that if the executor is simply the governor itself, use of `relay` is redundant.
  1958. [.contract-item]
  1959. [[Governor-_executor--]]
  1960. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  1961. Address through which the governor executes action. Will be overloaded by module that execute actions
  1962. through another contract such as a timelock.
  1963. [.contract-item]
  1964. [[Governor-onERC721Received-address-address-uint256-bytes-]]
  1965. ==== `[.contract-item-name]#++onERC721Received++#++(address, address, uint256, bytes) → bytes4++` [.item-kind]#public#
  1966. See {IERC721Receiver-onERC721Received}.
  1967. Receiving tokens is disabled if the governance executor is other than the governor itself (eg. when using with a timelock).
  1968. [.contract-item]
  1969. [[Governor-onERC1155Received-address-address-uint256-uint256-bytes-]]
  1970. ==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#
  1971. See {IERC1155Receiver-onERC1155Received}.
  1972. Receiving tokens is disabled if the governance executor is other than the governor itself (eg. when using with a timelock).
  1973. [.contract-item]
  1974. [[Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
  1975. ==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#
  1976. See {IERC1155Receiver-onERC1155BatchReceived}.
  1977. Receiving tokens is disabled if the governance executor is other than the governor itself (eg. when using with a timelock).
  1978. [.contract-item]
  1979. [[Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-]]
  1980. ==== `[.contract-item-name]#++_encodeStateBitmap++#++(enum IGovernor.ProposalState proposalState) → bytes32++` [.item-kind]#internal#
  1981. Encodes a `ProposalState` into a `bytes32` representation where each bit enabled corresponds to
  1982. the underlying position in the `ProposalState` enum. For example:
  1983. 0x000...10000
  1984. ^^^^^^------ ...
  1985. ^----- Succeeded
  1986. ^---- Defeated
  1987. ^--- Canceled
  1988. ^-- Active
  1989. ^- Pending
  1990. [.contract-item]
  1991. [[Governor-_isValidDescriptionForProposer-address-string-]]
  1992. ==== `[.contract-item-name]#++_isValidDescriptionForProposer++#++(address proposer, string description) → bool++` [.item-kind]#internal#
  1993. [.contract-item]
  1994. [[Governor-clock--]]
  1995. ==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#
  1996. Clock used for flagging checkpoints. Can be overridden to implement timestamp based checkpoints (and voting).
  1997. [.contract-item]
  1998. [[Governor-CLOCK_MODE--]]
  1999. ==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#
  2000. Description of the clock
  2001. [.contract-item]
  2002. [[Governor-votingDelay--]]
  2003. ==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#
  2004. Delay, between the proposal is created and the vote starts. The unit this duration is expressed in depends
  2005. on the clock (see EIP-6372) this contract uses.
  2006. This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a
  2007. proposal starts.
  2008. NOTE: While this interface returns a uint256, timepoints are stored as uint48 following the ERC-6372 clock type.
  2009. Consequently this value must fit in a uint48 (when added to the current clock). See {IERC6372-clock}.
  2010. [.contract-item]
  2011. [[Governor-votingPeriod--]]
  2012. ==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#
  2013. Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock
  2014. (see EIP-6372) this contract uses.
  2015. NOTE: The {votingDelay} can delay the start of the vote. This must be considered when setting the voting
  2016. duration compared to the voting delay.
  2017. NOTE: This value is stored when the proposal is submitted so that possible changes to the value do not affect
  2018. proposals that have already been submitted. The type used to save it is a uint32. Consequently, while this
  2019. interface returns a uint256, the value it returns should fit in a uint32.
  2020. [.contract-item]
  2021. [[Governor-quorum-uint256-]]
  2022. ==== `[.contract-item-name]#++quorum++#++(uint256 timepoint) → uint256++` [.item-kind]#public#
  2023. Minimum number of cast voted required for a proposal to be successful.
  2024. NOTE: The `timepoint` parameter corresponds to the snapshot used for counting vote. This allows to scale the
  2025. quorum depending on values such as the totalSupply of a token at this timepoint (see {ERC20Votes}).
  2026. [.contract-item]
  2027. [[Governor-BALLOT_TYPEHASH-bytes32]]
  2028. ==== `[.contract-item-name]#++BALLOT_TYPEHASH++#++() → bytes32++` [.item-kind]#public#
  2029. [.contract-item]
  2030. [[Governor-EXTENDED_BALLOT_TYPEHASH-bytes32]]
  2031. ==== `[.contract-item-name]#++EXTENDED_BALLOT_TYPEHASH++#++() → bytes32++` [.item-kind]#public#
  2032. === Modules
  2033. :VoteType: pass:normal[xref:#GovernorCountingSimple-VoteType[`++VoteType++`]]
  2034. :ProposalVote: pass:normal[xref:#GovernorCountingSimple-ProposalVote[`++ProposalVote++`]]
  2035. :COUNTING_MODE: pass:normal[xref:#GovernorCountingSimple-COUNTING_MODE--[`++COUNTING_MODE++`]]
  2036. :hasVoted: pass:normal[xref:#GovernorCountingSimple-hasVoted-uint256-address-[`++hasVoted++`]]
  2037. :proposalVotes: pass:normal[xref:#GovernorCountingSimple-proposalVotes-uint256-[`++proposalVotes++`]]
  2038. :_quorumReached: pass:normal[xref:#GovernorCountingSimple-_quorumReached-uint256-[`++_quorumReached++`]]
  2039. :_voteSucceeded: pass:normal[xref:#GovernorCountingSimple-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
  2040. :_countVote: pass:normal[xref:#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
  2041. [.contract]
  2042. [[GovernorCountingSimple]]
  2043. === `++GovernorCountingSimple++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorCountingSimple.sol[{github-icon},role=heading-link]
  2044. [.hljs-theme-light.nopadding]
  2045. ```solidity
  2046. import "@openzeppelin/contracts/governance/extensions/GovernorCountingSimple.sol";
  2047. ```
  2048. Extension of {Governor} for simple, 3 options, vote counting.
  2049. [.contract-index]
  2050. .Functions
  2051. --
  2052. * {xref-GovernorCountingSimple-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2053. * {xref-GovernorCountingSimple-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2054. * {xref-GovernorCountingSimple-proposalVotes-uint256-}[`++proposalVotes(proposalId)++`]
  2055. * {xref-GovernorCountingSimple-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2056. * {xref-GovernorCountingSimple-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2057. * {xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, )++`]
  2058. [.contract-subindex-inherited]
  2059. .Governor
  2060. * {xref-Governor-receive--}[`++receive()++`]
  2061. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2062. * {xref-Governor-name--}[`++name()++`]
  2063. * {xref-Governor-version--}[`++version()++`]
  2064. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2065. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2066. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2067. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2068. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2069. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  2070. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2071. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  2072. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  2073. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  2074. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2075. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2076. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  2077. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2078. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  2079. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2080. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  2081. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  2082. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2083. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  2084. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  2085. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2086. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2087. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2088. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  2089. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  2090. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2091. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2092. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2093. * {xref-Governor-_executor--}[`++_executor()++`]
  2094. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2095. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2096. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2097. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  2098. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  2099. * {xref-Governor-clock--}[`++clock()++`]
  2100. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  2101. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  2102. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  2103. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  2104. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  2105. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  2106. [.contract-subindex-inherited]
  2107. .IERC1155Receiver
  2108. [.contract-subindex-inherited]
  2109. .IERC721Receiver
  2110. [.contract-subindex-inherited]
  2111. .IGovernor
  2112. [.contract-subindex-inherited]
  2113. .IERC6372
  2114. [.contract-subindex-inherited]
  2115. .Nonces
  2116. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  2117. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  2118. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  2119. [.contract-subindex-inherited]
  2120. .EIP712
  2121. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2122. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2123. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  2124. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  2125. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  2126. [.contract-subindex-inherited]
  2127. .IERC5267
  2128. [.contract-subindex-inherited]
  2129. .ERC165
  2130. [.contract-subindex-inherited]
  2131. .IERC165
  2132. --
  2133. [.contract-index]
  2134. .Events
  2135. --
  2136. [.contract-subindex-inherited]
  2137. .Governor
  2138. [.contract-subindex-inherited]
  2139. .IERC1155Receiver
  2140. [.contract-subindex-inherited]
  2141. .IERC721Receiver
  2142. [.contract-subindex-inherited]
  2143. .IGovernor
  2144. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  2145. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  2146. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2147. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2148. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2149. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2150. [.contract-subindex-inherited]
  2151. .IERC6372
  2152. [.contract-subindex-inherited]
  2153. .Nonces
  2154. [.contract-subindex-inherited]
  2155. .EIP712
  2156. [.contract-subindex-inherited]
  2157. .IERC5267
  2158. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  2159. [.contract-subindex-inherited]
  2160. .ERC165
  2161. [.contract-subindex-inherited]
  2162. .IERC165
  2163. --
  2164. [.contract-index]
  2165. .Errors
  2166. --
  2167. [.contract-subindex-inherited]
  2168. .Governor
  2169. [.contract-subindex-inherited]
  2170. .IERC1155Receiver
  2171. [.contract-subindex-inherited]
  2172. .IERC721Receiver
  2173. [.contract-subindex-inherited]
  2174. .IGovernor
  2175. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  2176. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  2177. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  2178. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  2179. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  2180. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  2181. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  2182. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  2183. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  2184. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  2185. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  2186. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  2187. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  2188. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  2189. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  2190. [.contract-subindex-inherited]
  2191. .IERC6372
  2192. [.contract-subindex-inherited]
  2193. .Nonces
  2194. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  2195. [.contract-subindex-inherited]
  2196. .EIP712
  2197. [.contract-subindex-inherited]
  2198. .IERC5267
  2199. [.contract-subindex-inherited]
  2200. .ERC165
  2201. [.contract-subindex-inherited]
  2202. .IERC165
  2203. --
  2204. [.contract-item]
  2205. [[GovernorCountingSimple-COUNTING_MODE--]]
  2206. ==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#
  2207. See {IGovernor-COUNTING_MODE}.
  2208. [.contract-item]
  2209. [[GovernorCountingSimple-hasVoted-uint256-address-]]
  2210. ==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#
  2211. See {IGovernor-hasVoted}.
  2212. [.contract-item]
  2213. [[GovernorCountingSimple-proposalVotes-uint256-]]
  2214. ==== `[.contract-item-name]#++proposalVotes++#++(uint256 proposalId) → uint256 againstVotes, uint256 forVotes, uint256 abstainVotes++` [.item-kind]#public#
  2215. Accessor to the internal vote counts.
  2216. [.contract-item]
  2217. [[GovernorCountingSimple-_quorumReached-uint256-]]
  2218. ==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  2219. See {Governor-_quorumReached}.
  2220. [.contract-item]
  2221. [[GovernorCountingSimple-_voteSucceeded-uint256-]]
  2222. ==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#
  2223. See {Governor-_voteSucceeded}. In this module, the forVotes must be strictly over the againstVotes.
  2224. [.contract-item]
  2225. [[GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-]]
  2226. ==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes)++` [.item-kind]#internal#
  2227. See {Governor-_countVote}. In this module, the support follows the `VoteType` enum (from Governor Bravo).
  2228. :constructor: pass:normal[xref:#GovernorVotes-constructor-contract-IVotes-[`++constructor++`]]
  2229. :token: pass:normal[xref:#GovernorVotes-token--[`++token++`]]
  2230. :clock: pass:normal[xref:#GovernorVotes-clock--[`++clock++`]]
  2231. :CLOCK_MODE: pass:normal[xref:#GovernorVotes-CLOCK_MODE--[`++CLOCK_MODE++`]]
  2232. :_getVotes: pass:normal[xref:#GovernorVotes-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
  2233. [.contract]
  2234. [[GovernorVotes]]
  2235. === `++GovernorVotes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorVotes.sol[{github-icon},role=heading-link]
  2236. [.hljs-theme-light.nopadding]
  2237. ```solidity
  2238. import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol";
  2239. ```
  2240. Extension of {Governor} for voting weight extraction from an {ERC20Votes} token, or since v4.5 an {ERC721Votes}
  2241. token.
  2242. [.contract-index]
  2243. .Functions
  2244. --
  2245. * {xref-GovernorVotes-constructor-contract-IVotes-}[`++constructor(tokenAddress)++`]
  2246. * {xref-GovernorVotes-token--}[`++token()++`]
  2247. * {xref-GovernorVotes-clock--}[`++clock()++`]
  2248. * {xref-GovernorVotes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  2249. * {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, )++`]
  2250. [.contract-subindex-inherited]
  2251. .Governor
  2252. * {xref-Governor-receive--}[`++receive()++`]
  2253. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2254. * {xref-Governor-name--}[`++name()++`]
  2255. * {xref-Governor-version--}[`++version()++`]
  2256. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2257. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2258. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2259. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2260. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2261. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  2262. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2263. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  2264. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  2265. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2266. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2267. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2268. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2269. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2270. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  2271. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2272. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  2273. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2274. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  2275. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  2276. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2277. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  2278. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  2279. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2280. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2281. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2282. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  2283. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  2284. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2285. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2286. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2287. * {xref-Governor-_executor--}[`++_executor()++`]
  2288. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2289. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2290. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2291. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  2292. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  2293. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  2294. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  2295. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  2296. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  2297. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  2298. [.contract-subindex-inherited]
  2299. .IERC1155Receiver
  2300. [.contract-subindex-inherited]
  2301. .IERC721Receiver
  2302. [.contract-subindex-inherited]
  2303. .IGovernor
  2304. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2305. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2306. [.contract-subindex-inherited]
  2307. .IERC6372
  2308. [.contract-subindex-inherited]
  2309. .Nonces
  2310. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  2311. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  2312. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  2313. [.contract-subindex-inherited]
  2314. .EIP712
  2315. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2316. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2317. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  2318. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  2319. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  2320. [.contract-subindex-inherited]
  2321. .IERC5267
  2322. [.contract-subindex-inherited]
  2323. .ERC165
  2324. [.contract-subindex-inherited]
  2325. .IERC165
  2326. --
  2327. [.contract-index]
  2328. .Events
  2329. --
  2330. [.contract-subindex-inherited]
  2331. .Governor
  2332. [.contract-subindex-inherited]
  2333. .IERC1155Receiver
  2334. [.contract-subindex-inherited]
  2335. .IERC721Receiver
  2336. [.contract-subindex-inherited]
  2337. .IGovernor
  2338. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  2339. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  2340. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2341. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2342. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2343. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2344. [.contract-subindex-inherited]
  2345. .IERC6372
  2346. [.contract-subindex-inherited]
  2347. .Nonces
  2348. [.contract-subindex-inherited]
  2349. .EIP712
  2350. [.contract-subindex-inherited]
  2351. .IERC5267
  2352. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  2353. [.contract-subindex-inherited]
  2354. .ERC165
  2355. [.contract-subindex-inherited]
  2356. .IERC165
  2357. --
  2358. [.contract-index]
  2359. .Errors
  2360. --
  2361. [.contract-subindex-inherited]
  2362. .Governor
  2363. [.contract-subindex-inherited]
  2364. .IERC1155Receiver
  2365. [.contract-subindex-inherited]
  2366. .IERC721Receiver
  2367. [.contract-subindex-inherited]
  2368. .IGovernor
  2369. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  2370. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  2371. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  2372. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  2373. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  2374. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  2375. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  2376. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  2377. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  2378. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  2379. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  2380. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  2381. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  2382. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  2383. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  2384. [.contract-subindex-inherited]
  2385. .IERC6372
  2386. [.contract-subindex-inherited]
  2387. .Nonces
  2388. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  2389. [.contract-subindex-inherited]
  2390. .EIP712
  2391. [.contract-subindex-inherited]
  2392. .IERC5267
  2393. [.contract-subindex-inherited]
  2394. .ERC165
  2395. [.contract-subindex-inherited]
  2396. .IERC165
  2397. --
  2398. [.contract-item]
  2399. [[GovernorVotes-constructor-contract-IVotes-]]
  2400. ==== `[.contract-item-name]#++constructor++#++(contract IVotes tokenAddress)++` [.item-kind]#internal#
  2401. [.contract-item]
  2402. [[GovernorVotes-token--]]
  2403. ==== `[.contract-item-name]#++token++#++() → contract IERC5805++` [.item-kind]#public#
  2404. The token that voting power is sourced from.
  2405. [.contract-item]
  2406. [[GovernorVotes-clock--]]
  2407. ==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#
  2408. Clock (as specified in EIP-6372) is set to match the token's clock. Fallback to block numbers if the token
  2409. does not implement EIP-6372.
  2410. [.contract-item]
  2411. [[GovernorVotes-CLOCK_MODE--]]
  2412. ==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#
  2413. Machine-readable description of the clock as specified in EIP-6372.
  2414. [.contract-item]
  2415. [[GovernorVotes-_getVotes-address-uint256-bytes-]]
  2416. ==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 timepoint, bytes) → uint256++` [.item-kind]#internal#
  2417. :QuorumNumeratorUpdated: pass:normal[xref:#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-[`++QuorumNumeratorUpdated++`]]
  2418. :GovernorInvalidQuorumFraction: pass:normal[xref:#GovernorVotesQuorumFraction-GovernorInvalidQuorumFraction-uint256-uint256-[`++GovernorInvalidQuorumFraction++`]]
  2419. :constructor: pass:normal[xref:#GovernorVotesQuorumFraction-constructor-uint256-[`++constructor++`]]
  2420. :quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator--[`++quorumNumerator++`]]
  2421. :quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator-uint256-[`++quorumNumerator++`]]
  2422. :quorumDenominator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumDenominator--[`++quorumDenominator++`]]
  2423. :quorum: pass:normal[xref:#GovernorVotesQuorumFraction-quorum-uint256-[`++quorum++`]]
  2424. :updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-[`++updateQuorumNumerator++`]]
  2425. :_updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-[`++_updateQuorumNumerator++`]]
  2426. [.contract]
  2427. [[GovernorVotesQuorumFraction]]
  2428. === `++GovernorVotesQuorumFraction++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorVotesQuorumFraction.sol[{github-icon},role=heading-link]
  2429. [.hljs-theme-light.nopadding]
  2430. ```solidity
  2431. import "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";
  2432. ```
  2433. Extension of {Governor} for voting weight extraction from an {ERC20Votes} token and a quorum expressed as a
  2434. fraction of the total supply.
  2435. [.contract-index]
  2436. .Functions
  2437. --
  2438. * {xref-GovernorVotesQuorumFraction-constructor-uint256-}[`++constructor(quorumNumeratorValue)++`]
  2439. * {xref-GovernorVotesQuorumFraction-quorumNumerator--}[`++quorumNumerator()++`]
  2440. * {xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-}[`++quorumNumerator(timepoint)++`]
  2441. * {xref-GovernorVotesQuorumFraction-quorumDenominator--}[`++quorumDenominator()++`]
  2442. * {xref-GovernorVotesQuorumFraction-quorum-uint256-}[`++quorum(timepoint)++`]
  2443. * {xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-}[`++updateQuorumNumerator(newQuorumNumerator)++`]
  2444. * {xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-}[`++_updateQuorumNumerator(newQuorumNumerator)++`]
  2445. [.contract-subindex-inherited]
  2446. .GovernorVotes
  2447. * {xref-GovernorVotes-token--}[`++token()++`]
  2448. * {xref-GovernorVotes-clock--}[`++clock()++`]
  2449. * {xref-GovernorVotes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  2450. * {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, )++`]
  2451. [.contract-subindex-inherited]
  2452. .Governor
  2453. * {xref-Governor-receive--}[`++receive()++`]
  2454. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2455. * {xref-Governor-name--}[`++name()++`]
  2456. * {xref-Governor-version--}[`++version()++`]
  2457. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2458. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2459. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2460. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2461. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2462. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  2463. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2464. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  2465. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  2466. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2467. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2468. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2469. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2470. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2471. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  2472. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2473. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  2474. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2475. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  2476. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  2477. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2478. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  2479. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  2480. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2481. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2482. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2483. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  2484. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  2485. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2486. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2487. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2488. * {xref-Governor-_executor--}[`++_executor()++`]
  2489. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2490. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2491. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2492. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  2493. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  2494. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  2495. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  2496. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  2497. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  2498. [.contract-subindex-inherited]
  2499. .IERC1155Receiver
  2500. [.contract-subindex-inherited]
  2501. .IERC721Receiver
  2502. [.contract-subindex-inherited]
  2503. .IGovernor
  2504. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2505. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2506. [.contract-subindex-inherited]
  2507. .IERC6372
  2508. [.contract-subindex-inherited]
  2509. .Nonces
  2510. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  2511. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  2512. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  2513. [.contract-subindex-inherited]
  2514. .EIP712
  2515. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2516. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2517. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  2518. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  2519. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  2520. [.contract-subindex-inherited]
  2521. .IERC5267
  2522. [.contract-subindex-inherited]
  2523. .ERC165
  2524. [.contract-subindex-inherited]
  2525. .IERC165
  2526. --
  2527. [.contract-index]
  2528. .Events
  2529. --
  2530. * {xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-}[`++QuorumNumeratorUpdated(oldQuorumNumerator, newQuorumNumerator)++`]
  2531. [.contract-subindex-inherited]
  2532. .GovernorVotes
  2533. [.contract-subindex-inherited]
  2534. .Governor
  2535. [.contract-subindex-inherited]
  2536. .IERC1155Receiver
  2537. [.contract-subindex-inherited]
  2538. .IERC721Receiver
  2539. [.contract-subindex-inherited]
  2540. .IGovernor
  2541. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  2542. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  2543. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2544. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2545. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2546. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2547. [.contract-subindex-inherited]
  2548. .IERC6372
  2549. [.contract-subindex-inherited]
  2550. .Nonces
  2551. [.contract-subindex-inherited]
  2552. .EIP712
  2553. [.contract-subindex-inherited]
  2554. .IERC5267
  2555. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  2556. [.contract-subindex-inherited]
  2557. .ERC165
  2558. [.contract-subindex-inherited]
  2559. .IERC165
  2560. --
  2561. [.contract-index]
  2562. .Errors
  2563. --
  2564. * {xref-GovernorVotesQuorumFraction-GovernorInvalidQuorumFraction-uint256-uint256-}[`++GovernorInvalidQuorumFraction(quorumNumerator, quorumDenominator)++`]
  2565. [.contract-subindex-inherited]
  2566. .GovernorVotes
  2567. [.contract-subindex-inherited]
  2568. .Governor
  2569. [.contract-subindex-inherited]
  2570. .IERC1155Receiver
  2571. [.contract-subindex-inherited]
  2572. .IERC721Receiver
  2573. [.contract-subindex-inherited]
  2574. .IGovernor
  2575. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  2576. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  2577. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  2578. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  2579. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  2580. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  2581. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  2582. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  2583. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  2584. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  2585. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  2586. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  2587. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  2588. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  2589. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  2590. [.contract-subindex-inherited]
  2591. .IERC6372
  2592. [.contract-subindex-inherited]
  2593. .Nonces
  2594. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  2595. [.contract-subindex-inherited]
  2596. .EIP712
  2597. [.contract-subindex-inherited]
  2598. .IERC5267
  2599. [.contract-subindex-inherited]
  2600. .ERC165
  2601. [.contract-subindex-inherited]
  2602. .IERC165
  2603. --
  2604. [.contract-item]
  2605. [[GovernorVotesQuorumFraction-constructor-uint256-]]
  2606. ==== `[.contract-item-name]#++constructor++#++(uint256 quorumNumeratorValue)++` [.item-kind]#internal#
  2607. Initialize quorum as a fraction of the token's total supply.
  2608. The fraction is specified as `numerator / denominator`. By default the denominator is 100, so quorum is
  2609. specified as a percent: a numerator of 10 corresponds to quorum being 10% of total supply. The denominator can be
  2610. customized by overriding {quorumDenominator}.
  2611. [.contract-item]
  2612. [[GovernorVotesQuorumFraction-quorumNumerator--]]
  2613. ==== `[.contract-item-name]#++quorumNumerator++#++() → uint256++` [.item-kind]#public#
  2614. Returns the current quorum numerator. See {quorumDenominator}.
  2615. [.contract-item]
  2616. [[GovernorVotesQuorumFraction-quorumNumerator-uint256-]]
  2617. ==== `[.contract-item-name]#++quorumNumerator++#++(uint256 timepoint) → uint256++` [.item-kind]#public#
  2618. Returns the quorum numerator at a specific timepoint. See {quorumDenominator}.
  2619. [.contract-item]
  2620. [[GovernorVotesQuorumFraction-quorumDenominator--]]
  2621. ==== `[.contract-item-name]#++quorumDenominator++#++() → uint256++` [.item-kind]#public#
  2622. Returns the quorum denominator. Defaults to 100, but may be overridden.
  2623. [.contract-item]
  2624. [[GovernorVotesQuorumFraction-quorum-uint256-]]
  2625. ==== `[.contract-item-name]#++quorum++#++(uint256 timepoint) → uint256++` [.item-kind]#public#
  2626. Returns the quorum for a timepoint, in terms of number of votes: `supply * numerator / denominator`.
  2627. [.contract-item]
  2628. [[GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-]]
  2629. ==== `[.contract-item-name]#++updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#external#
  2630. Changes the quorum numerator.
  2631. Emits a {QuorumNumeratorUpdated} event.
  2632. Requirements:
  2633. - Must be called through a governance proposal.
  2634. - New numerator must be smaller or equal to the denominator.
  2635. [.contract-item]
  2636. [[GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-]]
  2637. ==== `[.contract-item-name]#++_updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#internal#
  2638. Changes the quorum numerator.
  2639. Emits a {QuorumNumeratorUpdated} event.
  2640. Requirements:
  2641. - New numerator must be smaller or equal to the denominator.
  2642. [.contract-item]
  2643. [[GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-]]
  2644. ==== `[.contract-item-name]#++QuorumNumeratorUpdated++#++(uint256 oldQuorumNumerator, uint256 newQuorumNumerator)++` [.item-kind]#event#
  2645. [.contract-item]
  2646. [[GovernorVotesQuorumFraction-GovernorInvalidQuorumFraction-uint256-uint256-]]
  2647. ==== `[.contract-item-name]#++GovernorInvalidQuorumFraction++#++(uint256 quorumNumerator, uint256 quorumDenominator)++` [.item-kind]#error#
  2648. The quorum set is not a valid fraction.
  2649. === Extensions
  2650. :ExecutionPlan: pass:normal[xref:#GovernorTimelockAccess-ExecutionPlan[`++ExecutionPlan++`]]
  2651. :GovernorUnmetDelay: pass:normal[xref:#GovernorTimelockAccess-GovernorUnmetDelay-uint256-uint256-[`++GovernorUnmetDelay++`]]
  2652. :GovernorMismatchedNonce: pass:normal[xref:#GovernorTimelockAccess-GovernorMismatchedNonce-uint256-uint256-uint256-[`++GovernorMismatchedNonce++`]]
  2653. :GovernorLockedIgnore: pass:normal[xref:#GovernorTimelockAccess-GovernorLockedIgnore--[`++GovernorLockedIgnore++`]]
  2654. :BaseDelaySet: pass:normal[xref:#GovernorTimelockAccess-BaseDelaySet-uint32-uint32-[`++BaseDelaySet++`]]
  2655. :AccessManagerIgnoredSet: pass:normal[xref:#GovernorTimelockAccess-AccessManagerIgnoredSet-address-bytes4-bool-[`++AccessManagerIgnoredSet++`]]
  2656. :constructor: pass:normal[xref:#GovernorTimelockAccess-constructor-address-uint32-[`++constructor++`]]
  2657. :accessManager: pass:normal[xref:#GovernorTimelockAccess-accessManager--[`++accessManager++`]]
  2658. :baseDelaySeconds: pass:normal[xref:#GovernorTimelockAccess-baseDelaySeconds--[`++baseDelaySeconds++`]]
  2659. :setBaseDelaySeconds: pass:normal[xref:#GovernorTimelockAccess-setBaseDelaySeconds-uint32-[`++setBaseDelaySeconds++`]]
  2660. :_setBaseDelaySeconds: pass:normal[xref:#GovernorTimelockAccess-_setBaseDelaySeconds-uint32-[`++_setBaseDelaySeconds++`]]
  2661. :isAccessManagerIgnored: pass:normal[xref:#GovernorTimelockAccess-isAccessManagerIgnored-address-bytes4-[`++isAccessManagerIgnored++`]]
  2662. :setAccessManagerIgnored: pass:normal[xref:#GovernorTimelockAccess-setAccessManagerIgnored-address-bytes4---bool-[`++setAccessManagerIgnored++`]]
  2663. :_setAccessManagerIgnored: pass:normal[xref:#GovernorTimelockAccess-_setAccessManagerIgnored-address-bytes4-bool-[`++_setAccessManagerIgnored++`]]
  2664. :proposalExecutionPlan: pass:normal[xref:#GovernorTimelockAccess-proposalExecutionPlan-uint256-[`++proposalExecutionPlan++`]]
  2665. :proposalNeedsQueuing: pass:normal[xref:#GovernorTimelockAccess-proposalNeedsQueuing-uint256-[`++proposalNeedsQueuing++`]]
  2666. :propose: pass:normal[xref:#GovernorTimelockAccess-propose-address---uint256---bytes---string-[`++propose++`]]
  2667. :_queueOperations: pass:normal[xref:#GovernorTimelockAccess-_queueOperations-uint256-address---uint256---bytes---bytes32-[`++_queueOperations++`]]
  2668. :_executeOperations: pass:normal[xref:#GovernorTimelockAccess-_executeOperations-uint256-address---uint256---bytes---bytes32-[`++_executeOperations++`]]
  2669. :_cancel: pass:normal[xref:#GovernorTimelockAccess-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  2670. [.contract]
  2671. [[GovernorTimelockAccess]]
  2672. === `++GovernorTimelockAccess++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorTimelockAccess.sol[{github-icon},role=heading-link]
  2673. [.hljs-theme-light.nopadding]
  2674. ```solidity
  2675. import "@openzeppelin/contracts/governance/extensions/GovernorTimelockAccess.sol";
  2676. ```
  2677. This module connects a {Governor} instance to an {AccessManager} instance, allowing the governor to make calls
  2678. that are delay-restricted by the manager using the normal {queue} workflow. An optional base delay is applied to
  2679. operations that are not delayed externally by the manager. Execution of a proposal will be delayed as much as
  2680. necessary to meet the required delays of all of its operations.
  2681. This extension allows the governor to hold and use its own assets and permissions, unlike {GovernorTimelockControl}
  2682. and {GovernorTimelockCompound}, where the timelock is a separate contract that must be the one to hold assets and
  2683. permissions. Operations that are delay-restricted by the manager, however, will be executed through the
  2684. {AccessManager-execute} function.
  2685. ==== Security Considerations
  2686. Some operations may be cancelable in the `AccessManager` by the admin or a set of guardians, depending on the
  2687. restricted function being invoked. Since proposals are atomic, the cancellation by a guardian of a single operation
  2688. in a proposal will cause all of the proposal to become unable to execute. Consider proposing cancellable operations
  2689. separately.
  2690. By default, function calls will be routed through the associated `AccessManager` whenever it claims the target
  2691. function to be restricted by it. However, admins may configure the manager to make that claim for functions that a
  2692. governor would want to call directly (e.g., token transfers) in an attempt to deny it access to those functions. To
  2693. mitigate this attack vector, the governor is able to ignore the restrictions claimed by the `AccessManager` using
  2694. {setAccessManagerIgnored}. While permanent denial of service is mitigated, temporary DoS may still be technically
  2695. possible. All of the governor's own functions (e.g., {setBaseDelaySeconds}) ignore the `AccessManager` by default.
  2696. [.contract-index]
  2697. .Functions
  2698. --
  2699. * {xref-GovernorTimelockAccess-constructor-address-uint32-}[`++constructor(manager, initialBaseDelay)++`]
  2700. * {xref-GovernorTimelockAccess-accessManager--}[`++accessManager()++`]
  2701. * {xref-GovernorTimelockAccess-baseDelaySeconds--}[`++baseDelaySeconds()++`]
  2702. * {xref-GovernorTimelockAccess-setBaseDelaySeconds-uint32-}[`++setBaseDelaySeconds(newBaseDelay)++`]
  2703. * {xref-GovernorTimelockAccess-_setBaseDelaySeconds-uint32-}[`++_setBaseDelaySeconds(newBaseDelay)++`]
  2704. * {xref-GovernorTimelockAccess-isAccessManagerIgnored-address-bytes4-}[`++isAccessManagerIgnored(target, selector)++`]
  2705. * {xref-GovernorTimelockAccess-setAccessManagerIgnored-address-bytes4---bool-}[`++setAccessManagerIgnored(target, selectors, ignored)++`]
  2706. * {xref-GovernorTimelockAccess-_setAccessManagerIgnored-address-bytes4-bool-}[`++_setAccessManagerIgnored(target, selector, ignored)++`]
  2707. * {xref-GovernorTimelockAccess-proposalExecutionPlan-uint256-}[`++proposalExecutionPlan(proposalId)++`]
  2708. * {xref-GovernorTimelockAccess-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing(proposalId)++`]
  2709. * {xref-GovernorTimelockAccess-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  2710. * {xref-GovernorTimelockAccess-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(proposalId, targets, , calldatas, )++`]
  2711. * {xref-GovernorTimelockAccess-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(proposalId, targets, values, calldatas, )++`]
  2712. * {xref-GovernorTimelockAccess-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2713. [.contract-subindex-inherited]
  2714. .Governor
  2715. * {xref-Governor-receive--}[`++receive()++`]
  2716. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2717. * {xref-Governor-name--}[`++name()++`]
  2718. * {xref-Governor-version--}[`++version()++`]
  2719. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2720. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  2721. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2722. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2723. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2724. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  2725. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  2726. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  2727. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  2728. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  2729. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  2730. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  2731. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  2732. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  2733. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  2734. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  2735. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  2736. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  2737. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  2738. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  2739. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  2740. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  2741. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  2742. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  2743. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  2744. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  2745. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  2746. * {xref-Governor-_executor--}[`++_executor()++`]
  2747. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  2748. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  2749. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  2750. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  2751. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  2752. * {xref-Governor-clock--}[`++clock()++`]
  2753. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  2754. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  2755. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  2756. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  2757. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  2758. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  2759. [.contract-subindex-inherited]
  2760. .IERC1155Receiver
  2761. [.contract-subindex-inherited]
  2762. .IERC721Receiver
  2763. [.contract-subindex-inherited]
  2764. .IGovernor
  2765. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  2766. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  2767. [.contract-subindex-inherited]
  2768. .IERC6372
  2769. [.contract-subindex-inherited]
  2770. .Nonces
  2771. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  2772. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  2773. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  2774. [.contract-subindex-inherited]
  2775. .EIP712
  2776. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  2777. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  2778. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  2779. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  2780. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  2781. [.contract-subindex-inherited]
  2782. .IERC5267
  2783. [.contract-subindex-inherited]
  2784. .ERC165
  2785. [.contract-subindex-inherited]
  2786. .IERC165
  2787. --
  2788. [.contract-index]
  2789. .Events
  2790. --
  2791. * {xref-GovernorTimelockAccess-BaseDelaySet-uint32-uint32-}[`++BaseDelaySet(oldBaseDelaySeconds, newBaseDelaySeconds)++`]
  2792. * {xref-GovernorTimelockAccess-AccessManagerIgnoredSet-address-bytes4-bool-}[`++AccessManagerIgnoredSet(target, selector, ignored)++`]
  2793. [.contract-subindex-inherited]
  2794. .Governor
  2795. [.contract-subindex-inherited]
  2796. .IERC1155Receiver
  2797. [.contract-subindex-inherited]
  2798. .IERC721Receiver
  2799. [.contract-subindex-inherited]
  2800. .IGovernor
  2801. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  2802. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  2803. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  2804. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  2805. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  2806. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  2807. [.contract-subindex-inherited]
  2808. .IERC6372
  2809. [.contract-subindex-inherited]
  2810. .Nonces
  2811. [.contract-subindex-inherited]
  2812. .EIP712
  2813. [.contract-subindex-inherited]
  2814. .IERC5267
  2815. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  2816. [.contract-subindex-inherited]
  2817. .ERC165
  2818. [.contract-subindex-inherited]
  2819. .IERC165
  2820. --
  2821. [.contract-index]
  2822. .Errors
  2823. --
  2824. * {xref-GovernorTimelockAccess-GovernorUnmetDelay-uint256-uint256-}[`++GovernorUnmetDelay(proposalId, neededTimestamp)++`]
  2825. * {xref-GovernorTimelockAccess-GovernorMismatchedNonce-uint256-uint256-uint256-}[`++GovernorMismatchedNonce(proposalId, expectedNonce, actualNonce)++`]
  2826. * {xref-GovernorTimelockAccess-GovernorLockedIgnore--}[`++GovernorLockedIgnore()++`]
  2827. [.contract-subindex-inherited]
  2828. .Governor
  2829. [.contract-subindex-inherited]
  2830. .IERC1155Receiver
  2831. [.contract-subindex-inherited]
  2832. .IERC721Receiver
  2833. [.contract-subindex-inherited]
  2834. .IGovernor
  2835. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  2836. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  2837. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  2838. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  2839. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  2840. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  2841. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  2842. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  2843. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  2844. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  2845. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  2846. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  2847. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  2848. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  2849. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  2850. [.contract-subindex-inherited]
  2851. .IERC6372
  2852. [.contract-subindex-inherited]
  2853. .Nonces
  2854. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  2855. [.contract-subindex-inherited]
  2856. .EIP712
  2857. [.contract-subindex-inherited]
  2858. .IERC5267
  2859. [.contract-subindex-inherited]
  2860. .ERC165
  2861. [.contract-subindex-inherited]
  2862. .IERC165
  2863. --
  2864. [.contract-item]
  2865. [[GovernorTimelockAccess-constructor-address-uint32-]]
  2866. ==== `[.contract-item-name]#++constructor++#++(address manager, uint32 initialBaseDelay)++` [.item-kind]#internal#
  2867. Initialize the governor with an {AccessManager} and initial base delay.
  2868. [.contract-item]
  2869. [[GovernorTimelockAccess-accessManager--]]
  2870. ==== `[.contract-item-name]#++accessManager++#++() → contract IAccessManager++` [.item-kind]#public#
  2871. Returns the {AccessManager} instance associated to this governor.
  2872. [.contract-item]
  2873. [[GovernorTimelockAccess-baseDelaySeconds--]]
  2874. ==== `[.contract-item-name]#++baseDelaySeconds++#++() → uint32++` [.item-kind]#public#
  2875. Base delay that will be applied to all function calls. Some may be further delayed by their associated
  2876. `AccessManager` authority; in this case the final delay will be the maximum of the base delay and the one
  2877. demanded by the authority.
  2878. NOTE: Execution delays are processed by the `AccessManager` contracts, and according to that contract are
  2879. expressed in seconds. Therefore, the base delay is also in seconds, regardless of the governor's clock mode.
  2880. [.contract-item]
  2881. [[GovernorTimelockAccess-setBaseDelaySeconds-uint32-]]
  2882. ==== `[.contract-item-name]#++setBaseDelaySeconds++#++(uint32 newBaseDelay)++` [.item-kind]#public#
  2883. Change the value of {baseDelaySeconds}. This operation can only be invoked through a governance proposal.
  2884. [.contract-item]
  2885. [[GovernorTimelockAccess-_setBaseDelaySeconds-uint32-]]
  2886. ==== `[.contract-item-name]#++_setBaseDelaySeconds++#++(uint32 newBaseDelay)++` [.item-kind]#internal#
  2887. Change the value of {baseDelaySeconds}. Internal function without access control.
  2888. [.contract-item]
  2889. [[GovernorTimelockAccess-isAccessManagerIgnored-address-bytes4-]]
  2890. ==== `[.contract-item-name]#++isAccessManagerIgnored++#++(address target, bytes4 selector) → bool++` [.item-kind]#public#
  2891. Check if restrictions from the associated {AccessManager} are ignored for a target function. Returns true
  2892. when the target function will be invoked directly regardless of `AccessManager` settings for the function.
  2893. See {setAccessManagerIgnored} and Security Considerations above.
  2894. [.contract-item]
  2895. [[GovernorTimelockAccess-setAccessManagerIgnored-address-bytes4---bool-]]
  2896. ==== `[.contract-item-name]#++setAccessManagerIgnored++#++(address target, bytes4[] selectors, bool ignored)++` [.item-kind]#public#
  2897. Configure whether restrictions from the associated {AccessManager} are ignored for a target function.
  2898. See Security Considerations above.
  2899. [.contract-item]
  2900. [[GovernorTimelockAccess-_setAccessManagerIgnored-address-bytes4-bool-]]
  2901. ==== `[.contract-item-name]#++_setAccessManagerIgnored++#++(address target, bytes4 selector, bool ignored)++` [.item-kind]#internal#
  2902. Internal version of {setAccessManagerIgnored} without access restriction.
  2903. [.contract-item]
  2904. [[GovernorTimelockAccess-proposalExecutionPlan-uint256-]]
  2905. ==== `[.contract-item-name]#++proposalExecutionPlan++#++(uint256 proposalId) → uint32 delay, bool[] indirect, bool[] withDelay++` [.item-kind]#public#
  2906. Public accessor to check the execution plan, including the number of seconds that the proposal will be
  2907. delayed since queuing, an array indicating which of the proposal actions will be executed indirectly through
  2908. the associated {AccessManager}, and another indicating which will be scheduled in {queue}. Note that
  2909. those that must be scheduled are cancellable by `AccessManager` guardians.
  2910. [.contract-item]
  2911. [[GovernorTimelockAccess-proposalNeedsQueuing-uint256-]]
  2912. ==== `[.contract-item-name]#++proposalNeedsQueuing++#++(uint256 proposalId) → bool++` [.item-kind]#public#
  2913. See {IGovernor-proposalNeedsQueuing}.
  2914. [.contract-item]
  2915. [[GovernorTimelockAccess-propose-address---uint256---bytes---string-]]
  2916. ==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#
  2917. See {IGovernor-propose}
  2918. [.contract-item]
  2919. [[GovernorTimelockAccess-_queueOperations-uint256-address---uint256---bytes---bytes32-]]
  2920. ==== `[.contract-item-name]#++_queueOperations++#++(uint256 proposalId, address[] targets, uint256[], bytes[] calldatas, bytes32) → uint48++` [.item-kind]#internal#
  2921. Mechanism to queue a proposal, potentially scheduling some of its operations in the AccessManager.
  2922. NOTE: The execution delay is chosen based on the delay information retrieved in {propose}. This value may be
  2923. off if the delay was updated since proposal creation. In this case, the proposal needs to be recreated.
  2924. [.contract-item]
  2925. [[GovernorTimelockAccess-_executeOperations-uint256-address---uint256---bytes---bytes32-]]
  2926. ==== `[.contract-item-name]#++_executeOperations++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  2927. Mechanism to execute a proposal, potentially going through {AccessManager-execute} for delayed operations.
  2928. [.contract-item]
  2929. [[GovernorTimelockAccess-_cancel-address---uint256---bytes---bytes32-]]
  2930. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  2931. See {IGovernor-_cancel}
  2932. [.contract-item]
  2933. [[GovernorTimelockAccess-BaseDelaySet-uint32-uint32-]]
  2934. ==== `[.contract-item-name]#++BaseDelaySet++#++(uint32 oldBaseDelaySeconds, uint32 newBaseDelaySeconds)++` [.item-kind]#event#
  2935. [.contract-item]
  2936. [[GovernorTimelockAccess-AccessManagerIgnoredSet-address-bytes4-bool-]]
  2937. ==== `[.contract-item-name]#++AccessManagerIgnoredSet++#++(address target, bytes4 selector, bool ignored)++` [.item-kind]#event#
  2938. [.contract-item]
  2939. [[GovernorTimelockAccess-GovernorUnmetDelay-uint256-uint256-]]
  2940. ==== `[.contract-item-name]#++GovernorUnmetDelay++#++(uint256 proposalId, uint256 neededTimestamp)++` [.item-kind]#error#
  2941. [.contract-item]
  2942. [[GovernorTimelockAccess-GovernorMismatchedNonce-uint256-uint256-uint256-]]
  2943. ==== `[.contract-item-name]#++GovernorMismatchedNonce++#++(uint256 proposalId, uint256 expectedNonce, uint256 actualNonce)++` [.item-kind]#error#
  2944. [.contract-item]
  2945. [[GovernorTimelockAccess-GovernorLockedIgnore--]]
  2946. ==== `[.contract-item-name]#++GovernorLockedIgnore++#++()++` [.item-kind]#error#
  2947. :TimelockChange: pass:normal[xref:#GovernorTimelockControl-TimelockChange-address-address-[`++TimelockChange++`]]
  2948. :constructor: pass:normal[xref:#GovernorTimelockControl-constructor-contract-TimelockController-[`++constructor++`]]
  2949. :state: pass:normal[xref:#GovernorTimelockControl-state-uint256-[`++state++`]]
  2950. :timelock: pass:normal[xref:#GovernorTimelockControl-timelock--[`++timelock++`]]
  2951. :proposalNeedsQueuing: pass:normal[xref:#GovernorTimelockControl-proposalNeedsQueuing-uint256-[`++proposalNeedsQueuing++`]]
  2952. :_queueOperations: pass:normal[xref:#GovernorTimelockControl-_queueOperations-uint256-address---uint256---bytes---bytes32-[`++_queueOperations++`]]
  2953. :_executeOperations: pass:normal[xref:#GovernorTimelockControl-_executeOperations-uint256-address---uint256---bytes---bytes32-[`++_executeOperations++`]]
  2954. :_cancel: pass:normal[xref:#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  2955. :_executor: pass:normal[xref:#GovernorTimelockControl-_executor--[`++_executor++`]]
  2956. :updateTimelock: pass:normal[xref:#GovernorTimelockControl-updateTimelock-contract-TimelockController-[`++updateTimelock++`]]
  2957. [.contract]
  2958. [[GovernorTimelockControl]]
  2959. === `++GovernorTimelockControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorTimelockControl.sol[{github-icon},role=heading-link]
  2960. [.hljs-theme-light.nopadding]
  2961. ```solidity
  2962. import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol";
  2963. ```
  2964. Extension of {Governor} that binds the execution process to an instance of {TimelockController}. This adds a
  2965. delay, enforced by the {TimelockController} to all successful proposal (in addition to the voting duration). The
  2966. {Governor} needs the proposer (and ideally the executor) roles for the {Governor} to work properly.
  2967. Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
  2968. the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
  2969. inaccessible from a proposal, unless executed via {Governor-relay}.
  2970. WARNING: Setting up the TimelockController to have additional proposers or cancellers besides the governor is very
  2971. risky, as it grants them the ability to: 1) execute operations as the timelock, and thus possibly performing
  2972. operations or accessing funds that are expected to only be accessible through a vote, and 2) block governance
  2973. proposals that have been approved by the voters, effectively executing a Denial of Service attack.
  2974. NOTE: `AccessManager` does not support scheduling more than one operation with the same target and calldata at
  2975. the same time. See {AccessManager-schedule} for a workaround.
  2976. [.contract-index]
  2977. .Functions
  2978. --
  2979. * {xref-GovernorTimelockControl-constructor-contract-TimelockController-}[`++constructor(timelockAddress)++`]
  2980. * {xref-GovernorTimelockControl-state-uint256-}[`++state(proposalId)++`]
  2981. * {xref-GovernorTimelockControl-timelock--}[`++timelock()++`]
  2982. * {xref-GovernorTimelockControl-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  2983. * {xref-GovernorTimelockControl-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(proposalId, targets, values, calldatas, descriptionHash)++`]
  2984. * {xref-GovernorTimelockControl-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(proposalId, targets, values, calldatas, descriptionHash)++`]
  2985. * {xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  2986. * {xref-GovernorTimelockControl-_executor--}[`++_executor()++`]
  2987. * {xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-}[`++updateTimelock(newTimelock)++`]
  2988. [.contract-subindex-inherited]
  2989. .Governor
  2990. * {xref-Governor-receive--}[`++receive()++`]
  2991. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  2992. * {xref-Governor-name--}[`++name()++`]
  2993. * {xref-Governor-version--}[`++version()++`]
  2994. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  2995. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  2996. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  2997. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  2998. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  2999. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  3000. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  3001. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  3002. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  3003. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  3004. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  3005. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  3006. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  3007. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  3008. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  3009. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  3010. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  3011. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  3012. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  3013. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  3014. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  3015. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  3016. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  3017. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  3018. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  3019. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  3020. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  3021. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  3022. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  3023. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  3024. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  3025. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  3026. * {xref-Governor-clock--}[`++clock()++`]
  3027. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  3028. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  3029. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  3030. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  3031. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  3032. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  3033. [.contract-subindex-inherited]
  3034. .IERC1155Receiver
  3035. [.contract-subindex-inherited]
  3036. .IERC721Receiver
  3037. [.contract-subindex-inherited]
  3038. .IGovernor
  3039. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  3040. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  3041. [.contract-subindex-inherited]
  3042. .IERC6372
  3043. [.contract-subindex-inherited]
  3044. .Nonces
  3045. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  3046. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  3047. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  3048. [.contract-subindex-inherited]
  3049. .EIP712
  3050. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  3051. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  3052. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  3053. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  3054. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  3055. [.contract-subindex-inherited]
  3056. .IERC5267
  3057. [.contract-subindex-inherited]
  3058. .ERC165
  3059. [.contract-subindex-inherited]
  3060. .IERC165
  3061. --
  3062. [.contract-index]
  3063. .Events
  3064. --
  3065. * {xref-GovernorTimelockControl-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]
  3066. [.contract-subindex-inherited]
  3067. .Governor
  3068. [.contract-subindex-inherited]
  3069. .IERC1155Receiver
  3070. [.contract-subindex-inherited]
  3071. .IERC721Receiver
  3072. [.contract-subindex-inherited]
  3073. .IGovernor
  3074. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  3075. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  3076. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  3077. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  3078. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  3079. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  3080. [.contract-subindex-inherited]
  3081. .IERC6372
  3082. [.contract-subindex-inherited]
  3083. .Nonces
  3084. [.contract-subindex-inherited]
  3085. .EIP712
  3086. [.contract-subindex-inherited]
  3087. .IERC5267
  3088. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  3089. [.contract-subindex-inherited]
  3090. .ERC165
  3091. [.contract-subindex-inherited]
  3092. .IERC165
  3093. --
  3094. [.contract-index]
  3095. .Errors
  3096. --
  3097. [.contract-subindex-inherited]
  3098. .Governor
  3099. [.contract-subindex-inherited]
  3100. .IERC1155Receiver
  3101. [.contract-subindex-inherited]
  3102. .IERC721Receiver
  3103. [.contract-subindex-inherited]
  3104. .IGovernor
  3105. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  3106. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  3107. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  3108. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  3109. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  3110. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  3111. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  3112. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  3113. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  3114. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  3115. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  3116. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  3117. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  3118. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  3119. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  3120. [.contract-subindex-inherited]
  3121. .IERC6372
  3122. [.contract-subindex-inherited]
  3123. .Nonces
  3124. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  3125. [.contract-subindex-inherited]
  3126. .EIP712
  3127. [.contract-subindex-inherited]
  3128. .IERC5267
  3129. [.contract-subindex-inherited]
  3130. .ERC165
  3131. [.contract-subindex-inherited]
  3132. .IERC165
  3133. --
  3134. [.contract-item]
  3135. [[GovernorTimelockControl-constructor-contract-TimelockController-]]
  3136. ==== `[.contract-item-name]#++constructor++#++(contract TimelockController timelockAddress)++` [.item-kind]#internal#
  3137. Set the timelock.
  3138. [.contract-item]
  3139. [[GovernorTimelockControl-state-uint256-]]
  3140. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  3141. Overridden version of the {Governor-state} function that considers the status reported by the timelock.
  3142. [.contract-item]
  3143. [[GovernorTimelockControl-timelock--]]
  3144. ==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#
  3145. Public accessor to check the address of the timelock
  3146. [.contract-item]
  3147. [[GovernorTimelockControl-proposalNeedsQueuing-uint256-]]
  3148. ==== `[.contract-item-name]#++proposalNeedsQueuing++#++(uint256) → bool++` [.item-kind]#public#
  3149. See {IGovernor-proposalNeedsQueuing}.
  3150. [.contract-item]
  3151. [[GovernorTimelockControl-_queueOperations-uint256-address---uint256---bytes---bytes32-]]
  3152. ==== `[.contract-item-name]#++_queueOperations++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint48++` [.item-kind]#internal#
  3153. Function to queue a proposal to the timelock.
  3154. [.contract-item]
  3155. [[GovernorTimelockControl-_executeOperations-uint256-address---uint256---bytes---bytes32-]]
  3156. ==== `[.contract-item-name]#++_executeOperations++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash)++` [.item-kind]#internal#
  3157. Overridden version of the {Governor-_executeOperations} function that runs the already queued proposal
  3158. through the timelock.
  3159. [.contract-item]
  3160. [[GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-]]
  3161. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  3162. Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it has already
  3163. been queued.
  3164. [.contract-item]
  3165. [[GovernorTimelockControl-_executor--]]
  3166. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  3167. Address through which the governor executes action. In this case, the timelock.
  3168. [.contract-item]
  3169. [[GovernorTimelockControl-updateTimelock-contract-TimelockController-]]
  3170. ==== `[.contract-item-name]#++updateTimelock++#++(contract TimelockController newTimelock)++` [.item-kind]#external#
  3171. Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
  3172. must be proposed, scheduled, and executed through governance proposals.
  3173. CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.
  3174. [.contract-item]
  3175. [[GovernorTimelockControl-TimelockChange-address-address-]]
  3176. ==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#
  3177. Emitted when the timelock controller used for proposal execution is modified.
  3178. :TimelockChange: pass:normal[xref:#GovernorTimelockCompound-TimelockChange-address-address-[`++TimelockChange++`]]
  3179. :constructor: pass:normal[xref:#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-[`++constructor++`]]
  3180. :state: pass:normal[xref:#GovernorTimelockCompound-state-uint256-[`++state++`]]
  3181. :timelock: pass:normal[xref:#GovernorTimelockCompound-timelock--[`++timelock++`]]
  3182. :proposalNeedsQueuing: pass:normal[xref:#GovernorTimelockCompound-proposalNeedsQueuing-uint256-[`++proposalNeedsQueuing++`]]
  3183. :_queueOperations: pass:normal[xref:#GovernorTimelockCompound-_queueOperations-uint256-address---uint256---bytes---bytes32-[`++_queueOperations++`]]
  3184. :_executeOperations: pass:normal[xref:#GovernorTimelockCompound-_executeOperations-uint256-address---uint256---bytes---bytes32-[`++_executeOperations++`]]
  3185. :_cancel: pass:normal[xref:#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
  3186. :_executor: pass:normal[xref:#GovernorTimelockCompound-_executor--[`++_executor++`]]
  3187. :__acceptAdmin: pass:normal[xref:#GovernorTimelockCompound-__acceptAdmin--[`++__acceptAdmin++`]]
  3188. :updateTimelock: pass:normal[xref:#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-[`++updateTimelock++`]]
  3189. [.contract]
  3190. [[GovernorTimelockCompound]]
  3191. === `++GovernorTimelockCompound++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorTimelockCompound.sol[{github-icon},role=heading-link]
  3192. [.hljs-theme-light.nopadding]
  3193. ```solidity
  3194. import "@openzeppelin/contracts/governance/extensions/GovernorTimelockCompound.sol";
  3195. ```
  3196. Extension of {Governor} that binds the execution process to a Compound Timelock. This adds a delay, enforced by
  3197. the external timelock to all successful proposal (in addition to the voting duration). The {Governor} needs to be
  3198. the admin of the timelock for any operation to be performed. A public, unrestricted,
  3199. {GovernorTimelockCompound-__acceptAdmin} is available to accept ownership of the timelock.
  3200. Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
  3201. the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
  3202. inaccessible.
  3203. [.contract-index]
  3204. .Functions
  3205. --
  3206. * {xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-}[`++constructor(timelockAddress)++`]
  3207. * {xref-GovernorTimelockCompound-state-uint256-}[`++state(proposalId)++`]
  3208. * {xref-GovernorTimelockCompound-timelock--}[`++timelock()++`]
  3209. * {xref-GovernorTimelockCompound-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  3210. * {xref-GovernorTimelockCompound-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(proposalId, targets, values, calldatas, )++`]
  3211. * {xref-GovernorTimelockCompound-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(proposalId, targets, values, calldatas, )++`]
  3212. * {xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  3213. * {xref-GovernorTimelockCompound-_executor--}[`++_executor()++`]
  3214. * {xref-GovernorTimelockCompound-__acceptAdmin--}[`++__acceptAdmin()++`]
  3215. * {xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-}[`++updateTimelock(newTimelock)++`]
  3216. [.contract-subindex-inherited]
  3217. .Governor
  3218. * {xref-Governor-receive--}[`++receive()++`]
  3219. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  3220. * {xref-Governor-name--}[`++name()++`]
  3221. * {xref-Governor-version--}[`++version()++`]
  3222. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  3223. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  3224. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  3225. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  3226. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  3227. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  3228. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  3229. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  3230. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  3231. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  3232. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  3233. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  3234. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  3235. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  3236. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  3237. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  3238. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  3239. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  3240. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  3241. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  3242. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  3243. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  3244. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  3245. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  3246. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  3247. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  3248. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  3249. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  3250. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  3251. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  3252. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  3253. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  3254. * {xref-Governor-clock--}[`++clock()++`]
  3255. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  3256. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  3257. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  3258. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  3259. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  3260. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  3261. [.contract-subindex-inherited]
  3262. .IERC1155Receiver
  3263. [.contract-subindex-inherited]
  3264. .IERC721Receiver
  3265. [.contract-subindex-inherited]
  3266. .IGovernor
  3267. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  3268. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  3269. [.contract-subindex-inherited]
  3270. .IERC6372
  3271. [.contract-subindex-inherited]
  3272. .Nonces
  3273. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  3274. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  3275. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  3276. [.contract-subindex-inherited]
  3277. .EIP712
  3278. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  3279. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  3280. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  3281. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  3282. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  3283. [.contract-subindex-inherited]
  3284. .IERC5267
  3285. [.contract-subindex-inherited]
  3286. .ERC165
  3287. [.contract-subindex-inherited]
  3288. .IERC165
  3289. --
  3290. [.contract-index]
  3291. .Events
  3292. --
  3293. * {xref-GovernorTimelockCompound-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]
  3294. [.contract-subindex-inherited]
  3295. .Governor
  3296. [.contract-subindex-inherited]
  3297. .IERC1155Receiver
  3298. [.contract-subindex-inherited]
  3299. .IERC721Receiver
  3300. [.contract-subindex-inherited]
  3301. .IGovernor
  3302. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  3303. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  3304. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  3305. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  3306. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  3307. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  3308. [.contract-subindex-inherited]
  3309. .IERC6372
  3310. [.contract-subindex-inherited]
  3311. .Nonces
  3312. [.contract-subindex-inherited]
  3313. .EIP712
  3314. [.contract-subindex-inherited]
  3315. .IERC5267
  3316. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  3317. [.contract-subindex-inherited]
  3318. .ERC165
  3319. [.contract-subindex-inherited]
  3320. .IERC165
  3321. --
  3322. [.contract-index]
  3323. .Errors
  3324. --
  3325. [.contract-subindex-inherited]
  3326. .Governor
  3327. [.contract-subindex-inherited]
  3328. .IERC1155Receiver
  3329. [.contract-subindex-inherited]
  3330. .IERC721Receiver
  3331. [.contract-subindex-inherited]
  3332. .IGovernor
  3333. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  3334. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  3335. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  3336. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  3337. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  3338. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  3339. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  3340. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  3341. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  3342. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  3343. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  3344. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  3345. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  3346. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  3347. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  3348. [.contract-subindex-inherited]
  3349. .IERC6372
  3350. [.contract-subindex-inherited]
  3351. .Nonces
  3352. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  3353. [.contract-subindex-inherited]
  3354. .EIP712
  3355. [.contract-subindex-inherited]
  3356. .IERC5267
  3357. [.contract-subindex-inherited]
  3358. .ERC165
  3359. [.contract-subindex-inherited]
  3360. .IERC165
  3361. --
  3362. [.contract-item]
  3363. [[GovernorTimelockCompound-constructor-contract-ICompoundTimelock-]]
  3364. ==== `[.contract-item-name]#++constructor++#++(contract ICompoundTimelock timelockAddress)++` [.item-kind]#internal#
  3365. Set the timelock.
  3366. [.contract-item]
  3367. [[GovernorTimelockCompound-state-uint256-]]
  3368. ==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#
  3369. Overridden version of the {Governor-state} function with added support for the `Expired` state.
  3370. [.contract-item]
  3371. [[GovernorTimelockCompound-timelock--]]
  3372. ==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#
  3373. Public accessor to check the address of the timelock
  3374. [.contract-item]
  3375. [[GovernorTimelockCompound-proposalNeedsQueuing-uint256-]]
  3376. ==== `[.contract-item-name]#++proposalNeedsQueuing++#++(uint256) → bool++` [.item-kind]#public#
  3377. See {IGovernor-proposalNeedsQueuing}.
  3378. [.contract-item]
  3379. [[GovernorTimelockCompound-_queueOperations-uint256-address---uint256---bytes---bytes32-]]
  3380. ==== `[.contract-item-name]#++_queueOperations++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32) → uint48++` [.item-kind]#internal#
  3381. Function to queue a proposal to the timelock.
  3382. [.contract-item]
  3383. [[GovernorTimelockCompound-_executeOperations-uint256-address---uint256---bytes---bytes32-]]
  3384. ==== `[.contract-item-name]#++_executeOperations++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#
  3385. Overridden version of the {Governor-_executeOperations} function that run the already queued proposal
  3386. through the timelock.
  3387. [.contract-item]
  3388. [[GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-]]
  3389. ==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#
  3390. Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it has already
  3391. been queued.
  3392. [.contract-item]
  3393. [[GovernorTimelockCompound-_executor--]]
  3394. ==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#
  3395. Address through which the governor executes action. In this case, the timelock.
  3396. [.contract-item]
  3397. [[GovernorTimelockCompound-__acceptAdmin--]]
  3398. ==== `[.contract-item-name]#++__acceptAdmin++#++()++` [.item-kind]#public#
  3399. Accept admin right over the timelock.
  3400. [.contract-item]
  3401. [[GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-]]
  3402. ==== `[.contract-item-name]#++updateTimelock++#++(contract ICompoundTimelock newTimelock)++` [.item-kind]#external#
  3403. Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
  3404. must be proposed, scheduled, and executed through governance proposals.
  3405. For security reasons, the timelock must be handed over to another admin before setting up a new one. The two
  3406. operations (hand over the timelock) and do the update can be batched in a single proposal.
  3407. Note that if the timelock admin has been handed over in a previous operation, we refuse updates made through the
  3408. timelock if admin of the timelock has already been accepted and the operation is executed outside the scope of
  3409. governance.
  3410. CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.
  3411. [.contract-item]
  3412. [[GovernorTimelockCompound-TimelockChange-address-address-]]
  3413. ==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#
  3414. Emitted when the timelock controller used for proposal execution is modified.
  3415. :VotingDelaySet: pass:normal[xref:#GovernorSettings-VotingDelaySet-uint256-uint256-[`++VotingDelaySet++`]]
  3416. :VotingPeriodSet: pass:normal[xref:#GovernorSettings-VotingPeriodSet-uint256-uint256-[`++VotingPeriodSet++`]]
  3417. :ProposalThresholdSet: pass:normal[xref:#GovernorSettings-ProposalThresholdSet-uint256-uint256-[`++ProposalThresholdSet++`]]
  3418. :constructor: pass:normal[xref:#GovernorSettings-constructor-uint48-uint32-uint256-[`++constructor++`]]
  3419. :votingDelay: pass:normal[xref:#GovernorSettings-votingDelay--[`++votingDelay++`]]
  3420. :votingPeriod: pass:normal[xref:#GovernorSettings-votingPeriod--[`++votingPeriod++`]]
  3421. :proposalThreshold: pass:normal[xref:#GovernorSettings-proposalThreshold--[`++proposalThreshold++`]]
  3422. :setVotingDelay: pass:normal[xref:#GovernorSettings-setVotingDelay-uint48-[`++setVotingDelay++`]]
  3423. :setVotingPeriod: pass:normal[xref:#GovernorSettings-setVotingPeriod-uint32-[`++setVotingPeriod++`]]
  3424. :setProposalThreshold: pass:normal[xref:#GovernorSettings-setProposalThreshold-uint256-[`++setProposalThreshold++`]]
  3425. :_setVotingDelay: pass:normal[xref:#GovernorSettings-_setVotingDelay-uint48-[`++_setVotingDelay++`]]
  3426. :_setVotingPeriod: pass:normal[xref:#GovernorSettings-_setVotingPeriod-uint32-[`++_setVotingPeriod++`]]
  3427. :_setProposalThreshold: pass:normal[xref:#GovernorSettings-_setProposalThreshold-uint256-[`++_setProposalThreshold++`]]
  3428. [.contract]
  3429. [[GovernorSettings]]
  3430. === `++GovernorSettings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorSettings.sol[{github-icon},role=heading-link]
  3431. [.hljs-theme-light.nopadding]
  3432. ```solidity
  3433. import "@openzeppelin/contracts/governance/extensions/GovernorSettings.sol";
  3434. ```
  3435. Extension of {Governor} for settings updatable through governance.
  3436. [.contract-index]
  3437. .Functions
  3438. --
  3439. * {xref-GovernorSettings-constructor-uint48-uint32-uint256-}[`++constructor(initialVotingDelay, initialVotingPeriod, initialProposalThreshold)++`]
  3440. * {xref-GovernorSettings-votingDelay--}[`++votingDelay()++`]
  3441. * {xref-GovernorSettings-votingPeriod--}[`++votingPeriod()++`]
  3442. * {xref-GovernorSettings-proposalThreshold--}[`++proposalThreshold()++`]
  3443. * {xref-GovernorSettings-setVotingDelay-uint48-}[`++setVotingDelay(newVotingDelay)++`]
  3444. * {xref-GovernorSettings-setVotingPeriod-uint32-}[`++setVotingPeriod(newVotingPeriod)++`]
  3445. * {xref-GovernorSettings-setProposalThreshold-uint256-}[`++setProposalThreshold(newProposalThreshold)++`]
  3446. * {xref-GovernorSettings-_setVotingDelay-uint48-}[`++_setVotingDelay(newVotingDelay)++`]
  3447. * {xref-GovernorSettings-_setVotingPeriod-uint32-}[`++_setVotingPeriod(newVotingPeriod)++`]
  3448. * {xref-GovernorSettings-_setProposalThreshold-uint256-}[`++_setProposalThreshold(newProposalThreshold)++`]
  3449. [.contract-subindex-inherited]
  3450. .Governor
  3451. * {xref-Governor-receive--}[`++receive()++`]
  3452. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  3453. * {xref-Governor-name--}[`++name()++`]
  3454. * {xref-Governor-version--}[`++version()++`]
  3455. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  3456. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  3457. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  3458. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  3459. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  3460. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  3461. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  3462. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  3463. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  3464. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  3465. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  3466. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  3467. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  3468. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  3469. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  3470. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  3471. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  3472. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  3473. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  3474. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  3475. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  3476. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  3477. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  3478. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  3479. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  3480. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  3481. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  3482. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  3483. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  3484. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  3485. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  3486. * {xref-Governor-_executor--}[`++_executor()++`]
  3487. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  3488. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  3489. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  3490. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  3491. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  3492. * {xref-Governor-clock--}[`++clock()++`]
  3493. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  3494. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  3495. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  3496. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  3497. [.contract-subindex-inherited]
  3498. .IERC1155Receiver
  3499. [.contract-subindex-inherited]
  3500. .IERC721Receiver
  3501. [.contract-subindex-inherited]
  3502. .IGovernor
  3503. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  3504. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  3505. [.contract-subindex-inherited]
  3506. .IERC6372
  3507. [.contract-subindex-inherited]
  3508. .Nonces
  3509. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  3510. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  3511. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  3512. [.contract-subindex-inherited]
  3513. .EIP712
  3514. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  3515. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  3516. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  3517. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  3518. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  3519. [.contract-subindex-inherited]
  3520. .IERC5267
  3521. [.contract-subindex-inherited]
  3522. .ERC165
  3523. [.contract-subindex-inherited]
  3524. .IERC165
  3525. --
  3526. [.contract-index]
  3527. .Events
  3528. --
  3529. * {xref-GovernorSettings-VotingDelaySet-uint256-uint256-}[`++VotingDelaySet(oldVotingDelay, newVotingDelay)++`]
  3530. * {xref-GovernorSettings-VotingPeriodSet-uint256-uint256-}[`++VotingPeriodSet(oldVotingPeriod, newVotingPeriod)++`]
  3531. * {xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-}[`++ProposalThresholdSet(oldProposalThreshold, newProposalThreshold)++`]
  3532. [.contract-subindex-inherited]
  3533. .Governor
  3534. [.contract-subindex-inherited]
  3535. .IERC1155Receiver
  3536. [.contract-subindex-inherited]
  3537. .IERC721Receiver
  3538. [.contract-subindex-inherited]
  3539. .IGovernor
  3540. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  3541. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  3542. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  3543. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  3544. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  3545. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  3546. [.contract-subindex-inherited]
  3547. .IERC6372
  3548. [.contract-subindex-inherited]
  3549. .Nonces
  3550. [.contract-subindex-inherited]
  3551. .EIP712
  3552. [.contract-subindex-inherited]
  3553. .IERC5267
  3554. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  3555. [.contract-subindex-inherited]
  3556. .ERC165
  3557. [.contract-subindex-inherited]
  3558. .IERC165
  3559. --
  3560. [.contract-index]
  3561. .Errors
  3562. --
  3563. [.contract-subindex-inherited]
  3564. .Governor
  3565. [.contract-subindex-inherited]
  3566. .IERC1155Receiver
  3567. [.contract-subindex-inherited]
  3568. .IERC721Receiver
  3569. [.contract-subindex-inherited]
  3570. .IGovernor
  3571. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  3572. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  3573. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  3574. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  3575. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  3576. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  3577. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  3578. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  3579. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  3580. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  3581. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  3582. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  3583. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  3584. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  3585. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  3586. [.contract-subindex-inherited]
  3587. .IERC6372
  3588. [.contract-subindex-inherited]
  3589. .Nonces
  3590. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  3591. [.contract-subindex-inherited]
  3592. .EIP712
  3593. [.contract-subindex-inherited]
  3594. .IERC5267
  3595. [.contract-subindex-inherited]
  3596. .ERC165
  3597. [.contract-subindex-inherited]
  3598. .IERC165
  3599. --
  3600. [.contract-item]
  3601. [[GovernorSettings-constructor-uint48-uint32-uint256-]]
  3602. ==== `[.contract-item-name]#++constructor++#++(uint48 initialVotingDelay, uint32 initialVotingPeriod, uint256 initialProposalThreshold)++` [.item-kind]#internal#
  3603. Initialize the governance parameters.
  3604. [.contract-item]
  3605. [[GovernorSettings-votingDelay--]]
  3606. ==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#
  3607. See {IGovernor-votingDelay}.
  3608. [.contract-item]
  3609. [[GovernorSettings-votingPeriod--]]
  3610. ==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#
  3611. See {IGovernor-votingPeriod}.
  3612. [.contract-item]
  3613. [[GovernorSettings-proposalThreshold--]]
  3614. ==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#
  3615. See {Governor-proposalThreshold}.
  3616. [.contract-item]
  3617. [[GovernorSettings-setVotingDelay-uint48-]]
  3618. ==== `[.contract-item-name]#++setVotingDelay++#++(uint48 newVotingDelay)++` [.item-kind]#public#
  3619. Update the voting delay. This operation can only be performed through a governance proposal.
  3620. Emits a {VotingDelaySet} event.
  3621. [.contract-item]
  3622. [[GovernorSettings-setVotingPeriod-uint32-]]
  3623. ==== `[.contract-item-name]#++setVotingPeriod++#++(uint32 newVotingPeriod)++` [.item-kind]#public#
  3624. Update the voting period. This operation can only be performed through a governance proposal.
  3625. Emits a {VotingPeriodSet} event.
  3626. [.contract-item]
  3627. [[GovernorSettings-setProposalThreshold-uint256-]]
  3628. ==== `[.contract-item-name]#++setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#public#
  3629. Update the proposal threshold. This operation can only be performed through a governance proposal.
  3630. Emits a {ProposalThresholdSet} event.
  3631. [.contract-item]
  3632. [[GovernorSettings-_setVotingDelay-uint48-]]
  3633. ==== `[.contract-item-name]#++_setVotingDelay++#++(uint48 newVotingDelay)++` [.item-kind]#internal#
  3634. Internal setter for the voting delay.
  3635. Emits a {VotingDelaySet} event.
  3636. [.contract-item]
  3637. [[GovernorSettings-_setVotingPeriod-uint32-]]
  3638. ==== `[.contract-item-name]#++_setVotingPeriod++#++(uint32 newVotingPeriod)++` [.item-kind]#internal#
  3639. Internal setter for the voting period.
  3640. Emits a {VotingPeriodSet} event.
  3641. [.contract-item]
  3642. [[GovernorSettings-_setProposalThreshold-uint256-]]
  3643. ==== `[.contract-item-name]#++_setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#internal#
  3644. Internal setter for the proposal threshold.
  3645. Emits a {ProposalThresholdSet} event.
  3646. [.contract-item]
  3647. [[GovernorSettings-VotingDelaySet-uint256-uint256-]]
  3648. ==== `[.contract-item-name]#++VotingDelaySet++#++(uint256 oldVotingDelay, uint256 newVotingDelay)++` [.item-kind]#event#
  3649. [.contract-item]
  3650. [[GovernorSettings-VotingPeriodSet-uint256-uint256-]]
  3651. ==== `[.contract-item-name]#++VotingPeriodSet++#++(uint256 oldVotingPeriod, uint256 newVotingPeriod)++` [.item-kind]#event#
  3652. [.contract-item]
  3653. [[GovernorSettings-ProposalThresholdSet-uint256-uint256-]]
  3654. ==== `[.contract-item-name]#++ProposalThresholdSet++#++(uint256 oldProposalThreshold, uint256 newProposalThreshold)++` [.item-kind]#event#
  3655. :ProposalExtended: pass:normal[xref:#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-[`++ProposalExtended++`]]
  3656. :LateQuorumVoteExtensionSet: pass:normal[xref:#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-[`++LateQuorumVoteExtensionSet++`]]
  3657. :constructor: pass:normal[xref:#GovernorPreventLateQuorum-constructor-uint48-[`++constructor++`]]
  3658. :proposalDeadline: pass:normal[xref:#GovernorPreventLateQuorum-proposalDeadline-uint256-[`++proposalDeadline++`]]
  3659. :_castVote: pass:normal[xref:#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
  3660. :lateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-lateQuorumVoteExtension--[`++lateQuorumVoteExtension++`]]
  3661. :setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint48-[`++setLateQuorumVoteExtension++`]]
  3662. :_setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint48-[`++_setLateQuorumVoteExtension++`]]
  3663. [.contract]
  3664. [[GovernorPreventLateQuorum]]
  3665. === `++GovernorPreventLateQuorum++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorPreventLateQuorum.sol[{github-icon},role=heading-link]
  3666. [.hljs-theme-light.nopadding]
  3667. ```solidity
  3668. import "@openzeppelin/contracts/governance/extensions/GovernorPreventLateQuorum.sol";
  3669. ```
  3670. A module that ensures there is a minimum voting period after quorum is reached. This prevents a large voter from
  3671. swaying a vote and triggering quorum at the last minute, by ensuring there is always time for other voters to react
  3672. and try to oppose the decision.
  3673. If a vote causes quorum to be reached, the proposal's voting period may be extended so that it does not end before at
  3674. least a specified time has passed (the "vote extension" parameter). This parameter can be set through a governance
  3675. proposal.
  3676. [.contract-index]
  3677. .Functions
  3678. --
  3679. * {xref-GovernorPreventLateQuorum-constructor-uint48-}[`++constructor(initialVoteExtension)++`]
  3680. * {xref-GovernorPreventLateQuorum-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  3681. * {xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  3682. * {xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--}[`++lateQuorumVoteExtension()++`]
  3683. * {xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint48-}[`++setLateQuorumVoteExtension(newVoteExtension)++`]
  3684. * {xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint48-}[`++_setLateQuorumVoteExtension(newVoteExtension)++`]
  3685. [.contract-subindex-inherited]
  3686. .Governor
  3687. * {xref-Governor-receive--}[`++receive()++`]
  3688. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  3689. * {xref-Governor-name--}[`++name()++`]
  3690. * {xref-Governor-version--}[`++version()++`]
  3691. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  3692. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  3693. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  3694. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  3695. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  3696. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  3697. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  3698. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  3699. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  3700. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  3701. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  3702. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  3703. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  3704. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  3705. * {xref-Governor-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  3706. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  3707. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  3708. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  3709. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  3710. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  3711. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  3712. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  3713. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  3714. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  3715. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  3716. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  3717. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  3718. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  3719. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  3720. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  3721. * {xref-Governor-_executor--}[`++_executor()++`]
  3722. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  3723. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  3724. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  3725. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  3726. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  3727. * {xref-Governor-clock--}[`++clock()++`]
  3728. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  3729. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  3730. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  3731. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  3732. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  3733. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  3734. [.contract-subindex-inherited]
  3735. .IERC1155Receiver
  3736. [.contract-subindex-inherited]
  3737. .IERC721Receiver
  3738. [.contract-subindex-inherited]
  3739. .IGovernor
  3740. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  3741. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  3742. [.contract-subindex-inherited]
  3743. .IERC6372
  3744. [.contract-subindex-inherited]
  3745. .Nonces
  3746. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  3747. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  3748. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  3749. [.contract-subindex-inherited]
  3750. .EIP712
  3751. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  3752. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  3753. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  3754. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  3755. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  3756. [.contract-subindex-inherited]
  3757. .IERC5267
  3758. [.contract-subindex-inherited]
  3759. .ERC165
  3760. [.contract-subindex-inherited]
  3761. .IERC165
  3762. --
  3763. [.contract-index]
  3764. .Events
  3765. --
  3766. * {xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-}[`++ProposalExtended(proposalId, extendedDeadline)++`]
  3767. * {xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-}[`++LateQuorumVoteExtensionSet(oldVoteExtension, newVoteExtension)++`]
  3768. [.contract-subindex-inherited]
  3769. .Governor
  3770. [.contract-subindex-inherited]
  3771. .IERC1155Receiver
  3772. [.contract-subindex-inherited]
  3773. .IERC721Receiver
  3774. [.contract-subindex-inherited]
  3775. .IGovernor
  3776. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  3777. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  3778. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  3779. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  3780. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  3781. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  3782. [.contract-subindex-inherited]
  3783. .IERC6372
  3784. [.contract-subindex-inherited]
  3785. .Nonces
  3786. [.contract-subindex-inherited]
  3787. .EIP712
  3788. [.contract-subindex-inherited]
  3789. .IERC5267
  3790. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  3791. [.contract-subindex-inherited]
  3792. .ERC165
  3793. [.contract-subindex-inherited]
  3794. .IERC165
  3795. --
  3796. [.contract-index]
  3797. .Errors
  3798. --
  3799. [.contract-subindex-inherited]
  3800. .Governor
  3801. [.contract-subindex-inherited]
  3802. .IERC1155Receiver
  3803. [.contract-subindex-inherited]
  3804. .IERC721Receiver
  3805. [.contract-subindex-inherited]
  3806. .IGovernor
  3807. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  3808. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  3809. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  3810. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  3811. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  3812. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  3813. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  3814. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  3815. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  3816. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  3817. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  3818. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  3819. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  3820. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  3821. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  3822. [.contract-subindex-inherited]
  3823. .IERC6372
  3824. [.contract-subindex-inherited]
  3825. .Nonces
  3826. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  3827. [.contract-subindex-inherited]
  3828. .EIP712
  3829. [.contract-subindex-inherited]
  3830. .IERC5267
  3831. [.contract-subindex-inherited]
  3832. .ERC165
  3833. [.contract-subindex-inherited]
  3834. .IERC165
  3835. --
  3836. [.contract-item]
  3837. [[GovernorPreventLateQuorum-constructor-uint48-]]
  3838. ==== `[.contract-item-name]#++constructor++#++(uint48 initialVoteExtension)++` [.item-kind]#internal#
  3839. Initializes the vote extension parameter: the time in either number of blocks or seconds (depending on the
  3840. governor clock mode) that is required to pass since the moment a proposal reaches quorum until its voting period
  3841. ends. If necessary the voting period will be extended beyond the one set during proposal creation.
  3842. [.contract-item]
  3843. [[GovernorPreventLateQuorum-proposalDeadline-uint256-]]
  3844. ==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#
  3845. Returns the proposal deadline, which may have been extended beyond that set at proposal creation, if the
  3846. proposal reached quorum late in the voting period. See {Governor-proposalDeadline}.
  3847. [.contract-item]
  3848. [[GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-]]
  3849. ==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#
  3850. Casts a vote and detects if it caused quorum to be reached, potentially extending the voting period. See
  3851. {Governor-_castVote}.
  3852. May emit a {ProposalExtended} event.
  3853. [.contract-item]
  3854. [[GovernorPreventLateQuorum-lateQuorumVoteExtension--]]
  3855. ==== `[.contract-item-name]#++lateQuorumVoteExtension++#++() → uint48++` [.item-kind]#public#
  3856. Returns the current value of the vote extension parameter: the number of blocks that are required to pass
  3857. from the time a proposal reaches quorum until its voting period ends.
  3858. [.contract-item]
  3859. [[GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint48-]]
  3860. ==== `[.contract-item-name]#++setLateQuorumVoteExtension++#++(uint48 newVoteExtension)++` [.item-kind]#public#
  3861. Changes the {lateQuorumVoteExtension}. This operation can only be performed by the governance executor,
  3862. generally through a governance proposal.
  3863. Emits a {LateQuorumVoteExtensionSet} event.
  3864. [.contract-item]
  3865. [[GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint48-]]
  3866. ==== `[.contract-item-name]#++_setLateQuorumVoteExtension++#++(uint48 newVoteExtension)++` [.item-kind]#internal#
  3867. Changes the {lateQuorumVoteExtension}. This is an internal function that can be exposed in a public function
  3868. like {setLateQuorumVoteExtension} if another access control mechanism is needed.
  3869. Emits a {LateQuorumVoteExtensionSet} event.
  3870. [.contract-item]
  3871. [[GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-]]
  3872. ==== `[.contract-item-name]#++ProposalExtended++#++(uint256 indexed proposalId, uint64 extendedDeadline)++` [.item-kind]#event#
  3873. Emitted when a proposal deadline is pushed back due to reaching quorum late in its voting period.
  3874. [.contract-item]
  3875. [[GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-]]
  3876. ==== `[.contract-item-name]#++LateQuorumVoteExtensionSet++#++(uint64 oldVoteExtension, uint64 newVoteExtension)++` [.item-kind]#event#
  3877. Emitted when the {lateQuorumVoteExtension} parameter is changed.
  3878. :ProposalDetails: pass:normal[xref:#GovernorStorage-ProposalDetails[`++ProposalDetails++`]]
  3879. :_propose: pass:normal[xref:#GovernorStorage-_propose-address---uint256---bytes---string-address-[`++_propose++`]]
  3880. :queue: pass:normal[xref:#GovernorStorage-queue-uint256-[`++queue++`]]
  3881. :execute: pass:normal[xref:#GovernorStorage-execute-uint256-[`++execute++`]]
  3882. :cancel: pass:normal[xref:#GovernorStorage-cancel-uint256-[`++cancel++`]]
  3883. :proposalCount: pass:normal[xref:#GovernorStorage-proposalCount--[`++proposalCount++`]]
  3884. :proposalDetails: pass:normal[xref:#GovernorStorage-proposalDetails-uint256-[`++proposalDetails++`]]
  3885. :proposalDetailsAt: pass:normal[xref:#GovernorStorage-proposalDetailsAt-uint256-[`++proposalDetailsAt++`]]
  3886. [.contract]
  3887. [[GovernorStorage]]
  3888. === `++GovernorStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/extensions/GovernorStorage.sol[{github-icon},role=heading-link]
  3889. [.hljs-theme-light.nopadding]
  3890. ```solidity
  3891. import "@openzeppelin/contracts/governance/extensions/GovernorStorage.sol";
  3892. ```
  3893. Extension of {Governor} that implements storage of proposal details. This modules also provides primitives for
  3894. the enumerability of proposals.
  3895. Use cases for this module include:
  3896. - UIs that explore the proposal state without relying on event indexing.
  3897. - Using only the proposalId as an argument in the {Governor-queue} and {Governor-execute} functions for L2 chains
  3898. where storage is cheap compared to calldata.
  3899. [.contract-index]
  3900. .Functions
  3901. --
  3902. * {xref-GovernorStorage-_propose-address---uint256---bytes---string-address-}[`++_propose(targets, values, calldatas, description, proposer)++`]
  3903. * {xref-GovernorStorage-queue-uint256-}[`++queue(proposalId)++`]
  3904. * {xref-GovernorStorage-execute-uint256-}[`++execute(proposalId)++`]
  3905. * {xref-GovernorStorage-cancel-uint256-}[`++cancel(proposalId)++`]
  3906. * {xref-GovernorStorage-proposalCount--}[`++proposalCount()++`]
  3907. * {xref-GovernorStorage-proposalDetails-uint256-}[`++proposalDetails(proposalId)++`]
  3908. * {xref-GovernorStorage-proposalDetailsAt-uint256-}[`++proposalDetailsAt(index)++`]
  3909. [.contract-subindex-inherited]
  3910. .Governor
  3911. * {xref-Governor-receive--}[`++receive()++`]
  3912. * {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  3913. * {xref-Governor-name--}[`++name()++`]
  3914. * {xref-Governor-version--}[`++version()++`]
  3915. * {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
  3916. * {xref-Governor-state-uint256-}[`++state(proposalId)++`]
  3917. * {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
  3918. * {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
  3919. * {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
  3920. * {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
  3921. * {xref-Governor-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
  3922. * {xref-Governor-proposalNeedsQueuing-uint256-}[`++proposalNeedsQueuing()++`]
  3923. * {xref-Governor-_checkGovernance--}[`++_checkGovernance()++`]
  3924. * {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
  3925. * {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
  3926. * {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
  3927. * {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
  3928. * {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
  3929. * {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
  3930. * {xref-Governor-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
  3931. * {xref-Governor-_queueOperations-uint256-address---uint256---bytes---bytes32-}[`++_queueOperations(, , , , )++`]
  3932. * {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
  3933. * {xref-Governor-_executeOperations-uint256-address---uint256---bytes---bytes32-}[`++_executeOperations(, targets, values, calldatas, )++`]
  3934. * {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
  3935. * {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
  3936. * {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
  3937. * {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
  3938. * {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
  3939. * {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
  3940. * {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
  3941. * {xref-Governor-castVoteBySig-uint256-uint8-address-bytes-}[`++castVoteBySig(proposalId, support, voter, signature)++`]
  3942. * {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-address-string-bytes-bytes-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, voter, reason, params, signature)++`]
  3943. * {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
  3944. * {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
  3945. * {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
  3946. * {xref-Governor-_executor--}[`++_executor()++`]
  3947. * {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  3948. * {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  3949. * {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  3950. * {xref-Governor-_encodeStateBitmap-enum-IGovernor-ProposalState-}[`++_encodeStateBitmap(proposalState)++`]
  3951. * {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]
  3952. * {xref-Governor-clock--}[`++clock()++`]
  3953. * {xref-Governor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  3954. * {xref-Governor-votingDelay--}[`++votingDelay()++`]
  3955. * {xref-Governor-votingPeriod--}[`++votingPeriod()++`]
  3956. * {xref-Governor-quorum-uint256-}[`++quorum(timepoint)++`]
  3957. * {xref-Governor-BALLOT_TYPEHASH-bytes32}[`++BALLOT_TYPEHASH()++`]
  3958. * {xref-Governor-EXTENDED_BALLOT_TYPEHASH-bytes32}[`++EXTENDED_BALLOT_TYPEHASH()++`]
  3959. [.contract-subindex-inherited]
  3960. .IERC1155Receiver
  3961. [.contract-subindex-inherited]
  3962. .IERC721Receiver
  3963. [.contract-subindex-inherited]
  3964. .IGovernor
  3965. * {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
  3966. * {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
  3967. [.contract-subindex-inherited]
  3968. .IERC6372
  3969. [.contract-subindex-inherited]
  3970. .Nonces
  3971. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  3972. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  3973. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  3974. [.contract-subindex-inherited]
  3975. .EIP712
  3976. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  3977. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  3978. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  3979. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  3980. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  3981. [.contract-subindex-inherited]
  3982. .IERC5267
  3983. [.contract-subindex-inherited]
  3984. .ERC165
  3985. [.contract-subindex-inherited]
  3986. .IERC165
  3987. --
  3988. [.contract-index]
  3989. .Events
  3990. --
  3991. [.contract-subindex-inherited]
  3992. .Governor
  3993. [.contract-subindex-inherited]
  3994. .IERC1155Receiver
  3995. [.contract-subindex-inherited]
  3996. .IERC721Receiver
  3997. [.contract-subindex-inherited]
  3998. .IGovernor
  3999. * {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
  4000. * {xref-IGovernor-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, etaSeconds)++`]
  4001. * {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
  4002. * {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
  4003. * {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
  4004. * {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]
  4005. [.contract-subindex-inherited]
  4006. .IERC6372
  4007. [.contract-subindex-inherited]
  4008. .Nonces
  4009. [.contract-subindex-inherited]
  4010. .EIP712
  4011. [.contract-subindex-inherited]
  4012. .IERC5267
  4013. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  4014. [.contract-subindex-inherited]
  4015. .ERC165
  4016. [.contract-subindex-inherited]
  4017. .IERC165
  4018. --
  4019. [.contract-index]
  4020. .Errors
  4021. --
  4022. [.contract-subindex-inherited]
  4023. .Governor
  4024. [.contract-subindex-inherited]
  4025. .IERC1155Receiver
  4026. [.contract-subindex-inherited]
  4027. .IERC721Receiver
  4028. [.contract-subindex-inherited]
  4029. .IGovernor
  4030. * {xref-IGovernor-GovernorInvalidProposalLength-uint256-uint256-uint256-}[`++GovernorInvalidProposalLength(targets, calldatas, values)++`]
  4031. * {xref-IGovernor-GovernorAlreadyCastVote-address-}[`++GovernorAlreadyCastVote(voter)++`]
  4032. * {xref-IGovernor-GovernorDisabledDeposit--}[`++GovernorDisabledDeposit()++`]
  4033. * {xref-IGovernor-GovernorOnlyProposer-address-}[`++GovernorOnlyProposer(account)++`]
  4034. * {xref-IGovernor-GovernorOnlyExecutor-address-}[`++GovernorOnlyExecutor(account)++`]
  4035. * {xref-IGovernor-GovernorNonexistentProposal-uint256-}[`++GovernorNonexistentProposal(proposalId)++`]
  4036. * {xref-IGovernor-GovernorUnexpectedProposalState-uint256-enum-IGovernor-ProposalState-bytes32-}[`++GovernorUnexpectedProposalState(proposalId, current, expectedStates)++`]
  4037. * {xref-IGovernor-GovernorInvalidVotingPeriod-uint256-}[`++GovernorInvalidVotingPeriod(votingPeriod)++`]
  4038. * {xref-IGovernor-GovernorInsufficientProposerVotes-address-uint256-uint256-}[`++GovernorInsufficientProposerVotes(proposer, votes, threshold)++`]
  4039. * {xref-IGovernor-GovernorRestrictedProposer-address-}[`++GovernorRestrictedProposer(proposer)++`]
  4040. * {xref-IGovernor-GovernorInvalidVoteType--}[`++GovernorInvalidVoteType()++`]
  4041. * {xref-IGovernor-GovernorQueueNotImplemented--}[`++GovernorQueueNotImplemented()++`]
  4042. * {xref-IGovernor-GovernorNotQueuedProposal-uint256-}[`++GovernorNotQueuedProposal(proposalId)++`]
  4043. * {xref-IGovernor-GovernorAlreadyQueuedProposal-uint256-}[`++GovernorAlreadyQueuedProposal(proposalId)++`]
  4044. * {xref-IGovernor-GovernorInvalidSignature-address-}[`++GovernorInvalidSignature(voter)++`]
  4045. [.contract-subindex-inherited]
  4046. .IERC6372
  4047. [.contract-subindex-inherited]
  4048. .Nonces
  4049. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  4050. [.contract-subindex-inherited]
  4051. .EIP712
  4052. [.contract-subindex-inherited]
  4053. .IERC5267
  4054. [.contract-subindex-inherited]
  4055. .ERC165
  4056. [.contract-subindex-inherited]
  4057. .IERC165
  4058. --
  4059. [.contract-item]
  4060. [[GovernorStorage-_propose-address---uint256---bytes---string-address-]]
  4061. ==== `[.contract-item-name]#++_propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description, address proposer) → uint256++` [.item-kind]#internal#
  4062. Hook into the proposing mechanism
  4063. [.contract-item]
  4064. [[GovernorStorage-queue-uint256-]]
  4065. ==== `[.contract-item-name]#++queue++#++(uint256 proposalId)++` [.item-kind]#public#
  4066. Version of {IGovernorTimelock-queue} with only `proposalId` as an argument.
  4067. [.contract-item]
  4068. [[GovernorStorage-execute-uint256-]]
  4069. ==== `[.contract-item-name]#++execute++#++(uint256 proposalId)++` [.item-kind]#public#
  4070. Version of {IGovernor-execute} with only `proposalId` as an argument.
  4071. [.contract-item]
  4072. [[GovernorStorage-cancel-uint256-]]
  4073. ==== `[.contract-item-name]#++cancel++#++(uint256 proposalId)++` [.item-kind]#public#
  4074. ProposalId version of {IGovernor-cancel}.
  4075. [.contract-item]
  4076. [[GovernorStorage-proposalCount--]]
  4077. ==== `[.contract-item-name]#++proposalCount++#++() → uint256++` [.item-kind]#public#
  4078. Returns the number of stored proposals.
  4079. [.contract-item]
  4080. [[GovernorStorage-proposalDetails-uint256-]]
  4081. ==== `[.contract-item-name]#++proposalDetails++#++(uint256 proposalId) → address[], uint256[], bytes[], bytes32++` [.item-kind]#public#
  4082. Returns the details of a proposalId. Reverts if `proposalId` is not a known proposal.
  4083. [.contract-item]
  4084. [[GovernorStorage-proposalDetailsAt-uint256-]]
  4085. ==== `[.contract-item-name]#++proposalDetailsAt++#++(uint256 index) → uint256, address[], uint256[], bytes[], bytes32++` [.item-kind]#public#
  4086. Returns the details (including the proposalId) of a proposal given its sequential index.
  4087. == Utils
  4088. :ERC6372InconsistentClock: pass:normal[xref:#Votes-ERC6372InconsistentClock--[`++ERC6372InconsistentClock++`]]
  4089. :ERC5805FutureLookup: pass:normal[xref:#Votes-ERC5805FutureLookup-uint256-uint48-[`++ERC5805FutureLookup++`]]
  4090. :clock: pass:normal[xref:#Votes-clock--[`++clock++`]]
  4091. :CLOCK_MODE: pass:normal[xref:#Votes-CLOCK_MODE--[`++CLOCK_MODE++`]]
  4092. :getVotes: pass:normal[xref:#Votes-getVotes-address-[`++getVotes++`]]
  4093. :getPastVotes: pass:normal[xref:#Votes-getPastVotes-address-uint256-[`++getPastVotes++`]]
  4094. :getPastTotalSupply: pass:normal[xref:#Votes-getPastTotalSupply-uint256-[`++getPastTotalSupply++`]]
  4095. :_getTotalSupply: pass:normal[xref:#Votes-_getTotalSupply--[`++_getTotalSupply++`]]
  4096. :delegates: pass:normal[xref:#Votes-delegates-address-[`++delegates++`]]
  4097. :delegate: pass:normal[xref:#Votes-delegate-address-[`++delegate++`]]
  4098. :delegateBySig: pass:normal[xref:#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-[`++delegateBySig++`]]
  4099. :_delegate: pass:normal[xref:#Votes-_delegate-address-address-[`++_delegate++`]]
  4100. :_transferVotingUnits: pass:normal[xref:#Votes-_transferVotingUnits-address-address-uint256-[`++_transferVotingUnits++`]]
  4101. :_numCheckpoints: pass:normal[xref:#Votes-_numCheckpoints-address-[`++_numCheckpoints++`]]
  4102. :_checkpoints: pass:normal[xref:#Votes-_checkpoints-address-uint32-[`++_checkpoints++`]]
  4103. :_getVotingUnits: pass:normal[xref:#Votes-_getVotingUnits-address-[`++_getVotingUnits++`]]
  4104. [.contract]
  4105. [[Votes]]
  4106. === `++Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/utils/Votes.sol[{github-icon},role=heading-link]
  4107. [.hljs-theme-light.nopadding]
  4108. ```solidity
  4109. import "@openzeppelin/contracts/governance/utils/Votes.sol";
  4110. ```
  4111. This is a base abstract contract that tracks voting units, which are a measure of voting power that can be
  4112. transferred, and provides a system of vote delegation, where an account can delegate its voting units to a sort of
  4113. "representative" that will pool delegated voting units from different accounts and can then use it to vote in
  4114. decisions. In fact, voting units _must_ be delegated in order to count as actual votes, and an account has to
  4115. delegate those votes to itself if it wishes to participate in decisions and does not have a trusted representative.
  4116. This contract is often combined with a token contract such that voting units correspond to token units. For an
  4117. example, see {ERC721Votes}.
  4118. The full history of delegate votes is tracked on-chain so that governance protocols can consider votes as distributed
  4119. at a particular block number to protect against flash loans and double voting. The opt-in delegate system makes the
  4120. cost of this history tracking optional.
  4121. When using this module the derived contract must implement {_getVotingUnits} (for example, make it return
  4122. {ERC721-balanceOf}), and can use {_transferVotingUnits} to track a change in the distribution of those units (in the
  4123. previous example, it would be included in {ERC721-_update}).
  4124. [.contract-index]
  4125. .Functions
  4126. --
  4127. * {xref-Votes-clock--}[`++clock()++`]
  4128. * {xref-Votes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
  4129. * {xref-Votes-getVotes-address-}[`++getVotes(account)++`]
  4130. * {xref-Votes-getPastVotes-address-uint256-}[`++getPastVotes(account, timepoint)++`]
  4131. * {xref-Votes-getPastTotalSupply-uint256-}[`++getPastTotalSupply(timepoint)++`]
  4132. * {xref-Votes-_getTotalSupply--}[`++_getTotalSupply()++`]
  4133. * {xref-Votes-delegates-address-}[`++delegates(account)++`]
  4134. * {xref-Votes-delegate-address-}[`++delegate(delegatee)++`]
  4135. * {xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-}[`++delegateBySig(delegatee, nonce, expiry, v, r, s)++`]
  4136. * {xref-Votes-_delegate-address-address-}[`++_delegate(account, delegatee)++`]
  4137. * {xref-Votes-_transferVotingUnits-address-address-uint256-}[`++_transferVotingUnits(from, to, amount)++`]
  4138. * {xref-Votes-_numCheckpoints-address-}[`++_numCheckpoints(account)++`]
  4139. * {xref-Votes-_checkpoints-address-uint32-}[`++_checkpoints(account, pos)++`]
  4140. * {xref-Votes-_getVotingUnits-address-}[`++_getVotingUnits()++`]
  4141. [.contract-subindex-inherited]
  4142. .IERC5805
  4143. [.contract-subindex-inherited]
  4144. .IVotes
  4145. [.contract-subindex-inherited]
  4146. .IERC6372
  4147. [.contract-subindex-inherited]
  4148. .Nonces
  4149. * {xref-Nonces-nonces-address-}[`++nonces(owner)++`]
  4150. * {xref-Nonces-_useNonce-address-}[`++_useNonce(owner)++`]
  4151. * {xref-Nonces-_useCheckedNonce-address-uint256-}[`++_useCheckedNonce(owner, nonce)++`]
  4152. [.contract-subindex-inherited]
  4153. .EIP712
  4154. * {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
  4155. * {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
  4156. * {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]
  4157. * {xref-EIP712-_EIP712Name--}[`++_EIP712Name()++`]
  4158. * {xref-EIP712-_EIP712Version--}[`++_EIP712Version()++`]
  4159. [.contract-subindex-inherited]
  4160. .IERC5267
  4161. --
  4162. [.contract-index]
  4163. .Events
  4164. --
  4165. [.contract-subindex-inherited]
  4166. .IERC5805
  4167. [.contract-subindex-inherited]
  4168. .IVotes
  4169. * {xref-IVotes-DelegateChanged-address-address-address-}[`++DelegateChanged(delegator, fromDelegate, toDelegate)++`]
  4170. * {xref-IVotes-DelegateVotesChanged-address-uint256-uint256-}[`++DelegateVotesChanged(delegate, previousVotes, newVotes)++`]
  4171. [.contract-subindex-inherited]
  4172. .IERC6372
  4173. [.contract-subindex-inherited]
  4174. .Nonces
  4175. [.contract-subindex-inherited]
  4176. .EIP712
  4177. [.contract-subindex-inherited]
  4178. .IERC5267
  4179. * {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]
  4180. --
  4181. [.contract-index]
  4182. .Errors
  4183. --
  4184. * {xref-Votes-ERC6372InconsistentClock--}[`++ERC6372InconsistentClock()++`]
  4185. * {xref-Votes-ERC5805FutureLookup-uint256-uint48-}[`++ERC5805FutureLookup(timepoint, clock)++`]
  4186. [.contract-subindex-inherited]
  4187. .IERC5805
  4188. [.contract-subindex-inherited]
  4189. .IVotes
  4190. * {xref-IVotes-VotesExpiredSignature-uint256-}[`++VotesExpiredSignature(expiry)++`]
  4191. [.contract-subindex-inherited]
  4192. .IERC6372
  4193. [.contract-subindex-inherited]
  4194. .Nonces
  4195. * {xref-Nonces-InvalidAccountNonce-address-uint256-}[`++InvalidAccountNonce(account, currentNonce)++`]
  4196. [.contract-subindex-inherited]
  4197. .EIP712
  4198. [.contract-subindex-inherited]
  4199. .IERC5267
  4200. --
  4201. [.contract-item]
  4202. [[Votes-clock--]]
  4203. ==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#
  4204. Clock used for flagging checkpoints. Can be overridden to implement timestamp based
  4205. checkpoints (and voting), in which case {CLOCK_MODE} should be overridden as well to match.
  4206. [.contract-item]
  4207. [[Votes-CLOCK_MODE--]]
  4208. ==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#
  4209. Machine-readable description of the clock as specified in EIP-6372.
  4210. [.contract-item]
  4211. [[Votes-getVotes-address-]]
  4212. ==== `[.contract-item-name]#++getVotes++#++(address account) → uint256++` [.item-kind]#public#
  4213. Returns the current amount of votes that `account` has.
  4214. [.contract-item]
  4215. [[Votes-getPastVotes-address-uint256-]]
  4216. ==== `[.contract-item-name]#++getPastVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#public#
  4217. Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
  4218. configured to use block numbers, this will return the value at the end of the corresponding block.
  4219. Requirements:
  4220. - `timepoint` must be in the past. If operating using block numbers, the block must be already mined.
  4221. [.contract-item]
  4222. [[Votes-getPastTotalSupply-uint256-]]
  4223. ==== `[.contract-item-name]#++getPastTotalSupply++#++(uint256 timepoint) → uint256++` [.item-kind]#public#
  4224. Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
  4225. configured to use block numbers, this will return the value at the end of the corresponding block.
  4226. NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
  4227. Votes that have not been delegated are still part of total supply, even though they would not participate in a
  4228. vote.
  4229. Requirements:
  4230. - `timepoint` must be in the past. If operating using block numbers, the block must be already mined.
  4231. [.contract-item]
  4232. [[Votes-_getTotalSupply--]]
  4233. ==== `[.contract-item-name]#++_getTotalSupply++#++() → uint256++` [.item-kind]#internal#
  4234. Returns the current total supply of votes.
  4235. [.contract-item]
  4236. [[Votes-delegates-address-]]
  4237. ==== `[.contract-item-name]#++delegates++#++(address account) → address++` [.item-kind]#public#
  4238. Returns the delegate that `account` has chosen.
  4239. [.contract-item]
  4240. [[Votes-delegate-address-]]
  4241. ==== `[.contract-item-name]#++delegate++#++(address delegatee)++` [.item-kind]#public#
  4242. Delegates votes from the sender to `delegatee`.
  4243. [.contract-item]
  4244. [[Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-]]
  4245. ==== `[.contract-item-name]#++delegateBySig++#++(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s)++` [.item-kind]#public#
  4246. Delegates votes from signer to `delegatee`.
  4247. [.contract-item]
  4248. [[Votes-_delegate-address-address-]]
  4249. ==== `[.contract-item-name]#++_delegate++#++(address account, address delegatee)++` [.item-kind]#internal#
  4250. Delegate all of `account`'s voting units to `delegatee`.
  4251. Emits events {IVotes-DelegateChanged} and {IVotes-DelegateVotesChanged}.
  4252. [.contract-item]
  4253. [[Votes-_transferVotingUnits-address-address-uint256-]]
  4254. ==== `[.contract-item-name]#++_transferVotingUnits++#++(address from, address to, uint256 amount)++` [.item-kind]#internal#
  4255. Transfers, mints, or burns voting units. To register a mint, `from` should be zero. To register a burn, `to`
  4256. should be zero. Total supply of voting units will be adjusted with mints and burns.
  4257. [.contract-item]
  4258. [[Votes-_numCheckpoints-address-]]
  4259. ==== `[.contract-item-name]#++_numCheckpoints++#++(address account) → uint32++` [.item-kind]#internal#
  4260. Get number of checkpoints for `account`.
  4261. [.contract-item]
  4262. [[Votes-_checkpoints-address-uint32-]]
  4263. ==== `[.contract-item-name]#++_checkpoints++#++(address account, uint32 pos) → struct Checkpoints.Checkpoint208++` [.item-kind]#internal#
  4264. Get the `pos`-th checkpoint for `account`.
  4265. [.contract-item]
  4266. [[Votes-_getVotingUnits-address-]]
  4267. ==== `[.contract-item-name]#++_getVotingUnits++#++(address) → uint256++` [.item-kind]#internal#
  4268. Must return the voting units held by an account.
  4269. [.contract-item]
  4270. [[Votes-ERC6372InconsistentClock--]]
  4271. ==== `[.contract-item-name]#++ERC6372InconsistentClock++#++()++` [.item-kind]#error#
  4272. The clock was incorrectly modified.
  4273. [.contract-item]
  4274. [[Votes-ERC5805FutureLookup-uint256-uint48-]]
  4275. ==== `[.contract-item-name]#++ERC5805FutureLookup++#++(uint256 timepoint, uint48 clock)++` [.item-kind]#error#
  4276. Lookup to future votes is not available.
  4277. == Timelock
  4278. 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}.
  4279. :PROPOSER_ROLE: pass:normal[xref:#TimelockController-PROPOSER_ROLE-bytes32[`++PROPOSER_ROLE++`]]
  4280. :EXECUTOR_ROLE: pass:normal[xref:#TimelockController-EXECUTOR_ROLE-bytes32[`++EXECUTOR_ROLE++`]]
  4281. :CANCELLER_ROLE: pass:normal[xref:#TimelockController-CANCELLER_ROLE-bytes32[`++CANCELLER_ROLE++`]]
  4282. :_DONE_TIMESTAMP: pass:normal[xref:#TimelockController-_DONE_TIMESTAMP-uint256[`++_DONE_TIMESTAMP++`]]
  4283. :OperationState: pass:normal[xref:#TimelockController-OperationState[`++OperationState++`]]
  4284. :TimelockInvalidOperationLength: pass:normal[xref:#TimelockController-TimelockInvalidOperationLength-uint256-uint256-uint256-[`++TimelockInvalidOperationLength++`]]
  4285. :TimelockInsufficientDelay: pass:normal[xref:#TimelockController-TimelockInsufficientDelay-uint256-uint256-[`++TimelockInsufficientDelay++`]]
  4286. :TimelockUnexpectedOperationState: pass:normal[xref:#TimelockController-TimelockUnexpectedOperationState-bytes32-bytes32-[`++TimelockUnexpectedOperationState++`]]
  4287. :TimelockUnexecutedPredecessor: pass:normal[xref:#TimelockController-TimelockUnexecutedPredecessor-bytes32-[`++TimelockUnexecutedPredecessor++`]]
  4288. :TimelockUnauthorizedCaller: pass:normal[xref:#TimelockController-TimelockUnauthorizedCaller-address-[`++TimelockUnauthorizedCaller++`]]
  4289. :CallScheduled: pass:normal[xref:#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-[`++CallScheduled++`]]
  4290. :CallExecuted: pass:normal[xref:#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-[`++CallExecuted++`]]
  4291. :CallSalt: pass:normal[xref:#TimelockController-CallSalt-bytes32-bytes32-[`++CallSalt++`]]
  4292. :Cancelled: pass:normal[xref:#TimelockController-Cancelled-bytes32-[`++Cancelled++`]]
  4293. :MinDelayChange: pass:normal[xref:#TimelockController-MinDelayChange-uint256-uint256-[`++MinDelayChange++`]]
  4294. :constructor: pass:normal[xref:#TimelockController-constructor-uint256-address---address---address-[`++constructor++`]]
  4295. :onlyRoleOrOpenRole: pass:normal[xref:#TimelockController-onlyRoleOrOpenRole-bytes32-[`++onlyRoleOrOpenRole++`]]
  4296. :receive: pass:normal[xref:#TimelockController-receive--[`++receive++`]]
  4297. :supportsInterface: pass:normal[xref:#TimelockController-supportsInterface-bytes4-[`++supportsInterface++`]]
  4298. :isOperation: pass:normal[xref:#TimelockController-isOperation-bytes32-[`++isOperation++`]]
  4299. :isOperationPending: pass:normal[xref:#TimelockController-isOperationPending-bytes32-[`++isOperationPending++`]]
  4300. :isOperationReady: pass:normal[xref:#TimelockController-isOperationReady-bytes32-[`++isOperationReady++`]]
  4301. :isOperationDone: pass:normal[xref:#TimelockController-isOperationDone-bytes32-[`++isOperationDone++`]]
  4302. :getTimestamp: pass:normal[xref:#TimelockController-getTimestamp-bytes32-[`++getTimestamp++`]]
  4303. :getOperationState: pass:normal[xref:#TimelockController-getOperationState-bytes32-[`++getOperationState++`]]
  4304. :getMinDelay: pass:normal[xref:#TimelockController-getMinDelay--[`++getMinDelay++`]]
  4305. :hashOperation: pass:normal[xref:#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-[`++hashOperation++`]]
  4306. :hashOperationBatch: pass:normal[xref:#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-[`++hashOperationBatch++`]]
  4307. :schedule: pass:normal[xref:#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-[`++schedule++`]]
  4308. :scheduleBatch: pass:normal[xref:#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-[`++scheduleBatch++`]]
  4309. :cancel: pass:normal[xref:#TimelockController-cancel-bytes32-[`++cancel++`]]
  4310. :execute: pass:normal[xref:#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-[`++execute++`]]
  4311. :executeBatch: pass:normal[xref:#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-[`++executeBatch++`]]
  4312. :_execute: pass:normal[xref:#TimelockController-_execute-address-uint256-bytes-[`++_execute++`]]
  4313. :updateDelay: pass:normal[xref:#TimelockController-updateDelay-uint256-[`++updateDelay++`]]
  4314. :_encodeStateBitmap: pass:normal[xref:#TimelockController-_encodeStateBitmap-enum-TimelockController-OperationState-[`++_encodeStateBitmap++`]]
  4315. [.contract]
  4316. [[TimelockController]]
  4317. === `++TimelockController++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/governance/TimelockController.sol[{github-icon},role=heading-link]
  4318. [.hljs-theme-light.nopadding]
  4319. ```solidity
  4320. import "@openzeppelin/contracts/governance/TimelockController.sol";
  4321. ```
  4322. Contract module which acts as a timelocked controller. When set as the
  4323. owner of an `Ownable` smart contract, it enforces a timelock on all
  4324. `onlyOwner` maintenance operations. This gives time for users of the
  4325. controlled contract to exit before a potentially dangerous maintenance
  4326. operation is applied.
  4327. By default, this contract is self administered, meaning administration tasks
  4328. have to go through the timelock process. The proposer (resp executor) role
  4329. is in charge of proposing (resp executing) operations. A common use case is
  4330. to position this {TimelockController} as the owner of a smart contract, with
  4331. a multisig or a DAO as the sole proposer.
  4332. [.contract-index]
  4333. .Modifiers
  4334. --
  4335. * {xref-TimelockController-onlyRoleOrOpenRole-bytes32-}[`++onlyRoleOrOpenRole(role)++`]
  4336. --
  4337. [.contract-index]
  4338. .Functions
  4339. --
  4340. * {xref-TimelockController-constructor-uint256-address---address---address-}[`++constructor(minDelay, proposers, executors, admin)++`]
  4341. * {xref-TimelockController-receive--}[`++receive()++`]
  4342. * {xref-TimelockController-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
  4343. * {xref-TimelockController-isOperation-bytes32-}[`++isOperation(id)++`]
  4344. * {xref-TimelockController-isOperationPending-bytes32-}[`++isOperationPending(id)++`]
  4345. * {xref-TimelockController-isOperationReady-bytes32-}[`++isOperationReady(id)++`]
  4346. * {xref-TimelockController-isOperationDone-bytes32-}[`++isOperationDone(id)++`]
  4347. * {xref-TimelockController-getTimestamp-bytes32-}[`++getTimestamp(id)++`]
  4348. * {xref-TimelockController-getOperationState-bytes32-}[`++getOperationState(id)++`]
  4349. * {xref-TimelockController-getMinDelay--}[`++getMinDelay()++`]
  4350. * {xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-}[`++hashOperation(target, value, data, predecessor, salt)++`]
  4351. * {xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-}[`++hashOperationBatch(targets, values, payloads, predecessor, salt)++`]
  4352. * {xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-}[`++schedule(target, value, data, predecessor, salt, delay)++`]
  4353. * {xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-}[`++scheduleBatch(targets, values, payloads, predecessor, salt, delay)++`]
  4354. * {xref-TimelockController-cancel-bytes32-}[`++cancel(id)++`]
  4355. * {xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-}[`++execute(target, value, payload, predecessor, salt)++`]
  4356. * {xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-}[`++executeBatch(targets, values, payloads, predecessor, salt)++`]
  4357. * {xref-TimelockController-_execute-address-uint256-bytes-}[`++_execute(target, value, data)++`]
  4358. * {xref-TimelockController-updateDelay-uint256-}[`++updateDelay(newDelay)++`]
  4359. * {xref-TimelockController-_encodeStateBitmap-enum-TimelockController-OperationState-}[`++_encodeStateBitmap(operationState)++`]
  4360. * {xref-TimelockController-PROPOSER_ROLE-bytes32}[`++PROPOSER_ROLE()++`]
  4361. * {xref-TimelockController-EXECUTOR_ROLE-bytes32}[`++EXECUTOR_ROLE()++`]
  4362. * {xref-TimelockController-CANCELLER_ROLE-bytes32}[`++CANCELLER_ROLE()++`]
  4363. [.contract-subindex-inherited]
  4364. .ERC1155Holder
  4365. * {xref-ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
  4366. * {xref-ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
  4367. [.contract-subindex-inherited]
  4368. .IERC1155Receiver
  4369. [.contract-subindex-inherited]
  4370. .ERC721Holder
  4371. * {xref-ERC721Holder-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
  4372. [.contract-subindex-inherited]
  4373. .IERC721Receiver
  4374. [.contract-subindex-inherited]
  4375. .AccessControl
  4376. * {xref-AccessControl-hasRole-bytes32-address-}[`++hasRole(role, account)++`]
  4377. * {xref-AccessControl-_checkRole-bytes32-}[`++_checkRole(role)++`]
  4378. * {xref-AccessControl-_checkRole-bytes32-address-}[`++_checkRole(role, account)++`]
  4379. * {xref-AccessControl-getRoleAdmin-bytes32-}[`++getRoleAdmin(role)++`]
  4380. * {xref-AccessControl-grantRole-bytes32-address-}[`++grantRole(role, account)++`]
  4381. * {xref-AccessControl-revokeRole-bytes32-address-}[`++revokeRole(role, account)++`]
  4382. * {xref-AccessControl-renounceRole-bytes32-address-}[`++renounceRole(role, callerConfirmation)++`]
  4383. * {xref-AccessControl-_setRoleAdmin-bytes32-bytes32-}[`++_setRoleAdmin(role, adminRole)++`]
  4384. * {xref-AccessControl-_grantRole-bytes32-address-}[`++_grantRole(role, account)++`]
  4385. * {xref-AccessControl-_revokeRole-bytes32-address-}[`++_revokeRole(role, account)++`]
  4386. * {xref-AccessControl-DEFAULT_ADMIN_ROLE-bytes32}[`++DEFAULT_ADMIN_ROLE()++`]
  4387. [.contract-subindex-inherited]
  4388. .ERC165
  4389. [.contract-subindex-inherited]
  4390. .IERC165
  4391. [.contract-subindex-inherited]
  4392. .IAccessControl
  4393. --
  4394. [.contract-index]
  4395. .Events
  4396. --
  4397. * {xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-}[`++CallScheduled(id, index, target, value, data, predecessor, delay)++`]
  4398. * {xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-}[`++CallExecuted(id, index, target, value, data)++`]
  4399. * {xref-TimelockController-CallSalt-bytes32-bytes32-}[`++CallSalt(id, salt)++`]
  4400. * {xref-TimelockController-Cancelled-bytes32-}[`++Cancelled(id)++`]
  4401. * {xref-TimelockController-MinDelayChange-uint256-uint256-}[`++MinDelayChange(oldDuration, newDuration)++`]
  4402. [.contract-subindex-inherited]
  4403. .ERC1155Holder
  4404. [.contract-subindex-inherited]
  4405. .IERC1155Receiver
  4406. [.contract-subindex-inherited]
  4407. .ERC721Holder
  4408. [.contract-subindex-inherited]
  4409. .IERC721Receiver
  4410. [.contract-subindex-inherited]
  4411. .AccessControl
  4412. [.contract-subindex-inherited]
  4413. .ERC165
  4414. [.contract-subindex-inherited]
  4415. .IERC165
  4416. [.contract-subindex-inherited]
  4417. .IAccessControl
  4418. * {xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-}[`++RoleAdminChanged(role, previousAdminRole, newAdminRole)++`]
  4419. * {xref-IAccessControl-RoleGranted-bytes32-address-address-}[`++RoleGranted(role, account, sender)++`]
  4420. * {xref-IAccessControl-RoleRevoked-bytes32-address-address-}[`++RoleRevoked(role, account, sender)++`]
  4421. --
  4422. [.contract-index]
  4423. .Errors
  4424. --
  4425. * {xref-TimelockController-TimelockInvalidOperationLength-uint256-uint256-uint256-}[`++TimelockInvalidOperationLength(targets, payloads, values)++`]
  4426. * {xref-TimelockController-TimelockInsufficientDelay-uint256-uint256-}[`++TimelockInsufficientDelay(delay, minDelay)++`]
  4427. * {xref-TimelockController-TimelockUnexpectedOperationState-bytes32-bytes32-}[`++TimelockUnexpectedOperationState(operationId, expectedStates)++`]
  4428. * {xref-TimelockController-TimelockUnexecutedPredecessor-bytes32-}[`++TimelockUnexecutedPredecessor(predecessorId)++`]
  4429. * {xref-TimelockController-TimelockUnauthorizedCaller-address-}[`++TimelockUnauthorizedCaller(caller)++`]
  4430. [.contract-subindex-inherited]
  4431. .ERC1155Holder
  4432. [.contract-subindex-inherited]
  4433. .IERC1155Receiver
  4434. [.contract-subindex-inherited]
  4435. .ERC721Holder
  4436. [.contract-subindex-inherited]
  4437. .IERC721Receiver
  4438. [.contract-subindex-inherited]
  4439. .AccessControl
  4440. [.contract-subindex-inherited]
  4441. .ERC165
  4442. [.contract-subindex-inherited]
  4443. .IERC165
  4444. [.contract-subindex-inherited]
  4445. .IAccessControl
  4446. * {xref-IAccessControl-AccessControlUnauthorizedAccount-address-bytes32-}[`++AccessControlUnauthorizedAccount(account, neededRole)++`]
  4447. * {xref-IAccessControl-AccessControlBadConfirmation--}[`++AccessControlBadConfirmation()++`]
  4448. --
  4449. [.contract-item]
  4450. [[TimelockController-onlyRoleOrOpenRole-bytes32-]]
  4451. ==== `[.contract-item-name]#++onlyRoleOrOpenRole++#++(bytes32 role)++` [.item-kind]#modifier#
  4452. Modifier to make a function callable only by a certain role. In
  4453. addition to checking the sender's role, `address(0)` 's role is also
  4454. considered. Granting a role to `address(0)` is equivalent to enabling
  4455. this role for everyone.
  4456. [.contract-item]
  4457. [[TimelockController-constructor-uint256-address---address---address-]]
  4458. ==== `[.contract-item-name]#++constructor++#++(uint256 minDelay, address[] proposers, address[] executors, address admin)++` [.item-kind]#public#
  4459. Initializes the contract with the following parameters:
  4460. - `minDelay`: initial minimum delay in seconds for operations
  4461. - `proposers`: accounts to be granted proposer and canceller roles
  4462. - `executors`: accounts to be granted executor role
  4463. - `admin`: optional account to be granted admin role; disable with zero address
  4464. IMPORTANT: The optional admin can aid with initial configuration of roles after deployment
  4465. without being subject to delay, but this role should be subsequently renounced in favor of
  4466. administration through timelocked proposals. Previous versions of this contract would assign
  4467. this admin to the deployer automatically and should be renounced as well.
  4468. [.contract-item]
  4469. [[TimelockController-receive--]]
  4470. ==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#
  4471. Contract might receive/hold ETH as part of the maintenance process.
  4472. [.contract-item]
  4473. [[TimelockController-supportsInterface-bytes4-]]
  4474. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
  4475. See {IERC165-supportsInterface}.
  4476. [.contract-item]
  4477. [[TimelockController-isOperation-bytes32-]]
  4478. ==== `[.contract-item-name]#++isOperation++#++(bytes32 id) → bool++` [.item-kind]#public#
  4479. Returns whether an id corresponds to a registered operation. This
  4480. includes both Waiting, Ready, and Done operations.
  4481. [.contract-item]
  4482. [[TimelockController-isOperationPending-bytes32-]]
  4483. ==== `[.contract-item-name]#++isOperationPending++#++(bytes32 id) → bool++` [.item-kind]#public#
  4484. Returns whether an operation is pending or not. Note that a "pending" operation may also be "ready".
  4485. [.contract-item]
  4486. [[TimelockController-isOperationReady-bytes32-]]
  4487. ==== `[.contract-item-name]#++isOperationReady++#++(bytes32 id) → bool++` [.item-kind]#public#
  4488. Returns whether an operation is ready for execution. Note that a "ready" operation is also "pending".
  4489. [.contract-item]
  4490. [[TimelockController-isOperationDone-bytes32-]]
  4491. ==== `[.contract-item-name]#++isOperationDone++#++(bytes32 id) → bool++` [.item-kind]#public#
  4492. Returns whether an operation is done or not.
  4493. [.contract-item]
  4494. [[TimelockController-getTimestamp-bytes32-]]
  4495. ==== `[.contract-item-name]#++getTimestamp++#++(bytes32 id) → uint256++` [.item-kind]#public#
  4496. Returns the timestamp at which an operation becomes ready (0 for
  4497. unset operations, 1 for done operations).
  4498. [.contract-item]
  4499. [[TimelockController-getOperationState-bytes32-]]
  4500. ==== `[.contract-item-name]#++getOperationState++#++(bytes32 id) → enum TimelockController.OperationState++` [.item-kind]#public#
  4501. Returns operation state.
  4502. [.contract-item]
  4503. [[TimelockController-getMinDelay--]]
  4504. ==== `[.contract-item-name]#++getMinDelay++#++() → uint256++` [.item-kind]#public#
  4505. Returns the minimum delay in seconds for an operation to become valid.
  4506. This value can be changed by executing an operation that calls `updateDelay`.
  4507. [.contract-item]
  4508. [[TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-]]
  4509. ==== `[.contract-item-name]#++hashOperation++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) → bytes32++` [.item-kind]#public#
  4510. Returns the identifier of an operation containing a single
  4511. transaction.
  4512. [.contract-item]
  4513. [[TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-]]
  4514. ==== `[.contract-item-name]#++hashOperationBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt) → bytes32++` [.item-kind]#public#
  4515. Returns the identifier of an operation containing a batch of
  4516. transactions.
  4517. [.contract-item]
  4518. [[TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-]]
  4519. ==== `[.contract-item-name]#++schedule++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#
  4520. Schedule an operation containing a single transaction.
  4521. Emits {CallSalt} if salt is nonzero, and {CallScheduled}.
  4522. Requirements:
  4523. - the caller must have the 'proposer' role.
  4524. [.contract-item]
  4525. [[TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-]]
  4526. ==== `[.contract-item-name]#++scheduleBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#
  4527. Schedule an operation containing a batch of transactions.
  4528. Emits {CallSalt} if salt is nonzero, and one {CallScheduled} event per transaction in the batch.
  4529. Requirements:
  4530. - the caller must have the 'proposer' role.
  4531. [.contract-item]
  4532. [[TimelockController-cancel-bytes32-]]
  4533. ==== `[.contract-item-name]#++cancel++#++(bytes32 id)++` [.item-kind]#public#
  4534. Cancel an operation.
  4535. Requirements:
  4536. - the caller must have the 'canceller' role.
  4537. [.contract-item]
  4538. [[TimelockController-execute-address-uint256-bytes-bytes32-bytes32-]]
  4539. ==== `[.contract-item-name]#++execute++#++(address target, uint256 value, bytes payload, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#
  4540. Execute an (ready) operation containing a single transaction.
  4541. Emits a {CallExecuted} event.
  4542. Requirements:
  4543. - the caller must have the 'executor' role.
  4544. [.contract-item]
  4545. [[TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-]]
  4546. ==== `[.contract-item-name]#++executeBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#
  4547. Execute an (ready) operation containing a batch of transactions.
  4548. Emits one {CallExecuted} event per transaction in the batch.
  4549. Requirements:
  4550. - the caller must have the 'executor' role.
  4551. [.contract-item]
  4552. [[TimelockController-_execute-address-uint256-bytes-]]
  4553. ==== `[.contract-item-name]#++_execute++#++(address target, uint256 value, bytes data)++` [.item-kind]#internal#
  4554. Execute an operation's call.
  4555. [.contract-item]
  4556. [[TimelockController-updateDelay-uint256-]]
  4557. ==== `[.contract-item-name]#++updateDelay++#++(uint256 newDelay)++` [.item-kind]#external#
  4558. Changes the minimum timelock duration for future operations.
  4559. Emits a {MinDelayChange} event.
  4560. Requirements:
  4561. - the caller must be the timelock itself. This can only be achieved by scheduling and later executing
  4562. an operation where the timelock is the target and the data is the ABI-encoded call to this function.
  4563. [.contract-item]
  4564. [[TimelockController-_encodeStateBitmap-enum-TimelockController-OperationState-]]
  4565. ==== `[.contract-item-name]#++_encodeStateBitmap++#++(enum TimelockController.OperationState operationState) → bytes32++` [.item-kind]#internal#
  4566. Encodes a `OperationState` into a `bytes32` representation where each bit enabled corresponds to
  4567. the underlying position in the `OperationState` enum. For example:
  4568. 0x000...1000
  4569. ^^^^^^----- ...
  4570. ^---- Done
  4571. ^--- Ready
  4572. ^-- Waiting
  4573. ^- Unset
  4574. [.contract-item]
  4575. [[TimelockController-PROPOSER_ROLE-bytes32]]
  4576. ==== `[.contract-item-name]#++PROPOSER_ROLE++#++() → bytes32++` [.item-kind]#public#
  4577. [.contract-item]
  4578. [[TimelockController-EXECUTOR_ROLE-bytes32]]
  4579. ==== `[.contract-item-name]#++EXECUTOR_ROLE++#++() → bytes32++` [.item-kind]#public#
  4580. [.contract-item]
  4581. [[TimelockController-CANCELLER_ROLE-bytes32]]
  4582. ==== `[.contract-item-name]#++CANCELLER_ROLE++#++() → bytes32++` [.item-kind]#public#
  4583. [.contract-item]
  4584. [[TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-]]
  4585. ==== `[.contract-item-name]#++CallScheduled++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)++` [.item-kind]#event#
  4586. Emitted when a call is scheduled as part of operation `id`.
  4587. [.contract-item]
  4588. [[TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-]]
  4589. ==== `[.contract-item-name]#++CallExecuted++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data)++` [.item-kind]#event#
  4590. Emitted when a call is performed as part of operation `id`.
  4591. [.contract-item]
  4592. [[TimelockController-CallSalt-bytes32-bytes32-]]
  4593. ==== `[.contract-item-name]#++CallSalt++#++(bytes32 indexed id, bytes32 salt)++` [.item-kind]#event#
  4594. Emitted when new proposal is scheduled with non-zero salt.
  4595. [.contract-item]
  4596. [[TimelockController-Cancelled-bytes32-]]
  4597. ==== `[.contract-item-name]#++Cancelled++#++(bytes32 indexed id)++` [.item-kind]#event#
  4598. Emitted when operation `id` is cancelled.
  4599. [.contract-item]
  4600. [[TimelockController-MinDelayChange-uint256-uint256-]]
  4601. ==== `[.contract-item-name]#++MinDelayChange++#++(uint256 oldDuration, uint256 newDuration)++` [.item-kind]#event#
  4602. Emitted when the minimum delay for future operations is modified.
  4603. [.contract-item]
  4604. [[TimelockController-TimelockInvalidOperationLength-uint256-uint256-uint256-]]
  4605. ==== `[.contract-item-name]#++TimelockInvalidOperationLength++#++(uint256 targets, uint256 payloads, uint256 values)++` [.item-kind]#error#
  4606. Mismatch between the parameters length for an operation call.
  4607. [.contract-item]
  4608. [[TimelockController-TimelockInsufficientDelay-uint256-uint256-]]
  4609. ==== `[.contract-item-name]#++TimelockInsufficientDelay++#++(uint256 delay, uint256 minDelay)++` [.item-kind]#error#
  4610. The schedule operation doesn't meet the minimum delay.
  4611. [.contract-item]
  4612. [[TimelockController-TimelockUnexpectedOperationState-bytes32-bytes32-]]
  4613. ==== `[.contract-item-name]#++TimelockUnexpectedOperationState++#++(bytes32 operationId, bytes32 expectedStates)++` [.item-kind]#error#
  4614. The current state of an operation is not as required.
  4615. The `expectedStates` is a bitmap with the bits enabled for each OperationState enum position
  4616. counting from right to left.
  4617. See {_encodeStateBitmap}.
  4618. [.contract-item]
  4619. [[TimelockController-TimelockUnexecutedPredecessor-bytes32-]]
  4620. ==== `[.contract-item-name]#++TimelockUnexecutedPredecessor++#++(bytes32 predecessorId)++` [.item-kind]#error#
  4621. The predecessor to an operation not yet done.
  4622. [.contract-item]
  4623. [[TimelockController-TimelockUnauthorizedCaller-address-]]
  4624. ==== `[.contract-item-name]#++TimelockUnauthorizedCaller++#++(address caller)++` [.item-kind]#error#
  4625. The caller account is not authorized.
  4626. [[timelock-terminology]]
  4627. ==== Terminology
  4628. * *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.
  4629. * *Operation status:*
  4630. ** *Unset:* An operation that is not part of the timelock mechanism.
  4631. ** *Waiting:* An operation that has been scheduled, before the timer expires.
  4632. ** *Ready:* An operation that has been scheduled, after the timer expires.
  4633. ** *Pending:* An operation that is either waiting or ready.
  4634. ** *Done:* An operation that has been executed.
  4635. * *Predecessor*: An (optional) dependency between operations. An operation can depend on another operation (its predecessor), forcing the execution order of these two operations.
  4636. * *Role*:
  4637. ** *Admin:* An address (smart contract or EOA) that is in charge of granting the roles of Proposer and Executor.
  4638. ** *Proposer:* An address (smart contract or EOA) that is in charge of scheduling (and cancelling) operations.
  4639. ** *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.
  4640. [[timelock-operation]]
  4641. ==== Operation structure
  4642. 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.
  4643. Both operations contain:
  4644. * *Target*, the address of the smart contract that the timelock should operate on.
  4645. * *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.
  4646. * *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:
  4647. ```javascript
  4648. const data = timelock.contract.methods.grantRole(ROLE, ACCOUNT).encodeABI()
  4649. ```
  4650. * *Predecessor*, that specifies a dependency between operations. This dependency is optional. Use `bytes32(0)` if the operation does not have any dependency.
  4651. * *Salt*, used to disambiguate two otherwise identical operations. This can be any random value.
  4652. In the case of batched operations, `target`, `value` and `data` are specified as arrays, which must be of the same length.
  4653. [[timelock-operation-lifecycle]]
  4654. ==== Operation lifecycle
  4655. Timelocked operations are identified by a unique id (their hash) and follow a specific lifecycle:
  4656. `Unset` -> `Pending` -> `Pending` + `Ready` -> `Done`
  4657. * 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.
  4658. * Once the timer expires, the operation automatically gets the `Ready` state. At this point, it can be executed.
  4659. * 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.
  4660. * 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.
  4661. Operations status can be queried using the functions:
  4662. * xref:api:governance.adoc#TimelockController-isOperationPending-bytes32-[`isOperationPending(bytes32)`]
  4663. * xref:api:governance.adoc#TimelockController-isOperationReady-bytes32-[`isOperationReady(bytes32)`]
  4664. * xref:api:governance.adoc#TimelockController-isOperationDone-bytes32-[`isOperationDone(bytes32)`]
  4665. [[timelock-roles]]
  4666. ==== Roles
  4667. [[timelock-admin]]
  4668. ===== Admin
  4669. 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.
  4670. [[timelock-proposer]]
  4671. ===== Proposer
  4672. 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.
  4673. 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.
  4674. This role is identified by the *PROPOSER_ROLE* value: `0xb09aa5aeb3702cfd50b6b62bc4532604938f21248a27a1d5ca736082b6819cc1`
  4675. [[timelock-executor]]
  4676. ===== Executor
  4677. 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.
  4678. This role is identified by the *EXECUTOR_ROLE* value: `0xd8aa0f3194971a2a116679f7c2090f6939c8d4e01a2a8d7e41d55e5351469e63`
  4679. 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.