diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..bae94e1 --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/EthernaGatewayCli.sln b/EthernaGatewayCli.sln index 286ffa6..0f101ff 100644 --- a/EthernaGatewayCli.sln +++ b/EthernaGatewayCli.sln @@ -8,6 +8,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution nuget.config = nuget.config .gitignore = .gitignore .editorconfig = .editorconfig + COPYING = COPYING EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{6DD03B58-3404-41AD-B84D-E43E600C54F3}" @@ -15,6 +16,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{ .github\workflows\publish-stable.yml = .github\workflows\publish-stable.yml EndProjectSection EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{061B4436-4F7D-4A14-8625-AE5930821F3B}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -28,5 +31,6 @@ Global EndGlobalSection GlobalSection(NestedProjects) = preSolution {6DD03B58-3404-41AD-B84D-E43E600C54F3} = {D3B7E18B-46F8-4072-9D14-801FDB15868C} + {F348B863-6892-45AD-AC33-3AD833A14BBB} = {061B4436-4F7D-4A14-8625-AE5930821F3B} EndGlobalSection EndGlobal diff --git a/EthernaGatewayCli.sln.DotSettings b/EthernaGatewayCli.sln.DotSettings index f73d392..1b5ebc7 100644 --- a/EthernaGatewayCli.sln.DotSettings +++ b/EthernaGatewayCli.sln.DotSettings @@ -1,17 +1,17 @@  - Copyright 2024-present Etherna SA + Copyright 2024-present Etherna SA +This file is part of Etherna Gateway CLI. - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at +Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +GNU Affero General Public License as published by the Free Software Foundation, +either version 3 of the License, or (at your option) any later version. - http://www.apache.org/licenses/LICENSE-2.0 +Etherna Gateway CLI 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 Affero General Public License for more details. - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +If not, see <https://www.gnu.org/licenses/>. True True True \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md index 107186b..75af1b3 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,16 @@ Run 'etherna -h' or 'etherna --help' to print help. Run 'etherna COMMAND -h' or 'etherna COMMAND --help' for more information on a command. ``` -# Issue reports +## Issue reports If you've discovered a bug, or have an idea for a new feature, please report it to our issue manager based on Jira https://etherna.atlassian.net/projects/EGC. -# Questions? Problems? +## Questions? Problems? For questions or problems please write an email to [info@etherna.io](mailto:info@etherna.io). + +## License + +![AGPL Logo](https://www.gnu.org/graphics/agplv3-with-text-162x68.png) + +We use the GNU Affero General Public License v3 (AGPL-3.0) for this project. +If you require a custom license, you can contact us at [license@etherna.io](mailto:license@etherna.io). diff --git a/src/EthernaGatewayCli/Commands/Etherna/DownloadCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/DownloadCommand.cs index 7863c41..3d79b26 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/DownloadCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/DownloadCommand.cs @@ -1,21 +1,23 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.BeeNet.Clients.GatewayApi; -using Etherna.GatewayCli.Models.Commands; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; +using Etherna.Sdk.Users.Clients; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna @@ -24,18 +26,19 @@ public class DownloadCommand : CommandBase { // Fields. private readonly IAuthenticationService authService; - private readonly IBeeGatewayClient beeGatewayClient; + private readonly IEthernaUserGatewayClient gatewayClient; // Constructor. public DownloadCommand( + Assembly assembly, IAuthenticationService authService, - IBeeGatewayClient beeGatewayClient, + IEthernaUserGatewayClient gatewayClient, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { this.authService = authService; - this.beeGatewayClient = beeGatewayClient; + this.gatewayClient = gatewayClient; } // Properties. diff --git a/src/EthernaGatewayCli/Commands/Etherna/DownloadCommandOptions.cs b/src/EthernaGatewayCli/Commands/Etherna/DownloadCommandOptions.cs index e8a9a10..bbd85b6 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/DownloadCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/DownloadCommandOptions.cs @@ -1,18 +1,18 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; +using Etherna.CliHelper.Models.Commands; using System; using System.Collections.Generic; diff --git a/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommand.cs index 1ca39ba..1d58aad 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommand.cs @@ -1,20 +1,23 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; +using Etherna.BeeNet.Models; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna.Postage @@ -27,11 +30,12 @@ public class CreateCommand : CommandBase // Constructor. public CreateCommand( + Assembly assembly, IAuthenticationService authService, IGatewayService gatewayService, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { this.authService = authService; this.gatewayService = gatewayService; @@ -53,9 +57,15 @@ protected override async Task ExecuteAsync(string[] commandArgs) await authService.SignInAsync(); // Create postage. - var amount = Options.Amount ?? (Options.Ttl.HasValue - ? await gatewayService.CalculateAmountAsync(Options.Ttl.Value) - : throw new InvalidOperationException("Amount ot ttl are required")); + BzzBalance amount; + if (Options.Amount.HasValue) amount = Options.Amount.Value; + else if (Options.Ttl.HasValue) + { + var chainPrice = await gatewayService.GetChainPriceAsync(); + amount = PostageBatch.CalculateAmount(chainPrice, Options.Ttl.Value); + } + else throw new InvalidOperationException("Amount or TTL are required"); + var batchId = await gatewayService.CreatePostageBatchAsync(amount, Options.Depth, Options.Label); // Print result. diff --git a/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommandOptions.cs b/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommandOptions.cs index 5135dc5..b6f58ad 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Postage/CreateCommandOptions.cs @@ -1,19 +1,20 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Models.Commands.OptionRequirements; +using Etherna.BeeNet.Models; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Models.Commands.OptionRequirements; using System; using System.Collections.Generic; @@ -24,7 +25,7 @@ public class CreateCommandOptions : CommandOptionsBase // Definitions. public override IEnumerable Definitions => new CommandOption[] { - new("-a", "--amount", "Specify the amount to use", args => Amount = long.Parse(args[0]), [typeof(long)]), + new("-a", "--amount", "Specify the amount to use", args => Amount = BzzBalance.FromPlurString(args[0]), [typeof(long)]), new("-d", "--depth", "Specify the postage batch depth", args => Depth = int.Parse(args[0]), [typeof(int)]), new("-l", "--label", "Set a custom postage batch label", args => Label = args[0], [typeof(string)]), new("-t", "--ttl", "Specify the time to live to obtain in days", args => Ttl = TimeSpan.FromDays(int.Parse(args[0])), [typeof(int)]) @@ -39,7 +40,7 @@ public class CreateCommandOptions : CommandOptionsBase }; // Options. - public long? Amount { get; private set; } + public BzzBalance? Amount { get; private set; } public int Depth { get; private set; } public string? Label { get; private set; } public TimeSpan? Ttl { get; private set; } diff --git a/src/EthernaGatewayCli/Commands/Etherna/Postage/InfoCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/Postage/InfoCommand.cs index b3a76a6..543377f 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Postage/InfoCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Postage/InfoCommand.cs @@ -1,21 +1,25 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; +using Etherna.BeeNet.JsonConverters; +using Etherna.BeeNet.Models; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; -using Etherna.Sdk.GeneratedClients.Gateway; +using Etherna.Sdk.Common.GenClients.Gateway; using System; +using System.Reflection; using System.Text.Json; using System.Threading.Tasks; @@ -24,7 +28,16 @@ namespace Etherna.GatewayCli.Commands.Etherna.Postage public class InfoCommand : CommandBase { // Consts. - private static readonly JsonSerializerOptions SerializerOptions = new() { WriteIndented = true }; + private static readonly JsonSerializerOptions SerializerOptions = new() + { + Converters = + { + new BzzBalanceJsonConverter(), + new PostageBatchIdJsonConverter(), + new XDaiBalanceJsonConverter() + }, + WriteIndented = true + }; // Fields. private readonly IAuthenticationService authService; @@ -32,11 +45,12 @@ public class InfoCommand : CommandBase // Constructor. public InfoCommand( + Assembly assembly, IAuthenticationService authService, IGatewayService gatewayService, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { this.authService = authService; this.gatewayService = gatewayService; @@ -59,7 +73,7 @@ protected override async Task ExecuteAsync(string[] commandArgs) await authService.SignInAsync(); // Get postage info - PostageBatchDto? postageBatch = null; + PostageBatch? postageBatch = null; try { postageBatch = await gatewayService.GetPostageBatchInfoAsync(commandArgs[0]); diff --git a/src/EthernaGatewayCli/Commands/Etherna/PostageCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/PostageCommand.cs index 2ec645a..b6173a0 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/PostageCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/PostageCommand.cs @@ -1,20 +1,21 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using System; +using System.Reflection; namespace Etherna.GatewayCli.Commands.Etherna { @@ -22,9 +23,10 @@ public class PostageCommand : CommandBase { // Constructor. public PostageCommand( + Assembly assembly, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { } // Properties. diff --git a/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommand.cs index a0b5b59..a2d4f72 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommand.cs @@ -1,20 +1,21 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna.Resource @@ -22,9 +23,10 @@ namespace Etherna.GatewayCli.Commands.Etherna.Resource public class DefundCommand : CommandBase { public DefundCommand( + Assembly assembly, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { } diff --git a/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommandOptions.cs b/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommandOptions.cs index 6f46f5f..a66d217 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Resource/DefundCommandOptions.cs @@ -1,19 +1,19 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Models.Commands.OptionRequirements; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Models.Commands.OptionRequirements; using System.Collections.Generic; namespace Etherna.GatewayCli.Commands.Etherna.Resource diff --git a/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommand.cs index 4ab519e..2896277 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommand.cs @@ -1,20 +1,22 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna.Resource @@ -27,11 +29,12 @@ public class FundCommand : CommandBase // Constructor. public FundCommand( + Assembly assembly, IAuthenticationService authService, IGatewayService gatewayService, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { this.authService = authService; this.gatewayService = gatewayService; @@ -77,7 +80,7 @@ protected override async Task ExecuteAsync(string[] commandArgs) #pragma warning disable CA1031 try { - await gatewayService.FundResourceTrafficAsync(resourceHash); + await gatewayService.FundResourceDownloadAsync(resourceHash); IoService.WriteLine($"Resource traffic funded"); } catch (Exception e) diff --git a/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommandOptions.cs b/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommandOptions.cs index 8a21402..d665f50 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Resource/FundCommandOptions.cs @@ -1,19 +1,19 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Models.Commands.OptionRequirements; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Models.Commands.OptionRequirements; using System.Collections.Generic; namespace Etherna.GatewayCli.Commands.Etherna.Resource diff --git a/src/EthernaGatewayCli/Commands/Etherna/Resource/ListCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/Resource/ListCommand.cs index 6ee1f44..6525219 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/Resource/ListCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/Resource/ListCommand.cs @@ -1,20 +1,21 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna.Resource @@ -22,9 +23,10 @@ namespace Etherna.GatewayCli.Commands.Etherna.Resource public class ListCommand : CommandBase { public ListCommand( + Assembly assembly, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { } diff --git a/src/EthernaGatewayCli/Commands/Etherna/ResourceCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/ResourceCommand.cs index 3e8a84b..e942d46 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/ResourceCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/ResourceCommand.cs @@ -1,20 +1,21 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using System; +using System.Reflection; namespace Etherna.GatewayCli.Commands.Etherna { @@ -22,9 +23,10 @@ public class ResourceCommand : CommandBase { // Constructor. public ResourceCommand( + Assembly assembly, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { } // Properties. diff --git a/src/EthernaGatewayCli/Commands/Etherna/UploadCommand.cs b/src/EthernaGatewayCli/Commands/Etherna/UploadCommand.cs index 6bd7a5d..087a3af 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/UploadCommand.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/UploadCommand.cs @@ -1,23 +1,25 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using Etherna.BeeNet.InputModels; -using Etherna.GatewayCli.Models.Commands; +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . + +using Etherna.BeeNet.Models; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; -using Etherna.Sdk.GeneratedClients.Gateway; +using Etherna.Sdk.Common.GenClients.Gateway; using System; using System.IO; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands.Etherna @@ -35,12 +37,13 @@ public class UploadCommand : CommandBase // Constructor. public UploadCommand( + Assembly assembly, IAuthenticationService authService, IFileService fileService, IGatewayService gatewayService, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { this.authService = authService; this.fileService = fileService; @@ -48,8 +51,8 @@ public UploadCommand( } // Properties. - public override string CommandArgsHelpString => "SOURCE_FILE [SOURCE_FILE ...]"; - public override string Description => "Upload a file resource to Swarm"; + public override string CommandArgsHelpString => "SOURCE [SOURCE ...]"; + public override string Description => "Upload files and directories to Swarm"; // Methods. protected override async Task ExecuteAsync(string[] commandArgs) @@ -59,53 +62,58 @@ protected override async Task ExecuteAsync(string[] commandArgs) // Parse args. if (commandArgs.Length < 1) throw new ArgumentException("Upload requires 1 or more arguments"); - var filePaths = commandArgs; - - // Search files and calculate total file size. - var contentByteSize = 0L; - foreach (var filePath in filePaths) - { - if (!File.Exists(filePath)) - throw new InvalidOperationException($"File {filePath} doesn't exist"); - - var fileInfo = new FileInfo(filePath); - contentByteSize += fileInfo.Length; - } + var paths = commandArgs; // Authenticate user. await authService.SignInAsync(); + // Search files and calculate required postage batch depth. + var batchDepth = await gatewayService.CalculatePostageBatchDepthAsync(paths); + // Identify postage batch to use. - var postageBatchId = await GetUsablePostageBatchIdAsync(contentByteSize); + var postageBatchId = await GetUsablePostageBatchIdAsync(batchDepth); // Upload file. - foreach (var filePath in filePaths) + foreach (var path in paths) { - IoService.WriteLine($"Uploading {filePath}..."); + IoService.WriteLine($"Uploading {path}..."); var uploadSucceeded = false; - string refHash = default!; + SwarmHash hash = default!; for (int i = 0; i < UploadMaxRetry && !uploadSucceeded; i++) { try { - await using var fileStream = File.Open(filePath, FileMode.Open); - var mimeType = fileService.GetMimeType(filePath); + if(File.Exists(path)) //is a file + { + await using var fileStream = File.OpenRead(path); + var mimeType = fileService.GetMimeType(path); - refHash = await gatewayService.UploadFileAsync( - postageBatchId, - fileStream, - Path.GetFileName(filePath), - mimeType, - Options.PinResource); - IoService.WriteLine($"Ref hash: {refHash}"); + hash = await gatewayService.UploadFileAsync( + postageBatchId, + fileStream, + Path.GetFileName(path), + mimeType, + Options.PinResource); + } + else if (Directory.Exists(path)) //is a directory + { + hash = await gatewayService.UploadDirectoryAsync( + postageBatchId, + path, + Options.PinResource); + } + else //invalid path + throw new InvalidOperationException($"Path {path} is not valid"); + + IoService.WriteLine($"Hash: {hash}"); uploadSucceeded = true; } #pragma warning disable CA1031 catch (Exception e) { - IoService.WriteErrorLine($"Error uploading {filePath}"); + IoService.WriteErrorLine($"Error uploading {path}"); IoService.WriteLine(e.ToString()); if (i + 1 < UploadMaxRetry) @@ -118,13 +126,13 @@ protected override async Task ExecuteAsync(string[] commandArgs) } if (!uploadSucceeded) - IoService.WriteErrorLine($"Can't upload \"{filePath}\" after {UploadMaxRetry} retries"); + IoService.WriteErrorLine($"Can't upload \"{path}\" after {UploadMaxRetry} retries"); else if (Options.OfferDownload) { #pragma warning disable CA1031 try { - await gatewayService.FundResourceTrafficAsync(refHash); + await gatewayService.FundResourceDownloadAsync(hash); IoService.WriteLine($"Resource traffic funded"); } catch (Exception e) @@ -138,16 +146,16 @@ protected override async Task ExecuteAsync(string[] commandArgs) } // Helpers. - private async Task GetUsablePostageBatchIdAsync(long contentByteSize) + private async Task GetUsablePostageBatchIdAsync(int batchDepth) { if (Options.UsePostageBatchId is null) { //create a new postage batch - var batchDepth = gatewayService.CalculateDepth(contentByteSize); - var amount = await gatewayService.CalculateAmountAsync(Options.NewPostageTtl); - var bzzPrice = gatewayService.CalculateBzzPrice(amount, batchDepth); + var chainPrice = await gatewayService.GetChainPriceAsync(); + var amount = PostageBatch.CalculateAmount(chainPrice, Options.NewPostageTtl); + var bzzPrice = PostageBatch.CalculatePrice(amount, batchDepth); - IoService.WriteLine($"Required postage batch Depth: {batchDepth}, Amount: {amount}, BZZ price: {bzzPrice}"); + IoService.WriteLine($"Required postage batch Depth: {batchDepth}, Amount: {amount.ToPlurString()}, BZZ price: {bzzPrice}"); if (!Options.NewPostageAutoPurchase) { @@ -182,7 +190,7 @@ private async Task GetUsablePostageBatchIdAsync(long contentByteSize) else { //get info about existing postage batch - PostageBatchDto postageBatch; + PostageBatch postageBatch; try { postageBatch = await gatewayService.GetPostageBatchInfoAsync(Options.UsePostageBatchId); @@ -194,20 +202,22 @@ private async Task GetUsablePostageBatchIdAsync(long contentByteSize) } //verify if it is usable - if (!postageBatch.Usable) + if (!postageBatch.IsUsable) { IoService.WriteErrorLine($"Postage batch \"{Options.UsePostageBatchId}\" is not usable."); throw new InvalidOperationException(); } - //verify if it has available space - if (gatewayService.CalculatePostageBatchByteSize(postageBatch) - - gatewayService.CalculateRequiredPostageBatchSpace(contentByteSize) < 0) - { - IoService.WriteErrorLine($"Postage batch \"{Options.UsePostageBatchId}\" has not enough space."); - throw new InvalidOperationException(); - } - + Console.WriteLine("Attention! Provided postage batch will be used without requirements checks!"); + //See: https://etherna.atlassian.net/browse/ESG-269 + // // verify if it has available space + // if (gatewayService.CalculatePostageBatchByteSize(postageBatch) - + // gatewayService.CalculateRequiredPostageBatchSpace(contentByteSize) < 0) + // { + // IoService.WriteErrorLine($"Postage batch \"{Options.UsePostageBatchId}\" has not enough space."); + // throw new InvalidOperationException(); + // } + return postageBatch.Id; } } diff --git a/src/EthernaGatewayCli/Commands/Etherna/UploadCommandOptions.cs b/src/EthernaGatewayCli/Commands/Etherna/UploadCommandOptions.cs index 755ff78..d1263e9 100644 --- a/src/EthernaGatewayCli/Commands/Etherna/UploadCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/Etherna/UploadCommandOptions.cs @@ -1,19 +1,19 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Models.Commands.OptionRequirements; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Models.Commands.OptionRequirements; using System; using System.Collections.Generic; diff --git a/src/EthernaGatewayCli/Commands/EthernaCommand.cs b/src/EthernaGatewayCli/Commands/EthernaCommand.cs index 1b10f88..190bc47 100644 --- a/src/EthernaGatewayCli/Commands/EthernaCommand.cs +++ b/src/EthernaGatewayCli/Commands/EthernaCommand.cs @@ -1,21 +1,22 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Utilities; using System; +using System.Reflection; using System.Threading.Tasks; namespace Etherna.GatewayCli.Commands @@ -24,13 +25,20 @@ public class EthernaCommand : CommandBase { // Constructor. public EthernaCommand( + Assembly assembly, IIoService ioService, IServiceProvider serviceProvider) - : base(ioService, serviceProvider) + : base(assembly, ioService, serviceProvider) { } // Properties. - public override string Description => "A CLI interface to the Etherna Gateway"; + public override string Description => + """ + A CLI interface to the Etherna Gateway. + + Program distributed under AGPLv3 license. Copyright since 2024 by Etherna SA. + You can find source code at: https://github.com/Etherna/etherna-gateway-cli + """; public override bool IsRootCommand => true; // Protected methods. diff --git a/src/EthernaGatewayCli/Commands/EthernaCommandOptions.cs b/src/EthernaGatewayCli/Commands/EthernaCommandOptions.cs index 98b8315..b23d3b4 100644 --- a/src/EthernaGatewayCli/Commands/EthernaCommandOptions.cs +++ b/src/EthernaGatewayCli/Commands/EthernaCommandOptions.cs @@ -1,19 +1,18 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Commands; -using System; +using Etherna.CliHelper.Models.Commands; using System.Collections.Generic; namespace Etherna.GatewayCli.Commands diff --git a/src/EthernaGatewayCli/CommonConsts.cs b/src/EthernaGatewayCli/CommonConsts.cs index 91b1324..97deecf 100644 --- a/src/EthernaGatewayCli/CommonConsts.cs +++ b/src/EthernaGatewayCli/CommonConsts.cs @@ -1,18 +1,17 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.BeeNet.Clients.GatewayApi; using System; namespace Etherna.GatewayCli @@ -22,7 +21,6 @@ public static class CommonConsts public const string EthernaGatewayCliClientId = "ethernaGatewayCliId"; public const string EthernaGatewayUrl = "https://gateway.etherna.io/"; public const string EthernaSsoUrl = "https://sso.etherna.io/"; - public static readonly TimeSpan GnosisBlockTime = TimeSpan.FromSeconds(5); public const string HttpClientName = "ethernaAuthnHttpClient"; } } \ No newline at end of file diff --git a/src/EthernaGatewayCli/EthernaGatewayCli.csproj b/src/EthernaGatewayCli/EthernaGatewayCli.csproj index 0834a06..cfa9aa0 100644 --- a/src/EthernaGatewayCli/EthernaGatewayCli.csproj +++ b/src/EthernaGatewayCli/EthernaGatewayCli.csproj @@ -31,8 +31,8 @@ - - + + all runtime; build; native; contentfiles; analyzers; buildtransitive @@ -41,7 +41,7 @@ all runtime; build; native; contentfiles; analyzers; buildtransitive - + diff --git a/src/EthernaGatewayCli/Models/Commands/CommandBase.cs b/src/EthernaGatewayCli/Models/Commands/CommandBase.cs deleted file mode 100644 index 1d2c487..0000000 --- a/src/EthernaGatewayCli/Models/Commands/CommandBase.cs +++ /dev/null @@ -1,319 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using Etherna.GatewayCli.Services; -using Microsoft.Extensions.DependencyInjection; -using System; -using System.Collections.Generic; -using System.Collections.Immutable; -using System.Diagnostics.CodeAnalysis; -using System.Linq; -using System.Reflection; -using System.Text; -using System.Threading.Tasks; - -namespace Etherna.GatewayCli.Models.Commands -{ - public abstract class CommandBase - { - // Fields. - private readonly IServiceProvider serviceProvider; - private ImmutableArray? _availableSubCommandTypes; - private ImmutableArray? _commandPathTypes; - - // Constructor. - protected CommandBase( - IIoService ioService, - IServiceProvider serviceProvider) - { - IoService = ioService; - this.serviceProvider = serviceProvider; - } - - // Properties. - public ImmutableArray AvailableSubCommandTypes - { - get - { - if (_availableSubCommandTypes is null) - { - var subCommandsNamespace = GetType().Namespace + "." + GetType().Name.Replace("Command", ""); - _availableSubCommandTypes = typeof(Program).GetTypeInfo().Assembly.GetTypes() - .Where(t => t is {IsClass:true, IsAbstract: false} && - t.Namespace == subCommandsNamespace && - typeof(CommandBase).IsAssignableFrom(t)) - .OrderBy(t => t.Name) - .ToImmutableArray(); - } - return _availableSubCommandTypes.Value; - } - } - public string CommandPathNames => string.Join(' ', - CommandPathTypes.Select(cType => ((CommandBase)serviceProvider.GetRequiredService(cType)).Name)); - public ImmutableArray CommandPathTypes - { - get - { - if (_commandPathTypes is null) - { - var currentCommandNamespace = GetType().Namespace; - if (currentCommandNamespace is null) - throw new InvalidOperationException(); - - _commandPathTypes = GetParentCommandTypesFromNamespace(currentCommandNamespace) - .Append(GetType()).ToImmutableArray(); - } - return _commandPathTypes.Value; - } - } - public virtual string CommandArgsHelpString => HasSubCommands ? "COMMAND" : ""; - public string CommandPathUsageHelpString - { - get - { - var strBuilder = new StringBuilder(); - foreach (var commandType in CommandPathTypes) - { - var command = (CommandBase)serviceProvider.GetRequiredService(commandType); - strBuilder.Append(command.Name); - if (command.HasOptions) - { - strBuilder.Append(command.HasRequiredOptions ? - $" {command.Name.ToUpperInvariant()}_OPTIONS" : - $" [{command.Name.ToUpperInvariant()}_OPTIONS]"); - } - - strBuilder.Append(' '); - } - strBuilder.Append(CommandArgsHelpString); - return strBuilder.ToString(); - } - } - public abstract string Description { get; } - public virtual bool HasOptions => false; - public virtual bool HasRequiredOptions => false; - public bool HasSubCommands => AvailableSubCommandTypes.Any(); - public virtual bool IsRootCommand => false; - public string Name => GetCommandNameFromType(GetType()); - public virtual bool PrintHelpWithNoArgs => true; - - // Protected properties. - protected IIoService IoService { get; } - - // Public methods. - public async Task RunAsync(string[] args) - { - // Parse arguments. - var printHelp = EvaluatePrintHelp(args); - var optionArgsCount = printHelp ? 0 : ParseOptionArgs(args); - - // Print help or run command. - if (printHelp) - PrintHelp(); - else - await ExecuteAsync(args[optionArgsCount..]); - } - - // Protected methods. - protected virtual void AppendOptionsHelp(StringBuilder strBuilder) { } - - /// - /// Parse command options - /// - /// Input args - /// Found option args counter - protected virtual int ParseOptionArgs(string[] args) => 0; - - protected virtual async Task ExecuteAsync(string[] commandArgs) - { - ArgumentNullException.ThrowIfNull(commandArgs, nameof(commandArgs)); - await ExecuteSubCommandAsync(commandArgs); - } - - protected async Task ExecuteSubCommandAsync(string[] commandArgs) - { - ArgumentNullException.ThrowIfNull(commandArgs, nameof(commandArgs)); - - if (commandArgs.Length == 0) - throw new ArgumentException("A command name is required"); - - var subCommandName = commandArgs[0]; - var subCommandArgs = commandArgs[1..]; - - var selectedCommandType = AvailableSubCommandTypes.FirstOrDefault( - t => GetCommandNameFromType(t) == subCommandName); - - if (selectedCommandType is null) - throw new ArgumentException($"{CommandPathNames}: '{subCommandName}' is not a valid command."); - - var selectedCommand = (CommandBase)serviceProvider.GetRequiredService(selectedCommandType); - await selectedCommand.RunAsync(subCommandArgs); - } - - // Protected helpers. - protected static string GetCommandNameFromType(Type commandType) - { - ArgumentNullException.ThrowIfNull(commandType, nameof(commandType)); - - if (!typeof(CommandBase).IsAssignableFrom(commandType)) - throw new ArgumentException($"{commandType.Name} is not a command type"); - - return commandType.Name.Replace("Command", "").ToLowerInvariant(); - } - - // Private helpers. - private bool EvaluatePrintHelp(string[] args) - { - ArgumentNullException.ThrowIfNull(args, nameof(args)); - - switch (args.Length) - { - case 0 when PrintHelpWithNoArgs: - return true; - case 1: - switch (args[0]) - { - case "-h": - case "--help": - return true; - } - break; - } - return false; - } - - private static IEnumerable GetParentCommandTypesFromNamespace(string currentNamespace) - { - var lastSeparatorIndex = currentNamespace.LastIndexOf('.'); - var parentNamespace = currentNamespace[..lastSeparatorIndex]; - var parentCommandName = currentNamespace[(lastSeparatorIndex + 1)..] + "Command"; - var parentCommandType = typeof(CommandBase).GetTypeInfo().Assembly.GetTypes() - .FirstOrDefault(t => t is { IsClass: true, IsAbstract: false } && - t.FullName == parentNamespace + '.' + parentCommandName && - typeof(CommandBase).IsAssignableFrom(t)); - - if (parentCommandType is null) - return Array.Empty(); - return GetParentCommandTypesFromNamespace(parentNamespace).Append(parentCommandType); - } - - [SuppressMessage("Performance", "CA1851:Possible multiple enumerations of \'IEnumerable\' collection")] - private void PrintHelp() - { - var strBuilder = new StringBuilder(); - - // Add name and description. - strBuilder.AppendLine(CommandPathNames); - strBuilder.AppendLine(Description); - strBuilder.AppendLine(); - - // Add usage. - strBuilder.AppendLine($"Usage: {CommandPathUsageHelpString}"); - strBuilder.AppendLine(); - - // Add sub commands. - var availableSubCommandTypes = AvailableSubCommandTypes; - if (availableSubCommandTypes.Any()) - { - var allSubCommands = availableSubCommandTypes.Select(t => (CommandBase)serviceProvider.GetRequiredService(t)); - - strBuilder.AppendLine("Commands:"); - var descriptionShift = allSubCommands.Select(c => c.Name.Length).Max() + 4; - foreach (var command in allSubCommands) - { - strBuilder.Append(" "); - strBuilder.Append(command.Name); - for (int i = 0; i < descriptionShift - command.Name.Length; i++) - strBuilder.Append(' '); - strBuilder.AppendLine(command.Description); - } - strBuilder.AppendLine(); - } - - // Add options. - AppendOptionsHelp(strBuilder); - - // Add print help. - strBuilder.AppendLine($"Run '{CommandPathNames} -h' or '{CommandPathNames} --help' to print help."); - if (IsRootCommand) - strBuilder.AppendLine($"Run '{CommandPathNames} COMMAND -h' or '{CommandPathNames} COMMAND --help' for more information on a command."); - strBuilder.AppendLine(); - - // Print it. - var helpOutput = strBuilder.ToString(); - IoService.Write(helpOutput); - } - } - - public abstract class CommandBase : CommandBase - where TOptions: CommandOptionsBase, new() - { - // Constructor. - protected CommandBase( - IIoService ioService, - IServiceProvider serviceProvider) - : base(ioService, serviceProvider) - { } - - // Properties. - public override bool HasOptions => true; - public override bool HasRequiredOptions => Options.AreRequired; - public TOptions Options { get; } = new TOptions(); - - // Methods. - protected override int ParseOptionArgs(string[] args) => Options.ParseArgs(args, IoService); - - protected override void AppendOptionsHelp(StringBuilder strBuilder) - { - ArgumentNullException.ThrowIfNull(strBuilder, nameof(strBuilder)); - - if (!Options.Definitions.Any()) return; - - // Option descriptions. - strBuilder.AppendLine("Options:"); - var descriptionShift = Options.Definitions.Select(opt => - { - var len = opt.LongName.Length; - foreach (var reqArgType in opt.RequiredArgTypes) - len += reqArgType.Name.Length + 1; - return len; - }).Max() + 4; - foreach (var option in Options.Definitions) - { - strBuilder.Append(" "); - strBuilder.Append(option.ShortName is null ? " " : $"{option.ShortName}, "); - strBuilder.Append(option.LongName); - var strLen = option.LongName.Length; - foreach (var reqArgType in option.RequiredArgTypes) - { - strBuilder.Append($" {reqArgType.Name.ToLower()}"); - strLen += reqArgType.Name.Length + 1; - } - for (int i = 0; i < descriptionShift - strLen; i++) - strBuilder.Append(' '); - strBuilder.AppendLine(option.Description); - } - strBuilder.AppendLine(); - - // Requirements. - if (Options.Requirements.Any()) - { - strBuilder.AppendLine("Option requirements:"); - foreach (var requirement in Options.Requirements) - strBuilder.AppendLine(" " + requirement.PrintHelpLine(Options)); - strBuilder.AppendLine(); - } - } - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/CommandOption.cs b/src/EthernaGatewayCli/Models/Commands/CommandOption.cs deleted file mode 100644 index a00a3fb..0000000 --- a/src/EthernaGatewayCli/Models/Commands/CommandOption.cs +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; - -namespace Etherna.GatewayCli.Models.Commands -{ - public class CommandOption - { - // Regex to validate option names. - private static readonly Regex shortNameRegex = new("^-[A-Za-z0-9]$"); - private static readonly Regex longNameRegex = new("^--[A-Za-z0-9-]+$"); - - // Constructor. - public CommandOption( - string? shortName, - string longName, - string description, - Action onFound, - IEnumerable? requiredArgTypes = null) - { - if (shortName != null && !shortNameRegex.IsMatch(shortName)) - throw new ArgumentException("Invalid short option name"); - - if (!longNameRegex.IsMatch(longName)) - throw new ArgumentException("Invalid long option name"); - - ShortName = shortName; - LongName = longName; - RequiredArgTypes = requiredArgTypes ?? Array.Empty(); - Description = description; - OnFound = onFound; - } - - // Properties. - public string Description { get; } - public Action OnFound { get; } - public string LongName { get; } - public IEnumerable RequiredArgTypes { get; } - public string? ShortName { get; } - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/CommandOptionsBase.cs b/src/EthernaGatewayCli/Models/Commands/CommandOptionsBase.cs deleted file mode 100644 index 55cf79d..0000000 --- a/src/EthernaGatewayCli/Models/Commands/CommandOptionsBase.cs +++ /dev/null @@ -1,93 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using Etherna.GatewayCli.Models.Commands.OptionRequirements; -using Etherna.GatewayCli.Services; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; - -namespace Etherna.GatewayCli.Models.Commands -{ - public abstract class CommandOptionsBase - { - // Properties. - public bool AreRequired => Requirements.OfType().Any(); - public abstract IEnumerable Definitions { get; } - public virtual IEnumerable Requirements => Array.Empty(); - - // Methods. - public CommandOption FindOptionByName(string name) => - Definitions.First(o => o.ShortName == name || o.LongName == name); - - /// - /// Parse command options - /// - /// Input args - /// Found option args counter - public virtual int ParseArgs( - string[] args, - IIoService ioService) - { - ArgumentNullException.ThrowIfNull(args, nameof(args)); - ArgumentNullException.ThrowIfNull(ioService, nameof(args)); - - // Parse options. - var parsedArgsCount = 0; - var foundOptions = new List(); - while (parsedArgsCount < args.Length && args[parsedArgsCount].StartsWith('-')) - { - var optName = args[parsedArgsCount++]; - - // Find option by name. - var foundOption = Definitions.FirstOrDefault(opt => opt.ShortName == optName || opt.LongName == optName); - if (foundOption is null) - throw new ArgumentException(optName + " is not a valid option"); - - // Verify duplicate options. - if (foundOptions.Any(opt => opt.Option.ShortName == optName || opt.Option.LongName == optName)) - throw new ArgumentException(optName + " option is duplicate"); - - // Check required option args. - if (args.Length - parsedArgsCount < foundOption.RequiredArgTypes.Count()) - throw new ArgumentException($"{optName} requires {foundOption.RequiredArgTypes.Count()} args: {string.Join(" ", foundOption.RequiredArgTypes.Select(t => t.Name.ToLower()))}"); - - // Exec option code. - var requiredOptArgs = args[parsedArgsCount..(parsedArgsCount + foundOption.RequiredArgTypes.Count())]; - parsedArgsCount += requiredOptArgs.Length; - foundOption.OnFound(requiredOptArgs); - - // Save on found options. - foundOptions.Add(new(foundOption, optName, requiredOptArgs)); - } - - // Verify option requirements. - var optionErrors = Requirements.SelectMany(r => r.ValidateOptions(this, foundOptions)).ToArray(); - if (optionErrors.Length != 0) - { - var errorStrBuilder = new StringBuilder(); - errorStrBuilder.AppendLine("Invalid options:"); - foreach (var error in optionErrors) - errorStrBuilder.AppendLine(" " + error.Message); - - ioService.WriteError(errorStrBuilder.ToString()); - - throw new ArgumentException("Errors with command options"); - } - - return parsedArgsCount; - } - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ExclusiveOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ExclusiveOptionRequirement.cs deleted file mode 100644 index f4de0a9..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ExclusiveOptionRequirement.cs +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class ExclusiveOptionRequirement(params string[] optionsNames) - : OptionRequirementBase(optionsNames) - { - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) => - ComposeSentence(OptionsNames.Select(n => commandOptions.FindOptionByName(n).LongName)); - - public override IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions) - { - if (OptionsNames.Count(optName => TryFindParsedOption(parsedOptions, optName, out _)) >= 2) - { - var invalidParsedNames = parsedOptions.Where(parsedOpt => - OptionsNames.Contains(parsedOpt.Option.ShortName) || - OptionsNames.Contains(parsedOpt.Option.LongName)) - .Select(foundOpt => foundOpt.ParsedName); - - return [new OptionRequirementError(ComposeSentence(invalidParsedNames))]; - } - - return Array.Empty(); - } - - // Private helpers. - private string ComposeSentence(IEnumerable optNames) => - $"{string.Join(", ", optNames)} are mutual exclusive."; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ForbiddenOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ForbiddenOptionRequirement.cs deleted file mode 100644 index 9067b25..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/ForbiddenOptionRequirement.cs +++ /dev/null @@ -1,48 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class ForbiddenOptionRequirement(params string[] optionsNames) - : OptionRequirementBase(optionsNames) - { - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) => - string.Join(", ", OptionsNames.Select(n => commandOptions.FindOptionByName(n).LongName)) + - (OptionsNames.Count == 1 ? " is forbidden." : " are forbidden."); - - public override IEnumerable ValidateOptions(CommandOptionsBase commandOptions, IEnumerable parsedOptions) - { - if (OptionsNames.Any(optName => TryFindParsedOption(parsedOptions, optName, out _))) - { - var invalidParsedNames = parsedOptions.Where(parsedOpt => - OptionsNames.Contains(parsedOpt.Option.ShortName) || - OptionsNames.Contains(parsedOpt.Option.LongName)) - .Select(foundOpt => foundOpt.ParsedName); - - return [new OptionRequirementError(ComposeSentence(invalidParsedNames))]; - } - - return Array.Empty(); - } - - // Private helpers. - private string ComposeSentence(IEnumerable optNames) => - string.Join(", ", optNames) + (optNames.Count() == 1 ? " is forbidden." : " are forbidden."); - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/IfPresentThenOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/IfPresentThenOptionRequirement.cs deleted file mode 100644 index 2fa9637..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/IfPresentThenOptionRequirement.cs +++ /dev/null @@ -1,54 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class IfPresentThenOptionRequirement( - string optionsName, - OptionRequirementBase thenRequirement) - : OptionRequirementBase([optionsName]) - { - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) - { - ArgumentNullException.ThrowIfNull(commandOptions, nameof(commandOptions)); - - return ComposeSentence( - commandOptions.FindOptionByName(OptionsNames.First()).LongName, - thenRequirement.PrintHelpLine(commandOptions), - commandOptions); - } - - public override IEnumerable ValidateOptions(CommandOptionsBase commandOptions, IEnumerable parsedOptions) - { - var optName = OptionsNames.First(); - - if (!TryFindParsedOption(parsedOptions, optName, out var parsedOption)) - return Array.Empty(); - - var thenErrors = thenRequirement.ValidateOptions(commandOptions, parsedOptions); - - return thenErrors.Select(thenError => - new OptionRequirementError(ComposeSentence(optName, thenError.Message, commandOptions))); - } - - // Private helpers. - private string ComposeSentence(string optName, string thenMessageLine, CommandOptionsBase commandOptions) => - $"If {optName} is present then {thenMessageLine}"; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MaxValueOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MaxValueOptionRequirement.cs deleted file mode 100644 index 2e60c5f..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MaxValueOptionRequirement.cs +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class MaxValueOptionRequirement( - string optionsName, - double maxValue) - : OptionRequirementBase([optionsName]) - { - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) - { - ArgumentNullException.ThrowIfNull(commandOptions, nameof(commandOptions)); - - return ComposeSentence(commandOptions.FindOptionByName(OptionsNames.First()).LongName); - } - - public override IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions) - { - var optName = OptionsNames.First(); - - if (!TryFindParsedOption(parsedOptions, optName, out var parsedOption)) - return Array.Empty(); - - if (!double.TryParse(parsedOption!.ParsedArgs.First(), out var doubleArg)) - return [new OptionRequirementError( - $"Invalid argument value: {parsedOption.ParsedName} {parsedOption.ParsedArgs.First()}")]; - - return doubleArg <= maxValue - ? Array.Empty() - : [new OptionRequirementError(ComposeSentence(parsedOption.ParsedName))]; - } - - // Private helpers. - private string ComposeSentence(string optName) => $"{optName} has max value {maxValue}."; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MinValueOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MinValueOptionRequirement.cs deleted file mode 100644 index b0479c1..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/MinValueOptionRequirement.cs +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class MinValueOptionRequirement( - string optionsName, - double minValue) - : OptionRequirementBase([optionsName]) - { - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) - { - ArgumentNullException.ThrowIfNull(commandOptions, nameof(commandOptions)); - - return ComposeSentence(commandOptions.FindOptionByName(OptionsNames.First()).LongName); - } - - public override IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions) - { - var optName = OptionsNames.First(); - - if (!TryFindParsedOption(parsedOptions, optName, out var parsedOption)) - return Array.Empty(); - - if (!double.TryParse(parsedOption!.ParsedArgs.First(), out var doubleArg)) - return [new OptionRequirementError( - $"Invalid argument value: {parsedOption.ParsedName} {parsedOption.ParsedArgs.First()}")]; - - return doubleArg >= minValue - ? Array.Empty() - : [new OptionRequirementError(ComposeSentence(parsedOption.ParsedName))]; - } - - // Private helpers. - private string ComposeSentence(string optName) => $"{optName} has min value {minValue}."; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementBase.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementBase.cs deleted file mode 100644 index e4afe9d..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementBase.cs +++ /dev/null @@ -1,46 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public abstract class OptionRequirementBase( - IReadOnlyCollection optionsNames) - { - // Properties. - public IReadOnlyCollection OptionsNames { get; protected set; } = optionsNames; - - // Methods. - public abstract string PrintHelpLine( - CommandOptionsBase commandOptions); - - public abstract IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions); - - // Protected helpers. - protected static bool TryFindParsedOption( - IEnumerable parsedOptions, - string optionName, - out ParsedOption? foundParsedOption) - { - foundParsedOption = parsedOptions.SingleOrDefault(parsOpt => - parsOpt.Option.ShortName == optionName || - parsOpt.Option.LongName == optionName); - return foundParsedOption != null; - } - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementError.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementError.cs deleted file mode 100644 index d8c7405..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/OptionRequirementError.cs +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class OptionRequirementError - { - // Constructor. - public OptionRequirementError(string message) - { - Message = message; - } - - // Properties. - public string Message { get; } - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RangeOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RangeOptionRequirement.cs deleted file mode 100644 index 747a453..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RangeOptionRequirement.cs +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class RangeOptionRequirement : OptionRequirementBase - { - // Constructor. - public RangeOptionRequirement(string optionsName, - double minValue, - double maxValue) : base([optionsName]) - { - if (minValue >= maxValue) - throw new ArgumentException("Min value must be smaller than max value"); - - MaxValue = maxValue; - MinValue = minValue; - } - - // Properties. - public double MaxValue { get; } - public double MinValue { get; } - - // Methods. - public override string PrintHelpLine(CommandOptionsBase commandOptions) - { - ArgumentNullException.ThrowIfNull(commandOptions, nameof(commandOptions)); - - return ComposeSentence(commandOptions.FindOptionByName(OptionsNames.First()).LongName); - } - - public override IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions) - { - var optName = OptionsNames.First(); - - if (!TryFindParsedOption(parsedOptions, optName, out var parsedOption)) - return Array.Empty(); - - if (!double.TryParse(parsedOption!.ParsedArgs.First(), out var doubleArg)) - return [new OptionRequirementError( - $"Invalid argument value: {parsedOption.ParsedName} {parsedOption.ParsedArgs.First()}")]; - - return doubleArg >= MinValue && doubleArg <= MaxValue - ? Array.Empty() - : [new OptionRequirementError(ComposeSentence(parsedOption.ParsedName))]; - } - - // Private helpers. - private string ComposeSentence(string optName) => $"{optName} has value in range [{MinValue}, {MaxValue}]."; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RequireOneOfOptionRequirement.cs b/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RequireOneOfOptionRequirement.cs deleted file mode 100644 index a481e10..0000000 --- a/src/EthernaGatewayCli/Models/Commands/OptionRequirements/RequireOneOfOptionRequirement.cs +++ /dev/null @@ -1,35 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Etherna.GatewayCli.Models.Commands.OptionRequirements -{ - public class RequireOneOfOptionRequirement(params string[] optionsNames) - : OptionRequirementBase(optionsNames) - { - public override string PrintHelpLine(CommandOptionsBase commandOptions) => - string.Join(", ", OptionsNames.Select(n => commandOptions.FindOptionByName(n).LongName)) + - (OptionsNames.Count == 1 ? " is required." : " at least one is required."); - - public override IEnumerable ValidateOptions( - CommandOptionsBase commandOptions, - IEnumerable parsedOptions) => - OptionsNames.Any(optName => TryFindParsedOption(parsedOptions, optName, out _)) ? - Array.Empty() : - [new OptionRequirementError(PrintHelpLine(commandOptions))]; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Commands/ParsedOption.cs b/src/EthernaGatewayCli/Models/Commands/ParsedOption.cs deleted file mode 100644 index d11e562..0000000 --- a/src/EthernaGatewayCli/Models/Commands/ParsedOption.cs +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System.Collections.Generic; -using System.Collections.ObjectModel; - -namespace Etherna.GatewayCli.Models.Commands -{ - public class ParsedOption( - CommandOption option, - string parsedName, - params string[] parsedArgs) - { - // Properties. - public CommandOption Option { get; } = option; - public ReadOnlyCollection ParsedArgs { get; } = parsedArgs.AsReadOnly(); - public string ParsedName { get; } = parsedName; - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/Domain/BzzBalance.cs b/src/EthernaGatewayCli/Models/Domain/BzzBalance.cs deleted file mode 100644 index d81d896..0000000 --- a/src/EthernaGatewayCli/Models/Domain/BzzBalance.cs +++ /dev/null @@ -1,89 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.Globalization; - -namespace Etherna.GatewayCli.Models.Domain -{ - public struct BzzBalance : IEquatable - { - // Consts. - public const int DecimalPrecision = 16; - - // Fields. - private readonly decimal _balance; - - // Constructors. - public BzzBalance(decimal balance) - { - _balance = decimal.Round(balance, DecimalPrecision) - / 1.000000000000000000000000000000000m; //remove final zeros - } - - // Methods. - public int CompareTo(BzzBalance other) => _balance.CompareTo(other._balance); - - public override bool Equals(object? obj) => - obj is BzzBalance xDaiObj && - Equals(xDaiObj); - - public bool Equals(BzzBalance other) => _balance == other._balance; - public BzzBalance FromDecimal(decimal value) => new(value); - public BzzBalance FromDouble(double value) => new((decimal)value); - public BzzBalance FromInt32(int value) => new(value); - public override int GetHashCode() => _balance.GetHashCode(); - public decimal ToDecimal() => _balance; - public override string ToString() => _balance.ToString(CultureInfo.InvariantCulture); - - // Static methods. - public static BzzBalance Add(BzzBalance left, BzzBalance right) => left + right; - public static BzzBalance Decrement(BzzBalance balance) => --balance; - public static BzzBalance Divide(BzzBalance left, BzzBalance right) => left / right; - public static BzzBalance Increment(BzzBalance balance) => ++balance; - public static BzzBalance Multiply(BzzBalance left, BzzBalance right) => left * right; - public static BzzBalance Negate(BzzBalance balance) => -balance; - public static BzzBalance Subtract(BzzBalance left, BzzBalance right) => left - right; - - // Operator methods. - public static BzzBalance operator +(BzzBalance left, BzzBalance right) => - new(left._balance + right._balance); - - public static BzzBalance operator -(BzzBalance left, BzzBalance right) => - new(left._balance - right._balance); - - public static BzzBalance operator *(BzzBalance left, BzzBalance right) => - new(left._balance * right._balance); - - public static BzzBalance operator /(BzzBalance left, BzzBalance right) => - new(left._balance / right._balance); - - public static bool operator ==(BzzBalance left, BzzBalance right) => left.Equals(right); - public static bool operator !=(BzzBalance left, BzzBalance right) => !(left == right); - public static bool operator >(BzzBalance left, BzzBalance right) => left._balance > right._balance; - public static bool operator <(BzzBalance left, BzzBalance right) => left._balance < right._balance; - public static bool operator >=(BzzBalance left, BzzBalance right) => left._balance >= right._balance; - public static bool operator <=(BzzBalance left, BzzBalance right) => left._balance <= right._balance; - public static BzzBalance operator -(BzzBalance value) => new(-value._balance); - public static BzzBalance operator ++(BzzBalance value) => new(value._balance + 1); - public static BzzBalance operator --(BzzBalance value) => new(value._balance - 1); - - // Implicit conversion operator methods. - public static implicit operator BzzBalance(decimal value) => new(value); - public static implicit operator BzzBalance(double value) => new((decimal)value); - public static implicit operator BzzBalance(int value) => new(value); - - public static explicit operator decimal(BzzBalance value) => value.ToDecimal(); - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Models/GitHubDto/GitReleaseVersionDto.cs b/src/EthernaGatewayCli/Models/GitHubDto/GitReleaseVersionDto.cs index 4d97cfe..53d9ce3 100644 --- a/src/EthernaGatewayCli/Models/GitHubDto/GitReleaseVersionDto.cs +++ b/src/EthernaGatewayCli/Models/GitHubDto/GitReleaseVersionDto.cs @@ -1,16 +1,16 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . using System; diff --git a/src/EthernaGatewayCli/Program.cs b/src/EthernaGatewayCli/Program.cs index b6b3aa3..97f02d4 100644 --- a/src/EthernaGatewayCli/Program.cs +++ b/src/EthernaGatewayCli/Program.cs @@ -1,20 +1,20 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . +using Etherna.CliHelper.Models.Commands; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Commands; -using Etherna.GatewayCli.Models.Commands; -using Etherna.GatewayCli.Services; using Etherna.Sdk.Users.Native; using Microsoft.Extensions.DependencyInjection; using System; diff --git a/src/EthernaGatewayCli/ServiceCollectionExtensions.cs b/src/EthernaGatewayCli/ServiceCollectionExtensions.cs index 5311d4d..df9c252 100644 --- a/src/EthernaGatewayCli/ServiceCollectionExtensions.cs +++ b/src/EthernaGatewayCli/ServiceCollectionExtensions.cs @@ -1,23 +1,22 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.BeeNet; -using Etherna.BeeNet.Clients.GatewayApi; +using Etherna.BeeNet.Services; +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Services; using Microsoft.Extensions.DependencyInjection; -using System; -using System.Net.Http; +using System.Reflection; namespace Etherna.GatewayCli { @@ -29,19 +28,12 @@ public static void AddCoreServices( // Add transient services. services.AddTransient(); services.AddTransient(); + services.AddTransient(); services.AddTransient(); services.AddTransient(); - + // Add singleton services. - //bee.net - services.AddSingleton((sp) => - { - var httpClientFactory = sp.GetRequiredService(); - return new BeeGatewayClient( - httpClientFactory.CreateClient(CommonConsts.HttpClientName), - new Uri(CommonConsts.EthernaGatewayUrl)); - }); - services.AddSingleton(); + services.AddSingleton(typeof(Program).GetTypeInfo().Assembly); } } } \ No newline at end of file diff --git a/src/EthernaGatewayCli/Services/AuthenticationService.cs b/src/EthernaGatewayCli/Services/AuthenticationService.cs index 22f5217..6870cfb 100644 --- a/src/EthernaGatewayCli/Services/AuthenticationService.cs +++ b/src/EthernaGatewayCli/Services/AuthenticationService.cs @@ -1,19 +1,20 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . using Etherna.Authentication; using Etherna.Authentication.Native; +using Etherna.CliHelper.Services; using System; using System.ComponentModel; using System.Threading.Tasks; diff --git a/src/EthernaGatewayCli/Services/ConsoleIoService.cs b/src/EthernaGatewayCli/Services/ConsoleIoService.cs deleted file mode 100644 index b818bb4..0000000 --- a/src/EthernaGatewayCli/Services/ConsoleIoService.cs +++ /dev/null @@ -1,47 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; - -namespace Etherna.GatewayCli.Services -{ - public class ConsoleIoService : IIoService - { - // Consts. - private const ConsoleColor ErrorForegroundColor = ConsoleColor.DarkRed; - - // Methods. - public ConsoleKeyInfo ReadKey() => Console.ReadKey(); - - public string? ReadLine() => Console.ReadLine(); - - public void Write(string? value) => Console.Write(value); - - public void WriteError(string value) - { - Console.ForegroundColor = ErrorForegroundColor; - Console.Write(value); - Console.ResetColor(); - } - - public void WriteErrorLine(string value) - { - Console.ForegroundColor = ErrorForegroundColor; - Console.WriteLine(value); - Console.ResetColor(); - } - - public void WriteLine(string? value = null) => Console.WriteLine(value); - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Services/FileService.cs b/src/EthernaGatewayCli/Services/FileService.cs index 6e9df66..044876c 100644 --- a/src/EthernaGatewayCli/Services/FileService.cs +++ b/src/EthernaGatewayCli/Services/FileService.cs @@ -1,16 +1,16 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . using Microsoft.AspNetCore.StaticFiles; using MimeDetective; diff --git a/src/EthernaGatewayCli/Services/GatewayService.cs b/src/EthernaGatewayCli/Services/GatewayService.cs index 753e241..3d7ac83 100644 --- a/src/EthernaGatewayCli/Services/GatewayService.cs +++ b/src/EthernaGatewayCli/Services/GatewayService.cs @@ -1,97 +1,112 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using Etherna.BeeNet.Clients.GatewayApi; -using Etherna.GatewayCli.Models.Domain; -using Etherna.Sdk.GeneratedClients.Gateway; -using Etherna.Sdk.Users; +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . + +using Etherna.BeeNet.Hasher.Postage; +using Etherna.BeeNet.Models; +using Etherna.BeeNet.Services; +using Etherna.CliHelper.Services; +using Etherna.Sdk.Common.GenClients.Gateway; +using Etherna.Sdk.Users.Clients; using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.IO; +using System.Linq; using System.Threading.Tasks; namespace Etherna.GatewayCli.Services { - public class GatewayService : IGatewayService + public class GatewayService( + ICalculatorService calculatorService, + IEthernaUserGatewayClient ethernaGatewayClient, + IFileService fileService, + IIoService ioService) + : IGatewayService { // Const. private readonly TimeSpan BatchCheckTimeSpan = new(0, 0, 0, 5); private readonly TimeSpan BatchCreationTimeout = new(0, 0, 10, 0); private readonly TimeSpan BatchUsableTimeout = new(0, 0, 10, 0); - private readonly long BzzDecimalPlacesToUnit = (long)Math.Pow(10, 16); - private const int ChunkByteSize = 4096; - private const int MinBatchDepth = 17; - - // Fields. - private readonly IBeeGatewayClient beeGatewayClient; - private readonly IEthernaUserGatewayClient ethernaGatewayClient; - private readonly IIoService ioService; - - // Constructor. - public GatewayService( - IBeeGatewayClient beeGatewayClient, - IEthernaUserGatewayClient ethernaGatewayClient, - IIoService ioService) - { - this.beeGatewayClient = beeGatewayClient; - this.ethernaGatewayClient = ethernaGatewayClient; - this.ioService = ioService; - } // Methods. - public async Task CalculateAmountAsync(TimeSpan ttl) - { - var currentPrice = await GetCurrentChainPriceAsync(); - return (long)(ttl.TotalSeconds * currentPrice / CommonConsts.GnosisBlockTime.TotalSeconds); - } + public async Task CalculatePostageBatchDepthAsync(Stream fileStream, string fileContentType, string fileName) => + (await calculatorService.EvaluateFileUploadAsync(fileStream, fileContentType, fileName)) + .RequiredPostageBatchDepth; - public BzzBalance CalculateBzzPrice(long amount, int depth) => - amount * Math.Pow(2, depth) / BzzDecimalPlacesToUnit; + public async Task CalculatePostageBatchDepthAsync(byte[] fileData, string fileContentType, string fileName) => + (await calculatorService.EvaluateFileUploadAsync(fileData, fileContentType, fileName)) + .RequiredPostageBatchDepth; - public int CalculateDepth(long contentByteSize) + [SuppressMessage("Performance", "CA1851:Possible multiple enumerations of \'IEnumerable\' collection")] + [SuppressMessage("ReSharper", "PossibleMultipleEnumeration")] + public async Task CalculatePostageBatchDepthAsync(IEnumerable paths) { - var batchDepth = 17; - while (Math.Pow(2, batchDepth) * ChunkByteSize < CalculateRequiredPostageBatchSpace(contentByteSize)) - batchDepth++; - return batchDepth; - } + ArgumentNullException.ThrowIfNull(paths, nameof(paths)); + if (!paths.Any()) + throw new ArgumentOutOfRangeException(nameof(paths), "Empty file paths"); + + ioService.Write("Calculating required postage batch depth... "); - public long CalculatePostageBatchByteSize(PostageBatchDto postageBatch) - { - ArgumentNullException.ThrowIfNull(postageBatch, nameof(postageBatch)); - return (long)Math.Pow(2, postageBatch.Depth) * ChunkByteSize; - } + var buckets = new uint[PostageBuckets.BucketsSize]; + var stampIssuer = new PostageStampIssuer(PostageBatch.MaxDepthInstance, buckets); + UploadEvaluationResult lastResult = null!; + foreach (var path in paths) + { + if (File.Exists(path)) //is a file + { + await using var fileStream = File.OpenRead(path); + var mimeType = fileService.GetMimeType(path); + var fileName = Path.GetFileName(path); + + lastResult = await calculatorService.EvaluateFileUploadAsync( + fileStream, + mimeType, + fileName, + postageStampIssuer: stampIssuer); + } + else if (Directory.Exists(path)) //is a directory + { + lastResult = await calculatorService.EvaluateDirectoryUploadAsync( + path, + postageStampIssuer: stampIssuer); + } + else //invalid path + throw new InvalidOperationException($"Path {path} is not valid"); + } + + ioService.WriteLine("Done"); - public long CalculateRequiredPostageBatchSpace(long contentByteSize) => - (long)(contentByteSize * 1.2); //keep 20% of tolerance + return lastResult.RequiredPostageBatchDepth; + } - public async Task CreatePostageBatchAsync(long amount, int batchDepth, string? label) + public async Task CreatePostageBatchAsync(BzzBalance amount, int batchDepth, string? label) { if (amount <= 0) throw new ArgumentException("Amount must be positive"); - if (batchDepth < MinBatchDepth) - throw new ArgumentException($"Postage depth must be at least {MinBatchDepth}"); + if (batchDepth < PostageBatch.MinDepth) + throw new ArgumentException($"Postage depth must be at least {PostageBatch.MinDepth}"); // Start creation. - var bzzPrice = CalculateBzzPrice(amount, batchDepth); - ioService.WriteLine($"Creating postage batch... Depth: {batchDepth}, Amount: {amount}, BZZ price: {bzzPrice}"); - var batchReferenceId = await ethernaGatewayClient.UsersClient.BatchesPostAsync(batchDepth, amount, label); + var bzzPrice = PostageBatch.CalculatePrice(amount, batchDepth); + ioService.WriteLine($"Creating postage batch... Depth: {batchDepth}, Amount: {amount.ToPlurString()}, BZZ price: {bzzPrice}"); + var batchReferenceId = await ethernaGatewayClient.BuyPostageBatchAsync(amount, batchDepth, label); // Wait until created batch is available. ioService.Write("Waiting for batch created... (it may take a while)"); var batchStartWait = DateTime.UtcNow; - string? batchId = null; + PostageBatchId? batchId = null; do { //timeout throw exception @@ -104,50 +119,60 @@ public async Task CreatePostageBatchAsync(long amount, int batchDepth, s try { - batchId = await ethernaGatewayClient.SystemClient.PostageBatchRefAsync(batchReferenceId); + batchId = await ethernaGatewayClient.TryGetNewPostageBatchIdFromPostageRefAsync(batchReferenceId); } catch (EthernaGatewayApiException) { //waiting for batchId available await Task.Delay(BatchCheckTimeSpan); } - } while (string.IsNullOrWhiteSpace(batchId)); + } while (!batchId.HasValue); ioService.WriteLine(". Done"); - await WaitForBatchUsableAsync(batchId); + await WaitForBatchUsableAsync(batchId.Value); - return batchId; + return batchId.Value; } - public Task FundResourcePinningAsync(string hash) => - ethernaGatewayClient.ResourcesClient.PinPostAsync(hash); + public Task FundResourceDownloadAsync(SwarmHash hash) => + ethernaGatewayClient.FundResourceDownloadAsync(hash); - public Task FundResourceTrafficAsync(string hash) => - ethernaGatewayClient.ResourcesClient.OffersPostAsync(hash); + public Task FundResourcePinningAsync(SwarmHash hash) => + ethernaGatewayClient.FundResourcePinningAsync(hash); - public async Task GetCurrentChainPriceAsync() => - (await ethernaGatewayClient.SystemClient.ChainstateAsync()).CurrentPrice; + public async Task GetChainPriceAsync() => + (await ethernaGatewayClient.GetChainStateAsync()).CurrentPrice; - public Task GetPostageBatchInfoAsync(string batchId) => - ethernaGatewayClient.UsersClient.BatchesGetAsync(batchId); + public Task GetPostageBatchInfoAsync(PostageBatchId batchId) => + ethernaGatewayClient.GetPostageBatchAsync(batchId); - public Task UploadFileAsync( - string postageBatchId, + public Task UploadFileAsync( + PostageBatchId batchId, Stream content, string? name, string? contentType, bool pinResource) => - beeGatewayClient.UploadFileAsync( - postageBatchId, + ethernaGatewayClient.UploadFileAsync( + batchId, content, name: name, contentType: contentType, swarmDeferredUpload: true, swarmPin: pinResource); + public Task UploadDirectoryAsync( + PostageBatchId batchId, + string directoryPath, + bool pinResource) => + ethernaGatewayClient.UploadDirectoryAsync( + batchId, + directoryPath, + swarmDeferredUpload: true, + swarmPin: pinResource); + // Helpers. - private async Task WaitForBatchUsableAsync(string batchId) + private async Task WaitForBatchUsableAsync(PostageBatchId batchId) { // Wait until created batch is usable. ioService.Write("Waiting for batch being usable... (it may take a while)"); @@ -164,7 +189,7 @@ private async Task WaitForBatchUsableAsync(string batchId) throw ex; } - batchIsUsable = (await GetPostageBatchInfoAsync(batchId)).Usable; + batchIsUsable = (await GetPostageBatchInfoAsync(batchId)).IsUsable; //waiting for batch usable await Task.Delay(BatchCheckTimeSpan); diff --git a/src/EthernaGatewayCli/Services/IAuthenticationService.cs b/src/EthernaGatewayCli/Services/IAuthenticationService.cs index c7b7540..429fec5 100644 --- a/src/EthernaGatewayCli/Services/IAuthenticationService.cs +++ b/src/EthernaGatewayCli/Services/IAuthenticationService.cs @@ -1,16 +1,16 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . using System.Threading.Tasks; diff --git a/src/EthernaGatewayCli/Services/IFileService.cs b/src/EthernaGatewayCli/Services/IFileService.cs index 28ab6b7..0acdb77 100644 --- a/src/EthernaGatewayCli/Services/IFileService.cs +++ b/src/EthernaGatewayCli/Services/IFileService.cs @@ -1,16 +1,16 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . namespace Etherna.GatewayCli.Services { diff --git a/src/EthernaGatewayCli/Services/IGatewayService.cs b/src/EthernaGatewayCli/Services/IGatewayService.cs index fca3630..85a2105 100644 --- a/src/EthernaGatewayCli/Services/IGatewayService.cs +++ b/src/EthernaGatewayCli/Services/IGatewayService.cs @@ -1,20 +1,19 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . -using Etherna.GatewayCli.Models.Domain; -using Etherna.Sdk.GeneratedClients.Gateway; -using System; +using Etherna.BeeNet.Models; +using System.Collections.Generic; using System.IO; using System.Threading.Tasks; @@ -22,21 +21,32 @@ namespace Etherna.GatewayCli.Services { public interface IGatewayService { - Task CalculateAmountAsync(TimeSpan ttl); - BzzBalance CalculateBzzPrice(long amount, int depth); - int CalculateDepth(long contentByteSize); - long CalculatePostageBatchByteSize(PostageBatchDto postageBatch); - long CalculateRequiredPostageBatchSpace(long contentByteSize); - Task CreatePostageBatchAsync(long amount, int batchDepth, string? label); - Task FundResourcePinningAsync(string hash); - Task FundResourceTrafficAsync(string hash); - Task GetCurrentChainPriceAsync(); - Task GetPostageBatchInfoAsync(string batchId); - Task UploadFileAsync( - string postageBatchId, + Task CalculatePostageBatchDepthAsync(Stream fileStream, string fileContentType, string fileName); + + Task CalculatePostageBatchDepthAsync(byte[] fileData, string fileContentType, string fileName); + + Task CalculatePostageBatchDepthAsync(IEnumerable paths); + + Task CreatePostageBatchAsync(BzzBalance amount, int batchDepth, string? label); + + Task FundResourceDownloadAsync(SwarmHash hash); + + Task FundResourcePinningAsync(SwarmHash hash); + + Task GetChainPriceAsync(); + + Task GetPostageBatchInfoAsync(PostageBatchId batchId); + + Task UploadFileAsync( + PostageBatchId batchId, Stream content, string? name, string? contentType, bool pinResource); + + Task UploadDirectoryAsync( + PostageBatchId batchId, + string directoryPath, + bool pinResource); } } \ No newline at end of file diff --git a/src/EthernaGatewayCli/Services/IIoService.cs b/src/EthernaGatewayCli/Services/IIoService.cs deleted file mode 100644 index 7b66049..0000000 --- a/src/EthernaGatewayCli/Services/IIoService.cs +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2024-present Etherna SA -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; - -namespace Etherna.GatewayCli.Services -{ - public interface IIoService - { - ConsoleKeyInfo ReadKey(); - string? ReadLine(); - void Write(string? value); - void WriteError(string value); - void WriteErrorLine(string value); - void WriteLine(string? value = null); - } -} \ No newline at end of file diff --git a/src/EthernaGatewayCli/Utilities/EthernaVersionControl.cs b/src/EthernaGatewayCli/Utilities/EthernaVersionControl.cs index d3bda7d..98b1e73 100644 --- a/src/EthernaGatewayCli/Utilities/EthernaVersionControl.cs +++ b/src/EthernaGatewayCli/Utilities/EthernaVersionControl.cs @@ -1,19 +1,19 @@ // Copyright 2024-present Etherna SA +// This file is part of Etherna Gateway CLI. // -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at +// Etherna Gateway CLI is free software: you can redistribute it and/or modify it under the terms of the +// GNU Affero General Public License as published by the Free Software Foundation, +// either version 3 of the License, or (at your option) any later version. // -// http://www.apache.org/licenses/LICENSE-2.0 +// Etherna Gateway CLI 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 Affero General Public License for more details. // -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +// You should have received a copy of the GNU Affero General Public License along with Etherna Gateway CLI. +// If not, see . +using Etherna.CliHelper.Services; using Etherna.GatewayCli.Models.GitHubDto; -using Etherna.GatewayCli.Services; using System; using System.Collections.Generic; using System.Diagnostics.CodeAnalysis;