Address Contract Verified
Address
0x0959a6eaea3C23148Fe69ddd703c277Bc6Ad79CC
Balance
0 ETH
Nonce
1
Code Size
18169 bytes
Creator
0x52418a26...4463 at tx 0x1d84e5d2...6d1902
Indexed Transactions
0 (1 on-chain, 0.8% indexed)
Contract Bytecode
18169 bytes
0x608060405234801561001057600080fd5b506004361061038e5760003560e01c80637ecebe00116101de578063c3cda5201161010f578063e1dfc884116100ad578063f13253bb1161007c578063f13253bb1461081b578063f2fde38b14610823578063f36e051514610836578063fe575a871461086257600080fd5b8063e1dfc884146107cd578063e30c3978146107e0578063e5195157146107e8578063f1127ed8146107fb57600080fd5b8063c771909c116100e9578063c771909c14610797578063c7dac7041461079f578063d4593872146107b2578063dd62ed3e146107ba57600080fd5b8063c3cda5201461074a578063c455d4f61461075d578063c4d66de81461078457600080fd5b806395d89b411161017c5780639ab24eb0116101565780639ab24eb0146106fe578063a9059cbb14610711578063b6274f3d14610724578063bfc9c3591461073757600080fd5b806395d89b41146106c757806395d9538d146106cf578063967f1cc6146106f657600080fd5b80638da5cb5b116101b85780638da5cb5b146106845780638e539e8c1461068c57806391ddadf41461069f57806394d4827f146106b457600080fd5b80637ecebe001461064357806384b0196e146106565780638682db371461067157600080fd5b80634bf5d7e9116102c35780635c975abb11610261578063715018a611610230578063715018a61461060d57806379ba50971461061557806379cc67901461061d5780637df9a6741461063057600080fd5b80635c975abb146105af5780636fc9028e146105c75780636fcfff45146105da57806370a08231146105fa57600080fd5b8063587cde1e1161029d578063587cde1e1461053d5780635a2cba271461055d5780635aa42d12146105895780635c19a95c1461059c57600080fd5b80634bf5d7e91461050f57806356c531b91461051757806356f31c5d1461052a57600080fd5b806323b872dd116103305780632ad366871161030a5780632ad36687146104c7578063313ce567146104da5780633a46b1a8146104e957806342966c68146104fc57600080fd5b806323b872dd14610478578063241f1c991461048b578063252f3867146104b457600080fd5b80630c68ba211161036c5780630c68ba21146104055780630f861ca314610431578063152439db1461043b57806318160ddd1461045157600080fd5b806306433b1b1461039357806306fdde03146103d0578063095ea7b3146103e5575b600080fd5b6103ba7f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce81565b6040516103c79190613b75565b60405180910390f35b6103d8610875565b6040516103c79190613bd9565b6103f86103f3366004613c2b565b61091e565b6040516103c79190613c70565b6103f8610413366004613c7e565b6001600160a01b031660009081526001602052604090205460ff1690565b610439610938565b005b61044460005481565b6040516103c79190613ca5565b7f52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace0254610444565b6103f8610486366004613cb3565b610952565b7f0000000000000000000000000000000000000000000000000000000068b58ac04210156103f8565b6104396104c2366004613d55565b610978565b6104396104d5366004613c7e565b610989565b60126040516103c79190613da6565b6104446104f7366004613c2b565b6109a5565b61043961050a366004613db4565b610a34565b6103d8610a3e565b610439610525366004613de8565b610ab6565b610439610538366004613db4565b610acc565b61055061054b366004613c7e565b610b41565b6040516103c79190613e24565b6103f861056b366004613c7e565b6001600160a01b031660009081526002602052604090205460ff1690565b610439610597366004613de8565b610b6c565b6104396105aa366004613c7e565b610b7e565b6000805160206146a48339815191525460ff166103f8565b6103f86105d5366004613c7e565b610b89565b6105ed6105e8366004613c7e565b610cad565b6040516103c79190613e3e565b610444610608366004613c7e565b610cb8565b610439610ceb565b610439610d0c565b61043961062b366004613c2b565b610d48565b61043961063e366004613cb3565b610d5d565b610444610651366004613c7e565b6111e5565b61065e61120e565b6040516103c79796959493929190613eb9565b61043961067f366004613de8565b611292565b610550611321565b61044461069a366004613db4565b611356565b6106a76113c5565b6040516103c79190613f43565b6104396106c2366004613cb3565b6113d4565b6103d86114bc565b6104447f0000000000000000000000000000000000000000000000000000000068b58ac081565b6104396114fb565b61044461070c366004613c7e565b611513565b6103f861071f366004613c2b565b611633565b610439610732366004613de8565b611641565b610444610745366004613c7e565b611653565b610439610758366004613f65565b6116f4565b6103ba7f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb9502958381565b610439610792366004613c7e565b611798565b6105506118b0565b6104396107ad366004613de8565b6118cc565b610439611928565b6104446107c8366004613fef565b611930565b6104396107db366004613de8565b61197a565b610550611982565b6104446107f6366004613d55565b6119ab565b61080e610809366004614039565b611af6565b6040516103c7919061409f565b610444611b14565b610439610831366004613c7e565b611bad565b6103f8610844366004613c7e565b6001600160a01b031660009081526003602052604090205460ff1690565b6103f8610870366004613c7e565b611c32565b606060006000805160206146648339815191525b905080600301805461089a906140c3565b80601f01602080910402602001604051908101604052809291908181526020018280546108c6906140c3565b80156109135780601f106108e857610100808354040283529160200191610913565b820191906000526020600020905b8154815290600101906020018083116108f657829003601f168201915b505050505091505090565b60003361092c818585611c5e565b60019150505b92915050565b610940611c6b565b610948611c9d565b610950611ccd565b565b600033610960858285611d1c565b61096b858585611d69565b60019150505b9392505050565b33610984818484611dc8565b505050565b610991611c6b565b6109a261099c611e85565b82611ee5565b50565b6000600080516020614644833981519152816109bf6113c5565b90508065ffffffffffff1684106109f6578381604051637669fc0f60e11b81526004016109ed9291906140ef565b60405180910390fd5b610a22610a0285611f59565b6001600160a01b0387166000908152600185016020526040902090611f8b565b6001600160d01b031695945050505050565b6109a23382612041565b6060610a48612077565b65ffffffffffff16610a586113c5565b65ffffffffffff1614610a7e576040516301bfc1c560e61b815260040160405180910390fd5b5060408051808201909152601d81527f6d6f64653d626c6f636b6e756d6265722666726f6d3d64656661756c74000000602082015290565b610abe611c6b565b610ac88282612082565b5050565b610ad4611c6b565b6b1027e72f1f12813088000000811115610b015760405163cec0812160e01b815260040160405180910390fd5b60008190556040517fe891886eac9e583940fb0844098689693a4d105206ec1f789d119b4314383b9590610b36908390613ca5565b60405180910390a150565b6001600160a01b03908116600090815260008051602061464483398151915260205260409020541690565b610b746120e7565b610ac88282612119565b33610ac8818361218c565b60405163d68b948d60e01b81526000906001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce169063d68b948d90610bd8908590600401613e24565b602060405180830381865afa158015610bf5573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c199190614115565b158061093257506040516325b6123360e11b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690634b6c246690610c6c908590600401613e24565b602060405180830381865afa158015610c89573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109329190614115565b6000610932826121ff565b6000806000805160206146648339815191525b6001600160a01b0390931660009081526020939093525050604090205490565b610cf3611c6b565b60405163d623472560e01b815260040160405180910390fd5b3380610d16611982565b6001600160a01b031614610d3f578060405163118cdaa760e01b81526004016109ed9190613e24565b6109a281612250565b610d53823383611d1c565b610ac88282612041565b610d65611c6b565b604051630eb2335d60e21b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690633ac8cd7490610db1908690600401613e24565b602060405180830381865afa158015610dce573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610df29190614115565b8015610e06575080610e0384610cb8565b14155b15610e2457604051632dfd9c3960e01b815260040160405180910390fd5b60405163d68b948d60e01b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce169063d68b948d90610e70908590600401613e24565b602060405180830381865afa158015610e8d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610eb19190614115565b15610ed357828260405163314b500b60e21b81526004016109ed929190614136565b8015610eed57610ee38382612041565b610eed8282612288565b604051630eb2335d60e21b81526000906001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690633ac8cd7490610f3c908790600401613e24565b602060405180830381865afa158015610f59573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f7d9190614115565b1561100b57506040516302612aeb60e21b81526001906001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690630984abac90610fd49087908790600401614136565b600060405180830381600087803b158015610fee57600080fd5b505af1158015611002573d6000803e3d6000fd5b505050506111a2565b6040516325b6123360e11b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690634b6c246690611057908790600401613e24565b602060405180830381865afa158015611074573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110989190614115565b156111a257506040516302612aeb60e21b81526001906001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690630984abac906110ef9087908790600401614136565b600060405180830381600087803b15801561110957600080fd5b505af115801561111d573d6000803e3d6000fd5b50506040516302612aeb60e21b81526001600160a01b037f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583169250630984abac915061116f9087908790600401614136565b600060405180830381600087803b15801561118957600080fd5b505af115801561119d573d6000803e3d6000fd5b505050505b7f7010a46c57b41359be039fda242f641df5204a59c81af3f06adbf83171004006848484846040516111d79493929190614151565b60405180910390a150505050565b6000807f5ab42ced628888259c08ac98db1eb0cf702fc1501344311d8b100cd1bfe4bb00610ccb565b60006060808280808381600080516020614684833981519152805490915015801561123b57506001810154155b6112575760405162461bcd60e51b81526004016109ed9061418f565b61125f6122be565b6112676122fd565b60408051600080825260208201909252600f60f81b9c939b5091995046985030975095509350915050565b61129a611c6b565b6001600160a01b0382166112c157604051630da30f6560e31b815260040160405180910390fd5b6001600160a01b03821660008181526001602052604090819020805460ff1916841515179055517fca139a0ba60fe6426dd1d713a05ec0c645224f72d7a9912d64163974672dd41090611315908490613c70565b60405180910390a25050565b6000807f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c1993005b546001600160a01b031692915050565b6000600080516020614644833981519152816113706113c5565b90508065ffffffffffff16841061139e578381604051637669fc0f60e11b81526004016109ed9291906140ef565b6113b46113aa85611f59565b6002840190611f8b565b6001600160d01b0316949350505050565b60006113cf612077565b905090565b6113dc611c6b565b6001600160a01b03831661140357604051630da30f6560e31b815260040160405180910390fd5b8060000361142457604051632a9ffab760e21b815260040160405180910390fd5b6040516370a0823160e01b81526000906001600160a01b038416906370a0823190611453903090600401613e24565b602060405180830381865afa158015611470573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061149491906141e3565b9050808211156114a2578091505b6114b66001600160a01b0384168584612315565b50505050565b7f52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace0480546060916000805160206146648339815191529161089a906140c3565b611503611c6b565b61150b61236d565b61095061239e565b6001600160a01b03811660009081526003602052604081205460ff168061153e575061153e82611c32565b1561154b57506000919050565b60405163282de9ed60e11b81526000906001600160a01b037f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583169063505bd3da9061159a908690600401613e24565b602060405180830381865afa1580156115b7573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906115db91906141e3565b6115e4846123e7565b6115ee919061421a565b905060006115fb84610b41565b6001600160a01b03160361161f5761161283610cb8565b61161c908261421a565b90505b600054811115610932575050600054919050565b60003361092c818585611d69565b611649611c6b565b610ac88282612447565b600061165d61236d565b611665611c6b565b604051632e6639a560e21b81526001600160a01b037f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583169063b998e694906116b1908590600401613e24565b6020604051808303816000875af11580156116d0573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061093291906141e3565b834211156117175783604051632341d78760e11b81526004016109ed9190613ca5565b60006117796117717fe48329057bfd03d55e49b547132e39cffd9c1820ad7b9d4c5307691425d15adf898989604051602001611756949392919061422d565b60405160208183030381529060405280519060200120612706565b858585612733565b90506117858187612761565b61178f818861218c565b50505050505050565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805460029190600160401b900460ff16806117e25750805467ffffffffffffffff808416911610155b156118005760405163f92ee8a960e01b815260040160405180910390fd5b805468ffffffffffffffffff191667ffffffffffffffff831617600160401b17815561184c61182d610875565b604051806040016040528060018152602001601960f91b8152506127c5565b6000611856611e85565b90506118628185611ee5565b50805468ff0000000000000000191681556040517fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2906118a3908490614272565b60405180910390a1505050565b60006118ba611e85565b600101546001600160a01b0316919050565b6118d4611c6b565b6001600160a01b03821660008181526002602052604090819020805460ff1916841515179055517fe4b88447f604c5e795f270c2758f4822062b56a3c2fc8b75394b077ba1dbf8ff90611315908490613c70565b6115036120e7565b6001600160a01b0391821660009081527f52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace016020908152604080832093909416825291909152205490565b610b74611c6b565b6000807f237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00611346565b60006119b561236d565b336119c1818585611dc8565b60405163402914f560e01b81526001600160a01b037f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583169063402914f590611a0d908490600401613e24565b602060405180830381865afa158015611a2a573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a4e91906141e3565b600003611a5f576000915050610932565b604051632e6639a560e21b81527f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb950295836001600160a01b03169063b998e69490611aab903390600401613e24565b6020604051808303816000875af1158015611aca573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611aee91906141e3565b949350505050565b604080518082019091526000808252602082015261097183836127d7565b6000611b1e61236d565b604051632e6639a560e21b81527f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb950295836001600160a01b03169063b998e69490611b6a903390600401613e24565b6020604051808303816000875af1158015611b89573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113cf91906141e3565b611bb5611c6b565b7f237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c0080546001600160a01b0319166001600160a01b0383169081178255611bf9611321565b6001600160a01b03167f38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e2270060405160405180910390a35050565b6000611c3c611e85565b6001600160a01b03909216600090815260209290925250604090205460ff1690565b610984838383600161283a565b33611c74611321565b6001600160a01b031614610950573360405163118cdaa760e01b81526004016109ed9190613e24565b6000805160206146a48339815191525460ff1661095057604051638dfc202b60e01b815260040160405180910390fd5b611cd5611c9d565b6000805160206146a4833981519152805460ff191681557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b604051610b369190613e24565b6000611d288484611930565b905060001981146114b65781811015611d5a57828183604051637dc7a0d960e11b81526004016109ed93929190614280565b6114b68484848403600061283a565b6001600160a01b038316611d93576000604051634b637e8f60e11b81526004016109ed9190613e24565b6001600160a01b038216611dbd57600060405163ec442f0560e01b81526004016109ed9190613e24565b61098483838361286c565b6000611e007f214b6837b0cb36c3dfa2494ae052b630f55f351d9e069e1c5920491aa344a514856040516020016117569291906142a8565b9050611e428184848080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250612b2d92505050565b6001600160a01b0316611e536118b0565b6001600160a01b031614611e7a57604051638baa579f60e01b815260040160405180910390fd5b6114b6846000612447565b60008060ff19611eb660017f5d14c3535674e7f5942e30e2a55bfc241c205a216ca5bfc40c567afac5d67ad36142b6565b604051602001611ec69190613ca5565b60408051601f1981840301815291905280516020909101201692915050565b6001600160a01b038116611f0c5760405163371685cf60e11b815260040160405180910390fd5b6001820180546001600160a01b0319166001600160a01b0383169081179091556040517fdc26eaa07c3e782e27ef385f6a52197f10505eed55db43e69a3d522714d0875a90600090a25050565b600065ffffffffffff821115611f87576030826040516306dfcc6560e41b81526004016109ed9291906142dd565b5090565b815460009081816005811115611fea576000611fa684612b57565b611fb090856142b6565b60008881526020902090915081015465ffffffffffff9081169087161015611fda57809150611fe8565b611fe581600161421a565b92505b505b6000611ff887878585612c3f565b905080156120335761201d8761200f6001846142b6565b600091825260209091200190565b54600160301b90046001600160d01b0316612036565b60005b979650505050505050565b6001600160a01b03821661206b576000604051634b637e8f60e11b81526004016109ed9190613e24565b610ac88260008361286c565b60006113cf43611f59565b80156120935761209382600061218c565b6001600160a01b03821660008181526003602052604090819020805460ff1916841515179055517f662fe17a45a2827abeda36082dde83f496af4ace698c1db04e760bc78bd8be0390611315908490613c70565b3360008181526001602052604090205460ff166109a25780604051635a968dab60e01b81526004016109ed9190613e24565b801561212a5761212a82600061218c565b80612133611e85565b6001600160a01b0384166000818152602092909252604091829020805460ff191693151593909317909255517f5019745a56bcdd97726f5b35a7bfcb97ffa4e40b51bc2f6f764c6671e1bef6d490611315908490613c70565b3361219681612ca1565b826121a081612ca1565b826121aa81612ca1565b6121b261236d565b6001600160a01b03851660009081526003602052604090205460ff16156121ee578460405163064a023360e51b81526004016109ed9190613e24565b6121f88585612cfd565b5050505050565b6001600160a01b03811660009081527fe8b26c30fad74198956032a3533d903385d56dd795af560196f9c78d4af40d0160205260408120546000805160206146448339815191529061097190612d87565b7f237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c0080546001600160a01b0319168155610ac882612db3565b6001600160a01b0382166122b257600060405163ec442f0560e01b81526004016109ed9190613e24565b610ac86000838361286c565b7fa16a46d94261c7517cc8ff89f61c0ce93598e3c849801011dee649a6a557d10280546060916000805160206146848339815191529161089a906140c3565b60606000600080516020614684833981519152610889565b61098483846001600160a01b031663a9059cbb858560405160240161233b9291906142f8565b604051602081830303815290604052915060e01b6020820180516001600160e01b038381831617835250505050612e24565b6000805160206146a48339815191525460ff16156109505760405163d93c066560e01b815260040160405180910390fd5b6123a661236d565b6000805160206146a4833981519152805460ff191660011781557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25833611d0f565b6001600160a01b03811660009081527fe8b26c30fad74198956032a3533d903385d56dd795af560196f9c78d4af40d01602052604081206000805160206146448339815191529061243790612e7e565b6001600160d01b03169392505050565b604051634f1908cd60e01b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690634f1908cd90612493908590600401613e24565b600060405180830381600087803b1580156124ad57600080fd5b505af11580156124c1573d6000803e3d6000fd5b5050604051635d0ecba760e11b8152600092506001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce16915063ba1d974e90612514908690600401613e24565b602060405180830381865afa158015612531573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125559190614311565b905060007f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce6001600160a01b0316632402f27f856040518263ffffffff1660e01b81526004016125a59190613e24565b602060405180830381865afa1580156125c2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125e6919061434c565b9050826114b657612619847f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb950295836000611c5e565b61264d847f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583836001600160701b0316611c5e565b60405163b5f3b57d60e01b81526001600160a01b037f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583169063b5f3b57d9061269d9087908690869060040161437c565b600060405180830381600087803b1580156126b757600080fd5b505af11580156126cb573d6000803e3d6000fd5b505050506126f9847f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb95029583611930565b156114b6576114b66143a4565b6000610932612713612eb7565b8360405161190160f01b8152600281019290925260228201526042902090565b60008060008061274588888888612ec1565b9250925092506127558282612f83565b50909695505050505050565b6001600160a01b03821660009081527f5ab42ced628888259c08ac98db1eb0cf702fc1501344311d8b100cd1bfe4bb00602052604090208054600181019091558181146109845782816040516301d4b62360e61b81526004016109ed9291906142f8565b6127cd61303a565b610ac88282613083565b604080518082018252600080825260208083018290526001600160a01b03861682527fe8b26c30fad74198956032a3533d903385d56dd795af560196f9c78d4af40d0190529190912060008051602061464483398151915290611aee90846130e4565b3361284481612ca1565b8461284e81612ca1565b8461285881612ca1565b61286061236d565b61178f87878787613154565b3361287681612ca1565b8361288081612ca1565b8361288a81612ca1565b306001600160a01b038616036128b357604051630da30f6560e31b815260040160405180910390fd5b7f0000000000000000000000000000000000000000000000000000000068b58ac04210156129c057337f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb950295836001600160a01b031614801561294457507f00000000000000000000000074b4f6a2e579d730aacb9dd23cfbbaeb950295836001600160a01b0316856001600160a01b0316145b806129675750612952611321565b6001600160a01b0316336001600160a01b0316145b1561297c57612977868686613239565b612b25565b6001600160a01b03861660009081526002602052604090205460ff166129b55760405163af423a6f60e01b815260040160405180910390fd5b612977868686613239565b604051630eb2335d60e21b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690633ac8cd7490612a0c908990600401613e24565b602060405180830381865afa158015612a29573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612a4d9190614115565b15612a6d578560405163583c441960e11b81526004016109ed9190613e24565b604051630eb2335d60e21b81526001600160a01b037f0000000000000000000000004f61a99e42e21ea3c3eaf9b1b30fb80a7900d3ce1690633ac8cd7490612ab9908890600401613e24565b602060405180830381865afa158015612ad6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612afa9190614115565b15612b1a578460405163583c441960e11b81526004016109ed9190613e24565b612b25868686613239565b505050505050565b600080600080612b3d868661324c565b925092509250612b4d8282612f83565b5090949350505050565b600081600003612b6957506000919050565b60006001612b7684613299565b901c6001901b90506001818481612b8f57612b8f6143ba565b048201901c90506001818481612ba757612ba76143ba565b048201901c90506001818481612bbf57612bbf6143ba565b048201901c90506001818481612bd757612bd76143ba565b048201901c90506001818481612bef57612bef6143ba565b048201901c90506001818481612c0757612c076143ba565b048201901c90506001818481612c1f57612c1f6143ba565b048201901c905061097181828581612c3957612c396143ba565b0461332d565b60005b81831015612c99576000612c568484613343565b60008781526020902090915065ffffffffffff86169082015465ffffffffffff161115612c8557809250612c93565b612c9081600161421a565b93505b50612c42565b509392505050565b6001600160a01b03811615801590612cda5750612cbc611e85565b6001600160a01b0382166000908152602091909152604090205460ff165b156109a257806040516001620b633d60e31b031981526004016109ed9190613e24565b6000805160206146448339815191526000612d1784610b41565b6001600160a01b0385811660008181526020869052604080822080546001600160a01b031916898616908117909155905194955093928516927f3134e8a2e6d97e929a7e54011ea5485d7d196dd5f0ba4d4ef95803e8e3fc257f9190a46114b68184612d828761335e565b613369565b600063ffffffff821115611f87576020826040516306dfcc6560e41b81526004016109ed9291906142dd565b7f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19930080546001600160a01b031981166001600160a01b03848116918217845560405192169182907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a3505050565b6000612e396001600160a01b038416836134d1565b90508051600014158015612e5e575080806020019051810190612e5c9190614115565b155b156109845782604051635274afe760e01b81526004016109ed9190613e24565b80546000908015612eae57612e988361200f6001846142b6565b54600160301b90046001600160d01b0316610971565b60009392505050565b60006113cf6134df565b600080807f7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a0841115612efc5750600091506003905082612f79565b600060018888888860405160008152602001604052604051612f2194939291906143d0565b6020604051602081039080840390855afa158015612f43573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116612f6f57506000925060019150829050612f79565b9250600091508190505b9450945094915050565b6000826003811115612f9757612f976143eb565b03612fa0575050565b6001826003811115612fb457612fb46143eb565b03612fd25760405163f645eedf60e01b815260040160405180910390fd5b6002826003811115612fe657612fe66143eb565b036130065760405163fce698f760e01b81526109ed908290600401613ca5565b600382600381111561301a5761301a6143eb565b03610ac857806040516335e2f38360e21b81526004016109ed9190613ca5565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0054600160401b900460ff1661095057604051631afcd79f60e31b815260040160405180910390fd5b61308b61303a565b6000805160206146848339815191527fa16a46d94261c7517cc8ff89f61c0ce93598e3c849801011dee649a6a557d1026130c58482614492565b50600381016130d48382614492565b5060008082556001909101555050565b6040805180820190915260008082526020820152826000018263ffffffff168154811061311357613113614555565b60009182526020918290206040805180820190915291015465ffffffffffff81168252600160301b90046001600160d01b0316918101919091529392505050565b6000805160206146648339815191526001600160a01b03851661318d57600060405163e602df0560e01b81526004016109ed9190613e24565b6001600160a01b0384166131b7576000604051634a1406b160e11b81526004016109ed9190613e24565b6001600160a01b038086166000908152600183016020908152604080832093881683529290522083905581156121f857836001600160a01b0316856001600160a01b03167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9258560405161322a9190613ca5565b60405180910390a35050505050565b61324161236d565b610984838383613543565b600080600083516041036132865760208401516040850151606086015160001a61327888828585612ec1565b955095509550505050613292565b50508151600091506002905b9250925092565b600080608083901c156132ae57608092831c92015b604083901c156132c057604092831c92015b602083901c156132d257602092831c92015b601083901c156132e457601092831c92015b600883901c156132f657600892831c92015b600483901c1561330857600492831c92015b600283901c1561331a57600292831c92015b600183901c156109325760010192915050565b600081831061333c5781610971565b5090919050565b6000613352600284841861456b565b6109719084841661421a565b600061093282610cb8565b6000805160206146448339815191526001600160a01b03848116908416148015906133945750600082115b156114b6576001600160a01b03841615613435576001600160a01b0384166000908152600182016020526040812081906133d9906135c36133d4876135cf565b6135fe565b6001600160d01b031691506001600160d01b03169150856001600160a01b03167fdec2bacdd2f05b59de34da9b523dff8be42e5e38e818c82fdb0bae774387a724838360405161342a92919061457f565b60405180910390a250505b6001600160a01b038316156114b6576001600160a01b038316600090815260018201602052604081208190613470906136376133d4876135cf565b6001600160d01b031691506001600160d01b03169150846001600160a01b03167fdec2bacdd2f05b59de34da9b523dff8be42e5e38e818c82fdb0bae774387a72483836040516134c192919061457f565b60405180910390a2505050505050565b606061097183836000613643565b60007f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f61350a6136e0565b61351261374a565b463060405160200161352895949392919061458d565b60405160208183030381529060405280519060200120905090565b61354e83838361378e565b6001600160a01b0383166135b85760006135867f52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace025490565b90506001600160d01b03808211156135b5578181604051630e58ae9360e11b81526004016109ed92919061457f565b50505b6109848383836138b7565b600061097182846145cf565b60006001600160d01b03821115611f875760d0826040516306dfcc6560e41b81526004016109ed9291906142dd565b60008061362a61360c6113c5565b61362261361888612e7e565b868863ffffffff16565b879190613929565b915091505b935093915050565b600061097182846145f2565b606081471015613668573060405163cd78605960e01b81526004016109ed9190613e24565b600080856001600160a01b031684866040516136849190614637565b60006040518083038185875af1925050503d80600081146136c1576040519150601f19603f3d011682016040523d82523d6000602084013e6136c6565b606091505b50915091506136d6868383613937565b9695505050505050565b6000600080516020614684833981519152816136fa6122be565b80519091501561371257805160209091012092915050565b81548015613721579392505050565b7fc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470935050505090565b6000600080516020614684833981519152816137646122fd565b80519091501561377c57805160209091012092915050565b60018201548015613721579392505050565b6000805160206146648339815191526001600160a01b0384166137ca57818160020160008282546137bf919061421a565b909155506138299050565b6001600160a01b0384166000908152602082905260409020548281101561380a5784818460405163391434e360e21b81526004016109ed93929190614280565b6001600160a01b03851660009081526020839052604090209083900390555b6001600160a01b038316613847576002810180548390039055613866565b6001600160a01b03831660009081526020829052604090208054830190555b826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef846040516138a99190613ca5565b60405180910390a350505050565b6000805160206146448339815191526001600160a01b0384166138ea576138e7816002016136376133d4856135cf565b50505b6001600160a01b03831661390e5761390b816002016135c36133d4856135cf565b50505b6114b661391a85610b41565b61392385610b41565b84613369565b60008061362a85858561398a565b60608261394c5761394782613b04565b610971565b815115801561396357506001600160a01b0384163b155b156139835783604051639996b31560e01b81526004016109ed9190613e24565b5080610971565b825460009081908015613aa95760006139a88761200f6001856142b6565b60408051808201909152905465ffffffffffff808216808452600160301b9092046001600160d01b0316602084015291925090871610156139fc57604051632520601d60e01b815260040160405180910390fd5b805165ffffffffffff808816911603613a485784613a1f8861200f6001866142b6565b80546001600160d01b0392909216600160301b0265ffffffffffff909216919091179055613a99565b6040805180820190915265ffffffffffff80881682526001600160d01b0380881660208085019182528b54600181018d5560008d81529190912094519151909216600160301b029216919091179101555b60200151925083915061362f9050565b50506040805180820190915265ffffffffffff80851682526001600160d01b0380851660208085019182528854600181018a5560008a815291822095519251909316600160301b02919093161792019190915590508161362f565b805115613b145780518082602001fd5b604051630a12f52160e11b815260040160405180910390fd5b60006109326001600160a01b038316613b44565b90565b6001600160a01b031690565b600061093282613b2d565b600061093282613b50565b613b6f81613b5b565b82525050565b602081016109328284613b66565b60005b83811015613b9e578181015183820152602001613b86565b50506000910152565b6000613bb1825190565b808452602084019350613bc8818560208601613b83565b601f01601f19169290920192915050565b602080825281016109718184613ba7565b60006001600160a01b038216610932565b613c0481613bea565b81146109a257600080fd5b803561093281613bfb565b80613c04565b803561093281613c1a565b60008060408385031215613c4157613c41600080fd5b6000613c4d8585613c0f565b9250506020613c5e85828601613c20565b9150509250929050565b801515613b6f565b602081016109328284613c68565b600060208284031215613c9357613c93600080fd5b6000611aee8484613c0f565b80613b6f565b602081016109328284613c9f565b600080600060608486031215613ccb57613ccb600080fd5b6000613cd78686613c0f565b9350506020613ce886828701613c0f565b9250506040613cf986828701613c20565b9150509250925092565b60008083601f840112613d1857613d18600080fd5b50813567ffffffffffffffff811115613d3357613d33600080fd5b602083019150836001820283011115613d4e57613d4e600080fd5b9250929050565b60008060208385031215613d6b57613d6b600080fd5b823567ffffffffffffffff811115613d8557613d85600080fd5b613d9185828601613d03565b92509250509250929050565b60ff8116613b6f565b602081016109328284613d9d565b600060208284031215613dc957613dc9600080fd5b6000611aee8484613c20565b801515613c04565b803561093281613dd5565b60008060408385031215613dfe57613dfe600080fd5b6000613e0a8585613c0f565b9250506020613c5e85828601613ddd565b613b6f81613bea565b602081016109328284613e1b565b63ffffffff8116613b6f565b602081016109328284613e32565b6001600160f81b03198116613b6f565b6000613e688383613c9f565b505060200190565b6000613e7a825190565b80845260209384019383018060005b83811015613eae578151613e9d8882613e5c565b975060208301925050600101613e89565b509495945050505050565b60e08101613ec7828a613e4c565b8181036020830152613ed98189613ba7565b90508181036040830152613eed8188613ba7565b9050613efc6060830187613c9f565b613f096080830186613e1b565b613f1660a0830185613c9f565b81810360c0830152613f288184613e70565b9998505050505050505050565b65ffffffffffff8116613b6f565b602081016109328284613f35565b60ff8116613c04565b803561093281613f51565b60008060008060008060c08789031215613f8157613f81600080fd5b6000613f8d8989613c0f565b9650506020613f9e89828a01613c20565b9550506040613faf89828a01613c20565b9450506060613fc089828a01613f5a565b9350506080613fd189828a01613c20565b92505060a0613fe289828a01613c20565b9150509295509295509295565b6000806040838503121561400557614005600080fd5b60006140118585613c0f565b9250506020613c5e85828601613c0f565b63ffffffff8116613c04565b803561093281614022565b6000806040838503121561404f5761404f600080fd5b600061405b8585613c0f565b9250506020613c5e8582860161402e565b6001600160d01b038116613b6f565b8051604083019061408c8482613f35565b5060208201516114b6602085018261406c565b60408101610932828461407b565b634e487b7160e01b600052602260045260246000fd5b6002810460018216806140d757607f821691505b6020821081036140e9576140e96140ad565b50919050565b604081016140fd8285613c9f565b6109716020830184613f35565b805161093281613dd5565b60006020828403121561412a5761412a600080fd5b6000611aee848461410a565b604081016141448285613e1b565b6109716020830184613e1b565b6080810161415f8287613e1b565b61416c6020830186613e1b565b6141796040830185613c9f565b6141866060830184613c68565b95945050505050565b602080825281016109328160158152741152540dcc4c8e88155b9a5b9a5d1a585b1a5e9959605a1b602082015260400190565b634e487b7160e01b600052604160045260246000fd5b805161093281613c1a565b6000602082840312156141f8576141f8600080fd5b6000611aee84846141d8565b634e487b7160e01b600052601160045260246000fd5b8082018082111561093257610932614204565b6080810161423b8287613c9f565b6142486020830186613e1b565b6142556040830185613c9f565b6141866060830184613c9f565b67ffffffffffffffff8116613b6f565b602081016109328284614262565b6060810161428e8286613e1b565b61429b6020830185613c9f565b611aee6040830184613c9f565b604081016141448285613c9f565b8181038181111561093257610932614204565b600060ff8216610932565b613b6f816142c9565b604081016142eb82856142d4565b6109716020830184613c9f565b604081016142eb8285613e1b565b805161093281613f51565b60006020828403121561432657614326600080fd5b6000611aee8484614306565b6001600160701b038116613c04565b805161093281614332565b60006020828403121561436157614361600080fd5b6000611aee8484614341565b6001600160701b038116613b6f565b6060810161438a8286613e1b565b6143976020830185613d9d565b611aee604083018461436d565b634e487b7160e01b600052600160045260246000fd5b634e487b7160e01b600052601260045260246000fd5b608081016143de8287613c9f565b6142486020830186613d9d565b634e487b7160e01b600052602160045260246000fd5b6000610932613b418381565b61441683614401565b815460001960089490940293841b1916921b91909117905550565b600061098481848461440d565b81811015610ac857614451600082614431565b60010161443e565b601f821115610984576000818152602090206020601f850104810160208510156144805750805b6121f86020601f86010483018261443e565b815167ffffffffffffffff8111156144ac576144ac6141c2565b6144b682546140c3565b6144c1828285614459565b6020601f8311600181146144f557600084156144dd5750858201515b600019600886021c1981166002860217865550612b25565b600085815260208120601f198616915b828110156145255788850151825560209485019460019092019101614505565b868310156145415784890151600019601f89166008021c191682555b600160028802018855505050505050505050565b634e487b7160e01b600052603260045260246000fd5b60008261457a5761457a6143ba565b500490565b604081016142eb8285613c9f565b60a0810161459b8288613c9f565b6145a86020830187613c9f565b6145b56040830186613c9f565b6145c26060830185613c9f565b6136d66080830184613e1b565b6001600160d01b0391821691908116908282039081111561093257610932614204565b6001600160d01b0391821691908116908282019081111561093257610932614204565b600061461f825190565b61462d818560208601613b83565b9290920192915050565b6000610971828461461556fee8b26c30fad74198956032a3533d903385d56dd795af560196f9c78d4af40d0052c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00a16a46d94261c7517cc8ff89f61c0ce93598e3c849801011dee649a6a557d100cd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300a2646970667358221220778e62eb6134543cffcc064d9f1118d3337c56f7c11cdf0febf6e60c66308cee64736f6c63430008180033
Verified Source Code Full Match
Compiler: v0.8.24+commit.e11b9ed9
EVM: paris
IVotes.sol 59 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (governance/utils/IVotes.sol)
pragma solidity ^0.8.20;
/**
* @dev Common interface for {ERC20Votes}, {ERC721Votes}, and other {Votes}-enabled contracts.
*/
interface IVotes {
/**
* @dev The signature used has expired.
*/
error VotesExpiredSignature(uint256 expiry);
/**
* @dev Emitted when an account changes their delegate.
*/
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate);
/**
* @dev Emitted when a token transfer or delegate change results in changes to a delegate's number of voting units.
*/
event DelegateVotesChanged(address indexed delegate, uint256 previousVotes, uint256 newVotes);
/**
* @dev Returns the current amount of votes that `account` has.
*/
function getVotes(address account) external view returns (uint256);
/**
* @dev Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*/
function getPastVotes(address account, uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*
* NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
* Votes that have not been delegated are still part of total supply, even though they would not participate in a
* vote.
*/
function getPastTotalSupply(uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the delegate that `account` has chosen.
*/
function delegates(address account) external view returns (address);
/**
* @dev Delegates votes from the sender to `delegatee`.
*/
function delegate(address delegatee) external;
/**
* @dev Delegates votes from signer to `delegatee`.
*/
function delegateBySig(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) external;
}
draft-IERC6093.sol 161 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 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 ERC721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-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 ERC1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 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);
}
IERC5267.sol 28 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5267.sol)
pragma solidity ^0.8.20;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}
IERC5805.sol 9 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5805.sol)
pragma solidity ^0.8.20;
import {IVotes} from "../governance/utils/IVotes.sol";
import {IERC6372} from "./IERC6372.sol";
interface IERC5805 is IERC6372, IVotes {}
IERC6372.sol 17 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC6372.sol)
pragma solidity ^0.8.20;
interface IERC6372 {
/**
* @dev Clock used for flagging checkpoints. Can be overridden to implement timestamp based checkpoints (and voting).
*/
function clock() external view returns (uint48);
/**
* @dev Description of the clock
*/
// solhint-disable-next-line func-name-mixedcase
function CLOCK_MODE() external view returns (string memory);
}
IERC20Metadata.sol 26 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
IERC20Permit.sol 90 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
IERC20.sol 79 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
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);
}
SafeERC20.sol 118 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
/**
* @dev An operation with an ERC20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data);
if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
}
}
Address.sol 159 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error AddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedInnerCall();
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert AddressInsufficientBalance(address(this));
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert FailedInnerCall();
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {FailedInnerCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert AddressInsufficientBalance(address(this));
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an
* unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {FailedInnerCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}
ECDSA.sol 174 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.20;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS
}
/**
* @dev The signature derives the `address(0)`.
*/
error ECDSAInvalidSignature();
/**
* @dev The signature has an invalid length.
*/
error ECDSAInvalidSignatureLength(uint256 length);
/**
* @dev The signature has an S value that is in the upper half order.
*/
error ECDSAInvalidSignatureS(bytes32 s);
/**
* @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not
* return address(0) without also returning an error description. Errors are documented using an enum (error type)
* and a bytes32 providing additional information about the error.
*
* If no error is returned, then the address can be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*/
function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError, bytes32) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
/// @solidity memory-safe-assembly
assembly {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length));
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
*/
function tryRecover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address, RecoverError, bytes32) {
unchecked {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
// We do not check for an overflow here since the shift operation results in 0 or 1.
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address, RecoverError, bytes32) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS, s);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature, bytes32(0));
}
return (signer, RecoverError.NoError, bytes32(0));
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
*/
function _throwError(RecoverError error, bytes32 errorArg) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert ECDSAInvalidSignature();
} else if (error == RecoverError.InvalidSignatureLength) {
revert ECDSAInvalidSignatureLength(uint256(errorArg));
} else if (error == RecoverError.InvalidSignatureS) {
revert ECDSAInvalidSignatureS(errorArg);
}
}
}
MessageHashUtils.sol 86 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.20;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[EIP 191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (EIP-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
/// @solidity memory-safe-assembly
assembly {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}
Math.sol 415 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
/**
* @dev Muldiv operation overflow.
*/
error MathOverflowedMulDiv();
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an overflow flag.
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return 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.
return a / b;
}
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
* @dev 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 {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 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 prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
if (denominator <= prod1) {
revert MathOverflowedMulDiv();
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, 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 {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
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^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// 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^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice 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) {
uint256 result = mulDiv(x, y, denominator);
if (unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice 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 + (unsignedRoundsUp(rounding) && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @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 + (unsignedRoundsUp(rounding) && 1 << result < value ? 1 : 0);
}
}
/**
* @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 + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
}
}
/**
* @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 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @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 + (unsignedRoundsUp(rounding) && 1 << (result << 3) < value ? 1 : 0);
}
}
/**
* @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 1153 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.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 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);
}
}
SignedMath.sol 43 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return 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 {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}
Strings.sol 94 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @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;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
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 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));
}
}
Checkpoints.sol 603 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/structs/Checkpoints.sol)
// This file was procedurally generated from scripts/generate/templates/Checkpoints.js.
pragma solidity ^0.8.20;
import {Math} from "../math/Math.sol";
/**
* @dev This library defines the `Trace*` struct, for checkpointing values as they change at different points in
* time, and later looking up past values by block number. See {Votes} as an example.
*
* To create a history of checkpoints define a variable type `Checkpoints.Trace*` in your contract, and store a new
* checkpoint for the current transaction block using the {push} function.
*/
library Checkpoints {
/**
* @dev A value was attempted to be inserted on a past checkpoint.
*/
error CheckpointUnorderedInsertion();
struct Trace224 {
Checkpoint224[] _checkpoints;
}
struct Checkpoint224 {
uint32 _key;
uint224 _value;
}
/**
* @dev Pushes a (`key`, `value`) pair into a Trace224 so that it is stored as the checkpoint.
*
* Returns previous value and new value.
*
* IMPORTANT: Never accept `key` as a user input, since an arbitrary `type(uint32).max` key set will disable the
* library.
*/
function push(Trace224 storage self, uint32 key, uint224 value) internal returns (uint224, uint224) {
return _insert(self._checkpoints, key, value);
}
/**
* @dev Returns the value in the first (oldest) checkpoint with key greater or equal than the search key, or zero if
* there is none.
*/
function lowerLookup(Trace224 storage self, uint32 key) internal view returns (uint224) {
uint256 len = self._checkpoints.length;
uint256 pos = _lowerBinaryLookup(self._checkpoints, key, 0, len);
return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*/
function upperLookup(Trace224 storage self, uint32 key) internal view returns (uint224) {
uint256 len = self._checkpoints.length;
uint256 pos = _upperBinaryLookup(self._checkpoints, key, 0, len);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*
* NOTE: This is a variant of {upperLookup} that is optimised to find "recent" checkpoint (checkpoints with high
* keys).
*/
function upperLookupRecent(Trace224 storage self, uint32 key) internal view returns (uint224) {
uint256 len = self._checkpoints.length;
uint256 low = 0;
uint256 high = len;
if (len > 5) {
uint256 mid = len - Math.sqrt(len);
if (key < _unsafeAccess(self._checkpoints, mid)._key) {
high = mid;
} else {
low = mid + 1;
}
}
uint256 pos = _upperBinaryLookup(self._checkpoints, key, low, high);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
*/
function latest(Trace224 storage self) internal view returns (uint224) {
uint256 pos = self._checkpoints.length;
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns whether there is a checkpoint in the structure (i.e. it is not empty), and if so the key and value
* in the most recent checkpoint.
*/
function latestCheckpoint(Trace224 storage self) internal view returns (bool exists, uint32 _key, uint224 _value) {
uint256 pos = self._checkpoints.length;
if (pos == 0) {
return (false, 0, 0);
} else {
Checkpoint224 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value);
}
}
/**
* @dev Returns the number of checkpoint.
*/
function length(Trace224 storage self) internal view returns (uint256) {
return self._checkpoints.length;
}
/**
* @dev Returns checkpoint at given position.
*/
function at(Trace224 storage self, uint32 pos) internal view returns (Checkpoint224 memory) {
return self._checkpoints[pos];
}
/**
* @dev Pushes a (`key`, `value`) pair into an ordered list of checkpoints, either by inserting a new checkpoint,
* or by updating the last one.
*/
function _insert(Checkpoint224[] storage self, uint32 key, uint224 value) private returns (uint224, uint224) {
uint256 pos = self.length;
if (pos > 0) {
// Copying to memory is important here.
Checkpoint224 memory last = _unsafeAccess(self, pos - 1);
// Checkpoint keys must be non-decreasing.
if (last._key > key) {
revert CheckpointUnorderedInsertion();
}
// Update or push new checkpoint
if (last._key == key) {
_unsafeAccess(self, pos - 1)._value = value;
} else {
self.push(Checkpoint224({_key: key, _value: value}));
}
return (last._value, value);
} else {
self.push(Checkpoint224({_key: key, _value: value}));
return (0, value);
}
}
/**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _upperBinaryLookup(
Checkpoint224[] storage self,
uint32 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key > key) {
high = mid;
} else {
low = mid + 1;
}
}
return high;
}
/**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and
* exclusive `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _lowerBinaryLookup(
Checkpoint224[] storage self,
uint32 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key < key) {
low = mid + 1;
} else {
high = mid;
}
}
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(
Checkpoint224[] storage self,
uint256 pos
) private pure returns (Checkpoint224 storage result) {
assembly {
mstore(0, self.slot)
result.slot := add(keccak256(0, 0x20), pos)
}
}
struct Trace208 {
Checkpoint208[] _checkpoints;
}
struct Checkpoint208 {
uint48 _key;
uint208 _value;
}
/**
* @dev Pushes a (`key`, `value`) pair into a Trace208 so that it is stored as the checkpoint.
*
* Returns previous value and new value.
*
* IMPORTANT: Never accept `key` as a user input, since an arbitrary `type(uint48).max` key set will disable the
* library.
*/
function push(Trace208 storage self, uint48 key, uint208 value) internal returns (uint208, uint208) {
return _insert(self._checkpoints, key, value);
}
/**
* @dev Returns the value in the first (oldest) checkpoint with key greater or equal than the search key, or zero if
* there is none.
*/
function lowerLookup(Trace208 storage self, uint48 key) internal view returns (uint208) {
uint256 len = self._checkpoints.length;
uint256 pos = _lowerBinaryLookup(self._checkpoints, key, 0, len);
return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*/
function upperLookup(Trace208 storage self, uint48 key) internal view returns (uint208) {
uint256 len = self._checkpoints.length;
uint256 pos = _upperBinaryLookup(self._checkpoints, key, 0, len);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*
* NOTE: This is a variant of {upperLookup} that is optimised to find "recent" checkpoint (checkpoints with high
* keys).
*/
function upperLookupRecent(Trace208 storage self, uint48 key) internal view returns (uint208) {
uint256 len = self._checkpoints.length;
uint256 low = 0;
uint256 high = len;
if (len > 5) {
uint256 mid = len - Math.sqrt(len);
if (key < _unsafeAccess(self._checkpoints, mid)._key) {
high = mid;
} else {
low = mid + 1;
}
}
uint256 pos = _upperBinaryLookup(self._checkpoints, key, low, high);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
*/
function latest(Trace208 storage self) internal view returns (uint208) {
uint256 pos = self._checkpoints.length;
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns whether there is a checkpoint in the structure (i.e. it is not empty), and if so the key and value
* in the most recent checkpoint.
*/
function latestCheckpoint(Trace208 storage self) internal view returns (bool exists, uint48 _key, uint208 _value) {
uint256 pos = self._checkpoints.length;
if (pos == 0) {
return (false, 0, 0);
} else {
Checkpoint208 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value);
}
}
/**
* @dev Returns the number of checkpoint.
*/
function length(Trace208 storage self) internal view returns (uint256) {
return self._checkpoints.length;
}
/**
* @dev Returns checkpoint at given position.
*/
function at(Trace208 storage self, uint32 pos) internal view returns (Checkpoint208 memory) {
return self._checkpoints[pos];
}
/**
* @dev Pushes a (`key`, `value`) pair into an ordered list of checkpoints, either by inserting a new checkpoint,
* or by updating the last one.
*/
function _insert(Checkpoint208[] storage self, uint48 key, uint208 value) private returns (uint208, uint208) {
uint256 pos = self.length;
if (pos > 0) {
// Copying to memory is important here.
Checkpoint208 memory last = _unsafeAccess(self, pos - 1);
// Checkpoint keys must be non-decreasing.
if (last._key > key) {
revert CheckpointUnorderedInsertion();
}
// Update or push new checkpoint
if (last._key == key) {
_unsafeAccess(self, pos - 1)._value = value;
} else {
self.push(Checkpoint208({_key: key, _value: value}));
}
return (last._value, value);
} else {
self.push(Checkpoint208({_key: key, _value: value}));
return (0, value);
}
}
/**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _upperBinaryLookup(
Checkpoint208[] storage self,
uint48 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key > key) {
high = mid;
} else {
low = mid + 1;
}
}
return high;
}
/**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and
* exclusive `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _lowerBinaryLookup(
Checkpoint208[] storage self,
uint48 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key < key) {
low = mid + 1;
} else {
high = mid;
}
}
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(
Checkpoint208[] storage self,
uint256 pos
) private pure returns (Checkpoint208 storage result) {
assembly {
mstore(0, self.slot)
result.slot := add(keccak256(0, 0x20), pos)
}
}
struct Trace160 {
Checkpoint160[] _checkpoints;
}
struct Checkpoint160 {
uint96 _key;
uint160 _value;
}
/**
* @dev Pushes a (`key`, `value`) pair into a Trace160 so that it is stored as the checkpoint.
*
* Returns previous value and new value.
*
* IMPORTANT: Never accept `key` as a user input, since an arbitrary `type(uint96).max` key set will disable the
* library.
*/
function push(Trace160 storage self, uint96 key, uint160 value) internal returns (uint160, uint160) {
return _insert(self._checkpoints, key, value);
}
/**
* @dev Returns the value in the first (oldest) checkpoint with key greater or equal than the search key, or zero if
* there is none.
*/
function lowerLookup(Trace160 storage self, uint96 key) internal view returns (uint160) {
uint256 len = self._checkpoints.length;
uint256 pos = _lowerBinaryLookup(self._checkpoints, key, 0, len);
return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*/
function upperLookup(Trace160 storage self, uint96 key) internal view returns (uint160) {
uint256 len = self._checkpoints.length;
uint256 pos = _upperBinaryLookup(self._checkpoints, key, 0, len);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
* if there is none.
*
* NOTE: This is a variant of {upperLookup} that is optimised to find "recent" checkpoint (checkpoints with high
* keys).
*/
function upperLookupRecent(Trace160 storage self, uint96 key) internal view returns (uint160) {
uint256 len = self._checkpoints.length;
uint256 low = 0;
uint256 high = len;
if (len > 5) {
uint256 mid = len - Math.sqrt(len);
if (key < _unsafeAccess(self._checkpoints, mid)._key) {
high = mid;
} else {
low = mid + 1;
}
}
uint256 pos = _upperBinaryLookup(self._checkpoints, key, low, high);
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
*/
function latest(Trace160 storage self) internal view returns (uint160) {
uint256 pos = self._checkpoints.length;
return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
}
/**
* @dev Returns whether there is a checkpoint in the structure (i.e. it is not empty), and if so the key and value
* in the most recent checkpoint.
*/
function latestCheckpoint(Trace160 storage self) internal view returns (bool exists, uint96 _key, uint160 _value) {
uint256 pos = self._checkpoints.length;
if (pos == 0) {
return (false, 0, 0);
} else {
Checkpoint160 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value);
}
}
/**
* @dev Returns the number of checkpoint.
*/
function length(Trace160 storage self) internal view returns (uint256) {
return self._checkpoints.length;
}
/**
* @dev Returns checkpoint at given position.
*/
function at(Trace160 storage self, uint32 pos) internal view returns (Checkpoint160 memory) {
return self._checkpoints[pos];
}
/**
* @dev Pushes a (`key`, `value`) pair into an ordered list of checkpoints, either by inserting a new checkpoint,
* or by updating the last one.
*/
function _insert(Checkpoint160[] storage self, uint96 key, uint160 value) private returns (uint160, uint160) {
uint256 pos = self.length;
if (pos > 0) {
// Copying to memory is important here.
Checkpoint160 memory last = _unsafeAccess(self, pos - 1);
// Checkpoint keys must be non-decreasing.
if (last._key > key) {
revert CheckpointUnorderedInsertion();
}
// Update or push new checkpoint
if (last._key == key) {
_unsafeAccess(self, pos - 1)._value = value;
} else {
self.push(Checkpoint160({_key: key, _value: value}));
}
return (last._value, value);
} else {
self.push(Checkpoint160({_key: key, _value: value}));
return (0, value);
}
}
/**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _upperBinaryLookup(
Checkpoint160[] storage self,
uint96 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key > key) {
high = mid;
} else {
low = mid + 1;
}
}
return high;
}
/**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and
* exclusive `high`.
*
* WARNING: `high` should not be greater than the array's length.
*/
function _lowerBinaryLookup(
Checkpoint160[] storage self,
uint96 key,
uint256 low,
uint256 high
) private view returns (uint256) {
while (low < high) {
uint256 mid = Math.average(low, high);
if (_unsafeAccess(self, mid)._key < key) {
low = mid + 1;
} else {
high = mid;
}
}
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(
Checkpoint160[] storage self,
uint256 pos
) private pure returns (Checkpoint160 storage result) {
assembly {
mstore(0, self.slot)
result.slot := add(keccak256(0, 0x20), pos)
}
}
}
Time.sol 130 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/types/Time.sol)
pragma solidity ^0.8.20;
import {Math} from "../math/Math.sol";
import {SafeCast} from "../math/SafeCast.sol";
/**
* @dev This library provides helpers for manipulating time-related objects.
*
* It uses the following types:
* - `uint48` for timepoints
* - `uint32` for durations
*
* While the library doesn't provide specific types for timepoints and duration, it does provide:
* - a `Delay` type to represent duration that can be programmed to change value automatically at a given point
* - additional helper functions
*/
library Time {
using Time for *;
/**
* @dev Get the block timestamp as a Timepoint.
*/
function timestamp() internal view returns (uint48) {
return SafeCast.toUint48(block.timestamp);
}
/**
* @dev Get the block number as a Timepoint.
*/
function blockNumber() internal view returns (uint48) {
return SafeCast.toUint48(block.number);
}
// ==================================================== Delay =====================================================
/**
* @dev A `Delay` is a uint32 duration that can be programmed to change value automatically at a given point in the
* future. The "effect" timepoint describes when the transitions happens from the "old" value to the "new" value.
* This allows updating the delay applied to some operation while keeping some guarantees.
*
* In particular, the {update} function guarantees that if the delay is reduced, the old delay still applies for
* some time. For example if the delay is currently 7 days to do an upgrade, the admin should not be able to set
* the delay to 0 and upgrade immediately. If the admin wants to reduce the delay, the old delay (7 days) should
* still apply for some time.
*
*
* The `Delay` type is 112 bits long, and packs the following:
*
* ```
* | [uint48]: effect date (timepoint)
* | | [uint32]: value before (duration)
* ↓ ↓ ↓ [uint32]: value after (duration)
* 0xAAAAAAAAAAAABBBBBBBBCCCCCCCC
* ```
*
* NOTE: The {get} and {withUpdate} functions operate using timestamps. Block number based delays are not currently
* supported.
*/
type Delay is uint112;
/**
* @dev Wrap a duration into a Delay to add the one-step "update in the future" feature
*/
function toDelay(uint32 duration) internal pure returns (Delay) {
return Delay.wrap(duration);
}
/**
* @dev Get the value at a given timepoint plus the pending value and effect timepoint if there is a scheduled
* change after this timepoint. If the effect timepoint is 0, then the pending value should not be considered.
*/
function _getFullAt(Delay self, uint48 timepoint) private pure returns (uint32, uint32, uint48) {
(uint32 valueBefore, uint32 valueAfter, uint48 effect) = self.unpack();
return effect <= timepoint ? (valueAfter, 0, 0) : (valueBefore, valueAfter, effect);
}
/**
* @dev Get the current value plus the pending value and effect timepoint if there is a scheduled change. If the
* effect timepoint is 0, then the pending value should not be considered.
*/
function getFull(Delay self) internal view returns (uint32, uint32, uint48) {
return _getFullAt(self, timestamp());
}
/**
* @dev Get the current value.
*/
function get(Delay self) internal view returns (uint32) {
(uint32 delay, , ) = self.getFull();
return delay;
}
/**
* @dev Update a Delay object so that it takes a new duration after a timepoint that is automatically computed to
* enforce the old delay at the moment of the update. Returns the updated Delay object and the timestamp when the
* new delay becomes effective.
*/
function withUpdate(
Delay self,
uint32 newValue,
uint32 minSetback
) internal view returns (Delay updatedDelay, uint48 effect) {
uint32 value = self.get();
uint32 setback = uint32(Math.max(minSetback, value > newValue ? value - newValue : 0));
effect = timestamp() + setback;
return (pack(value, newValue, effect), effect);
}
/**
* @dev Split a delay into its components: valueBefore, valueAfter and effect (transition timepoint).
*/
function unpack(Delay self) internal pure returns (uint32 valueBefore, uint32 valueAfter, uint48 effect) {
uint112 raw = Delay.unwrap(self);
valueAfter = uint32(raw);
valueBefore = uint32(raw >> 32);
effect = uint48(raw >> 64);
return (valueBefore, valueAfter, effect);
}
/**
* @dev pack the components into a Delay object.
*/
function pack(uint32 valueBefore, uint32 valueAfter, uint48 effect) internal pure returns (Delay) {
return Delay.wrap((uint112(effect) << 64) | (uint112(valueBefore) << 32) | uint112(valueAfter));
}
}
Ownable2StepUpgradeable.sol 80 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.20;
import {OwnableUpgradeable} from "./OwnableUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is specified at deployment time in the constructor for `Ownable`. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Ownable2Step
struct Ownable2StepStorage {
address _pendingOwner;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable2Step")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant Ownable2StepStorageLocation = 0x237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00;
function _getOwnable2StepStorage() private pure returns (Ownable2StepStorage storage $) {
assembly {
$.slot := Ownable2StepStorageLocation
}
}
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
function __Ownable2Step_init() internal onlyInitializing {
}
function __Ownable2Step_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
return $._pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
$._pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
delete $._pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
if (pendingOwner() != sender) {
revert OwnableUnauthorizedAccount(sender);
}
_transferOwnership(sender);
}
}
OwnableUpgradeable.sol 119 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.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 OwnableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Ownable
struct OwnableStorage {
address _owner;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300;
function _getOwnableStorage() private pure returns (OwnableStorage storage $) {
assembly {
$.slot := OwnableStorageLocation
}
}
/**
* @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.
*/
function __Ownable_init(address initialOwner) internal onlyInitializing {
__Ownable_init_unchained(initialOwner);
}
function __Ownable_init_unchained(address initialOwner) internal onlyInitializing {
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) {
OwnableStorage storage $ = _getOwnableStorage();
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 {
OwnableStorage storage $ = _getOwnableStorage();
address oldOwner = $._owner;
$._owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
VotesUpgradeable.sol 279 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (governance/utils/Votes.sol)
pragma solidity ^0.8.20;
import {IERC5805} from "contracts/libraries/oz-v5/immutable/interfaces/IERC5805.sol";
import {ContextUpgradeable} from "../../utils/ContextUpgradeable.sol";
import {NoncesUpgradeable} from "../../utils/NoncesUpgradeable.sol";
import {EIP712Upgradeable} from "../../utils/cryptography/EIP712Upgradeable.sol";
import {Checkpoints} from "contracts/libraries/oz-v5/immutable/utils/structs/Checkpoints.sol";
import {SafeCast} from "contracts/libraries/oz-v5/immutable/utils/math/SafeCast.sol";
import {ECDSA} from "contracts/libraries/oz-v5/immutable/utils/cryptography/ECDSA.sol";
import {Time} from "contracts/libraries/oz-v5/immutable/utils/types/Time.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev This is a base abstract contract that tracks voting units, which are a measure of voting power that can be
* transferred, and provides a system of vote delegation, where an account can delegate its voting units to a sort of
* "representative" that will pool delegated voting units from different accounts and can then use it to vote in
* decisions. In fact, voting units _must_ be delegated in order to count as actual votes, and an account has to
* delegate those votes to itself if it wishes to participate in decisions and does not have a trusted representative.
*
* This contract is often combined with a token contract such that voting units correspond to token units. For an
* example, see {ERC721Votes}.
*
* The full history of delegate votes is tracked on-chain so that governance protocols can consider votes as distributed
* at a particular block number to protect against flash loans and double voting. The opt-in delegate system makes the
* cost of this history tracking optional.
*
* When using this module the derived contract must implement {_getVotingUnits} (for example, make it return
* {ERC721-balanceOf}), and can use {_transferVotingUnits} to track a change in the distribution of those units (in the
* previous example, it would be included in {ERC721-_update}).
*/
abstract contract VotesUpgradeable is Initializable, ContextUpgradeable, EIP712Upgradeable, NoncesUpgradeable, IERC5805 {
using Checkpoints for Checkpoints.Trace208;
bytes32 private constant DELEGATION_TYPEHASH =
keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)");
/// @custom:storage-location erc7201:openzeppelin.storage.Votes
struct VotesStorage {
mapping(address account => address) _delegatee;
mapping(address delegatee => Checkpoints.Trace208) _delegateCheckpoints;
Checkpoints.Trace208 _totalCheckpoints;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Votes")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant VotesStorageLocation = 0xe8b26c30fad74198956032a3533d903385d56dd795af560196f9c78d4af40d00;
function _getVotesStorage() private pure returns (VotesStorage storage $) {
assembly {
$.slot := VotesStorageLocation
}
}
/**
* @dev The clock was incorrectly modified.
*/
error ERC6372InconsistentClock();
/**
* @dev Lookup to future votes is not available.
*/
error ERC5805FutureLookup(uint256 timepoint, uint48 clock);
function __Votes_init() internal onlyInitializing {
}
function __Votes_init_unchained() internal onlyInitializing {
}
/**
* @dev Clock used for flagging checkpoints. Can be overridden to implement timestamp based
* checkpoints (and voting), in which case {CLOCK_MODE} should be overridden as well to match.
*/
function clock() public view virtual returns (uint48) {
return Time.blockNumber();
}
/**
* @dev Machine-readable description of the clock as specified in EIP-6372.
*/
// solhint-disable-next-line func-name-mixedcase
function CLOCK_MODE() public view virtual returns (string memory) {
// Check that the clock was not modified
if (clock() != Time.blockNumber()) {
revert ERC6372InconsistentClock();
}
return "mode=blocknumber&from=default";
}
/**
* @dev Returns the current amount of votes that `account` has.
*/
function getVotes(address account) public view virtual returns (uint256) {
VotesStorage storage $ = _getVotesStorage();
return $._delegateCheckpoints[account].latest();
}
/**
* @dev Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*
* Requirements:
*
* - `timepoint` must be in the past. If operating using block numbers, the block must be already mined.
*/
function getPastVotes(address account, uint256 timepoint) public view virtual returns (uint256) {
VotesStorage storage $ = _getVotesStorage();
uint48 currentTimepoint = clock();
if (timepoint >= currentTimepoint) {
revert ERC5805FutureLookup(timepoint, currentTimepoint);
}
return $._delegateCheckpoints[account].upperLookupRecent(SafeCast.toUint48(timepoint));
}
/**
* @dev Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*
* NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
* Votes that have not been delegated are still part of total supply, even though they would not participate in a
* vote.
*
* Requirements:
*
* - `timepoint` must be in the past. If operating using block numbers, the block must be already mined.
*/
function getPastTotalSupply(uint256 timepoint) public view virtual returns (uint256) {
VotesStorage storage $ = _getVotesStorage();
uint48 currentTimepoint = clock();
if (timepoint >= currentTimepoint) {
revert ERC5805FutureLookup(timepoint, currentTimepoint);
}
return $._totalCheckpoints.upperLookupRecent(SafeCast.toUint48(timepoint));
}
/**
* @dev Returns the current total supply of votes.
*/
function _getTotalSupply() internal view virtual returns (uint256) {
VotesStorage storage $ = _getVotesStorage();
return $._totalCheckpoints.latest();
}
/**
* @dev Returns the delegate that `account` has chosen.
*/
function delegates(address account) public view virtual returns (address) {
VotesStorage storage $ = _getVotesStorage();
return $._delegatee[account];
}
/**
* @dev Delegates votes from the sender to `delegatee`.
*/
function delegate(address delegatee) public virtual {
address account = _msgSender();
_delegate(account, delegatee);
}
/**
* @dev Delegates votes from signer to `delegatee`.
*/
function delegateBySig(
address delegatee,
uint256 nonce,
uint256 expiry,
uint8 v,
bytes32 r,
bytes32 s
) public virtual {
if (block.timestamp > expiry) {
revert VotesExpiredSignature(expiry);
}
address signer = ECDSA.recover(
_hashTypedDataV4(keccak256(abi.encode(DELEGATION_TYPEHASH, delegatee, nonce, expiry))),
v,
r,
s
);
_useCheckedNonce(signer, nonce);
_delegate(signer, delegatee);
}
/**
* @dev Delegate all of `account`'s voting units to `delegatee`.
*
* Emits events {IVotes-DelegateChanged} and {IVotes-DelegateVotesChanged}.
*/
function _delegate(address account, address delegatee) internal virtual {
VotesStorage storage $ = _getVotesStorage();
address oldDelegate = delegates(account);
$._delegatee[account] = delegatee;
emit DelegateChanged(account, oldDelegate, delegatee);
_moveDelegateVotes(oldDelegate, delegatee, _getVotingUnits(account));
}
/**
* @dev Transfers, mints, or burns voting units. To register a mint, `from` should be zero. To register a burn, `to`
* should be zero. Total supply of voting units will be adjusted with mints and burns.
*/
function _transferVotingUnits(address from, address to, uint256 amount) internal virtual {
VotesStorage storage $ = _getVotesStorage();
if (from == address(0)) {
_push($._totalCheckpoints, _add, SafeCast.toUint208(amount));
}
if (to == address(0)) {
_push($._totalCheckpoints, _subtract, SafeCast.toUint208(amount));
}
_moveDelegateVotes(delegates(from), delegates(to), amount);
}
/**
* @dev Moves delegated votes from one delegate to another.
*/
function _moveDelegateVotes(address from, address to, uint256 amount) private {
VotesStorage storage $ = _getVotesStorage();
if (from != to && amount > 0) {
if (from != address(0)) {
(uint256 oldValue, uint256 newValue) = _push(
$._delegateCheckpoints[from],
_subtract,
SafeCast.toUint208(amount)
);
emit DelegateVotesChanged(from, oldValue, newValue);
}
if (to != address(0)) {
(uint256 oldValue, uint256 newValue) = _push(
$._delegateCheckpoints[to],
_add,
SafeCast.toUint208(amount)
);
emit DelegateVotesChanged(to, oldValue, newValue);
}
}
}
/**
* @dev Get number of checkpoints for `account`.
*/
function _numCheckpoints(address account) internal view virtual returns (uint32) {
VotesStorage storage $ = _getVotesStorage();
return SafeCast.toUint32($._delegateCheckpoints[account].length());
}
/**
* @dev Get the `pos`-th checkpoint for `account`.
*/
function _checkpoints(
address account,
uint32 pos
) internal view virtual returns (Checkpoints.Checkpoint208 memory) {
VotesStorage storage $ = _getVotesStorage();
return $._delegateCheckpoints[account].at(pos);
}
function _push(
Checkpoints.Trace208 storage store,
function(uint208, uint208) view returns (uint208) op,
uint208 delta
) private returns (uint208, uint208) {
return store.push(clock(), op(store.latest(), delta));
}
function _add(uint208 a, uint208 b) private pure returns (uint208) {
return a + b;
}
function _subtract(uint208 a, uint208 b) private pure returns (uint208) {
return a - b;
}
/**
* @dev Must return the voting units held by an account.
*/
function _getVotingUnits(address) internal view virtual returns (uint256);
}
Initializable.sol 228 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reininitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._initialized = 1;
if (isTopLevelCall) {
$._initializing = true;
}
_;
if (isTopLevelCall) {
$._initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._initialized = version;
$._initializing = true;
_;
$._initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
assembly {
$.slot := INITIALIZABLE_STORAGE
}
}
}
ERC20Upgradeable.sol 341 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "contracts/libraries/oz-v5/immutable/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "contracts/libraries/oz-v5/immutable/token/ERC20/extensions/IERC20Metadata.sol";
import {ContextUpgradeable} from "../../utils/ContextUpgradeable.sol";
import {IERC20Errors} from "contracts/libraries/oz-v5/immutable/interfaces/draft-IERC6093.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*/
abstract contract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20, IERC20Metadata, IERC20Errors {
/// @custom:storage-location erc7201:openzeppelin.storage.ERC20
struct ERC20Storage {
mapping(address account => uint256) _balances;
mapping(address account => mapping(address spender => uint256)) _allowances;
uint256 _totalSupply;
string _name;
string _symbol;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC20")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ERC20StorageLocation = 0x52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00;
function _getERC20Storage() private pure returns (ERC20Storage storage $) {
assembly {
$.slot := ERC20StorageLocation
}
}
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {
__ERC20_init_unchained(name_, symbol_);
}
function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
ERC20Storage storage $ = _getERC20Storage();
$._name = name_;
$._symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
ERC20Storage storage $ = _getERC20Storage();
return $._name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
ERC20Storage storage $ = _getERC20Storage();
return $._symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
ERC20Storage storage $ = _getERC20Storage();
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
$._totalSupply += value;
} else {
uint256 fromBalance = $._balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
$._balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
$._totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
$._balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
* ```
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
ERC20Storage storage $ = _getERC20Storage();
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
$._allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}
ERC20BurnableUpgradeable.sol 45 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Burnable.sol)
pragma solidity ^0.8.20;
import {ERC20Upgradeable} from "../ERC20Upgradeable.sol";
import {ContextUpgradeable} from "../../../utils/ContextUpgradeable.sol";
import {Initializable} from "../../../proxy/utils/Initializable.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
abstract contract ERC20BurnableUpgradeable is Initializable, ContextUpgradeable, ERC20Upgradeable {
function __ERC20Burnable_init() internal onlyInitializing {
}
function __ERC20Burnable_init_unchained() internal onlyInitializing {
}
/**
* @dev Destroys a `value` amount of tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 value) public virtual {
_burn(_msgSender(), value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, deducting from
* the caller's allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `value`.
*/
function burnFrom(address account, uint256 value) public virtual {
_spendAllowance(account, _msgSender(), value);
_burn(account, value);
}
}
ERC20PausableUpgradeable.sol 40 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Pausable.sol)
pragma solidity ^0.8.20;
import {ERC20Upgradeable} from "../ERC20Upgradeable.sol";
import {PausableUpgradeable} from "../../../utils/PausableUpgradeable.sol";
import {Initializable} from "../../../proxy/utils/Initializable.sol";
/**
* @dev ERC20 token with pausable token transfers, minting and burning.
*
* Useful for scenarios such as preventing trades until the end of an evaluation
* period, or having an emergency switch for freezing all token transfers in the
* event of a large bug.
*
* IMPORTANT: This contract does not include public pause and unpause functions. In
* addition to inheriting this contract, you must define both functions, invoking the
* {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
* access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
* make the contract pause mechanism of the contract unreachable, and thus unusable.
*/
abstract contract ERC20PausableUpgradeable is Initializable, ERC20Upgradeable, PausableUpgradeable {
function __ERC20Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __ERC20Pausable_init_unchained() internal onlyInitializing {
}
/**
* @dev See {ERC20-_update}.
*
* Requirements:
*
* - the contract must not be paused.
*/
function _update(address from, address to, uint256 value) internal virtual override whenNotPaused {
super._update(from, to, value);
}
}
ERC20VotesUpgradeable.sol 89 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Votes.sol)
pragma solidity ^0.8.20;
import {ERC20Upgradeable} from "../ERC20Upgradeable.sol";
import {VotesUpgradeable} from "../../../governance/utils/VotesUpgradeable.sol";
import {Checkpoints} from "contracts/libraries/oz-v5/immutable/utils/structs/Checkpoints.sol";
import {Initializable} from "../../../proxy/utils/Initializable.sol";
/**
* @dev Extension of ERC20 to support Compound-like voting and delegation. This version is more generic than Compound's,
* and supports token supply up to 2^208^ - 1, while COMP is limited to 2^96^ - 1.
*
* NOTE: This contract does not provide interface compatibility with Compound's COMP token.
*
* This extension keeps a history (checkpoints) of each account's vote power. Vote power can be delegated either
* by calling the {delegate} function directly, or by providing a signature to be used with {delegateBySig}. Voting
* power can be queried through the public accessors {getVotes} and {getPastVotes}.
*
* By default, token balance does not account for voting power. This makes transfers cheaper. The downside is that it
* requires users to delegate to themselves in order to activate checkpoints and have their voting power tracked.
*/
abstract contract ERC20VotesUpgradeable is Initializable, ERC20Upgradeable, VotesUpgradeable {
/**
* @dev Total supply cap has been exceeded, introducing a risk of votes overflowing.
*/
error ERC20ExceededSafeSupply(uint256 increasedSupply, uint256 cap);
function __ERC20Votes_init() internal onlyInitializing {
}
function __ERC20Votes_init_unchained() internal onlyInitializing {
}
/**
* @dev Maximum token supply. Defaults to `type(uint208).max` (2^208^ - 1).
*
* This maximum is enforced in {_update}. It limits the total supply of the token, which is otherwise a uint256,
* so that checkpoints can be stored in the Trace208 structure used by {{Votes}}. Increasing this value will not
* remove the underlying limitation, and will cause {_update} to fail because of a math overflow in
* {_transferVotingUnits}. An override could be used to further restrict the total supply (to a lower value) if
* additional logic requires it. When resolving override conflicts on this function, the minimum should be
* returned.
*/
function _maxSupply() internal view virtual returns (uint256) {
return type(uint208).max;
}
/**
* @dev Move voting power when tokens are transferred.
*
* Emits a {IVotes-DelegateVotesChanged} event.
*/
function _update(address from, address to, uint256 value) internal virtual override {
super._update(from, to, value);
if (from == address(0)) {
uint256 supply = totalSupply();
uint256 cap = _maxSupply();
if (supply > cap) {
revert ERC20ExceededSafeSupply(supply, cap);
}
}
_transferVotingUnits(from, to, value);
}
/**
* @dev Returns the voting units of an `account`.
*
* WARNING: Overriding this function may compromise the internal vote accounting.
* `ERC20Votes` assumes tokens map to voting units 1:1 and this is not easy to change.
*/
function _getVotingUnits(address account) internal view virtual override returns (uint256) {
return balanceOf(account);
}
/**
* @dev Get number of checkpoints for `account`.
*/
function numCheckpoints(address account) public view virtual returns (uint32) {
return _numCheckpoints(account);
}
/**
* @dev Get the `pos`-th checkpoint for `account`.
*/
function checkpoints(address account, uint32 pos) public view virtual returns (Checkpoints.Checkpoint208 memory) {
return _checkpoints(account, pos);
}
}
ContextUpgradeable.sol 34 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @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 ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
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;
}
}
EIP712Upgradeable.sol 210 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "contracts/libraries/oz-v5/immutable/utils/cryptography/MessageHashUtils.sol";
import {IERC5267} from "contracts/libraries/oz-v5/immutable/interfaces/IERC5267.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
*
* The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose
* encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract
* does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to
* produce the hash of their typed data using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*/
abstract contract EIP712Upgradeable is Initializable, IERC5267 {
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
/// @custom:storage-location erc7201:openzeppelin.storage.EIP712
struct EIP712Storage {
/// @custom:oz-renamed-from _HASHED_NAME
bytes32 _hashedName;
/// @custom:oz-renamed-from _HASHED_VERSION
bytes32 _hashedVersion;
string _name;
string _version;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.EIP712")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant EIP712StorageLocation = 0xa16a46d94261c7517cc8ff89f61c0ce93598e3c849801011dee649a6a557d100;
function _getEIP712Storage() private pure returns (EIP712Storage storage $) {
assembly {
$.slot := EIP712StorageLocation
}
}
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
function __EIP712_init(string memory name, string memory version) internal onlyInitializing {
__EIP712_init_unchained(name, version);
}
function __EIP712_init_unchained(string memory name, string memory version) internal onlyInitializing {
EIP712Storage storage $ = _getEIP712Storage();
$._name = name;
$._version = version;
// Reset prior values in storage if upgrading
$._hashedName = 0;
$._hashedVersion = 0;
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
return _buildDomainSeparator();
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash(), block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/**
* @dev See {IERC-5267}.
*/
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
EIP712Storage storage $ = _getEIP712Storage();
// If the hashed name and version in storage are non-zero, the contract hasn't been properly initialized
// and the EIP712 domain is not reliable, as it will be missing name and version.
require($._hashedName == 0 && $._hashedVersion == 0, "EIP712: Uninitialized");
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
* are a concern.
*/
function _EIP712Name() internal view virtual returns (string memory) {
EIP712Storage storage $ = _getEIP712Storage();
return $._name;
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
* are a concern.
*/
function _EIP712Version() internal view virtual returns (string memory) {
EIP712Storage storage $ = _getEIP712Storage();
return $._version;
}
/**
* @dev The hash of the name parameter for the EIP712 domain.
*
* NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Name` instead.
*/
function _EIP712NameHash() internal view returns (bytes32) {
EIP712Storage storage $ = _getEIP712Storage();
string memory name = _EIP712Name();
if (bytes(name).length > 0) {
return keccak256(bytes(name));
} else {
// If the name is empty, the contract may have been upgraded without initializing the new storage.
// We return the name hash in storage if non-zero, otherwise we assume the name is empty by design.
bytes32 hashedName = $._hashedName;
if (hashedName != 0) {
return hashedName;
} else {
return keccak256("");
}
}
}
/**
* @dev The hash of the version parameter for the EIP712 domain.
*
* NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Version` instead.
*/
function _EIP712VersionHash() internal view returns (bytes32) {
EIP712Storage storage $ = _getEIP712Storage();
string memory version = _EIP712Version();
if (bytes(version).length > 0) {
return keccak256(bytes(version));
} else {
// If the version is empty, the contract may have been upgraded without initializing the new storage.
// We return the version hash in storage if non-zero, otherwise we assume the version is empty by design.
bytes32 hashedVersion = $._hashedVersion;
if (hashedVersion != 0) {
return hashedVersion;
} else {
return keccak256("");
}
}
}
}
NoncesUpgradeable.sol 66 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Nonces.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides tracking nonces for addresses. Nonces will only increment.
*/
abstract contract NoncesUpgradeable is Initializable {
/**
* @dev The nonce used for an `account` is not the expected current nonce.
*/
error InvalidAccountNonce(address account, uint256 currentNonce);
/// @custom:storage-location erc7201:openzeppelin.storage.Nonces
struct NoncesStorage {
mapping(address account => uint256) _nonces;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Nonces")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant NoncesStorageLocation = 0x5ab42ced628888259c08ac98db1eb0cf702fc1501344311d8b100cd1bfe4bb00;
function _getNoncesStorage() private pure returns (NoncesStorage storage $) {
assembly {
$.slot := NoncesStorageLocation
}
}
function __Nonces_init() internal onlyInitializing {
}
function __Nonces_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the next unused nonce for an address.
*/
function nonces(address owner) public view virtual returns (uint256) {
NoncesStorage storage $ = _getNoncesStorage();
return $._nonces[owner];
}
/**
* @dev Consumes a nonce.
*
* Returns the current value and increments nonce.
*/
function _useNonce(address owner) internal virtual returns (uint256) {
NoncesStorage storage $ = _getNoncesStorage();
// For each account, the nonce has an initial value of 0, can only be incremented by one, and cannot be
// decremented or reset. This guarantees that the nonce never overflows.
unchecked {
// It is important to do x++ and not ++x here.
return $._nonces[owner]++;
}
}
/**
* @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`.
*/
function _useCheckedNonce(address owner, uint256 nonce) internal virtual {
uint256 current = _useNonce(owner);
if (nonce != current) {
revert InvalidAccountNonce(owner, current);
}
}
}
PausableUpgradeable.sol 140 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.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 PausableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @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 Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
}
/**
* @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) {
PausableStorage storage $ = _getPausableStorage();
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 {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}
IWorldLibertyFinancialRegistry.sol 138 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.24;
interface IWorldLibertyFinancialRegistry {
// ==================================================
// ==================== Structs =====================
// ==================================================
/// @dev The entirety of this struct should compact down into one storage slot
struct LegacyUser {
/// @dev This is data type is big enough to fit the whole WLFI supply
uint112 amount;
/// @dev Incremental categories, where 0 represents NONE and should be considered unset
uint8 category;
/// @dev True if the user has "activated" their account by transferring their funds into the vester
bool isActivated;
}
struct RegistryStorage {
uint256 nonce;
mapping(address => LegacyUser) legacyUserMap;
}
// ==================================================
// ===================== Events =====================
// ==================================================
event NonceUpdated(uint256 nonce);
event LegacyUserUpdated(address indexed user, uint256 amount, uint8 category, bool isActivated);
event LegacyUserTransferred(address indexed from, address indexed to);
// ==================================================
// ===================== Errors =====================
// ==================================================
error InvalidNonce();
error InvalidBulkInsertLegacyUsersParams();
error InvalidBulkInsertLegacyUserAtIndex(uint256 index);
error InvalidBulkInsertLegacyUserBalance(address user);
error InvalidUser(address user);
error AlreadyInitialized(address user);
error Unauthorized();
// ==================================================
// ================== Initializers ==================
// ==================================================
function initialize() external;
// ===================================================
// =============== External Functions ================
// ===================================================
/**
* @notice Allows the WLFI token to activate a legacy user. This is the typical flow most Legacy Users will follow
* to initialize their vesting account.
*
* @param _user The address of the user whose account will be activated
*/
function wlfiActivateAccount(address _user) external;
/**
* @notice Transfers the registration of `_from` account to the `_to` account. Reverts if `_to` is already
* registered. `_to` account must be a fresh wallet. Reverts if `_from` is not a legacy user
*
* @param _from The from account whose registration is being transferred.
* @param _to The to account whose registration is being received by `_from`.
*/
function wlfiReallocateFrom(address _from, address _to) external;
/**
* @notice Allows the whitelist agent or owner to add Legacy Users to this registry. Each user is assigned an
* amount of WLFI they have and a category. Categories are useful for partitioning users (between founders,
* public sale recipient, OTC sale recipient, etc.). The lengths of these arrays must match and be > 0.
*
* @param _expectedNonce The nonce that is expected be set in storage at the time of this call. Used for
* coordination with the offchain script.
* @param _users The Legacy Users that will be added to the registry
* @param _amounts The amount of WLFI that each Legacy User has. Must be equal to the Legacy User's balance
* @param _categories The category in which each Legacy User resides
*/
function agentBulkInsertLegacyUsers(
uint256 _expectedNonce,
address[] calldata _users,
uint256[] calldata _amounts,
uint8[] calldata _categories
) external;
/**
*
* @return The nonce of the latest insertion from calling {agentBulkInsertLegacyUsers}
*/
function nonce() external view returns (uint256);
/**
*
* @param _user The user to check if they are considered a Legacy User or not
* @return True if the user is considered a Legacy User or false otherwise
*/
function isLegacyUser(address _user) external view returns (bool);
/**
*
* @param _user The user to check if they are considered a Legacy User and if their status is activated yet
* @return True if the user is considered a Legacy User and they have been activated or false otherwise
*/
function isLegacyUserAndIsActivated(address _user) external view returns (bool);
/**
*
* @param _user The user to check if they are considered a Legacy User and if their status is not activated yet
* @return True if the user is considered a Legacy User and they have not been activated yet. False otherwise
*/
function isLegacyUserAndIsNotActivated(address _user) external view returns (bool);
/**
*
* @param _user The user whose Legacy User info should be retrieved
* @return The user's Legacy User info
*/
function getLegacyUserInfo(address _user) external view returns (LegacyUser memory);
/**
*
* @param _user The user whose category should be retrieved
* @return The user's assigned category
*/
function getLegacyUserCategory(address _user) external view returns (uint8);
/**
*
* @param _user The user whose allocation should be retrieved
* @return The user's assigned WLFI allocation
*/
function getLegacyUserAllocation(address _user) external view returns (uint112);
}
IWorldLibertyFinancialV2.sol 266 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.24;
import {ERC20Upgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/ERC20Upgradeable.sol";
import {ERC20PausableUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20PausableUpgradeable.sol";
import {ERC20BurnableUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";
import {ERC20VotesUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20VotesUpgradeable.sol";
import {Ownable2StepUpgradeable} from "contracts/libraries/oz-v5/upgradeable/access/Ownable2StepUpgradeable.sol";
import {IERC20} from "contracts/libraries/oz-v5/immutable/token/ERC20/IERC20.sol";
interface IWorldLibertyFinancialV2 is IERC20 {
// ==================================================
// ==================== Structs =====================
// ==================================================
struct V2 {
/// @dev Whether or not a user can approve or transfer tokens
mapping(address => bool) blacklistStatus;
address authorizedSigner;
}
// ==================================================
// ===================== Events =====================
// ==================================================
event SetAuthorizedSigner(address indexed authorizedSigner);
event SetGuardian(address indexed guardian, bool isGuardian);
event SetAllowListStatus(address indexed account, bool isTransferAllowed);
event SetVotingPowerExcludedStatus(address indexed account, bool isExcluded);
event SetBlacklistStatus(address indexed account, bool isBlacklisted);
event SetMaxVotingPower(uint256 maxVotingPower);
event Reallocated(address from, address to, uint256 amount, bool didTransferRegistry);
// ==================================================
// ===================== Errors =====================
// ==================================================
error AccountNotActivated(address account);
error Blacklisted(address account);
error GuardianUnauthorizedAccount(address _account);
error InvalidReallocation();
error CannotReallocateToLegacyUser(address from, address to);
error InvalidAccount();
error InvalidAuthorizedSigner();
error InvalidMaxVotingPower();
error InvalidSignature();
error InvalidValue();
error NotImplemented();
error TransferNotAllowedYet();
error VoterIsExcluded(address account);
// ==================================================
// ================== Initializers ==================
// ==================================================
function initialize(address _authorizedSigner) external;
// ===================================================
// ================= Owner Functions =================
// ===================================================
/**
* @notice Pauses token transfers and approvals on the WLFI token
* @dev Only owner can invoke this function
*/
function ownerPause() external;
/**
* @notice Pauses token transfers and approvals on the WLFI token
* @dev Only owner can invoke this function
*/
function ownerUnpause() external;
/**
* @notice Set the authorized signer for this contract. This signer is used to enable the transferring of tokens by
* "Legacy Users"
* @param _authorizedSigner The authorized signer address
* @dev Only owner can invoke this function
*/
function ownerSetAuthorizedSigner(address _authorizedSigner) external;
/**
* @notice Set guardian status for address. Guardians are used to call `guardian`-designated functions
* @param _guardian Guardian address
* @param _status Guardian status
* @dev Only owner can invoke this function
*/
function ownerSetGuardian(address _guardian, bool _status) external;
/**
* @notice Set max voting power
* @param _maxVotingPower Max voting power for an account
* @dev Only owner can invoke this function
*/
function ownerSetMaxVotingPower(uint256 _maxVotingPower) external;
/**
* @notice Set account transferability status. Only used before `START_TIMESTAMP` is passed by `block.timestamp`.
* The storage for this function inherits state from V1 `_allowList`.
* @param _account The account whose status should be set
* @param _isAllowed True to allow transferring before `START_TIMESTAMP`. False to disallow it.
* @dev Only owner can invoke this function
*/
function ownerSetTransferBeforeStartStatus(
address _account,
bool _isAllowed
) external;
/**
* @notice Set excluded account voting power
* @param _account Account address
* @param _isExcluded True to exclude this user's voting power, false to include it
* @dev Only owner can invoke this function
*/
function ownerSetVotingPowerExcludedStatus(
address _account,
bool _isExcluded
) external;
/**
* @notice Rescue accidental tokens that are stuck in the contract
* @param _recipient Treasury address
* @param _token Token address
* @param _value Value to rescue
* @dev Only owner can invoke this function
*/
function ownerRescueTokens(
address _recipient,
address _token,
uint256 _value
) external;
/**
* @notice Burn tokens from a malicious account without requiring allowance. Mints the corresponding tokens on the
* other account. This is meant to be used only if a user loses access to their wallet prior to vesting
* beginning or when a malicious account acquires WLFI via exploit. Emits the {Reallocated} event.
*
* @param _from Account address to burn tokens from
* @param _to Account address to mint the tokens to
* @param _value Amount of tokens to re-allocate
* @dev Only owner can invoke this function
*/
function ownerReallocateFrom(
address _from,
address _to,
uint256 _value
) external;
/**
* @notice Blacklist an account from transacting with WLFI
* @dev Only owner can invoke this function
* @param _account The account whose blacklist status should be changed
* @param _isBlacklisted True to blacklist the account, false to remove it from the blacklist
*/
function ownerSetBlacklistStatus(address _account, bool _isBlacklisted) external;
/**
* @notice Activates a legacy user's vesting contract and moves their tokens into the vesting contract. Upon
* activation, the user may begin sending or receiving WLFI tokens.
* @param _account The legacy user that should be activated
* @param _bypassVester true if the user should bypass moving their funds into the vester and therefore be instantly
* unlocked. Setting this to false emulates the behavior from {activateAccount}. This parameter
* is mainly used for treasury assets or tokens that should remain under the user's control.
*/
function ownerActivateAccount(address _account, bool _bypassVester) external;
/**
* @notice Claims any available WLFI for `_user`
* @param _user The user whose vest should be claimed
* @return The amount of WLFI claimed for the caller
*/
function ownerClaimVestFor(address _user) external returns (uint256);
// ==================================================
// =============== Guardian Functions ===============
// ==================================================
/**
* @notice Pauses token transfers and approvals on the WLFI token
* @dev Only a guardian can invoke this function
*/
function guardianPause() external;
/**
* @notice Blacklist an account from transacting with WLFI
* @dev Only a guardian can invoke this function
*/
function guardianSetBlacklistStatus(address _account, bool _isBlacklisted) external;
// ==================================================
// ================ Public Functions ================
// ==================================================
/**
* @notice Activates a legacy user's vesting contract and moves their tokens into the vesting contract. Upon
* activation, the user may begin sending or receiving WLFI tokens.
* @param _signature The signature that was sent by the `authorizedSigner` amount of
*/
function activateAccount(bytes calldata _signature) external;
/**
* @notice Claims any available WLFI for `msg.sender`
* @return The amount of WLFI claimed for the caller
*/
function claimVest() external returns (uint256);
/**
* @notice Activates a user's account and claims any available WLFI for `msg.sender`
* @return The amount of WLFI claimed for the caller
*/
function activateAccountAndClaimVest(bytes calldata _signature) external returns (uint256);
/**
* @notice Get account transferability status
* @param _sender Sender address
*/
function getAllowListStatus(address _sender) external view returns (bool status);
/**
* @notice View authorized guardians
* @param _guardian Guardian address
*/
function isGuardian(address _guardian) external view returns (bool guardianStatus);
/**
* @notice Check if an address's voting power is excluded. If it is excluded, `balanceOfVotes` and
* `getVotesWithBalanceFallback` will return 0 for the user
* @param _account The address of the account to check if their voting power is excluded
*/
function isVoterExcluded(address _account) external view returns (bool excludedStatus);
/**
* @notice Check if an account is blacklisted
* @param _account The address of the account
*/
function isBlacklisted(address _account) external view returns (bool blacklistStatus);
/**
* @notice Checks if the provided `_account` is able to transfer or receive tokens
* @param _account The account to check if its ready to transact
* @return True fi the user can send or receive tokens. False if they are not able to yet.
*/
function isReadyToTransact(address _account) external view returns (bool);
/**
* @return The address of the authorized signer that can approve a Legacy User's activation.
*/
function authorizedSigner() external view returns (address);
/**
* @return True if the current block's timestamp is equal to or after the `TRADING_START_TIMESTAMP`.
*/
function isAfterTradingStartTimestamp() external view returns (bool);
/**
* @return The max voting power an account can have
*/
function MAX_VOTING_POWER() external view returns (uint256);
/**
* @return The timestamp at which trading and general transfers can begin for the WLFI token.
*/
function TRADING_START_TIMESTAMP() external view returns (uint256);
}
IWorldLibertyFinancialVester.sol 301 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.24;
interface IWorldLibertyFinancialVester {
// ==================================================
// ==================== Structs =====================
// ==================================================
// One slot: 112 + 112 + 8 + 8 = 240 bits
struct UserInfo {
/// @dev total allocation for this user (all segments combined)
uint112 allocation;
/// @dev total claimed so far
uint112 claimed;
/// @dev user category
uint8 category;
/// @dev set at first by the user
bool initialized;
}
// One slot: 112 + 32 + 32 + 32 = 208 bits
struct Template {
/// @dev percentage cap for this segment; 1 ether (10 ** 18) equals 100%. The sum of all
/// `percentageOfAllocation` for a category should be <= 1 ether (100%)
uint112 percentageOfAllocation;
/// @dev linear start (unix time)
uint32 startTimestamp;
/// @dev first moment any unlocks; usually == start for cliffed-linear
uint32 cliffTimestamp;
/// @dev linear end (unix time)
uint32 endTimestamp;
}
struct CategoryInfo {
/// @dev Numbered from 0..8
uint8 templateCount;
/// @dev True if this category is enabled or not yet
bool enabled;
}
struct VesterStorage {
/// @dev Up to 8 templates per category, index order = priority (0 highest → 7 lowest).
mapping(uint8 => Template[8]) categoryTemplates;
/// @dev Category ID to CategoryInfo
mapping(uint8 => CategoryInfo) categoryInfo;
/// @dev All of the legacy users that have activated their vesting account
mapping(address => UserInfo) users;
/// @dev The total amount of WLFI that have been claimed by users against this vesting contract
uint112 totalClaimed;
/// @dev The total amount of WLFI that have been allocated to users for this vesting contract
uint112 totalAllocated;
}
// ==================================================
// ===================== Events =====================
// ==================================================
event VestActivated(address indexed account, uint8 category, uint112 allocation);
event VestTransferred(address indexed from, address indexed to);
event SetCategoryTemplate(uint8 indexed category, uint8 indexed index, Template t);
event SetCategoryEnabled(uint8 indexed category, bool enabled);
event SetCategoryTemplateCount(uint8 indexed category, uint8 count);
event Claimed(address indexed user, uint256 amount);
// ==================================================
// ===================== Errors =====================
// ==================================================
error Unauthorized();
error InvalidParameters();
error InvalidTemplateCount();
error InvalidTemplateTimestamp();
error InvalidUser(address user);
error CategoryNotEnabled(uint8 category);
error AlreadyInitialized(address user);
error UserNotInitialized(address user);
error NothingToClaim();
// ==================================================
// ================== Initializers ==================
// ==================================================
function initialize() external;
// ==================================================
// ================= Owner Functions ================
// ==================================================
/**
* @notice Pause user claims and vest activations.
* @dev Owner-only guardian switch. Paused state blocks {claim} but allows admin maintenance.
*
* @custom:reverts OwnableUnauthorizedAccount If the caller is not the contract owner.
* @custom:reverts AlreadyPaused If the contract is already paused.
*/
function ownerPause() external;
/**
* @notice Unpause user claims.
* @dev Owner-only guardian switch. Restores {claim} functionality.
*
* @custom:reverts OwnableUnauthorizedAccount If the caller is not the contract owner.
* @custom:reverts NotPaused If the contract is not currently paused.
*/
function ownerUnpause() external;
/**
* @notice Enables a category so their vests may be activated.
*
* @param _category The category ID (uint8) that is being enabled
* @param _enabled True to enable the category, false to disable it.
*
* @custom:reverts OwnableUnauthorizedAccount If the caller is not the contract owner.
* @custom:reverts NotPaused If the contract is not currently paused.
*/
function ownerSetCategoryEnabled(uint8 _category, bool _enabled) external;
/**
* @notice Configure or update a vesting template for a given category at a given priority index.
* @dev Each category supports up to 8 template slots (priority order: index 0 highest → 7 lowest).
* The `_template` struct uses:
* - percentageOfAllocation (uint112):
* percentage cap for this segment; 1 ether (10 ** 18) equals 100%. The sum of all
* `percentageOfAllocation` for a category should be <= 1 ether (100%)
* - startTimestamp (uint32)
* - cliffTimestamp (uint32)
* - endTimestamp (uint32)
* The vesting schedule; linear from (startTimestamp → endTimestamp); cliffTimestamp must be greater
* than or equal to startTimestamp.
* Setting a higher index than the current count increases the active template count for that category.
*
* @param _category The category ID (uint8) being configured.
* @param _index The priority index to set (0..3).
* @param _template The vesting template parameters for this slot.
*
* @custom:reverts OwnableUnauthorizedAccount If the caller is not the contract owner.
* @custom:reverts IndexOutOfRange If `_index` >= 8.
* @custom:reverts InvalidTimeOrdering If `_template.endTimestamp` != 0 and
* (startTimestamp > cliffTimestamp || cliffTimestamp > endTimestamp).
*/
function ownerSetCategoryTemplate(uint8 _category, uint8 _index, Template calldata _template) external;
// ==================================================
// =============== Guardian Functions ===============
// ==================================================
/**
* @notice Pause vest activation, user claims, owner-assisted claims.
* @dev Guardian-only circuit breaker. When paused, user-facing functions
* (e.g., {claim}, {wlfiActivateVest}, {ownerClaimFor}) MUST revert. Administrative configuration
* (e.g., setting templates) may remain allowed depending on implementation.
*
* @custom:reverts GuardianUnauthorizedAccount If the caller is not the designated guardian.
* @custom:reverts EnforcedPause If the contract is already in the paused state.
*/
function guardianPause() external;
// ==================================================
// =============== External Functions ===============
// ==================================================
/**
* @notice Activate a user's WLFI vest using offchain–curated data.
* @dev Callable by the the WLFI token only and used to set up a user's vesting info as well as transfer a Legacy
* User's vesting allocation into this vesting contract. Once a user is activated, they can begin calling
* {claim}.
*
* @param _user The beneficiary to activate.
* @param _category The category the user belongs to.
* @param _amount The total WLFI allocation for this user (uint112).
*
* @custom:reverts Unauthorized If the caller is not the WLFI token.
* @custom:reverts InvalidParameters If `_user` is the zero address, `_category` is 0, or `_amount` is zero.
* @custom:reverts AlreadyInitialized If `_user` is already activated their vest.
*/
function wlfiActivateVest(address _user, uint8 _category, uint112 _amount) external;
/**
* @notice Claim ALL currently available (vested & unclaimed) WLFI for `_user`.
* @dev Pulls the user’s category pipeline, computes unlocked amounts across up to 8 template
* segments in order, subtracts `claimed`, and transfers the claimable amount to the user.
* If nothing is claimable, reverts with `NothingToClaim`.
*
* @param _user The user whose vest should be claimed
* @return amount The amount of WLFI transferred to the user for this claim.
*
* @custom:reverts Unauthorized If the caller is not the WLFI token.
* @custom:reverts EnforcedPause If the contract is paused.
* @custom:reverts UserNotInitialized If the user has not been initialized (see {wlfiActivateVest}).
* @custom:reverts NothingToClaim If the user's claimable amount is 0
*/
function wlfiClaimFor(address _user) external returns (uint256);
/**
* @notice Reassign a vested account’s ownership from one address to another within the vesting contract.
* @dev Admin-only maintenance. Moves the in-contract accounting record for `_from` to `_to`
* without transferring any tokens. The fields `{allocation, claimed, category, initialized}`
* are copied so that the user’s remaining claimable balance is preserved exactly under `_to`.
* Intended for support cases (e.g., lost wallets). Does not modify category or totals.
*
* @param _from The current owner of the vested account record.
* @param _to The new owner that will assume the vested account record.
*
* @custom:effects Copies the entire `UserInfo` for `_from` to `_to`, then clears `_from`’s record.
* No ERC20 transfer occurs. After reallocation, `_to` can call {claim}.
*
* @custom:reverts NotAuthorized If the caller lacks permission to reallocate vest records.
* @custom:reverts ZeroAddress If `_to` is the zero address.
* @custom:reverts SameAddress If `_to` equals `_from`.
* @custom:reverts FromNotInitialized If `_from` has no initialized vesting record in this contract.
* @custom:reverts ToAlreadyInitialized If `_to` already has a vesting record (initialized or non-empty).
* @custom:reverts Paused (If implemented) If the contract is paused and reallocations are disallowed.
*
* @dev Optional policy notes:
* - If your policy requires the new owner to explicitly acknowledge terms, you may reset
* `initialized` to false during the move so `_to` must re-initialize before claiming.
* - If you disallow moving fully claimed records, add and document `NothingToReallocate`
* when `allocation == claimed`.
*/
function wlfiReallocateFrom(address _from, address _to) external;
/**
* @notice Claim ALL currently available (vested & unclaimed) WLFI for the caller.
* @dev Pulls the user’s category pipeline, computes unlocked amounts across up to 8 template
* segments in order, subtracts `claimed`, and transfers the claimable amount to the user.
* If nothing is claimable, reverts with `NothingToClaim`.
*
* @return amount The amount of WLFI transferred to the user for this claim.
*
* @custom:reverts EnforcedPause If the contract is paused.
* @custom:reverts UserNotInitialized If the user has not been initialized (see {wlfiActivateVest}).
* @custom:reverts NothingToClaim If the user's claimable amount is 0
*/
function claim() external returns (uint256);
/**
* @notice View the amount currently claimable by a user.
* @dev Purely a read: computes unlocked across the user’s category templates and subtracts `claimed`.
* Returns 0 for users who are not initialized.
*
* @param _user The address to query.
* @return The currently claimable WLFI for `_user`.
*/
function claimable(address _user) external view returns (uint256);
/**
* @notice View the amount that has been claimed by a user.
* @dev Purely a read: computes how many tokens were `claimed`. Returns 0 for users who are not initialized.
*
* @param _user The address to query.
* @return The amount of WLFI claimed for `_user`.
*/
function claimed(address _user) external view returns (uint256);
/**
* @notice View the amount that has been allocated to a user. Returns 0 for users who are not initialized.
* @dev Purely a read: computes how many tokens were `claimed`. Returns 0 for users who are not initialized.
*
* @param _user The address to query.
* @return The amount of WLFI that has been allocated for `_user`.
*/
function allocation(address _user) external view returns (uint256);
/**
* @notice View the amount that has been unclaimed by the user. Returns 0 for users who are not initialized.
* @dev Purely a read: computes how many tokens were `unclaimed`. Returns 0 for users who are not initialized.
*
* @param _user The address to query.
* @return The amount of WLFI that has been allocated to the `_user` and unclaimed.
*/
function unclaimed(address _user) external view returns (uint256);
/**
* @return The total amount of WLFI tokens that have been claimed by users
*/
function totalClaimed() external view returns (uint256);
/**
* @return The total amount of WLFI tokens that have been allocated to users who have activated their wallets
*/
function totalAllocated() external view returns (uint256);
/**
* @return The total amount of WLFI tokens that have been allocated to users and are unclaimed
*/
function totalUnclaimed() external view returns (uint256);
/**
* @param _category The category whose info should be retrieved.
* @return The category info for a given category
*/
function getCategoryInfo(uint8 _category) external view returns (CategoryInfo memory);
/**
* @param _category The category whose info should be retrieved.
* @return All of the templates for a given category. The max length of the array is 8.
*/
function getAllCategoryTemplates(uint8 _category) external view returns (Template[] memory);
}
WorldLibertyFinancialV2.sol 471 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.24;
import {Ownable2StepUpgradeable} from "contracts/libraries/oz-v5/upgradeable/access/Ownable2StepUpgradeable.sol";
import {ERC20Upgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/ERC20Upgradeable.sol";
import {ERC20BurnableUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";
import {ERC20PausableUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20PausableUpgradeable.sol";
import {ERC20VotesUpgradeable} from "contracts/libraries/oz-v5/upgradeable/token/ERC20/extensions/ERC20VotesUpgradeable.sol";
import {IERC20} from "contracts/libraries/oz-v5/immutable/token/ERC20/IERC20.sol";
import {SafeERC20} from "contracts/libraries/oz-v5/immutable/token/ERC20/utils/SafeERC20.sol";
import {ECDSA} from "contracts/libraries/oz-v5/immutable/utils/cryptography/ECDSA.sol";
import {IWorldLibertyFinancialRegistry} from "./interfaces/IWorldLibertyFinancialRegistry.sol";
import {IWorldLibertyFinancialVester} from "./interfaces/IWorldLibertyFinancialVester.sol";
import {IWorldLibertyFinancialV2} from "./interfaces/IWorldLibertyFinancialV2.sol";
/*
# ################################################################################################ #
#### ########################################################################## ###
########### ##################################################### ##########
###################### ################################ #####################
############### ############ ##################### ############ ############
#################### ############## ## ################
########################### ######### WLFI ####### ######### ######################
############################# # #### # ##########################
################################### ### #####################
############################################## #### ###############################
#################################################### ###############################
################################################## ############################
############################################## ##### ##########################
*/
contract WorldLibertyFinancialV2 is
IWorldLibertyFinancialV2,
ERC20VotesUpgradeable,
ERC20PausableUpgradeable,
ERC20BurnableUpgradeable,
Ownable2StepUpgradeable
{
using SafeERC20 for IERC20;
bytes32 private constant WLFIV2StorageLocation = keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.WLFIV2")) - 1)) & ~bytes32(uint256(0xff));
bytes32 private constant ACTIVATION_TYPEHASH = keccak256("Activation(address account)");
// ===================================================
// ================ Immutable Fields =================
// ===================================================
uint256 public immutable override TRADING_START_TIMESTAMP;
IWorldLibertyFinancialRegistry public immutable REGISTRY;
IWorldLibertyFinancialVester public immutable VESTER;
// ===================================================
// ================== Mutable Fields =================
// ===================================================
// ==========================================
/// @notice These are inherited from WLFI V1 and cannot be changed. Nor can their ordering be changed.
// ==========================================
/// @dev The max amount of voting power a single address can have
uint256 public override MAX_VOTING_POWER;
/// @dev Mapping of guardians. More info on this can be read in the interface declaration.
mapping(address => bool) private _guardians;
/// @dev Mapping of allowed transfer agents before transferring can begin. More info on this can be read in the
/// interface declaration.
mapping(address => bool) private _allowListStatus;
/// @dev Mapping of addresses that cannot vote. More info on this can be read in the interface declaration.
mapping(address => bool) private _excludedVotingPower;
modifier onlyGuardian() {
_checkGuardian();
_;
}
modifier notBlacklisted(address _account) {
_checkNotBlacklisted(_account);
_;
}
constructor(uint256 _startTimestamp, address _registry, address _vester) {
_disableInitializers();
TRADING_START_TIMESTAMP = _startTimestamp;
REGISTRY = IWorldLibertyFinancialRegistry(_registry);
VESTER = IWorldLibertyFinancialVester(_vester);
}
/**
* @notice Initialize World Liberty Financial (WLFI) Token
*/
function initialize(address _authorizedSigner) external reinitializer(/* version = */ 2) {
__EIP712_init(name(), "2");
V2 storage $ = _getStorage();
_ownerSetAuthorizedSigner($, _authorizedSigner);
}
// ===================================================
// ================= Owner Functions =================
// ===================================================
function ownerPause() external onlyOwner whenNotPaused {
_pause();
}
function ownerUnpause() external onlyOwner whenPaused {
_unpause();
}
function ownerSetAuthorizedSigner(address _authorizedSigner) external onlyOwner {
_ownerSetAuthorizedSigner(_getStorage(), _authorizedSigner);
}
function ownerSetGuardian(address _guardian, bool _status) external onlyOwner {
if (_guardian == address(0)) {
revert InvalidAccount();
}
_guardians[_guardian] = _status;
emit SetGuardian(_guardian, _status);
}
function ownerSetMaxVotingPower(uint256 _maxVotingPower) external onlyOwner {
if (_maxVotingPower > (5_000_000_000 * 1 ether)) {
revert InvalidMaxVotingPower();
}
MAX_VOTING_POWER = _maxVotingPower;
emit SetMaxVotingPower(_maxVotingPower);
}
function ownerSetTransferBeforeStartStatus(
address _account,
bool _isAllowed
) external onlyOwner {
_allowListStatus[_account] = _isAllowed;
emit SetAllowListStatus(_account, _isAllowed);
}
function ownerSetVotingPowerExcludedStatus(
address _account,
bool _status
) external onlyOwner {
_ownerSetVotingPowerExcludedStatus(_account, _status);
}
function ownerRescueTokens(
address _recipient,
address _token,
uint256 _value
) external onlyOwner {
if (_recipient == address(0)) {
revert InvalidAccount();
}
if (_value == 0) {
revert InvalidValue();
}
uint256 balanceOfToken = IERC20(_token).balanceOf(address(this));
if (_value > balanceOfToken) {
_value = balanceOfToken;
}
IERC20(_token).safeTransfer(_recipient, _value);
}
function ownerReallocateFrom(
address _from,
address _to,
uint256 _value
) public onlyOwner {
if (
REGISTRY.isLegacyUserAndIsNotActivated(_from)
&& balanceOf(_from) != _value
) {
// Legacy users must re-allocate their full balance if they are not activated
revert InvalidReallocation();
}
if (REGISTRY.isLegacyUser(_to)) {
revert CannotReallocateToLegacyUser(_from, _to);
}
if (_value != 0) {
_burn(_from, _value);
_mint(_to, _value);
}
bool isLegacyUser = false;
if (REGISTRY.isLegacyUserAndIsNotActivated(_from)) {
isLegacyUser = true;
REGISTRY.wlfiReallocateFrom(_from, _to);
} else if (REGISTRY.isLegacyUserAndIsActivated(_from)) {
isLegacyUser = true;
REGISTRY.wlfiReallocateFrom(_from, _to);
VESTER.wlfiReallocateFrom(_from, _to);
}
emit Reallocated(_from, _to, _value, isLegacyUser);
}
function ownerSetBlacklistStatus(address _account, bool _isBlacklisted) external onlyOwner {
_setBlacklistStatus(_account, _isBlacklisted);
}
function ownerActivateAccount(address _account, bool _bypassVester) external onlyOwner {
_activateAccount(_account,_bypassVester);
}
function ownerClaimVestFor(address _user) external whenNotPaused onlyOwner returns (uint256) {
return VESTER.wlfiClaimFor(_user);
}
function renounceOwnership() public override view onlyOwner {
revert NotImplemented();
}
// ==================================================
// =============== Guardian Functions ===============
// ==================================================
function guardianPause() external onlyGuardian whenNotPaused {
_pause();
}
function guardianSetBlacklistStatus(address _account, bool _isBlacklisted) external onlyGuardian {
_setBlacklistStatus(_account, _isBlacklisted);
}
// ==================================================
// ================ Public Functions ================
// ==================================================
function activateAccount(bytes calldata _signature) external {
address account = _msgSender();
_validateSignatureForAccountActivationAndActivate(account, _signature);
}
function activateAccountAndClaimVest(bytes calldata _signature) external whenNotPaused returns (uint256) {
address account = _msgSender();
_validateSignatureForAccountActivationAndActivate(account, _signature);
if (VESTER.claimable(account) == 0) {
// Prevent reversion if there is nothing to claim. For a better UX
return 0;
}
return VESTER.wlfiClaimFor(_msgSender());
}
function claimVest() external whenNotPaused returns (uint256) {
return VESTER.wlfiClaimFor(_msgSender());
}
function getAllowListStatus(
address _account
) public view returns (bool) {
return _allowListStatus[_account];
}
function isGuardian(
address _guardian
) public view returns (bool) {
return _guardians[_guardian];
}
function isVoterExcluded(
address _account
) public view returns (bool excludedStatus) {
return _excludedVotingPower[_account];
}
function isBlacklisted(
address _account
) public view returns (bool blacklistStatus) {
return _getStorage().blacklistStatus[_account];
}
function getVotes(
address _account
) public view override returns (uint256) {
if (isVoterExcluded(_account) || isBlacklisted(_account)) {
return 0;
}
// Get delegated votes + vesting votes
// Tokens in the vester contract that are owned by `_account` cannot be delegated
uint256 votingPower = super.getVotes(_account) + VESTER.unclaimed(_account);
if (delegates(_account) == address(0)) {
// If the user has not delegated yet, add their balance to reduce UX burden of calling `delegate`
votingPower += super.balanceOf(_account);
}
if (votingPower > MAX_VOTING_POWER) {
return MAX_VOTING_POWER;
}
return votingPower;
}
function isReadyToTransact(address _account) public view returns (bool) {
return !REGISTRY.isLegacyUser(_account) || REGISTRY.isLegacyUserAndIsActivated(_account);
}
function authorizedSigner() public view returns (address) {
return _getStorage().authorizedSigner;
}
function isAfterTradingStartTimestamp() public view returns (bool) {
return block.timestamp >= TRADING_START_TIMESTAMP;
}
// ==================================================
// =============== Internal Functions ===============
// ==================================================
function _delegate(
address _account,
address _delegatee
)
notBlacklisted(_msgSender())
notBlacklisted(_account)
notBlacklisted(_delegatee)
whenNotPaused
internal
override
{
if (isVoterExcluded(_account)) {
revert VoterIsExcluded(_account);
}
super._delegate(_account, _delegatee);
}
function _approve(
address _owner,
address _spender,
uint256 _value,
bool _emitEvent
)
notBlacklisted(_msgSender())
notBlacklisted(_owner)
notBlacklisted(_spender)
whenNotPaused
internal
override
{
super._approve(_owner, _spender, _value, _emitEvent);
}
function _update(
address _from,
address _to,
uint256 _value
)
notBlacklisted(_msgSender())
notBlacklisted(_from)
notBlacklisted(_to)
internal
override(
ERC20Upgradeable,
ERC20VotesUpgradeable,
ERC20PausableUpgradeable
)
{
if (_to == address(this)) {
revert InvalidAccount();
}
if (!isAfterTradingStartTimestamp()) {
if ((_msgSender() == address(VESTER) && _to == address(VESTER)) || _msgSender() == owner()) {
// GUARD STATEMENT
// Only `owner()` or `VESTER` can move tokens
return super._update(_from, _to, _value);
}
// GUARD STATEMENT #2
if (!_allowListStatus[_from]) {
revert TransferNotAllowedYet();
}
return super._update(_from, _to, _value);
}
if (REGISTRY.isLegacyUserAndIsNotActivated(_from)) {
// The registry is updated prior to the transfer occurring, so we don't need to check if the funds are
// going to the vester
revert AccountNotActivated(_from);
}
if (REGISTRY.isLegacyUserAndIsNotActivated(_to)) {
revert AccountNotActivated(_to);
}
return super._update(_from, _to, _value);
}
function _ownerSetVotingPowerExcludedStatus(
address _account,
bool _isExcluded
) internal {
if (_isExcluded) {
// Undelegate the user's voting power
_delegate(_account, address(0));
}
_excludedVotingPower[_account] = _isExcluded;
emit SetVotingPowerExcludedStatus(_account, _isExcluded);
}
function _setBlacklistStatus(address _account, bool _isBlacklisted) internal {
if (_isBlacklisted) {
// Undelegate the user's voting power
_delegate(_account, address(0));
}
_getStorage().blacklistStatus[_account] = _isBlacklisted;
emit SetBlacklistStatus(_account, _isBlacklisted);
}
function _ownerSetAuthorizedSigner(V2 storage $, address _authorizedSigner) internal {
if (_authorizedSigner == address(0)) {
revert InvalidAuthorizedSigner();
}
$.authorizedSigner = _authorizedSigner;
emit SetAuthorizedSigner(_authorizedSigner);
}
function _validateSignatureForAccountActivationAndActivate(address _account, bytes calldata _signature) internal {
bytes32 hash = _hashTypedDataV4(keccak256(abi.encode(ACTIVATION_TYPEHASH, _account)));
if (authorizedSigner() != ECDSA.recover(hash, _signature)) {
revert InvalidSignature();
}
_activateAccount(_account, /* _bypassVester = */ false);
}
function _activateAccount(address _account, bool _bypassVester) internal {
REGISTRY.wlfiActivateAccount(_account);
uint8 category = REGISTRY.getLegacyUserCategory(_account);
uint112 allocation = REGISTRY.getLegacyUserAllocation(_account);
if (!_bypassVester) {
// Reset the allowance
_approve(_account, address(VESTER), 0);
_approve(_account, address(VESTER), allocation);
VESTER.wlfiActivateVest(_account, category, allocation);
assert(allowance(_account, address(VESTER)) == 0);
}
}
function _checkGuardian() internal view {
address caller = _msgSender();
if (!_guardians[caller]) {
revert GuardianUnauthorizedAccount(caller);
}
}
function _checkNotBlacklisted(address _account) internal view {
if (_account != address(0) && _getStorage().blacklistStatus[_account]) {
revert Blacklisted(_account);
}
}
function _getStorage() private pure returns (V2 storage $) {
bytes32 location = WLFIV2StorageLocation;
assembly {
$.slot := location
}
}
uint256[50] private __gap; // reserve space for upgradeability storage slot. Inherited from WLFI V1
}
Read Contract
CLOCK_MODE 0x4bf5d7e9 → string
MAX_VOTING_POWER 0x152439db → uint256
REGISTRY 0x06433b1b → address
TRADING_START_TIMESTAMP 0x95d9538d → uint256
VESTER 0xc455d4f6 → address
allowance 0xdd62ed3e → uint256
authorizedSigner 0xc771909c → address
balanceOf 0x70a08231 → uint256
checkpoints 0xf1127ed8 → tuple
clock 0x91ddadf4 → uint48
decimals 0x313ce567 → uint8
delegates 0x587cde1e → address
eip712Domain 0x84b0196e → bytes1, string, string, uint256, address, bytes32, uint256[]
getAllowListStatus 0x5a2cba27 → bool
getPastTotalSupply 0x8e539e8c → uint256
getPastVotes 0x3a46b1a8 → uint256
getVotes 0x9ab24eb0 → uint256
isAfterTradingStartTimestamp 0x241f1c99 → bool
isBlacklisted 0xfe575a87 → bool
isGuardian 0x0c68ba21 → bool
isReadyToTransact 0x6fc9028e → bool
isVoterExcluded 0xf36e0515 → bool
name 0x06fdde03 → string
nonces 0x7ecebe00 → uint256
numCheckpoints 0x6fcfff45 → uint32
owner 0x8da5cb5b → address
paused 0x5c975abb → bool
pendingOwner 0xe30c3978 → address
renounceOwnership 0x715018a6
symbol 0x95d89b41 → string
totalSupply 0x18160ddd → uint256
Write Contract 27 functions
These functions modify contract state and require a wallet transaction to execute.
acceptOwnership 0x79ba5097
No parameters
activateAccount 0x252f3867
bytes _signature
activateAccountAndClaimVest 0xe5195157
bytes _signature
returns: uint256
approve 0x095ea7b3
address spender
uint256 value
returns: bool
burn 0x42966c68
uint256 value
burnFrom 0x79cc6790
address account
uint256 value
claimVest 0xf13253bb
No parameters
returns: uint256
delegate 0x5c19a95c
address delegatee
delegateBySig 0xc3cda520
address delegatee
uint256 nonce
uint256 expiry
uint8 v
bytes32 r
bytes32 s
guardianPause 0xd4593872
No parameters
guardianSetBlacklistStatus 0x5aa42d12
address _account
bool _isBlacklisted
initialize 0xc4d66de8
address _authorizedSigner
ownerActivateAccount 0xb6274f3d
address _account
bool _bypassVester
ownerClaimVestFor 0xbfc9c359
address _user
returns: uint256
ownerPause 0x967f1cc6
No parameters
ownerReallocateFrom 0x7df9a674
address _from
address _to
uint256 _value
ownerRescueTokens 0x94d4827f
address _recipient
address _token
uint256 _value
ownerSetAuthorizedSigner 0x2ad36687
address _authorizedSigner
ownerSetBlacklistStatus 0xe1dfc884
address _account
bool _isBlacklisted
ownerSetGuardian 0x8682db37
address _guardian
bool _status
ownerSetMaxVotingPower 0x56f31c5d
uint256 _maxVotingPower
ownerSetTransferBeforeStartStatus 0xc7dac704
address _account
bool _isAllowed
ownerSetVotingPowerExcludedStatus 0x56c531b9
address _account
bool _status
ownerUnpause 0x0f861ca3
No parameters
transfer 0xa9059cbb
address to
uint256 value
returns: bool
transferFrom 0x23b872dd
address from
address to
uint256 value
returns: bool
transferOwnership 0xf2fde38b
address newOwner
Recent Transactions
This address has 1 on-chain transactions, but only 0.8% of the chain is indexed. Transactions will appear as indexing progresses. View on Etherscan →