rickub
julien/lovepublic Fork
⑂ c8588ca
Branches
1-add-main-logic 10-fix-weth-chain-allowlist 11-add-changelog-entry 12-add-networks-readme 13-add-supported-networks-doc 14-add-gas-in-love-note 17-add-batch-envelope-deposit 18-replace-envelopes-with-zk 19-add-anvil-e2e-test 2-multichain-check 20-add-mainnet-deployment-docs 21-add-first-op-flow-to-gas-note 3-peg-love-to-weth 5-weth-bytecode-verification 6-add-love-envelope 7-add-docs 8-fix-secrethash-zero 9-add-changelog-entry main View all branches → View all tags →
Commits
⬇ Clone ▾
git clone https://git.rickub.com/julien/love.git
git clone ssh://git@rickub.com/julien/love.git

Host key fingerprint (ed25519): SHA256:iycHnxEyq0Q7uyVpB7JlznP0G7JrTPXLYRcAU5CSLhc — verify it before your first connect.

Download ZIP

Merge 14-add-gas-in-love-note into main

rickub committed 2026-09-18T20:13:21Z Browse files
c8588ca parent: 6e1128e
modified CHANGELOG.md +4 -0
@@ -54,6 +54,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5454
5555 ### Added
5656
57+- `LICENSE`, the GPL-3.0 text the README already named, so the terms ship with
58+ the repository rather than only being asserted.
59+- A "Docs" section in the README linking `docs/MULTICHAIN.md`,
60+ `docs/PRIVACY.md` and `docs/SUPPORTED_NETWORKS.md`, just before "License".
5761 - `docs/SUPPORTED_NETWORKS.md`, listing the 14 chains the allowlist covers and
5862 the 2026-09-18 survey of other candidates. Six OP Stack chains (Orderly, Lyra,
5963 Shape, Swan Chain, HashKey Chain, Settlus) run a reviewed hash and only need
@@ -54,6 +54,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
54 54
55 ### Added55 ### Added
56 56
57+- `LICENSE`, the GPL-3.0 text the README already named, so the terms ship with
58+ the repository rather than only being asserted.
59+- A "Docs" section in the README linking `docs/MULTICHAIN.md`,
60+ `docs/PRIVACY.md` and `docs/SUPPORTED_NETWORKS.md`, just before "License".
57 - `docs/SUPPORTED_NETWORKS.md`, listing the 14 chains the allowlist covers and61 - `docs/SUPPORTED_NETWORKS.md`, listing the 14 chains the allowlist covers and
58 the 2026-09-18 survey of other candidates. Six OP Stack chains (Orderly, Lyra,62 the 2026-09-18 survey of other candidates. Six OP Stack chains (Orderly, Lyra,
59 Shape, Swan Chain, HashKey Chain, Settlus) run a reviewed hash and only need63 Shape, Swan Chain, HashKey Chain, Settlus) run a reviewed hash and only need
added LICENSE +673 -0
new file mode 100644
@@ -0,0 +1,673 @@
1+GNU GENERAL PUBLIC LICENSE
2+Version 3, 29 June 2007
3+
4+Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+Everyone is permitted to copy and distribute verbatim copies
6+of this license document, but changing it is not allowed.
7+
8+ Preamble
9+
10+The GNU General Public License is a free, copyleft license for
11+software and other kinds of works.
12+
13+The licenses for most software and other practical works are designed
14+to take away your freedom to share and change the works. By contrast,
15+the GNU General Public License is intended to guarantee your freedom to
16+share and change all versions of a program--to make sure it remains free
17+software for all its users. We, the Free Software Foundation, use the
18+GNU General Public License for most of our software; it applies also to
19+any other work released this way by its authors. You can apply it to
20+your programs, too.
21+
22+When we speak of free software, we are referring to freedom, not
23+price. Our General Public Licenses are designed to make sure that you
24+have the freedom to distribute copies of free software (and charge for
25+them if you wish), that you receive source code or can get it if you
26+want it, that you can change the software or use pieces of it in new
27+free programs, and that you know you can do these things.
28+
29+To protect your rights, we need to prevent others from denying you
30+these rights or asking you to surrender the rights. Therefore, you have
31+certain responsibilities if you distribute copies of the software, or if
32+you modify it: responsibilities to respect the freedom of others.
33+
34+For example, if you distribute copies of such a program, whether
35+gratis or for a fee, you must pass on to the recipients the same
36+freedoms that you received. You must make sure that they, too, receive
37+or can get the source code. And you must show them these terms so they
38+know their rights.
39+
40+Developers that use the GNU GPL protect your rights with two steps:
41+(1) assert copyright on the software, and (2) offer you this License
42+giving you legal permission to copy, distribute and/or modify it.
43+
44+For the developers' and authors' protection, the GPL clearly explains
45+that there is no warranty for this free software. For both users' and
46+authors' sake, the GPL requires that modified versions be marked as
47+changed, so that their problems will not be attributed erroneously to
48+authors of previous versions.
49+
50+Some devices are designed to deny users access to install or run
51+modified versions of the software inside them, although the manufacturer
52+can do so. This is fundamentally incompatible with the aim of
53+protecting users' freedom to change the software. The systematic
54+pattern of such abuse occurs in the area of products for individuals to
55+use, which is precisely where it is most unacceptable. Therefore, we
56+have designed this version of the GPL to prohibit the practice for those
57+products. If such problems arise substantially in other domains, we
58+stand ready to extend this provision to those domains in future versions
59+of the GPL, as needed to protect the freedom of users.
60+
61+Finally, every program is threatened constantly by software patents.
62+States should not allow patents to restrict development and use of
63+software on general-purpose computers, but in those that do, we wish to
64+avoid the special danger that patents applied to a free program could
65+make it effectively proprietary. To prevent this, the GPL assures that
66+patents cannot be used to render the program non-free.
67+
68+The precise terms and conditions for copying, distribution and
69+modification follow.
70+
71+TERMS AND CONDITIONS
72+
73+0. Definitions.
74+
75+"This License" refers to version 3 of the GNU General Public License.
76+
77+"Copyright" also means copyright-like laws that apply to other kinds of
78+works, such as semiconductor masks.
79+
80+"The Program" refers to any copyrightable work licensed under this
81+License. Each licensee is addressed as "you". "Licensees" and
82+"recipients" may be individuals or organizations.
83+
84+To "modify" a work means to copy from or adapt all or part of the work
85+in a fashion requiring copyright permission, other than the making of an
86+exact copy. The resulting work is called a "modified version" of the
87+earlier work or a work "based on" the earlier work.
88+
89+A "covered work" means either the unmodified Program or a work based
90+on the Program.
91+
92+To "propagate" a work means to do anything with it that, without
93+permission, would make you directly or secondarily liable for
94+infringement under applicable copyright law, except executing it on a
95+computer or modifying a private copy. Propagation includes copying,
96+distribution (with or without modification), making available to the
97+public, and in some countries other activities as well.
98+
99+To "convey" a work means any kind of propagation that enables other
100+parties to make or receive copies. Mere interaction with a user through
101+a computer network, with no transfer of a copy, is not conveying.
102+
103+An interactive user interface displays "Appropriate Legal Notices"
104+to the extent that it includes a convenient and prominently visible
105+feature that (1) displays an appropriate copyright notice, and (2)
106+tells the user that there is no warranty for the work (except to the
107+extent that warranties are provided), that licensees may convey the
108+work under this License, and how to view a copy of this License. If
109+the interface presents a list of user commands or options, such as a
110+menu, a prominent item in the list meets this criterion.
111+
112+1. Source Code.
113+
114+The "source code" for a work means the preferred form of the work
115+for making modifications to it. "Object code" means any non-source
116+form of a work.
117+
118+A "Standard Interface" means an interface that either is an official
119+standard defined by a recognized standards body, or, in the case of
120+interfaces specified for a particular programming language, one that
121+is widely used among developers working in that language.
122+
123+The "System Libraries" of an executable work include anything, other
124+than the work as a whole, that (a) is included in the normal form of
125+packaging a Major Component, but which is not part of that Major
126+Component, and (b) serves only to enable use of the work with that
127+Major Component, or to implement a Standard Interface for which an
128+implementation is available to the public in source code form. A
129+"Major Component", in this context, means a major essential component
130+(kernel, window system, and so on) of the specific operating system
131+(if any) on which the executable work runs, or a compiler used to
132+produce the work, or an object code interpreter used to run it.
133+
134+The "Corresponding Source" for a work in object code form means all
135+the source code needed to generate, install, and (for an executable
136+work) run the object code and to modify the work, including scripts to
137+control those activities. However, it does not include the work's
138+System Libraries, or general-purpose tools or generally available free
139+programs which are used unmodified in performing those activities but
140+which are not part of the work. For example, Corresponding Source
141+includes interface definition files associated with source files for
142+the work, and the source code for shared libraries and dynamically
143+linked subprograms that the work is specifically designed to require,
144+such as by intimate data communication or control flow between those
145+subprograms and other parts of the work.
146+
147+The Corresponding Source need not include anything that users
148+can regenerate automatically from other parts of the Corresponding
149+Source.
150+
151+The Corresponding Source for a work in source code form is that
152+same work.
153+
154+2. Basic Permissions.
155+
156+All rights granted under this License are granted for the term of
157+copyright on the Program, and are irrevocable provided the stated
158+conditions are met. This License explicitly affirms your unlimited
159+permission to run the unmodified Program. The output from running a
160+covered work is covered by this License only if the output, given its
161+content, constitutes a covered work. This License acknowledges your
162+rights of fair use or other equivalent, as provided by copyright law.
163+
164+You may make, run and propagate covered works that you do not
165+convey, without conditions so long as your license otherwise remains
166+in force. You may convey covered works to others for the sole purpose
167+of having them make modifications exclusively for you, or provide you
168+with facilities for running those works, provided that you comply with
169+the terms of this License in conveying all material for which you do
170+not control copyright. Those thus making or running the covered works
171+for you must do so exclusively on your behalf, under your direction
172+and control, on terms that prohibit them from making any copies of
173+your copyrighted material outside their relationship with you.
174+
175+Conveying under any other circumstances is permitted solely under
176+the conditions stated below. Sublicensing is not allowed; section 10
177+makes it unnecessary.
178+
179+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180+
181+No covered work shall be deemed part of an effective technological
182+measure under any applicable law fulfilling obligations under article
183+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184+similar laws prohibiting or restricting circumvention of such
185+measures.
186+
187+When you convey a covered work, you waive any legal power to forbid
188+circumvention of technological measures to the extent such circumvention
189+is effected by exercising rights under this License with respect to
190+the covered work, and you disclaim any intention to limit operation or
191+modification of the work as a means of enforcing, against the work's
192+users, your or third parties' legal rights to forbid circumvention of
193+technological measures.
194+
195+4. Conveying Verbatim Copies.
196+
197+You may convey verbatim copies of the Program's source code as you
198+receive it, in any medium, provided that you conspicuously and
199+appropriately publish on each copy an appropriate copyright notice;
200+keep intact all notices stating that this License and any
201+non-permissive terms added in accord with section 7 apply to the code;
202+keep intact all notices of the absence of any warranty; and give all
203+recipients a copy of this License along with the Program.
204+
205+You may charge any price or no price for each copy that you convey,
206+and you may offer support or warranty protection for a fee.
207+
208+5. Conveying Modified Source Versions.
209+
210+You may convey a work based on the Program, or the modifications to
211+produce it from the Program, in the form of source code under the
212+terms of section 4, provided that you also meet all of these conditions:
213+
214+a) The work must carry prominent notices stating that you modified
215+it, and giving a relevant date.
216+
217+b) The work must carry prominent notices stating that it is
218+released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to
219+"keep intact all notices".
220+
221+c) You must license the entire work, as a whole, under this
222+License to anyone who comes into possession of a copy. This
223+License will therefore apply, along with any applicable section 7
224+additional terms, to the whole of the work, and all its parts,
225+regardless of how they are packaged. This License gives no
226+permission to license the work in any other way, but it does not
227+invalidate such permission if you have separately received it.
228+
229+d) If the work has interactive user interfaces, each must display
230+Appropriate Legal Notices; however, if the Program has interactive
231+interfaces that do not display Appropriate Legal Notices, your
232+work need not make them do so.
233+
234+A compilation of a covered work with other separate and independent
235+works, which are not by their nature extensions of the covered work,
236+and which are not combined with it such as to form a larger program,
237+in or on a volume of a storage or distribution medium, is called an
238+"aggregate" if the compilation and its resulting copyright are not
239+used to limit the access or legal rights of the compilation's users
240+beyond what the individual works permit. Inclusion of a covered work
241+in an aggregate does not cause this License to apply to the other
242+parts of the aggregate.
243+
244+6. Conveying Non-Source Forms.
245+
246+You may convey a covered work in object code form under the terms
247+of sections 4 and 5, provided that you also convey the
248+machine-readable Corresponding Source under the terms of this License,
249+in one of these ways:
250+
251+a) Convey the object code in, or embodied in, a physical product
252+(including a physical distribution medium), accompanied by the
253+Corresponding Source fixed on a durable physical medium
254+customarily used for software interchange.
255+
256+b) Convey the object code in, or embodied in, a physical product
257+(including a physical distribution medium), accompanied by a
258+written offer, valid for at least three years and valid for as
259+long as you offer spare parts or customer support for that product
260+model, to give anyone who possesses the object code either (1) a
261+copy of the Corresponding Source for all the software in the
262+product that is covered by this License, on a durable physical
263+medium customarily used for software interchange, for a price no
264+more than your reasonable cost of physically performing this
265+conveying of source, or (2) access to copy the
266+Corresponding Source from a network server at no charge.
267+
268+c) Convey individual copies of the object code with a copy of the
269+written offer to provide the Corresponding Source. This
270+alternative is allowed only occasionally and noncommercially, and
271+only if you received the object code with such an offer, in accord
272+with subsection 6b.
273+
274+d) Convey the object code by offering access from a designated
275+place (gratis or for a charge), and offer equivalent access to the
276+Corresponding Source in the same way through the same place at no
277+further charge. You need not require recipients to copy the
278+Corresponding Source along with the object code. If the place to
279+copy the object code is a network server, the Corresponding Source
280+may be on a different server (operated by you or a third party)
281+that supports equivalent copying facilities, provided you maintain
282+clear directions next to the object code saying where to find the
283+Corresponding Source. Regardless of what server hosts the
284+Corresponding Source, you remain obligated to ensure that it is
285+available for as long as needed to satisfy these requirements.
286+
287+e) Convey the object code using peer-to-peer transmission, provided
288+you inform other peers where the object code and Corresponding
289+Source of the work are being offered to the general public at no
290+charge under subsection 6d.
291+
292+A separable portion of the object code, whose source code is excluded
293+from the Corresponding Source as a System Library, need not be
294+included in conveying the object code work.
295+
296+A "User Product" is either (1) a "consumer product", which means any
297+tangible personal property which is normally used for personal, family,
298+or household purposes, or (2) anything designed or sold for incorporation
299+into a dwelling. In determining whether a product is a consumer product,
300+doubtful cases shall be resolved in favor of coverage. For a particular
301+product received by a particular user, "normally used" refers to a
302+typical or common use of that class of product, regardless of the status
303+of the particular user or of the way in which the particular user
304+actually uses, or expects or is expected to use, the product. A product
305+is a consumer product regardless of whether the product has substantial
306+commercial, industrial or non-consumer uses, unless such uses represent
307+the only significant mode of use of the product.
308+
309+"Installation Information" for a User Product means any methods,
310+procedures, authorization keys, or other information required to install
311+and execute modified versions of a covered work in that User Product from
312+a modified version of its Corresponding Source. The information must
313+suffice to ensure that the continued functioning of the modified object
314+code is in no case prevented or interfered with solely because
315+modification has been made.
316+
317+If you convey an object code work under this section in, or with, or
318+specifically for use in, a User Product, and the conveying occurs as
319+part of a transaction in which the right of possession and use of the
320+User Product is transferred to the recipient in perpetuity or for a
321+fixed term (regardless of how the transaction is characterized), the
322+Corresponding Source conveyed under this section must be accompanied
323+by the Installation Information. But this requirement does not apply
324+if neither you nor any third party retains the ability to install
325+modified object code on the User Product (for example, the work has
326+been installed in ROM).
327+
328+The requirement to provide Installation Information does not include a
329+requirement to continue to provide support service, warranty, or updates
330+for a work that has been modified or installed by the recipient, or for
331+the User Product in which it has been modified or installed. Access to a
332+network may be denied when the modification itself materially and
333+adversely affects the operation of the network or violates the rules and
334+protocols for communication across the network.
335+
336+Corresponding Source conveyed, and Installation Information provided,
337+in accord with this section must be in a format that is publicly
338+documented (and with an implementation available to the public in
339+source code form), and must require no special password or key for
340+unpacking, reading or copying.
341+
342+7. Additional Terms.
343+
344+"Additional permissions" are terms that supplement the terms of this
345+License by making exceptions from one or more of its conditions.
346+Additional permissions that are applicable to the entire Program shall
347+be treated as though they were included in this License, to the extent
348+that they are valid under applicable law. If additional permissions
349+apply only to part of the Program, that part may be used separately
350+under those permissions, but the entire Program remains governed by
351+this License without regard to the additional permissions.
352+
353+When you convey a copy of a covered work, you may at your option
354+remove any additional permissions from that copy, or from any part of
355+it. (Additional permissions may be written to require their own
356+removal in certain cases when you modify the work.) You may place
357+additional permissions on material, added by you to a covered work,
358+for which you have or can give appropriate copyright permission.
359+
360+Notwithstanding any other provision of this License, for material you
361+add to a covered work, you may (if authorized by the copyright holders of
362+that material) supplement the terms of this License with terms:
363+
364+a) Disclaiming warranty or limiting liability differently from the
365+terms of sections 15 and 16 of this License; or
366+
367+b) Requiring preservation of specified reasonable legal notices or
368+author attributions in that material or in the Appropriate Legal
369+Notices displayed by works containing it; or
370+
371+c) Prohibiting misrepresentation of the origin of that material, or
372+requiring that modified versions of such material be marked in
373+reasonable ways as different from the original version; or
374+
375+d) Limiting the use for publicity purposes of names of licensors or
376+authors of the material; or
377+
378+e) Declining to grant rights under trademark law for use of some
379+trade names, trademarks, or service marks; or
380+
381+f) Requiring indemnification of licensors and authors of that
382+material by anyone who conveys the material (or modified versions of
383+it) with contractual assumptions of liability to the recipient, for
384+any liability that these contractual assumptions directly impose on
385+those licensors and authors.
386+
387+All other non-permissive additional terms are considered "further
388+restrictions" within the meaning of section 10. If the Program as you
389+received it, or any part of it, contains a notice stating that it is
390+governed by this License along with a term that is a further
391+restriction, you may remove that term. If a license document contains
392+a further restriction but permits relicensing or conveying under this
393+License, you may add to a covered work material governed by the terms
394+of that license document, provided that the further restriction does
395+not survive such relicensing or conveying.
396+
397+If you add terms to a covered work in accord with this section, you
398+must place, in the relevant source files, a statement of the
399+additional terms that apply to those files, or a notice indicating
400+where to find the applicable terms.
401+
402+Additional terms, permissive or non-permissive, may be stated in the
403+form of a separately written license, or stated as exceptions;
404+the above requirements apply either way.
405+
406+8. Termination.
407+
408+You may not propagate or modify a covered work except as expressly
409+provided under this License. Any attempt otherwise to propagate or
410+modify it is void, and will automatically terminate your rights under
411+this License (including any patent licenses granted under the third
412+paragraph of section 11).
413+
414+However, if you cease all violation of this License, then your
415+license from a particular copyright holder is reinstated (a)
416+provisionally, unless and until the copyright holder explicitly and
417+finally terminates your license, and (b) permanently, if the copyright
418+holder fails to notify you of the violation by some reasonable means
419+prior to 60 days after the cessation.
420+
421+Moreover, your license from a particular copyright holder is
422+reinstated permanently if the copyright holder notifies you of the
423+violation by some reasonable means, this is the first time you have
424+received notice of violation of this License (for any work) from that
425+copyright holder, and you cure the violation prior to 30 days after
426+your receipt of the notice.
427+
428+Termination of your rights under this section does not terminate the
429+licenses of parties who have received copies or rights from you under
430+this License. If your rights have been terminated and not permanently
431+reinstated, you do not qualify to receive new licenses for the same
432+material under section 10.
433+
434+9. Acceptance Not Required for Having Copies.
435+
436+You are not required to accept this License in order to receive or
437+run a copy of the Program. Ancillary propagation of a covered work
438+occurring solely as a consequence of using peer-to-peer transmission
439+to receive a copy likewise does not require acceptance. However,
440+nothing other than this License grants you permission to propagate or
441+modify any covered work. These actions infringe copyright if you do
442+not accept this License. Therefore, by modifying or propagating a
443+covered work, you indicate your acceptance of this License to do so.
444+
445+10. Automatic Licensing of Downstream Recipients.
446+
447+Each time you convey a covered work, the recipient automatically
448+receives a license from the original licensors, to run, modify and
449+propagate that work, subject to this License. You are not responsible
450+for enforcing compliance by third parties with this License.
451+
452+An "entity transaction" is a transaction transferring control of an
453+organization, or substantially all assets of one, or subdividing an
454+organization, or merging organizations. If propagation of a covered
455+work results from an entity transaction, each party to that
456+transaction who receives a copy of the work also receives whatever
457+licenses to the work the party's predecessor in interest had or could
458+give under the previous paragraph, plus a right to possession of the
459+Corresponding Source of the work from the predecessor in interest, if
460+the predecessor has it or can get it with reasonable efforts.
461+
462+You may not impose any further restrictions on the exercise of the
463+rights granted or affirmed under this License. For example, you may
464+not impose a license fee, royalty, or other charge for exercise of
465+rights granted under this License, and you may not initiate litigation
466+(including a cross-claim or counterclaim in a lawsuit) alleging that
467+any patent claim is infringed by making, using, selling, offering for
468+sale, or importing the Program or any portion of it.
469+
470+11. Patents.
471+
472+A "contributor" is a copyright holder who authorizes use under this
473+License of the Program or a work on which the Program is based. The
474+work thus licensed is called the contributor's "contributor version".
475+
476+A contributor's "essential patent claims" are all patent claims
477+owned or controlled by the contributor, whether already acquired or
478+hereafter acquired, that would be infringed by some manner, permitted
479+by this License, of making, using, or selling its contributor version,
480+but do not include claims that would be infringed only as a
481+consequence of further modification of the contributor version. For
482+purposes of this definition, "control" includes the right to grant
483+patent sublicenses in a manner consistent with the requirements of
484+this License.
485+
486+Each contributor grants you a non-exclusive, worldwide, royalty-free
487+patent license under the contributor's essential patent claims, to
488+make, use, sell, offer for sale, import and otherwise run, modify and
489+propagate the contents of its contributor version.
490+
491+In the following three paragraphs, a "patent license" is any express
492+agreement or commitment, however denominated, not to enforce a patent
493+(such as an express permission to practice a patent or covenant not to
494+sue for patent infringement). To "grant" such a patent license to a
495+party means to make such an agreement or commitment not to enforce a
496+patent against the party.
497+
498+If you convey a covered work, knowingly relying on a patent license,
499+and the Corresponding Source of the work is not available for anyone
500+to copy, free of charge and under the terms of this License, through a
501+publicly available network server or other readily accessible means,
502+then you must either (1) cause the Corresponding Source to be so
503+available, or (2) arrange to deprive yourself of the benefit of the
504+patent license for this particular work, or (3) arrange, in a manner
505+consistent with the requirements of this License, to extend the patent
506+license to downstream recipients. "Knowingly relying" means you have
507+actual knowledge that, but for the patent license, your conveying the
508+covered work in a country, or your recipient's use of the covered work
509+in a country, would infringe one or more identifiable patents in that
510+country that you have reason to believe are valid.
511+
512+If, pursuant to or in connection with a single transaction or
513+arrangement, you convey, or propagate by procuring conveyance of, a
514+covered work, and grant a patent license to some of the parties
515+receiving the covered work authorizing them to use, propagate, modify
516+or convey a specific copy of the covered work, then the patent license
517+you grant is automatically extended to all recipients of the covered
518+work and works based on it.
519+
520+A patent license is "discriminatory" if it does not include within
521+the scope of its coverage, prohibits the exercise of, or is
522+conditioned on the non-exercise of one or more of the rights that are
523+specifically granted under this License. You may not convey a covered
524+work if you are a party to an arrangement with a third party that is
525+in the business of distributing software, under which you make payment
526+to the third party based on the extent of your activity of conveying
527+the work, and under which the third party grants, to any of the
528+parties who would receive the covered work from you, a discriminatory
529+patent license (a) in connection with copies of the covered work
530+conveyed by you (or copies made from those copies), or (b) primarily
531+for and in connection with specific products or compilations that
532+contain the covered work, unless you entered into that arrangement,
533+or that patent license was granted, prior to 28 March 2007.
534+
535+Nothing in this License shall be construed as excluding or limiting
536+any implied license or other defenses to infringement that may
537+otherwise be available to you under applicable patent law.
538+
539+12. No Surrender of Others' Freedom.
540+
541+If conditions are imposed on you (whether by court order, agreement or
542+otherwise) that contradict the conditions of this License, they do not
543+excuse you from the conditions of this License. If you cannot convey a
544+covered work so as to satisfy simultaneously your obligations under this
545+License and any other pertinent obligations, then as a consequence you may
546+not convey it at all. For example, if you agree to terms that obligate you
547+to collect a royalty for further conveying from those to whom you convey
548+the Program, the only way you could satisfy both those terms and this
549+License would be to refrain entirely from conveying the Program.
550+
551+13. Use with the GNU Affero General Public License.
552+
553+Notwithstanding any other provision of this License, you have
554+permission to link or combine any covered work with a work licensed
555+under version 3 of the GNU Affero General Public License into a single
556+combined work, and to convey the resulting work. The terms of this
557+License will continue to apply to the part which is the covered work,
558+but the special requirements of the GNU Affero General Public License,
559+section 13, concerning interaction through a network will apply to the
560+combination as such.
561+
562+14. Revised Versions of this License.
563+
564+The Free Software Foundation may publish revised and/or new versions of
565+the GNU General Public License from time to time. Such new versions will
566+be similar in spirit to the present version, but may differ in detail to
567+address new problems or concerns.
568+
569+Each version is given a distinguishing version number. If the
570+Program specifies that a certain numbered version of the GNU General
571+Public License "or any later version" applies to it, you have the
572+option of following the terms and conditions either of that numbered
573+version or of any later version published by the Free Software
574+Foundation. If the Program does not specify a version number of the
575+GNU General Public License, you may choose any version ever published
576+by the Free Software Foundation.
577+
578+If the Program specifies that a proxy can decide which future
579+versions of the GNU General Public License can be used, that proxy's
580+public statement of acceptance of a version permanently authorizes you
581+to choose that version for the Program.
582+
583+Later license versions may give you additional or different
584+permissions. However, no additional obligations are imposed on any
585+author or copyright holder as a result of your choosing to follow a
586+later version.
587+
588+15. Disclaimer of Warranty.
589+
590+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
591+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
592+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
593+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
594+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
595+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
596+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
597+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
598+
599+16. Limitation of Liability.
600+
601+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
602+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
603+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
604+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
605+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
606+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
607+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
608+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
609+SUCH DAMAGES.
610+
611+17. Interpretation of Sections 15 and 16.
612+
613+If the disclaimer of warranty and limitation of liability provided
614+above cannot be given local legal effect according to their terms,
615+reviewing courts shall apply local law that most closely approximates
616+an absolute waiver of all civil liability in connection with the
617+Program, unless a warranty or assumption of liability accompanies a
618+copy of the Program in return for a fee.
619+
620+END OF TERMS AND CONDITIONS
621+
622+How to Apply These Terms to Your New Programs
623+
624+If you develop a new program, and you want it to be of the greatest
625+possible use to the public, the best way to achieve this is to make it
626+free software which everyone can redistribute and change under these terms.
627+
628+To do so, attach the following notices to the program. It is safest
629+to attach them to the start of each source file to most effectively
630+state the exclusion of warranty; and each file should have at least
631+the "copyright" line and a pointer to where the full notice is found.
632+
633+<one line to give the program's name and a brief idea of what it does.>
634+Copyright (C) <year> <name of author>
635+
636+This program is free software: you can redistribute it and/or modify
637+it under the terms of the GNU General Public License as published by
638+the Free Software Foundation, either version 3 of the License, or
639+(at your option) any later version.
640+
641+This program is distributed in the hope that it will be useful,
642+but WITHOUT ANY WARRANTY; without even the implied warranty of
643+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644+GNU General Public License for more details.
645+
646+You should have received a copy of the GNU General Public License
647+along with this program. If not, see <https://www.gnu.org/licenses/>.
648+
649+Also add information on how to contact you by electronic and paper mail.
650+
651+If the program does terminal interaction, make it output a short
652+notice like this when it starts in an interactive mode:
653+
654+<program> Copyright (C) <year> <name of author>
655+This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
656+This is free software, and you are welcome to redistribute it
657+under certain conditions; type `show c' for details.
658+
659+The hypothetical commands `show w' and `show c' should show the appropriate
660+parts of the General Public License. Of course, your program's commands
661+might be different; for a GUI interface, you would use an "about box".
662+
663+You should also get your employer (if you work as a programmer) or school,
664+if any, to sign a "copyright disclaimer" for the program, if necessary.
665+For more information on this, and how to apply and follow the GNU GPL, see
666+<https://www.gnu.org/licenses/>.
667+
668+The GNU General Public License does not permit incorporating your program
669+into proprietary programs. If your program is a subroutine library, you
670+may consider it more useful to permit linking proprietary applications with
671+the library. If this is what you want to do, use the GNU Lesser General
672+Public License instead of this License. But first, please read
673+<https://www.gnu.org/licenses/why-not-lgpl.html>.
\ No newline at end of file
new file mode 100644
@@ -0,0 +1,673 @@
1+GNU GENERAL PUBLIC LICENSE
2+Version 3, 29 June 2007
3+
4+Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+Everyone is permitted to copy and distribute verbatim copies
6+of this license document, but changing it is not allowed.
7+
8+ Preamble
9+
10+The GNU General Public License is a free, copyleft license for
11+software and other kinds of works.
12+
13+The licenses for most software and other practical works are designed
14+to take away your freedom to share and change the works. By contrast,
15+the GNU General Public License is intended to guarantee your freedom to
16+share and change all versions of a program--to make sure it remains free
17+software for all its users. We, the Free Software Foundation, use the
18+GNU General Public License for most of our software; it applies also to
19+any other work released this way by its authors. You can apply it to
20+your programs, too.
21+
22+When we speak of free software, we are referring to freedom, not
23+price. Our General Public Licenses are designed to make sure that you
24+have the freedom to distribute copies of free software (and charge for
25+them if you wish), that you receive source code or can get it if you
26+want it, that you can change the software or use pieces of it in new
27+free programs, and that you know you can do these things.
28+
29+To protect your rights, we need to prevent others from denying you
30+these rights or asking you to surrender the rights. Therefore, you have
31+certain responsibilities if you distribute copies of the software, or if
32+you modify it: responsibilities to respect the freedom of others.
33+
34+For example, if you distribute copies of such a program, whether
35+gratis or for a fee, you must pass on to the recipients the same
36+freedoms that you received. You must make sure that they, too, receive
37+or can get the source code. And you must show them these terms so they
38+know their rights.
39+
40+Developers that use the GNU GPL protect your rights with two steps:
41+(1) assert copyright on the software, and (2) offer you this License
42+giving you legal permission to copy, distribute and/or modify it.
43+
44+For the developers' and authors' protection, the GPL clearly explains
45+that there is no warranty for this free software. For both users' and
46+authors' sake, the GPL requires that modified versions be marked as
47+changed, so that their problems will not be attributed erroneously to
48+authors of previous versions.
49+
50+Some devices are designed to deny users access to install or run
51+modified versions of the software inside them, although the manufacturer
52+can do so. This is fundamentally incompatible with the aim of
53+protecting users' freedom to change the software. The systematic
54+pattern of such abuse occurs in the area of products for individuals to
55+use, which is precisely where it is most unacceptable. Therefore, we
56+have designed this version of the GPL to prohibit the practice for those
57+products. If such problems arise substantially in other domains, we
58+stand ready to extend this provision to those domains in future versions
59+of the GPL, as needed to protect the freedom of users.
60+
61+Finally, every program is threatened constantly by software patents.
62+States should not allow patents to restrict development and use of
63+software on general-purpose computers, but in those that do, we wish to
64+avoid the special danger that patents applied to a free program could
65+make it effectively proprietary. To prevent this, the GPL assures that
66+patents cannot be used to render the program non-free.
67+
68+The precise terms and conditions for copying, distribution and
69+modification follow.
70+
71+TERMS AND CONDITIONS
72+
73+0. Definitions.
74+
75+"This License" refers to version 3 of the GNU General Public License.
76+
77+"Copyright" also means copyright-like laws that apply to other kinds of
78+works, such as semiconductor masks.
79+
80+"The Program" refers to any copyrightable work licensed under this
81+License. Each licensee is addressed as "you". "Licensees" and
82+"recipients" may be individuals or organizations.
83+
84+To "modify" a work means to copy from or adapt all or part of the work
85+in a fashion requiring copyright permission, other than the making of an
86+exact copy. The resulting work is called a "modified version" of the
87+earlier work or a work "based on" the earlier work.
88+
89+A "covered work" means either the unmodified Program or a work based
90+on the Program.
91+
92+To "propagate" a work means to do anything with it that, without
93+permission, would make you directly or secondarily liable for
94+infringement under applicable copyright law, except executing it on a
95+computer or modifying a private copy. Propagation includes copying,
96+distribution (with or without modification), making available to the
97+public, and in some countries other activities as well.
98+
99+To "convey" a work means any kind of propagation that enables other
100+parties to make or receive copies. Mere interaction with a user through
101+a computer network, with no transfer of a copy, is not conveying.
102+
103+An interactive user interface displays "Appropriate Legal Notices"
104+to the extent that it includes a convenient and prominently visible
105+feature that (1) displays an appropriate copyright notice, and (2)
106+tells the user that there is no warranty for the work (except to the
107+extent that warranties are provided), that licensees may convey the
108+work under this License, and how to view a copy of this License. If
109+the interface presents a list of user commands or options, such as a
110+menu, a prominent item in the list meets this criterion.
111+
112+1. Source Code.
113+
114+The "source code" for a work means the preferred form of the work
115+for making modifications to it. "Object code" means any non-source
116+form of a work.
117+
118+A "Standard Interface" means an interface that either is an official
119+standard defined by a recognized standards body, or, in the case of
120+interfaces specified for a particular programming language, one that
121+is widely used among developers working in that language.
122+
123+The "System Libraries" of an executable work include anything, other
124+than the work as a whole, that (a) is included in the normal form of
125+packaging a Major Component, but which is not part of that Major
126+Component, and (b) serves only to enable use of the work with that
127+Major Component, or to implement a Standard Interface for which an
128+implementation is available to the public in source code form. A
129+"Major Component", in this context, means a major essential component
130+(kernel, window system, and so on) of the specific operating system
131+(if any) on which the executable work runs, or a compiler used to
132+produce the work, or an object code interpreter used to run it.
133+
134+The "Corresponding Source" for a work in object code form means all
135+the source code needed to generate, install, and (for an executable
136+work) run the object code and to modify the work, including scripts to
137+control those activities. However, it does not include the work's
138+System Libraries, or general-purpose tools or generally available free
139+programs which are used unmodified in performing those activities but
140+which are not part of the work. For example, Corresponding Source
141+includes interface definition files associated with source files for
142+the work, and the source code for shared libraries and dynamically
143+linked subprograms that the work is specifically designed to require,
144+such as by intimate data communication or control flow between those
145+subprograms and other parts of the work.
146+
147+The Corresponding Source need not include anything that users
148+can regenerate automatically from other parts of the Corresponding
149+Source.
150+
151+The Corresponding Source for a work in source code form is that
152+same work.
153+
154+2. Basic Permissions.
155+
156+All rights granted under this License are granted for the term of
157+copyright on the Program, and are irrevocable provided the stated
158+conditions are met. This License explicitly affirms your unlimited
159+permission to run the unmodified Program. The output from running a
160+covered work is covered by this License only if the output, given its
161+content, constitutes a covered work. This License acknowledges your
162+rights of fair use or other equivalent, as provided by copyright law.
163+
164+You may make, run and propagate covered works that you do not
165+convey, without conditions so long as your license otherwise remains
166+in force. You may convey covered works to others for the sole purpose
167+of having them make modifications exclusively for you, or provide you
168+with facilities for running those works, provided that you comply with
169+the terms of this License in conveying all material for which you do
170+not control copyright. Those thus making or running the covered works
171+for you must do so exclusively on your behalf, under your direction
172+and control, on terms that prohibit them from making any copies of
173+your copyrighted material outside their relationship with you.
174+
175+Conveying under any other circumstances is permitted solely under
176+the conditions stated below. Sublicensing is not allowed; section 10
177+makes it unnecessary.
178+
179+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180+
181+No covered work shall be deemed part of an effective technological
182+measure under any applicable law fulfilling obligations under article
183+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184+similar laws prohibiting or restricting circumvention of such
185+measures.
186+
187+When you convey a covered work, you waive any legal power to forbid
188+circumvention of technological measures to the extent such circumvention
189+is effected by exercising rights under this License with respect to
190+the covered work, and you disclaim any intention to limit operation or
191+modification of the work as a means of enforcing, against the work's
192+users, your or third parties' legal rights to forbid circumvention of
193+technological measures.
194+
195+4. Conveying Verbatim Copies.
196+
197+You may convey verbatim copies of the Program's source code as you
198+receive it, in any medium, provided that you conspicuously and
199+appropriately publish on each copy an appropriate copyright notice;
200+keep intact all notices stating that this License and any
201+non-permissive terms added in accord with section 7 apply to the code;
202+keep intact all notices of the absence of any warranty; and give all
203+recipients a copy of this License along with the Program.
204+
205+You may charge any price or no price for each copy that you convey,
206+and you may offer support or warranty protection for a fee.
207+
208+5. Conveying Modified Source Versions.
209+
210+You may convey a work based on the Program, or the modifications to
211+produce it from the Program, in the form of source code under the
212+terms of section 4, provided that you also meet all of these conditions:
213+
214+a) The work must carry prominent notices stating that you modified
215+it, and giving a relevant date.
216+
217+b) The work must carry prominent notices stating that it is
218+released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to
219+"keep intact all notices".
220+
221+c) You must license the entire work, as a whole, under this
222+License to anyone who comes into possession of a copy. This
223+License will therefore apply, along with any applicable section 7
224+additional terms, to the whole of the work, and all its parts,
225+regardless of how they are packaged. This License gives no
226+permission to license the work in any other way, but it does not
227+invalidate such permission if you have separately received it.
228+
229+d) If the work has interactive user interfaces, each must display
230+Appropriate Legal Notices; however, if the Program has interactive
231+interfaces that do not display Appropriate Legal Notices, your
232+work need not make them do so.
233+
234+A compilation of a covered work with other separate and independent
235+works, which are not by their nature extensions of the covered work,
236+and which are not combined with it such as to form a larger program,
237+in or on a volume of a storage or distribution medium, is called an
238+"aggregate" if the compilation and its resulting copyright are not
239+used to limit the access or legal rights of the compilation's users
240+beyond what the individual works permit. Inclusion of a covered work
241+in an aggregate does not cause this License to apply to the other
242+parts of the aggregate.
243+
244+6. Conveying Non-Source Forms.
245+
246+You may convey a covered work in object code form under the terms
247+of sections 4 and 5, provided that you also convey the
248+machine-readable Corresponding Source under the terms of this License,
249+in one of these ways:
250+
251+a) Convey the object code in, or embodied in, a physical product
252+(including a physical distribution medium), accompanied by the
253+Corresponding Source fixed on a durable physical medium
254+customarily used for software interchange.
255+
256+b) Convey the object code in, or embodied in, a physical product
257+(including a physical distribution medium), accompanied by a
258+written offer, valid for at least three years and valid for as
259+long as you offer spare parts or customer support for that product
260+model, to give anyone who possesses the object code either (1) a
261+copy of the Corresponding Source for all the software in the
262+product that is covered by this License, on a durable physical
263+medium customarily used for software interchange, for a price no
264+more than your reasonable cost of physically performing this
265+conveying of source, or (2) access to copy the
266+Corresponding Source from a network server at no charge.
267+
268+c) Convey individual copies of the object code with a copy of the
269+written offer to provide the Corresponding Source. This
270+alternative is allowed only occasionally and noncommercially, and
271+only if you received the object code with such an offer, in accord
272+with subsection 6b.
273+
274+d) Convey the object code by offering access from a designated
275+place (gratis or for a charge), and offer equivalent access to the
276+Corresponding Source in the same way through the same place at no
277+further charge. You need not require recipients to copy the
278+Corresponding Source along with the object code. If the place to
279+copy the object code is a network server, the Corresponding Source
280+may be on a different server (operated by you or a third party)
281+that supports equivalent copying facilities, provided you maintain
282+clear directions next to the object code saying where to find the
283+Corresponding Source. Regardless of what server hosts the
284+Corresponding Source, you remain obligated to ensure that it is
285+available for as long as needed to satisfy these requirements.
286+
287+e) Convey the object code using peer-to-peer transmission, provided
288+you inform other peers where the object code and Corresponding
289+Source of the work are being offered to the general public at no
290+charge under subsection 6d.
291+
292+A separable portion of the object code, whose source code is excluded
293+from the Corresponding Source as a System Library, need not be
294+included in conveying the object code work.
295+
296+A "User Product" is either (1) a "consumer product", which means any
297+tangible personal property which is normally used for personal, family,
298+or household purposes, or (2) anything designed or sold for incorporation
299+into a dwelling. In determining whether a product is a consumer product,
300+doubtful cases shall be resolved in favor of coverage. For a particular
301+product received by a particular user, "normally used" refers to a
302+typical or common use of that class of product, regardless of the status
303+of the particular user or of the way in which the particular user
304+actually uses, or expects or is expected to use, the product. A product
305+is a consumer product regardless of whether the product has substantial
306+commercial, industrial or non-consumer uses, unless such uses represent
307+the only significant mode of use of the product.
308+
309+"Installation Information" for a User Product means any methods,
310+procedures, authorization keys, or other information required to install
311+and execute modified versions of a covered work in that User Product from
312+a modified version of its Corresponding Source. The information must
313+suffice to ensure that the continued functioning of the modified object
314+code is in no case prevented or interfered with solely because
315+modification has been made.
316+
317+If you convey an object code work under this section in, or with, or
318+specifically for use in, a User Product, and the conveying occurs as
319+part of a transaction in which the right of possession and use of the
320+User Product is transferred to the recipient in perpetuity or for a
321+fixed term (regardless of how the transaction is characterized), the
322+Corresponding Source conveyed under this section must be accompanied
323+by the Installation Information. But this requirement does not apply
324+if neither you nor any third party retains the ability to install
325+modified object code on the User Product (for example, the work has
326+been installed in ROM).
327+
328+The requirement to provide Installation Information does not include a
329+requirement to continue to provide support service, warranty, or updates
330+for a work that has been modified or installed by the recipient, or for
331+the User Product in which it has been modified or installed. Access to a
332+network may be denied when the modification itself materially and
333+adversely affects the operation of the network or violates the rules and
334+protocols for communication across the network.
335+
336+Corresponding Source conveyed, and Installation Information provided,
337+in accord with this section must be in a format that is publicly
338+documented (and with an implementation available to the public in
339+source code form), and must require no special password or key for
340+unpacking, reading or copying.
341+
342+7. Additional Terms.
343+
344+"Additional permissions" are terms that supplement the terms of this
345+License by making exceptions from one or more of its conditions.
346+Additional permissions that are applicable to the entire Program shall
347+be treated as though they were included in this License, to the extent
348+that they are valid under applicable law. If additional permissions
349+apply only to part of the Program, that part may be used separately
350+under those permissions, but the entire Program remains governed by
351+this License without regard to the additional permissions.
352+
353+When you convey a copy of a covered work, you may at your option
354+remove any additional permissions from that copy, or from any part of
355+it. (Additional permissions may be written to require their own
356+removal in certain cases when you modify the work.) You may place
357+additional permissions on material, added by you to a covered work,
358+for which you have or can give appropriate copyright permission.
359+
360+Notwithstanding any other provision of this License, for material you
361+add to a covered work, you may (if authorized by the copyright holders of
362+that material) supplement the terms of this License with terms:
363+
364+a) Disclaiming warranty or limiting liability differently from the
365+terms of sections 15 and 16 of this License; or
366+
367+b) Requiring preservation of specified reasonable legal notices or
368+author attributions in that material or in the Appropriate Legal
369+Notices displayed by works containing it; or
370+
371+c) Prohibiting misrepresentation of the origin of that material, or
372+requiring that modified versions of such material be marked in
373+reasonable ways as different from the original version; or
374+
375+d) Limiting the use for publicity purposes of names of licensors or
376+authors of the material; or
377+
378+e) Declining to grant rights under trademark law for use of some
379+trade names, trademarks, or service marks; or
380+
381+f) Requiring indemnification of licensors and authors of that
382+material by anyone who conveys the material (or modified versions of
383+it) with contractual assumptions of liability to the recipient, for
384+any liability that these contractual assumptions directly impose on
385+those licensors and authors.
386+
387+All other non-permissive additional terms are considered "further
388+restrictions" within the meaning of section 10. If the Program as you
389+received it, or any part of it, contains a notice stating that it is
390+governed by this License along with a term that is a further
391+restriction, you may remove that term. If a license document contains
392+a further restriction but permits relicensing or conveying under this
393+License, you may add to a covered work material governed by the terms
394+of that license document, provided that the further restriction does
395+not survive such relicensing or conveying.
396+
397+If you add terms to a covered work in accord with this section, you
398+must place, in the relevant source files, a statement of the
399+additional terms that apply to those files, or a notice indicating
400+where to find the applicable terms.
401+
402+Additional terms, permissive or non-permissive, may be stated in the
403+form of a separately written license, or stated as exceptions;
404+the above requirements apply either way.
405+
406+8. Termination.
407+
408+You may not propagate or modify a covered work except as expressly
409+provided under this License. Any attempt otherwise to propagate or
410+modify it is void, and will automatically terminate your rights under
411+this License (including any patent licenses granted under the third
412+paragraph of section 11).
413+
414+However, if you cease all violation of this License, then your
415+license from a particular copyright holder is reinstated (a)
416+provisionally, unless and until the copyright holder explicitly and
417+finally terminates your license, and (b) permanently, if the copyright
418+holder fails to notify you of the violation by some reasonable means
419+prior to 60 days after the cessation.
420+
421+Moreover, your license from a particular copyright holder is
422+reinstated permanently if the copyright holder notifies you of the
423+violation by some reasonable means, this is the first time you have
424+received notice of violation of this License (for any work) from that
425+copyright holder, and you cure the violation prior to 30 days after
426+your receipt of the notice.
427+
428+Termination of your rights under this section does not terminate the
429+licenses of parties who have received copies or rights from you under
430+this License. If your rights have been terminated and not permanently
431+reinstated, you do not qualify to receive new licenses for the same
432+material under section 10.
433+
434+9. Acceptance Not Required for Having Copies.
435+
436+You are not required to accept this License in order to receive or
437+run a copy of the Program. Ancillary propagation of a covered work
438+occurring solely as a consequence of using peer-to-peer transmission
439+to receive a copy likewise does not require acceptance. However,
440+nothing other than this License grants you permission to propagate or
441+modify any covered work. These actions infringe copyright if you do
442+not accept this License. Therefore, by modifying or propagating a
443+covered work, you indicate your acceptance of this License to do so.
444+
445+10. Automatic Licensing of Downstream Recipients.
446+
447+Each time you convey a covered work, the recipient automatically
448+receives a license from the original licensors, to run, modify and
449+propagate that work, subject to this License. You are not responsible
450+for enforcing compliance by third parties with this License.
451+
452+An "entity transaction" is a transaction transferring control of an
453+organization, or substantially all assets of one, or subdividing an
454+organization, or merging organizations. If propagation of a covered
455+work results from an entity transaction, each party to that
456+transaction who receives a copy of the work also receives whatever
457+licenses to the work the party's predecessor in interest had or could
458+give under the previous paragraph, plus a right to possession of the
459+Corresponding Source of the work from the predecessor in interest, if
460+the predecessor has it or can get it with reasonable efforts.
461+
462+You may not impose any further restrictions on the exercise of the
463+rights granted or affirmed under this License. For example, you may
464+not impose a license fee, royalty, or other charge for exercise of
465+rights granted under this License, and you may not initiate litigation
466+(including a cross-claim or counterclaim in a lawsuit) alleging that
467+any patent claim is infringed by making, using, selling, offering for
468+sale, or importing the Program or any portion of it.
469+
470+11. Patents.
471+
472+A "contributor" is a copyright holder who authorizes use under this
473+License of the Program or a work on which the Program is based. The
474+work thus licensed is called the contributor's "contributor version".
475+
476+A contributor's "essential patent claims" are all patent claims
477+owned or controlled by the contributor, whether already acquired or
478+hereafter acquired, that would be infringed by some manner, permitted
479+by this License, of making, using, or selling its contributor version,
480+but do not include claims that would be infringed only as a
481+consequence of further modification of the contributor version. For
482+purposes of this definition, "control" includes the right to grant
483+patent sublicenses in a manner consistent with the requirements of
484+this License.
485+
486+Each contributor grants you a non-exclusive, worldwide, royalty-free
487+patent license under the contributor's essential patent claims, to
488+make, use, sell, offer for sale, import and otherwise run, modify and
489+propagate the contents of its contributor version.
490+
491+In the following three paragraphs, a "patent license" is any express
492+agreement or commitment, however denominated, not to enforce a patent
493+(such as an express permission to practice a patent or covenant not to
494+sue for patent infringement). To "grant" such a patent license to a
495+party means to make such an agreement or commitment not to enforce a
496+patent against the party.
497+
498+If you convey a covered work, knowingly relying on a patent license,
499+and the Corresponding Source of the work is not available for anyone
500+to copy, free of charge and under the terms of this License, through a
501+publicly available network server or other readily accessible means,
502+then you must either (1) cause the Corresponding Source to be so
503+available, or (2) arrange to deprive yourself of the benefit of the
504+patent license for this particular work, or (3) arrange, in a manner
505+consistent with the requirements of this License, to extend the patent
506+license to downstream recipients. "Knowingly relying" means you have
507+actual knowledge that, but for the patent license, your conveying the
508+covered work in a country, or your recipient's use of the covered work
509+in a country, would infringe one or more identifiable patents in that
510+country that you have reason to believe are valid.
511+
512+If, pursuant to or in connection with a single transaction or
513+arrangement, you convey, or propagate by procuring conveyance of, a
514+covered work, and grant a patent license to some of the parties
515+receiving the covered work authorizing them to use, propagate, modify
516+or convey a specific copy of the covered work, then the patent license
517+you grant is automatically extended to all recipients of the covered
518+work and works based on it.
519+
520+A patent license is "discriminatory" if it does not include within
521+the scope of its coverage, prohibits the exercise of, or is
522+conditioned on the non-exercise of one or more of the rights that are
523+specifically granted under this License. You may not convey a covered
524+work if you are a party to an arrangement with a third party that is
525+in the business of distributing software, under which you make payment
526+to the third party based on the extent of your activity of conveying
527+the work, and under which the third party grants, to any of the
528+parties who would receive the covered work from you, a discriminatory
529+patent license (a) in connection with copies of the covered work
530+conveyed by you (or copies made from those copies), or (b) primarily
531+for and in connection with specific products or compilations that
532+contain the covered work, unless you entered into that arrangement,
533+or that patent license was granted, prior to 28 March 2007.
534+
535+Nothing in this License shall be construed as excluding or limiting
536+any implied license or other defenses to infringement that may
537+otherwise be available to you under applicable patent law.
538+
539+12. No Surrender of Others' Freedom.
540+
541+If conditions are imposed on you (whether by court order, agreement or
542+otherwise) that contradict the conditions of this License, they do not
543+excuse you from the conditions of this License. If you cannot convey a
544+covered work so as to satisfy simultaneously your obligations under this
545+License and any other pertinent obligations, then as a consequence you may
546+not convey it at all. For example, if you agree to terms that obligate you
547+to collect a royalty for further conveying from those to whom you convey
548+the Program, the only way you could satisfy both those terms and this
549+License would be to refrain entirely from conveying the Program.
550+
551+13. Use with the GNU Affero General Public License.
552+
553+Notwithstanding any other provision of this License, you have
554+permission to link or combine any covered work with a work licensed
555+under version 3 of the GNU Affero General Public License into a single
556+combined work, and to convey the resulting work. The terms of this
557+License will continue to apply to the part which is the covered work,
558+but the special requirements of the GNU Affero General Public License,
559+section 13, concerning interaction through a network will apply to the
560+combination as such.
561+
562+14. Revised Versions of this License.
563+
564+The Free Software Foundation may publish revised and/or new versions of
565+the GNU General Public License from time to time. Such new versions will
566+be similar in spirit to the present version, but may differ in detail to
567+address new problems or concerns.
568+
569+Each version is given a distinguishing version number. If the
570+Program specifies that a certain numbered version of the GNU General
571+Public License "or any later version" applies to it, you have the
572+option of following the terms and conditions either of that numbered
573+version or of any later version published by the Free Software
574+Foundation. If the Program does not specify a version number of the
575+GNU General Public License, you may choose any version ever published
576+by the Free Software Foundation.
577+
578+If the Program specifies that a proxy can decide which future
579+versions of the GNU General Public License can be used, that proxy's
580+public statement of acceptance of a version permanently authorizes you
581+to choose that version for the Program.
582+
583+Later license versions may give you additional or different
584+permissions. However, no additional obligations are imposed on any
585+author or copyright holder as a result of your choosing to follow a
586+later version.
587+
588+15. Disclaimer of Warranty.
589+
590+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
591+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
592+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
593+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
594+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
595+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
596+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
597+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
598+
599+16. Limitation of Liability.
600+
601+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
602+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
603+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
604+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
605+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
606+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
607+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
608+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
609+SUCH DAMAGES.
610+
611+17. Interpretation of Sections 15 and 16.
612+
613+If the disclaimer of warranty and limitation of liability provided
614+above cannot be given local legal effect according to their terms,
615+reviewing courts shall apply local law that most closely approximates
616+an absolute waiver of all civil liability in connection with the
617+Program, unless a warranty or assumption of liability accompanies a
618+copy of the Program in return for a fee.
619+
620+END OF TERMS AND CONDITIONS
621+
622+How to Apply These Terms to Your New Programs
623+
624+If you develop a new program, and you want it to be of the greatest
625+possible use to the public, the best way to achieve this is to make it
626+free software which everyone can redistribute and change under these terms.
627+
628+To do so, attach the following notices to the program. It is safest
629+to attach them to the start of each source file to most effectively
630+state the exclusion of warranty; and each file should have at least
631+the "copyright" line and a pointer to where the full notice is found.
632+
633+<one line to give the program's name and a brief idea of what it does.>
634+Copyright (C) <year> <name of author>
635+
636+This program is free software: you can redistribute it and/or modify
637+it under the terms of the GNU General Public License as published by
638+the Free Software Foundation, either version 3 of the License, or
639+(at your option) any later version.
640+
641+This program is distributed in the hope that it will be useful,
642+but WITHOUT ANY WARRANTY; without even the implied warranty of
643+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644+GNU General Public License for more details.
645+
646+You should have received a copy of the GNU General Public License
647+along with this program. If not, see <https://www.gnu.org/licenses/>.
648+
649+Also add information on how to contact you by electronic and paper mail.
650+
651+If the program does terminal interaction, make it output a short
652+notice like this when it starts in an interactive mode:
653+
654+<program> Copyright (C) <year> <name of author>
655+This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
656+This is free software, and you are welcome to redistribute it
657+under certain conditions; type `show c' for details.
658+
659+The hypothetical commands `show w' and `show c' should show the appropriate
660+parts of the General Public License. Of course, your program's commands
661+might be different; for a GUI interface, you would use an "about box".
662+
663+You should also get your employer (if you work as a programmer) or school,
664+if any, to sign a "copyright disclaimer" for the program, if necessary.
665+For more information on this, and how to apply and follow the GNU GPL, see
666+<https://www.gnu.org/licenses/>.
667+
668+The GNU General Public License does not permit incorporating your program
669+into proprietary programs. If your program is a subroutine library, you
670+may consider it more useful to permit linking proprietary applications with
671+the library. If this is what you want to do, use the GNU Lesser General
672+Public License instead of this License. But first, please read
673+<https://www.gnu.org/licenses/why-not-lgpl.html>.
\ No newline at end of file\ No newline at end of file
modified README.md +44 -36
@@ -1,6 +1,6 @@
11 # Love
22
3-The official LOVE token.
3+The one and only LOVE token.
44
55 ## Install
66
@@ -9,16 +9,49 @@ forge install
99 cp .env.example .env
1010 ```
1111
12-## Build & test
12+## Build
1313
1414 ```shell
15-forge build # compile
16-forge test # run tests
17-forge test -vvv # with traces
18-forge fmt # format
19-anvil # local node
15+forge build
2016 ```
2117
18+## Test
19+
20+```shell
21+forge test
22+```
23+
24+## Deploy
25+
26+Deployment uses CREATE2, so the token has the same address on every EVM network.
27+Bringing up a chain is registry, then registration, then token — `run()` does
28+all three and skips whichever has already happened.
29+
30+```shell
31+forge script script/Love.s.sol:LoveScript --sig 'predict()' # print the address
32+
33+WETH=0x4200000000000000000000000000000000000006 \
34+forge script script/Love.s.sol:LoveScript \
35+ --rpc-url base_sepolia \
36+ --account "$DEPLOYER_ACCOUNT" \
37+ --broadcast \
38+ --verify
39+```
40+
41+`WETH` defaults to the OP Stack predeploy and is ignored once a wETH is
42+registered. Registration sends 1 wei, which stays in the registry.
43+
44+To check determinism for real, deploy on two local chains and compare:
45+
46+```shell
47+./script/multichain-check.sh
48+```
49+
50+It starts two anvil nodes (chain IDs 31337 and 31338), gives them *different*
51+wETH implementations at *different* addresses, brings both up, and exits
52+non-zero if the two LOVE addresses differ. Override `PORT_A`, `PORT_B`,
53+`CHAIN_ID_A`, `CHAIN_ID_B` or `SALT` as needed.
54+
2255 ## Privacy
2356
2457 Besides the plain `deposit(uint256)`, LOVE can be locked behind a secret
@@ -79,36 +112,11 @@ address before treating a deployment as the real one.
79112 Full design rationale, the allowlist's contents, and how to verify determinism
80113 yourself: see [docs/MULTICHAIN.md](docs/MULTICHAIN.md).
81114
82-## Deploy
83-
84-Deployment uses CREATE2, so the token has the same address on every EVM network.
85-Bringing up a chain is registry, then registration, then token — `run()` does
86-all three and skips whichever has already happened.
87-
88-```shell
89-forge script script/Love.s.sol:LoveScript --sig 'predict()' # print the address
90-
91-WETH=0x4200000000000000000000000000000000000006 \
92-forge script script/Love.s.sol:LoveScript \
93- --rpc-url base_sepolia \
94- --account "$DEPLOYER_ACCOUNT" \
95- --broadcast \
96- --verify
97-```
98-
99-`WETH` defaults to the OP Stack predeploy and is ignored once a wETH is
100-registered. Registration sends 1 wei, which stays in the registry.
101-
102-To check determinism for real, deploy on two local chains and compare:
103-
104-```shell
105-./script/multichain-check.sh
106-```
115+## Docs
107116
108-It starts two anvil nodes (chain IDs 31337 and 31338), gives them *different*
109-wETH implementations at *different* addresses, brings both up, and exits
110-non-zero if the two LOVE addresses differ. Override `PORT_A`, `PORT_B`,
111-`CHAIN_ID_A`, `CHAIN_ID_B` or `SALT` as needed.
117+- [Multichain deployment](docs/MULTICHAIN.md) — CREATE2, the codehash allowlist, and verifying determinism
118+- [Privacy](docs/PRIVACY.md) — sending LOVE by secret instead of by address
119+- [Supported networks](docs/SUPPORTED_NETWORKS.md) — where LOVE deploys today and what could be added
112120
113121 ## License
114122
@@ -1,6 +1,6 @@
1 # Love1 # Love
2 2
3-The official LOVE token.3+The one and only LOVE token.
4 4
5 ## Install5 ## Install
6 6
@@ -9,16 +9,49 @@ forge install
9 cp .env.example .env9 cp .env.example .env
10 ```10 ```
11 11
12-## Build & test12+## Build
13 13
14 ```shell14 ```shell
15-forge build # compile15+forge build
16-forge test # run tests
17-forge test -vvv # with traces
18-forge fmt # format
19-anvil # local node
20 ```16 ```
21 17
18+## Test
19+
20+```shell
21+forge test
22+```
23+
24+## Deploy
25+
26+Deployment uses CREATE2, so the token has the same address on every EVM network.
27+Bringing up a chain is registry, then registration, then token — `run()` does
28+all three and skips whichever has already happened.
29+
30+```shell
31+forge script script/Love.s.sol:LoveScript --sig 'predict()' # print the address
32+
33+WETH=0x4200000000000000000000000000000000000006 \
34+forge script script/Love.s.sol:LoveScript \
35+ --rpc-url base_sepolia \
36+ --account "$DEPLOYER_ACCOUNT" \
37+ --broadcast \
38+ --verify
39+```
40+
41+`WETH` defaults to the OP Stack predeploy and is ignored once a wETH is
42+registered. Registration sends 1 wei, which stays in the registry.
43+
44+To check determinism for real, deploy on two local chains and compare:
45+
46+```shell
47+./script/multichain-check.sh
48+```
49+
50+It starts two anvil nodes (chain IDs 31337 and 31338), gives them *different*
51+wETH implementations at *different* addresses, brings both up, and exits
52+non-zero if the two LOVE addresses differ. Override `PORT_A`, `PORT_B`,
53+`CHAIN_ID_A`, `CHAIN_ID_B` or `SALT` as needed.
54+
22 ## Privacy55 ## Privacy
23 56
24 Besides the plain `deposit(uint256)`, LOVE can be locked behind a secret57 Besides the plain `deposit(uint256)`, LOVE can be locked behind a secret
@@ -79,36 +112,11 @@ address before treating a deployment as the real one.
79 Full design rationale, the allowlist's contents, and how to verify determinism112 Full design rationale, the allowlist's contents, and how to verify determinism
80 yourself: see [docs/MULTICHAIN.md](docs/MULTICHAIN.md).113 yourself: see [docs/MULTICHAIN.md](docs/MULTICHAIN.md).
81 114
82-## Deploy115+## Docs
83-
84-Deployment uses CREATE2, so the token has the same address on every EVM network.
85-Bringing up a chain is registry, then registration, then token — `run()` does
86-all three and skips whichever has already happened.
87-
88-```shell
89-forge script script/Love.s.sol:LoveScript --sig 'predict()' # print the address
90-
91-WETH=0x4200000000000000000000000000000000000006 \
92-forge script script/Love.s.sol:LoveScript \
93- --rpc-url base_sepolia \
94- --account "$DEPLOYER_ACCOUNT" \
95- --broadcast \
96- --verify
97-```
98-
99-`WETH` defaults to the OP Stack predeploy and is ignored once a wETH is
100-registered. Registration sends 1 wei, which stays in the registry.
101-
102-To check determinism for real, deploy on two local chains and compare:
103-
104-```shell
105-./script/multichain-check.sh
106-```
107 116
108-It starts two anvil nodes (chain IDs 31337 and 31338), gives them *different*117+- [Multichain deployment](docs/MULTICHAIN.md) — CREATE2, the codehash allowlist, and verifying determinism
109-wETH implementations at *different* addresses, brings both up, and exits118+- [Privacy](docs/PRIVACY.md) — sending LOVE by secret instead of by address
110-non-zero if the two LOVE addresses differ. Override `PORT_A`, `PORT_B`,119+- [Supported networks](docs/SUPPORTED_NETWORKS.md) — where LOVE deploys today and what could be added
111-`CHAIN_ID_A`, `CHAIN_ID_B` or `SALT` as needed.
112 120
113 ## License121 ## License
114 122