Cryo Explorer Ethereum Mainnet

Address Contract Verified

Address 0xEC854cC992DC91bc4e2a3Ed5d42a8F3b05cD8427
Balance 0 ETH
Nonce 1
Code Size 12238 bytes
Indexed Transactions 0
External Etherscan · Sourcify

Contract Bytecode

12238 bytes
0x608080604052600436101561001a575b5036612e5057612e50565b60003560e01c9081630407e61c146124985750806314414cc01461247b5780631978c8041461245d5780632037424b1461243f57806322a8b41e146122da5780632ceb8bda1461223c5780632d22f6ba146121475780632e5629db1461211b5780632e993611146120f15780632f8d602e146120d3578063309482d1146120745780633ccfd60b14611fc25780633f4ba83a14611f6b578063431f21da14611bcb578063441069c214611ba9578063454a2ab3146116cb5780634d91e1f7146116a457806351af43b21461168157806356200819146115d0578063571a26a01461153157806358e4101d146114a75780635b8d02d7146114805780635c1e939614610f415780635c975abb14610f1e57806362c665b914610efa578063715018a614610ea157806378bd793514610d6d5780637c76e3fe14610d505780637ee8b2f8146103005780637f9cf04b14610c545780638070849e14610bcb5780638456cb5914610b715780638cd4299114610b4b5780638da5cb5b14610b245780638eef55861461065e5780639038e69314610a5b57806394a898c014610a3d57806396b5a7551461093e5780639f254dd11461086d578063a4563e031461084f578063a4b2bbb4146107e9578063ab25080b146106ef578063bb19dd08146106c3578063cfdbf254146106a7578063d56d229d14610663578063db2e28031461065e578063e71f7b15146105e3578063f17b4fdf146103dc578063f2fde38b1461033a578063f3f4370314610300578063f6e8fa7d146102cf578063fc00e628146102915763fc5284821461026e573861000f565b3461028c57600036600319011261028c576020600354604051908152f35b600080fd5b3461028c57600036600319011261028c57600b54600c54600d54604080514781526020810194909452830191909152606082015280608081015b0390f35b3461028c57606036600319011261028c576102cb6102f4604435602435600435612dc2565b604051918291826125c1565b3461028c57602036600319011261028c576001600160a01b036103216124b3565b16600052600a6020526020604060002054604051908152f35b3461028c57602036600319011261028c576001600160a01b0361035b6124b3565b610363612eae565b1680156103ad576001600160a01b03600054826001600160a01b0319821617600055167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a3005b7f1e4fbdf700000000000000000000000000000000000000000000000000000000600052600060045260246000fd5b3461028c57602036600319011261028c5760043567ffffffffffffffff811161028c5761040d9036906004016124c9565b906104178261273e565b9161042560405193846126c2565b808352601f196104348261273e565b0160005b8181106105cc57505060005b818110610518578360405180916020820160208352815180915260206040840192019060005b818110610478575050500390f35b9193509160206101408261050a6001948851610120809180518452602081015160208501526040810151604085015260608101516060850152608081015160808501526001600160a01b0360a08201511660a08501526bffffffffffffffffffffffff60c08201511660c085015260ff60e08201511660e0850152610100810151151561010085015201511515910152565b01940191019184939261046a565b8061052660019284866127a0565b356000526008602052604060002060ff60066040519261054584612689565b8054845285810154602085015260028101546040850152600381015460608501526004810154608085015260058101546001600160a01b03811660a086015260a01c60c0850152015481811660e0840152818160081c16151561010084015260101c1615156101208201526105ba82876128b0565b526105c581866128b0565b5001610444565b6020906105d7612d30565b82828801015201610438565b3461028c57602036600319011261028c5760043560005260086020526020604060002060068101549060ff8260101c16918261064f575b5081610640575b81610632575b506040519015158152f35b600291500154421082610627565b60018101544210159150610621565b60081c60ff161591508361061a565b61266c565b3461028c57600036600319011261028c5760206040516001600160a01b037f0000000000000000000000008f814c7c75c5e9e0ede0336f535604b1915c1985168152f35b3461028c57600036600319011261028c57602060405160328152f35b3461028c57602036600319011261028c5760043560005260096020526020604060002054604051908152f35b3461028c57604036600319011261028c5760043567ffffffffffffffff811161028c576107209036906004016124c9565b9060243561072d83612756565b9260005b81811061074657604051806102cb87826124fa565b6107518183866127a0565b3590604051917f441069c20000000000000000000000000000000000000000000000000000000083526004830152836024830152600082604481305afa80156107dd576001926000916107bc575b506107aa82886128b0565b526107b581876128b0565b5001610731565b6107d7913d8091833e6107cf81836126c2565b8101906127da565b8761079f565b6040513d6000823e3d90fd5b3461028c57602036600319011261028c5760043560005260086020526020604060002060068101549060ff8260101c169182610840575b508161083157506040519015158152f35b60029150015442101582610627565b60081c60ff1615915083610820565b3461028c57600036600319011261028c576020600b54604051908152f35b3461028c57604036600319011261028c576108866124b3565b7fc0fa8033e4f8c118e016a2c5dcb3679d78c647745edff996486213ca9807be3a60406001600160a01b03602435936108bd612eae565b6108c5612f61565b6108cd612ef0565b169283600052600a602052816000205490818111600014610921576108fd6108f58383612724565b600b54612731565b600b555b84600052600a60205280836000205582519182526020820152a260018055005b61093661092e8284612724565b600b54612724565b600b55610901565b3461028c57602036600319011261028c5760043561095a612eae565b610962612ef0565b806000526008602052604060002060068101805460ff8160101c1615610a285760ff8160081c16610a13576001600160a01b036005840154166109e9576101009061ff001916179055805460005260096020526000604081205554907fe933b4aae08ab9bd538fc4c8f819965cfc818a17985d76a5b9d706b24c032c4e600080a360018055005b7fe48da95b0000000000000000000000000000000000000000000000000000000060005260046000fd5b836338602da160e21b60005260045260246000fd5b8363aff5aad960e01b60005260045260246000fd5b3461028c57600036600319011261028c576020600454604051908152f35b3461028c57600036600319011261028c57610a74612eae565b610a7c612ef0565b600d548015610afa576000600d556000808080846001600160a01b03600754165af1610aa66126e4565b5015610ae9577faa916bb7738886447c333e8803dd7d94e5fcb6acb2f5d5aa6502373dd59dc55b60206001600160a01b036007541692604051908152a260018055005b6327fcd9d160e01b60005260046000fd5b7f67e3990d0000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57600036600319011261028c5760206001600160a01b0360005416604051908152f35b3461028c57602036600319011261028c576020610b69600435612d7b565b604051908152f35b3461028c57600036600319011261028c57610b8a612eae565b610b92612f2b565b600160ff1960025416176002557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a2586020604051338152a1005b3461028c57602036600319011261028c57600435610be7612eae565b620151808111610c2a5760407f9f36a7073b2ef0cd05389879d8a123028d49443ce64a74fcc826744e972f417091600554908060055582519182526020820152a1005b7fe1272c4a0000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57602036600319011261028c576001600160a01b03610c756124b3565b610c7d612eae565b610c85612f61565b610c8d612ef0565b1680600052600a602052604060002054908115610afa5780600052600a60205260006040812055610cc082600b54612724565b600b556000808080856001600160a01b03600754165af1610cdf6126e4565b5015610d22577f6ba41f42944c63e6df84e7fcbb7a9c3fa8f9ebb3af9677856a5b634db9d657b360206001600160a01b036007541693604051908152a360018055005b90610d3e91600052600a60205280604060002055600b54612731565b506327fcd9d160e01b60005260046000fd5b3461028c57600036600319011261028c5760206040516103e88152f35b3461028c57602036600319011261028c57610d86612d30565b506004356000526008602052610140604060002060ff600660405192610dab84612689565b805484526001810154602085015260028101546040850152600381015460608501526004810154608085015260058101546001600160a01b03811660a086015260a01c60c0850152015481811660e0840152818160081c16151561010084015260101c161515610120820152610e9f6040518092610120809180518452602081015160208501526040810151604085015260608101516060850152608081015160808501526001600160a01b0360a08201511660a08501526bffffffffffffffffffffffff60c08201511660c085015260ff60e08201511660e0850152610100810151151561010085015201511515910152565bf35b3461028c57600036600319011261028c57610eba612eae565b60006001600160a01b0381546001600160a01b031981168355167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a3005b3461028c57600036600319011261028c576020604051683635c9adc5dea000008152f35b3461028c57600036600319011261028c57602060ff600254166040519015158152f35b3461028c57608036600319011261028c5760043567ffffffffffffffff811161028c57610f729036906004016124c9565b60243590604435606435610f84612eae565b610f8c612f2b565b8215611456576032831161142c578115611387578015611423575b60045481106113f95760405163e985e9c560e01b81526001600160a01b037f0000000000000000000000008f814c7c75c5e9e0ede0336f535604b1915c1985166004820181905230602483015290602081604481855afa9081156107dd576000916113ca575b50156113b95761101c84612cfe565b9480156113b157905b61102f8483612731565b428111156113875760005b8681106110ea57505050506040519160a0835261105a60a0840186612638565b9583870360208501528487527f07ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff851161028c576102cb968560209486947f6e4b338a3d5826de5c5e1339a27b9aef2ed07baab677a8f4917f29056c604c4b9860051b80958886013760408601526060850152608084015201030190a1604051918291602083526020830190612638565b6110f581888b6127a0565b3560405163d5abeb0160e01b8152602081600481885afa9081156107dd57600091611356575b508110156112d257806000526009602052604060002054611342576040516331a9108f60e11b8152816004820152602081602481885afa80156107dd5785916000916112fc575b506001600160a01b0316036112d2576003546001810160035560045460405161118a81612689565b8381526020808201898152604080840189815260608501958652608085018d8152600060a080880182815260c0890183815260e08a018481526101008b0185815260016101208d018181528f88526008909c52989095209a518b559751968a01969096559351600289015597516003880155905160048701559051915190951b6001600160a01b0319166001600160a01b0390911617600584015592909192516006939093018054915161ffff1990921660ff9094169390931790151560081b61ff001617825551151581549060101b62ff0000169062ff000019161790558160005260096020528060406000205580611284848c6128b0565b52600454604080518881526020810187905290810191909152606081018890527f5fbba63870d521bdef10028b188e60430d21c37fb6fa3782add98c4154ab8fb490608090a360010161103a565b7f3f6cc7680000000000000000000000000000000000000000000000000000000060005260046000fd5b91506020823d821161133a575b81611316602093836126c2565b8101031261133757506001600160a01b0361133186926127c6565b90611162565b80fd5b3d9150611309565b633d04f6ad60e11b60005260045260246000fd5b906020823d821161137f575b8161136f602093836126c2565b810103126113375750518b61111b565b3d9150611362565b7f761664010000000000000000000000000000000000000000000000000000000060005260046000fd5b504290611025565b630772f59360e21b60005260046000fd5b6113ec915060203d6020116113f2575b6113e481836126c2565b8101906128c4565b8761100d565b503d6113da565b7ffb33f9b50000000000000000000000000000000000000000000000000000000060005260046000fd5b50600454610fa7565b7f205fff950000000000000000000000000000000000000000000000000000000060005260046000fd5b7f736195330000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57600036600319011261028c5760206001600160a01b0360075416604051908152f35b3461028c57602036600319011261028c5760043567ffffffffffffffff811161028c576114d89036906004016124c9565b906114e282612cfe565b9160005b81811061150357604051602080825281906102cb90820187612638565b8061151160019284866127a0565b35600052600960205260406000205461152a82876128b0565b52016114e6565b3461028c57602036600319011261028c576004356000526008602052610140604060002060ff81549160018101549060028101546003820154600483015491600660058501549401549460405197885260208801526040870152606086015260808501526001600160a01b03811660a085015260a01c60c084015281811660e0840152818160081c16151561010084015260101c161515610120820152f35b3461028c57602036600319011261028c576115e96124b3565b6115f1612eae565b6001600160a01b03811690811561165757600780546001600160a01b03198116939093179055604080516001600160a01b0393841681529190921660208201527fba2be5e898fed1646bc0814dee1cc9a2aee98f51fced7d5fc4699c47d99077539190a1005b7fb942d9200000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57600036600319011261028c57602060405167016345785d8a00008152f35b3461028c57600036600319011261028c5760206040516bffffffffffffffffffffffff8152f35b602036600319011261028c576004356116e2612ef0565b6116ea612f2b565b80600052600860205260406000206006810190815460ff8160101c1615610a285760081c60ff16611b945760018101544210611b7f5760028101908154421015611b51576bffffffffffffffffffffffff3411611b27576003810154803410611a9b57506004810154803410611af657506005019081546001600160a01b03811690338214611acc57859082159081159081611a5f575b3460a081811b6001600160a01b03191633179098556bffffffffffffffffffffffff16961c9115611a42576117b834600c54612731565b600c555b61199c575b5050508054926117d14285612724565b6005541161191c575b505082600052600e6020526040600020906040516117f7816126a6565b33815260208101918252604081019263ffffffff421684528054680100000000000000008110156119065761183191600182018155612c12565b6118f0579051915160a01b6001600160a01b0319166001600160a01b039290921691909117815563ffffffff9060010191511663ffffffff19825416179055817fe0771bb8191f40e2c9380d044dd32271d56e14b7722162d048aa9ebe13eefbb1604051806118b433954234846040919493926060820195825260208201520152565b0390a3604051903482524260208301527ffa9550b623f149a32fb3dd34c1632d6332ce39ba524f5cdd4a98dace0726a19f60403393a360018055005b634e487b7160e01b600052600060045260246000fd5b634e487b7160e01b600052604160045260246000fd5b90925060ff8154166103e88110156119725760ff811461195c57600160ff91011660ff1982541617905561195260065442612731565b80925583806117da565b634e487b7160e01b600052601160045260246000fd5b7fe445b2920000000000000000000000000000000000000000000000000000000060005260046000fd5b600080808084876161a8f16119af6126e4565b50156119e95760207fa59312996dc68b7f0224b341fed75d5afeb3bb20624107d37942d14f5942815691604051908152a35b8484816117c1565b60207f76dcf7f6501ec52bd675dfb131e8d2d099a40be2f4c2523b37b95d9208e83f5b9184600052600a82526040600020611a25828254612731565b9055611a3381600b54612731565b600b55604051908152a36119e1565b611a57611a4f8334612724565b600c54612731565b600c556117bc565b809192935060a01c6101f48102908082046101f4148115171561195c57612710611a8a920490612731565b803410611a9b575090879291611781565b7ff0defc61000000000000000000000000000000000000000000000000000000006000526004523460245260446000fd5b7faae645b60000000000000000000000000000000000000000000000000000000060005260046000fd5b7fa0859643000000000000000000000000000000000000000000000000000000006000526004523460245260446000fd5b7fc9b80cd40000000000000000000000000000000000000000000000000000000060005260046000fd5b837f45806e510000000000000000000000000000000000000000000000000000000060005260045260246000fd5b8263aff5aad960e01b60005260045260246000fd5b826338602da160e21b60005260045260246000fd5b3461028c57604036600319011261028c576102cb6102f4602435600435612c64565b3461028c57608036600319011261028c57602435600435604435606435611bf0612eae565b611bf8612f2b565b8115611387576001600160a01b037f0000000000000000000000008f814c7c75c5e9e0ede0336f535604b1915c19851660405163d5abeb0160e01b8152602081600481855afa9081156107dd57600091611f39575b508410156112d257836000526009602052604060002054611f24576040516331a9108f60e11b8152846004820152602081602481855afa80156107dd578291600091611ee0575b506001600160a01b0316036112d25760405163e985e9c560e01b81526001600160a01b038216600482015230602482015290602090829060449082905afa9081156107dd57600091611ec1575b50156113b9578015611eb8575b600454918282106113f9576003805460018101909155948015611ead57611d1790915b82612731565b9042821115611387578593604051611d2e81612689565b86815260208101908382526040810190858252606081019384526080810187815260a08201906000825260c08301906000825260e08401966000885261010085019560008752610120860197600189528d60005260086020526040600020965187555160018701555160028601555160038501555160048401556005830191516001600160a01b03166001600160a01b031682546001600160a01b031916178255516bffffffffffffffffffffffff16611e0291906001600160a01b036001600160a01b031983549260a01b169116179055565b92516006939093018054915161ffff1990921660ff9094169390931790151560081b61ff001617825551151581549060101b62ff0000169062ff000019161790558460005260096020528360406000205560045492604051938493611e7e93859094939260609260808301968352602083015260408201520152565b037f5fbba63870d521bdef10028b188e60430d21c37fb6fa3782add98c4154ab8fb491a3604051908152602090f35b50611d174291611d11565b50600454611cee565b611eda915060203d6020116113f2576113e481836126c2565b85611ce1565b9150506020813d602011611f1c575b81611efc602093836126c2565b8101031261028c576001600160a01b03611f1683926127c6565b90611c94565b3d9150611eef565b83633d04f6ad60e11b60005260045260246000fd5b90506020813d602011611f63575b81611f54602093836126c2565b8101031261028c575186611c4d565b3d9150611f47565b3461028c57600036600319011261028c57611f84612eae565b611f8c612f61565b60ff19600254166002557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa6020604051338152a1005b3461028c57600036600319011261028c57611fdb612ef0565b33600052600a6020526040600020548015610afa5733600052600a6020526000604081205561200c81600b54612724565b600b55600080808084335af16120206126e4565b5015612058576040519081527feaff4b37086828766ad3268786972c0cd24259d4c87a80f9d3963a3c3d999b0d60203392a260018055005b610d3e9033600052600a60205280604060002055600b54612731565b3461028c57602036600319011261028c57600435612090612eae565b620151808111610c2a5760407f8f1716f4a1460fc889ee1b65f689fd7c6e36740f20717b5f96b810eb46e210d391600654908060065582519182526020820152a1005b3461028c57600036600319011261028c576020600c54604051908152f35b3461028c57602036600319011261028c5761210a612ef0565b6121156004356128dc565b60018055005b3461028c57602036600319011261028c57600435600052600e6020526020604060002054604051908152f35b3461028c57606036600319011261028c5760043567ffffffffffffffff811161028c576121789036906004016124c9565b9060443560243561218884612756565b9360005b8181106121a157604051806102cb88826124fa565b806000846121b18794868a6127a0565b6040517ff6e8fa7d000000000000000000000000000000000000000000000000000000008152903560048201526024810191909152604481019390935282606481305afa80156107dd57600192600091612223575b5061221182896128b0565b5261221c81886128b0565b500161218c565b612236913d8091833e6107cf81836126c2565b88612206565b3461028c57602036600319011261028c57600435612258612eae565b67016345785d8a000081106122b057683635c9adc5dea0000081116122b05760407fe4c0778ec3187c088833022fc8c6a2b55903251c6d43e584506bf511f4f52ded91600454908060045582519182526020820152a1005b7fd62a23920000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57602036600319011261028c576001600160a01b036122fb6124b3565b612303612eae565b61230b612ef0565b1680600052600a60205260406000205480156124155760008080808486612710f16123346126e4565b50156123895760207feaff4b37086828766ad3268786972c0cd24259d4c87a80f9d3963a3c3d999b0d9183600052600a82526000604081205561237981600b54612724565b600b55604051908152a260018055005b81600052600a602052600060408120556123a581600b54612724565b600b556000808080846001600160a01b03600754165af16123c46126e4565b50156123fa5760207ff80ced89b96044fe3ce5b0d1111d1d0089cb506bfa9303a90efdda44a8c73eb391604051908152a2612115565b610d3e91600052600a60205280604060002055600b54612731565b7f91663d8c0000000000000000000000000000000000000000000000000000000060005260046000fd5b3461028c57600036600319011261028c576020600654604051908152f35b3461028c57600036600319011261028c576020600554604051908152f35b3461028c57600036600319011261028c5760206040516101f48152f35b3461028c57600036600319011261028c57602090600d548152f35b600435906001600160a01b038216820361028c57565b9181601f8401121561028c5782359167ffffffffffffffff831161028c576020808501948460051b01011161028c57565b602081016020825282518091526040820191602060408360051b8301019401926000915b83831061252d57505050505090565b9091929394603f19828203018352855190602080835192838152019201906000905b80821061256e575050506020806001929701930193019193929061251e565b90919260206125b760019286519063ffffffff60406060936001600160a01b0381511684526bffffffffffffffffffffffff602082015116602085015201511660408201520190565b940192019061254f565b602060408183019282815284518094520192019060005b8181106125e55750505090565b909192602061262e60019286519063ffffffff60406060936001600160a01b0381511684526bffffffffffffffffffffffff602082015116602085015201511660408201520190565b94019291016125d8565b906020808351928381520192019060005b8181106126565750505090565b8251845260209384019390920191600101612649565b3461028c57600036600319011261028c57602060405161012c8152f35b610140810190811067ffffffffffffffff82111761190657604052565b6060810190811067ffffffffffffffff82111761190657604052565b90601f8019910116810190811067ffffffffffffffff82111761190657604052565b3d1561271f573d9067ffffffffffffffff82116119065760405191612713601f8201601f1916602001846126c2565b82523d6000602084013e565b606090565b9190820391821161195c57565b9190820180921161195c57565b67ffffffffffffffff81116119065760051b60200190565b906127608261273e565b61276d60405191826126c2565b828152809261277e601f199161273e565b019060005b82811061278f57505050565b806060602080938501015201612783565b91908110156127b05760051b0190565b634e487b7160e01b600052603260045260246000fd5b51906001600160a01b038216820361028c57565b60208183031261028c5780519067ffffffffffffffff821161028c570181601f8201121561028c5780519061280e8261273e565b9261281c60405194856126c2565b8284526020606081860194028301019181831161028c57602001925b828410612846575050505090565b60608483031261028c576040519061285d826126a6565b612866856127c6565b825260208501516bffffffffffffffffffffffff8116810361028c57602083015260408501519063ffffffff8216820361028c578260209260406060950152815201930192612838565b80518210156127b05760209160051b010190565b9081602091031261028c5751801515810361028c5790565b600081815260086020526040812091600683019283549060ff8260101c1615612b4b5760028101544210612b1f5760ff8260081c16612b0c5760058101916001600160a01b0383541615612ac5575060405163e985e9c560e01b81526001600160a01b037f0000000000000000000000008f814c7c75c5e9e0ede0336f535604b1915c1985166004820181905230602483015295906020816044818a5afa908115612aba578691612a9b575b5015612a8c5761010061ff00198254161790555492815460a01c946129af86600c54612724565b600c556129be86600d54612731565b600d5584825260096020528160408120556001600160a01b03835416813b15612a885782916064839260405194859384927f42842e0e00000000000000000000000000000000000000000000000000000000845281600485015260248401528a60448401525af18015612a7d57926020926001600160a01b03927fa3f81c0e157dc1e05cb31e254314bbde8e3878d9ff78b10ef6abfe316492bfbe95612a6d575b5050541694604051908152a4565b81612a77916126c2565b38612a5f565b6040513d84823e3d90fd5b8280fd5b600485630772f59360e21b8152fd5b612ab4915060203d6020116113f2576113e481836126c2565b38612988565b6040513d88823e3d90fd5b61ff001916610100179094555082548252600960205260408220829055915491907fe933b4aae08ab9bd538fc4c8f819965cfc818a17985d76a5b9d706b24c032c4e9080a3565b602484846338602da160e21b8252600452fd5b602484847fe30e8d47000000000000000000000000000000000000000000000000000000008252600452fd5b6024848463aff5aad960e01b8252600452fd5b60405190612b6d6020836126c2565b600080835282815b828110612b8157505050565b602090604051612b90816126a6565b600081526000838201526000604082015282828501015201612b75565b90612bb78261273e565b612bc460405191826126c2565b8281528092612bd5601f199161273e565b019060005b828110612be657505050565b602090604051612bf5816126a6565b600081526000838201526000604082015282828501015201612bda565b80548210156127b05760005260206000209060011b0190600090565b90604051612c3b816126a6565b604063ffffffff6001839580546001600160a01b038116865260a01c6020860152015416910152565b600052600e6020526040600020908154908115612cf05781811115612ce55750612c8e8180612724565b91612c9882612bad565b9260005b838110612caa575050505090565b80612cc9612cc3612cbd60019486612731565b86612c12565b50612c2e565b612cd382886128b0565b52612cde81876128b0565b5001612c9c565b612c8e908092612724565b505050612cfb612b5e565b90565b90612d088261273e565b612d1560405191826126c2565b8281528092612d26601f199161273e565b0190602036910137565b60405190612d3d82612689565b6000610120838281528260208201528260408201528260608201528260808201528260a08201528260c08201528260e0820152826101008201520152565b6000526008602052604060002060ff600682015460101c16158015612db4575b612dae576002612cfb9101544290612724565b50600090565b506002810154421015612d9b565b919091600052600e602052604060002090815480841015612e445781818592612df19411612e3c575b50612724565b90612dfb82612bad565b9260005b838110612e0d575050505090565b80612e20612cc3612cbd60019486612731565b612e2a82886128b0565b52612e3581876128b0565b5001612dff565b905038612deb565b50505050612cfb612b5e565b60646040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601260248201527f5573652062696428292066756e6374696f6e00000000000000000000000000006044820152fd5b6001600160a01b03600054163303612ec257565b7f118cdaa7000000000000000000000000000000000000000000000000000000006000523360045260246000fd5b600260015414612f01576002600155565b7f3ee5aeb50000000000000000000000000000000000000000000000000000000060005260046000fd5b60ff60025416612f3757565b7fd93c06650000000000000000000000000000000000000000000000000000000060005260046000fd5b60ff6002541615612f6e57565b7f8dfc202b0000000000000000000000000000000000000000000000000000000060005260046000fdfea2646970667358221220227e05c5cd46ebf095cd6e03eb8ec9bfd52cf984e7ffdff89f61a063339e3e9264736f6c634300081c0033

Verified Source Code Full Match

Compiler: v0.8.28+commit.7893614a EVM: paris Optimization: Yes (1000 runs)
Ownable.sol 100 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)

pragma solidity ^0.8.20;

import {Context} from "../utils/Context.sol";

/**
 * @dev Contract module which provides a basic access control mechanism, where
 * there is an account (an owner) that can be granted exclusive access to
 * specific functions.
 *
 * The initial owner is set to the address provided by the deployer. This can
 * later be changed with {transferOwnership}.
 *
 * This module is used through inheritance. It will make available the modifier
 * `onlyOwner`, which can be applied to your functions to restrict their use to
 * the owner.
 */
abstract contract Ownable is Context {
    address private _owner;

    /**
     * @dev The caller account is not authorized to perform an operation.
     */
    error OwnableUnauthorizedAccount(address account);

    /**
     * @dev The owner is not a valid owner account. (eg. `address(0)`)
     */
    error OwnableInvalidOwner(address owner);

    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

    /**
     * @dev Initializes the contract setting the address provided by the deployer as the initial owner.
     */
    constructor(address initialOwner) {
        if (initialOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(initialOwner);
    }

    /**
     * @dev Throws if called by any account other than the owner.
     */
    modifier onlyOwner() {
        _checkOwner();
        _;
    }

    /**
     * @dev Returns the address of the current owner.
     */
    function owner() public view virtual returns (address) {
        return _owner;
    }

    /**
     * @dev Throws if the sender is not the owner.
     */
    function _checkOwner() internal view virtual {
        if (owner() != _msgSender()) {
            revert OwnableUnauthorizedAccount(_msgSender());
        }
    }

    /**
     * @dev Leaves the contract without owner. It will not be possible to call
     * `onlyOwner` functions. Can only be called by the current owner.
     *
     * NOTE: Renouncing ownership will leave the contract without an owner,
     * thereby disabling any functionality that is only available to the owner.
     */
    function renounceOwnership() public virtual onlyOwner {
        _transferOwnership(address(0));
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Can only be called by the current owner.
     */
    function transferOwnership(address newOwner) public virtual onlyOwner {
        if (newOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(newOwner);
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Internal function without access restriction.
     */
    function _transferOwnership(address newOwner) internal virtual {
        address oldOwner = _owner;
        _owner = newOwner;
        emit OwnershipTransferred(oldOwner, newOwner);
    }
}
draft-IERC6093.sol 161 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;

/**
 * @dev Standard ERC-20 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
 */
interface IERC20Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC20InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC20InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     * @param allowance Amount of tokens a `spender` is allowed to operate with.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC20InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `spender` to be approved. Used in approvals.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC20InvalidSpender(address spender);
}

/**
 * @dev Standard ERC-721 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
 */
interface IERC721Errors {
    /**
     * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
     * Used in balance queries.
     * @param owner Address of the current owner of a token.
     */
    error ERC721InvalidOwner(address owner);

    /**
     * @dev Indicates a `tokenId` whose `owner` is the zero address.
     * @param tokenId Identifier number of a token.
     */
    error ERC721NonexistentToken(uint256 tokenId);

    /**
     * @dev Indicates an error related to the ownership over a particular token. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param tokenId Identifier number of a token.
     * @param owner Address of the current owner of a token.
     */
    error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC721InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC721InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param tokenId Identifier number of a token.
     */
    error ERC721InsufficientApproval(address operator, uint256 tokenId);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC721InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC721InvalidOperator(address operator);
}

/**
 * @dev Standard ERC-1155 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
 */
interface IERC1155Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     * @param tokenId Identifier number of a token.
     */
    error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC1155InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC1155InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param owner Address of the current owner of a token.
     */
    error ERC1155MissingApprovalForAll(address operator, address owner);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC1155InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC1155InvalidOperator(address operator);

    /**
     * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
     * Used in batch transfers.
     * @param idsLength Length of the array of token identifiers
     * @param valuesLength Length of the array of token amounts
     */
    error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}
IERC20.sol 79 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol)

pragma solidity >=0.4.16;

/**
 * @dev Interface of the ERC-20 standard as defined in the ERC.
 */
interface IERC20 {
    /**
     * @dev Emitted when `value` tokens are moved from one account (`from`) to
     * another (`to`).
     *
     * Note that `value` may be zero.
     */
    event Transfer(address indexed from, address indexed to, uint256 value);

    /**
     * @dev Emitted when the allowance of a `spender` for an `owner` is set by
     * a call to {approve}. `value` is the new allowance.
     */
    event Approval(address indexed owner, address indexed spender, uint256 value);

    /**
     * @dev Returns the value of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

    /**
     * @dev Returns the value of tokens owned by `account`.
     */
    function balanceOf(address account) external view returns (uint256);

    /**
     * @dev Moves a `value` amount of tokens from the caller's account to `to`.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transfer(address to, uint256 value) external returns (bool);

    /**
     * @dev Returns the remaining number of tokens that `spender` will be
     * allowed to spend on behalf of `owner` through {transferFrom}. This is
     * zero by default.
     *
     * This value changes when {approve} or {transferFrom} are called.
     */
    function allowance(address owner, address spender) external view returns (uint256);

    /**
     * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
     * caller's tokens.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * IMPORTANT: Beware that changing an allowance with this method brings the risk
     * that someone may use both the old and the new allowance by unfortunate
     * transaction ordering. One possible solution to mitigate this race
     * condition is to first reduce the spender's allowance to 0 and set the
     * desired value afterwards:
     * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
     *
     * Emits an {Approval} event.
     */
    function approve(address spender, uint256 value) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to` using the
     * allowance mechanism. `value` is then deducted from the caller's
     * allowance.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 value) external returns (bool);
}
ERC721.sol 430 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/ERC721.sol)

pragma solidity ^0.8.20;

import {IERC721} from "./IERC721.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {ERC721Utils} from "./utils/ERC721Utils.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.sol";

/**
 * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC-721] Non-Fungible Token Standard, including
 * the Metadata extension, but not including the Enumerable extension, which is available separately as
 * {ERC721Enumerable}.
 */
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
    using Strings for uint256;

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

    mapping(uint256 tokenId => address) private _owners;

    mapping(address owner => uint256) private _balances;

    mapping(uint256 tokenId => address) private _tokenApprovals;

    mapping(address owner => mapping(address operator => bool)) private _operatorApprovals;

    /**
     * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

    /// @inheritdoc IERC165
    function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
        return
            interfaceId == type(IERC721).interfaceId ||
            interfaceId == type(IERC721Metadata).interfaceId ||
            super.supportsInterface(interfaceId);
    }

    /// @inheritdoc IERC721
    function balanceOf(address owner) public view virtual returns (uint256) {
        if (owner == address(0)) {
            revert ERC721InvalidOwner(address(0));
        }
        return _balances[owner];
    }

    /// @inheritdoc IERC721
    function ownerOf(uint256 tokenId) public view virtual returns (address) {
        return _requireOwned(tokenId);
    }

    /// @inheritdoc IERC721Metadata
    function name() public view virtual returns (string memory) {
        return _name;
    }

    /// @inheritdoc IERC721Metadata
    function symbol() public view virtual returns (string memory) {
        return _symbol;
    }

    /// @inheritdoc IERC721Metadata
    function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
        _requireOwned(tokenId);

        string memory baseURI = _baseURI();
        return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenId.toString()) : "";
    }

    /**
     * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
     * token will be the concatenation of the `baseURI` and the `tokenId`. Empty
     * by default, can be overridden in child contracts.
     */
    function _baseURI() internal view virtual returns (string memory) {
        return "";
    }

    /// @inheritdoc IERC721
    function approve(address to, uint256 tokenId) public virtual {
        _approve(to, tokenId, _msgSender());
    }

    /// @inheritdoc IERC721
    function getApproved(uint256 tokenId) public view virtual returns (address) {
        _requireOwned(tokenId);

        return _getApproved(tokenId);
    }

    /// @inheritdoc IERC721
    function setApprovalForAll(address operator, bool approved) public virtual {
        _setApprovalForAll(_msgSender(), operator, approved);
    }

    /// @inheritdoc IERC721
    function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
        return _operatorApprovals[owner][operator];
    }

    /// @inheritdoc IERC721
    function transferFrom(address from, address to, uint256 tokenId) public virtual {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        // Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
        // (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
        address previousOwner = _update(to, tokenId, _msgSender());
        if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /// @inheritdoc IERC721
    function safeTransferFrom(address from, address to, uint256 tokenId) public {
        safeTransferFrom(from, to, tokenId, "");
    }

    /// @inheritdoc IERC721
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
        transferFrom(from, to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
    }

    /**
     * @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
     *
     * IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
     * core ERC-721 logic MUST be matched with the use of {_increaseBalance} to keep balances
     * consistent with ownership. The invariant to preserve is that for any address `a` the value returned by
     * `balanceOf(a)` must be equal to the number of tokens such that `_ownerOf(tokenId)` is `a`.
     */
    function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
        return _owners[tokenId];
    }

    /**
     * @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
     */
    function _getApproved(uint256 tokenId) internal view virtual returns (address) {
        return _tokenApprovals[tokenId];
    }

    /**
     * @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
     * particular (ignoring whether it is owned by `owner`).
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
        return
            spender != address(0) &&
            (owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
    }

    /**
     * @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
     * Reverts if:
     * - `spender` does not have approval from `owner` for `tokenId`.
     * - `spender` does not have approval to manage all of `owner`'s assets.
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
        if (!_isAuthorized(owner, spender, tokenId)) {
            if (owner == address(0)) {
                revert ERC721NonexistentToken(tokenId);
            } else {
                revert ERC721InsufficientApproval(spender, tokenId);
            }
        }
    }

    /**
     * @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
     *
     * NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
     * a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
     *
     * WARNING: Increasing an account's balance using this function tends to be paired with an override of the
     * {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
     * remain consistent with one another.
     */
    function _increaseBalance(address account, uint128 value) internal virtual {
        unchecked {
            _balances[account] += value;
        }
    }

    /**
     * @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
     * (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that
     * `auth` is either the owner of the token, or approved to operate on the token (by the owner).
     *
     * Emits a {Transfer} event.
     *
     * NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
     */
    function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
        address from = _ownerOf(tokenId);

        // Perform (optional) operator check
        if (auth != address(0)) {
            _checkAuthorized(from, auth, tokenId);
        }

        // Execute the update
        if (from != address(0)) {
            // Clear approval. No need to re-authorize or emit the Approval event
            _approve(address(0), tokenId, address(0), false);

            unchecked {
                _balances[from] -= 1;
            }
        }

        if (to != address(0)) {
            unchecked {
                _balances[to] += 1;
            }
        }

        _owners[tokenId] = to;

        emit Transfer(from, to, tokenId);

        return from;
    }

    /**
     * @dev Mints `tokenId` and transfers it to `to`.
     *
     * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - `to` cannot be the zero address.
     *
     * Emits a {Transfer} event.
     */
    function _mint(address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner != address(0)) {
            revert ERC721InvalidSender(address(0));
        }
    }

    /**
     * @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeMint(address to, uint256 tokenId) internal {
        _safeMint(to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
        _mint(to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), address(0), to, tokenId, data);
    }

    /**
     * @dev Destroys `tokenId`.
     * The approval is cleared when the token is burned.
     * This is an internal function that does not check if the sender is authorized to operate on the token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     *
     * Emits a {Transfer} event.
     */
    function _burn(uint256 tokenId) internal {
        address previousOwner = _update(address(0), tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
    }

    /**
     * @dev Transfers `tokenId` from `from` to `to`.
     *  As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     *
     * Emits a {Transfer} event.
     */
    function _transfer(address from, address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        } else if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
     * are aware of the ERC-721 standard to prevent tokens from being forever locked.
     *
     * `data` is additional data, it has no specified format and it is sent in call to `to`.
     *
     * This internal function is like {safeTransferFrom} in the sense that it invokes
     * {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
     * implement alternative mechanisms to perform token transfer, such as signature-based.
     *
     * Requirements:
     *
     * - `tokenId` token must exist and be owned by `from`.
     * - `to` cannot be the zero address.
     * - `from` cannot be the zero address.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeTransfer(address from, address to, uint256 tokenId) internal {
        _safeTransfer(from, to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
        _transfer(from, to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
    }

    /**
     * @dev Approve `to` to operate on `tokenId`
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
     * either the owner of the token, or approved to operate on all tokens held by this owner.
     *
     * Emits an {Approval} event.
     *
     * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
     */
    function _approve(address to, uint256 tokenId, address auth) internal {
        _approve(to, tokenId, auth, true);
    }

    /**
     * @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
     * emitted in the context of transfers.
     */
    function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
        // Avoid reading the owner unless necessary
        if (emitEvent || auth != address(0)) {
            address owner = _requireOwned(tokenId);

            // We do not use _isAuthorized because single-token approvals should not be able to call approve
            if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
                revert ERC721InvalidApprover(auth);
            }

            if (emitEvent) {
                emit Approval(owner, to, tokenId);
            }
        }

        _tokenApprovals[tokenId] = to;
    }

    /**
     * @dev Approve `operator` to operate on all of `owner` tokens
     *
     * Requirements:
     * - operator can't be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
        if (operator == address(0)) {
            revert ERC721InvalidOperator(operator);
        }
        _operatorApprovals[owner][operator] = approved;
        emit ApprovalForAll(owner, operator, approved);
    }

    /**
     * @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
     * Returns the owner.
     *
     * Overrides to ownership logic should be done to {_ownerOf}.
     */
    function _requireOwned(uint256 tokenId) internal view returns (address) {
        address owner = _ownerOf(tokenId);
        if (owner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
        return owner;
    }
}
IERC721Metadata.sol 27 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/extensions/IERC721Metadata.sol)

pragma solidity >=0.6.2;

import {IERC721} from "../IERC721.sol";

/**
 * @title ERC-721 Non-Fungible Token Standard, optional metadata extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721Metadata is IERC721 {
    /**
     * @dev Returns the token collection name.
     */
    function name() external view returns (string memory);

    /**
     * @dev Returns the token collection symbol.
     */
    function symbol() external view returns (string memory);

    /**
     * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
     */
    function tokenURI(uint256 tokenId) external view returns (string memory);
}
IERC721.sol 135 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721.sol)

pragma solidity >=0.6.2;

import {IERC165} from "../../utils/introspection/IERC165.sol";

/**
 * @dev Required interface of an ERC-721 compliant contract.
 */
interface IERC721 is IERC165 {
    /**
     * @dev Emitted when `tokenId` token is transferred from `from` to `to`.
     */
    event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
     */
    event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
     */
    event ApprovalForAll(address indexed owner, address indexed operator, bool approved);

    /**
     * @dev Returns the number of tokens in ``owner``'s account.
     */
    function balanceOf(address owner) external view returns (uint256 balance);

    /**
     * @dev Returns the owner of the `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function ownerOf(uint256 tokenId) external view returns (address owner);

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
     * are aware of the ERC-721 protocol to prevent tokens from being forever locked.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
     *   {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Transfers `tokenId` token from `from` to `to`.
     *
     * WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
     * or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
     * understand this adds an external call which potentially creates a reentrancy vulnerability.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Gives permission to `to` to transfer `tokenId` token to another account.
     * The approval is cleared when the token is transferred.
     *
     * Only a single account can be approved at a time, so approving the zero address clears previous approvals.
     *
     * Requirements:
     *
     * - The caller must own the token or be an approved operator.
     * - `tokenId` must exist.
     *
     * Emits an {Approval} event.
     */
    function approve(address to, uint256 tokenId) external;

    /**
     * @dev Approve or remove `operator` as an operator for the caller.
     * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
     *
     * Requirements:
     *
     * - The `operator` cannot be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function setApprovalForAll(address operator, bool approved) external;

    /**
     * @dev Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId) external view returns (address operator);

    /**
     * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
     *
     * See {setApprovalForAll}
     */
    function isApprovedForAll(address owner, address operator) external view returns (bool);
}
IERC721Receiver.sol 28 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721Receiver.sol)

pragma solidity >=0.5.0;

/**
 * @title ERC-721 token receiver interface
 * @dev Interface for any contract that wants to support safeTransfers
 * from ERC-721 asset contracts.
 */
interface IERC721Receiver {
    /**
     * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
     * by `operator` from `from`, this function is called.
     *
     * It must return its Solidity selector to confirm the token transfer.
     * If any other value is returned or the interface is not implemented by the recipient, the transfer will be
     * reverted.
     *
     * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}
ERC721Holder.sol 24 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/utils/ERC721Holder.sol)

pragma solidity ^0.8.20;

import {IERC721Receiver} from "../IERC721Receiver.sol";

/**
 * @dev Implementation of the {IERC721Receiver} interface.
 *
 * Accepts all token transfers.
 * Make sure the contract is able to use its token with {IERC721-safeTransferFrom}, {IERC721-approve} or
 * {IERC721-setApprovalForAll}.
 */
abstract contract ERC721Holder is IERC721Receiver {
    /**
     * @dev See {IERC721Receiver-onERC721Received}.
     *
     * Always returns `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(address, address, uint256, bytes memory) public virtual returns (bytes4) {
        return this.onERC721Received.selector;
    }
}
ERC721Utils.sol 50 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/utils/ERC721Utils.sol)

pragma solidity ^0.8.20;

import {IERC721Receiver} from "../IERC721Receiver.sol";
import {IERC721Errors} from "../../../interfaces/draft-IERC6093.sol";

/**
 * @dev Library that provide common ERC-721 utility functions.
 *
 * See https://eips.ethereum.org/EIPS/eip-721[ERC-721].
 *
 * _Available since v5.1._
 */
library ERC721Utils {
    /**
     * @dev Performs an acceptance check for the provided `operator` by calling {IERC721Receiver-onERC721Received}
     * on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
     *
     * The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
     * Otherwise, the recipient must implement {IERC721Receiver-onERC721Received} and return the acceptance magic value to accept
     * the transfer.
     */
    function checkOnERC721Received(
        address operator,
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) internal {
        if (to.code.length > 0) {
            try IERC721Receiver(to).onERC721Received(operator, from, tokenId, data) returns (bytes4 retval) {
                if (retval != IERC721Receiver.onERC721Received.selector) {
                    // Token rejected
                    revert IERC721Errors.ERC721InvalidReceiver(to);
                }
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    // non-IERC721Receiver implementer
                    revert IERC721Errors.ERC721InvalidReceiver(to);
                } else {
                    assembly ("memory-safe") {
                        revert(add(reason, 0x20), mload(reason))
                    }
                }
            }
        }
    }
}
Context.sol 28 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)

pragma solidity ^0.8.20;

/**
 * @dev Provides information about the current execution context, including the
 * sender of the transaction and its data. While these are generally available
 * via msg.sender and msg.data, they should not be accessed in such a direct
 * manner, since when dealing with meta-transactions the account sending and
 * paying for execution may not be the actual sender (as far as an application
 * is concerned).
 *
 * This contract is only required for intermediate, library-like contracts.
 */
abstract contract Context {
    function _msgSender() internal view virtual returns (address) {
        return msg.sender;
    }

    function _msgData() internal view virtual returns (bytes calldata) {
        return msg.data;
    }

    function _contextSuffixLength() internal view virtual returns (uint256) {
        return 0;
    }
}
ERC165.sol 25 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/ERC165.sol)

pragma solidity ^0.8.20;

import {IERC165} from "./IERC165.sol";

/**
 * @dev Implementation of the {IERC165} interface.
 *
 * Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
 * for the additional interface id that will be supported. For example:
 *
 * ```solidity
 * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
 *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
 * }
 * ```
 */
abstract contract ERC165 is IERC165 {
    /// @inheritdoc IERC165
    function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
        return interfaceId == type(IERC165).interfaceId;
    }
}
IERC165.sol 25 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)

pragma solidity >=0.4.16;

/**
 * @dev Interface of the ERC-165 standard, as defined in the
 * https://eips.ethereum.org/EIPS/eip-165[ERC].
 *
 * Implementers can declare support of contract interfaces, which can then be
 * queried by others ({ERC165Checker}).
 *
 * For an implementation, see {ERC165}.
 */
interface IERC165 {
    /**
     * @dev Returns true if this contract implements the interface defined by
     * `interfaceId`. See the corresponding
     * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30 000 gas.
     */
    function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
Math.sol 749 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/math/Math.sol)

pragma solidity ^0.8.20;

import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library Math {
    enum Rounding {
        Floor, // Toward negative infinity
        Ceil, // Toward positive infinity
        Trunc, // Toward zero
        Expand // Away from zero
    }

    /**
     * @dev Return the 512-bit addition of two uint256.
     *
     * The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
     */
    function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
        assembly ("memory-safe") {
            low := add(a, b)
            high := lt(low, a)
        }
    }

    /**
     * @dev Return the 512-bit multiplication of two uint256.
     *
     * The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
     */
    function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
        // 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
        // the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
        // variables such that product = high * 2²⁵⁶ + low.
        assembly ("memory-safe") {
            let mm := mulmod(a, b, not(0))
            low := mul(a, b)
            high := sub(sub(mm, low), lt(mm, low))
        }
    }

    /**
     * @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a + b;
            success = c >= a;
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
     */
    function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a - b;
            success = c <= a;
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a * b;
            assembly ("memory-safe") {
                // Only true when the multiplication doesn't overflow
                // (c / a == b) || (a == 0)
                success := or(eq(div(c, a), b), iszero(a))
            }
            // equivalent to: success ? c : 0
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            success = b > 0;
            assembly ("memory-safe") {
                // The `DIV` opcode returns zero when the denominator is 0.
                result := div(a, b)
            }
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
     */
    function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            success = b > 0;
            assembly ("memory-safe") {
                // The `MOD` opcode returns zero when the denominator is 0.
                result := mod(a, b)
            }
        }
    }

    /**
     * @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
     */
    function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
        (bool success, uint256 result) = tryAdd(a, b);
        return ternary(success, result, type(uint256).max);
    }

    /**
     * @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
     */
    function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
        (, uint256 result) = trySub(a, b);
        return result;
    }

    /**
     * @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
     */
    function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
        (bool success, uint256 result) = tryMul(a, b);
        return ternary(success, result, type(uint256).max);
    }

    /**
     * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
     *
     * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
     * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
     * one branch when needed, making this function more expensive.
     */
    function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
        unchecked {
            // branchless ternary works because:
            // b ^ (a ^ b) == a
            // b ^ 0 == b
            return b ^ ((a ^ b) * SafeCast.toUint(condition));
        }
    }

    /**
     * @dev Returns the largest of two numbers.
     */
    function max(uint256 a, uint256 b) internal pure returns (uint256) {
        return ternary(a > b, a, b);
    }

    /**
     * @dev Returns the smallest of two numbers.
     */
    function min(uint256 a, uint256 b) internal pure returns (uint256) {
        return ternary(a < b, a, b);
    }

    /**
     * @dev Returns the average of two numbers. The result is rounded towards
     * zero.
     */
    function average(uint256 a, uint256 b) internal pure returns (uint256) {
        // (a + b) / 2 can overflow.
        return (a & b) + (a ^ b) / 2;
    }

    /**
     * @dev Returns the ceiling of the division of two numbers.
     *
     * This differs from standard division with `/` in that it rounds towards infinity instead
     * of rounding towards zero.
     */
    function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
        if (b == 0) {
            // Guarantee the same behavior as in a regular Solidity division.
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }

        // The following calculation ensures accurate ceiling division without overflow.
        // Since a is non-zero, (a - 1) / b will not overflow.
        // The largest possible result occurs when (a - 1) / b is type(uint256).max,
        // but the largest value we can obtain is type(uint256).max - 1, which happens
        // when a = type(uint256).max and b = 1.
        unchecked {
            return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
        }
    }

    /**
     * @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
     * denominator == 0.
     *
     * Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
     * Uniswap Labs also under MIT license.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
        unchecked {
            (uint256 high, uint256 low) = mul512(x, y);

            // Handle non-overflow cases, 256 by 256 division.
            if (high == 0) {
                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
                // The surrounding unchecked block does not change this fact.
                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
                return low / denominator;
            }

            // Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
            if (denominator <= high) {
                Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
            }

            ///////////////////////////////////////////////
            // 512 by 256 division.
            ///////////////////////////////////////////////

            // Make division exact by subtracting the remainder from [high low].
            uint256 remainder;
            assembly ("memory-safe") {
                // Compute remainder using mulmod.
                remainder := mulmod(x, y, denominator)

                // Subtract 256 bit number from 512 bit number.
                high := sub(high, gt(remainder, low))
                low := sub(low, remainder)
            }

            // Factor powers of two out of denominator and compute largest power of two divisor of denominator.
            // Always >= 1. See https://cs.stackexchange.com/q/138556/92363.

            uint256 twos = denominator & (0 - denominator);
            assembly ("memory-safe") {
                // Divide denominator by twos.
                denominator := div(denominator, twos)

                // Divide [high low] by twos.
                low := div(low, twos)

                // Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
                twos := add(div(sub(0, twos), twos), 1)
            }

            // Shift in bits from high into low.
            low |= high * twos;

            // Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
            // that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
            // four bits. That is, denominator * inv ≡ 1 mod 2⁴.
            uint256 inverse = (3 * denominator) ^ 2;

            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
            // works in modular arithmetic, doubling the correct bits in each step.
            inverse *= 2 - denominator * inverse; // inverse mod 2⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
            inverse *= 2 - denominator * inverse; // inverse mod 2³²
            inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
            inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶

            // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
            // This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
            // less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
            // is no longer required.
            result = low * inverse;
            return result;
        }
    }

    /**
     * @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
        return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
    }

    /**
     * @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
     */
    function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
        unchecked {
            (uint256 high, uint256 low) = mul512(x, y);
            if (high >= 1 << n) {
                Panic.panic(Panic.UNDER_OVERFLOW);
            }
            return (high << (256 - n)) | (low >> n);
        }
    }

    /**
     * @dev Calculates x * y >> n with full precision, following the selected rounding direction.
     */
    function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
        return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
    }

    /**
     * @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
     *
     * If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
     * If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
     *
     * If the input value is not inversible, 0 is returned.
     *
     * NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
     * inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
     */
    function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
        unchecked {
            if (n == 0) return 0;

            // The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
            // Used to compute integers x and y such that: ax + ny = gcd(a, n).
            // When the gcd is 1, then the inverse of a modulo n exists and it's x.
            // ax + ny = 1
            // ax = 1 + (-y)n
            // ax ≡ 1 (mod n) # x is the inverse of a modulo n

            // If the remainder is 0 the gcd is n right away.
            uint256 remainder = a % n;
            uint256 gcd = n;

            // Therefore the initial coefficients are:
            // ax + ny = gcd(a, n) = n
            // 0a + 1n = n
            int256 x = 0;
            int256 y = 1;

            while (remainder != 0) {
                uint256 quotient = gcd / remainder;

                (gcd, remainder) = (
                    // The old remainder is the next gcd to try.
                    remainder,
                    // Compute the next remainder.
                    // Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
                    // where gcd is at most n (capped to type(uint256).max)
                    gcd - remainder * quotient
                );

                (x, y) = (
                    // Increment the coefficient of a.
                    y,
                    // Decrement the coefficient of n.
                    // Can overflow, but the result is casted to uint256 so that the
                    // next value of y is "wrapped around" to a value between 0 and n - 1.
                    x - y * int256(quotient)
                );
            }

            if (gcd != 1) return 0; // No inverse exists.
            return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
        }
    }

    /**
     * @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
     *
     * From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
     * prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
     * `a**(p-2)` is the modular multiplicative inverse of a in Fp.
     *
     * NOTE: this function does NOT check that `p` is a prime greater than `2`.
     */
    function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
        unchecked {
            return Math.modExp(a, p - 2, p);
        }
    }

    /**
     * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
     *
     * Requirements:
     * - modulus can't be zero
     * - underlying staticcall to precompile must succeed
     *
     * IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
     * sure the chain you're using it on supports the precompiled contract for modular exponentiation
     * at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
     * the underlying function will succeed given the lack of a revert, but the result may be incorrectly
     * interpreted as 0.
     */
    function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
        (bool success, uint256 result) = tryModExp(b, e, m);
        if (!success) {
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }
        return result;
    }

    /**
     * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
     * It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
     * to operate modulo 0 or if the underlying precompile reverted.
     *
     * IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
     * you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
     * https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
     * of a revert, but the result may be incorrectly interpreted as 0.
     */
    function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
        if (m == 0) return (false, 0);
        assembly ("memory-safe") {
            let ptr := mload(0x40)
            // | Offset    | Content    | Content (Hex)                                                      |
            // |-----------|------------|--------------------------------------------------------------------|
            // | 0x00:0x1f | size of b  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x20:0x3f | size of e  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x40:0x5f | size of m  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x60:0x7f | value of b | 0x<.............................................................b> |
            // | 0x80:0x9f | value of e | 0x<.............................................................e> |
            // | 0xa0:0xbf | value of m | 0x<.............................................................m> |
            mstore(ptr, 0x20)
            mstore(add(ptr, 0x20), 0x20)
            mstore(add(ptr, 0x40), 0x20)
            mstore(add(ptr, 0x60), b)
            mstore(add(ptr, 0x80), e)
            mstore(add(ptr, 0xa0), m)

            // Given the result < m, it's guaranteed to fit in 32 bytes,
            // so we can use the memory scratch space located at offset 0.
            success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
            result := mload(0x00)
        }
    }

    /**
     * @dev Variant of {modExp} that supports inputs of arbitrary length.
     */
    function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
        (bool success, bytes memory result) = tryModExp(b, e, m);
        if (!success) {
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }
        return result;
    }

    /**
     * @dev Variant of {tryModExp} that supports inputs of arbitrary length.
     */
    function tryModExp(
        bytes memory b,
        bytes memory e,
        bytes memory m
    ) internal view returns (bool success, bytes memory result) {
        if (_zeroBytes(m)) return (false, new bytes(0));

        uint256 mLen = m.length;

        // Encode call args in result and move the free memory pointer
        result = abi.encodePacked(b.length, e.length, mLen, b, e, m);

        assembly ("memory-safe") {
            let dataPtr := add(result, 0x20)
            // Write result on top of args to avoid allocating extra memory.
            success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
            // Overwrite the length.
            // result.length > returndatasize() is guaranteed because returndatasize() == m.length
            mstore(result, mLen)
            // Set the memory pointer after the returned data.
            mstore(0x40, add(dataPtr, mLen))
        }
    }

    /**
     * @dev Returns whether the provided byte array is zero.
     */
    function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
        for (uint256 i = 0; i < byteArray.length; ++i) {
            if (byteArray[i] != 0) {
                return false;
            }
        }
        return true;
    }

    /**
     * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
     * towards zero.
     *
     * This method is based on Newton's method for computing square roots; the algorithm is restricted to only
     * using integer operations.
     */
    function sqrt(uint256 a) internal pure returns (uint256) {
        unchecked {
            // Take care of easy edge cases when a == 0 or a == 1
            if (a <= 1) {
                return a;
            }

            // In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
            // sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
            // the current value as `ε_n = | x_n - sqrt(a) |`.
            //
            // For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
            // of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
            // bigger than any uint256.
            //
            // By noticing that
            // `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
            // we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
            // to the msb function.
            uint256 aa = a;
            uint256 xn = 1;

            if (aa >= (1 << 128)) {
                aa >>= 128;
                xn <<= 64;
            }
            if (aa >= (1 << 64)) {
                aa >>= 64;
                xn <<= 32;
            }
            if (aa >= (1 << 32)) {
                aa >>= 32;
                xn <<= 16;
            }
            if (aa >= (1 << 16)) {
                aa >>= 16;
                xn <<= 8;
            }
            if (aa >= (1 << 8)) {
                aa >>= 8;
                xn <<= 4;
            }
            if (aa >= (1 << 4)) {
                aa >>= 4;
                xn <<= 2;
            }
            if (aa >= (1 << 2)) {
                xn <<= 1;
            }

            // We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
            //
            // We can refine our estimation by noticing that the middle of that interval minimizes the error.
            // If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
            // This is going to be our x_0 (and ε_0)
            xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)

            // From here, Newton's method give us:
            // x_{n+1} = (x_n + a / x_n) / 2
            //
            // One should note that:
            // x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
            //              = ((x_n² + a) / (2 * x_n))² - a
            //              = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
            //              = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
            //              = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
            //              = (x_n² - a)² / (2 * x_n)²
            //              = ((x_n² - a) / (2 * x_n))²
            //              ≥ 0
            // Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
            //
            // This gives us the proof of quadratic convergence of the sequence:
            // ε_{n+1} = | x_{n+1} - sqrt(a) |
            //         = | (x_n + a / x_n) / 2 - sqrt(a) |
            //         = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
            //         = | (x_n - sqrt(a))² / (2 * x_n) |
            //         = | ε_n² / (2 * x_n) |
            //         = ε_n² / | (2 * x_n) |
            //
            // For the first iteration, we have a special case where x_0 is known:
            // ε_1 = ε_0² / | (2 * x_0) |
            //     ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
            //     ≤ 2**(2*e-4) / (3 * 2**(e-1))
            //     ≤ 2**(e-3) / 3
            //     ≤ 2**(e-3-log2(3))
            //     ≤ 2**(e-4.5)
            //
            // For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
            // ε_{n+1} = ε_n² / | (2 * x_n) |
            //         ≤ (2**(e-k))² / (2 * 2**(e-1))
            //         ≤ 2**(2*e-2*k) / 2**e
            //         ≤ 2**(e-2*k)
            xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5)  -- special case, see above
            xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9)    -- general case with k = 4.5
            xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18)   -- general case with k = 9
            xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36)   -- general case with k = 18
            xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72)   -- general case with k = 36
            xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144)  -- general case with k = 72

            // Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
            // ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
            // sqrt(a) or sqrt(a) + 1.
            return xn - SafeCast.toUint(xn > a / xn);
        }
    }

    /**
     * @dev Calculates sqrt(a), following the selected rounding direction.
     */
    function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = sqrt(a);
            return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
        }
    }

    /**
     * @dev Return the log in base 2 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log2(uint256 x) internal pure returns (uint256 r) {
        // If value has upper 128 bits set, log2 result is at least 128
        r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
        // If upper 64 bits of 128-bit half set, add 64 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
        // If upper 32 bits of 64-bit half set, add 32 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
        // If upper 16 bits of 32-bit half set, add 16 to result
        r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
        // If upper 8 bits of 16-bit half set, add 8 to result
        r |= SafeCast.toUint((x >> r) > 0xff) << 3;
        // If upper 4 bits of 8-bit half set, add 4 to result
        r |= SafeCast.toUint((x >> r) > 0xf) << 2;

        // Shifts value right by the current result and use it as an index into this lookup table:
        //
        // | x (4 bits) |  index  | table[index] = MSB position |
        // |------------|---------|-----------------------------|
        // |    0000    |    0    |        table[0] = 0         |
        // |    0001    |    1    |        table[1] = 0         |
        // |    0010    |    2    |        table[2] = 1         |
        // |    0011    |    3    |        table[3] = 1         |
        // |    0100    |    4    |        table[4] = 2         |
        // |    0101    |    5    |        table[5] = 2         |
        // |    0110    |    6    |        table[6] = 2         |
        // |    0111    |    7    |        table[7] = 2         |
        // |    1000    |    8    |        table[8] = 3         |
        // |    1001    |    9    |        table[9] = 3         |
        // |    1010    |   10    |        table[10] = 3        |
        // |    1011    |   11    |        table[11] = 3        |
        // |    1100    |   12    |        table[12] = 3        |
        // |    1101    |   13    |        table[13] = 3        |
        // |    1110    |   14    |        table[14] = 3        |
        // |    1111    |   15    |        table[15] = 3        |
        //
        // The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes.
        assembly ("memory-safe") {
            r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
        }
    }

    /**
     * @dev Return the log in base 2, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log2(value);
            return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
        }
    }

    /**
     * @dev Return the log in base 10 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log10(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >= 10 ** 64) {
                value /= 10 ** 64;
                result += 64;
            }
            if (value >= 10 ** 32) {
                value /= 10 ** 32;
                result += 32;
            }
            if (value >= 10 ** 16) {
                value /= 10 ** 16;
                result += 16;
            }
            if (value >= 10 ** 8) {
                value /= 10 ** 8;
                result += 8;
            }
            if (value >= 10 ** 4) {
                value /= 10 ** 4;
                result += 4;
            }
            if (value >= 10 ** 2) {
                value /= 10 ** 2;
                result += 2;
            }
            if (value >= 10 ** 1) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 10, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log10(value);
            return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
        }
    }

    /**
     * @dev Return the log in base 256 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     *
     * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
     */
    function log256(uint256 x) internal pure returns (uint256 r) {
        // If value has upper 128 bits set, log2 result is at least 128
        r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
        // If upper 64 bits of 128-bit half set, add 64 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
        // If upper 32 bits of 64-bit half set, add 32 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
        // If upper 16 bits of 32-bit half set, add 16 to result
        r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
        // Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
        return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
    }

    /**
     * @dev Return the log in base 256, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log256(value);
            return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
        }
    }

    /**
     * @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
     */
    function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
        return uint8(rounding) % 2 == 1;
    }
}
SafeCast.sol 1162 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.

pragma solidity ^0.8.20;

/**
 * @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
 * checks.
 *
 * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
 * easily result in undesired exploitation or bugs, since developers usually
 * assume that overflows raise errors. `SafeCast` restores this intuition by
 * reverting the transaction when such an operation overflows.
 *
 * Using this library instead of the unchecked operations eliminates an entire
 * class of bugs, so it's recommended to use it always.
 */
library SafeCast {
    /**
     * @dev Value doesn't fit in an uint of `bits` size.
     */
    error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);

    /**
     * @dev An int value doesn't fit in an uint of `bits` size.
     */
    error SafeCastOverflowedIntToUint(int256 value);

    /**
     * @dev Value doesn't fit in an int of `bits` size.
     */
    error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);

    /**
     * @dev An uint value doesn't fit in an int of `bits` size.
     */
    error SafeCastOverflowedUintToInt(uint256 value);

    /**
     * @dev Returns the downcasted uint248 from uint256, reverting on
     * overflow (when the input is greater than largest uint248).
     *
     * Counterpart to Solidity's `uint248` operator.
     *
     * Requirements:
     *
     * - input must fit into 248 bits
     */
    function toUint248(uint256 value) internal pure returns (uint248) {
        if (value > type(uint248).max) {
            revert SafeCastOverflowedUintDowncast(248, value);
        }
        return uint248(value);
    }

    /**
     * @dev Returns the downcasted uint240 from uint256, reverting on
     * overflow (when the input is greater than largest uint240).
     *
     * Counterpart to Solidity's `uint240` operator.
     *
     * Requirements:
     *
     * - input must fit into 240 bits
     */
    function toUint240(uint256 value) internal pure returns (uint240) {
        if (value > type(uint240).max) {
            revert SafeCastOverflowedUintDowncast(240, value);
        }
        return uint240(value);
    }

    /**
     * @dev Returns the downcasted uint232 from uint256, reverting on
     * overflow (when the input is greater than largest uint232).
     *
     * Counterpart to Solidity's `uint232` operator.
     *
     * Requirements:
     *
     * - input must fit into 232 bits
     */
    function toUint232(uint256 value) internal pure returns (uint232) {
        if (value > type(uint232).max) {
            revert SafeCastOverflowedUintDowncast(232, value);
        }
        return uint232(value);
    }

    /**
     * @dev Returns the downcasted uint224 from uint256, reverting on
     * overflow (when the input is greater than largest uint224).
     *
     * Counterpart to Solidity's `uint224` operator.
     *
     * Requirements:
     *
     * - input must fit into 224 bits
     */
    function toUint224(uint256 value) internal pure returns (uint224) {
        if (value > type(uint224).max) {
            revert SafeCastOverflowedUintDowncast(224, value);
        }
        return uint224(value);
    }

    /**
     * @dev Returns the downcasted uint216 from uint256, reverting on
     * overflow (when the input is greater than largest uint216).
     *
     * Counterpart to Solidity's `uint216` operator.
     *
     * Requirements:
     *
     * - input must fit into 216 bits
     */
    function toUint216(uint256 value) internal pure returns (uint216) {
        if (value > type(uint216).max) {
            revert SafeCastOverflowedUintDowncast(216, value);
        }
        return uint216(value);
    }

    /**
     * @dev Returns the downcasted uint208 from uint256, reverting on
     * overflow (when the input is greater than largest uint208).
     *
     * Counterpart to Solidity's `uint208` operator.
     *
     * Requirements:
     *
     * - input must fit into 208 bits
     */
    function toUint208(uint256 value) internal pure returns (uint208) {
        if (value > type(uint208).max) {
            revert SafeCastOverflowedUintDowncast(208, value);
        }
        return uint208(value);
    }

    /**
     * @dev Returns the downcasted uint200 from uint256, reverting on
     * overflow (when the input is greater than largest uint200).
     *
     * Counterpart to Solidity's `uint200` operator.
     *
     * Requirements:
     *
     * - input must fit into 200 bits
     */
    function toUint200(uint256 value) internal pure returns (uint200) {
        if (value > type(uint200).max) {
            revert SafeCastOverflowedUintDowncast(200, value);
        }
        return uint200(value);
    }

    /**
     * @dev Returns the downcasted uint192 from uint256, reverting on
     * overflow (when the input is greater than largest uint192).
     *
     * Counterpart to Solidity's `uint192` operator.
     *
     * Requirements:
     *
     * - input must fit into 192 bits
     */
    function toUint192(uint256 value) internal pure returns (uint192) {
        if (value > type(uint192).max) {
            revert SafeCastOverflowedUintDowncast(192, value);
        }
        return uint192(value);
    }

    /**
     * @dev Returns the downcasted uint184 from uint256, reverting on
     * overflow (when the input is greater than largest uint184).
     *
     * Counterpart to Solidity's `uint184` operator.
     *
     * Requirements:
     *
     * - input must fit into 184 bits
     */
    function toUint184(uint256 value) internal pure returns (uint184) {
        if (value > type(uint184).max) {
            revert SafeCastOverflowedUintDowncast(184, value);
        }
        return uint184(value);
    }

    /**
     * @dev Returns the downcasted uint176 from uint256, reverting on
     * overflow (when the input is greater than largest uint176).
     *
     * Counterpart to Solidity's `uint176` operator.
     *
     * Requirements:
     *
     * - input must fit into 176 bits
     */
    function toUint176(uint256 value) internal pure returns (uint176) {
        if (value > type(uint176).max) {
            revert SafeCastOverflowedUintDowncast(176, value);
        }
        return uint176(value);
    }

    /**
     * @dev Returns the downcasted uint168 from uint256, reverting on
     * overflow (when the input is greater than largest uint168).
     *
     * Counterpart to Solidity's `uint168` operator.
     *
     * Requirements:
     *
     * - input must fit into 168 bits
     */
    function toUint168(uint256 value) internal pure returns (uint168) {
        if (value > type(uint168).max) {
            revert SafeCastOverflowedUintDowncast(168, value);
        }
        return uint168(value);
    }

    /**
     * @dev Returns the downcasted uint160 from uint256, reverting on
     * overflow (when the input is greater than largest uint160).
     *
     * Counterpart to Solidity's `uint160` operator.
     *
     * Requirements:
     *
     * - input must fit into 160 bits
     */
    function toUint160(uint256 value) internal pure returns (uint160) {
        if (value > type(uint160).max) {
            revert SafeCastOverflowedUintDowncast(160, value);
        }
        return uint160(value);
    }

    /**
     * @dev Returns the downcasted uint152 from uint256, reverting on
     * overflow (when the input is greater than largest uint152).
     *
     * Counterpart to Solidity's `uint152` operator.
     *
     * Requirements:
     *
     * - input must fit into 152 bits
     */
    function toUint152(uint256 value) internal pure returns (uint152) {
        if (value > type(uint152).max) {
            revert SafeCastOverflowedUintDowncast(152, value);
        }
        return uint152(value);
    }

    /**
     * @dev Returns the downcasted uint144 from uint256, reverting on
     * overflow (when the input is greater than largest uint144).
     *
     * Counterpart to Solidity's `uint144` operator.
     *
     * Requirements:
     *
     * - input must fit into 144 bits
     */
    function toUint144(uint256 value) internal pure returns (uint144) {
        if (value > type(uint144).max) {
            revert SafeCastOverflowedUintDowncast(144, value);
        }
        return uint144(value);
    }

    /**
     * @dev Returns the downcasted uint136 from uint256, reverting on
     * overflow (when the input is greater than largest uint136).
     *
     * Counterpart to Solidity's `uint136` operator.
     *
     * Requirements:
     *
     * - input must fit into 136 bits
     */
    function toUint136(uint256 value) internal pure returns (uint136) {
        if (value > type(uint136).max) {
            revert SafeCastOverflowedUintDowncast(136, value);
        }
        return uint136(value);
    }

    /**
     * @dev Returns the downcasted uint128 from uint256, reverting on
     * overflow (when the input is greater than largest uint128).
     *
     * Counterpart to Solidity's `uint128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     */
    function toUint128(uint256 value) internal pure returns (uint128) {
        if (value > type(uint128).max) {
            revert SafeCastOverflowedUintDowncast(128, value);
        }
        return uint128(value);
    }

    /**
     * @dev Returns the downcasted uint120 from uint256, reverting on
     * overflow (when the input is greater than largest uint120).
     *
     * Counterpart to Solidity's `uint120` operator.
     *
     * Requirements:
     *
     * - input must fit into 120 bits
     */
    function toUint120(uint256 value) internal pure returns (uint120) {
        if (value > type(uint120).max) {
            revert SafeCastOverflowedUintDowncast(120, value);
        }
        return uint120(value);
    }

    /**
     * @dev Returns the downcasted uint112 from uint256, reverting on
     * overflow (when the input is greater than largest uint112).
     *
     * Counterpart to Solidity's `uint112` operator.
     *
     * Requirements:
     *
     * - input must fit into 112 bits
     */
    function toUint112(uint256 value) internal pure returns (uint112) {
        if (value > type(uint112).max) {
            revert SafeCastOverflowedUintDowncast(112, value);
        }
        return uint112(value);
    }

    /**
     * @dev Returns the downcasted uint104 from uint256, reverting on
     * overflow (when the input is greater than largest uint104).
     *
     * Counterpart to Solidity's `uint104` operator.
     *
     * Requirements:
     *
     * - input must fit into 104 bits
     */
    function toUint104(uint256 value) internal pure returns (uint104) {
        if (value > type(uint104).max) {
            revert SafeCastOverflowedUintDowncast(104, value);
        }
        return uint104(value);
    }

    /**
     * @dev Returns the downcasted uint96 from uint256, reverting on
     * overflow (when the input is greater than largest uint96).
     *
     * Counterpart to Solidity's `uint96` operator.
     *
     * Requirements:
     *
     * - input must fit into 96 bits
     */
    function toUint96(uint256 value) internal pure returns (uint96) {
        if (value > type(uint96).max) {
            revert SafeCastOverflowedUintDowncast(96, value);
        }
        return uint96(value);
    }

    /**
     * @dev Returns the downcasted uint88 from uint256, reverting on
     * overflow (when the input is greater than largest uint88).
     *
     * Counterpart to Solidity's `uint88` operator.
     *
     * Requirements:
     *
     * - input must fit into 88 bits
     */
    function toUint88(uint256 value) internal pure returns (uint88) {
        if (value > type(uint88).max) {
            revert SafeCastOverflowedUintDowncast(88, value);
        }
        return uint88(value);
    }

    /**
     * @dev Returns the downcasted uint80 from uint256, reverting on
     * overflow (when the input is greater than largest uint80).
     *
     * Counterpart to Solidity's `uint80` operator.
     *
     * Requirements:
     *
     * - input must fit into 80 bits
     */
    function toUint80(uint256 value) internal pure returns (uint80) {
        if (value > type(uint80).max) {
            revert SafeCastOverflowedUintDowncast(80, value);
        }
        return uint80(value);
    }

    /**
     * @dev Returns the downcasted uint72 from uint256, reverting on
     * overflow (when the input is greater than largest uint72).
     *
     * Counterpart to Solidity's `uint72` operator.
     *
     * Requirements:
     *
     * - input must fit into 72 bits
     */
    function toUint72(uint256 value) internal pure returns (uint72) {
        if (value > type(uint72).max) {
            revert SafeCastOverflowedUintDowncast(72, value);
        }
        return uint72(value);
    }

    /**
     * @dev Returns the downcasted uint64 from uint256, reverting on
     * overflow (when the input is greater than largest uint64).
     *
     * Counterpart to Solidity's `uint64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     */
    function toUint64(uint256 value) internal pure returns (uint64) {
        if (value > type(uint64).max) {
            revert SafeCastOverflowedUintDowncast(64, value);
        }
        return uint64(value);
    }

    /**
     * @dev Returns the downcasted uint56 from uint256, reverting on
     * overflow (when the input is greater than largest uint56).
     *
     * Counterpart to Solidity's `uint56` operator.
     *
     * Requirements:
     *
     * - input must fit into 56 bits
     */
    function toUint56(uint256 value) internal pure returns (uint56) {
        if (value > type(uint56).max) {
            revert SafeCastOverflowedUintDowncast(56, value);
        }
        return uint56(value);
    }

    /**
     * @dev Returns the downcasted uint48 from uint256, reverting on
     * overflow (when the input is greater than largest uint48).
     *
     * Counterpart to Solidity's `uint48` operator.
     *
     * Requirements:
     *
     * - input must fit into 48 bits
     */
    function toUint48(uint256 value) internal pure returns (uint48) {
        if (value > type(uint48).max) {
            revert SafeCastOverflowedUintDowncast(48, value);
        }
        return uint48(value);
    }

    /**
     * @dev Returns the downcasted uint40 from uint256, reverting on
     * overflow (when the input is greater than largest uint40).
     *
     * Counterpart to Solidity's `uint40` operator.
     *
     * Requirements:
     *
     * - input must fit into 40 bits
     */
    function toUint40(uint256 value) internal pure returns (uint40) {
        if (value > type(uint40).max) {
            revert SafeCastOverflowedUintDowncast(40, value);
        }
        return uint40(value);
    }

    /**
     * @dev Returns the downcasted uint32 from uint256, reverting on
     * overflow (when the input is greater than largest uint32).
     *
     * Counterpart to Solidity's `uint32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     */
    function toUint32(uint256 value) internal pure returns (uint32) {
        if (value > type(uint32).max) {
            revert SafeCastOverflowedUintDowncast(32, value);
        }
        return uint32(value);
    }

    /**
     * @dev Returns the downcasted uint24 from uint256, reverting on
     * overflow (when the input is greater than largest uint24).
     *
     * Counterpart to Solidity's `uint24` operator.
     *
     * Requirements:
     *
     * - input must fit into 24 bits
     */
    function toUint24(uint256 value) internal pure returns (uint24) {
        if (value > type(uint24).max) {
            revert SafeCastOverflowedUintDowncast(24, value);
        }
        return uint24(value);
    }

    /**
     * @dev Returns the downcasted uint16 from uint256, reverting on
     * overflow (when the input is greater than largest uint16).
     *
     * Counterpart to Solidity's `uint16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     */
    function toUint16(uint256 value) internal pure returns (uint16) {
        if (value > type(uint16).max) {
            revert SafeCastOverflowedUintDowncast(16, value);
        }
        return uint16(value);
    }

    /**
     * @dev Returns the downcasted uint8 from uint256, reverting on
     * overflow (when the input is greater than largest uint8).
     *
     * Counterpart to Solidity's `uint8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits
     */
    function toUint8(uint256 value) internal pure returns (uint8) {
        if (value > type(uint8).max) {
            revert SafeCastOverflowedUintDowncast(8, value);
        }
        return uint8(value);
    }

    /**
     * @dev Converts a signed int256 into an unsigned uint256.
     *
     * Requirements:
     *
     * - input must be greater than or equal to 0.
     */
    function toUint256(int256 value) internal pure returns (uint256) {
        if (value < 0) {
            revert SafeCastOverflowedIntToUint(value);
        }
        return uint256(value);
    }

    /**
     * @dev Returns the downcasted int248 from int256, reverting on
     * overflow (when the input is less than smallest int248 or
     * greater than largest int248).
     *
     * Counterpart to Solidity's `int248` operator.
     *
     * Requirements:
     *
     * - input must fit into 248 bits
     */
    function toInt248(int256 value) internal pure returns (int248 downcasted) {
        downcasted = int248(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(248, value);
        }
    }

    /**
     * @dev Returns the downcasted int240 from int256, reverting on
     * overflow (when the input is less than smallest int240 or
     * greater than largest int240).
     *
     * Counterpart to Solidity's `int240` operator.
     *
     * Requirements:
     *
     * - input must fit into 240 bits
     */
    function toInt240(int256 value) internal pure returns (int240 downcasted) {
        downcasted = int240(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(240, value);
        }
    }

    /**
     * @dev Returns the downcasted int232 from int256, reverting on
     * overflow (when the input is less than smallest int232 or
     * greater than largest int232).
     *
     * Counterpart to Solidity's `int232` operator.
     *
     * Requirements:
     *
     * - input must fit into 232 bits
     */
    function toInt232(int256 value) internal pure returns (int232 downcasted) {
        downcasted = int232(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(232, value);
        }
    }

    /**
     * @dev Returns the downcasted int224 from int256, reverting on
     * overflow (when the input is less than smallest int224 or
     * greater than largest int224).
     *
     * Counterpart to Solidity's `int224` operator.
     *
     * Requirements:
     *
     * - input must fit into 224 bits
     */
    function toInt224(int256 value) internal pure returns (int224 downcasted) {
        downcasted = int224(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(224, value);
        }
    }

    /**
     * @dev Returns the downcasted int216 from int256, reverting on
     * overflow (when the input is less than smallest int216 or
     * greater than largest int216).
     *
     * Counterpart to Solidity's `int216` operator.
     *
     * Requirements:
     *
     * - input must fit into 216 bits
     */
    function toInt216(int256 value) internal pure returns (int216 downcasted) {
        downcasted = int216(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(216, value);
        }
    }

    /**
     * @dev Returns the downcasted int208 from int256, reverting on
     * overflow (when the input is less than smallest int208 or
     * greater than largest int208).
     *
     * Counterpart to Solidity's `int208` operator.
     *
     * Requirements:
     *
     * - input must fit into 208 bits
     */
    function toInt208(int256 value) internal pure returns (int208 downcasted) {
        downcasted = int208(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(208, value);
        }
    }

    /**
     * @dev Returns the downcasted int200 from int256, reverting on
     * overflow (when the input is less than smallest int200 or
     * greater than largest int200).
     *
     * Counterpart to Solidity's `int200` operator.
     *
     * Requirements:
     *
     * - input must fit into 200 bits
     */
    function toInt200(int256 value) internal pure returns (int200 downcasted) {
        downcasted = int200(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(200, value);
        }
    }

    /**
     * @dev Returns the downcasted int192 from int256, reverting on
     * overflow (when the input is less than smallest int192 or
     * greater than largest int192).
     *
     * Counterpart to Solidity's `int192` operator.
     *
     * Requirements:
     *
     * - input must fit into 192 bits
     */
    function toInt192(int256 value) internal pure returns (int192 downcasted) {
        downcasted = int192(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(192, value);
        }
    }

    /**
     * @dev Returns the downcasted int184 from int256, reverting on
     * overflow (when the input is less than smallest int184 or
     * greater than largest int184).
     *
     * Counterpart to Solidity's `int184` operator.
     *
     * Requirements:
     *
     * - input must fit into 184 bits
     */
    function toInt184(int256 value) internal pure returns (int184 downcasted) {
        downcasted = int184(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(184, value);
        }
    }

    /**
     * @dev Returns the downcasted int176 from int256, reverting on
     * overflow (when the input is less than smallest int176 or
     * greater than largest int176).
     *
     * Counterpart to Solidity's `int176` operator.
     *
     * Requirements:
     *
     * - input must fit into 176 bits
     */
    function toInt176(int256 value) internal pure returns (int176 downcasted) {
        downcasted = int176(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(176, value);
        }
    }

    /**
     * @dev Returns the downcasted int168 from int256, reverting on
     * overflow (when the input is less than smallest int168 or
     * greater than largest int168).
     *
     * Counterpart to Solidity's `int168` operator.
     *
     * Requirements:
     *
     * - input must fit into 168 bits
     */
    function toInt168(int256 value) internal pure returns (int168 downcasted) {
        downcasted = int168(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(168, value);
        }
    }

    /**
     * @dev Returns the downcasted int160 from int256, reverting on
     * overflow (when the input is less than smallest int160 or
     * greater than largest int160).
     *
     * Counterpart to Solidity's `int160` operator.
     *
     * Requirements:
     *
     * - input must fit into 160 bits
     */
    function toInt160(int256 value) internal pure returns (int160 downcasted) {
        downcasted = int160(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(160, value);
        }
    }

    /**
     * @dev Returns the downcasted int152 from int256, reverting on
     * overflow (when the input is less than smallest int152 or
     * greater than largest int152).
     *
     * Counterpart to Solidity's `int152` operator.
     *
     * Requirements:
     *
     * - input must fit into 152 bits
     */
    function toInt152(int256 value) internal pure returns (int152 downcasted) {
        downcasted = int152(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(152, value);
        }
    }

    /**
     * @dev Returns the downcasted int144 from int256, reverting on
     * overflow (when the input is less than smallest int144 or
     * greater than largest int144).
     *
     * Counterpart to Solidity's `int144` operator.
     *
     * Requirements:
     *
     * - input must fit into 144 bits
     */
    function toInt144(int256 value) internal pure returns (int144 downcasted) {
        downcasted = int144(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(144, value);
        }
    }

    /**
     * @dev Returns the downcasted int136 from int256, reverting on
     * overflow (when the input is less than smallest int136 or
     * greater than largest int136).
     *
     * Counterpart to Solidity's `int136` operator.
     *
     * Requirements:
     *
     * - input must fit into 136 bits
     */
    function toInt136(int256 value) internal pure returns (int136 downcasted) {
        downcasted = int136(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(136, value);
        }
    }

    /**
     * @dev Returns the downcasted int128 from int256, reverting on
     * overflow (when the input is less than smallest int128 or
     * greater than largest int128).
     *
     * Counterpart to Solidity's `int128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     */
    function toInt128(int256 value) internal pure returns (int128 downcasted) {
        downcasted = int128(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(128, value);
        }
    }

    /**
     * @dev Returns the downcasted int120 from int256, reverting on
     * overflow (when the input is less than smallest int120 or
     * greater than largest int120).
     *
     * Counterpart to Solidity's `int120` operator.
     *
     * Requirements:
     *
     * - input must fit into 120 bits
     */
    function toInt120(int256 value) internal pure returns (int120 downcasted) {
        downcasted = int120(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(120, value);
        }
    }

    /**
     * @dev Returns the downcasted int112 from int256, reverting on
     * overflow (when the input is less than smallest int112 or
     * greater than largest int112).
     *
     * Counterpart to Solidity's `int112` operator.
     *
     * Requirements:
     *
     * - input must fit into 112 bits
     */
    function toInt112(int256 value) internal pure returns (int112 downcasted) {
        downcasted = int112(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(112, value);
        }
    }

    /**
     * @dev Returns the downcasted int104 from int256, reverting on
     * overflow (when the input is less than smallest int104 or
     * greater than largest int104).
     *
     * Counterpart to Solidity's `int104` operator.
     *
     * Requirements:
     *
     * - input must fit into 104 bits
     */
    function toInt104(int256 value) internal pure returns (int104 downcasted) {
        downcasted = int104(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(104, value);
        }
    }

    /**
     * @dev Returns the downcasted int96 from int256, reverting on
     * overflow (when the input is less than smallest int96 or
     * greater than largest int96).
     *
     * Counterpart to Solidity's `int96` operator.
     *
     * Requirements:
     *
     * - input must fit into 96 bits
     */
    function toInt96(int256 value) internal pure returns (int96 downcasted) {
        downcasted = int96(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(96, value);
        }
    }

    /**
     * @dev Returns the downcasted int88 from int256, reverting on
     * overflow (when the input is less than smallest int88 or
     * greater than largest int88).
     *
     * Counterpart to Solidity's `int88` operator.
     *
     * Requirements:
     *
     * - input must fit into 88 bits
     */
    function toInt88(int256 value) internal pure returns (int88 downcasted) {
        downcasted = int88(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(88, value);
        }
    }

    /**
     * @dev Returns the downcasted int80 from int256, reverting on
     * overflow (when the input is less than smallest int80 or
     * greater than largest int80).
     *
     * Counterpart to Solidity's `int80` operator.
     *
     * Requirements:
     *
     * - input must fit into 80 bits
     */
    function toInt80(int256 value) internal pure returns (int80 downcasted) {
        downcasted = int80(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(80, value);
        }
    }

    /**
     * @dev Returns the downcasted int72 from int256, reverting on
     * overflow (when the input is less than smallest int72 or
     * greater than largest int72).
     *
     * Counterpart to Solidity's `int72` operator.
     *
     * Requirements:
     *
     * - input must fit into 72 bits
     */
    function toInt72(int256 value) internal pure returns (int72 downcasted) {
        downcasted = int72(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(72, value);
        }
    }

    /**
     * @dev Returns the downcasted int64 from int256, reverting on
     * overflow (when the input is less than smallest int64 or
     * greater than largest int64).
     *
     * Counterpart to Solidity's `int64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     */
    function toInt64(int256 value) internal pure returns (int64 downcasted) {
        downcasted = int64(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(64, value);
        }
    }

    /**
     * @dev Returns the downcasted int56 from int256, reverting on
     * overflow (when the input is less than smallest int56 or
     * greater than largest int56).
     *
     * Counterpart to Solidity's `int56` operator.
     *
     * Requirements:
     *
     * - input must fit into 56 bits
     */
    function toInt56(int256 value) internal pure returns (int56 downcasted) {
        downcasted = int56(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(56, value);
        }
    }

    /**
     * @dev Returns the downcasted int48 from int256, reverting on
     * overflow (when the input is less than smallest int48 or
     * greater than largest int48).
     *
     * Counterpart to Solidity's `int48` operator.
     *
     * Requirements:
     *
     * - input must fit into 48 bits
     */
    function toInt48(int256 value) internal pure returns (int48 downcasted) {
        downcasted = int48(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(48, value);
        }
    }

    /**
     * @dev Returns the downcasted int40 from int256, reverting on
     * overflow (when the input is less than smallest int40 or
     * greater than largest int40).
     *
     * Counterpart to Solidity's `int40` operator.
     *
     * Requirements:
     *
     * - input must fit into 40 bits
     */
    function toInt40(int256 value) internal pure returns (int40 downcasted) {
        downcasted = int40(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(40, value);
        }
    }

    /**
     * @dev Returns the downcasted int32 from int256, reverting on
     * overflow (when the input is less than smallest int32 or
     * greater than largest int32).
     *
     * Counterpart to Solidity's `int32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     */
    function toInt32(int256 value) internal pure returns (int32 downcasted) {
        downcasted = int32(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(32, value);
        }
    }

    /**
     * @dev Returns the downcasted int24 from int256, reverting on
     * overflow (when the input is less than smallest int24 or
     * greater than largest int24).
     *
     * Counterpart to Solidity's `int24` operator.
     *
     * Requirements:
     *
     * - input must fit into 24 bits
     */
    function toInt24(int256 value) internal pure returns (int24 downcasted) {
        downcasted = int24(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(24, value);
        }
    }

    /**
     * @dev Returns the downcasted int16 from int256, reverting on
     * overflow (when the input is less than smallest int16 or
     * greater than largest int16).
     *
     * Counterpart to Solidity's `int16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     */
    function toInt16(int256 value) internal pure returns (int16 downcasted) {
        downcasted = int16(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(16, value);
        }
    }

    /**
     * @dev Returns the downcasted int8 from int256, reverting on
     * overflow (when the input is less than smallest int8 or
     * greater than largest int8).
     *
     * Counterpart to Solidity's `int8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits
     */
    function toInt8(int256 value) internal pure returns (int8 downcasted) {
        downcasted = int8(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(8, value);
        }
    }

    /**
     * @dev Converts an unsigned uint256 into a signed int256.
     *
     * Requirements:
     *
     * - input must be less than or equal to maxInt256.
     */
    function toInt256(uint256 value) internal pure returns (int256) {
        // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
        if (value > uint256(type(int256).max)) {
            revert SafeCastOverflowedUintToInt(value);
        }
        return int256(value);
    }

    /**
     * @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
     */
    function toUint(bool b) internal pure returns (uint256 u) {
        assembly ("memory-safe") {
            u := iszero(iszero(b))
        }
    }
}
SignedMath.sol 68 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SignedMath.sol)

pragma solidity ^0.8.20;

import {SafeCast} from "./SafeCast.sol";

/**
 * @dev Standard signed math utilities missing in the Solidity language.
 */
library SignedMath {
    /**
     * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
     *
     * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
     * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
     * one branch when needed, making this function more expensive.
     */
    function ternary(bool condition, int256 a, int256 b) internal pure returns (int256) {
        unchecked {
            // branchless ternary works because:
            // b ^ (a ^ b) == a
            // b ^ 0 == b
            return b ^ ((a ^ b) * int256(SafeCast.toUint(condition)));
        }
    }

    /**
     * @dev Returns the largest of two signed numbers.
     */
    function max(int256 a, int256 b) internal pure returns (int256) {
        return ternary(a > b, a, b);
    }

    /**
     * @dev Returns the smallest of two signed numbers.
     */
    function min(int256 a, int256 b) internal pure returns (int256) {
        return ternary(a < b, a, b);
    }

    /**
     * @dev Returns the average of two signed numbers without overflow.
     * The result is rounded towards zero.
     */
    function average(int256 a, int256 b) internal pure returns (int256) {
        // Formula from the book "Hacker's Delight"
        int256 x = (a & b) + ((a ^ b) >> 1);
        return x + (int256(uint256(x) >> 255) & (a ^ b));
    }

    /**
     * @dev Returns the absolute unsigned value of a signed value.
     */
    function abs(int256 n) internal pure returns (uint256) {
        unchecked {
            // Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson.
            // Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
            // taking advantage of the most significant (or "sign" bit) in two's complement representation.
            // This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
            // the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
            int256 mask = n >> 255;

            // A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
            return uint256((n + mask) ^ mask);
        }
    }
}
Panic.sol 57 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)

pragma solidity ^0.8.20;

/**
 * @dev Helper library for emitting standardized panic codes.
 *
 * ```solidity
 * contract Example {
 *      using Panic for uint256;
 *
 *      // Use any of the declared internal constants
 *      function foo() { Panic.GENERIC.panic(); }
 *
 *      // Alternatively
 *      function foo() { Panic.panic(Panic.GENERIC); }
 * }
 * ```
 *
 * Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
 *
 * _Available since v5.1._
 */
// slither-disable-next-line unused-state
library Panic {
    /// @dev generic / unspecified error
    uint256 internal constant GENERIC = 0x00;
    /// @dev used by the assert() builtin
    uint256 internal constant ASSERT = 0x01;
    /// @dev arithmetic underflow or overflow
    uint256 internal constant UNDER_OVERFLOW = 0x11;
    /// @dev division or modulo by zero
    uint256 internal constant DIVISION_BY_ZERO = 0x12;
    /// @dev enum conversion error
    uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
    /// @dev invalid encoding in storage
    uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
    /// @dev empty array pop
    uint256 internal constant EMPTY_ARRAY_POP = 0x31;
    /// @dev array out of bounds access
    uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
    /// @dev resource error (too large allocation or too large array)
    uint256 internal constant RESOURCE_ERROR = 0x41;
    /// @dev calling invalid internal function
    uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;

    /// @dev Reverts with a panic code. Recommended to use with
    /// the internal constants with predefined codes.
    function panic(uint256 code) internal pure {
        assembly ("memory-safe") {
            mstore(0x00, 0x4e487b71)
            mstore(0x20, code)
            revert(0x1c, 0x24)
        }
    }
}
Pausable.sol 112 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Pausable.sol)

pragma solidity ^0.8.20;

import {Context} from "../utils/Context.sol";

/**
 * @dev Contract module which allows children to implement an emergency stop
 * mechanism that can be triggered by an authorized account.
 *
 * This module is used through inheritance. It will make available the
 * modifiers `whenNotPaused` and `whenPaused`, which can be applied to
 * the functions of your contract. Note that they will not be pausable by
 * simply including this module, only once the modifiers are put in place.
 */
abstract contract Pausable is Context {
    bool private _paused;

    /**
     * @dev Emitted when the pause is triggered by `account`.
     */
    event Paused(address account);

    /**
     * @dev Emitted when the pause is lifted by `account`.
     */
    event Unpaused(address account);

    /**
     * @dev The operation failed because the contract is paused.
     */
    error EnforcedPause();

    /**
     * @dev The operation failed because the contract is not paused.
     */
    error ExpectedPause();

    /**
     * @dev Modifier to make a function callable only when the contract is not paused.
     *
     * Requirements:
     *
     * - The contract must not be paused.
     */
    modifier whenNotPaused() {
        _requireNotPaused();
        _;
    }

    /**
     * @dev Modifier to make a function callable only when the contract is paused.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    modifier whenPaused() {
        _requirePaused();
        _;
    }

    /**
     * @dev Returns true if the contract is paused, and false otherwise.
     */
    function paused() public view virtual returns (bool) {
        return _paused;
    }

    /**
     * @dev Throws if the contract is paused.
     */
    function _requireNotPaused() internal view virtual {
        if (paused()) {
            revert EnforcedPause();
        }
    }

    /**
     * @dev Throws if the contract is not paused.
     */
    function _requirePaused() internal view virtual {
        if (!paused()) {
            revert ExpectedPause();
        }
    }

    /**
     * @dev Triggers stopped state.
     *
     * Requirements:
     *
     * - The contract must not be paused.
     */
    function _pause() internal virtual whenNotPaused {
        _paused = true;
        emit Paused(_msgSender());
    }

    /**
     * @dev Returns to normal state.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    function _unpause() internal virtual whenPaused {
        _paused = false;
        emit Unpaused(_msgSender());
    }
}
ReentrancyGuard.sol 87 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)

pragma solidity ^0.8.20;

/**
 * @dev Contract module that helps prevent reentrant calls to a function.
 *
 * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
 * available, which can be applied to functions to make sure there are no nested
 * (reentrant) calls to them.
 *
 * Note that because there is a single `nonReentrant` guard, functions marked as
 * `nonReentrant` may not call one another. This can be worked around by making
 * those functions `private`, and then adding `external` `nonReentrant` entry
 * points to them.
 *
 * TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
 * consider using {ReentrancyGuardTransient} instead.
 *
 * TIP: If you would like to learn more about reentrancy and alternative ways
 * to protect against it, check out our blog post
 * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
 */
abstract contract ReentrancyGuard {
    // Booleans are more expensive than uint256 or any type that takes up a full
    // word because each write operation emits an extra SLOAD to first read the
    // slot's contents, replace the bits taken up by the boolean, and then write
    // back. This is the compiler's defense against contract upgrades and
    // pointer aliasing, and it cannot be disabled.

    // The values being non-zero value makes deployment a bit more expensive,
    // but in exchange the refund on every call to nonReentrant will be lower in
    // amount. Since refunds are capped to a percentage of the total
    // transaction's gas, it is best to keep them low in cases like this one, to
    // increase the likelihood of the full refund coming into effect.
    uint256 private constant NOT_ENTERED = 1;
    uint256 private constant ENTERED = 2;

    uint256 private _status;

    /**
     * @dev Unauthorized reentrant call.
     */
    error ReentrancyGuardReentrantCall();

    constructor() {
        _status = NOT_ENTERED;
    }

    /**
     * @dev Prevents a contract from calling itself, directly or indirectly.
     * Calling a `nonReentrant` function from another `nonReentrant`
     * function is not supported. It is possible to prevent this from happening
     * by making the `nonReentrant` function external, and making it call a
     * `private` function that does the actual work.
     */
    modifier nonReentrant() {
        _nonReentrantBefore();
        _;
        _nonReentrantAfter();
    }

    function _nonReentrantBefore() private {
        // On the first call to nonReentrant, _status will be NOT_ENTERED
        if (_status == ENTERED) {
            revert ReentrancyGuardReentrantCall();
        }

        // Any calls to nonReentrant after this point will fail
        _status = ENTERED;
    }

    function _nonReentrantAfter() private {
        // By storing the original value once again, a refund is triggered (see
        // https://eips.ethereum.org/EIPS/eip-2200)
        _status = NOT_ENTERED;
    }

    /**
     * @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
     * `nonReentrant` function in the call stack.
     */
    function _reentrancyGuardEntered() internal view returns (bool) {
        return _status == ENTERED;
    }
}
Strings.sol 490 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/Strings.sol)

pragma solidity ^0.8.20;

import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";

/**
 * @dev String operations.
 */
library Strings {
    using SafeCast for *;

    bytes16 private constant HEX_DIGITS = "0123456789abcdef";
    uint8 private constant ADDRESS_LENGTH = 20;
    uint256 private constant SPECIAL_CHARS_LOOKUP =
        (1 << 0x08) | // backspace
            (1 << 0x09) | // tab
            (1 << 0x0a) | // newline
            (1 << 0x0c) | // form feed
            (1 << 0x0d) | // carriage return
            (1 << 0x22) | // double quote
            (1 << 0x5c); // backslash

    /**
     * @dev The `value` string doesn't fit in the specified `length`.
     */
    error StringsInsufficientHexLength(uint256 value, uint256 length);

    /**
     * @dev The string being parsed contains characters that are not in scope of the given base.
     */
    error StringsInvalidChar();

    /**
     * @dev The string being parsed is not a properly formatted address.
     */
    error StringsInvalidAddressFormat();

    /**
     * @dev Converts a `uint256` to its ASCII `string` decimal representation.
     */
    function toString(uint256 value) internal pure returns (string memory) {
        unchecked {
            uint256 length = Math.log10(value) + 1;
            string memory buffer = new string(length);
            uint256 ptr;
            assembly ("memory-safe") {
                ptr := add(add(buffer, 0x20), length)
            }
            while (true) {
                ptr--;
                assembly ("memory-safe") {
                    mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
                }
                value /= 10;
                if (value == 0) break;
            }
            return buffer;
        }
    }

    /**
     * @dev Converts a `int256` to its ASCII `string` decimal representation.
     */
    function toStringSigned(int256 value) internal pure returns (string memory) {
        return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) internal pure returns (string memory) {
        unchecked {
            return toHexString(value, Math.log256(value) + 1);
        }
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
     */
    function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
        uint256 localValue = value;
        bytes memory buffer = new bytes(2 * length + 2);
        buffer[0] = "0";
        buffer[1] = "x";
        for (uint256 i = 2 * length + 1; i > 1; --i) {
            buffer[i] = HEX_DIGITS[localValue & 0xf];
            localValue >>= 4;
        }
        if (localValue != 0) {
            revert StringsInsufficientHexLength(value, length);
        }
        return string(buffer);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
     * representation.
     */
    function toHexString(address addr) internal pure returns (string memory) {
        return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
     * representation, according to EIP-55.
     */
    function toChecksumHexString(address addr) internal pure returns (string memory) {
        bytes memory buffer = bytes(toHexString(addr));

        // hash the hex part of buffer (skip length + 2 bytes, length 40)
        uint256 hashValue;
        assembly ("memory-safe") {
            hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
        }

        for (uint256 i = 41; i > 1; --i) {
            // possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
            if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
                // case shift by xoring with 0x20
                buffer[i] ^= 0x20;
            }
            hashValue >>= 4;
        }
        return string(buffer);
    }

    /**
     * @dev Returns true if the two strings are equal.
     */
    function equal(string memory a, string memory b) internal pure returns (bool) {
        return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
    }

    /**
     * @dev Parse a decimal string and returns the value as a `uint256`.
     *
     * Requirements:
     * - The string must be formatted as `[0-9]*`
     * - The result must fit into an `uint256` type
     */
    function parseUint(string memory input) internal pure returns (uint256) {
        return parseUint(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `[0-9]*`
     * - The result must fit into an `uint256` type
     */
    function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
        (bool success, uint256 value) = tryParseUint(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
        return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
     * character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseUint(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, uint256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseUintUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseUintUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, uint256 value) {
        bytes memory buffer = bytes(input);

        uint256 result = 0;
        for (uint256 i = begin; i < end; ++i) {
            uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
            if (chr > 9) return (false, 0);
            result *= 10;
            result += chr;
        }
        return (true, result);
    }

    /**
     * @dev Parse a decimal string and returns the value as a `int256`.
     *
     * Requirements:
     * - The string must be formatted as `[-+]?[0-9]*`
     * - The result must fit in an `int256` type.
     */
    function parseInt(string memory input) internal pure returns (int256) {
        return parseInt(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `[-+]?[0-9]*`
     * - The result must fit in an `int256` type.
     */
    function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
        (bool success, int256 value) = tryParseInt(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
     * the result does not fit in a `int256`.
     *
     * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
     */
    function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
        return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
    }

    uint256 private constant ABS_MIN_INT256 = 2 ** 255;

    /**
     * @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
     * character or if the result does not fit in a `int256`.
     *
     * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
     */
    function tryParseInt(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, int256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseIntUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseIntUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, int256 value) {
        bytes memory buffer = bytes(input);

        // Check presence of a negative sign.
        bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        bool positiveSign = sign == bytes1("+");
        bool negativeSign = sign == bytes1("-");
        uint256 offset = (positiveSign || negativeSign).toUint();

        (bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);

        if (absSuccess && absValue < ABS_MIN_INT256) {
            return (true, negativeSign ? -int256(absValue) : int256(absValue));
        } else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
            return (true, type(int256).min);
        } else return (false, 0);
    }

    /**
     * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
     *
     * Requirements:
     * - The string must be formatted as `(0x)?[0-9a-fA-F]*`
     * - The result must fit in an `uint256` type.
     */
    function parseHexUint(string memory input) internal pure returns (uint256) {
        return parseHexUint(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
     * - The result must fit in an `uint256` type.
     */
    function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
        (bool success, uint256 value) = tryParseHexUint(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
        return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
     * invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseHexUint(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, uint256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseHexUintUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseHexUintUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, uint256 value) {
        bytes memory buffer = bytes(input);

        // skip 0x prefix if present
        bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        uint256 offset = hasPrefix.toUint() * 2;

        uint256 result = 0;
        for (uint256 i = begin + offset; i < end; ++i) {
            uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
            if (chr > 15) return (false, 0);
            result *= 16;
            unchecked {
                // Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
                // This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked.
                result += chr;
            }
        }
        return (true, result);
    }

    /**
     * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
     *
     * Requirements:
     * - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
     */
    function parseAddress(string memory input) internal pure returns (address) {
        return parseAddress(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
     */
    function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
        (bool success, address value) = tryParseAddress(input, begin, end);
        if (!success) revert StringsInvalidAddressFormat();
        return value;
    }

    /**
     * @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
     * formatted address. See {parseAddress-string} requirements.
     */
    function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
        return tryParseAddress(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
     * formatted address. See {parseAddress-string-uint256-uint256} requirements.
     */
    function tryParseAddress(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, address value) {
        if (end > bytes(input).length || begin > end) return (false, address(0));

        bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        uint256 expectedLength = 40 + hasPrefix.toUint() * 2;

        // check that input is the correct length
        if (end - begin == expectedLength) {
            // length guarantees that this does not overflow, and value is at most type(uint160).max
            (bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
            return (s, address(uint160(v)));
        } else {
            return (false, address(0));
        }
    }

    function _tryParseChr(bytes1 chr) private pure returns (uint8) {
        uint8 value = uint8(chr);

        // Try to parse `chr`:
        // - Case 1: [0-9]
        // - Case 2: [a-f]
        // - Case 3: [A-F]
        // - otherwise not supported
        unchecked {
            if (value > 47 && value < 58) value -= 48;
            else if (value > 96 && value < 103) value -= 87;
            else if (value > 64 && value < 71) value -= 55;
            else return type(uint8).max;
        }

        return value;
    }

    /**
     * @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata.
     *
     * WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped.
     *
     * NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of
     * RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode
     * characters that are not in this range, but other tooling may provide different results.
     */
    function escapeJSON(string memory input) internal pure returns (string memory) {
        bytes memory buffer = bytes(input);
        bytes memory output = new bytes(2 * buffer.length); // worst case scenario
        uint256 outputLength = 0;

        for (uint256 i; i < buffer.length; ++i) {
            bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i));
            if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) {
                output[outputLength++] = "\\";
                if (char == 0x08) output[outputLength++] = "b";
                else if (char == 0x09) output[outputLength++] = "t";
                else if (char == 0x0a) output[outputLength++] = "n";
                else if (char == 0x0c) output[outputLength++] = "f";
                else if (char == 0x0d) output[outputLength++] = "r";
                else if (char == 0x5c) output[outputLength++] = "\\";
                else if (char == 0x22) {
                    // solhint-disable-next-line quotes
                    output[outputLength++] = '"';
                }
            } else {
                output[outputLength++] = char;
            }
        }
        // write the actual length and deallocate unused memory
        assembly ("memory-safe") {
            mstore(output, outputLength)
            mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63)))))
        }

        return string(output);
    }

    /**
     * @dev Reads a bytes32 from a bytes array without bounds checking.
     *
     * NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
     * assembly block as such would prevent some optimizations.
     */
    function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
        // This is not memory safe in the general case, but all calls to this private function are within bounds.
        assembly ("memory-safe") {
            value := mload(add(add(buffer, 0x20), offset))
        }
    }
}
AbrahamAuction.sol 997 lines
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;

import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {Pausable} from "@openzeppelin/contracts/utils/Pausable.sol";
import {AbrahamCovenant} from "./AbrahamCovenant.sol";

/**
 * @title AbrahamAuction
 * @author Eden Platform
 * @notice Multi-auction system for Abraham Covenant NFTs with batch auction creation
 * @dev Allows multiple simultaneous auctions with batch creation, withdrawal pattern for safety
 * @dev Outbid bidders can withdraw their funds using the withdrawal pattern
 */
contract AbrahamAuction is Ownable, ReentrancyGuard, Pausable {
    // ============ Events ============

    event AuctionCreated(
        uint256 indexed auctionId,
        uint256 indexed tokenId,
        uint256 startTime,
        uint256 endTime,
        uint256 minBid,
        uint256 reservePrice
    );
    event BidPlaced(
        uint256 indexed auctionId,
        address indexed bidder,
        uint256 amount,
        uint256 timestamp,
        uint256 newEndTime
    );
    event BatchAuctionsCreated(
        uint256[] auctionIds,
        uint256[] tokenIds,
        uint256 duration,
        uint256 reservePrice,
        uint256 count
    );
    event AuctionSettled(
        uint256 indexed auctionId,
        uint256 indexed tokenId,
        address indexed winner,
        uint256 winningBid
    );
    event AuctionCanceled(uint256 indexed auctionId, uint256 indexed tokenId);
    event FundsWithdrawn(address indexed user, uint256 amount);
    event StuckFundsRecovered(address indexed user, uint256 amount);
    event AccountingCorrected(address indexed user, uint256 oldAmount, uint256 newAmount);
    event MinBidUpdated(uint256 previousMinBid, uint256 newMinBid);
    event ExtensionWindowUpdated(uint256 previousWindow, uint256 newWindow);
    event ExtensionDurationUpdated(uint256 previousDuration, uint256 newDuration);
    event PayoutAddressUpdated(address previousAddress, address newAddress);
    event PayoutWithdrawn(address indexed recipient, uint256 amount);
    event BidHistoryUpdated(
        uint256 indexed auctionId,
        address indexed bidder,
        uint256 amount,
        uint256 timestamp
    );
    event BidRefunded(uint256 indexed auctionId, address indexed bidder, uint256 amount);
    event BidRefundFailed(uint256 indexed auctionId, address indexed bidder, uint256 amount);
    event OwnerWithdrewFor(address indexed user, address indexed recipient, uint256 amount);

    // ============ Errors ============

    error InvalidNFTContract();
    error InvalidPayoutAddress();
    error InvalidMinBid();
    error InvalidDuration();
    error InvalidReservePrice();
    error InvalidTokenId();
    error AuctionNotActive(uint256 auctionId);
    error AuctionNotEnded(uint256 auctionId);
    error AuctionEnded(uint256 auctionId);
    error AuctionAlreadyExists(uint256 tokenId);
    error BidTooLow(uint256 required, uint256 provided);
    error BelowReservePrice(uint256 reserve, uint256 provided);
    error NoFundsToWithdraw();
    error WithdrawalFailed();
    error AuctionAlreadySettled(uint256 auctionId);
    error EmptyBatchCreate();
    error ApprovalMissing();
    error InvalidExtensionParam();
    error CannotCancelWithBids();
    error NoStuckFundsForUser();
    error AccountingMismatch();
    error TooManyAuctions();
    error MaxExtensionsReached();
    error AlreadyHighestBidder();
    error BidTooHigh();

    // ============ Constants ============

    /// @notice Minimum bid floor (0.1 ETH)
    uint256 public constant MIN_BID_FLOOR = 0.1 ether;

    /// @notice Minimum bid increment percentage (500 = 5%)
    uint256 public constant MIN_BID_INCREMENT_BPS = 500;

    /// @notice Default extension window (5 minutes)
    uint256 public constant DEFAULT_EXTENSION_WINDOW = 5 minutes;

    /// @notice Default extension duration (5 minutes)
    uint256 public constant DEFAULT_EXTENSION_DURATION = 5 minutes;

    /// @notice Maximum auctions per batch operation
    uint256 public constant MAX_BATCH_SIZE = 50;

    /// @notice Maximum extensions per auction
    uint256 public constant MAX_AUCTION_EXTENSIONS = 1000;

    /// @notice Maximum global minimum bid (1000 ETH)
    uint256 public constant MAX_GLOBAL_MIN_BID = 1000 ether;

    /// @notice Maximum bid amount (type(uint96).max ~= 79 million ETH)
    uint256 public constant MAX_BID = type(uint96).max;

    // ============ Structs ============

    /**
     * @notice Auction data structure
     * @dev Optimized for storage: Uses 5 slots (160 bytes) instead of 9 slots (288 bytes) if unpacked
     * @dev highestBid uses uint96 (max: 79 million ETH - sufficient for art auctions)
     * @dev Final slot packs 5 fields: highestBidder(20) + highestBid(12) + extensionCount(1) + settled(1) + exists(1) = 35 bytes
     */
    struct Auction {
        uint256 tokenId; // slot 0
        uint256 startTime; // slot 1
        uint256 endTime; // slot 2
        uint256 minBid; // slot 3
        uint256 reservePrice; // slot 4
        address highestBidder; // slot 5 (20 bytes)
        uint96 highestBid; // slot 5 (12 bytes) - MAX: ~79M ETH
        uint8 extensionCount; // slot 5 (1 byte)
        bool settled; // slot 5 (1 byte)
        bool exists; // slot 5 (1 byte)
    }

    /**
     * @notice Bid history record
     * @dev Stored in append-only array per auction for transparency
     * @dev Packed: bidder(20) + amount(12) + timestamp(4) = 36 bytes
     */
    struct BidRecord {
        address bidder; // Address who placed the bid
        uint96 amount; // Bid amount in wei (matches Auction.highestBid type)
        uint32 timestamp; // When the bid was placed
    }

    // ============ State Variables ============

    /// @notice AbrahamCovenant NFT contract instance
    AbrahamCovenant public immutable nftContract;

    /// @notice Current auction ID counter (starts at 1 to avoid sentinel collision)
    uint256 private _auctionIdCounter = 1;

    /// @notice Global minimum bid (can be updated by owner)
    uint256 public globalMinBid;

    /// @notice Time window before auction end that triggers extension
    uint256 public extensionWindow;

    /// @notice Duration to extend auction by
    uint256 public extensionDuration;

    /// @notice Address to receive auction proceeds
    address public payoutAddress;

    /// @notice Mapping of auction ID to auction data
    mapping(uint256 => Auction) public auctions;

    /// @notice Mapping of token ID to auction ID (0 if no auction exists)
    mapping(uint256 => uint256) public tokenToAuction;

    /// @notice Mapping of user address to withdrawable balance
    mapping(address => uint256) public pendingWithdrawals;

    /// @notice Total amount held in pending withdrawals
    uint256 public totalPendingWithdrawals;

    /// @notice Total ETH escrowed in active (unsettled) auction bids
    /// @dev Prevents owner from withdrawing funds before NFT delivery
    uint256 public escrowedActiveBids;

    /// @notice Total realized proceeds from settled auctions
    /// @dev Only these funds are withdrawable by owner
    uint256 public realizedProceeds;

    /// @notice Mapping of auction ID to bid history (append-only)
    mapping(uint256 => BidRecord[]) private _bidHistory;

    // ============ Constructor ============

    /**
     * @notice Initializes the AbrahamAuction contract
     * @param _nftContract Address of the AbrahamCovenant contract
     * @param _owner Address that will own this contract
     * @param _payoutAddress Address to receive auction proceeds
     */
    constructor(address _nftContract, address _owner, address _payoutAddress) Ownable(_owner) {
        if (_nftContract == address(0)) revert InvalidNFTContract();
        if (_payoutAddress == address(0)) revert InvalidPayoutAddress();

        nftContract = AbrahamCovenant(_nftContract);
        payoutAddress = _payoutAddress;
        globalMinBid = MIN_BID_FLOOR;
        extensionWindow = DEFAULT_EXTENSION_WINDOW;
        extensionDuration = DEFAULT_EXTENSION_DURATION;

        emit PayoutAddressUpdated(address(0), _payoutAddress);
        emit MinBidUpdated(0, MIN_BID_FLOOR);
        emit ExtensionWindowUpdated(0, DEFAULT_EXTENSION_WINDOW);
        emit ExtensionDurationUpdated(0, DEFAULT_EXTENSION_DURATION);
    }

    // ============ External Functions - Auction Management ============

    /**
     * @notice Create a new auction for a specific token index
     * @dev Token must exist, be owned by covenant, and covenant must approve this contract
     * @param tokenId Token ID to auction (must be minted and owned by covenant)
     * @param startTime Auction start time (use 0 for immediate start)
     * @param duration Auction duration in seconds
     * @param reservePrice Reserve price (must be >= globalMinBid, 0 to use globalMinBid)
     * @return auctionId The ID of the created auction
     */
    function createAuction(
        uint256 tokenId,
        uint256 startTime,
        uint256 duration,
        uint256 reservePrice
    ) external onlyOwner whenNotPaused returns (uint256) {
        if (duration == 0) revert InvalidDuration();
        if (tokenId >= nftContract.maxSupply()) revert InvalidTokenId();
        if (tokenToAuction[tokenId] != 0) revert AuctionAlreadyExists(tokenId);

        // Verify NFT is owned by covenant contract
        // Note: ownerOf will revert with ERC721NonexistentToken if token doesn't exist
        address tokenOwner = nftContract.ownerOf(tokenId);
        if (tokenOwner != address(nftContract)) revert InvalidTokenId();

        // Verify this contract is approved to transfer the NFT
        if (!nftContract.isApprovedForAll(address(nftContract), address(this))) {
            revert ApprovalMissing();
        }

        // Reserve price must be at least globalMinBid
        uint256 actualReserve = reservePrice > 0 ? reservePrice : globalMinBid;
        if (actualReserve < globalMinBid) revert InvalidReservePrice();

        uint256 auctionId = _auctionIdCounter;
        unchecked {
            _auctionIdCounter = auctionId + 1;
        }

        uint256 actualStartTime = startTime > 0 ? startTime : block.timestamp;
        uint256 endTime = actualStartTime + duration;

        // Validate end time is in the future
        if (endTime <= block.timestamp) revert InvalidDuration();

        auctions[auctionId] = Auction({
            tokenId: tokenId,
            startTime: actualStartTime,
            endTime: endTime,
            minBid: globalMinBid,
            reservePrice: actualReserve,
            highestBidder: address(0),
            highestBid: 0,
            extensionCount: 0,
            settled: false,
            exists: true
        });

        tokenToAuction[tokenId] = auctionId;

        emit AuctionCreated(
            auctionId,
            tokenId,
            actualStartTime,
            endTime,
            globalMinBid,
            actualReserve
        );

        return auctionId;
    }

    /**
     * @notice Create multiple auctions at once with the same start time, duration and reserve price
     * @dev More gas efficient than calling createAuction multiple times
     * @param tokenIds Array of token IDs to auction (must be minted and owned by covenant)
     * @param startTime Auction start time (use 0 for immediate start, applied to all auctions)
     * @param duration Auction duration in seconds (applied to all auctions)
     * @param reservePrice Reserve price (must be >= globalMinBid, 0 to use globalMinBid, applied to all)
     * @return auctionIds Array of created auction IDs
     */
    function batchCreateAuctions(
        uint256[] calldata tokenIds,
        uint256 startTime,
        uint256 duration,
        uint256 reservePrice
    ) external onlyOwner whenNotPaused returns (uint256[] memory) {
        if (tokenIds.length == 0) revert EmptyBatchCreate();
        if (tokenIds.length > MAX_BATCH_SIZE) revert TooManyAuctions();
        if (duration == 0) revert InvalidDuration();

        // Reserve price must be at least globalMinBid
        uint256 actualReserve = reservePrice > 0 ? reservePrice : globalMinBid;
        if (actualReserve < globalMinBid) revert InvalidReservePrice();

        // Verify approval once (applies to all tokens)
        if (!nftContract.isApprovedForAll(address(nftContract), address(this))) {
            revert ApprovalMissing();
        }

        uint256[] memory auctionIds = new uint256[](tokenIds.length);
        uint256 actualStartTime = startTime > 0 ? startTime : block.timestamp;
        uint256 endTime = actualStartTime + duration;

        // Validate end time is in the future
        if (endTime <= block.timestamp) revert InvalidDuration();

        for (uint256 i = 0; i < tokenIds.length; i++) {
            uint256 tokenId = tokenIds[i];

            // Validate token
            if (tokenId >= nftContract.maxSupply()) revert InvalidTokenId();
            if (tokenToAuction[tokenId] != 0) revert AuctionAlreadyExists(tokenId);

            // Verify NFT is owned by covenant contract
            // Note: ownerOf will revert with ERC721NonexistentToken if token doesn't exist
            address tokenOwner = nftContract.ownerOf(tokenId);
            if (tokenOwner != address(nftContract)) revert InvalidTokenId();

            // Create auction
            uint256 auctionId = _auctionIdCounter;
            unchecked {
                _auctionIdCounter = auctionId + 1;
            }

            auctions[auctionId] = Auction({
                tokenId: tokenId,
                startTime: actualStartTime,
                endTime: endTime,
                minBid: globalMinBid,
                reservePrice: actualReserve,
                highestBidder: address(0),
                highestBid: 0,
                extensionCount: 0,
                settled: false,
                exists: true
            });

            tokenToAuction[tokenId] = auctionId;
            auctionIds[i] = auctionId;

            emit AuctionCreated(
                auctionId,
                tokenId,
                actualStartTime,
                endTime,
                globalMinBid,
                actualReserve
            );
        }

        emit BatchAuctionsCreated(auctionIds, tokenIds, duration, actualReserve, tokenIds.length);

        return auctionIds;
    }

    /**
     * @notice Place a bid on a specific auction
     * @param auctionId Auction ID to bid on
     * @dev Automatically refunds previous highest bidder
     * @dev If automatic refund fails, bidder can call withdraw() manually
     * @dev Uses 25k gas limit for refund to support smart contract wallets
     */
    function bid(uint256 auctionId) external payable nonReentrant whenNotPaused {
        Auction storage auction = auctions[auctionId];
        if (!auction.exists) revert AuctionNotActive(auctionId);
        if (auction.settled) revert AuctionAlreadySettled(auctionId);
        if (block.timestamp < auction.startTime) revert AuctionNotActive(auctionId);
        if (block.timestamp >= auction.endTime) revert AuctionEnded(auctionId);

        uint256 bidAmount = msg.value;

        // Check maximum bid (uint96 limit for gas optimization)
        if (bidAmount > MAX_BID) {
            revert BidTooHigh();
        }

        // Check minimum bid
        if (bidAmount < auction.minBid) {
            revert BidTooLow(auction.minBid, bidAmount);
        }

        // Check reserve price
        if (bidAmount < auction.reservePrice) {
            revert BelowReservePrice(auction.reservePrice, bidAmount);
        }

        // Prevent self-outbidding
        if (auction.highestBidder == msg.sender) {
            revert AlreadyHighestBidder();
        }

        // Check bid increment if there's already a bid
        if (auction.highestBidder != address(0)) {
            uint256 minIncrement = auction.highestBid +
                (auction.highestBid * MIN_BID_INCREMENT_BPS) /
                10000;
            if (bidAmount < minIncrement) {
                revert BidTooLow(minIncrement, bidAmount);
            }
        }

        // CEI Pattern: Store previous bidder info and update state BEFORE external call
        address previousBidder = auction.highestBidder;
        uint256 previousBid = auction.highestBid;

        auction.highestBidder = msg.sender;
        auction.highestBid = uint96(bidAmount);

        // Update escrow accounting
        if (previousBidder == address(0)) {
            // First bid: add entire amount to escrow
            escrowedActiveBids += bidAmount;
        } else {
            // Subsequent bid: add delta (new bid - old bid) to escrow
            // Note: previousBid is already in escrow, only add the difference
            escrowedActiveBids += (bidAmount - previousBid);
        }

        // Refund previous bidder (automatic with fallback to withdrawal pattern)
        if (previousBidder != address(0)) {
            // Try automatic refund first (gas limited to prevent griefing)
            (bool success, ) = previousBidder.call{value: previousBid, gas: 25000}("");

            if (success) {
                emit BidRefunded(auctionId, previousBidder, previousBid);
            } else {
                // Fallback to withdrawal pattern
                pendingWithdrawals[previousBidder] += previousBid;
                totalPendingWithdrawals += previousBid;
                emit BidRefundFailed(auctionId, previousBidder, previousBid);
            }
        }

        // Check if we need to extend auction (bid in last extension window)
        uint256 timeRemaining = auction.endTime - block.timestamp;
        uint256 newEndTime = auction.endTime;

        if (timeRemaining < extensionWindow) {
            // Check extension limit
            if (auction.extensionCount >= MAX_AUCTION_EXTENSIONS) {
                revert MaxExtensionsReached();
            }

            auction.extensionCount++;
            newEndTime = block.timestamp + extensionDuration;
            auction.endTime = newEndTime;
        }

        // Append to bid history (append-only for transparency)
        _bidHistory[auctionId].push(
            BidRecord({
                bidder: msg.sender,
                amount: uint96(bidAmount),
                timestamp: uint32(block.timestamp)
            })
        );

        emit BidPlaced(auctionId, msg.sender, bidAmount, block.timestamp, newEndTime);
        emit BidHistoryUpdated(auctionId, msg.sender, bidAmount, block.timestamp);
    }

    /**
     * @notice Settle an auction and transfer NFT to winner
     * @dev Can be called by anyone after auction ends
     * @dev Re-checks approval to prevent bricking if covenant revoked approval
     * @dev Uses safeTransferFrom to prevent NFTs getting stuck in contracts without ERC721Receiver
     * @param auctionId Auction ID to settle
     */
    function settleAuction(uint256 auctionId) external nonReentrant {
        Auction storage auction = auctions[auctionId];
        if (!auction.exists) revert AuctionNotActive(auctionId);
        if (block.timestamp < auction.endTime) revert AuctionNotEnded(auctionId);
        if (auction.settled) revert AuctionAlreadySettled(auctionId);

        // If no bids, mark as settled and cancel
        if (auction.highestBidder == address(0)) {
            auction.settled = true;
            tokenToAuction[auction.tokenId] = 0;
            emit AuctionCanceled(auctionId, auction.tokenId);
            return;
        }

        // Re-check approval before attempting transfer (prevents bricking)
        if (!nftContract.isApprovedForAll(address(nftContract), address(this))) {
            revert ApprovalMissing();
        }

        auction.settled = true;
        uint256 tokenId = auction.tokenId;
        uint256 winningBid = auction.highestBid;

        // Move funds from escrow to realized proceeds
        escrowedActiveBids -= winningBid;
        realizedProceeds += winningBid;

        // Clear tokenToAuction mapping
        tokenToAuction[tokenId] = 0;

        // Transfer NFT from covenant to winner (safe transfer prevents stuck NFTs)
        nftContract.safeTransferFrom(address(nftContract), auction.highestBidder, tokenId);

        emit AuctionSettled(auctionId, tokenId, auction.highestBidder, winningBid);
    }

    /**
     * @notice Cancel an auction (emergency only - no bids allowed)
     * @dev Can only cancel if no bids have been placed to prevent owner rug
     * @dev Prevents unfair cancellation after bidders have committed funds
     * @param auctionId Auction ID to cancel
     */
    function cancelAuction(uint256 auctionId) external onlyOwner nonReentrant {
        Auction storage auction = auctions[auctionId];
        if (!auction.exists) revert AuctionNotActive(auctionId);
        if (auction.settled) revert AuctionAlreadySettled(auctionId);

        // Prevent cancellation if bids exist (prevents owner rug)
        if (auction.highestBidder != address(0)) {
            revert CannotCancelWithBids();
        }

        auction.settled = true;
        tokenToAuction[auction.tokenId] = 0;
        emit AuctionCanceled(auctionId, auction.tokenId);
    }

    /**
     * @notice Withdraw pending funds
     * @dev Uses withdrawal pattern for safety (pull over push)
     */
    function withdraw() external nonReentrant {
        uint256 amount = pendingWithdrawals[msg.sender];
        if (amount == 0) revert NoFundsToWithdraw();

        pendingWithdrawals[msg.sender] = 0;
        totalPendingWithdrawals -= amount;

        (bool success, ) = payable(msg.sender).call{value: amount}("");
        if (!success) {
            // Restore balance on failure
            pendingWithdrawals[msg.sender] = amount;
            totalPendingWithdrawals += amount;
            revert WithdrawalFailed();
        }

        emit FundsWithdrawn(msg.sender, amount);
    }

    // ============ External Functions - Owner Only ============

    /**
     * @notice Update the global minimum bid
     * @dev Changes only affect NEW auctions; existing auctions use their snapshotted minBid
     * @dev Each auction stores its own minBid at creation time from globalMinBid
     * @param newMinBid New minimum bid (must be >= MIN_BID_FLOOR and <= MAX_GLOBAL_MIN_BID)
     */
    function updateGlobalMinBid(uint256 newMinBid) external onlyOwner {
        if (newMinBid < MIN_BID_FLOOR) revert InvalidMinBid();
        if (newMinBid > MAX_GLOBAL_MIN_BID) revert InvalidMinBid();

        uint256 previousMinBid = globalMinBid;
        globalMinBid = newMinBid;

        emit MinBidUpdated(previousMinBid, newMinBid);
    }

    /**
     * @notice Update the extension window
     * @dev Window must be <= 24 hours to prevent accidental misconfiguration
     * @param newWindow New extension window in seconds
     */
    function updateExtensionWindow(uint256 newWindow) external onlyOwner {
        if (newWindow > 24 hours) revert InvalidExtensionParam();

        uint256 previousWindow = extensionWindow;
        extensionWindow = newWindow;

        emit ExtensionWindowUpdated(previousWindow, newWindow);
    }

    /**
     * @notice Update the extension duration
     * @dev Duration must be <= 24 hours to prevent accidental misconfiguration
     * @param newDuration New extension duration in seconds
     */
    function updateExtensionDuration(uint256 newDuration) external onlyOwner {
        if (newDuration > 24 hours) revert InvalidExtensionParam();

        uint256 previousDuration = extensionDuration;
        extensionDuration = newDuration;

        emit ExtensionDurationUpdated(previousDuration, newDuration);
    }

    /**
     * @notice Update the payout address
     * @param newPayoutAddress New address to receive auction proceeds
     */
    function updatePayoutAddress(address newPayoutAddress) external onlyOwner {
        if (newPayoutAddress == address(0)) revert InvalidPayoutAddress();

        address previousAddress = payoutAddress;
        payoutAddress = newPayoutAddress;

        emit PayoutAddressUpdated(previousAddress, newPayoutAddress);
    }

    /**
     * @notice Pause the contract (emergency stop)
     */
    function pause() external onlyOwner {
        _pause();
    }

    /**
     * @notice Unpause the contract
     */
    function unpause() external onlyOwner {
        _unpause();
    }

    /**
     * @notice Withdraw auction proceeds to payout address
     * @dev Only withdraws realized proceeds from settled auctions
     * @dev Does not allow withdrawing escrowed bids from active auctions
     * @dev This prevents owner from taking funds before NFT delivery
     */
    function withdrawProceeds() external onlyOwner nonReentrant {
        uint256 amount = realizedProceeds;
        if (amount == 0) revert NoFundsToWithdraw();

        // Clear realized proceeds before transfer
        realizedProceeds = 0;

        (bool success, ) = payable(payoutAddress).call{value: amount}("");
        if (!success) {
            // Restore on failure
            realizedProceeds = amount;
            revert WithdrawalFailed();
        }

        emit PayoutWithdrawn(payoutAddress, amount);
    }

    /**
     * @notice Recover stuck funds from users who cannot receive ETH
     * @dev If a user has pending withdrawals but their address cannot receive ETH,
     *      admin can recover these funds to the payout address
     * @dev This prevents fund-locking from contracts with no receive/fallback functions
     * @param user Address of user whose stuck funds should be recovered
     */
    function recoverStuckFunds(address user) external onlyOwner nonReentrant {
        uint256 amount = pendingWithdrawals[user];
        if (amount == 0) revert NoStuckFundsForUser();

        // Try to send to user first (with gas limit to prevent griefing)
        (bool userSuccess, ) = payable(user).call{value: amount, gas: 10000}("");

        if (userSuccess) {
            // User can receive - complete normal withdrawal
            pendingWithdrawals[user] = 0;
            totalPendingWithdrawals -= amount;
            emit FundsWithdrawn(user, amount);
        } else {
            // User cannot receive - recover to payout address
            pendingWithdrawals[user] = 0;
            totalPendingWithdrawals -= amount;

            (bool payoutSuccess, ) = payable(payoutAddress).call{value: amount}("");
            if (!payoutSuccess) {
                // Restore state if payout also fails
                pendingWithdrawals[user] = amount;
                totalPendingWithdrawals += amount;
                revert WithdrawalFailed();
            }

            emit StuckFundsRecovered(user, amount);
        }
    }

    /**
     * @notice Owner can withdraw pending funds on behalf of a user (emergency only)
     * @param user Address to withdraw funds for
     * @dev Only callable by owner when contract is paused
     * @dev Sends to payoutAddress, not to user
     * @dev Useful if user's address can't receive ETH or in emergency situations
     */
    function ownerWithdrawFor(address user) external onlyOwner whenPaused nonReentrant {
        uint256 amount = pendingWithdrawals[user];
        if (amount == 0) revert NoFundsToWithdraw();

        // Clear user's pending balance
        pendingWithdrawals[user] = 0;
        totalPendingWithdrawals -= amount;

        // Send to payout address
        (bool success, ) = payoutAddress.call{value: amount}("");
        if (!success) {
            // Restore state if transfer fails
            pendingWithdrawals[user] = amount;
            totalPendingWithdrawals += amount;
            revert WithdrawalFailed();
        }

        emit OwnerWithdrewFor(user, payoutAddress, amount);
    }

    /**
     * @notice Emergency function to correct accounting mismatch
     * @dev Only callable by owner when contract is paused
     * @dev Use with extreme caution - only for fixing critical accounting errors
     * @param user Address whose pending withdrawal to correct
     * @param correctAmount Correct pending withdrawal amount for the user
     */
    function emergencyCorrectAccounting(
        address user,
        uint256 correctAmount
    ) external onlyOwner whenPaused nonReentrant {
        uint256 oldAmount = pendingWithdrawals[user];

        // Update total first (prevents underflow if correctAmount < oldAmount)
        if (correctAmount > oldAmount) {
            totalPendingWithdrawals += (correctAmount - oldAmount);
        } else {
            totalPendingWithdrawals -= (oldAmount - correctAmount);
        }

        pendingWithdrawals[user] = correctAmount;

        emit AccountingCorrected(user, oldAmount, correctAmount);
    }

    // ============ External View Functions ============

    /**
     * @notice Get auction information
     * @param auctionId Auction ID
     * @return Auction struct data
     */
    function getAuction(uint256 auctionId) external view returns (Auction memory) {
        return auctions[auctionId];
    }

    /**
     * @notice Check if an auction is active (exists, not settled, started, not ended)
     * @param auctionId Auction ID
     * @return True if auction is active and accepting bids
     */
    function isAuctionActive(uint256 auctionId) external view returns (bool) {
        Auction storage auction = auctions[auctionId];
        return
            auction.exists &&
            !auction.settled &&
            block.timestamp >= auction.startTime &&
            block.timestamp < auction.endTime;
    }

    /**
     * @notice Get time remaining in an auction
     * @param auctionId Auction ID
     * @return Time remaining in seconds (0 if ended or doesn't exist)
     */
    function getTimeRemaining(uint256 auctionId) external view returns (uint256) {
        Auction storage auction = auctions[auctionId];
        if (!auction.exists || block.timestamp >= auction.endTime) return 0;
        return auction.endTime - block.timestamp;
    }

    /**
     * @notice Get pending withdrawal amount for a user
     * @param user User address
     * @return Amount available to withdraw
     */
    function getPendingWithdrawal(address user) external view returns (uint256) {
        return pendingWithdrawals[user];
    }

    /**
     * @notice Get next auction ID
     * @return Next auction ID that will be created
     */
    function nextAuctionId() external view returns (uint256) {
        return _auctionIdCounter;
    }

    /**
     * @notice Get multiple auctions at once
     * @param auctionIds Array of auction IDs to retrieve
     * @return Array of Auction struct data
     */
    function getAuctions(uint256[] calldata auctionIds) external view returns (Auction[] memory) {
        Auction[] memory result = new Auction[](auctionIds.length);
        for (uint256 i = 0; i < auctionIds.length; i++) {
            result[i] = auctions[auctionIds[i]];
        }
        return result;
    }

    /**
     * @notice Get auction IDs for given token IDs
     * @param tokenIds Array of token IDs
     * @return Array of auction IDs (0 if no active auction for token)
     */
    function getAuctionsByTokens(
        uint256[] calldata tokenIds
    ) external view returns (uint256[] memory) {
        uint256[] memory result = new uint256[](tokenIds.length);
        for (uint256 i = 0; i < tokenIds.length; i++) {
            result[i] = tokenToAuction[tokenIds[i]];
        }
        return result;
    }

    /**
     * @notice Check if auction needs settlement
     * @param auctionId Auction ID
     * @return True if auction ended and not yet settled
     */
    function needsSettlement(uint256 auctionId) external view returns (bool) {
        Auction storage auction = auctions[auctionId];
        return auction.exists && !auction.settled && block.timestamp >= auction.endTime;
    }

    /**
     * @notice Get contract balance accounting info
     * @return totalBalance Total ETH in contract
     * @return pendingTotal Total pending withdrawals for outbid bidders
     * @return escrowedBids Total escrowed in active (unsettled) auctions
     * @return realizedAmount Realized proceeds available for owner withdrawal
     */
    function getBalanceInfo()
        external
        view
        returns (
            uint256 totalBalance,
            uint256 pendingTotal,
            uint256 escrowedBids,
            uint256 realizedAmount
        )
    {
        totalBalance = address(this).balance;
        pendingTotal = totalPendingWithdrawals;
        escrowedBids = escrowedActiveBids;
        realizedAmount = realizedProceeds;
    }

    // ============ Bid History View Functions ============

    /**
     * @notice Get the total number of bids for an auction
     * @param auctionId Auction ID to query
     * @return Total number of bids in history
     */
    function getBidHistoryLength(uint256 auctionId) external view returns (uint256) {
        return _bidHistory[auctionId].length;
    }

    /**
     * @notice Get a slice of bid history for an auction
     * @param auctionId Auction ID to query
     * @param startIndex Starting index (inclusive)
     * @param endIndex Ending index (exclusive)
     * @return Array of BidRecord structs
     * @dev Returns empty array if startIndex >= history length
     * @dev Caps endIndex at history length automatically
     */
    function getBidHistory(
        uint256 auctionId,
        uint256 startIndex,
        uint256 endIndex
    ) external view returns (BidRecord[] memory) {
        BidRecord[] storage history = _bidHistory[auctionId];

        // Validate indices
        if (startIndex >= history.length) {
            return new BidRecord[](0);
        }

        // Cap endIndex at array length
        if (endIndex > history.length) {
            endIndex = history.length;
        }

        // Build result
        uint256 resultLength = endIndex - startIndex;
        BidRecord[] memory result = new BidRecord[](resultLength);

        for (uint256 i = 0; i < resultLength; i++) {
            result[i] = history[startIndex + i];
        }

        return result;
    }

    /**
     * @notice Get the most recent N bids for an auction
     * @param auctionId Auction ID to query
     * @param count Number of recent bids to return
     * @return Array of BidRecord structs (most recent last)
     * @dev Returns all bids if count > history length
     */
    function getRecentBidHistory(
        uint256 auctionId,
        uint256 count
    ) external view returns (BidRecord[] memory) {
        BidRecord[] storage history = _bidHistory[auctionId];

        if (history.length == 0) {
            return new BidRecord[](0);
        }

        uint256 resultCount = count > history.length ? history.length : count;
        uint256 startIndex = history.length - resultCount;

        BidRecord[] memory result = new BidRecord[](resultCount);
        for (uint256 i = 0; i < resultCount; i++) {
            result[i] = history[startIndex + i];
        }

        return result;
    }

    /**
     * @notice Get bid history for multiple auctions (batch query)
     * @param auctionIds Array of auction IDs to query
     * @param startIndex Starting index for each auction
     * @param endIndex Ending index for each auction
     * @return Array of BidRecord arrays (one per auction)
     */
    function getBidHistoryBatch(
        uint256[] calldata auctionIds,
        uint256 startIndex,
        uint256 endIndex
    ) external view returns (BidRecord[][] memory) {
        BidRecord[][] memory results = new BidRecord[][](auctionIds.length);

        for (uint256 i = 0; i < auctionIds.length; i++) {
            results[i] = this.getBidHistory(auctionIds[i], startIndex, endIndex);
        }

        return results;
    }

    /**
     * @notice Get recent bid history for multiple auctions (batch query)
     * @param auctionIds Array of auction IDs to query
     * @param count Number of recent bids to return per auction
     * @return Array of BidRecord arrays (one per auction)
     */
    function getRecentBidHistoryBatch(
        uint256[] calldata auctionIds,
        uint256 count
    ) external view returns (BidRecord[][] memory) {
        BidRecord[][] memory results = new BidRecord[][](auctionIds.length);

        for (uint256 i = 0; i < auctionIds.length; i++) {
            results[i] = this.getRecentBidHistory(auctionIds[i], count);
        }

        return results;
    }

    // ============ Receive Functions ============

    /**
     * @notice Prevent accidental ETH sends
     */
    receive() external payable {
        revert("Use bid() function");
    }

    /**
     * @notice Fallback function
     */
    fallback() external payable {
        revert("Use bid() function");
    }
}
AbrahamCovenant.sol 746 lines
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;

import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import {ERC721Holder} from "@openzeppelin/contracts/token/ERC721/utils/ERC721Holder.sol";
import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";

/**
 * @title AbrahamCovenant
 * @author Eden Platform
 * @notice NFT contract for Abraham Covenant collection with controlled minting
 * @dev Implements ERC721 with Abraham controlling daily work and Owner controlling sales mechanics
 * @dev Abraham controls daily work commitments and work cycle
 * @dev Owner (deployer) controls sales mechanism configuration
 * @dev Inherits ERC721Holder to safely receive NFTs minted to itself (covenant pattern)
 */
contract AbrahamCovenant is ERC721, ERC721Holder, Ownable, ReentrancyGuard {
    // ============ Events ============

    event NFTMinted(uint256 indexed tokenId, address indexed recipient);
    event DailyWorkCommitted(uint256 indexed dayNumber, uint256 indexed tokenId, uint256 timestamp);
    event DayMissed(uint256 indexed dayNumber, uint256 indexed tokenId);
    event SalesMechanicUpdated(address previousMechanic, address newMechanic);
    event MechanicOperatorSet(address indexed mechanic, bool approved);
    event SalesMechanicRotated(address indexed previous, address indexed current, bool approved);
    event RestDayTaken(uint256 timestamp, uint256 cycleSize);
    event WorkCycleUpdated(uint256 previousCycle, uint256 newCycle);
    event CovenantBreached(uint256 timestamp, uint256 lastCommitTimestamp);
    event CovenantStarted(uint256 timestamp);
    event AbrahamAddressUpdated(address indexed previousAbraham, address indexed newAbraham);

    // ============ Errors ============

    error MaxSupplyExceeded(uint256 requested, uint256 maxSupply);
    error MaxSupplyCannotBeZero();
    error InvalidRecipient();
    error AlreadyCommittedToday();
    error OnlyAbraham();
    error EmptyTokenURI();
    error MustRestBeforeNextWork();
    error NotYetTimeToRest();
    error AlreadyRested();
    error AlreadyRestedToday();
    error CannotRestOnSameDayAsWork();
    error SalesMechanicNotSet();
    error SalesMechanicCannotBeSelf();
    error CovenantBroken();
    error CovenantNotStarted();
    error CovenantAlreadyStarted();
    error StartTimeWouldCauseBreach(uint256 timeSinceStart, uint256 maxAllowed);

    // ============ State Variables ============

    /// @notice Current token ID counter (starts at 0)
    uint256 private _tokenIdCounter = 0;

    /// @notice Maximum number of tokens that can ever be minted (immutable for trust)
    uint256 public immutable maxSupply;

    /// @notice Sales mechanism address (for NFT approvals)
    address public salesMechanic;

    /// @notice Abraham's address (the only one who can commit daily work)
    address public abraham;

    /// @notice Mapping from token ID to token URI (each piece has unique metadata)
    mapping(uint256 => string) private _tokenURIs;

    /// @notice Tracks daily work commitments (optimized for gas)
    struct DailyWork {
        uint256 tokenId; // Links to the minted NFT
        uint256 timestamp; // When the work was committed
        bool exists; // True if work was committed on this day (handles tokenId 0 case)
    }

    /// @notice Mapping from day number to daily work
    mapping(uint256 => DailyWork) internal _dailyWorks;

    /// @notice Last day Abraham committed work (prevents multiple commits per day)
    uint256 public lastCommitDay;

    /// @notice Last day Abraham took rest (prevents multiple rest calls per day)
    uint256 public lastRestDay;

    /// @notice Covenant start timestamp - used as epoch for day calculations
    /// @dev Set to 0 initially, Abraham must call startCovenant() to begin
    uint256 public covenantStartTimestamp;

    /// @notice Number of consecutive works before rest is required (0 = infinite, no rest required)
    uint256 public daysOfWork;

    /// @notice Count of works completed since last rest
    uint256 public worksSinceLastRest;

    /// @notice Tracks if Abraham needs to take a rest day before next commit
    bool public needsRest;

    /// @notice Timestamp of the last commit (for breach detection)
    uint256 public lastCommitTimestamp;

    /// @notice Commit interval in seconds (60 seconds = 1 minute)
    uint256 public constant COMMIT_INTERVAL = 60;

    /// @notice Grace period in seconds (7 intervals = 420 seconds = 7 minutes)
    uint256 public constant GRACE_PERIOD = 60 * 7;

    /// @notice Whether the covenant has been broken
    bool public covenantBroken;

    // ============ Constructor ============

    /**
     * @notice Initializes the AbrahamCovenant NFT contract
     * @param _name NFT collection name
     * @param _symbol NFT collection symbol
     * @param _owner Owner address (deployer, controls sales mechanics)
     * @param _abraham Abraham's address (controls daily work commitments)
     * @param _maxSupply Maximum number of tokens that can be minted (immutable)
     * @param _daysOfWork Number of days to work before rest (0 = infinite, no rest days)
     */
    constructor(
        string memory _name,
        string memory _symbol,
        address _owner,
        address _abraham,
        uint256 _maxSupply,
        uint256 _daysOfWork
    ) ERC721(_name, _symbol) Ownable(_owner) {
        if (_maxSupply == 0) revert MaxSupplyCannotBeZero();
        if (_abraham == address(0)) revert InvalidRecipient();

        abraham = _abraham;
        maxSupply = _maxSupply;
        covenantStartTimestamp = 0; // Not started yet, Abraham must call startCovenant()
        daysOfWork = _daysOfWork;
        worksSinceLastRest = 0;
        needsRest = false;
        lastCommitTimestamp = 0;
        covenantBroken = false;

        emit WorkCycleUpdated(0, _daysOfWork);
    }

    // ============ Modifiers ============

    /**
     * @dev Ensures only Abraham can call the function
     */
    modifier onlyAbraham() {
        if (msg.sender != abraham) {
            revert OnlyAbraham();
        }
        _;
    }

    // ============ Internal Functions ============

    /**
     * @dev Internal helper to check if covenant has actually started (past start timestamp)
     * @return True if covenant start time has been reached
     */
    function _hasStarted() internal view returns (bool) {
        return covenantStartTimestamp != 0 && block.timestamp >= covenantStartTimestamp;
    }

    /**
     * @dev Safe helper to calculate time elapsed since a timestamp
     * @dev Returns 0 if current time is before the timestamp (future-proofing)
     * @param t The timestamp to measure from
     * @return Time elapsed in seconds, or 0 if t is in the future
     */
    function _timeSince(uint256 t) internal view returns (uint256) {
        return block.timestamp > t ? block.timestamp - t : 0;
    }

    /**
     * @dev Internal function to check and enforce covenant breach
     * @dev Called at the start of commitDailyWork() and takeRestDay()
     * @dev Reverts if covenant is broken or becomes broken during this call
     */
    function _checkAndEnforceCovenantBreach() internal {
        // Covenant must be started
        if (covenantStartTimestamp == 0) revert CovenantNotStarted();

        // If already marked as broken, revert immediately
        if (covenantBroken) revert CovenantBroken();

        // Calculate time since last commit
        uint256 timeSinceLastCommit;
        if (lastCommitTimestamp == 0) {
            // No commits yet - check time since covenant start
            timeSinceLastCommit = _timeSince(covenantStartTimestamp);
        } else {
            // Check time since last actual commit
            timeSinceLastCommit = _timeSince(lastCommitTimestamp);
        }

        // Check if grace period has expired
        if (timeSinceLastCommit >= GRACE_PERIOD) {
            covenantBroken = true;
            emit CovenantBreached(block.timestamp, lastCommitTimestamp);
            revert CovenantBroken();
        }
    }

    // ============ External Functions - Daily Covenant ============

    /**
     * @notice Abraham commits his daily work and mints NFT to covenant
     * @dev Can only be called by Abraham, once per day
     * @dev If daysOfWork > 0, enforces rest after completing the cycle
     * @dev Token ID increments sequentially based on works completed (not day number)
     * @param uri IPFS URI for this piece's metadata (e.g., "ipfs://QmAbc...")
     * @return tokenId The ID of the minted token
     */
    function commitDailyWork(
        string calldata uri
    ) external nonReentrant onlyAbraham returns (uint256) {
        // Covenant must be started
        if (!_hasStarted()) revert CovenantNotStarted();

        // Check covenant breach FIRST (will revert if broken)
        _checkAndEnforceCovenantBreach();

        if (bytes(uri).length == 0) revert EmptyTokenURI();

        // Calculate current day number (intervals since covenant start)
        uint256 currentDay = _timeSince(covenantStartTimestamp) / COMMIT_INTERVAL;

        // Ensure Abraham hasn't already committed in this interval
        if (_dailyWorks[currentDay].exists) {
            revert AlreadyCommittedToday();
        }

        // Enforce rest day if required (only if daysOfWork > 0)
        if (needsRest) {
            revert MustRestBeforeNextWork();
        }

        // Calculate missed days and mint null tokens to Abraham
        uint256 daysMissed = 0;
        if (lastCommitDay > 0 || _tokenIdCounter > 0) {
            // Calculate how many days were skipped
            daysMissed = currentDay - lastCommitDay - 1;
        }

        // Check max supply including missed days (safer subtraction-based check)
        uint256 remaining = maxSupply - _tokenIdCounter; // reverts if counter > maxSupply
        uint256 toMint = daysMissed + 1; // null tokens + current work
        if (toMint > remaining) {
            revert MaxSupplyExceeded(_tokenIdCounter + toMint, maxSupply);
        }

        // Mint null tokens for missed days to Abraham
        for (uint256 i = 0; i < daysMissed; i++) {
            uint256 missedDay = lastCommitDay + i + 1;
            uint256 missedTokenId = _tokenIdCounter;

            // Store the missed day work (null token)
            _dailyWorks[missedDay] = DailyWork({
                tokenId: missedTokenId,
                timestamp: 0, // Zero timestamp for missed days
                exists: true
            });

            // Store empty token URI
            _tokenURIs[missedTokenId] = "";

            // Mint null token to Abraham (not covenant contract)
            _safeMint(abraham, missedTokenId);

            // Increment counter
            unchecked {
                _tokenIdCounter++;
            }

            emit DayMissed(missedDay, missedTokenId);
        }

        // Token ID = number of works completed (sequential, not day-based)
        uint256 tokenId = _tokenIdCounter;

        // Store the daily work
        _dailyWorks[currentDay] = DailyWork({
            tokenId: tokenId,
            timestamp: block.timestamp,
            exists: true
        });

        // Store token URI for this specific token
        _tokenURIs[tokenId] = uri;

        // Update last commit day
        lastCommitDay = currentDay;

        // Mint NFT to covenant contract (self)
        _safeMint(address(this), tokenId);

        // Note: Sales mechanic uses operator approval (setApprovalForAll)
        // instead of per-token approvals to handle mechanic rotations

        // Increment counter (next token ID)
        unchecked {
            _tokenIdCounter = tokenId + 1;
        }

        // Track work cycle (if daysOfWork > 0, enforce rest)
        if (daysOfWork > 0) {
            worksSinceLastRest++;

            // If completed the work cycle, require rest before next commit
            if (worksSinceLastRest >= daysOfWork) {
                needsRest = true;
            }
        }

        // Update last commit timestamp for breach detection
        lastCommitTimestamp = block.timestamp;

        emit DailyWorkCommitted(currentDay, tokenId, block.timestamp);
        emit NFTMinted(tokenId, address(this));

        return tokenId;
    }

    /**
     * @notice Abraham takes a rest day after completing work cycle
     * @dev Can only be called after completing daysOfWork commits
     * @dev Can be called anytime during a calendar day (like commitDailyWork)
     * @dev Cannot be called on same day as work commit
     * @dev Resets work counter and allows next cycle to begin
     */
    function takeRestDay() external nonReentrant onlyAbraham {
        // Covenant must be started
        if (!_hasStarted()) revert CovenantNotStarted();

        // Check covenant breach FIRST (will revert if broken)
        _checkAndEnforceCovenantBreach();

        // If daysOfWork is 0 (infinite mode), rest is not required
        if (daysOfWork == 0) {
            revert NotYetTimeToRest();
        }

        // Must have completed at least daysOfWork commits
        if (worksSinceLastRest < daysOfWork) {
            revert NotYetTimeToRest();
        }

        // Must need rest (can't rest twice in a row without working)
        if (!needsRest) {
            revert AlreadyRested();
        }

        // Calculate current day number (intervals since covenant start)
        uint256 currentDay = _timeSince(covenantStartTimestamp) / COMMIT_INTERVAL;

        // Cannot rest on same interval as work commit
        if (currentDay == lastCommitDay) {
            revert CannotRestOnSameDayAsWork();
        }

        // Cannot rest multiple times on same day
        if (currentDay == lastRestDay) {
            revert AlreadyRestedToday();
        }

        // Update last rest day
        lastRestDay = currentDay;

        // Reset counters
        worksSinceLastRest = 0;
        needsRest = false;

        emit RestDayTaken(block.timestamp, daysOfWork);
    }

    /**
     * @notice Start the covenant and begin the grace period timer
     * @dev Can only be called once by Abraham
     * @dev Sets the covenant start timestamp which begins the daily work cycle
     * @dev Must be called before commitDailyWork() or takeRestDay()
     * @dev Start time cannot be more than GRACE_PERIOD ago (prevents immediate breach)
     * @param _startTimestamp The timestamp when the covenant begins (use block.timestamp for immediate start, or future timestamp for scheduled start)
     */
    function startCovenant(uint256 _startTimestamp) external onlyAbraham {
        // Can only start once
        if (covenantStartTimestamp != 0) revert CovenantAlreadyStarted();

        // Ensure start time won't cause immediate breach
        uint256 timeSinceStart = block.timestamp > _startTimestamp
            ? block.timestamp - _startTimestamp
            : 0;

        if (timeSinceStart >= GRACE_PERIOD) {
            revert StartTimeWouldCauseBreach(timeSinceStart, GRACE_PERIOD);
        }

        covenantStartTimestamp = _startTimestamp;

        // Set lastCommitTimestamp to start time so breach checking begins from that moment
        lastCommitTimestamp = _startTimestamp;

        emit CovenantStarted(_startTimestamp);
    }

    // ============ External Functions - Minting ============

    // ============ External Functions - Abraham Only ============

    /**
     * @notice Update the sales mechanism address
     * @dev Can only be called by owner (deployer)
     * @dev Does NOT automatically grant operator approval - call setMechanicOperator separately
     * @param _salesMechanic New sales mechanism address
     */
    function updateSalesMechanic(address _salesMechanic) external onlyOwner {
        // Prevent self-approval edge case (would revert in OZ _setApprovalForAll)
        if (_salesMechanic == address(this)) revert SalesMechanicCannotBeSelf();

        address previousMechanic = salesMechanic;
        salesMechanic = _salesMechanic;

        emit SalesMechanicUpdated(previousMechanic, _salesMechanic);
    }

    /**
     * @notice Set operator approval for the current sales mechanic
     * @dev Can only be called by owner (deployer)
     * @dev Uses setApprovalForAll to grant/revoke operator status
     * @dev This allows the mechanic to transfer ALL tokens owned by the contract
     * @dev Handles mechanic rotations cleanly - revoke old, approve new
     * @param approved True to grant approval, false to revoke
     */
    function setMechanicOperator(bool approved) external onlyOwner {
        address mechanic = salesMechanic;
        if (mechanic == address(0)) revert SalesMechanicNotSet();

        _setApprovalForAll(address(this), mechanic, approved);

        emit MechanicOperatorSet(mechanic, approved);
    }

    /**
     * @notice Atomically rotate sales mechanic (revoke old, update address, optionally approve new)
     * @dev Can only be called by owner (deployer)
     * @dev Recommended for mechanic rotations - handles approval management automatically
     * @dev Revokes old mechanic's approval, updates address, optionally approves new mechanic
     * @param _newMechanic New sales mechanism address (can be address(0) to clear)
     * @param approveNew True to grant operator approval to new mechanic, false to skip
     */
    function rotateSalesMechanic(address _newMechanic, bool approveNew) external onlyOwner {
        // Prevent self-approval edge case (would revert in OZ _setApprovalForAll)
        if (_newMechanic == address(this)) revert SalesMechanicCannotBeSelf();

        address prev = salesMechanic;

        // Revoke old operator if set
        if (prev != address(0)) {
            _setApprovalForAll(address(this), prev, false);
            emit MechanicOperatorSet(prev, false);
        }

        salesMechanic = _newMechanic;
        emit SalesMechanicUpdated(prev, _newMechanic);

        // Approve new mechanic if requested and not address(0)
        if (_newMechanic != address(0) && approveNew) {
            _setApprovalForAll(address(this), _newMechanic, true);
            emit MechanicOperatorSet(_newMechanic, true);
        }

        emit SalesMechanicRotated(prev, _newMechanic, approveNew);
    }

    /**
     * @notice Update the work cycle (days of work before rest)
     * @dev Can only be called by Abraham
     * @dev Set to 0 for infinite work mode (no rest days required)
     * @dev If currently needing rest and switching to infinite mode, clears rest requirement
     * @param _daysOfWork New work cycle (0 = infinite)
     */
    function updateWorkCycle(uint256 _daysOfWork) external onlyAbraham {
        uint256 previousCycle = daysOfWork;
        daysOfWork = _daysOfWork;

        // If switching to infinite mode (0), clear any rest requirements
        if (_daysOfWork == 0) {
            worksSinceLastRest = 0;
            needsRest = false;
        }

        emit WorkCycleUpdated(previousCycle, _daysOfWork);
    }

    /**
     * @notice Update Abraham's address
     * @dev Can only be called by owner (deployer)
     * @dev Critical for key rotation and recovery over 13-year covenant
     * @dev New address immediately gains control of daily work commitments
     * @param _newAbraham New Abraham address
     */
    function updateAbrahamAddress(address _newAbraham) external onlyOwner {
        if (_newAbraham == address(0)) revert InvalidRecipient();

        address previousAbraham = abraham;
        abraham = _newAbraham;

        emit AbrahamAddressUpdated(previousAbraham, _newAbraham);
    }

    // ============ External View Functions ============

    /**
     * @notice Get the current total supply of minted tokens
     * @dev This represents minted tokens, not burned tokens (mint counter)
     * @return The number of tokens currently minted
     */
    function totalSupply() external view returns (uint256) {
        return _tokenIdCounter;
    }

    /**
     * @notice Get the next token ID that will be minted
     * @return The next token ID
     */
    function nextTokenId() external view returns (uint256) {
        return _tokenIdCounter;
    }

    /**
     * @notice Get current day number (intervals since covenant start)
     * @return Current day number (0 if covenant not started or not yet reached)
     */
    function getCurrentDay() external view returns (uint256) {
        if (!_hasStarted()) return 0;
        return _timeSince(covenantStartTimestamp) / COMMIT_INTERVAL;
    }

    /**
     * @notice Check if Abraham has committed work in current interval
     * @return True if Abraham has already committed in this interval
     */
    function hasCommittedToday() external view returns (bool) {
        if (!_hasStarted()) return false;
        return lastCommitDay == (_timeSince(covenantStartTimestamp) / COMMIT_INTERVAL);
    }

    /**
     * @notice Get daily work by day number
     * @param dayNumber Day number to query
     * @return work The daily work struct
     */
    function getDailyWork(uint256 dayNumber) external view returns (DailyWork memory work) {
        return _dailyWorks[dayNumber];
    }

    /**
     * @notice Check if the maximum supply has been reached
     * @return True if max supply reached, false otherwise
     */
    function isMaxSupplyReached() external view returns (bool) {
        return _tokenIdCounter >= maxSupply;
    }

    /**
     * @notice Get remaining tokens that can be minted
     * @return Number of tokens that can still be minted
     */
    function remainingSupply() external view returns (uint256) {
        uint256 currentSupply = _tokenIdCounter;
        return currentSupply >= maxSupply ? 0 : maxSupply - currentSupply;
    }

    // ============ Public View Functions ============

    /**
     * @notice Get the token URI for a specific token
     * @dev Each token has a unique IPFS URI set when committed
     * @param tokenId The token ID to get the URI for
     * @return The IPFS URI for this token's metadata
     */
    function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
        _requireOwned(tokenId);
        return _tokenURIs[tokenId];
    }

    /**
     * @notice Check if this contract supports a given interface
     * @dev Includes support for IERC721Receiver (via ERC721Holder) for covenant pattern
     * @param interfaceId The interface identifier to check
     * @return True if this contract supports the interface
     */
    function supportsInterface(
        bytes4 interfaceId
    ) public view virtual override(ERC721) returns (bool) {
        return
            interfaceId == type(IERC721Receiver).interfaceId ||
            super.supportsInterface(interfaceId);
    }

    // ============ Breach Checking View Functions ============

    /**
     * @notice Check if the covenant is currently active
     * @dev Returns false if covenant not started OR start time not yet reached
     * @return True if covenant is active, false if broken or grace period expired
     */
    function isCovenantActive() public view returns (bool) {
        // If covenant not started or start time not reached, return false
        if (!_hasStarted()) return false;

        // If already broken, return false
        if (covenantBroken) return false;

        // Calculate time since last commit
        uint256 timeSinceLastCommit;
        if (lastCommitTimestamp == 0) {
            // No commits yet - check time since covenant start
            timeSinceLastCommit = _timeSince(covenantStartTimestamp);
        } else {
            timeSinceLastCommit = _timeSince(lastCommitTimestamp);
        }

        return timeSinceLastCommit < GRACE_PERIOD;
    }

    /**
     * @notice Get days remaining until covenant breach
     * @dev Returns type(uint256).max if not started or start time not reached
     * @return Number of days remaining, 0 if already breached
     */
    function daysUntilBreach() public view returns (uint256) {
        // If covenant not started or start time not reached, return max value
        if (!_hasStarted()) return type(uint256).max;

        // If already broken, return 0
        if (covenantBroken) return 0;

        // Calculate time since last commit
        uint256 timeSinceLastCommit;
        if (lastCommitTimestamp == 0) {
            timeSinceLastCommit = _timeSince(covenantStartTimestamp);
        } else {
            timeSinceLastCommit = _timeSince(lastCommitTimestamp);
        }

        // If already expired, return 0
        if (timeSinceLastCommit >= GRACE_PERIOD) return 0;

        return (GRACE_PERIOD - timeSinceLastCommit) / 1 days; // Still return in days for grace period
    }

    /**
     * @notice Get hours remaining until covenant breach
     * @dev Returns type(uint256).max if not started or start time not reached
     * @return Number of hours remaining, 0 if already breached
     */
    function hoursUntilBreach() public view returns (uint256) {
        // If covenant not started or start time not reached, return max value
        if (!_hasStarted()) return type(uint256).max;

        // If already broken, return 0
        if (covenantBroken) return 0;

        // Calculate time since last commit
        uint256 timeSinceLastCommit;
        if (lastCommitTimestamp == 0) {
            timeSinceLastCommit = _timeSince(covenantStartTimestamp);
        } else {
            timeSinceLastCommit = _timeSince(lastCommitTimestamp);
        }

        // If already expired, return 0
        if (timeSinceLastCommit >= GRACE_PERIOD) return 0;

        return (GRACE_PERIOD - timeSinceLastCommit) / 1 hours;
    }

    /**
     * @notice Check if covenant has been breached and update state
     * @dev Can be called by anyone to trigger breach detection
     * @return True if covenant is broken, false if still active
     */
    function checkCovenantBreach() external returns (bool) {
        // If covenant not started or start time not reached, return false
        if (!_hasStarted()) return false;

        // If already broken, return true
        if (covenantBroken) return true;

        // Calculate time since last commit
        uint256 timeSinceLastCommit;
        if (lastCommitTimestamp == 0) {
            timeSinceLastCommit = _timeSince(covenantStartTimestamp);
        } else {
            timeSinceLastCommit = _timeSince(lastCommitTimestamp);
        }

        // Check if grace period has expired
        if (timeSinceLastCommit >= GRACE_PERIOD) {
            covenantBroken = true;
            emit CovenantBreached(block.timestamp, lastCommitTimestamp);
            return true;
        }

        return false;
    }

    // ============ Rescue Functions ============

    /**
     * @notice Rescue ERC721 tokens sent to this contract
     * @dev Can only be called by owner (deployer)
     * @param c Token contract address
     * @param id Token ID to rescue
     * @param to Address to send the token to
     */
    function rescueERC721(address c, uint256 id, address to) external onlyOwner {
        IERC721(c).safeTransferFrom(address(this), to, id);
    }

    /**
     * @notice Rescue ERC20 tokens sent to this contract
     * @dev Can only be called by owner (deployer)
     * @param t Token contract address
     * @param to Address to send the tokens to
     * @param amt Amount of tokens to rescue
     */
    function rescueERC20(address t, address to, uint256 amt) external onlyOwner {
        IERC20(t).transfer(to, amt);
    }

    /**
     * @notice Rescue ETH sent to this contract
     * @dev Can only be called by owner (deployer)
     * @param to Address to send the ETH to
     */
    function rescueETH(address payable to) external onlyOwner {
        to.transfer(address(this).balance);
    }
}

Read Contract

DEFAULT_EXTENSION_DURATION 0x8eef5586 → uint256
DEFAULT_EXTENSION_WINDOW 0xdb2e2803 → uint256
MAX_AUCTION_EXTENSIONS 0x7c76e3fe → uint256
MAX_BATCH_SIZE 0xcfdbf254 → uint256
MAX_BID 0x4d91e1f7 → uint256
MAX_GLOBAL_MIN_BID 0x62c665b9 → uint256
MIN_BID_FLOOR 0x51af43b2 → uint256
MIN_BID_INCREMENT_BPS 0x14414cc0 → uint256
auctions 0x571a26a0 → uint256, uint256, uint256, uint256, uint256, address, uint96, uint8, bool, bool
escrowedActiveBids 0x2f8d602e → uint256
extensionDuration 0x2037424b → uint256
extensionWindow 0x1978c804 → uint256
getAuction 0x78bd7935 → tuple
getAuctions 0xf17b4fdf → tuple[]
getAuctionsByTokens 0x58e4101d → uint256[]
getBalanceInfo 0xfc00e628 → uint256, uint256, uint256, uint256
getBidHistory 0xf6e8fa7d → tuple[]
getBidHistoryBatch 0x2d22f6ba → tuple[][]
getBidHistoryLength 0x2e5629db → uint256
getPendingWithdrawal 0x7ee8b2f8 → uint256
getRecentBidHistory 0x441069c2 → tuple[]
getRecentBidHistoryBatch 0xab25080b → tuple[][]
getTimeRemaining 0x8cd42991 → uint256
globalMinBid 0x94a898c0 → uint256
isAuctionActive 0xe71f7b15 → bool
needsSettlement 0xa4b2bbb4 → bool
nextAuctionId 0xfc528482 → uint256
nftContract 0xd56d229d → address
owner 0x8da5cb5b → address
paused 0x5c975abb → bool
payoutAddress 0x5b8d02d7 → address
pendingWithdrawals 0xf3f43703 → uint256
realizedProceeds 0x0407e61c → uint256
tokenToAuction 0xbb19dd08 → uint256
totalPendingWithdrawals 0xa4563e03 → uint256

Write Contract 18 functions

These functions modify contract state and require a wallet transaction to execute.

batchCreateAuctions 0x5c1e9396
uint256[] tokenIds
uint256 startTime
uint256 duration
uint256 reservePrice
returns: uint256[]
bid 0x454a2ab3
uint256 auctionId
cancelAuction 0x96b5a755
uint256 auctionId
createAuction 0x431f21da
uint256 tokenId
uint256 startTime
uint256 duration
uint256 reservePrice
returns: uint256
emergencyCorrectAccounting 0x9f254dd1
address user
uint256 correctAmount
ownerWithdrawFor 0x7f9cf04b
address user
pause 0x8456cb59
No parameters
recoverStuckFunds 0x22a8b41e
address user
renounceOwnership 0x715018a6
No parameters
settleAuction 0x2e993611
uint256 auctionId
transferOwnership 0xf2fde38b
address newOwner
unpause 0x3f4ba83a
No parameters
updateExtensionDuration 0x309482d1
uint256 newDuration
updateExtensionWindow 0x8070849e
uint256 newWindow
updateGlobalMinBid 0x2ceb8bda
uint256 newMinBid
updatePayoutAddress 0x56200819
address newPayoutAddress
withdraw 0x3ccfd60b
No parameters
withdrawProceeds 0x9038e693
No parameters

Recent Transactions

No transactions found for this address