diff --git a/sidecar/.eslintrc b/sidecar/.eslintrc new file mode 100644 index 00000000..60f52edf --- /dev/null +++ b/sidecar/.eslintrc @@ -0,0 +1,15 @@ +{ + "parser": "@typescript-eslint/parser", + "extends": [ + "plugin:@typescript-eslint/recommended" + ], + "parserOptions": { + "ecmaVersion": 2020, + "sourceType": "module" + }, + "rules": { + "@typescript-eslint/no-empty-interface": "off", + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/no-unused-vars": "off" + } +} \ No newline at end of file diff --git a/sidecar/.gitignore b/sidecar/.gitignore new file mode 100644 index 00000000..dc5f233f --- /dev/null +++ b/sidecar/.gitignore @@ -0,0 +1,138 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional stylelint cache +.stylelintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variable files +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# vuepress v2.x temp and cache directory +.temp +.cache + +# Docusaurus cache and generated files +.docusaurus + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# lmdb +db + +# build +dist + +package-lock.json diff --git a/sidecar/LICENSE b/sidecar/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/sidecar/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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, either version 3 of the License, or + (at your option) any later version. + + 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. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/sidecar/README.md b/sidecar/README.md new file mode 100644 index 00000000..40e6c53e --- /dev/null +++ b/sidecar/README.md @@ -0,0 +1,2 @@ +# cosmos-api-sidecar +Cosmos API Sidecar for Horizon diff --git a/sidecar/config/default.json b/sidecar/config/default.json new file mode 100644 index 00000000..de8e4ba6 --- /dev/null +++ b/sidecar/config/default.json @@ -0,0 +1,19 @@ +{ + "db": { + "path": "db" + }, + "server": { + "endpoint": "http://127.0.0.1:1317", + "port": 1317, + "logger": false + }, + "chain": { + "endpoint": "ws://127.0.0.1:9944", + "network": "dev", + "moniker": "dot", + "name": "noir", + "version": "1", + "denom": "adot", + "node": "noir" + } +} diff --git a/sidecar/package.json b/sidecar/package.json new file mode 100644 index 00000000..6ef2c903 --- /dev/null +++ b/sidecar/package.json @@ -0,0 +1,58 @@ +{ + "name": "@horizon/sidecar", + "version": "0.0.1", + "description": "Cosmos API Sidecar for Horizon", + "main": "dist/main.js", + "scripts": { + "build": "tsc", + "lint": "eslint ./src --ext .ts", + "test": "jest", + "start": "node --es-module-specifier-resolution=node ./dist/main.js", + "fmt": "eslint ./src --ext .ts --fix", + "prepare": "patch-package --patch-dir node_modules/@pinot/api/patches" + }, + "type": "module", + "keywords": [], + "author": "code0xff ", + "license": "MIT", + "jest": { + "transform": { + "^.+\\.ts$": "ts-jest" + }, + "testRegex": "\\.spec\\.ts$", + "moduleFileExtensions": [ + "ts", + "tsx", + "js", + "json" + ] + }, + "devDependencies": { + "@types/config": "^3.3.0", + "@types/jest": "^29.2.5", + "@types/node": "^18.11.11", + "@types/ws": "^8.5.5", + "@typescript-eslint/eslint-plugin": "^5.62.0", + "@typescript-eslint/parser": "^5.62.0", + "eslint": "^8.29.0", + "jest": "^29.3.1", + "patch-package": "^8.0.0", + "ts-jest": "^29.0.4", + "ts-loader": "^9.4.2", + "ts-node": "^10.9.1", + "typescript": "^4.9.4" + }, + "dependencies": { + "@cosmjs/encoding": "^0.30.1", + "@fastify/static": "^6.10.2", + "@fastify/websocket": "^8.1.0", + "@pinot/api": "^0.3.0", + "config": "^3.3.9", + "cosmjs-types": "^0.8.0", + "ethereum-cryptography": "^2.0.0", + "fastify": "4.17.0", + "json-rpc-2.0": "^1.6.0", + "lmdb": "^2.8.3", + "protobufjs": "^7.2.4" + } +} \ No newline at end of file diff --git a/sidecar/public/config.js b/sidecar/public/config.js new file mode 100644 index 00000000..3dfd5981 --- /dev/null +++ b/sidecar/public/config.js @@ -0,0 +1,16 @@ +const config = { + chainId: "dev", + chainName: "Noir", + addressPrefix: "dot", + baseDenom: "adot", // atto dot + displayDenom: "DOT", + restURL: "http://127.0.0.1:1317", + coinType: "354", + decimals: 18, + gasRate: { + average: "1", + low: "0.8", + tiny: "0.6", + }, + sendGas: "1000000000" +}; diff --git a/sidecar/public/cosmostation_logo.png b/sidecar/public/cosmostation_logo.png new file mode 100644 index 00000000..5d66b9db Binary files /dev/null and b/sidecar/public/cosmostation_logo.png differ diff --git a/sidecar/public/index.html b/sidecar/public/index.html new file mode 100644 index 00000000..1eb3022c --- /dev/null +++ b/sidecar/public/index.html @@ -0,0 +1,128 @@ + + + + + + + + Cosmos API Sidecar + + + + +
+

Welcome to Horizon!

+

The translator from Cosmos to Substrate.

+
+
+ +
+
+ +
+ + + + + \ No newline at end of file diff --git a/sidecar/public/keplr_logo.png b/sidecar/public/keplr_logo.png new file mode 100644 index 00000000..34a73c9d Binary files /dev/null and b/sidecar/public/keplr_logo.png differ diff --git a/sidecar/src/app.ts b/sidecar/src/app.ts new file mode 100644 index 00000000..9917effb --- /dev/null +++ b/sidecar/src/app.ts @@ -0,0 +1,347 @@ +import fastify, { + FastifyInstance, + FastifyReply, + FastifyRequest, +} from "fastify"; +import { ApiPromise, WsProvider } from "@pinot/api"; +import { + AbciService, + ApiServices, + BalanceService, + DistributionService, + NodeInfoService, + StakingService, + StatusService, + TxService, + IAccountService, + NoirAccountService, + HorizonAccountService, +} from "./services/index.js"; +import { + AccountResponse, + BroadcastTxSyncResponse, + ResultTxSearch, +} from "./types/index.js"; +import path from "path"; +import fastifyStatic from "@fastify/static"; +import FastifyWebsocket, { SocketStream } from "@fastify/websocket"; +import { JSONRPCServer } from "json-rpc-2.0"; +import { IConfig } from "config"; +import { Database, open } from "lmdb"; +import quertstring from "node:querystring"; +import rpc from "./constants/rpc.js"; +import { QueryAccountRequest } from "cosmjs-types/cosmos/auth/v1beta1/query.js"; +import { + ABCIQueryResponse, + GetNodeInfoResponse, +} from "cosmjs-types/cosmos/base/tendermint/v1beta1/query.js"; +import { + QueryAllBalancesRequest, + QueryAllBalancesResponse, +} from "cosmjs-types/cosmos/bank/v1beta1/query.js"; +import { toSnakeCase } from "./utils/index.js"; +import { + QueryDelegationTotalRewardsRequest, + QueryDelegationTotalRewardsResponse, +} from "cosmjs-types/cosmos/distribution/v1beta1/query.js"; +import { + QueryDelegatorDelegationsRequest, + QueryDelegatorDelegationsResponse, + QueryDelegatorUnbondingDelegationsRequest, + QueryDelegatorUnbondingDelegationsResponse, +} from "cosmjs-types/cosmos/staking/v1beta1/query.js"; +import { + BroadcastTxResponse, + SimulateResponse, +} from "cosmjs-types/cosmos/tx/v1beta1/service.js"; + +export class App { + config: IConfig; + db: Database; + server: FastifyInstance; + services: ApiServices; + jsonrpc: JSONRPCServer; + chainApi: ApiPromise; + + constructor(config: IConfig) { + this.config = config; + this.services = new ApiServices(); + } + + async initialize() { + await this.initDatabase(); + await this.initApiServices(); + await this.initApiServer(); + await this.initJsonRpcServer(); + await this.initSubscribeEvents(); + } + + async start() { + const port = this.config.get("server.port"); + await this.server.listen({ port }); + } + + async initDatabase() { + const path = this.config.get("db.path"); + this.db = open({ + path, + compression: true, + }); + } + + async initApiServices() { + const endpoint = this.config.get("chain.endpoint"); + const provider = new WsProvider(endpoint); + this.chainApi = await ApiPromise.create({ + provider, + rpc, + }); + let accountService: IAccountService; + if (this.config.get("chain.node") === "horizon") { + accountService = new HorizonAccountService(this.chainApi); + } else if (this.config.get("chain.node") === "noir") { + accountService = new NoirAccountService(this.chainApi); + } else { + throw new Error("unsupported node type"); + } + const abciService = new AbciService(this.chainApi, accountService); + const balanceService = new BalanceService( + this.config, + this.chainApi, + accountService + ); + const distributionService = new DistributionService(); + const nodeInfoService = new NodeInfoService(this.config); + const stakingService = new StakingService(); + const statusService = new StatusService(this.config, this.chainApi); + const txService = new TxService(this.db, this.chainApi); + + this.services.set("abci", abciService); + this.services.set("account", accountService); + this.services.set("balance", balanceService); + this.services.set("distribution", distributionService); + this.services.set("nodeInfo", nodeInfoService); + this.services.set("staking", stakingService); + this.services.set("status", statusService); + this.services.set("tx", txService); + } + + async initApiServer() { + const logger = this.config.get("server.logger"); + this.server = fastify({ logger }); + const __dirname = path.resolve(); + this.server.register(fastifyStatic, { + root: path.join(__dirname, "public"), + }); + await this.server.register(FastifyWebsocket); + + this.server.get("/", (request: FastifyRequest, reply: FastifyReply) => { + reply.sendFile("index.html"); + }); + + this.server.get( + "/cosmos/bank/v1beta1/balances/:address", + async ( + request: FastifyRequest<{ + Params: QueryAllBalancesRequest; + }> + ): Promise => { + const { address } = request.params; + const response = QueryAllBalancesResponse.toJSON( + await this.services.get("balance").balances(address) + ); + return toSnakeCase(response); + } + ); + + this.server.get( + "/cosmos/auth/v1beta1/accounts/:address", + async ( + request: FastifyRequest<{ + Params: QueryAccountRequest; + }> + ): Promise => { + const { address } = request.params; + return await this.services + .get("account") + .accounts(address); + } + ); + + this.server.get( + "/cosmos/base/tendermint/v1beta1/node_info", + (): GetNodeInfoResponse => { + const response = GetNodeInfoResponse.toJSON( + this.services.get("nodeInfo").nodeInfo() + ); + return toSnakeCase(response); + } + ); + + this.server.post( + "/cosmos/tx/v1beta1/txs", + async ( + request: FastifyRequest<{ + Body: { + tx_bytes: string; + mode: number; + }; + }> + ): Promise => { + const { tx_bytes } = request.body; + const response = BroadcastTxResponse.toJSON( + await this.services.get("tx").broadcastTx(tx_bytes) + ); + return toSnakeCase(response); + } + ); + + this.server.get( + "/cosmos/staking/v1beta1/delegations/:delegatorAddr", + ( + request: FastifyRequest<{ + Params: QueryDelegatorDelegationsRequest; + }> + ): unknown => { + const { delegatorAddr } = request.params; + const response = QueryDelegatorDelegationsResponse.toJSON( + this.services + .get("staking") + .deligations(delegatorAddr) + ); + return toSnakeCase(response); + } + ); + + this.server.get( + "/cosmos/distribution/v1beta1/delegators/:delegatorAddress/rewards", + ( + request: FastifyRequest<{ + Params: QueryDelegationTotalRewardsRequest; + }> + ): unknown => { + const { delegatorAddress } = request.params; + const response = QueryDelegationTotalRewardsResponse.toJSON( + this.services + .get("distribution") + .rewards(delegatorAddress) + ); + return toSnakeCase(response); + } + ); + + this.server.get( + "/cosmos/staking/v1beta1/delegators/:delegatorAddr/unbonding_delegations", + ( + request: FastifyRequest<{ + Params: QueryDelegatorUnbondingDelegationsRequest; + }> + ): unknown => { + const { delegatorAddr } = request.params; + const response = QueryDelegatorUnbondingDelegationsResponse.toJSON( + this.services + .get("staking") + .unbondingDeligations(delegatorAddr) + ); + return toSnakeCase(response); + } + ); + + this.server.post( + "/cosmos/tx/v1beta1/simulate", + ( + request: FastifyRequest<{ + Body: { tx_bytes: string }; + }> + ): unknown => { + const { tx_bytes } = request.body; + const response = SimulateResponse.toJSON( + this.services.get("tx").simulateTx(tx_bytes) + ); + return toSnakeCase(response); + } + ); + } + + async initJsonRpcServer() { + this.jsonrpc = new JSONRPCServer(); + + this.jsonrpc.addMethod("status", async (): Promise => { + return toSnakeCase( + await this.services.get("status").status() + ); + }); + + this.jsonrpc.addMethod( + "abci_query", + async ({ path, data }): Promise => { + const result = await this.services + .get("abci") + .query(path, data); + const response = ABCIQueryResponse.toJSON(result); + return { + response, + }; + } + ); + + this.jsonrpc.addMethod( + "broadcast_tx_sync", + async ({ tx }): Promise => { + const result = await this.services.get("tx").broadcastTx(tx); + const { code, txhash, data, rawLog, codespace } = result.txResponse; + return { + code, + data, + log: rawLog, + codespace, + hash: txhash, + }; + } + ); + + this.jsonrpc.addMethod("tx_search", ({ query }): ResultTxSearch => { + const args = quertstring.parse(query); + let hash = args["tx.hash"] as string; + if (hash.includes("'")) { + hash = hash.replace(/'/gi, ""); + } + return this.services.get("tx").searchTx(hash); + }); + + this.server.get( + "/websocket", + { websocket: true }, + (connection: SocketStream) => { + connection.socket.on("message", async (message) => { + const request = JSON.parse(message.toString()); + const response = await this.jsonrpc.receive(request); + if (response) { + connection.socket.send( + Buffer.from(JSON.stringify(response), "utf8") + ); + } + }); + } + ); + } + + async initSubscribeEvents() { + await this.chainApi.rpc.chain.subscribeNewHeads( + async (header) => { + const signedBlock = await this.chainApi.rpc.chain.getBlock(header.hash); + + signedBlock.block.extrinsics.forEach( + async ({ method: { args, method, section } }, index) => { + if (section === "cosmos" && method === "transact") { + const tx = JSON.parse(args.toString()); + await this.services + .get("tx") + .saveTransactResult(tx, index, header); + } + } + ); + } + ); + } +} diff --git a/sidecar/src/constants/dummy.ts b/sidecar/src/constants/dummy.ts new file mode 100644 index 00000000..18c37bff --- /dev/null +++ b/sidecar/src/constants/dummy.ts @@ -0,0 +1,8 @@ +const Dummy = { + Secp256k1PublicKey: Buffer.concat([ + Buffer.from([0x02]), + Buffer.allocUnsafe(32), + ]).toString("base64"), +}; + +export default Dummy; diff --git a/sidecar/src/constants/rpc.ts b/sidecar/src/constants/rpc.ts new file mode 100644 index 00000000..e48b6fcf --- /dev/null +++ b/sidecar/src/constants/rpc.ts @@ -0,0 +1,16 @@ +const rpc = { + cosm: { + broadcastTx: { + description: "Broadcast cosmos tx.", + params: [ + { + name: "tx_bytes", + type: "Bytes", + }, + ], + type: "H256", + }, + }, +}; + +export default rpc; diff --git a/sidecar/src/constants/weights.ts b/sidecar/src/constants/weights.ts new file mode 100644 index 00000000..b8829c24 --- /dev/null +++ b/sidecar/src/constants/weights.ts @@ -0,0 +1,5 @@ +const Weights = { + MsgSend: 1000000000, +}; + +export default Weights; diff --git a/sidecar/src/main.ts b/sidecar/src/main.ts new file mode 100644 index 00000000..1b796982 --- /dev/null +++ b/sidecar/src/main.ts @@ -0,0 +1,10 @@ +import { App } from "./app.js"; +import config from "config"; + +async function main() { + const app = new App(config); + await app.initialize(); + await app.start(); +} + +main().catch((e: unknown) => console.error(e)); diff --git a/sidecar/src/services/abci.ts b/sidecar/src/services/abci.ts new file mode 100644 index 00000000..df355f65 --- /dev/null +++ b/sidecar/src/services/abci.ts @@ -0,0 +1,64 @@ +import { + QueryAccountRequest, + QueryAccountResponse, +} from "cosmjs-types/cosmos/auth/v1beta1/query.js"; +import { ApiService } from "./service.js"; +import { IAccountService } from "./account.js"; +import { PubKey } from "cosmjs-types/cosmos/crypto/secp256k1/keys.js"; +import { BaseAccount } from "cosmjs-types/cosmos/auth/v1beta1/auth.js"; +import Long from "long"; +import { ApiPromise } from "@pinot/api"; +import { ABCIQueryResponse } from "cosmjs-types/cosmos/base/tendermint/v1beta1/query.js"; + +export class AbciService implements ApiService { + chainApi: ApiPromise; + accountService: IAccountService; + + constructor(chainApi: ApiPromise, accountService: IAccountService) { + this.chainApi = chainApi; + this.accountService = accountService; + } + + async query(path: string, data: string): Promise { + if (path === "/cosmos.auth.v1beta1.Query/Account") { + const address = QueryAccountRequest.decode( + Buffer.from(data, "hex") + ).address; + const { account } = await this.accountService.accounts(address); + const pubkey: PubKey = { + key: Buffer.from(account.pub_key.key, "base64"), + }; + const baseAccount: BaseAccount = { + address: account.address, + pubKey: { + typeUrl: "/cosmos.crypto.secp256k1.PubKey", + value: PubKey.encode(pubkey).finish(), + }, + accountNumber: Long.fromNumber(parseInt(account.account_number)), + sequence: Long.fromNumber(parseInt(account.sequence)), + }; + + const queryAccountResponse: QueryAccountResponse = { + account: { + typeUrl: "/cosmos.auth.v1beta1.BaseAccount", + value: BaseAccount.encode(baseAccount).finish(), + }, + }; + const value = QueryAccountResponse.encode(queryAccountResponse).finish(); + const height = (await this.chainApi.query.system.number()).toString(); + return { + code: 0, + log: "", + info: "", + index: Long.ZERO, + key: undefined, + value, + proofOps: undefined, + height: Long.fromString(height), + codespace: "", + }; + } else { + throw new Error("unexpected path"); + } + } +} diff --git a/sidecar/src/services/account.ts b/sidecar/src/services/account.ts new file mode 100644 index 00000000..47f07b99 --- /dev/null +++ b/sidecar/src/services/account.ts @@ -0,0 +1,122 @@ +import { ApiPromise } from "@pinot/api"; +import { AccountResponse } from "../types/index.js"; +import { fromBech32 } from "@cosmjs/encoding"; +import { Codec } from "@polkadot/types/types/index.js"; +import { blake2b } from "ethereum-cryptography/blake2b.js"; +import { ApiService } from "./service.js"; +import Dummy from "../constants/dummy.js"; + +export interface IAccountService extends ApiService { + accounts(address: string): Promise; + origin(address: string): Promise; + interim(address: string): string; +} + +export class HorizonAccountService implements IAccountService { + chainApi: ApiPromise; + + constructor(chainApi: ApiPromise) { + this.chainApi = chainApi; + } + + public async accounts(address: string): Promise { + let sequence = "0"; + let key: string | null = null; + + const originRaw = await this.origin(address); + let origin = originRaw.toString(); + if (origin) { + key = Buffer.from( + origin.startsWith("0x") ? origin.substring(2) : origin, + "hex" + ).toString("base64"); + } else { + origin = this.interim(address); + key = Dummy.Secp256k1PublicKey; + } + const account = await this.chainApi.query["system"]["account"]( + origin.startsWith("0x") ? origin : `0x${origin}` + ); + if (account) { + const { nonce } = account.toJSON() as any; + sequence = nonce.toString(); + } + return new AccountResponse({ + "@type": "/cosmos.auth.v1beta1.BaseAccount", + address: address, + pub_key: { + "@type": "/cosmos.crypto.secp256k1.PubKey", + key, + }, + account_number: "0", + sequence, + }); + } + + public async origin(address: string): Promise { + const { data } = fromBech32(address); + return this.chainApi.query["cosmosAccounts"]["connections"](data); + } + + public interim(address: string): string { + const { data } = fromBech32(address); + const addressRaw = Buffer.concat([ + Buffer.from([0x00]), + Buffer.from( + blake2b(Buffer.concat([Buffer.from("cosm:", "utf8"), data]), 32) + ), + ]); + return `0x${addressRaw.toString("hex")}`; + } +} + +export class NoirAccountService implements IAccountService { + chainApi: ApiPromise; + + constructor(chainApi: ApiPromise) { + this.chainApi = chainApi; + } + + public async accounts(address: string): Promise { + let sequence = "0"; + let key: string | null = null; + + const originRaw = await this.origin(address); + let origin = originRaw.toString(); + if (origin) { + key = Buffer.from(originRaw.toU8a(true).slice(2)).toString("base64"); + } else { + origin = this.interim(address); + key = Dummy.Secp256k1PublicKey; + } + const account = await this.chainApi.query["system"]["account"](origin); + if (account) { + const { nonce } = account.toJSON() as any; + sequence = nonce.toString(); + } + return new AccountResponse({ + "@type": "/cosmos.auth.v1beta1.BaseAccount", + address: address, + pub_key: { + "@type": "/cosmos.crypto.secp256k1.PubKey", + key, + }, + account_number: "0", + sequence, + }); + } + + public async origin(address: string): Promise { + const { data } = fromBech32(address); + const addressRaw = Buffer.concat([Buffer.from([0x01]), data]); + return this.chainApi.query["alias"]["accountIdOf"]( + addressRaw + ); + } + + public interim(address: string): string { + const { data } = fromBech32(address); + const addressRaw = blake2b(Buffer.concat([Buffer.from("cosm:", "utf8"), data]), 32); + return `0x${Buffer.from(addressRaw).toString("hex")}`; + } +} diff --git a/sidecar/src/services/balance.ts b/sidecar/src/services/balance.ts new file mode 100644 index 00000000..57b8b368 --- /dev/null +++ b/sidecar/src/services/balance.ts @@ -0,0 +1,50 @@ +import { ApiPromise } from "@pinot/api"; +import { IAccountService } from "./account.js"; +import { ApiService } from "./service.js"; +import { IConfig } from "config"; +import { QueryAllBalancesResponse } from "cosmjs-types/cosmos/bank/v1beta1/query.js"; +import Long from "long"; + +export class BalanceService implements ApiService { + config: IConfig; + chainApi: ApiPromise; + accountService: IAccountService; + + constructor( + config: IConfig, + chainApi: ApiPromise, + accountService: IAccountService + ) { + this.config = config; + this.chainApi = chainApi; + this.accountService = accountService; + } + + public async balances(address: string): Promise { + const originRaw = await this.accountService.origin(address); + let amount = "0"; + let origin = originRaw.toString(); + if (!origin) { + origin = this.accountService.interim(address); + } + const account = await this.chainApi.query.system.account(origin); + if (account) { + const { data } = account.toJSON() as any; + const { free } = data; + amount = free; + } + const denom = this.config.get("chain.denom"); + return { + balances: [ + { + denom, + amount, + }, + ], + pagination: { + nextKey: new Uint8Array(), + total: Long.ZERO, + }, + }; + } +} diff --git a/sidecar/src/services/distribution.ts b/sidecar/src/services/distribution.ts new file mode 100644 index 00000000..4c05384e --- /dev/null +++ b/sidecar/src/services/distribution.ts @@ -0,0 +1,13 @@ +import { QueryDelegationTotalRewardsResponse } from "cosmjs-types/cosmos/distribution/v1beta1/query.js"; +import { ApiService } from "./service.js"; + +export class DistributionService implements ApiService { + public rewards( + delegatorAddress: string + ): QueryDelegationTotalRewardsResponse { + return { + rewards: [], + total: [], + }; + } +} diff --git a/sidecar/src/services/index.ts b/sidecar/src/services/index.ts new file mode 100644 index 00000000..cf9d3293 --- /dev/null +++ b/sidecar/src/services/index.ts @@ -0,0 +1,9 @@ +export * from "./abci.js"; +export * from "./account.js"; +export * from "./balance.js"; +export * from "./distribution.js"; +export * from "./nodeinfo.js"; +export * from "./service.js"; +export * from "./staking.js"; +export * from "./status.js"; +export * from "./tx.js"; diff --git a/sidecar/src/services/nodeinfo.ts b/sidecar/src/services/nodeinfo.ts new file mode 100644 index 00000000..850ed9d7 --- /dev/null +++ b/sidecar/src/services/nodeinfo.ts @@ -0,0 +1,49 @@ +import { GetNodeInfoResponse } from "cosmjs-types/cosmos/base/tendermint/v1beta1/query.js"; +import { ApiService } from "./service.js"; +import { IConfig } from "config"; +import Long from "long"; + +export class NodeInfoService implements ApiService { + config: IConfig; + + constructor(config: IConfig) { + this.config = config; + } + + public nodeInfo(): GetNodeInfoResponse { + const endpoint = this.config.get("server.endpoint"); + const network = this.config.get("chain.network"); + const version = this.config.get("chain.version"); + const moniker = this.config.get("chain.moniker"); + const name = this.config.get("chain.name"); + return { + defaultNodeInfo: { + protocolVersion: { + p2p: Long.ZERO, + block: Long.ZERO, + app: Long.ZERO, + }, + defaultNodeId: "0000000000000000000000000000000000000000", + listenAddr: endpoint, + network, + version, + channels: new Uint8Array(Buffer.allocUnsafe(8)), + moniker, + other: { + txIndex: "off", + rpcAddress: "", + }, + }, + applicationVersion: { + name, + appName: name, + version, + gitCommit: "0000000000000000000000000000000000000000", + buildTags: "", + goVersion: "0", + buildDeps: [], + cosmosSdkVersion: "0", + }, + }; + } +} diff --git a/sidecar/src/services/service.ts b/sidecar/src/services/service.ts new file mode 100644 index 00000000..746c0eb3 --- /dev/null +++ b/sidecar/src/services/service.ts @@ -0,0 +1,17 @@ +export interface ApiService {} + +export class ApiServices { + services: Map; + + constructor() { + this.services = new Map(); + } + + public get(name: string): T { + return this.services.get(name) as T; + } + + public set(name: string, service: ApiService) { + this.services.set(name, service); + } +} diff --git a/sidecar/src/services/staking.ts b/sidecar/src/services/staking.ts new file mode 100644 index 00000000..0a4f2286 --- /dev/null +++ b/sidecar/src/services/staking.ts @@ -0,0 +1,30 @@ +import Long from "long"; +import { ApiService } from "./service.js"; +import { + QueryDelegatorDelegationsResponse, + QueryDelegatorUnbondingDelegationsResponse, +} from "cosmjs-types/cosmos/staking/v1beta1/query.js"; + +export class StakingService implements ApiService { + public deligations(delegatorAddr: string): QueryDelegatorDelegationsResponse { + return { + delegationResponses: [], + pagination: { + nextKey: new Uint8Array(), + total: Long.ZERO, + }, + }; + } + + public unbondingDeligations( + delegatorAddr: string + ): QueryDelegatorUnbondingDelegationsResponse { + return { + unbondingResponses: [], + pagination: { + nextKey: new Uint8Array(), + total: Long.ZERO, + }, + }; + } +} diff --git a/sidecar/src/services/status.ts b/sidecar/src/services/status.ts new file mode 100644 index 00000000..f5df8ba7 --- /dev/null +++ b/sidecar/src/services/status.ts @@ -0,0 +1,69 @@ +import { ApiPromise } from "@pinot/api"; +import { ResultStatus } from "../types/index.js"; +import { ApiService } from "./service.js"; +import { IConfig } from "config"; +import Long from "long"; + +export class StatusService implements ApiService { + config: IConfig; + chainApi: ApiPromise; + + constructor(config: IConfig, chainApi: ApiPromise) { + this.config = config; + this.chainApi = chainApi; + } + + public async status(): Promise { + const hash = (await this.chainApi.rpc.chain.getFinalizedHead()).toString(); + const { block } = (await this.chainApi.rpc.chain.getBlock(hash)).toJSON(); + const blockNumber = (block as any).header.number; + const timestamp = ( + await (await this.chainApi.at(hash)).query.timestamp.now() + ).toString(); + const blockTime = new Date(parseInt(timestamp)).toISOString(); + let blockHash = hash; + if (blockHash.startsWith("0x")) { + blockHash = blockHash.substring(2); + } + + const endpoint = this.config.get("server.endpoint"); + const network = this.config.get("chain.network"); + const version = this.config.get("chain.version"); + const moniker = this.config.get("chain.moniker"); + return { + node_info: { + protocol_version: { + p2p: Long.ZERO.toString(), + block: Long.ZERO.toString(), + app: Long.ZERO.toString(), + }, + id: "0000000000000000000000000000000000000000", + listen_addr: endpoint, + network, + version, + channels: "0000000000000000", + moniker, + other: { + tx_index: "off", + rpc_address: endpoint, + }, + }, + sync_info: { + latest_block_hash: blockHash.toUpperCase(), + latest_app_hash: + "0000000000000000000000000000000000000000000000000000000000000000", + latest_block_height: blockNumber, + latest_block_time: blockTime, + catching_up: false, + }, + validator_info: { + address: "0000000000000000000000000000000000000000", + pub_key: { + type: "tendermint/PubKeyEd25519", + value: "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + }, + voting_power: "0", + }, + }; + } +} diff --git a/sidecar/src/services/tx.ts b/sidecar/src/services/tx.ts new file mode 100644 index 00000000..d933b2a0 --- /dev/null +++ b/sidecar/src/services/tx.ts @@ -0,0 +1,161 @@ +import { ApiPromise } from "@pinot/api"; +import { ResultTx, ResultTxSearch } from "../types/index.js"; +import { ApiService } from "./service.js"; +import { Database } from "lmdb"; +import { Tx } from "cosmjs-types/cosmos/tx/v1beta1/tx.js"; +import Weights from "../constants/weights.js"; +import { + BroadcastTxResponse, + SimulateResponse, +} from "cosmjs-types/cosmos/tx/v1beta1/service.js"; +import Long from "long"; + +type TransactResult = { code: number; gasUsed: number }; + +export class TxService implements ApiService { + chainApi: ApiPromise; + db: Database; + + constructor(db: Database, chainApi: ApiPromise) { + this.chainApi = chainApi; + this.db = db; + } + + public async broadcastTx(txBytes: string): Promise { + const hexTx = `0x${Buffer.from(txBytes, "base64").toString("hex")}`; + const res = await this.chainApi.rpc["cosm"]["broadcastTx"](hexTx); + let txhash = res.toString(); + if (txhash.startsWith("0x")) { + txhash = txhash.substring(2); + } + + await this.db.put(`tx::origin::${txhash.toLowerCase()}`, txBytes); + return { + txResponse: { + height: Long.ZERO, + txhash: txhash.toUpperCase(), + codespace: "", + code: 0, + data: "", + rawLog: "", + logs: [], + info: "", + gasWanted: Long.ZERO, + gasUsed: Long.ZERO, + tx: { + typeUrl: "", + value: new Uint8Array(), + }, + timestamp: "", + events: [], + }, + }; + } + + public searchTx(hash: string): ResultTxSearch { + const resultTx = this.db.get(`tx::result::${hash.toLowerCase()}`); + const txs: ResultTx[] = []; + if (resultTx) { + txs.push(resultTx); + } + return { + txs, + total_count: txs.length, + }; + } + + public async saveTransactResult( + tx: any, + extrinsicIndex: number, + header: any + ): Promise { + let txHash = tx.hash; + if (txHash.startsWith("0x")) { + txHash = txHash.substring(2); + } + const rawTx = this.db.get(`tx::origin::${txHash.toLowerCase()}`); + const { code, gasUsed } = await this.checkResult(header, extrinsicIndex); + const txResult: ResultTx = { + hash: txHash.toUpperCase(), + height: header.number.toString(), + index: extrinsicIndex, + tx_result: { + code, + data: "", + log: "", + info: "", + gas_wanted: tx.authInfo.fee.gasLimit, + gas_used: gasUsed, + events: [], + codespace: "", + }, + tx: rawTx, + }; + await this.db.put(`tx::result::${txHash.toLowerCase()}`, txResult); + } + + async checkResult( + header: any, + extrinsicIndex: number + ): Promise { + const events = (await ( + await this.chainApi.at(header.hash) + ).query.system.events()) as any; + const result = events + .filter(({ event: { section, method }, phase }) => { + const { applyExtrinsic } = JSON.parse(phase.toString()); + return ( + applyExtrinsic === extrinsicIndex && + (`${section}::${method}` === "cosmos::Executed" || + `${section}::${method}` === "system::ExtrinsicFailed") + ); + }) + .map(({ event: { data, section, method } }) => { + if (`${section}::${method}` === "cosmos::Executed") { + const result = JSON.parse(data.toString()); + const code = result[0]; + const { refTime } = result[1]; + return { code, gasUsed: refTime }; + } else { + const { error } = JSON.parse(data.toString())[0]["module"]; + const { refTime } = JSON.parse(data.toString())[1]["weight"]; + let code = error; + if (code.startsWith("0x")) { + code = code.substring(2); + } + code = Buffer.from(code, "hex").readUint32LE(); + return { code, gasUsed: refTime }; + } + }); + return result[0]; + } + + public simulateTx(txBytes: string): SimulateResponse { + const { + body, + authInfo: { + fee: { gasLimit }, + }, + } = Tx.decode(Buffer.from(txBytes, "base64")); + const { messages } = body; + + let gasUsed = 0; + // Multi message type is not supported yet. + if (messages[0].typeUrl === "/cosmos.bank.v1beta1.MsgSend") { + gasUsed += Weights.MsgSend; + } + + return { + gasInfo: { + gasWanted: gasLimit, + gasUsed: Long.fromNumber(gasUsed), + }, + result: { + data: new Uint8Array(), + log: "", + events: [], + msgResponses: [], + }, + }; + } +} diff --git a/sidecar/src/types/account.ts b/sidecar/src/types/account.ts new file mode 100644 index 00000000..3974b152 --- /dev/null +++ b/sidecar/src/types/account.ts @@ -0,0 +1,26 @@ +import Dummy from "../constants/dummy.js"; + +export class AccountResponse { + account: BaseAccount; + + constructor(account: BaseAccount) { + this.account = account; + } + + public isInterim(): boolean { + return this.account.pub_key.key === Dummy.Secp256k1PublicKey; + } +} + +export interface BaseAccount { + "@type": string; + address: string; + pub_key: PublicKey | null; + account_number: string; + sequence: string; +} + +export interface PublicKey { + "@type": string; + key: string; +} diff --git a/sidecar/src/types/cometbft.ts b/sidecar/src/types/cometbft.ts new file mode 100644 index 00000000..637c2460 --- /dev/null +++ b/sidecar/src/types/cometbft.ts @@ -0,0 +1,34 @@ +export interface ResultTxSearch { + txs: ResultTx[]; + total_count: number; +} + +export interface ResultTx { + hash: string; + height: string; + index: number; + tx_result: ResponseDeliverTx; + tx: string; +} + +export interface ResponseDeliverTx { + code: number; + data: string; + log: string; + info: string; + gas_wanted: number; + gas_used: number; + events: Event[]; + codespace: string; +} + +export interface Event { + type: string; + attributes: EventAttribute[]; +} + +export interface EventAttribute { + key: string; + value: string; + index: boolean; +} diff --git a/sidecar/src/types/index.ts b/sidecar/src/types/index.ts new file mode 100644 index 00000000..ebba7746 --- /dev/null +++ b/sidecar/src/types/index.ts @@ -0,0 +1,4 @@ +export * from "./account.js"; +export * from "./cometbft.js"; +export * from "./status.js"; +export * from "./tx.js"; diff --git a/sidecar/src/types/status.ts b/sidecar/src/types/status.ts new file mode 100644 index 00000000..e1f422e3 --- /dev/null +++ b/sidecar/src/types/status.ts @@ -0,0 +1,46 @@ +export interface ResultStatus { + node_info: StatusDefaultNodeInfo; + sync_info: SyncInfo; + validator_info: ValidatorInfo; +} + +export interface DefaultNodeInfoOther { + tx_index: string; + rpc_address: string; +} + +export interface ProtocolVersion { + p2p: string; + block: string; + app: string; +} + +export interface StatusDefaultNodeInfo { + protocol_version: ProtocolVersion; + id: string; + listen_addr: string; + network: string; + version: string; + channels: string; + moniker: string; + other: DefaultNodeInfoOther; +} + +export interface SyncInfo { + latest_block_hash: string; + latest_app_hash: string; + latest_block_height: string; + latest_block_time: string; + catching_up: boolean; +} + +export interface ValidatorInfo { + address: string; + pub_key: PubKey; + voting_power: string; +} + +export interface PubKey { + type: string; + value: string; +} diff --git a/sidecar/src/types/tx.ts b/sidecar/src/types/tx.ts new file mode 100644 index 00000000..0f518733 --- /dev/null +++ b/sidecar/src/types/tx.ts @@ -0,0 +1,7 @@ +export interface BroadcastTxSyncResponse { + code: number; + data: string; + log: string; + codespace: string; + hash: string; +} diff --git a/sidecar/src/utils/index.ts b/sidecar/src/utils/index.ts new file mode 100644 index 00000000..effce245 --- /dev/null +++ b/sidecar/src/utils/index.ts @@ -0,0 +1,22 @@ +export function toSnakeCase(input: unknown): unknown { + if (typeof input !== "object" || input === null) { + return input; + } + + if (Array.isArray(input)) { + return input.map(toSnakeCase); + } + + const result: unknown = {}; + for (const key in input) { + if (input.hasOwnProperty(key)) { + const snakeCaseKey = key + .replace(/([A-Z])/g, "_$1") + .toLowerCase() + .replace(/^_/, ""); + result[snakeCaseKey] = toSnakeCase(input[key]); + } + } + + return result; +} diff --git a/sidecar/tsconfig.json b/sidecar/tsconfig.json new file mode 100644 index 00000000..b0c7947d --- /dev/null +++ b/sidecar/tsconfig.json @@ -0,0 +1,25 @@ +{ + "compilerOptions": { + "target": "ES2020", + "module": "ESNext", + "rootDir": "./src", + "moduleResolution": "node", + "allowJs": true, + "checkJs": true, + "sourceMap": true, + "outDir": "./dist", + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "skipLibCheck": true, + "declaration": true, + "noImplicitReturns": true + }, + "exclude": [ + "node_modules", + "**/*.spec.ts" + ], + "include": [ + "src/*", + "src/**/*" + ] +} \ No newline at end of file