├── .gitignore ├── LICENSE ├── README.md ├── index.ts ├── lib ├── constants.ts ├── index.ts ├── metrics.ts └── utils.ts ├── package.json ├── prettier.config.js ├── schema.graphql ├── tsconfig.json └── yarn.lock /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | build/ 3 | package/ 4 | .idea/ 5 | .vscode/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Subgraph Toolkit 2 | A Swiss Army knife for building subgraphs on [The Graph Protocol](https://thegraph.com) 3 | 4 | [![NPM Package](https://img.shields.io/npm/v/@protofire/subgraph-toolkit)](https://www.npmjs.com/package/@protofire/subgraph-toolkit) 5 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 6 | [![Code Style: prettier](https://img.shields.io/badge/Code_Style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) 7 | 8 | --- 9 | 10 | **Content** 11 | 12 | * [Features](#features-) 13 | * [Install](#install-) 14 | * [Usage](#usage-) 15 | * [Documentation](#documentation-) 16 | * [Examples](#example-) 17 | * [Contributing](#contributing-) 18 | 19 | 20 | ## Features ✨ 21 | 22 | This library complements and extends the official library `@graphprotocol/graph-ts` with the following functionality: 23 | - [x] Helper functions to convert between different types not available in the standard library 24 | - [x] Convert Bytes to Address 25 | - [x] Convert Bytes to signed and unsigned integer 26 | - [x] Convert BigDecimal to BigInt with a given precision 27 | - [x] Convert BigInt to Bytes 28 | - [x] Convert BigInt to BigDecimal with a given precision 29 | - [x] Useful constants ready to use in the subgraph mappings (including numeric constants, addresses, hashes and more) 30 | - [x] Calculate maximum and minimum of BigInt and BigDecimal values 31 | - [x] Hex Strings helpers 32 | - [x] Counters 33 | - [x] Accumulators 34 | - [ ] Helper functions to handle aggregated data [WIP] 35 | - [ ] Utilities to manipulate tokens (ERC20/ERC721/ERC1115) 36 | 37 | 38 | ## Install 🐙 39 | 40 | ```bash 41 | $ yarn add @protofire/subgraph-toolkit --exact 42 | ``` 43 | 44 | > 45 | >**NOTE** 46 | > 47 | >It's recommended installing a specific version of this library since the API in early versions is subject to change without previous notice. 48 | > 49 | 50 | 51 | ## Usage 💡 52 | 53 | 54 | ```typescript 55 | import { integer, decimal, DEFAULT_DECIMALS, ZERO_ADDRESS } from '@protofire/subgraph-toolkit' 56 | 57 | // ... 58 | 59 | export function handleTransfer(event: Transfer): void { 60 | // ... 61 | 62 | if (event.params._to.toHexString == ZERO_ADDRESS) { 63 | let amount = decimal.max( 64 | decimal.ZERO, 65 | decimal.fromBigInt(event.params._value, DEFAULT_DECIMALS) 66 | ) 67 | 68 | totalBurned += amount 69 | 70 | burnCount = integer.increment(burnCount) 71 | } 72 | 73 | // ... 74 | } 75 | 76 | // ... 77 | 78 | ``` 79 | 80 | ### Counters and accumulators 81 | 82 | To use metrics module you need to append the content of [schema.graphql](./schema.graphql) to the subgraph schema. 83 | 84 | 85 | ### Prettier configuration 86 | 87 | This package also provides an opinionated Prettier configuration file. To apply this configuration: 88 | 89 | ```javascript 90 | // prettier.config.js or .prettierrc.js 91 | 92 | module.exports = require('@protofire/subgraph-toolkit/prettier.config.js') 93 | ``` 94 | 95 | To override and/or extend the configuration: 96 | 97 | ```javascript 98 | // prettier.config.js or .prettierrc.js 99 | 100 | module.exports = { 101 | ...require('@protofire/subgraph-toolkit/prettier.config.js'), 102 | 103 | printWidth: 120, 104 | 105 | overrides: [ 106 | { 107 | files: '*.json', 108 | options: { 109 | printWidth: 80, 110 | }, 111 | }, 112 | ], 113 | } 114 | ``` 115 | 116 | 117 | ## Documentation 📄 118 | 119 | ### Constants 120 |
121 |
ADDRESS_ZERO
122 |
The address zero, which is 20 bytes (40 nibbles) of zero. Aliases: GENESIS_ADDRESS, ZERO_ADDRESS
123 | 124 |
HASH_ZERO
125 |
The hash zero, which is 32 bytes (64 nibbles) of zero. Alias: ZERO_HASH
126 | 127 |
MAX_UINT
128 |
The hex string representing the maximum `uint256` value. Alias: MAX_UINT_256
129 |
130 | 131 | #### Integers 132 |
133 |
integer. NEGATIVE_ONE
134 |
The BigInt representing -1
135 | 136 |
integer. ZERO
137 |
The BigInt representing 0
138 | 139 |
integer. ONE
140 |
The BigInt representing 1
141 | 142 |
integer. TWO
143 |
The BigInt representing 2
144 | 145 |
integer. ONE_THOUSAND
146 |
The BigInt representing 1000
147 | 148 |
integer. WEI_PER_ETHER
149 |
The BigInt representing 1018
150 |
151 | 152 | #### Decimals 153 |
154 |
decimal. NEGATIVE_ONE
155 |
The BigDecimal representing -1
156 | 157 |
decimal. ZERO
158 |
The BigDecimal representing 0
159 | 160 |
decimal. ONE
161 |
The BigDecimal representing 1
162 | 163 |
decimal. TWO
164 |
The BigDecimal representing 2
165 |
166 | 167 | #### Units 168 | 169 | ##### MakerDAO 170 |
171 |
units. WAD
172 |
The BigDecimal representing 1018
173 | 174 |
units. RAY
175 |
The BigDecimal representing 1027
176 | 177 |
units. RAD
178 |
The BigDecimal representing 1045
179 |
180 | 181 | ### Helper functions 182 | 183 | #### Addresses 184 |
185 |
address. isZeroAddress(address: Address) → Boolean
186 |
Checks if a given address is the zero address
187 |
188 | 189 | #### Byte Manipulation 190 |
191 |
bytes. toAddress(address: Bytes) → Address
192 |
Checks if a given address is the zero address (0x0)
193 | 194 |
bytes. toSignedInt(value: Bytes, bigEndian: Boolean = true) → BigInt
195 |
Converts Bytes to a signed BigInt using a given endianness
196 | 197 |
bytes. toUnsignedInt(value: Bytes, bigEndian: Boolean = true) → BigInt
198 |
Converts Bytes to a unsigned BigInt using a given endianness
199 | 200 |
bytes. hexZeroPad(value: Bytes, length: i32 → String
201 |
Returns a hex string padded with zeros (on the left) to length bytes (each byte is two nibbles)
202 |
203 | 204 | 205 | #### Integer 206 |
207 |
integer. fromBigInt(value: BigInt, decimals: i32 = 18) → BigDecimal
208 |
Converts a BigInt to a BigDecimal including a given number of decimals (by default, 18 decimals)
209 | 210 | ##### Factory methods 211 |
integer. fromNumber(value: i32) → BigInt
212 |
Converts a integer number to a BigInt
213 | 214 |
integer. fromString(value: String) → BigInt
215 |
Parses a string as a BigInt
216 |
217 | 218 | ##### Converters 219 |
220 |
integer. toBytes(value: BigInt) → Bytes
221 |
Converts a BigInt to a raw Bytes
222 |
223 | 224 | ##### Other helpers 225 |
226 |
integer. decrement(value: BigInt, amount: BigInt = 1) → BigInt
227 |
Decrements a BigInt by a given amount and returns the new value (by default, decrements by 1)
228 | 229 |
integer. increment(value: BigInt, amount: BigInt = 1) → BigInt
230 |
Increments a BigInt by a given amount and returns the new value (by default, increments by 1)
231 | 232 |
integer. min(a: BigInt, b: BigInt) → BigInt
233 |
Returns the smallest of the given numbers
234 | 235 |
integer. max(a: BigInt, b: BigInt) → BigInt
236 |
Returns the largest of the given numbers
237 |
238 | 239 | 240 | #### Decimal 241 |
242 |
decimal. fromBigInt(value: BigInt, decimals: i32 = 18) → BigDecimal
243 |
Converts a BigInt to a BigDecimal including a given number of decimals (by default, 18 decimals)
244 | 245 | ##### Factory methods 246 |
decimal. fromNumber(value: f64) → BigDecimal
247 |
Converts a float number to a BigDecimal
248 | 249 |
decimal. fromString(value: String) → BigDecimal
250 |
Parses a string as a BigDecimal
251 |
252 | 253 | ##### Converters 254 |
255 |
decimal. toBigInt(value: BigDecimal, decimals: u8 = 18) → BigInt
256 |
Converts a BigDecimal to a BigInt using a given number of decimals (by default, 18 decimals)
257 |
258 | 259 | ##### Other helpers 260 |
261 |
decimal. getPrecision(decimals: u8 = 18) → BigInt
262 |
Returns a BigInt representing a unit of a fixed point decimal with a given number of decimals (by default, 18 decimals)
263 | 264 |
decimal. min(a: BigDecimal, b: BigDecimal) → BigDecimal
265 |
Returns the smallest of the given numbers
266 | 267 |
decimal. max(a: BigDecimal, b: BigDecimal) → BigDecimal
268 |
Returns the largest of the given numbers
269 |
270 | 271 | 272 | #### Units 273 | 274 | ##### MakerDAO 275 |
276 |
units. fromRad(value: BigInt) → BigDecimal
277 |
Reads a BigInt as a fixed point decimal with 18 decimals (used for basic quantities, e.g. balances)
278 | 279 |
units. fromRay(value: BigInt) → BigDecimal
280 |
Reads a BigInt as a fixed point decimal with 27 decimals (for precise quantites, e.g. ratios)
281 | 282 |
units. fromWad(value: BigInt) → BigDecimal
283 |
Reads a BigInt as a fixed point decimal with 45 decimals (result of integer multiplication with a `wad` and a `ray)
284 | 285 |
units. toRad(value: BigDecimal) → BigInt
286 |
Converts a BigDecimal to a BigInt representing a fixed point decimal with 18 decimals (used for basic quantities, e.g. balances)
287 | 288 |
units. toRay(value: BigDecimal) → BigInt
289 |
Converts a BigDecimal to a BigInt representing a fixed point decimal with 27 decimals (for precise quantites, e.g. ratios)
290 | 291 |
units. toWad(value: BigDecimal) → BigInt
292 |
Converts a BigDecimal to a BigInt representing a fixed point decimal with 45 decimals (result of integer multiplication with a WAD and a RAY)
293 |
294 | 295 | 296 | ## Examples 🖍 297 | 298 | The following subgraphs are using this library: 299 | * [Maker Protocol](https://thegraph.com/explorer/subgraph/protofire/maker-protocol) 300 | * [Curve](https://thegraph.com/explorer/subgraph/protofire/curve) 301 | * [Nexus Mutual](https://thegraph.com/explorer/subgraph/protofire/nexus-mutual) 302 | * [SuperRare](https://thegraph.com/explorer/subgraph/protofire/superrare) 303 | 304 | 305 | ## Contributing 🍰 306 | 307 | Please make sure to read the [Contributing Guide]() before making a pull request. 308 | 309 | Thank you to all the people who already contributed to this project! 310 | 311 | 312 | ## License ⚖️ 313 | 314 | Copyright © 2020 Protofire.io and contributors 315 | 316 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3. 317 | 318 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 319 | 320 | You should have received a copy of the GNU General Public License along with this program. If not, see . 321 | -------------------------------------------------------------------------------- /index.ts: -------------------------------------------------------------------------------- 1 | export * from './lib' 2 | -------------------------------------------------------------------------------- /lib/constants.ts: -------------------------------------------------------------------------------- 1 | // 2 | // Constants 3 | // 4 | 5 | // Addresses 6 | export const ADDRESS_LENGTH = 20 7 | 8 | export const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000' 9 | export const GENESIS_ADDRESS = ADDRESS_ZERO 10 | export const ZERO_ADDRESS = ADDRESS_ZERO 11 | 12 | export const ETH_TOKEN_ADDRESS = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee' 13 | 14 | // Decimals 15 | export const DEFAULT_DECIMALS = 18 16 | 17 | // Hashes 18 | export const HASH_ZERO = '0x0000000000000000000000000000000000000000000000000000000000000000' 19 | export const ZERO_HASH = HASH_ZERO 20 | 21 | export const MAX_UINT_256 = '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff' 22 | export const MAX_UINT = MAX_UINT_256 23 | -------------------------------------------------------------------------------- /lib/index.ts: -------------------------------------------------------------------------------- 1 | export * from './constants' 2 | export * from './metrics' 3 | export * from './utils' 4 | -------------------------------------------------------------------------------- /lib/metrics.ts: -------------------------------------------------------------------------------- 1 | import { BigDecimal, BigInt, Entity, Value, ValueKind, store } from '@graphprotocol/graph-ts' 2 | 3 | import { decimal, integer } from './utils' 4 | 5 | export namespace metrics { 6 | class Accumulator extends Entity { 7 | constructor(id: string) { 8 | super() 9 | this.set('id', Value.fromString(id)) 10 | } 11 | 12 | save(): void { 13 | let id = this.get('id') 14 | assert(id !== null, 'Cannot save Accumulator entity without an ID') 15 | assert( 16 | id.kind == ValueKind.STRING, 17 | 'Cannot save Accumulator entity with non-string ID. ' + 18 | 'Considering using .toHex() to convert the "id" to a string.', 19 | ) 20 | store.set('Accumulator', id.toString(), this) 21 | } 22 | 23 | static load(id: string): Accumulator | null { 24 | return store.get('Accumulator', id) as Accumulator | null 25 | } 26 | 27 | get id(): string { 28 | let value = this.get('id') 29 | return value.toString() 30 | } 31 | 32 | set id(value: string) { 33 | this.set('id', Value.fromString(value)) 34 | } 35 | 36 | get total(): BigDecimal { 37 | let value = this.get('total') 38 | return value.toBigDecimal() 39 | } 40 | 41 | set total(value: BigDecimal) { 42 | this.set('total', Value.fromBigDecimal(value)) 43 | } 44 | 45 | add(value: BigDecimal): Accumulator { 46 | this.total = this.total.plus(value) 47 | return this 48 | } 49 | 50 | subtract(value: BigDecimal): Accumulator { 51 | this.total = this.total.minus(value) 52 | return this 53 | } 54 | } 55 | 56 | class Counter extends Entity { 57 | constructor(id: string) { 58 | super() 59 | this.set('id', Value.fromString(id)) 60 | this.set('count', Value.fromBigInt(integer.ZERO)) 61 | } 62 | 63 | save(): void { 64 | let id = this.get('id') 65 | assert(id !== null, 'Cannot save Counter entity without an ID') 66 | assert( 67 | id.kind == ValueKind.STRING, 68 | 'Cannot save Counter entity with non-string ID. ' + 69 | 'Considering using .toHex() to convert the "id" to a string.', 70 | ) 71 | store.set('Counter', id.toString(), this) 72 | } 73 | 74 | static load(id: string): Counter | null { 75 | return store.get('Counter', id) as Counter | null 76 | } 77 | 78 | get id(): string { 79 | let value = this.get('id') 80 | return value.toString() 81 | } 82 | 83 | set id(value: string) { 84 | this.set('id', Value.fromString(value)) 85 | } 86 | 87 | get count(): BigInt { 88 | let value = this.get('count') 89 | return value.toBigInt() 90 | } 91 | 92 | private set count(value: BigInt) { 93 | this.set('count', Value.fromBigInt(value)) 94 | } 95 | 96 | increase(value: BigInt = integer.ONE): Counter { 97 | this.count = this.count.plus(value) 98 | return this 99 | } 100 | 101 | decrease(value: BigInt = integer.ONE): Counter { 102 | this.count = this.count.minus(value) 103 | return this 104 | } 105 | } 106 | 107 | export function getAccumulator(id: string): Accumulator { 108 | let acc = Accumulator.load(id) 109 | 110 | if (acc == null) { 111 | acc = new Accumulator(id) 112 | acc.total = decimal.ZERO 113 | } 114 | 115 | return acc as Accumulator 116 | } 117 | 118 | export function getCounter(counterName: string): Counter { 119 | let counter = Counter.load(counterName) 120 | 121 | if (counter == null) { 122 | counter = new Counter(counterName) 123 | counter.count = integer.ZERO 124 | } 125 | 126 | return counter as Counter 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /lib/utils.ts: -------------------------------------------------------------------------------- 1 | import { Address, BigDecimal, BigInt, Bytes } from '@graphprotocol/graph-ts' 2 | 3 | import { ADDRESS_LENGTH, DEFAULT_DECIMALS, ZERO_ADDRESS } from './constants' 4 | 5 | export namespace address { 6 | // Helpers 7 | export function isZeroAddress(address: Address): boolean { 8 | return address.toHexString() == ZERO_ADDRESS 9 | } 10 | } 11 | 12 | export namespace bytes { 13 | // Converters 14 | export function toAddress(address: Bytes): Address { 15 | return Address.fromHexString(address.toHexString()).subarray(-ADDRESS_LENGTH) as Address 16 | } 17 | 18 | export function toSignedInt(value: Bytes, bigEndian: boolean = true): BigInt { 19 | return BigInt.fromSignedBytes(bigEndian ? (value.reverse() as Bytes) : value) 20 | } 21 | 22 | export function toUnsignedInt(value: Bytes, bigEndian: boolean = true): BigInt { 23 | return BigInt.fromUnsignedBytes(bigEndian ? Bytes.fromUint8Array(value.reverse()) : value) 24 | } 25 | 26 | // Helpers 27 | export function hexZeroPad(value: Bytes, length: i32 = 32): string { 28 | let hexstring = value.toHexString() 29 | 30 | return hexstring.substr(0, 2) + hexstring.substr(2).padStart(length * 2, '0') 31 | } 32 | } 33 | 34 | export namespace decimal { 35 | // Constants 36 | export let NEGATIVE_ONE = BigDecimal.fromString('-1') 37 | export let ZERO = BigDecimal.fromString('0') 38 | export let ONE = BigDecimal.fromString('1') 39 | export let TWO = BigDecimal.fromString('2') 40 | export let ONE_HUNDRED = BigDecimal.fromString('100') 41 | 42 | // Factory methods 43 | export function fromBigInt(value: BigInt, decimals: i32 = DEFAULT_DECIMALS): BigDecimal { 44 | let precision = BigInt.fromI32(10) 45 | .pow(decimals) 46 | .toBigDecimal() 47 | 48 | return value.divDecimal(precision) 49 | } 50 | 51 | export function fromNumber(value: f64): BigDecimal { 52 | return fromString(value.toString()) 53 | } 54 | 55 | export function fromString(value: string): BigDecimal { 56 | return BigDecimal.fromString(value) 57 | } 58 | 59 | // Converters 60 | export function toBigInt(value: BigDecimal, decimals: u8 = DEFAULT_DECIMALS): BigInt { 61 | return value.times(getPrecision(decimals).toBigDecimal()).truncate(0).digits 62 | } 63 | 64 | // Helpers 65 | export function getPrecision(decimals: u8 = DEFAULT_DECIMALS): BigInt { 66 | return BigInt.fromI32(10).pow(decimals) 67 | } 68 | 69 | export function min(a: BigDecimal, b: BigDecimal): BigDecimal { 70 | return BigDecimal.compare(a, b) < 1 ? a : b 71 | } 72 | 73 | export function max(a: BigDecimal, b: BigDecimal): BigDecimal { 74 | return BigDecimal.compare(a, b) > 1 ? a : b 75 | } 76 | } 77 | 78 | export namespace integer { 79 | // Constants 80 | export let NEGATIVE_ONE = BigInt.fromI32(-1) 81 | export let ZERO = BigInt.fromI32(0) 82 | export let ONE = BigInt.fromI32(1) 83 | export let TWO = BigInt.fromI32(2) 84 | export let ONE_THOUSAND = BigInt.fromI32(1000) 85 | 86 | export let WEI_PER_ETHER = BigInt.fromI32(1000000000000000000) 87 | 88 | // Factory methods 89 | export function fromNumber(value: i32): BigInt { 90 | return BigInt.fromI32(value) 91 | } 92 | 93 | export function fromString(value: string): BigInt { 94 | return fromNumber(parseI32(value)) 95 | } 96 | 97 | // Converters 98 | export function toBytes(value: BigInt): Bytes { 99 | return (value as Uint8Array) as Bytes 100 | } 101 | 102 | // Helpers 103 | export function decrement(value: BigInt, amount: BigInt = ONE): BigInt { 104 | return value.minus(amount) 105 | } 106 | 107 | export function increment(value: BigInt, amount: BigInt = ONE): BigInt { 108 | return value.plus(amount) 109 | } 110 | 111 | export function min(a: BigInt, b: BigInt): BigInt { 112 | return BigInt.compare(a, b) < 1 ? a : b 113 | } 114 | 115 | export function max(a: BigInt, b: BigInt): BigInt { 116 | return BigInt.compare(a, b) > 1 ? a : b 117 | } 118 | } 119 | 120 | export namespace units { 121 | export let WAD = BigDecimal.fromString('1000000000000000000') 122 | export let RAY = BigDecimal.fromString('1000000000000000000000000000') 123 | export let RAD = BigDecimal.fromString('1000000000000000000000000000000000000000000000') 124 | 125 | // Factory methods 126 | export function fromRad(value: BigInt): BigDecimal { 127 | return value.divDecimal(RAD) 128 | } 129 | 130 | export function fromRay(value: BigInt): BigDecimal { 131 | return value.divDecimal(RAY) 132 | } 133 | 134 | export function fromWad(value: BigInt): BigDecimal { 135 | return value.divDecimal(WAD) 136 | } 137 | 138 | // Converters 139 | export function toRad(value: BigDecimal): BigInt { 140 | return value.times(RAD).truncate(0).digits 141 | } 142 | 143 | export function toRay(value: BigDecimal): BigInt { 144 | return value.times(RAY).truncate(0).digits 145 | } 146 | 147 | export function toWad(value: BigDecimal): BigInt { 148 | return value.times(WAD).truncate(0).digits 149 | } 150 | } 151 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@protofire/subgraph-toolkit", 3 | "version": "0.1.3", 4 | "description": "AssemblyScript helpers for writing subgraph mappings for The Graph", 5 | "repository": "https://github.com/protofire/subgraph-toolkit.git", 6 | "license": "GPL-3.0-only", 7 | "author": "Sebastián Galiano", 8 | "module": "index.ts", 9 | "types": "index.ts", 10 | "dependencies": { 11 | "@protofire/subgraph-prettier-config": "^0.1.1" 12 | }, 13 | "devDependencies": { 14 | "@graphprotocol/graph-ts": ">=0.20.0", 15 | "prettier": "2.1.2" 16 | }, 17 | "peerDependencies": { 18 | "@graphprotocol/graph-ts": ">=0.20.0" 19 | } 20 | } -------------------------------------------------------------------------------- /prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = require('@protofire/subgraph-prettier-config') 2 | -------------------------------------------------------------------------------- /schema.graphql: -------------------------------------------------------------------------------- 1 | # Metrics Module 2 | interface Metric @entity { 3 | id: ID! 4 | } 5 | 6 | type Accumulator implements Metric @entity { 7 | id: ID! 8 | total: BigDecimal! 9 | } 10 | 11 | type Counter implements Metric @entity { 12 | id: ID! 13 | count: BigInt! 14 | } 15 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./node_modules/assemblyscript/std/assembly.json", 3 | "include": ["index.ts"], 4 | "exclude": ["node_modules"] 5 | } 6 | -------------------------------------------------------------------------------- /yarn.lock: -------------------------------------------------------------------------------- 1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. 2 | # yarn lockfile v1 3 | 4 | 5 | "@graphprotocol/graph-ts@>=0.20.0": 6 | version "0.20.0" 7 | resolved "https://registry.yarnpkg.com/@graphprotocol/graph-ts/-/graph-ts-0.20.0.tgz#ed31ffd59a6aa9703a1ec5079f137a81220443cb" 8 | integrity sha512-+R0Tu/MD4Fiq0Fo+v1l+xznz+ZrciQKWlzMtXjDrhM70vlMNVL9wDmf90MVFYpslgqIfw024hT6XwlmyNyOWbQ== 9 | dependencies: 10 | assemblyscript "https://github.com/AssemblyScript/assemblyscript#36040d5b5312f19a025782b5e36663823494c2f3" 11 | 12 | "@protobufjs/utf8@^1.1.0": 13 | version "1.1.0" 14 | resolved "https://registry.yarnpkg.com/@protobufjs/utf8/-/utf8-1.1.0.tgz#a777360b5b39a1a2e5106f8e858f2fd2d060c570" 15 | integrity sha1-p3c2C1s5oaLlEG+OhY8v0tBgxXA= 16 | 17 | "@protofire/subgraph-prettier-config@^0.1.1": 18 | version "0.1.1" 19 | resolved "https://registry.yarnpkg.com/@protofire/subgraph-prettier-config/-/subgraph-prettier-config-0.1.1.tgz#da616048f8d77f27446ac0298d8fdd9bbc4eb16a" 20 | integrity sha512-XJNXRYotEcywkCMsUMsbpzbC5xZUwQGwdk2NS+NNMhwNhm24i3SSO2dqJgnWYscmBGwpVZJTGVYK6f8g/Gn16g== 21 | 22 | "assemblyscript@git+https://github.com/AssemblyScript/assemblyscript.git#36040d5b5312f19a025782b5e36663823494c2f3": 23 | version "0.6.0" 24 | resolved "git+https://github.com/AssemblyScript/assemblyscript.git#36040d5b5312f19a025782b5e36663823494c2f3" 25 | dependencies: 26 | "@protobufjs/utf8" "^1.1.0" 27 | binaryen "77.0.0-nightly.20190407" 28 | glob "^7.1.3" 29 | long "^4.0.0" 30 | opencollective-postinstall "^2.0.0" 31 | source-map-support "^0.5.11" 32 | 33 | balanced-match@^1.0.0: 34 | version "1.0.2" 35 | resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" 36 | integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== 37 | 38 | binaryen@77.0.0-nightly.20190407: 39 | version "77.0.0-nightly.20190407" 40 | resolved "https://registry.yarnpkg.com/binaryen/-/binaryen-77.0.0-nightly.20190407.tgz#fbe4f8ba0d6bd0809a84eb519d2d5b5ddff3a7d1" 41 | integrity sha512-1mxYNvQ0xywMe582K7V6Vo2zzhZZxMTeGHH8aE/+/AND8f64D8Q1GThVY3RVRwGY/4p+p95ccw9Xbw2ovFXRIg== 42 | 43 | brace-expansion@^1.1.7: 44 | version "1.1.11" 45 | resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" 46 | integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== 47 | dependencies: 48 | balanced-match "^1.0.0" 49 | concat-map "0.0.1" 50 | 51 | buffer-from@^1.0.0: 52 | version "1.1.1" 53 | resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.1.tgz#32713bc028f75c02fdb710d7c7bcec1f2c6070ef" 54 | integrity sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A== 55 | 56 | concat-map@0.0.1: 57 | version "0.0.1" 58 | resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" 59 | integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= 60 | 61 | fs.realpath@^1.0.0: 62 | version "1.0.0" 63 | resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" 64 | integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8= 65 | 66 | glob@^7.1.3: 67 | version "7.1.7" 68 | resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.7.tgz#3b193e9233f01d42d0b3f78294bbeeb418f94a90" 69 | integrity sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ== 70 | dependencies: 71 | fs.realpath "^1.0.0" 72 | inflight "^1.0.4" 73 | inherits "2" 74 | minimatch "^3.0.4" 75 | once "^1.3.0" 76 | path-is-absolute "^1.0.0" 77 | 78 | inflight@^1.0.4: 79 | version "1.0.6" 80 | resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" 81 | integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk= 82 | dependencies: 83 | once "^1.3.0" 84 | wrappy "1" 85 | 86 | inherits@2: 87 | version "2.0.4" 88 | resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" 89 | integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== 90 | 91 | long@^4.0.0: 92 | version "4.0.0" 93 | resolved "https://registry.yarnpkg.com/long/-/long-4.0.0.tgz#9a7b71cfb7d361a194ea555241c92f7468d5bf28" 94 | integrity sha512-XsP+KhQif4bjX1kbuSiySJFNAehNxgLb6hPRGJ9QsUr8ajHkuXGdrHmFUTUUXhDwVX2R5bY4JNZEwbUiMhV+MA== 95 | 96 | minimatch@^3.0.4: 97 | version "3.0.4" 98 | resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" 99 | integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA== 100 | dependencies: 101 | brace-expansion "^1.1.7" 102 | 103 | once@^1.3.0: 104 | version "1.4.0" 105 | resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" 106 | integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= 107 | dependencies: 108 | wrappy "1" 109 | 110 | opencollective-postinstall@^2.0.0: 111 | version "2.0.3" 112 | resolved "https://registry.yarnpkg.com/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz#7a0fff978f6dbfa4d006238fbac98ed4198c3259" 113 | integrity sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q== 114 | 115 | path-is-absolute@^1.0.0: 116 | version "1.0.1" 117 | resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" 118 | integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= 119 | 120 | prettier@2.1.2: 121 | version "2.1.2" 122 | resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.1.2.tgz#3050700dae2e4c8b67c4c3f666cdb8af405e1ce5" 123 | integrity sha512-16c7K+x4qVlJg9rEbXl7HEGmQyZlG4R9AgP+oHKRMsMsuk8s+ATStlf1NpDqyBI1HpVyfjLOeMhH2LvuNvV5Vg== 124 | 125 | source-map-support@^0.5.11: 126 | version "0.5.19" 127 | resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.19.tgz#a98b62f86dcaf4f67399648c085291ab9e8fed61" 128 | integrity sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw== 129 | dependencies: 130 | buffer-from "^1.0.0" 131 | source-map "^0.6.0" 132 | 133 | source-map@^0.6.0: 134 | version "0.6.1" 135 | resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" 136 | integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== 137 | 138 | wrappy@1: 139 | version "1.0.2" 140 | resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" 141 | integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= 142 | --------------------------------------------------------------------------------