├── .env.example ├── .github └── workflows │ ├── lints.yml │ └── tests.yml ├── .gitignore ├── LICENSE ├── README.md ├── contracts ├── Greeter.cairo ├── interfaces │ ├── IAccount.cairo │ ├── IAggregatorV3.cairo │ ├── IERC1155.cairo │ ├── IERC165.cairo │ ├── IERC20.cairo │ └── IERC721.cairo └── utils │ ├── Account.cairo │ ├── Context.cairo │ ├── Ownable.cairo │ └── Pausable.cairo ├── package.json ├── requirements.txt └── tests ├── test_Greeter.py └── utils.py /.env.example: -------------------------------------------------------------------------------- 1 | STARKNET_NETWORK=alpha-goerli -------------------------------------------------------------------------------- /.github/workflows/lints.yml: -------------------------------------------------------------------------------- 1 | name: Lints 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | lint: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Set up Python 3.9 13 | uses: actions/setup-python@v2 14 | with: 15 | python-version: 3.9 16 | - name: Install dependencies 17 | run: | 18 | python -m pip install --upgrade pip 19 | pip install flake8 pytest cairo-lang 20 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 21 | - name: Lint with flake8 22 | run: | 23 | # stop the build if there are Python syntax errors or undefined names 24 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 25 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 26 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | tests: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Set up Python 3.9 13 | uses: actions/setup-python@v2 14 | with: 15 | python-version: 3.9 16 | - name: Install dependencies 17 | run: | 18 | python -m pip install --upgrade pip 19 | pip install flake8 pytest cairo-lang 20 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 21 | - name: Test with pytest 22 | run: | 23 | pytest -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Cairo-specific ignores 2 | artifacts 3 | 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | pip-wheel-metadata/ 28 | share/python-wheels/ 29 | *.egg-info/ 30 | .installed.cfg 31 | *.egg 32 | MANIFEST 33 | 34 | # PyInstaller 35 | # Usually these files are written by a python script from a template 36 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 37 | *.manifest 38 | *.spec 39 | 40 | # Installer logs 41 | pip-log.txt 42 | pip-delete-this-directory.txt 43 | 44 | # Unit test / coverage reports 45 | htmlcov/ 46 | .tox/ 47 | .nox/ 48 | .coverage 49 | .coverage.* 50 | .cache 51 | nosetests.xml 52 | coverage.xml 53 | *.cover 54 | *.py,cover 55 | .hypothesis/ 56 | .pytest_cache/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | target/ 80 | 81 | # Jupyter Notebook 82 | .ipynb_checkpoints 83 | 84 | # IPython 85 | profile_default/ 86 | ipython_config.py 87 | 88 | # pyenv 89 | .python-version 90 | 91 | # pipenv 92 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 93 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 94 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 95 | # install all needed dependencies. 96 | #Pipfile.lock 97 | 98 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 99 | __pypackages__/ 100 | 101 | # Celery stuff 102 | celerybeat-schedule 103 | celerybeat.pid 104 | 105 | # SageMath parsed files 106 | *.sage.py 107 | 108 | # Environments 109 | .env 110 | .venv 111 | env/ 112 | venv/ 113 | ENV/ 114 | env.bak/ 115 | venv.bak/ 116 | 117 | # Spyder project settings 118 | .spyderproject 119 | .spyproject 120 | 121 | # Rope project settings 122 | .ropeproject 123 | 124 | # mkdocs documentation 125 | /site 126 | 127 | # mypy 128 | .mypy_cache/ 129 | .dmypy.json 130 | dmypy.json 131 | 132 | # Pyre type checker 133 | .pyre/ 134 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cairostarter • [![Tests](https://github.com/a5f9t4/cairostarter/actions/workflows/tests.yml/badge.svg)](https://github.com/a5f9t4/cairostarter/actions/workflows/tests.yml) [![Lints](https://github.com/a5f9t4/cairostarter/actions/workflows/lints.yml/badge.svg)](https://github.com/a5f9t4/cairostarter/actions/workflows/lints.yml) ![GitHub](https://img.shields.io/github/license/a5f9t4/cairostarter) ![GitHub package.json version](https://img.shields.io/github/package-json/v/a5f9t4/cairostarter) 2 | 3 | 4 | **Forkable**, **Minimal** Template for Starknet Projects. 5 | 6 | ## Directory Structure 7 | 8 | ```ml 9 | contracts 10 | ├─ Greeter — "An example greeter contract" 11 | ├─ interfaces 12 | │ ├─ IAccount — "Account Interface" 13 | │ ├─ IAggregatorV3 — "Chainlink V3 Aggregator Interface" 14 | │ ├─ IERC20 — "ERC20 Contract Interface" 15 | │ ├─ IERC165 — "ERC165 Contract Interface" 16 | │ ├─ IERC721 — "ERC721 Contract Interface" 17 | │ └─ IERC1155 — "ERC1155 Contract Interface" 18 | ├─ utils 19 | │ ├─ Account — "Stripped account" 20 | │ ├─ Ownable — "Minimal, ownable contract instance" 21 | │ ├─ Context — "Port of OZ's Solidity Context Abstraction" 22 | │ └─ Pausible — "Pausible Solidity Functionality" 23 | tests 24 | └─ test_Greeter — "Test Script for the Greeter Contract" 25 | ``` 26 | 27 | ## Installation 28 | 29 | ### TL;DR 30 | 31 | ```bash 32 | sudo apt install -y libgmp3-dev # linux 33 | # OR 34 | brew install gmp # mac 35 | 36 | yarn setup # Sets up a python environment and nile installation 37 | 38 | yarn compile # Compile the contracts 39 | 40 | yarn test # Syntactic sugar for running `pytest` (python tests) 41 | ``` 42 | 43 | ### First time? 44 | 45 | Further installation instructions provided in the [cairo-lang docs](https://www.cairo-lang.org/docs/quickstart.html) 46 | 47 | Before installing Cairo on your machine, you need to install `gmp`: 48 | ```bash 49 | sudo apt install -y libgmp3-dev # linux 50 | brew install gmp # mac 51 | ``` 52 | > If you have any troubles installing gmp on your Apple M1 computer, [here’s a list of potential solutions](https://github.com/OpenZeppelin/nile/issues/22). 53 | 54 | For VSCode support: 55 | 56 | Download `cairo-0.6.2.vsix` from https://github.com/starkware-libs/cairo-lang/releases/tag/v0.6.2 57 | 58 | And run: 59 | ```bash 60 | code --install-extension cairo-0.6.2.vsix 61 | ``` 62 | 63 | ### Set up the project 64 | 65 | Clone the repository 66 | 67 | ```bash 68 | git clone git@github.com:a5f9t4/cairostarter.git 69 | ``` 70 | 71 | `cd` into it and create a Python virtual environment: 72 | 73 | ```bash 74 | cd cairostarter 75 | python3 -m venv env 76 | source env/bin/activate 77 | ``` 78 | 79 | ### Nile 80 | 81 | Install the [Nile](https://github.com/OpenZeppelin/nile) dev environment and then run `install` to get [the Cairo language](https://www.cairo-lang.org/docs/quickstart.html), a [local network](https://github.com/Shard-Labs/starknet-devnet/), and a [testing framework](https://docs.pytest.org/en/6.2.x/). 82 | ```bash 83 | pip3 install cairo-nile 84 | nile install 85 | ``` 86 | 87 | ## Usage 88 | 89 | ### Compile the contracts 90 | 91 | ```bash 92 | nile compile 93 | ``` 94 | 95 | ### Run tests 96 | 97 | ```bash 98 | pytest 99 | ``` 100 | 101 | 102 | ## Acknowledgements 103 | 104 | - [cairomate](https://github.com/a5f9t4/cairomate) 105 | - [StarkWare](https://starkware.co/) 106 | - [OpenZeppelin](https://github.com/OpenZeppelin/cairo-contracts) 107 | - [DappTools Template](https://github.com/gakonst/dapptools-template) 108 | 109 | ## Security 110 | 111 | This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Do not use in production. 112 | 113 | Please report any security issues you find by opening up an issue in this reposisitory. 114 | 115 | ## License 116 | 117 | Cairostarter Contracts are released under the [AGPL-3.0-only](LICENSE). -------------------------------------------------------------------------------- /contracts/Greeter.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | %builtins pedersen range_check 3 | 4 | from starkware.starknet.common.syscalls import get_caller_address 5 | from starkware.cairo.common.cairo_builtins import HashBuiltin 6 | from starkware.cairo.common.hash import hash2 7 | from starkware.cairo.common.math import assert_le, assert_nn_le, unsigned_div_rem, assert_not_zero 8 | from starkware.starknet.common.syscalls import storage_read, storage_write 9 | from starkware.cairo.common.uint256 import ( 10 | Uint256, uint256_add, uint256_sub, uint256_le, uint256_lt, uint256_check 11 | ) 12 | 13 | ## @title Greeting 14 | ## @description A minimalistic gm 15 | ## @description Mirrors gakonst's Dapptools-template https://github.com/gakonst/dapptools-template/blob/master/src/Greeter.sol 16 | ## @author Alucard 17 | 18 | ############################################# 19 | ## METADATA ## 20 | ############################################# 21 | 22 | @storage_var 23 | func GREETING() -> (greeting: felt): 24 | end 25 | 26 | ############################################# 27 | ## CONSTRUCTOR ## 28 | ############################################# 29 | 30 | @constructor 31 | func constructor{ 32 | syscall_ptr: felt*, 33 | pedersen_ptr: HashBuiltin*, 34 | range_check_ptr 35 | }( 36 | greeting: felt 37 | ): 38 | GREETING.write(greeting) 39 | return () 40 | end 41 | 42 | ############################################# 43 | ## ACCESSORS ## 44 | ############################################# 45 | 46 | @view 47 | func gm{ 48 | syscall_ptr: felt*, 49 | pedersen_ptr: HashBuiltin*, 50 | range_check_ptr 51 | }() -> (gm: felt): 52 | ## Manually fetch the caller address ## 53 | let (greeting: felt) = GREETING.read() 54 | return (gm=greeting) 55 | end 56 | 57 | ############################################# 58 | ## MUTATORS ## 59 | ############################################# 60 | 61 | @external 62 | func setGreeting{ 63 | syscall_ptr: felt*, 64 | pedersen_ptr: HashBuiltin*, 65 | range_check_ptr 66 | }( 67 | new_greeting: felt 68 | ): 69 | GREETING.write(new_greeting) 70 | return () 71 | end 72 | -------------------------------------------------------------------------------- /contracts/interfaces/IAccount.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | ## @title Account Interface 4 | ## @description An interface for the Account implementation. 5 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 6 | ## @author Alucard 7 | 8 | @contract_interface 9 | namespace IAccount: 10 | func get_nonce() -> (res : felt): 11 | end 12 | 13 | func is_valid_signature( 14 | hash: felt, 15 | signature_len: felt, 16 | signature: felt* 17 | ): 18 | end 19 | 20 | func execute( 21 | to: felt, 22 | selector: felt, 23 | calldata_len: felt, 24 | calldata: felt*, 25 | nonce: felt 26 | ) -> (response_len: felt, response: felt*): 27 | end 28 | end -------------------------------------------------------------------------------- /contracts/interfaces/IAggregatorV3.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | from starkware.cairo.common.uint256 import Uint256 4 | 5 | ## @title AggregatorV3 Interface 6 | ## @description An interface for Chainlink V3 aggregator. 7 | ## @description Adapted from https://solidity-by-example.org/defi/chainlink-price-oracle/ 8 | ## @author Alucard 9 | 10 | @contract_interface 11 | namespace IAggregatorV3: 12 | func latestRoundData() -> ( 13 | roundId: Uint256, # This should be a uint80 14 | answer: Uint256, 15 | startedAt: Uint256, 16 | updatedAt: Uint256, 17 | answeredInRound: Uint256 # This should be a uint80 18 | ): 19 | end 20 | end -------------------------------------------------------------------------------- /contracts/interfaces/IERC1155.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | from starkware.cairo.common.uint256 import Uint256 4 | 5 | ## @title ERC1155 Interface 6 | ## @description An interface for the ERC1155 standard. 7 | ## @description Follows https://eips.ethereum.org/EIPS/eip-1155 8 | ## @author Alucard 9 | 10 | @contract_interface 11 | namespace IERC1155: 12 | 13 | ## @notice Transfers `_value` amount of an `_id` from the `_from` address to the `_to` address specified (with safety call). 14 | ## @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). 15 | ## MUST revert if `_to` is the zero address. 16 | ## MUST revert if balance of holder for token `_id` is lower than the `_value` sent. 17 | ## MUST revert on any other error. 18 | ## MUST emit the `TransferSingle` event to reflect the balance change (see "Safe Transfer Rules" section of the standard). 19 | ## After the above conditions are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call `onERC1155Received` on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). 20 | ## @param _from Source address 21 | ## @param _to Target address 22 | ## @param _id ID of the token type 23 | ## @param _value Transfer amount 24 | ## @param _data Additional data with no specified format, MUST be sent unaltered in call to `onERC1155Received` on `_to` 25 | func safeTransferFrom( 26 | _from: felt, 27 | _to: felt, 28 | _id: Uint256, 29 | _value: Uint256, 30 | _data: felt 31 | ): 32 | end 33 | 34 | ## @notice Transfers `_values` amount(s) of `_ids` from the `_from` address to the `_to` address specified (with safety call). 35 | ## @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). 36 | ## MUST revert if `_to` is the zero address. 37 | ## MUST revert if length of `_ids` is not the same as length of `_values`. 38 | ## MUST revert if any of the balance(s) of the holder(s) for token(s) in `_ids` is lower than the respective amount(s) in `_values` sent to the recipient. 39 | ## MUST revert on any other error. 40 | ## MUST emit `TransferSingle` or `TransferBatch` event(s) such that all the balance changes are reflected (see "Safe Transfer Rules" section of the standard). 41 | ## Balance changes and events MUST follow the ordering of the arrays (_ids[0]/_values[0] before _ids[1]/_values[1], etc). 42 | ## After the above conditions for the transfer(s) in the batch are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call the relevant `ERC1155TokenReceiver` hook(s) on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). 43 | ## @param _from Source address 44 | ## @param _to Target address 45 | ## @param _ids IDs of each token type (order and length must match _values array) 46 | ## @param _values Transfer amounts per token type (order and length must match _ids array) 47 | ## @param _data Additional data with no specified format, MUST be sent unaltered in call to the `ERC1155TokenReceiver` hook(s) on `_to` 48 | func safeBatchTransferFrom( 49 | _from: felt, 50 | _to: felt, 51 | ## @dev Array arguments are defined by `_len` felt and the data 52 | ## @dev https://www.cairo-lang.org/docs/hello_starknet/more_features.html#array-arguments-in-calldata 53 | _ids_len: felt, 54 | _ids: felt*, # ?? Uint256* ?? 55 | _values_len: felt, 56 | _values: felt*, # ?? Uint256* ?? 57 | _data: felt 58 | ): 59 | end 60 | 61 | ## @notice Get the balance of an account's tokens. 62 | ## @param _owner The address of the token holder 63 | ## @param _id ID of the token 64 | ## @return The _owner's balance of the token type requested 65 | func balanceOf( 66 | _owner: felt, 67 | _id: Uint256 68 | ) -> ( 69 | balance: Uint256 70 | ): 71 | end 72 | 73 | ## @notice Get the balance of multiple account/token pairs 74 | ## @param _owners The addresses of the token holders 75 | ## @param _ids ID of the tokens 76 | ## @return The _owner's balance of the token types requested (i.e. balance for each (owner, id) pair) 77 | func balanceOfBatch( 78 | ## @dev Array arguments are defined by `_len` felt and the data 79 | ## @dev https://www.cairo-lang.org/docs/hello_starknet/more_features.html#array-arguments-in-calldata 80 | _owners_len: felt, 81 | _owners: felt*, 82 | _ids_len: felt, 83 | _ids: felt* # ?? Uint256* ?? 84 | ) -> ( 85 | balances_len: felt, 86 | balances: felt* # ?? Uint256* ?? 87 | ): 88 | end 89 | 90 | ## @notice Enable or disable approval for a third party ("operator") to manage all of the caller's tokens. 91 | ## @dev MUST emit the ApprovalForAll event on success. 92 | ## @param _operator Address to add to the set of authorized operators 93 | ## @param _approved True if the operator is approved, false to revoke approval 94 | func setApprovalForAll( 95 | _operator: felt, 96 | _approved: felt 97 | ): 98 | end 99 | 100 | ## @notice Queries the approval status of an operator for a given owner. 101 | ## @param _owner The owner of the tokens 102 | ## @param _operator Address of authorized operator 103 | ## @return True if the operator is approved, false if not 104 | func isApprovedForAll( 105 | _owner: felt, 106 | _operator: felt 107 | ) -> ( 108 | approved: felt 109 | ): 110 | end 111 | end -------------------------------------------------------------------------------- /contracts/interfaces/IERC165.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | from starkware.cairo.common.uint256 import Uint256 4 | 5 | ## @title ERC165 Interface 6 | ## @description An interface for the ERC165 standard. 7 | ## @description Specification: https://eips.ethereum.org/EIPS/eip-165 8 | ## @author Alucard 9 | 10 | @contract_interface 11 | namespace IERC165: 12 | ## @notice Query if a contract implements an interface 13 | ## @param interfaceID The interface identifier, as specified in ERC-165 14 | ## @dev Interface identification is specified in ERC-165. This function 15 | ## uses less than 30,000 gas. 16 | ## @return `true` if the contract implements `interfaceID` and 17 | ## `interfaceID` is not 0xffffffff, `false` otherwise 18 | func supportsInterface( 19 | interfaceID: felt # This should be a bytes4 20 | ) -> ( 21 | supported: felt # 0 (false) or 1 (true) - no native booleans in cairo 22 | ): 23 | end 24 | end -------------------------------------------------------------------------------- /contracts/interfaces/IERC20.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | from starkware.cairo.common.uint256 import Uint256 4 | 5 | ## @title ERC20 Interface 6 | ## @description An interface for the ERC20 standard. 7 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 8 | ## @author Alucard 9 | 10 | @contract_interface 11 | namespace IERC20: 12 | func name() -> (name: felt): 13 | end 14 | 15 | func symbol() -> (symbol: felt): 16 | end 17 | 18 | func decimals() -> (decimals: felt): 19 | end 20 | 21 | func totalSupply() -> (totalSupply: Uint256): 22 | end 23 | 24 | func balanceOf(account: felt) -> (balance: Uint256): 25 | end 26 | 27 | func allowance(owner: felt, spender: felt) -> (remaining: Uint256): 28 | end 29 | 30 | func transfer(recipient: felt, amount: Uint256) -> (success: felt): 31 | end 32 | 33 | func transferFrom( 34 | sender: felt, 35 | recipient: felt, 36 | amount: Uint256 37 | ) -> (success: felt): 38 | end 39 | 40 | func approve(spender: felt, amount: Uint256) -> (success: felt): 41 | end 42 | end -------------------------------------------------------------------------------- /contracts/interfaces/IERC721.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | 3 | from starkware.cairo.common.uint256 import Uint256 4 | 5 | ## @title ERC721 Interface 6 | ## @description An interface for the ERC721 standard. 7 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 8 | ## @author Alucard 9 | 10 | @contract_interface 11 | namespace IERC721: 12 | func name() -> (name: felt): 13 | end 14 | 15 | func symbol() -> (symbol: felt): 16 | end 17 | 18 | func baseURI() -> (base_uri: felt): 19 | end 20 | 21 | func totalSupply() -> (totalSupply: Uint256): 22 | end 23 | 24 | func balanceOf(account: felt) -> (balance: Uint256): 25 | end 26 | 27 | func allowance(owner: felt, spender: felt) -> (remaining: Uint256): 28 | end 29 | 30 | func transfer(recipient: felt, amount: Uint256) -> (success: felt): 31 | end 32 | 33 | func transferFrom( 34 | sender: felt, 35 | recipient: felt, 36 | amount: Uint256 37 | ) -> (success: felt): 38 | end 39 | 40 | func approve(spender: felt, amount: Uint256) -> (success: felt): 41 | end 42 | end -------------------------------------------------------------------------------- /contracts/utils/Account.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | %builtins pedersen range_check ecdsa 3 | 4 | from starkware.cairo.common.registers import get_fp_and_pc 5 | from starkware.starknet.common.syscalls import get_contract_address 6 | from starkware.cairo.common.signature import verify_ecdsa_signature 7 | from starkware.cairo.common.cairo_builtins import HashBuiltin, SignatureBuiltin 8 | from starkware.starknet.common.syscalls import call_contract, get_caller_address, get_tx_signature 9 | from starkware.cairo.common.hash_state import ( 10 | hash_init, hash_finalize, hash_update, hash_update_single 11 | ) 12 | 13 | ## @title Account 14 | ## @description A stripped down Account adapted from OpenZeppelin's [Account.cairo](https://github.com/OpenZeppelin/cairo-contracts/blob/main/contracts/Account.cairo). 15 | ## @author Alucard 16 | 17 | ############################################# 18 | ## STORAGE ## 19 | ############################################# 20 | 21 | struct Message: 22 | member sender: felt 23 | member to: felt 24 | member selector: felt 25 | member calldata: felt* 26 | member calldata_size: felt 27 | member nonce: felt 28 | end 29 | 30 | @storage_var 31 | func current_nonce() -> (res: felt): 32 | end 33 | 34 | @storage_var 35 | func public_key() -> (res: felt): 36 | end 37 | 38 | ############################################# 39 | ## CONSTRUCTOR ## 40 | ############################################# 41 | 42 | @constructor 43 | func constructor{ 44 | syscall_ptr: felt*, 45 | pedersen_ptr: HashBuiltin*, 46 | range_check_ptr 47 | }(_public_key: felt): 48 | public_key.write(_public_key) 49 | return() 50 | end 51 | 52 | ############################################# 53 | ## MODIFIERS ## 54 | ############################################# 55 | 56 | @view 57 | func assert_only_self{ 58 | syscall_ptr: felt*, 59 | pedersen_ptr: HashBuiltin*, 60 | range_check_ptr 61 | }(): 62 | let (self) = get_contract_address() 63 | let (caller) = get_caller_address() 64 | assert self = caller 65 | return () 66 | end 67 | 68 | ############################################# 69 | ## ACCESSORS ## 70 | ############################################# 71 | 72 | @view 73 | func get_public_key{ 74 | syscall_ptr: felt*, 75 | pedersen_ptr: HashBuiltin*, 76 | range_check_ptr 77 | }() -> (res: felt): 78 | let (res) = public_key.read() 79 | return (res=res) 80 | end 81 | 82 | @view 83 | func get_nonce{ 84 | syscall_ptr: felt*, 85 | pedersen_ptr: HashBuiltin*, 86 | range_check_ptr 87 | }() -> (res: felt): 88 | let (res) = current_nonce.read() 89 | return (res=res) 90 | end 91 | 92 | ############################################# 93 | ## MUTATORS ## 94 | ############################################# 95 | 96 | @external 97 | func set_public_key{ 98 | syscall_ptr: felt*, 99 | pedersen_ptr: HashBuiltin*, 100 | range_check_ptr 101 | }(new_public_key: felt): 102 | assert_only_self() 103 | public_key.write(new_public_key) 104 | return () 105 | end 106 | 107 | ############################################# 108 | ## LOGIC ## 109 | ############################################# 110 | 111 | @view 112 | func is_valid_signature{ 113 | syscall_ptr: felt*, 114 | pedersen_ptr: HashBuiltin*, 115 | range_check_ptr, 116 | ecdsa_ptr: SignatureBuiltin* 117 | }( 118 | hash: felt, 119 | signature_len: felt, 120 | signature: felt* 121 | ) -> (): 122 | let (_public_key) = public_key.read() 123 | 124 | # This interface expects a signature pointer and length to make 125 | # no assumption about signature validation schemes. 126 | # But this implementation does, and it expects a (sig_r, sig_s) pair. 127 | let sig_r = signature[0] 128 | let sig_s = signature[1] 129 | 130 | verify_ecdsa_signature( 131 | message=hash, 132 | public_key=_public_key, 133 | signature_r=sig_r, 134 | signature_s=sig_s) 135 | 136 | return () 137 | end 138 | 139 | @external 140 | func execute{ 141 | syscall_ptr: felt*, 142 | pedersen_ptr: HashBuiltin*, 143 | range_check_ptr, 144 | ecdsa_ptr: SignatureBuiltin* 145 | }( 146 | to: felt, 147 | selector: felt, 148 | calldata_len: felt, 149 | calldata: felt*, 150 | nonce: felt 151 | ) -> (response_len: felt, response: felt*): 152 | alloc_locals 153 | 154 | let (__fp__, _) = get_fp_and_pc() 155 | let (_address) = get_contract_address() 156 | let (_current_nonce) = current_nonce.read() 157 | 158 | local message: Message = Message( 159 | _address, 160 | to, 161 | selector, 162 | calldata, 163 | calldata_size=calldata_len, 164 | _current_nonce 165 | ) 166 | 167 | ## CHECKS ## 168 | let (hash) = hash_message(&message) 169 | let (signature_len, signature) = get_tx_signature() 170 | is_valid_signature(hash, signature_len, signature) 171 | 172 | ## EFFECTS ## 173 | current_nonce.write(_current_nonce + 1) 174 | 175 | ## INTERACTIONS ## 176 | let response = call_contract( 177 | contract_address=message.to, 178 | function_selector=message.selector, 179 | calldata_size=message.calldata_size, 180 | calldata=message.calldata 181 | ) 182 | 183 | return (response_len=response.retdata_size, response=response.retdata) 184 | end 185 | 186 | func hash_message{ 187 | pedersen_ptr: HashBuiltin* 188 | }( 189 | message: Message* 190 | ) -> (res: felt): 191 | alloc_locals 192 | # we need to make `res_calldata` local 193 | # to prevent the reference from being revoked 194 | let (local res_calldata) = hash_calldata(message.calldata, message.calldata_size) 195 | let hash_ptr = pedersen_ptr 196 | with hash_ptr: 197 | let (hash_state_ptr) = hash_init() 198 | # first three iterations are 'sender', 'to', and 'selector' 199 | let (hash_state_ptr) = hash_update( 200 | hash_state_ptr, 201 | message, 202 | 3 203 | ) 204 | let (hash_state_ptr) = hash_update_single( 205 | hash_state_ptr, res_calldata) 206 | let (hash_state_ptr) = hash_update_single( 207 | hash_state_ptr, message.nonce) 208 | let (res) = hash_finalize(hash_state_ptr) 209 | let pedersen_ptr = hash_ptr 210 | return (res=res) 211 | end 212 | end 213 | 214 | func hash_calldata{ 215 | pedersen_ptr: HashBuiltin* 216 | }( 217 | calldata: felt*, 218 | calldata_size: felt 219 | ) -> (res: felt): 220 | let hash_ptr = pedersen_ptr 221 | with hash_ptr: 222 | let (hash_state_ptr) = hash_init() 223 | let (hash_state_ptr) = hash_update( 224 | hash_state_ptr, 225 | calldata, 226 | calldata_size 227 | ) 228 | let (res) = hash_finalize(hash_state_ptr) 229 | let pedersen_ptr = hash_ptr 230 | return (res=res) 231 | end 232 | end -------------------------------------------------------------------------------- /contracts/utils/Context.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | %builtins pedersen range_check 3 | 4 | from starkware.cairo.common.cairo_builtins import HashBuiltin 5 | from starkware.starknet.common.syscalls import ( 6 | get_contract_address) 7 | 8 | ## @title Context 9 | ## @description A mirror of the Openzeppelin Context pattern. 10 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 11 | ## @description https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/Context.sol 12 | ## @description sry @t11s know ur not a fan 13 | ## @author Alucard 14 | 15 | ## Returns the caller ## 16 | @external 17 | func _msgSender{ 18 | syscall_ptr: felt*, 19 | pedersen_ptr: HashBuiltin*, 20 | range_check_ptr 21 | }() -> (sender: felt): 22 | let (sender) = get_contract_address() 23 | return (sender=sender) 24 | end -------------------------------------------------------------------------------- /contracts/utils/Ownable.cairo: -------------------------------------------------------------------------------- 1 | %lang starknet 2 | %builtins pedersen range_check 3 | 4 | from starkware.cairo.common.cairo_builtins import HashBuiltin 5 | 6 | ## @title Ownable 7 | ## @description A mirror of the Openzeppelin Ownable pattern 8 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 9 | ## @author Alucard 10 | 11 | ############################################# 12 | ## STORAGE ## 13 | ############################################# 14 | 15 | ## The contract owner ## 16 | @storage_var 17 | func OWNER() -> (owner : felt): 18 | end 19 | 20 | ############################################# 21 | ## CONSTRUCTOR ## 22 | ############################################# 23 | 24 | ## Sets the contract owner as the `owner` parameter ## 25 | @constructor 26 | func constructor{ 27 | syscall_ptr: felt*, 28 | pedersen_ptr: HashBuiltin*, 29 | range_check_ptr 30 | }( 31 | owner: felt 32 | ): 33 | OWNER.write(owner) 34 | return () 35 | end 36 | 37 | ############################################# 38 | ## OWNABLE LOGIC ## 39 | ############################################# 40 | 41 | @external 42 | func get_owner{ 43 | syscall_ptr: felt*, 44 | pedersen_ptr: HashBuiltin*, 45 | range_check_ptr 46 | }() -> (owner: felt): 47 | let (owner) = OWNER.read() 48 | return (owner=owner) 49 | end 50 | 51 | @external 52 | func transfer_ownership{ 53 | syscall_ptr: felt*, 54 | pedersen_ptr: HashBuiltin*, 55 | range_check_ptr 56 | }(new_owner: felt) -> (new_owner: felt): 57 | OWNER.write(new_owner) 58 | return (new_owner=new_owner) 59 | end -------------------------------------------------------------------------------- /contracts/utils/Pausable.cairo: -------------------------------------------------------------------------------- 1 | 2 | %lang starknet 3 | %builtins pedersen range_check 4 | 5 | from starkware.cairo.common.cairo_builtins import HashBuiltin 6 | from starkware.starknet.common.syscalls import get_caller_address 7 | 8 | ## @title Pausable 9 | ## @description A mirror of the Openzeppelin Pausable pattern 10 | ## @description Adapted from OpenZeppelin's Cairo Contracts: https://github.com/OpenZeppelin/cairo-contracts 11 | ## @author Alucard 12 | 13 | ############################################# 14 | ## STORAGE ## 15 | ############################################# 16 | 17 | @storage_var 18 | func PAUSED() -> (paused: felt): 19 | end 20 | 21 | ############################################# 22 | ## CONSTRUCTOR ## 23 | ############################################# 24 | 25 | ## Initializes paused as false or `0` ## 26 | @constructor 27 | func constructor{ 28 | syscall_ptr: felt*, 29 | pedersen_ptr: HashBuiltin*, 30 | range_check_ptr 31 | }(): 32 | PAUSED.write(0) 33 | return () 34 | end 35 | 36 | ############################################# 37 | ## MODIFIERS ## 38 | ############################################# 39 | 40 | func onlyNotPaused{ 41 | syscall_ptr: felt*, 42 | pedersen_ptr: HashBuiltin*, 43 | range_check_ptr 44 | }(): 45 | let (is_paused) = PAUSED.read() 46 | assert is_paused = 0 47 | return () 48 | end 49 | 50 | func onlyPaused{ 51 | syscall_ptr: felt*, 52 | pedersen_ptr: HashBuiltin*, 53 | range_check_ptr 54 | }(): 55 | let (is_paused) = PAUSED.read() 56 | assert is_paused = 1 57 | return () 58 | end 59 | 60 | ############################################# 61 | ## PAUSABLE LOGIC ## 62 | ############################################# 63 | 64 | @view 65 | func paused{ 66 | syscall_ptr: felt*, 67 | pedersen_ptr: HashBuiltin*, 68 | range_check_ptr 69 | }() -> (paused: felt): 70 | let (paused) = PAUSED.read() 71 | return (paused) 72 | end 73 | 74 | @external 75 | func pause{ 76 | syscall_ptr: felt*, 77 | pedersen_ptr: HashBuiltin*, 78 | range_check_ptr 79 | }(): 80 | onlyNotPaused() # In place of Solidity's MODIFIERS 81 | PAUSED.write(1) 82 | return () 83 | end 84 | 85 | @external 86 | func unpause{ 87 | syscall_ptr: felt*, 88 | pedersen_ptr: HashBuiltin*, 89 | range_check_ptr 90 | }(): 91 | onlyPaused() # In place of Solidity's MODIFIERS 92 | PAUSED.write(0) 93 | return () 94 | end -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cairostarter", 3 | "version": "1.1.0", 4 | "description": "Forkable, Minimal Template for Starknet Projects.", 5 | "main": "index.js", 6 | "repository": "https://github.com/a5f9t4/cairostarter.git", 7 | "author": "velleity.eth ", 8 | "license": "AGPL-3.0-only", 9 | "private": false, 10 | "scripts": { 11 | "setup": "python3 -m venv env && . env/bin/activate && pip install -r requirements.txt", 12 | "compile": "nile compile", 13 | "test": "pytest", 14 | "export:virtualenv": "pip freeze > requirements.txt" 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | cairo-lang==0.6.2 2 | cairo-nile==0.3.0 -------------------------------------------------------------------------------- /tests/test_Greeter.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | import asyncio 3 | from starkware.starknet.testing.starknet import Starknet 4 | from utils import Signer, uint, str_to_felt, MAX_UINT256 5 | 6 | signer = Signer(123456789987654321) 7 | 8 | 9 | @pytest.fixture(scope='module') 10 | def event_loop(): 11 | return asyncio.new_event_loop() 12 | 13 | 14 | @pytest.fixture(scope='module') 15 | async def ownable_factory(): 16 | starknet = await Starknet.empty() 17 | owner = await starknet.deploy( 18 | "contracts/utils/Account.cairo", 19 | constructor_calldata=[signer.public_key] 20 | ) 21 | 22 | greeter = await starknet.deploy( 23 | "contracts/Greeter.cairo", 24 | constructor_calldata=[ 25 | str_to_felt("gm everybody, gm") 26 | ] 27 | ) 28 | return starknet, greeter, owner 29 | 30 | 31 | @pytest.mark.asyncio 32 | async def test_constructor(ownable_factory): 33 | _, greeter, _ = ownable_factory 34 | expected = await greeter.gm().call() 35 | assert expected.result.gm == str_to_felt("gm everybody, gm") 36 | 37 | @pytest.mark.asyncio 38 | async def test_set_greeting(ownable_factory): 39 | _, greeter, owner = ownable_factory 40 | new_greeting = str_to_felt("gtgm") 41 | await signer.send_transaction(owner, greeter.contract_address, 'setGreeting', [new_greeting]) 42 | expected = await greeter.gm().call() 43 | assert expected.result.gm == new_greeting 44 | -------------------------------------------------------------------------------- /tests/utils.py: -------------------------------------------------------------------------------- 1 | 2 | """Utilities for testing Cairo contracts.""" 3 | 4 | from starkware.cairo.common.hash_state import compute_hash_on_elements 5 | from starkware.crypto.signature.signature import private_to_stark_key, sign 6 | from starkware.starknet.definitions.error_codes import StarknetErrorCode 7 | from starkware.starkware_utils.error_handling import StarkException 8 | from starkware.starknet.public.abi import get_selector_from_name 9 | 10 | MAX_UINT256 = (2**128 - 1, 2**128 - 1) 11 | 12 | 13 | def str_to_felt(text): 14 | b_text = bytes(text, 'UTF-8') 15 | return int.from_bytes(b_text, "big") 16 | 17 | 18 | def uint(a): 19 | return(a, 0) 20 | 21 | 22 | async def assert_revert(fun): 23 | try: 24 | await fun 25 | assert False 26 | except StarkException as err: 27 | _, error = err.args 28 | assert error['code'] == StarknetErrorCode.TRANSACTION_FAILED 29 | 30 | 31 | class Signer(): 32 | """ 33 | Utility for sending signed transactions to an Account on Starknet. 34 | Parameters 35 | ---------- 36 | private_key : int 37 | Examples 38 | --------- 39 | Constructing a Singer object 40 | >>> signer = Signer(1234) 41 | Sending a transaction 42 | >>> await signer.send_transaction(account, 43 | account.contract_address, 44 | 'set_public_key', 45 | [other.public_key] 46 | ) 47 | """ 48 | 49 | def __init__(self, private_key): 50 | self.private_key = private_key 51 | self.public_key = private_to_stark_key(private_key) 52 | 53 | def sign(self, message_hash): 54 | return sign(msg_hash=message_hash, priv_key=self.private_key) 55 | 56 | async def send_transaction(self, account, to, selector_name, calldata, nonce=None): 57 | if nonce is None: 58 | execution_info = await account.get_nonce().call() 59 | nonce, = execution_info.result 60 | 61 | selector = get_selector_from_name(selector_name) 62 | message_hash = hash_message( 63 | account.contract_address, to, selector, calldata, nonce) 64 | sig_r, sig_s = self.sign(message_hash) 65 | 66 | return await account.execute(to, selector, calldata, nonce).invoke(signature=[sig_r, sig_s]) 67 | 68 | 69 | def hash_message(sender, to, selector, calldata, nonce): 70 | message = [ 71 | sender, 72 | to, 73 | selector, 74 | compute_hash_on_elements(calldata), 75 | nonce 76 | ] 77 | return compute_hash_on_elements(message) --------------------------------------------------------------------------------