forked from mirror/go-ethereum
commit
193c62fdba
@ -0,0 +1,24 @@ |
||||
# This is the official list of go-ethereum authors for copyright purposes. |
||||
|
||||
Alex Leverington <alex@ethdev.com> |
||||
Alexandre Van de Sande <alex.vandesande@ethdev.com> |
||||
Bas van Kervel <bas@ethdev.com> |
||||
Daniel A. Nagy <nagy.da@gmail.com> |
||||
Ethan Buchman <ethan@coinculture.info> |
||||
Fabian Vogelsteller <fabian@frozeman.de> |
||||
Felix Lange <fjl@twurst.com> |
||||
Gustav Simonsson <gustav.simonsson@gmail.com> |
||||
Jae Kwon <jkwon.work@gmail.com> |
||||
Jason Carver <jacarver@linkedin.com> |
||||
Jeffrey Wilcke <jeffrey@ethereum.org> |
||||
Joseph Chow <ethereum@outlook.com> |
||||
Kobi Gurkan <kobigurk@gmail.com> |
||||
Maran Hidskes <maran.hidskes@gmail.com> |
||||
Marek Kotewicz <marek.kotewicz@gmail.com> |
||||
Matthew Wampler-Doty <matthew.wampler.doty@gmail.com> |
||||
Nick Dodson <silentcicero@outlook.com> |
||||
Péter Szilágyi <peterke@gmail.com> |
||||
Taylor Gerring <taylor.gerring@gmail.com> |
||||
Viktor Trón <viktor.tron@gmail.com> |
||||
Vitalik Buterin <v@buterin.com> |
||||
Zsolt Felföldi <zsfelfoldi@gmail.com> |
@ -0,0 +1,619 @@ |
||||
GNU GENERAL PUBLIC LICENSE |
||||
Version 3, 29 June 2007 |
||||
|
||||
Copyright (C) 2014 The go-ethereum Authors. |
||||
Everyone is permitted to copy and distribute verbatim copies |
||||
of this license document, but changing it is not allowed. |
||||
|
||||
Preamble |
||||
|
||||
The GNU General Public License is a free, copyleft license for |
||||
software and other kinds of works. |
||||
|
||||
The licenses for most software and other practical works are designed |
||||
to take away your freedom to share and change the works. By contrast, |
||||
the GNU General Public License is intended to guarantee your freedom to |
||||
share and change all versions of a program--to make sure it remains free |
||||
software for all its users. We, the Free Software Foundation, use the |
||||
GNU General Public License for most of our software; it applies also to |
||||
any other work released this way by its authors. You can apply it to |
||||
your programs, too. |
||||
|
||||
When we speak of free software, we are referring to freedom, not |
||||
price. Our General Public Licenses are designed to make sure that you |
||||
have the freedom to distribute copies of free software (and charge for |
||||
them if you wish), that you receive source code or can get it if you |
||||
want it, that you can change the software or use pieces of it in new |
||||
free programs, and that you know you can do these things. |
||||
|
||||
To protect your rights, we need to prevent others from denying you |
||||
these rights or asking you to surrender the rights. Therefore, you have |
||||
certain responsibilities if you distribute copies of the software, or if |
||||
you modify it: responsibilities to respect the freedom of others. |
||||
|
||||
For example, if you distribute copies of such a program, whether |
||||
gratis or for a fee, you must pass on to the recipients the same |
||||
freedoms that you received. You must make sure that they, too, receive |
||||
or can get the source code. And you must show them these terms so they |
||||
know their rights. |
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: |
||||
(1) assert copyright on the software, and (2) offer you this License |
||||
giving you legal permission to copy, distribute and/or modify it. |
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains |
||||
that there is no warranty for this free software. For both users' and |
||||
authors' sake, the GPL requires that modified versions be marked as |
||||
changed, so that their problems will not be attributed erroneously to |
||||
authors of previous versions. |
||||
|
||||
Some devices are designed to deny users access to install or run |
||||
modified versions of the software inside them, although the manufacturer |
||||
can do so. This is fundamentally incompatible with the aim of |
||||
protecting users' freedom to change the software. The systematic |
||||
pattern of such abuse occurs in the area of products for individuals to |
||||
use, which is precisely where it is most unacceptable. Therefore, we |
||||
have designed this version of the GPL to prohibit the practice for those |
||||
products. If such problems arise substantially in other domains, we |
||||
stand ready to extend this provision to those domains in future versions |
||||
of the GPL, as needed to protect the freedom of users. |
||||
|
||||
Finally, every program is threatened constantly by software patents. |
||||
States should not allow patents to restrict development and use of |
||||
software on general-purpose computers, but in those that do, we wish to |
||||
avoid the special danger that patents applied to a free program could |
||||
make it effectively proprietary. To prevent this, the GPL assures that |
||||
patents cannot be used to render the program non-free. |
||||
|
||||
The precise terms and conditions for copying, distribution and |
||||
modification follow. |
||||
|
||||
TERMS AND CONDITIONS |
||||
|
||||
0. Definitions. |
||||
|
||||
"This License" refers to version 3 of the GNU General Public License. |
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of |
||||
works, such as semiconductor masks. |
||||
|
||||
"The Program" refers to any copyrightable work licensed under this |
||||
License. Each licensee is addressed as "you". "Licensees" and |
||||
"recipients" may be individuals or organizations. |
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work |
||||
in a fashion requiring copyright permission, other than the making of an |
||||
exact copy. The resulting work is called a "modified version" of the |
||||
earlier work or a work "based on" the earlier work. |
||||
|
||||
A "covered work" means either the unmodified Program or a work based |
||||
on the Program. |
||||
|
||||
To "propagate" a work means to do anything with it that, without |
||||
permission, would make you directly or secondarily liable for |
||||
infringement under applicable copyright law, except executing it on a |
||||
computer or modifying a private copy. Propagation includes copying, |
||||
distribution (with or without modification), making available to the |
||||
public, and in some countries other activities as well. |
||||
|
||||
To "convey" a work means any kind of propagation that enables other |
||||
parties to make or receive copies. Mere interaction with a user through |
||||
a computer network, with no transfer of a copy, is not conveying. |
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" |
||||
to the extent that it includes a convenient and prominently visible |
||||
feature that (1) displays an appropriate copyright notice, and (2) |
||||
tells the user that there is no warranty for the work (except to the |
||||
extent that warranties are provided), that licensees may convey the |
||||
work under this License, and how to view a copy of this License. If |
||||
the interface presents a list of user commands or options, such as a |
||||
menu, a prominent item in the list meets this criterion. |
||||
|
||||
1. Source Code. |
||||
|
||||
The "source code" for a work means the preferred form of the work |
||||
for making modifications to it. "Object code" means any non-source |
||||
form of a work. |
||||
|
||||
A "Standard Interface" means an interface that either is an official |
||||
standard defined by a recognized standards body, or, in the case of |
||||
interfaces specified for a particular programming language, one that |
||||
is widely used among developers working in that language. |
||||
|
||||
The "System Libraries" of an executable work include anything, other |
||||
than the work as a whole, that (a) is included in the normal form of |
||||
packaging a Major Component, but which is not part of that Major |
||||
Component, and (b) serves only to enable use of the work with that |
||||
Major Component, or to implement a Standard Interface for which an |
||||
implementation is available to the public in source code form. A |
||||
"Major Component", in this context, means a major essential component |
||||
(kernel, window system, and so on) of the specific operating system |
||||
(if any) on which the executable work runs, or a compiler used to |
||||
produce the work, or an object code interpreter used to run it. |
||||
|
||||
The "Corresponding Source" for a work in object code form means all |
||||
the source code needed to generate, install, and (for an executable |
||||
work) run the object code and to modify the work, including scripts to |
||||
control those activities. However, it does not include the work's |
||||
System Libraries, or general-purpose tools or generally available free |
||||
programs which are used unmodified in performing those activities but |
||||
which are not part of the work. For example, Corresponding Source |
||||
includes interface definition files associated with source files for |
||||
the work, and the source code for shared libraries and dynamically |
||||
linked subprograms that the work is specifically designed to require, |
||||
such as by intimate data communication or control flow between those |
||||
subprograms and other parts of the work. |
||||
|
||||
The Corresponding Source need not include anything that users |
||||
can regenerate automatically from other parts of the Corresponding |
||||
Source. |
||||
|
||||
The Corresponding Source for a work in source code form is that |
||||
same work. |
||||
|
||||
2. Basic Permissions. |
||||
|
||||
All rights granted under this License are granted for the term of |
||||
copyright on the Program, and are irrevocable provided the stated |
||||
conditions are met. This License explicitly affirms your unlimited |
||||
permission to run the unmodified Program. The output from running a |
||||
covered work is covered by this License only if the output, given its |
||||
content, constitutes a covered work. This License acknowledges your |
||||
rights of fair use or other equivalent, as provided by copyright law. |
||||
|
||||
You may make, run and propagate covered works that you do not |
||||
convey, without conditions so long as your license otherwise remains |
||||
in force. You may convey covered works to others for the sole purpose |
||||
of having them make modifications exclusively for you, or provide you |
||||
with facilities for running those works, provided that you comply with |
||||
the terms of this License in conveying all material for which you do |
||||
not control copyright. Those thus making or running the covered works |
||||
for you must do so exclusively on your behalf, under your direction |
||||
and control, on terms that prohibit them from making any copies of |
||||
your copyrighted material outside their relationship with you. |
||||
|
||||
Conveying under any other circumstances is permitted solely under |
||||
the conditions stated below. Sublicensing is not allowed; section 10 |
||||
makes it unnecessary. |
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
||||
|
||||
No covered work shall be deemed part of an effective technological |
||||
measure under any applicable law fulfilling obligations under article |
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
||||
similar laws prohibiting or restricting circumvention of such |
||||
measures. |
||||
|
||||
When you convey a covered work, you waive any legal power to forbid |
||||
circumvention of technological measures to the extent such circumvention |
||||
is effected by exercising rights under this License with respect to |
||||
the covered work, and you disclaim any intention to limit operation or |
||||
modification of the work as a means of enforcing, against the work's |
||||
users, your or third parties' legal rights to forbid circumvention of |
||||
technological measures. |
||||
|
||||
4. Conveying Verbatim Copies. |
||||
|
||||
You may convey verbatim copies of the Program's source code as you |
||||
receive it, in any medium, provided that you conspicuously and |
||||
appropriately publish on each copy an appropriate copyright notice; |
||||
keep intact all notices stating that this License and any |
||||
non-permissive terms added in accord with section 7 apply to the code; |
||||
keep intact all notices of the absence of any warranty; and give all |
||||
recipients a copy of this License along with the Program. |
||||
|
||||
You may charge any price or no price for each copy that you convey, |
||||
and you may offer support or warranty protection for a fee. |
||||
|
||||
5. Conveying Modified Source Versions. |
||||
|
||||
You may convey a work based on the Program, or the modifications to |
||||
produce it from the Program, in the form of source code under the |
||||
terms of section 4, provided that you also meet all of these conditions: |
||||
|
||||
a) The work must carry prominent notices stating that you modified |
||||
it, and giving a relevant date. |
||||
|
||||
b) The work must carry prominent notices stating that it is |
||||
released under this License and any conditions added under section |
||||
7. This requirement modifies the requirement in section 4 to |
||||
"keep intact all notices". |
||||
|
||||
c) You must license the entire work, as a whole, under this |
||||
License to anyone who comes into possession of a copy. This |
||||
License will therefore apply, along with any applicable section 7 |
||||
additional terms, to the whole of the work, and all its parts, |
||||
regardless of how they are packaged. This License gives no |
||||
permission to license the work in any other way, but it does not |
||||
invalidate such permission if you have separately received it. |
||||
|
||||
d) If the work has interactive user interfaces, each must display |
||||
Appropriate Legal Notices; however, if the Program has interactive |
||||
interfaces that do not display Appropriate Legal Notices, your |
||||
work need not make them do so. |
||||
|
||||
A compilation of a covered work with other separate and independent |
||||
works, which are not by their nature extensions of the covered work, |
||||
and which are not combined with it such as to form a larger program, |
||||
in or on a volume of a storage or distribution medium, is called an |
||||
"aggregate" if the compilation and its resulting copyright are not |
||||
used to limit the access or legal rights of the compilation's users |
||||
beyond what the individual works permit. Inclusion of a covered work |
||||
in an aggregate does not cause this License to apply to the other |
||||
parts of the aggregate. |
||||
|
||||
6. Conveying Non-Source Forms. |
||||
|
||||
You may convey a covered work in object code form under the terms |
||||
of sections 4 and 5, provided that you also convey the |
||||
machine-readable Corresponding Source under the terms of this License, |
||||
in one of these ways: |
||||
|
||||
a) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by the |
||||
Corresponding Source fixed on a durable physical medium |
||||
customarily used for software interchange. |
||||
|
||||
b) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by a |
||||
written offer, valid for at least three years and valid for as |
||||
long as you offer spare parts or customer support for that product |
||||
model, to give anyone who possesses the object code either (1) a |
||||
copy of the Corresponding Source for all the software in the |
||||
product that is covered by this License, on a durable physical |
||||
medium customarily used for software interchange, for a price no |
||||
more than your reasonable cost of physically performing this |
||||
conveying of source, or (2) access to copy the |
||||
Corresponding Source from a network server at no charge. |
||||
|
||||
c) Convey individual copies of the object code with a copy of the |
||||
written offer to provide the Corresponding Source. This |
||||
alternative is allowed only occasionally and noncommercially, and |
||||
only if you received the object code with such an offer, in accord |
||||
with subsection 6b. |
||||
|
||||
d) Convey the object code by offering access from a designated |
||||
place (gratis or for a charge), and offer equivalent access to the |
||||
Corresponding Source in the same way through the same place at no |
||||
further charge. You need not require recipients to copy the |
||||
Corresponding Source along with the object code. If the place to |
||||
copy the object code is a network server, the Corresponding Source |
||||
may be on a different server (operated by you or a third party) |
||||
that supports equivalent copying facilities, provided you maintain |
||||
clear directions next to the object code saying where to find the |
||||
Corresponding Source. Regardless of what server hosts the |
||||
Corresponding Source, you remain obligated to ensure that it is |
||||
available for as long as needed to satisfy these requirements. |
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided |
||||
you inform other peers where the object code and Corresponding |
||||
Source of the work are being offered to the general public at no |
||||
charge under subsection 6d. |
||||
|
||||
A separable portion of the object code, whose source code is excluded |
||||
from the Corresponding Source as a System Library, need not be |
||||
included in conveying the object code work. |
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any |
||||
tangible personal property which is normally used for personal, family, |
||||
or household purposes, or (2) anything designed or sold for incorporation |
||||
into a dwelling. In determining whether a product is a consumer product, |
||||
doubtful cases shall be resolved in favor of coverage. For a particular |
||||
product received by a particular user, "normally used" refers to a |
||||
typical or common use of that class of product, regardless of the status |
||||
of the particular user or of the way in which the particular user |
||||
actually uses, or expects or is expected to use, the product. A product |
||||
is a consumer product regardless of whether the product has substantial |
||||
commercial, industrial or non-consumer uses, unless such uses represent |
||||
the only significant mode of use of the product. |
||||
|
||||
"Installation Information" for a User Product means any methods, |
||||
procedures, authorization keys, or other information required to install |
||||
and execute modified versions of a covered work in that User Product from |
||||
a modified version of its Corresponding Source. The information must |
||||
suffice to ensure that the continued functioning of the modified object |
||||
code is in no case prevented or interfered with solely because |
||||
modification has been made. |
||||
|
||||
If you convey an object code work under this section in, or with, or |
||||
specifically for use in, a User Product, and the conveying occurs as |
||||
part of a transaction in which the right of possession and use of the |
||||
User Product is transferred to the recipient in perpetuity or for a |
||||
fixed term (regardless of how the transaction is characterized), the |
||||
Corresponding Source conveyed under this section must be accompanied |
||||
by the Installation Information. But this requirement does not apply |
||||
if neither you nor any third party retains the ability to install |
||||
modified object code on the User Product (for example, the work has |
||||
been installed in ROM). |
||||
|
||||
The requirement to provide Installation Information does not include a |
||||
requirement to continue to provide support service, warranty, or updates |
||||
for a work that has been modified or installed by the recipient, or for |
||||
the User Product in which it has been modified or installed. Access to a |
||||
network may be denied when the modification itself materially and |
||||
adversely affects the operation of the network or violates the rules and |
||||
protocols for communication across the network. |
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, |
||||
in accord with this section must be in a format that is publicly |
||||
documented (and with an implementation available to the public in |
||||
source code form), and must require no special password or key for |
||||
unpacking, reading or copying. |
||||
|
||||
7. Additional Terms. |
||||
|
||||
"Additional permissions" are terms that supplement the terms of this |
||||
License by making exceptions from one or more of its conditions. |
||||
Additional permissions that are applicable to the entire Program shall |
||||
be treated as though they were included in this License, to the extent |
||||
that they are valid under applicable law. If additional permissions |
||||
apply only to part of the Program, that part may be used separately |
||||
under those permissions, but the entire Program remains governed by |
||||
this License without regard to the additional permissions. |
||||
|
||||
When you convey a copy of a covered work, you may at your option |
||||
remove any additional permissions from that copy, or from any part of |
||||
it. (Additional permissions may be written to require their own |
||||
removal in certain cases when you modify the work.) You may place |
||||
additional permissions on material, added by you to a covered work, |
||||
for which you have or can give appropriate copyright permission. |
||||
|
||||
Notwithstanding any other provision of this License, for material you |
||||
add to a covered work, you may (if authorized by the copyright holders of |
||||
that material) supplement the terms of this License with terms: |
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the |
||||
terms of sections 15 and 16 of this License; or |
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or |
||||
author attributions in that material or in the Appropriate Legal |
||||
Notices displayed by works containing it; or |
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or |
||||
requiring that modified versions of such material be marked in |
||||
reasonable ways as different from the original version; or |
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or |
||||
authors of the material; or |
||||
|
||||
e) Declining to grant rights under trademark law for use of some |
||||
trade names, trademarks, or service marks; or |
||||
|
||||
f) Requiring indemnification of licensors and authors of that |
||||
material by anyone who conveys the material (or modified versions of |
||||
it) with contractual assumptions of liability to the recipient, for |
||||
any liability that these contractual assumptions directly impose on |
||||
those licensors and authors. |
||||
|
||||
All other non-permissive additional terms are considered "further |
||||
restrictions" within the meaning of section 10. If the Program as you |
||||
received it, or any part of it, contains a notice stating that it is |
||||
governed by this License along with a term that is a further |
||||
restriction, you may remove that term. If a license document contains |
||||
a further restriction but permits relicensing or conveying under this |
||||
License, you may add to a covered work material governed by the terms |
||||
of that license document, provided that the further restriction does |
||||
not survive such relicensing or conveying. |
||||
|
||||
If you add terms to a covered work in accord with this section, you |
||||
must place, in the relevant source files, a statement of the |
||||
additional terms that apply to those files, or a notice indicating |
||||
where to find the applicable terms. |
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the |
||||
form of a separately written license, or stated as exceptions; |
||||
the above requirements apply either way. |
||||
|
||||
8. Termination. |
||||
|
||||
You may not propagate or modify a covered work except as expressly |
||||
provided under this License. Any attempt otherwise to propagate or |
||||
modify it is void, and will automatically terminate your rights under |
||||
this License (including any patent licenses granted under the third |
||||
paragraph of section 11). |
||||
|
||||
However, if you cease all violation of this License, then your |
||||
license from a particular copyright holder is reinstated (a) |
||||
provisionally, unless and until the copyright holder explicitly and |
||||
finally terminates your license, and (b) permanently, if the copyright |
||||
holder fails to notify you of the violation by some reasonable means |
||||
prior to 60 days after the cessation. |
||||
|
||||
Moreover, your license from a particular copyright holder is |
||||
reinstated permanently if the copyright holder notifies you of the |
||||
violation by some reasonable means, this is the first time you have |
||||
received notice of violation of this License (for any work) from that |
||||
copyright holder, and you cure the violation prior to 30 days after |
||||
your receipt of the notice. |
||||
|
||||
Termination of your rights under this section does not terminate the |
||||
licenses of parties who have received copies or rights from you under |
||||
this License. If your rights have been terminated and not permanently |
||||
reinstated, you do not qualify to receive new licenses for the same |
||||
material under section 10. |
||||
|
||||
9. Acceptance Not Required for Having Copies. |
||||
|
||||
You are not required to accept this License in order to receive or |
||||
run a copy of the Program. Ancillary propagation of a covered work |
||||
occurring solely as a consequence of using peer-to-peer transmission |
||||
to receive a copy likewise does not require acceptance. However, |
||||
nothing other than this License grants you permission to propagate or |
||||
modify any covered work. These actions infringe copyright if you do |
||||
not accept this License. Therefore, by modifying or propagating a |
||||
covered work, you indicate your acceptance of this License to do so. |
||||
|
||||
10. Automatic Licensing of Downstream Recipients. |
||||
|
||||
Each time you convey a covered work, the recipient automatically |
||||
receives a license from the original licensors, to run, modify and |
||||
propagate that work, subject to this License. You are not responsible |
||||
for enforcing compliance by third parties with this License. |
||||
|
||||
An "entity transaction" is a transaction transferring control of an |
||||
organization, or substantially all assets of one, or subdividing an |
||||
organization, or merging organizations. If propagation of a covered |
||||
work results from an entity transaction, each party to that |
||||
transaction who receives a copy of the work also receives whatever |
||||
licenses to the work the party's predecessor in interest had or could |
||||
give under the previous paragraph, plus a right to possession of the |
||||
Corresponding Source of the work from the predecessor in interest, if |
||||
the predecessor has it or can get it with reasonable efforts. |
||||
|
||||
You may not impose any further restrictions on the exercise of the |
||||
rights granted or affirmed under this License. For example, you may |
||||
not impose a license fee, royalty, or other charge for exercise of |
||||
rights granted under this License, and you may not initiate litigation |
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
||||
any patent claim is infringed by making, using, selling, offering for |
||||
sale, or importing the Program or any portion of it. |
||||
|
||||
11. Patents. |
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this |
||||
License of the Program or a work on which the Program is based. The |
||||
work thus licensed is called the contributor's "contributor version". |
||||
|
||||
A contributor's "essential patent claims" are all patent claims |
||||
owned or controlled by the contributor, whether already acquired or |
||||
hereafter acquired, that would be infringed by some manner, permitted |
||||
by this License, of making, using, or selling its contributor version, |
||||
but do not include claims that would be infringed only as a |
||||
consequence of further modification of the contributor version. For |
||||
purposes of this definition, "control" includes the right to grant |
||||
patent sublicenses in a manner consistent with the requirements of |
||||
this License. |
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
||||
patent license under the contributor's essential patent claims, to |
||||
make, use, sell, offer for sale, import and otherwise run, modify and |
||||
propagate the contents of its contributor version. |
||||
|
||||
In the following three paragraphs, a "patent license" is any express |
||||
agreement or commitment, however denominated, not to enforce a patent |
||||
(such as an express permission to practice a patent or covenant not to |
||||
sue for patent infringement). To "grant" such a patent license to a |
||||
party means to make such an agreement or commitment not to enforce a |
||||
patent against the party. |
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, |
||||
and the Corresponding Source of the work is not available for anyone |
||||
to copy, free of charge and under the terms of this License, through a |
||||
publicly available network server or other readily accessible means, |
||||
then you must either (1) cause the Corresponding Source to be so |
||||
available, or (2) arrange to deprive yourself of the benefit of the |
||||
patent license for this particular work, or (3) arrange, in a manner |
||||
consistent with the requirements of this License, to extend the patent |
||||
license to downstream recipients. "Knowingly relying" means you have |
||||
actual knowledge that, but for the patent license, your conveying the |
||||
covered work in a country, or your recipient's use of the covered work |
||||
in a country, would infringe one or more identifiable patents in that |
||||
country that you have reason to believe are valid. |
||||
|
||||
If, pursuant to or in connection with a single transaction or |
||||
arrangement, you convey, or propagate by procuring conveyance of, a |
||||
covered work, and grant a patent license to some of the parties |
||||
receiving the covered work authorizing them to use, propagate, modify |
||||
or convey a specific copy of the covered work, then the patent license |
||||
you grant is automatically extended to all recipients of the covered |
||||
work and works based on it. |
||||
|
||||
A patent license is "discriminatory" if it does not include within |
||||
the scope of its coverage, prohibits the exercise of, or is |
||||
conditioned on the non-exercise of one or more of the rights that are |
||||
specifically granted under this License. You may not convey a covered |
||||
work if you are a party to an arrangement with a third party that is |
||||
in the business of distributing software, under which you make payment |
||||
to the third party based on the extent of your activity of conveying |
||||
the work, and under which the third party grants, to any of the |
||||
parties who would receive the covered work from you, a discriminatory |
||||
patent license (a) in connection with copies of the covered work |
||||
conveyed by you (or copies made from those copies), or (b) primarily |
||||
for and in connection with specific products or compilations that |
||||
contain the covered work, unless you entered into that arrangement, |
||||
or that patent license was granted, prior to 28 March 2007. |
||||
|
||||
Nothing in this License shall be construed as excluding or limiting |
||||
any implied license or other defenses to infringement that may |
||||
otherwise be available to you under applicable patent law. |
||||
|
||||
12. No Surrender of Others' Freedom. |
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or |
||||
otherwise) that contradict the conditions of this License, they do not |
||||
excuse you from the conditions of this License. If you cannot convey a |
||||
covered work so as to satisfy simultaneously your obligations under this |
||||
License and any other pertinent obligations, then as a consequence you may |
||||
not convey it at all. For example, if you agree to terms that obligate you |
||||
to collect a royalty for further conveying from those to whom you convey |
||||
the Program, the only way you could satisfy both those terms and this |
||||
License would be to refrain entirely from conveying the Program. |
||||
|
||||
13. Use with the GNU Affero General Public License. |
||||
|
||||
Notwithstanding any other provision of this License, you have |
||||
permission to link or combine any covered work with a work licensed |
||||
under version 3 of the GNU Affero General Public License into a single |
||||
combined work, and to convey the resulting work. The terms of this |
||||
License will continue to apply to the part which is the covered work, |
||||
but the special requirements of the GNU Affero General Public License, |
||||
section 13, concerning interaction through a network will apply to the |
||||
combination as such. |
||||
|
||||
14. Revised Versions of this License. |
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of |
||||
the GNU General Public License from time to time. Such new versions will |
||||
be similar in spirit to the present version, but may differ in detail to |
||||
address new problems or concerns. |
||||
|
||||
Each version is given a distinguishing version number. If the |
||||
Program specifies that a certain numbered version of the GNU General |
||||
Public License "or any later version" applies to it, you have the |
||||
option of following the terms and conditions either of that numbered |
||||
version or of any later version published by the Free Software |
||||
Foundation. If the Program does not specify a version number of the |
||||
GNU General Public License, you may choose any version ever published |
||||
by the Free Software Foundation. |
||||
|
||||
If the Program specifies that a proxy can decide which future |
||||
versions of the GNU General Public License can be used, that proxy's |
||||
public statement of acceptance of a version permanently authorizes you |
||||
to choose that version for the Program. |
||||
|
||||
Later license versions may give you additional or different |
||||
permissions. However, no additional obligations are imposed on any |
||||
author or copyright holder as a result of your choosing to follow a |
||||
later version. |
||||
|
||||
15. Disclaimer of Warranty. |
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
||||
|
||||
16. Limitation of Liability. |
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
||||
SUCH DAMAGES. |
||||
|
||||
17. Interpretation of Sections 15 and 16. |
||||
|
||||
If the disclaimer of warranty and limitation of liability provided |
||||
above cannot be given local legal effect according to their terms, |
||||
reviewing courts shall apply local law that most closely approximates |
||||
an absolute waiver of all civil liability in connection with the |
||||
Program, unless a warranty or assumption of liability accompanies a |
||||
copy of the Program in return for a fee. |
@ -0,0 +1,165 @@ |
||||
GNU LESSER GENERAL PUBLIC LICENSE |
||||
Version 3, 29 June 2007 |
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
||||
Everyone is permitted to copy and distribute verbatim copies |
||||
of this license document, but changing it is not allowed. |
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates |
||||
the terms and conditions of version 3 of the GNU General Public |
||||
License, supplemented by the additional permissions listed below. |
||||
|
||||
0. Additional Definitions. |
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser |
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU |
||||
General Public License. |
||||
|
||||
"The Library" refers to a covered work governed by this License, |
||||
other than an Application or a Combined Work as defined below. |
||||
|
||||
An "Application" is any work that makes use of an interface provided |
||||
by the Library, but which is not otherwise based on the Library. |
||||
Defining a subclass of a class defined by the Library is deemed a mode |
||||
of using an interface provided by the Library. |
||||
|
||||
A "Combined Work" is a work produced by combining or linking an |
||||
Application with the Library. The particular version of the Library |
||||
with which the Combined Work was made is also called the "Linked |
||||
Version". |
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the |
||||
Corresponding Source for the Combined Work, excluding any source code |
||||
for portions of the Combined Work that, considered in isolation, are |
||||
based on the Application, and not on the Linked Version. |
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the |
||||
object code and/or source code for the Application, including any data |
||||
and utility programs needed for reproducing the Combined Work from the |
||||
Application, but excluding the System Libraries of the Combined Work. |
||||
|
||||
1. Exception to Section 3 of the GNU GPL. |
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License |
||||
without being bound by section 3 of the GNU GPL. |
||||
|
||||
2. Conveying Modified Versions. |
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a |
||||
facility refers to a function or data to be supplied by an Application |
||||
that uses the facility (other than as an argument passed when the |
||||
facility is invoked), then you may convey a copy of the modified |
||||
version: |
||||
|
||||
a) under this License, provided that you make a good faith effort to |
||||
ensure that, in the event an Application does not supply the |
||||
function or data, the facility still operates, and performs |
||||
whatever part of its purpose remains meaningful, or |
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of |
||||
this License applicable to that copy. |
||||
|
||||
3. Object Code Incorporating Material from Library Header Files. |
||||
|
||||
The object code form of an Application may incorporate material from |
||||
a header file that is part of the Library. You may convey such object |
||||
code under terms of your choice, provided that, if the incorporated |
||||
material is not limited to numerical parameters, data structure |
||||
layouts and accessors, or small macros, inline functions and templates |
||||
(ten or fewer lines in length), you do both of the following: |
||||
|
||||
a) Give prominent notice with each copy of the object code that the |
||||
Library is used in it and that the Library and its use are |
||||
covered by this License. |
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license |
||||
document. |
||||
|
||||
4. Combined Works. |
||||
|
||||
You may convey a Combined Work under terms of your choice that, |
||||
taken together, effectively do not restrict modification of the |
||||
portions of the Library contained in the Combined Work and reverse |
||||
engineering for debugging such modifications, if you also do each of |
||||
the following: |
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that |
||||
the Library is used in it and that the Library and its use are |
||||
covered by this License. |
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license |
||||
document. |
||||
|
||||
c) For a Combined Work that displays copyright notices during |
||||
execution, include the copyright notice for the Library among |
||||
these notices, as well as a reference directing the user to the |
||||
copies of the GNU GPL and this license document. |
||||
|
||||
d) Do one of the following: |
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this |
||||
License, and the Corresponding Application Code in a form |
||||
suitable for, and under terms that permit, the user to |
||||
recombine or relink the Application with a modified version of |
||||
the Linked Version to produce a modified Combined Work, in the |
||||
manner specified by section 6 of the GNU GPL for conveying |
||||
Corresponding Source. |
||||
|
||||
1) Use a suitable shared library mechanism for linking with the |
||||
Library. A suitable mechanism is one that (a) uses at run time |
||||
a copy of the Library already present on the user's computer |
||||
system, and (b) will operate properly with a modified version |
||||
of the Library that is interface-compatible with the Linked |
||||
Version. |
||||
|
||||
e) Provide Installation Information, but only if you would otherwise |
||||
be required to provide such information under section 6 of the |
||||
GNU GPL, and only to the extent that such information is |
||||
necessary to install and execute a modified version of the |
||||
Combined Work produced by recombining or relinking the |
||||
Application with a modified version of the Linked Version. (If |
||||
you use option 4d0, the Installation Information must accompany |
||||
the Minimal Corresponding Source and Corresponding Application |
||||
Code. If you use option 4d1, you must provide the Installation |
||||
Information in the manner specified by section 6 of the GNU GPL |
||||
for conveying Corresponding Source.) |
||||
|
||||
5. Combined Libraries. |
||||
|
||||
You may place library facilities that are a work based on the |
||||
Library side by side in a single library together with other library |
||||
facilities that are not Applications and are not covered by this |
||||
License, and convey such a combined library under terms of your |
||||
choice, if you do both of the following: |
||||
|
||||
a) Accompany the combined library with a copy of the same work based |
||||
on the Library, uncombined with any other library facilities, |
||||
conveyed under the terms of this License. |
||||
|
||||
b) Give prominent notice with the combined library that part of it |
||||
is a work based on the Library, and explaining where to find the |
||||
accompanying uncombined form of the same work. |
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License. |
||||
|
||||
The Free Software Foundation may publish revised and/or new versions |
||||
of the GNU Lesser 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 |
||||
Library as you received it specifies that a certain numbered version |
||||
of the GNU Lesser General Public License "or any later version" |
||||
applies to it, you have the option of following the terms and |
||||
conditions either of that published version or of any later version |
||||
published by the Free Software Foundation. If the Library as you |
||||
received it does not specify a version number of the GNU Lesser |
||||
General Public License, you may choose any version of the GNU Lesser |
||||
General Public License ever published by the Free Software Foundation. |
||||
|
||||
If the Library as you received it specifies that a proxy can decide |
||||
whether future versions of the GNU Lesser General Public License shall |
||||
apply, that proxy's public statement of acceptance of any version is |
||||
permanent authorization for you to choose that version for the |
||||
Library. |
@ -0,0 +1,347 @@ |
||||
// +build none
|
||||
|
||||
/* |
||||
This command generates GPL license headers on top of all source files. |
||||
You can run it once per month, before cutting a release or just |
||||
whenever you feel like it. |
||||
|
||||
go run update-license.go |
||||
|
||||
All authors (people who have contributed code) are listed in the |
||||
AUTHORS file. The author names are mapped and deduplicated using the |
||||
.mailmap file. You can use .mailmap to set the canonical name and |
||||
address for each author. See git-shortlog(1) for an explanation of the |
||||
.mailmap format. |
||||
|
||||
Please review the resulting diff to check whether the correct |
||||
copyright assignments are performed. |
||||
*/ |
||||
|
||||
package main |
||||
|
||||
import ( |
||||
"bufio" |
||||
"bytes" |
||||
"fmt" |
||||
"io/ioutil" |
||||
"log" |
||||
"os" |
||||
"os/exec" |
||||
"path/filepath" |
||||
"regexp" |
||||
"runtime" |
||||
"sort" |
||||
"strconv" |
||||
"strings" |
||||
"sync" |
||||
"text/template" |
||||
"time" |
||||
) |
||||
|
||||
var ( |
||||
// only files with these extensions will be considered
|
||||
extensions = []string{".go", ".js", ".qml"} |
||||
|
||||
// paths with any of these prefixes will be skipped
|
||||
skipPrefixes = []string{ |
||||
// boring stuff
|
||||
"Godeps/", "tests/files/", "build/", |
||||
// don't relicense vendored packages
|
||||
"crypto/sha3/", "crypto/ecies/", "logger/glog/", |
||||
} |
||||
|
||||
// paths with this prefix are licensed as GPL. all other files are LGPL.
|
||||
gplPrefixes = []string{"cmd/"} |
||||
|
||||
// this regexp must match the entire license comment at the
|
||||
// beginning of each file.
|
||||
licenseCommentRE = regexp.MustCompile(`^//\s*(Copyright|This file is part of).*?\n(?://.*?\n)*\n*`) |
||||
|
||||
// this text appears at the start of AUTHORS
|
||||
authorsFileHeader = "# This is the official list of go-ethereum authors for copyright purposes.\n\n" |
||||
) |
||||
|
||||
// this template generates the license comment.
|
||||
// its input is an info structure.
|
||||
var licenseT = template.Must(template.New("").Parse(` |
||||
// Copyright {{.Year}} The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU {{.License}} as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 {{.License}} for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU {{.License}}
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
`[1:])) |
||||
|
||||
type info struct { |
||||
file string |
||||
Year int64 |
||||
} |
||||
|
||||
func (i info) License() string { |
||||
if i.gpl() { |
||||
return "General Public License" |
||||
} else { |
||||
return "Lesser General Public License" |
||||
} |
||||
} |
||||
|
||||
func (i info) ShortLicense() string { |
||||
if i.gpl() { |
||||
return "GPL" |
||||
} else { |
||||
return "LGPL" |
||||
} |
||||
} |
||||
|
||||
func (i info) gpl() bool { |
||||
for _, p := range gplPrefixes { |
||||
if strings.HasPrefix(i.file, p) { |
||||
return true |
||||
} |
||||
} |
||||
return false |
||||
} |
||||
|
||||
func main() { |
||||
var ( |
||||
files = getFiles() |
||||
filec = make(chan string) |
||||
infoc = make(chan *info, 20) |
||||
wg sync.WaitGroup |
||||
) |
||||
|
||||
writeAuthors(files) |
||||
|
||||
go func() { |
||||
for _, f := range files { |
||||
filec <- f |
||||
} |
||||
close(filec) |
||||
}() |
||||
for i := runtime.NumCPU(); i >= 0; i-- { |
||||
// getting file info is slow and needs to be parallel.
|
||||
// it traverses git history for each file.
|
||||
wg.Add(1) |
||||
go getInfo(filec, infoc, &wg) |
||||
} |
||||
go func() { |
||||
wg.Wait() |
||||
close(infoc) |
||||
}() |
||||
writeLicenses(infoc) |
||||
} |
||||
|
||||
func getFiles() []string { |
||||
cmd := exec.Command("git", "ls-tree", "-r", "--name-only", "HEAD") |
||||
var files []string |
||||
err := doLines(cmd, func(line string) { |
||||
for _, p := range skipPrefixes { |
||||
if strings.HasPrefix(line, p) { |
||||
return |
||||
} |
||||
} |
||||
ext := filepath.Ext(line) |
||||
for _, wantExt := range extensions { |
||||
if ext == wantExt { |
||||
goto keep |
||||
} |
||||
} |
||||
return |
||||
keep: |
||||
files = append(files, line) |
||||
}) |
||||
if err != nil { |
||||
log.Fatalf("error getting files:", err) |
||||
} |
||||
return files |
||||
} |
||||
|
||||
var authorRegexp = regexp.MustCompile(`\s*[0-9]+\s*(.*)`) |
||||
|
||||
func gitAuthors(files []string) []string { |
||||
cmds := []string{"shortlog", "-s", "-n", "-e", "HEAD", "--"} |
||||
cmds = append(cmds, files...) |
||||
cmd := exec.Command("git", cmds...) |
||||
var authors []string |
||||
err := doLines(cmd, func(line string) { |
||||
m := authorRegexp.FindStringSubmatch(line) |
||||
if len(m) > 1 { |
||||
authors = append(authors, m[1]) |
||||
} |
||||
}) |
||||
if err != nil { |
||||
log.Fatalln("error getting authors:", err) |
||||
} |
||||
return authors |
||||
} |
||||
|
||||
func readAuthors() []string { |
||||
content, err := ioutil.ReadFile("AUTHORS") |
||||
if err != nil && !os.IsNotExist(err) { |
||||
log.Fatalln("error reading AUTHORS:", err) |
||||
} |
||||
var authors []string |
||||
for _, a := range bytes.Split(content, []byte("\n")) { |
||||
if len(a) > 0 && a[0] != '#' { |
||||
authors = append(authors, string(a)) |
||||
} |
||||
} |
||||
// Retranslate existing authors through .mailmap.
|
||||
// This should catch email address changes.
|
||||
authors = mailmapLookup(authors) |
||||
return authors |
||||
} |
||||
|
||||
func mailmapLookup(authors []string) []string { |
||||
if len(authors) == 0 { |
||||
return nil |
||||
} |
||||
cmds := []string{"check-mailmap", "--"} |
||||
cmds = append(cmds, authors...) |
||||
cmd := exec.Command("git", cmds...) |
||||
var translated []string |
||||
err := doLines(cmd, func(line string) { |
||||
translated = append(translated, line) |
||||
}) |
||||
if err != nil { |
||||
log.Fatalln("error translating authors:", err) |
||||
} |
||||
return translated |
||||
} |
||||
|
||||
func writeAuthors(files []string) { |
||||
merge := make(map[string]bool) |
||||
// Add authors that Git reports as contributorxs.
|
||||
// This is the primary source of author information.
|
||||
for _, a := range gitAuthors(files) { |
||||
merge[a] = true |
||||
} |
||||
// Add existing authors from the file. This should ensure that we
|
||||
// never lose authors, even if Git stops listing them. We can also
|
||||
// add authors manually this way.
|
||||
for _, a := range readAuthors() { |
||||
merge[a] = true |
||||
} |
||||
// Write sorted list of authors back to the file.
|
||||
var result []string |
||||
for a := range merge { |
||||
result = append(result, a) |
||||
} |
||||
sort.Strings(result) |
||||
content := new(bytes.Buffer) |
||||
content.WriteString(authorsFileHeader) |
||||
for _, a := range result { |
||||
content.WriteString(a) |
||||
content.WriteString("\n") |
||||
} |
||||
fmt.Println("writing AUTHORS") |
||||
if err := ioutil.WriteFile("AUTHORS", content.Bytes(), 0644); err != nil { |
||||
log.Fatalln(err) |
||||
} |
||||
} |
||||
|
||||
func getInfo(files <-chan string, out chan<- *info, wg *sync.WaitGroup) { |
||||
for file := range files { |
||||
stat, err := os.Lstat(file) |
||||
if err != nil { |
||||
fmt.Printf("ERROR %s: %v\n", file, err) |
||||
continue |
||||
} |
||||
if !stat.Mode().IsRegular() { |
||||
continue |
||||
} |
||||
info, err := fileInfo(file) |
||||
if err != nil { |
||||
fmt.Printf("ERROR %s: %v\n", file, err) |
||||
continue |
||||
} |
||||
out <- info |
||||
} |
||||
wg.Done() |
||||
} |
||||
|
||||
// fileInfo finds the lowest year in which the given file was commited.
|
||||
func fileInfo(file string) (*info, error) { |
||||
info := &info{file: file, Year: int64(time.Now().Year())} |
||||
cmd := exec.Command("git", "log", "--follow", "--find-copies", "--pretty=format:%ai", "--", file) |
||||
err := doLines(cmd, func(line string) { |
||||
y, err := strconv.ParseInt(line[:4], 10, 64) |
||||
if err != nil { |
||||
fmt.Printf("cannot parse year: %q", line[:4]) |
||||
} |
||||
if y < info.Year { |
||||
info.Year = y |
||||
} |
||||
}) |
||||
return info, err |
||||
} |
||||
|
||||
func writeLicenses(infos <-chan *info) { |
||||
for i := range infos { |
||||
writeLicense(i) |
||||
} |
||||
} |
||||
|
||||
func writeLicense(info *info) { |
||||
fi, err := os.Stat(info.file) |
||||
if os.IsNotExist(err) { |
||||
fmt.Println("skipping (does not exist)", info.file) |
||||
return |
||||
} |
||||
if err != nil { |
||||
log.Fatalf("error stat'ing %s: %v\n", info.file, err) |
||||
} |
||||
content, err := ioutil.ReadFile(info.file) |
||||
if err != nil { |
||||
log.Fatalf("error reading %s: %v\n", info.file, err) |
||||
} |
||||
// Construct new file content.
|
||||
buf := new(bytes.Buffer) |
||||
licenseT.Execute(buf, info) |
||||
if m := licenseCommentRE.FindIndex(content); m != nil && m[0] == 0 { |
||||
buf.Write(content[:m[0]]) |
||||
buf.Write(content[m[1]:]) |
||||
} else { |
||||
buf.Write(content) |
||||
} |
||||
// Write it to the file.
|
||||
if bytes.Equal(content, buf.Bytes()) { |
||||
fmt.Println("skipping (no changes)", info.file) |
||||
return |
||||
} |
||||
fmt.Println("writing", info.ShortLicense(), info.file) |
||||
if err := ioutil.WriteFile(info.file, buf.Bytes(), fi.Mode()); err != nil { |
||||
log.Fatalf("error writing %s: %v", info.file, err) |
||||
} |
||||
} |
||||
|
||||
func doLines(cmd *exec.Cmd, f func(string)) error { |
||||
stdout, err := cmd.StdoutPipe() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
if err := cmd.Start(); err != nil { |
||||
return err |
||||
} |
||||
s := bufio.NewScanner(stdout) |
||||
for s.Scan() { |
||||
f(s.Text()) |
||||
} |
||||
if s.Err() != nil { |
||||
return s.Err() |
||||
} |
||||
if err := cmd.Wait(); err != nil { |
||||
return fmt.Errorf("%v (for %s)", err, strings.Join(cmd.Args, " ")) |
||||
} |
||||
return nil |
||||
} |
@ -1,6 +0,0 @@ |
||||
package main |
||||
|
||||
var ( |
||||
globalRegistrar = `var GlobalRegistrar = web3.eth.contract([{"constant":true,"inputs":[{"name":"_owner","type":"address"}],"name":"name","outputs":[{"name":"o_name","type":"bytes32"}],"type":"function"},{"constant":true,"inputs":[{"name":"_name","type":"bytes32"}],"name":"owner","outputs":[{"name":"","type":"address"}],"type":"function"},{"constant":true,"inputs":[{"name":"_name","type":"bytes32"}],"name":"content","outputs":[{"name":"","type":"bytes32"}],"type":"function"},{"constant":true,"inputs":[{"name":"_name","type":"bytes32"}],"name":"addr","outputs":[{"name":"","type":"address"}],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"}],"name":"reserve","outputs":[],"type":"function"},{"constant":true,"inputs":[{"name":"_name","type":"bytes32"}],"name":"subRegistrar","outputs":[{"name":"o_subRegistrar","type":"address"}],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"},{"name":"_newOwner","type":"address"}],"name":"transfer","outputs":[],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"},{"name":"_registrar","type":"address"}],"name":"setSubRegistrar","outputs":[],"type":"function"},{"constant":false,"inputs":[],"name":"Registrar","outputs":[],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"},{"name":"_a","type":"address"},{"name":"_primary","type":"bool"}],"name":"setAddress","outputs":[],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"},{"name":"_content","type":"bytes32"}],"name":"setContent","outputs":[],"type":"function"},{"constant":false,"inputs":[{"name":"_name","type":"bytes32"}],"name":"disown","outputs":[],"type":"function"},{"constant":true,"inputs":[{"name":"_name","type":"bytes32"}],"name":"register","outputs":[{"name":"","type":"address"}],"type":"function"},{"anonymous":false,"inputs":[{"indexed":true,"name":"name","type":"bytes32"}],"name":"Changed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"name","type":"bytes32"},{"indexed":true,"name":"addr","type":"address"}],"name":"PrimaryChanged","type":"event"}]);` |
||||
globalRegistrarAddr = "0xc6d9d2cd449a754c494264e1809c50e34d64562b" |
||||
) |
@ -0,0 +1,253 @@ |
||||
package natspec |
||||
|
||||
import ( |
||||
"fmt" |
||||
"io/ioutil" |
||||
"os" |
||||
"strings" |
||||
"testing" |
||||
|
||||
"github.com/ethereum/go-ethereum/accounts" |
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/common/docserver" |
||||
"github.com/ethereum/go-ethereum/common/registrar" |
||||
"github.com/ethereum/go-ethereum/core" |
||||
"github.com/ethereum/go-ethereum/core/state" |
||||
"github.com/ethereum/go-ethereum/crypto" |
||||
"github.com/ethereum/go-ethereum/eth" |
||||
xe "github.com/ethereum/go-ethereum/xeth" |
||||
) |
||||
|
||||
const ( |
||||
testBalance = "10000000000000000000" |
||||
|
||||
testFileName = "long_file_name_for_testing_registration_of_URLs_longer_than_32_bytes.content" |
||||
|
||||
testNotice = "Register key `utils.toHex(_key)` <- content `utils.toHex(_content)`" |
||||
|
||||
testExpNotice = "Register key 0xadd1a7d961cff0242089674ec2ef6fca671ab15e1fe80e38859fc815b98d88ab <- content 0xb3a2dea218de5d8bbe6c4645aadbf67b5ab00ecb1a9ec95dbdad6a0eed3e41a7" |
||||
|
||||
testExpNotice2 = `About to submit transaction (NatSpec notice error: abi key does not match any method): {"params":[{"to":"%s","data": "0x31e12c20"}]}` |
||||
|
||||
testExpNotice3 = `About to submit transaction (no NatSpec info found for contract: content hash not found for '0x1392c62d05b2d149e22a339c531157ae06b44d39a674cce500064b12b9aeb019'): {"params":[{"to":"%s","data": "0x300a3bbfb3a2dea218de5d8bbe6c4645aadbf67b5ab00ecb1a9ec95dbdad6a0eed3e41a7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000066696c653a2f2f2f746573742e636f6e74656e74"}]}` |
||||
) |
||||
|
||||
const ( |
||||
testUserDoc = ` |
||||
{ |
||||
"methods": { |
||||
"register(uint256,uint256)": { |
||||
"notice": "` + testNotice + `" |
||||
} |
||||
}, |
||||
"invariants": [ |
||||
{ "notice": "" } |
||||
], |
||||
"construction": [ |
||||
{ "notice": "" } |
||||
] |
||||
} |
||||
` |
||||
testAbiDefinition = ` |
||||
[{ |
||||
"name": "register", |
||||
"constant": false, |
||||
"type": "function", |
||||
"inputs": [{ |
||||
"name": "_key", |
||||
"type": "uint256" |
||||
}, { |
||||
"name": "_content", |
||||
"type": "uint256" |
||||
}], |
||||
"outputs": [] |
||||
}] |
||||
` |
||||
|
||||
testContractInfo = ` |
||||
{ |
||||
"userDoc": ` + testUserDoc + `, |
||||
"abiDefinition": ` + testAbiDefinition + ` |
||||
} |
||||
` |
||||
) |
||||
|
||||
type testFrontend struct { |
||||
t *testing.T |
||||
ethereum *eth.Ethereum |
||||
xeth *xe.XEth |
||||
coinbase common.Address |
||||
stateDb *state.StateDB |
||||
txc uint64 |
||||
lastConfirm string |
||||
wantNatSpec bool |
||||
} |
||||
|
||||
func (self *testFrontend) UnlockAccount(acc []byte) bool { |
||||
self.ethereum.AccountManager().Unlock(common.BytesToAddress(acc), "password") |
||||
return true |
||||
} |
||||
|
||||
func (self *testFrontend) ConfirmTransaction(tx string) bool { |
||||
if self.wantNatSpec { |
||||
ds := docserver.New("/tmp/") |
||||
self.lastConfirm = GetNotice(self.xeth, tx, ds) |
||||
} |
||||
return true |
||||
} |
||||
|
||||
func testEth(t *testing.T) (ethereum *eth.Ethereum, err error) { |
||||
|
||||
os.RemoveAll("/tmp/eth-natspec/") |
||||
|
||||
err = os.MkdirAll("/tmp/eth-natspec/keystore", os.ModePerm) |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
|
||||
// create a testAddress
|
||||
ks := crypto.NewKeyStorePassphrase("/tmp/eth-natspec/keystore") |
||||
am := accounts.NewManager(ks) |
||||
testAccount, err := am.NewAccount("password") |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
testAddress := strings.TrimPrefix(testAccount.Address.Hex(), "0x") |
||||
|
||||
// set up mock genesis with balance on the testAddress
|
||||
core.GenesisAccounts = []byte(`{ |
||||
"` + testAddress + `": {"balance": "` + testBalance + `"} |
||||
}`) |
||||
|
||||
// only use minimalistic stack with no networking
|
||||
ethereum, err = eth.New(ð.Config{ |
||||
DataDir: "/tmp/eth-natspec", |
||||
AccountManager: am, |
||||
MaxPeers: 0, |
||||
}) |
||||
|
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
|
||||
return |
||||
} |
||||
|
||||
func testInit(t *testing.T) (self *testFrontend) { |
||||
// initialise and start minimal ethereum stack
|
||||
ethereum, err := testEth(t) |
||||
if err != nil { |
||||
t.Errorf("error creating ethereum: %v", err) |
||||
return |
||||
} |
||||
err = ethereum.Start() |
||||
if err != nil { |
||||
t.Errorf("error starting ethereum: %v", err) |
||||
return |
||||
} |
||||
|
||||
// mock frontend
|
||||
self = &testFrontend{t: t, ethereum: ethereum} |
||||
self.xeth = xe.New(ethereum, self) |
||||
|
||||
addr, _ := ethereum.Etherbase() |
||||
self.coinbase = addr |
||||
self.stateDb = self.ethereum.ChainManager().State().Copy() |
||||
|
||||
// initialise the registry contracts
|
||||
reg := registrar.New(self.xeth) |
||||
err = reg.SetHashReg("", addr) |
||||
if err != nil { |
||||
t.Errorf("error creating HashReg: %v", err) |
||||
} |
||||
err = reg.SetUrlHint("", addr) |
||||
if err != nil { |
||||
t.Errorf("error creating UrlHint: %v", err) |
||||
} |
||||
self.applyTxs() |
||||
|
||||
return |
||||
|
||||
} |
||||
|
||||
// this is needed for transaction to be applied to the state in testing
|
||||
// the heavy lifing is done in XEth.ApplyTestTxs
|
||||
// this is fragile,
|
||||
// and does process leaking since xeth loops cannot quit safely
|
||||
// should be replaced by proper mining with testDAG for easy full integration tests
|
||||
func (self *testFrontend) applyTxs() { |
||||
self.txc, self.xeth = self.xeth.ApplyTestTxs(self.stateDb, self.coinbase, self.txc) |
||||
return |
||||
} |
||||
|
||||
// end to end test
|
||||
func TestNatspecE2E(t *testing.T) { |
||||
t.Skip() |
||||
|
||||
tf := testInit(t) |
||||
defer tf.ethereum.Stop() |
||||
|
||||
// create a contractInfo file (mock cloud-deployed contract metadocs)
|
||||
// incidentally this is the info for the registry contract itself
|
||||
ioutil.WriteFile("/tmp/"+testFileName, []byte(testContractInfo), os.ModePerm) |
||||
dochash := common.BytesToHash(crypto.Sha3([]byte(testContractInfo))) |
||||
|
||||
// take the codehash for the contract we wanna test
|
||||
// codehex := tf.xeth.CodeAt(registar.HashRegAddr)
|
||||
codeb := tf.xeth.CodeAtBytes(registrar.HashRegAddr) |
||||
codehash := common.BytesToHash(crypto.Sha3(codeb)) |
||||
|
||||
// use resolver to register codehash->dochash->url
|
||||
// test if globalregistry works
|
||||
// registrar.HashRefAddr = "0x0"
|
||||
// registrar.UrlHintAddr = "0x0"
|
||||
reg := registrar.New(tf.xeth) |
||||
_, err := reg.SetHashToHash(tf.coinbase, codehash, dochash) |
||||
if err != nil { |
||||
t.Errorf("error registering: %v", err) |
||||
} |
||||
_, err = reg.SetUrlToHash(tf.coinbase, dochash, "file:///"+testFileName) |
||||
if err != nil { |
||||
t.Errorf("error registering: %v", err) |
||||
} |
||||
// apply txs to the state
|
||||
tf.applyTxs() |
||||
|
||||
// NatSpec info for register method of HashReg contract installed
|
||||
// now using the same transactions to check confirm messages
|
||||
|
||||
tf.wantNatSpec = true // this is set so now the backend uses natspec confirmation
|
||||
_, err = reg.SetHashToHash(tf.coinbase, codehash, dochash) |
||||
if err != nil { |
||||
t.Errorf("error calling contract registry: %v", err) |
||||
} |
||||
|
||||
fmt.Printf("GlobalRegistrar: %v, HashReg: %v, UrlHint: %v\n", registrar.GlobalRegistrarAddr, registrar.HashRegAddr, registrar.UrlHintAddr) |
||||
if tf.lastConfirm != testExpNotice { |
||||
t.Errorf("Wrong confirm message. expected '%v', got '%v'", testExpNotice, tf.lastConfirm) |
||||
} |
||||
|
||||
// test unknown method
|
||||
exp := fmt.Sprintf(testExpNotice2, registrar.HashRegAddr) |
||||
_, err = reg.SetOwner(tf.coinbase) |
||||
if err != nil { |
||||
t.Errorf("error setting owner: %v", err) |
||||
} |
||||
|
||||
if tf.lastConfirm != exp { |
||||
t.Errorf("Wrong confirm message, expected '%v', got '%v'", exp, tf.lastConfirm) |
||||
} |
||||
|
||||
// test unknown contract
|
||||
exp = fmt.Sprintf(testExpNotice3, registrar.UrlHintAddr) |
||||
|
||||
_, err = reg.SetUrlToHash(tf.coinbase, dochash, "file:///test.content") |
||||
if err != nil { |
||||
t.Errorf("error registering: %v", err) |
||||
} |
||||
|
||||
if tf.lastConfirm != exp { |
||||
t.Errorf("Wrong confirm message, expected '%v', got '%v'", exp, tf.lastConfirm) |
||||
} |
||||
|
||||
} |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,48 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package ethreg |
||||
|
||||
import ( |
||||
"math/big" |
||||
|
||||
"github.com/ethereum/go-ethereum/common/registrar" |
||||
"github.com/ethereum/go-ethereum/xeth" |
||||
) |
||||
|
||||
// implements a versioned Registrar on an archiving full node
|
||||
type EthReg struct { |
||||
backend *xeth.XEth |
||||
registry *registrar.Registrar |
||||
} |
||||
|
||||
func New(xe *xeth.XEth) (self *EthReg) { |
||||
self = &EthReg{backend: xe} |
||||
self.registry = registrar.New(xe) |
||||
return |
||||
} |
||||
|
||||
func (self *EthReg) Registry() *registrar.Registrar { |
||||
return self.registry |
||||
} |
||||
|
||||
func (self *EthReg) Resolver(n *big.Int) *registrar.Registrar { |
||||
xe := self.backend |
||||
if n != nil { |
||||
xe = self.backend.AtStateNum(n.Int64()) |
||||
} |
||||
return registrar.New(xe) |
||||
} |
@ -0,0 +1,408 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package registrar |
||||
|
||||
import ( |
||||
"encoding/binary" |
||||
"fmt" |
||||
"math/big" |
||||
"regexp" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/crypto" |
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
) |
||||
|
||||
/* |
||||
Registrar implements the Ethereum name registrar services mapping |
||||
- arbitrary strings to ethereum addresses |
||||
- hashes to hashes |
||||
- hashes to arbitrary strings |
||||
(likely will provide lookup service for all three) |
||||
|
||||
The Registrar is used by |
||||
* the roundtripper transport implementation of |
||||
url schemes to resolve domain names and services that register these names |
||||
* contract info retrieval (NatSpec). |
||||
|
||||
The Registrar uses 3 contracts on the blockchain: |
||||
* GlobalRegistrar: Name (string) -> Address (Owner) |
||||
* HashReg : Key Hash (hash of domain name or contract code) -> Content Hash |
||||
* UrlHint : Content Hash -> Url Hint |
||||
|
||||
These contracts are (currently) not included in the genesis block. |
||||
Each Set<X> needs to be called once on each blockchain/network once. |
||||
|
||||
Contract addresses need to be set (HashReg and UrlHint retrieved from the global |
||||
registrar the first time any Registrar method is called in a client session |
||||
|
||||
So the caller needs to make sure the relevant environment initialised the desired |
||||
contracts |
||||
*/ |
||||
var ( |
||||
UrlHintAddr = "0x0" |
||||
HashRegAddr = "0x0" |
||||
GlobalRegistrarAddr = "0x0" |
||||
// GlobalRegistrarAddr = "0xc6d9d2cd449a754c494264e1809c50e34d64562b"
|
||||
|
||||
zero = regexp.MustCompile("^(0x)?0*$") |
||||
) |
||||
|
||||
const ( |
||||
trueHex = "0000000000000000000000000000000000000000000000000000000000000001" |
||||
falseHex = "0000000000000000000000000000000000000000000000000000000000000000" |
||||
) |
||||
|
||||
func abiSignature(s string) string { |
||||
return common.ToHex(crypto.Sha3([]byte(s))[:4]) |
||||
} |
||||
|
||||
var ( |
||||
HashRegName = "HashReg" |
||||
UrlHintName = "UrlHint" |
||||
|
||||
registerContentHashAbi = abiSignature("register(uint256,uint256)") |
||||
registerUrlAbi = abiSignature("register(uint256,uint8,uint256)") |
||||
setOwnerAbi = abiSignature("setowner()") |
||||
reserveAbi = abiSignature("reserve(bytes32)") |
||||
resolveAbi = abiSignature("addr(bytes32)") |
||||
registerAbi = abiSignature("setAddress(bytes32,address,bool)") |
||||
addressAbiPrefix = falseHex[:24] |
||||
) |
||||
|
||||
// Registrar's backend is defined as an interface (implemented by xeth, but could be remote)
|
||||
type Backend interface { |
||||
StorageAt(string, string) string |
||||
Transact(fromStr, toStr, nonceStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, error) |
||||
Call(fromStr, toStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, string, error) |
||||
} |
||||
|
||||
// TODO Registrar should also just implement The Resolver and Registry interfaces
|
||||
// Simplify for now.
|
||||
type VersionedRegistrar interface { |
||||
Resolver(*big.Int) *Registrar |
||||
Registry() *Registrar |
||||
} |
||||
|
||||
type Registrar struct { |
||||
backend Backend |
||||
} |
||||
|
||||
func New(b Backend) (res *Registrar) { |
||||
res = &Registrar{b} |
||||
return |
||||
} |
||||
|
||||
func (self *Registrar) SetGlobalRegistrar(namereg string, addr common.Address) (txhash string, err error) { |
||||
if namereg != "" { |
||||
GlobalRegistrarAddr = namereg |
||||
return |
||||
} |
||||
if GlobalRegistrarAddr == "0x0" || GlobalRegistrarAddr == "0x" { |
||||
if (addr == common.Address{}) { |
||||
err = fmt.Errorf("GlobalRegistrar address not found and sender for creation not given") |
||||
return |
||||
} else { |
||||
txhash, err = self.backend.Transact(addr.Hex(), "", "", "", "800000", "", GlobalRegistrarCode) |
||||
if err != nil { |
||||
err = fmt.Errorf("GlobalRegistrar address not found and sender for creation failed: %v", err) |
||||
return |
||||
} |
||||
} |
||||
} |
||||
return |
||||
} |
||||
|
||||
func (self *Registrar) SetHashReg(hashreg string, addr common.Address) (txhash string, err error) { |
||||
if hashreg != "" { |
||||
HashRegAddr = hashreg |
||||
} else { |
||||
if !zero.MatchString(HashRegAddr) { |
||||
return |
||||
} |
||||
nameHex, extra := encodeName(HashRegName, 2) |
||||
hashRegAbi := resolveAbi + nameHex + extra |
||||
glog.V(logger.Detail).Infof("\ncall HashRegAddr %v with %v\n", GlobalRegistrarAddr, hashRegAbi) |
||||
var res string |
||||
res, _, err = self.backend.Call("", GlobalRegistrarAddr, "", "", "", hashRegAbi) |
||||
if len(res) >= 40 { |
||||
HashRegAddr = "0x" + res[len(res)-40:len(res)] |
||||
} |
||||
if err != nil || zero.MatchString(HashRegAddr) { |
||||
if (addr == common.Address{}) { |
||||
err = fmt.Errorf("HashReg address not found and sender for creation not given") |
||||
return |
||||
} |
||||
|
||||
txhash, err = self.backend.Transact(addr.Hex(), "", "", "", "", "", HashRegCode) |
||||
if err != nil { |
||||
err = fmt.Errorf("HashReg address not found and sender for creation failed: %v", err) |
||||
} |
||||
glog.V(logger.Detail).Infof("created HashRegAddr @ txhash %v\n", txhash) |
||||
} else { |
||||
glog.V(logger.Detail).Infof("HashRegAddr found at @ %v\n", HashRegAddr) |
||||
return |
||||
} |
||||
} |
||||
|
||||
return |
||||
} |
||||
|
||||
func (self *Registrar) SetUrlHint(urlhint string, addr common.Address) (txhash string, err error) { |
||||
if urlhint != "" { |
||||
UrlHintAddr = urlhint |
||||
} else { |
||||
if !zero.MatchString(UrlHintAddr) { |
||||
return |
||||
} |
||||
nameHex, extra := encodeName(UrlHintName, 2) |
||||
urlHintAbi := resolveAbi + nameHex + extra |
||||
glog.V(logger.Detail).Infof("UrlHint address query data: %s to %s", urlHintAbi, GlobalRegistrarAddr) |
||||
var res string |
||||
res, _, err = self.backend.Call("", GlobalRegistrarAddr, "", "", "", urlHintAbi) |
||||
if len(res) >= 40 { |
||||
UrlHintAddr = "0x" + res[len(res)-40:len(res)] |
||||
} |
||||
if err != nil || zero.MatchString(UrlHintAddr) { |
||||
if (addr == common.Address{}) { |
||||
err = fmt.Errorf("UrlHint address not found and sender for creation not given") |
||||
return |
||||
} |
||||
txhash, err = self.backend.Transact(addr.Hex(), "", "", "", "210000", "", UrlHintCode) |
||||
if err != nil { |
||||
err = fmt.Errorf("UrlHint address not found and sender for creation failed: %v", err) |
||||
} |
||||
glog.V(logger.Detail).Infof("created UrlHint @ txhash %v\n", txhash) |
||||
} else { |
||||
glog.V(logger.Detail).Infof("UrlHint found @ %v\n", HashRegAddr) |
||||
return |
||||
} |
||||
} |
||||
|
||||
return |
||||
} |
||||
|
||||
// ReserveName(from, name) reserves name for the sender address in the globalRegistrar
|
||||
// the tx needs to be mined to take effect
|
||||
func (self *Registrar) ReserveName(address common.Address, name string) (txh string, err error) { |
||||
nameHex, extra := encodeName(name, 2) |
||||
abi := reserveAbi + nameHex + extra |
||||
glog.V(logger.Detail).Infof("Reserve data: %s", abi) |
||||
return self.backend.Transact( |
||||
address.Hex(), |
||||
GlobalRegistrarAddr, |
||||
"", "", "", "", |
||||
abi, |
||||
) |
||||
} |
||||
|
||||
// SetAddressToName(from, name, addr) will set the Address to address for name
|
||||
// in the globalRegistrar using from as the sender of the transaction
|
||||
// the tx needs to be mined to take effect
|
||||
func (self *Registrar) SetAddressToName(from common.Address, name string, address common.Address) (txh string, err error) { |
||||
nameHex, extra := encodeName(name, 6) |
||||
addrHex := encodeAddress(address) |
||||
|
||||
abi := registerAbi + nameHex + addrHex + trueHex + extra |
||||
glog.V(logger.Detail).Infof("SetAddressToName data: %s to %s ", abi, GlobalRegistrarAddr) |
||||
|
||||
return self.backend.Transact( |
||||
from.Hex(), |
||||
GlobalRegistrarAddr, |
||||
"", "", "", "", |
||||
abi, |
||||
) |
||||
} |
||||
|
||||
// NameToAddr(from, name) queries the registrar for the address on name
|
||||
func (self *Registrar) NameToAddr(from common.Address, name string) (address common.Address, err error) { |
||||
nameHex, extra := encodeName(name, 2) |
||||
abi := resolveAbi + nameHex + extra |
||||
glog.V(logger.Detail).Infof("NameToAddr data: %s", abi) |
||||
res, _, err := self.backend.Call( |
||||
from.Hex(), |
||||
GlobalRegistrarAddr, |
||||
"", "", "", |
||||
abi, |
||||
) |
||||
if err != nil { |
||||
return |
||||
} |
||||
address = common.HexToAddress(res) |
||||
return |
||||
} |
||||
|
||||
// called as first step in the registration process on HashReg
|
||||
func (self *Registrar) SetOwner(address common.Address) (txh string, err error) { |
||||
return self.backend.Transact( |
||||
address.Hex(), |
||||
HashRegAddr, |
||||
"", "", "", "", |
||||
setOwnerAbi, |
||||
) |
||||
} |
||||
|
||||
// registers some content hash to a key/code hash
|
||||
// e.g., the contract Info combined Json Doc's ContentHash
|
||||
// to CodeHash of a contract or hash of a domain
|
||||
func (self *Registrar) SetHashToHash(address common.Address, codehash, dochash common.Hash) (txh string, err error) { |
||||
_, err = self.SetOwner(address) |
||||
if err != nil { |
||||
return |
||||
} |
||||
codehex := common.Bytes2Hex(codehash[:]) |
||||
dochex := common.Bytes2Hex(dochash[:]) |
||||
|
||||
data := registerContentHashAbi + codehex + dochex |
||||
glog.V(logger.Detail).Infof("SetHashToHash data: %s sent to %v\n", data, HashRegAddr) |
||||
return self.backend.Transact( |
||||
address.Hex(), |
||||
HashRegAddr, |
||||
"", "", "", "", |
||||
data, |
||||
) |
||||
} |
||||
|
||||
// SetUrlToHash(from, hash, url) registers a url to a content hash so that the content can be fetched
|
||||
// address is used as sender for the transaction and will be the owner of a new
|
||||
// registry entry on first time use
|
||||
// FIXME: silently doing nothing if sender is not the owner
|
||||
// note that with content addressed storage, this step is no longer necessary
|
||||
func (self *Registrar) SetUrlToHash(address common.Address, hash common.Hash, url string) (txh string, err error) { |
||||
hashHex := common.Bytes2Hex(hash[:]) |
||||
var urlHex string |
||||
urlb := []byte(url) |
||||
var cnt byte |
||||
n := len(urlb) |
||||
|
||||
for n > 0 { |
||||
if n > 32 { |
||||
n = 32 |
||||
} |
||||
urlHex = common.Bytes2Hex(urlb[:n]) |
||||
urlb = urlb[n:] |
||||
n = len(urlb) |
||||
bcnt := make([]byte, 32) |
||||
bcnt[31] = cnt |
||||
data := registerUrlAbi + |
||||
hashHex + |
||||
common.Bytes2Hex(bcnt) + |
||||
common.Bytes2Hex(common.Hex2BytesFixed(urlHex, 32)) |
||||
txh, err = self.backend.Transact( |
||||
address.Hex(), |
||||
UrlHintAddr, |
||||
"", "", "", "", |
||||
data, |
||||
) |
||||
if err != nil { |
||||
return |
||||
} |
||||
cnt++ |
||||
} |
||||
return |
||||
} |
||||
|
||||
// HashToHash(key) resolves contenthash for key (a hash) using HashReg
|
||||
// resolution is costless non-transactional
|
||||
// implemented as direct retrieval from db
|
||||
func (self *Registrar) HashToHash(khash common.Hash) (chash common.Hash, err error) { |
||||
// look up in hashReg
|
||||
at := HashRegAddr[2:] |
||||
key := storageAddress(storageMapping(storageIdx2Addr(1), khash[:])) |
||||
hash := self.backend.StorageAt(at, key) |
||||
|
||||
if hash == "0x0" || len(hash) < 3 || (hash == common.Hash{}.Hex()) { |
||||
err = fmt.Errorf("content hash not found for '%v'", khash.Hex()) |
||||
return |
||||
} |
||||
copy(chash[:], common.Hex2BytesFixed(hash[2:], 32)) |
||||
return |
||||
} |
||||
|
||||
// HashToUrl(contenthash) resolves the url for contenthash using UrlHint
|
||||
// resolution is costless non-transactional
|
||||
// implemented as direct retrieval from db
|
||||
// if we use content addressed storage, this step is no longer necessary
|
||||
func (self *Registrar) HashToUrl(chash common.Hash) (uri string, err error) { |
||||
// look up in URL reg
|
||||
var str string = " " |
||||
var idx uint32 |
||||
for len(str) > 0 { |
||||
mapaddr := storageMapping(storageIdx2Addr(1), chash[:]) |
||||
key := storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(idx))) |
||||
hex := self.backend.StorageAt(UrlHintAddr[2:], key) |
||||
str = string(common.Hex2Bytes(hex[2:])) |
||||
l := 0 |
||||
for (l < len(str)) && (str[l] == 0) { |
||||
l++ |
||||
} |
||||
|
||||
str = str[l:] |
||||
uri = uri + str |
||||
idx++ |
||||
} |
||||
|
||||
if len(uri) == 0 { |
||||
err = fmt.Errorf("GetURLhint: URL hint not found for '%v'", chash.Hex()) |
||||
} |
||||
return |
||||
} |
||||
|
||||
func storageIdx2Addr(varidx uint32) []byte { |
||||
data := make([]byte, 32) |
||||
binary.BigEndian.PutUint32(data[28:32], varidx) |
||||
return data |
||||
} |
||||
|
||||
func storageMapping(addr, key []byte) []byte { |
||||
data := make([]byte, 64) |
||||
copy(data[0:32], key[0:32]) |
||||
copy(data[32:64], addr[0:32]) |
||||
sha := crypto.Sha3(data) |
||||
return sha |
||||
} |
||||
|
||||
func storageFixedArray(addr, idx []byte) []byte { |
||||
var carry byte |
||||
for i := 31; i >= 0; i-- { |
||||
var b byte = addr[i] + idx[i] + carry |
||||
if b < addr[i] { |
||||
carry = 1 |
||||
} else { |
||||
carry = 0 |
||||
} |
||||
addr[i] = b |
||||
} |
||||
return addr |
||||
} |
||||
|
||||
func storageAddress(addr []byte) string { |
||||
return common.ToHex(addr) |
||||
} |
||||
|
||||
func encodeAddress(address common.Address) string { |
||||
return addressAbiPrefix + address.Hex()[2:] |
||||
} |
||||
|
||||
func encodeName(name string, index uint8) (string, string) { |
||||
extra := common.Bytes2Hex([]byte(name)) |
||||
if len(name) > 32 { |
||||
return fmt.Sprintf("%064x", index), extra |
||||
} |
||||
return extra + falseHex[len(extra):], "" |
||||
} |
@ -0,0 +1,112 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package registrar |
||||
|
||||
import ( |
||||
"testing" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/crypto" |
||||
) |
||||
|
||||
type testBackend struct { |
||||
// contracts mock
|
||||
contracts map[string](map[string]string) |
||||
} |
||||
|
||||
var ( |
||||
text = "test" |
||||
codehash = common.StringToHash("1234") |
||||
hash = common.BytesToHash(crypto.Sha3([]byte(text))) |
||||
url = "bzz://bzzhash/my/path/contr.act" |
||||
) |
||||
|
||||
func NewTestBackend() *testBackend { |
||||
HashRegAddr = common.BigToAddress(common.Big0).Hex() //[2:]
|
||||
UrlHintAddr = common.BigToAddress(common.Big1).Hex() //[2:]
|
||||
self := &testBackend{} |
||||
self.contracts = make(map[string](map[string]string)) |
||||
|
||||
self.contracts[HashRegAddr[2:]] = make(map[string]string) |
||||
key := storageAddress(storageMapping(storageIdx2Addr(1), codehash[:])) |
||||
self.contracts[HashRegAddr[2:]][key] = hash.Hex() |
||||
|
||||
self.contracts[UrlHintAddr[2:]] = make(map[string]string) |
||||
mapaddr := storageMapping(storageIdx2Addr(1), hash[:]) |
||||
|
||||
key = storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(0))) |
||||
self.contracts[UrlHintAddr[2:]][key] = common.ToHex([]byte(url)) |
||||
key = storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(1))) |
||||
self.contracts[UrlHintAddr[2:]][key] = "0x0" |
||||
return self |
||||
} |
||||
|
||||
func (self *testBackend) StorageAt(ca, sa string) (res string) { |
||||
c := self.contracts[ca] |
||||
if c == nil { |
||||
return |
||||
} |
||||
res = c[sa] |
||||
return |
||||
} |
||||
|
||||
func (self *testBackend) Transact(fromStr, toStr, nonceStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, error) { |
||||
return "", nil |
||||
} |
||||
|
||||
func (self *testBackend) Call(fromStr, toStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, string, error) { |
||||
return "", "", nil |
||||
} |
||||
|
||||
func TestSetGlobalRegistrar(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
_, err := res.SetGlobalRegistrar("addresshex", common.BigToAddress(common.Big1)) |
||||
if err != nil { |
||||
t.Errorf("unexpected error: %v'", err) |
||||
} |
||||
} |
||||
|
||||
func TestHashToHash(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
// res.SetHashReg()
|
||||
|
||||
got, err := res.HashToHash(codehash) |
||||
if err != nil { |
||||
t.Errorf("expected no error, got %v", err) |
||||
} else { |
||||
if got != hash { |
||||
t.Errorf("incorrect result, expected '%v', got '%v'", hash.Hex(), got.Hex()) |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestHashToUrl(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
// res.SetUrlHint()
|
||||
|
||||
got, err := res.HashToUrl(hash) |
||||
if err != nil { |
||||
t.Errorf("expected error, got %v", err) |
||||
} else { |
||||
if got != url { |
||||
t.Errorf("incorrect result, expected '%v', got '%s'", url, got) |
||||
} |
||||
} |
||||
} |
@ -1,36 +0,0 @@ |
||||
package resolver |
||||
|
||||
const ( // built-in contracts address and code
|
||||
ContractCodeURLhint = "0x60c180600c6000396000f30060003560e060020a90048063300a3bbf14601557005b6024600435602435604435602a565b60006000f35b6000600084815260200190815260200160002054600160a060020a0316600014806078575033600160a060020a03166000600085815260200190815260200160002054600160a060020a0316145b607f5760bc565b336000600085815260200190815260200160002081905550806001600085815260200190815260200160002083610100811060b657005b01819055505b50505056" |
||||
/* |
||||
contract URLhint { |
||||
function register(uint256 _hash, uint8 idx, uint256 _url) { |
||||
if (owner[_hash] == 0 || owner[_hash] == msg.sender) { |
||||
owner[_hash] = msg.sender; |
||||
url[_hash][idx] = _url; |
||||
} |
||||
} |
||||
mapping (uint256 => address) owner; |
||||
mapping (uint256 => uint256[256]) url; |
||||
} |
||||
*/ |
||||
|
||||
ContractCodeHashReg = "0x609880600c6000396000f30060003560e060020a9004806331e12c2014601f578063d66d6c1014602b57005b6025603d565b60006000f35b6037600435602435605d565b60006000f35b600054600160a060020a0316600014605357605b565b336000819055505b565b600054600160a060020a031633600160a060020a031614607b576094565b8060016000848152602001908152602001600020819055505b505056" |
||||
/* |
||||
contract HashReg { |
||||
function setowner() { |
||||
if (owner == 0) { |
||||
owner = msg.sender; |
||||
} |
||||
} |
||||
function register(uint256 _key, uint256 _content) { |
||||
if (msg.sender == owner) { |
||||
content[_key] = _content; |
||||
} |
||||
} |
||||
address owner; |
||||
mapping (uint256 => uint256) content; |
||||
} |
||||
*/ |
||||
|
||||
) |
@ -1,232 +0,0 @@ |
||||
package resolver |
||||
|
||||
import ( |
||||
"encoding/binary" |
||||
"fmt" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/crypto" |
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
) |
||||
|
||||
/* |
||||
Resolver implements the Ethereum DNS mapping |
||||
HashReg : Key Hash (hash of domain name or contract code) -> Content Hash |
||||
UrlHint : Content Hash -> Url Hint |
||||
|
||||
The resolver is meant to be called by the roundtripper transport implementation |
||||
of a url scheme |
||||
*/ |
||||
|
||||
// // contract addresses will be hardcoded after they're created
|
||||
var UrlHintContractAddress, HashRegContractAddress string |
||||
|
||||
const ( |
||||
txValue = "0" |
||||
txGas = "100000" |
||||
txGasPrice = "1000000000000" |
||||
) |
||||
|
||||
func abi(s string) string { |
||||
return common.ToHex(crypto.Sha3([]byte(s))[:4]) |
||||
} |
||||
|
||||
var ( |
||||
registerContentHashAbi = abi("register(uint256,uint256)") |
||||
registerUrlAbi = abi("register(uint256,uint8,uint256)") |
||||
setOwnerAbi = abi("setowner()") |
||||
) |
||||
|
||||
type Backend interface { |
||||
StorageAt(string, string) string |
||||
Transact(fromStr, toStr, nonceStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, error) |
||||
} |
||||
|
||||
type Resolver struct { |
||||
backend Backend |
||||
} |
||||
|
||||
func New(eth Backend) *Resolver { |
||||
return &Resolver{eth} |
||||
} |
||||
|
||||
// for testing and play temporarily
|
||||
// ideally the HashReg and UrlHint contracts should be in the genesis block
|
||||
// if we got build-in support for natspec/contract info
|
||||
// there should be only one of these officially endorsed
|
||||
// addresses as constants
|
||||
// TODO: could get around this with namereg, check
|
||||
func (self *Resolver) CreateContracts(addr common.Address) (err error) { |
||||
HashRegContractAddress, err = self.backend.Transact(addr.Hex(), "", "", txValue, txGas, txGasPrice, ContractCodeHashReg) |
||||
if err != nil { |
||||
return |
||||
} |
||||
UrlHintContractAddress, err = self.backend.Transact(addr.Hex(), "", "", txValue, txGas, txGasPrice, ContractCodeURLhint) |
||||
glog.V(logger.Detail).Infof("HashReg @ %v\nUrlHint @ %v\n", HashRegContractAddress, UrlHintContractAddress) |
||||
return |
||||
} |
||||
|
||||
// called as first step in the registration process on HashReg
|
||||
func (self *Resolver) SetOwner(address common.Address) (txh string, err error) { |
||||
return self.backend.Transact( |
||||
address.Hex(), |
||||
HashRegContractAddress, |
||||
"", txValue, txGas, txGasPrice, |
||||
setOwnerAbi, |
||||
) |
||||
} |
||||
|
||||
// registers some content hash to a key/code hash
|
||||
// e.g., the contract Info combined Json Doc's ContentHash
|
||||
// to CodeHash of a contract or hash of a domain
|
||||
// kept
|
||||
func (self *Resolver) RegisterContentHash(address common.Address, codehash, dochash common.Hash) (txh string, err error) { |
||||
_, err = self.SetOwner(address) |
||||
if err != nil { |
||||
return |
||||
} |
||||
codehex := common.Bytes2Hex(codehash[:]) |
||||
dochex := common.Bytes2Hex(dochash[:]) |
||||
|
||||
data := registerContentHashAbi + codehex + dochex |
||||
return self.backend.Transact( |
||||
address.Hex(), |
||||
HashRegContractAddress, |
||||
"", txValue, txGas, txGasPrice, |
||||
data, |
||||
) |
||||
} |
||||
|
||||
// registers a url to a content hash so that the content can be fetched
|
||||
// address is used as sender for the transaction and will be the owner of a new
|
||||
// registry entry on first time use
|
||||
// FIXME: silently doing nothing if sender is not the owner
|
||||
// note that with content addressed storage, this step is no longer necessary
|
||||
// it could be purely
|
||||
func (self *Resolver) RegisterUrl(address common.Address, hash common.Hash, url string) (txh string, err error) { |
||||
hashHex := common.Bytes2Hex(hash[:]) |
||||
var urlHex string |
||||
urlb := []byte(url) |
||||
var cnt byte |
||||
n := len(urlb) |
||||
|
||||
for n > 0 { |
||||
if n > 32 { |
||||
n = 32 |
||||
} |
||||
urlHex = common.Bytes2Hex(urlb[:n]) |
||||
urlb = urlb[n:] |
||||
n = len(urlb) |
||||
bcnt := make([]byte, 32) |
||||
bcnt[31] = cnt |
||||
data := registerUrlAbi + |
||||
hashHex + |
||||
common.Bytes2Hex(bcnt) + |
||||
common.Bytes2Hex(common.Hex2BytesFixed(urlHex, 32)) |
||||
txh, err = self.backend.Transact( |
||||
address.Hex(), |
||||
UrlHintContractAddress, |
||||
"", txValue, txGas, txGasPrice, |
||||
data, |
||||
) |
||||
if err != nil { |
||||
return |
||||
} |
||||
cnt++ |
||||
} |
||||
return |
||||
} |
||||
|
||||
func (self *Resolver) Register(address common.Address, codehash, dochash common.Hash, url string) (txh string, err error) { |
||||
|
||||
_, err = self.RegisterContentHash(address, codehash, dochash) |
||||
if err != nil { |
||||
return |
||||
} |
||||
return self.RegisterUrl(address, dochash, url) |
||||
} |
||||
|
||||
// resolution is costless non-transactional
|
||||
// implemented as direct retrieval from db
|
||||
func (self *Resolver) KeyToContentHash(khash common.Hash) (chash common.Hash, err error) { |
||||
// look up in hashReg
|
||||
at := common.Bytes2Hex(common.FromHex(HashRegContractAddress)) |
||||
key := storageAddress(storageMapping(storageIdx2Addr(1), khash[:])) |
||||
hash := self.backend.StorageAt(at, key) |
||||
|
||||
if hash == "0x0" || len(hash) < 3 { |
||||
err = fmt.Errorf("content hash not found for '%v'", khash.Hex()) |
||||
return |
||||
} |
||||
copy(chash[:], common.Hex2BytesFixed(hash[2:], 32)) |
||||
return |
||||
} |
||||
|
||||
// retrieves the url-hint for the content hash -
|
||||
// if we use content addressed storage, this step is no longer necessary
|
||||
func (self *Resolver) ContentHashToUrl(chash common.Hash) (uri string, err error) { |
||||
// look up in URL reg
|
||||
var str string = " " |
||||
var idx uint32 |
||||
for len(str) > 0 { |
||||
mapaddr := storageMapping(storageIdx2Addr(1), chash[:]) |
||||
key := storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(idx))) |
||||
hex := self.backend.StorageAt(UrlHintContractAddress, key) |
||||
str = string(common.Hex2Bytes(hex[2:])) |
||||
l := len(str) |
||||
for (l > 0) && (str[l-1] == 0) { |
||||
l-- |
||||
} |
||||
str = str[:l] |
||||
uri = uri + str |
||||
idx++ |
||||
} |
||||
|
||||
if len(uri) == 0 { |
||||
err = fmt.Errorf("GetURLhint: URL hint not found for '%v'", chash.Hex()) |
||||
} |
||||
return |
||||
} |
||||
|
||||
func (self *Resolver) KeyToUrl(key common.Hash) (uri string, hash common.Hash, err error) { |
||||
// look up in urlHint
|
||||
hash, err = self.KeyToContentHash(key) |
||||
if err != nil { |
||||
return |
||||
} |
||||
uri, err = self.ContentHashToUrl(hash) |
||||
return |
||||
} |
||||
|
||||
func storageIdx2Addr(varidx uint32) []byte { |
||||
data := make([]byte, 32) |
||||
binary.BigEndian.PutUint32(data[28:32], varidx) |
||||
return data |
||||
} |
||||
|
||||
func storageMapping(addr, key []byte) []byte { |
||||
data := make([]byte, 64) |
||||
copy(data[0:32], key[0:32]) |
||||
copy(data[32:64], addr[0:32]) |
||||
sha := crypto.Sha3(data) |
||||
return sha |
||||
} |
||||
|
||||
func storageFixedArray(addr, idx []byte) []byte { |
||||
var carry byte |
||||
for i := 31; i >= 0; i-- { |
||||
var b byte = addr[i] + idx[i] + carry |
||||
if b < addr[i] { |
||||
carry = 1 |
||||
} else { |
||||
carry = 0 |
||||
} |
||||
addr[i] = b |
||||
} |
||||
return addr |
||||
} |
||||
|
||||
func storageAddress(addr []byte) string { |
||||
return common.ToHex(addr) |
||||
} |
@ -1,93 +0,0 @@ |
||||
package resolver |
||||
|
||||
import ( |
||||
"testing" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/crypto" |
||||
) |
||||
|
||||
type testBackend struct { |
||||
// contracts mock
|
||||
contracts map[string](map[string]string) |
||||
} |
||||
|
||||
var ( |
||||
text = "test" |
||||
codehash = common.StringToHash("1234") |
||||
hash = common.BytesToHash(crypto.Sha3([]byte(text))) |
||||
url = "bzz://bzzhash/my/path/contr.act" |
||||
) |
||||
|
||||
func NewTestBackend() *testBackend { |
||||
HashRegContractAddress = common.BigToAddress(common.Big0).Hex()[2:] |
||||
UrlHintContractAddress = common.BigToAddress(common.Big1).Hex()[2:] |
||||
self := &testBackend{} |
||||
self.contracts = make(map[string](map[string]string)) |
||||
|
||||
self.contracts[HashRegContractAddress] = make(map[string]string) |
||||
key := storageAddress(storageMapping(storageIdx2Addr(1), codehash[:])) |
||||
self.contracts[HashRegContractAddress][key] = hash.Hex() |
||||
|
||||
self.contracts[UrlHintContractAddress] = make(map[string]string) |
||||
mapaddr := storageMapping(storageIdx2Addr(1), hash[:]) |
||||
|
||||
key = storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(0))) |
||||
self.contracts[UrlHintContractAddress][key] = common.ToHex([]byte(url)) |
||||
key = storageAddress(storageFixedArray(mapaddr, storageIdx2Addr(1))) |
||||
self.contracts[UrlHintContractAddress][key] = "0x00" |
||||
return self |
||||
} |
||||
|
||||
func (self *testBackend) StorageAt(ca, sa string) (res string) { |
||||
c := self.contracts[ca] |
||||
if c == nil { |
||||
return |
||||
} |
||||
res = c[sa] |
||||
return |
||||
} |
||||
|
||||
func (self *testBackend) Transact(fromStr, toStr, nonceStr, valueStr, gasStr, gasPriceStr, codeStr string) (string, error) { |
||||
return "", nil |
||||
} |
||||
|
||||
func TestKeyToContentHash(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
|
||||
got, err := res.KeyToContentHash(codehash) |
||||
if err != nil { |
||||
t.Errorf("expected no error, got %v", err) |
||||
} else { |
||||
if got != hash { |
||||
t.Errorf("incorrect result, expected '%v', got '%v'", hash.Hex(), got.Hex()) |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestContentHashToUrl(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
got, err := res.ContentHashToUrl(hash) |
||||
if err != nil { |
||||
t.Errorf("expected no error, got %v", err) |
||||
} else { |
||||
if got != url { |
||||
t.Errorf("incorrect result, expected '%v', got '%s'", url, got) |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestKeyToUrl(t *testing.T) { |
||||
b := NewTestBackend() |
||||
res := New(b) |
||||
got, _, err := res.KeyToUrl(codehash) |
||||
if err != nil { |
||||
t.Errorf("expected no error, got %v", err) |
||||
} else { |
||||
if got != url { |
||||
t.Errorf("incorrect result, expected \n'%s', got \n'%s'", url, got) |
||||
} |
||||
} |
||||
} |
@ -0,0 +1,72 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package core |
||||
|
||||
import ( |
||||
"bytes" |
||||
"encoding/json" |
||||
"io/ioutil" |
||||
"net/http" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/core/types" |
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
"github.com/ethereum/go-ethereum/rlp" |
||||
) |
||||
|
||||
// DisabledBadBlockReporting can be set to prevent blocks being reported.
|
||||
var DisableBadBlockReporting = true |
||||
|
||||
// ReportBlock reports the block to the block reporting tool found at
|
||||
// badblocks.ethdev.com
|
||||
func ReportBlock(block *types.Block, err error) { |
||||
if DisableBadBlockReporting { |
||||
return |
||||
} |
||||
|
||||
const url = "https://badblocks.ethdev.com" |
||||
|
||||
blockRlp, _ := rlp.EncodeToBytes(block) |
||||
data := map[string]interface{}{ |
||||
"block": common.Bytes2Hex(blockRlp), |
||||
"errortype": err.Error(), |
||||
"hints": map[string]interface{}{ |
||||
"receipts": "NYI", |
||||
"vmtrace": "NYI", |
||||
}, |
||||
} |
||||
jsonStr, _ := json.Marshal(map[string]interface{}{"method": "eth_badBlock", "params": []interface{}{data}, "id": "1", "jsonrpc": "2.0"}) |
||||
|
||||
req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonStr)) |
||||
req.Header.Set("Content-Type", "application/json") |
||||
|
||||
client := &http.Client{} |
||||
resp, err := client.Do(req) |
||||
if err != nil { |
||||
glog.V(logger.Error).Infoln("POST err:", err) |
||||
return |
||||
} |
||||
defer resp.Body.Close() |
||||
|
||||
if glog.V(logger.Debug) { |
||||
glog.Infoln("response Status:", resp.Status) |
||||
glog.Infoln("response Headers:", resp.Header) |
||||
body, _ := ioutil.ReadAll(resp.Body) |
||||
glog.Infoln("response Body:", string(body)) |
||||
} |
||||
} |
@ -0,0 +1,114 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package core |
||||
|
||||
import ( |
||||
"bytes" |
||||
"math/big" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/core/types" |
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
"github.com/ethereum/go-ethereum/params" |
||||
"github.com/ethereum/go-ethereum/rlp" |
||||
) |
||||
|
||||
// CalcDifficulty is the difficulty adjustment algorithm. It returns
|
||||
// the difficulty that a new block b should have when created at time
|
||||
// given the parent block's time and difficulty.
|
||||
func CalcDifficulty(time int64, parentTime int64, parentDiff *big.Int) *big.Int { |
||||
diff := new(big.Int) |
||||
adjust := new(big.Int).Div(parentDiff, params.DifficultyBoundDivisor) |
||||
if big.NewInt(time-parentTime).Cmp(params.DurationLimit) < 0 { |
||||
diff.Add(parentDiff, adjust) |
||||
} else { |
||||
diff.Sub(parentDiff, adjust) |
||||
} |
||||
if diff.Cmp(params.MinimumDifficulty) < 0 { |
||||
return params.MinimumDifficulty |
||||
} |
||||
return diff |
||||
} |
||||
|
||||
// CalcTD computes the total difficulty of block.
|
||||
func CalcTD(block, parent *types.Block) *big.Int { |
||||
if parent == nil { |
||||
return block.Difficulty() |
||||
} |
||||
d := block.Difficulty() |
||||
d.Add(d, parent.Td) |
||||
return d |
||||
} |
||||
|
||||
// CalcGasLimit computes the gas limit of the next block after parent.
|
||||
// The result may be modified by the caller.
|
||||
func CalcGasLimit(parent *types.Block) *big.Int { |
||||
decay := new(big.Int).Div(parent.GasLimit(), params.GasLimitBoundDivisor) |
||||
contrib := new(big.Int).Mul(parent.GasUsed(), big.NewInt(3)) |
||||
contrib = contrib.Div(contrib, big.NewInt(2)) |
||||
contrib = contrib.Div(contrib, params.GasLimitBoundDivisor) |
||||
|
||||
gl := new(big.Int).Sub(parent.GasLimit(), decay) |
||||
gl = gl.Add(gl, contrib) |
||||
gl = gl.Add(gl, big.NewInt(1)) |
||||
gl.Set(common.BigMax(gl, params.MinGasLimit)) |
||||
|
||||
if gl.Cmp(params.GenesisGasLimit) < 0 { |
||||
gl.Add(parent.GasLimit(), decay) |
||||
gl.Set(common.BigMin(gl, params.GenesisGasLimit)) |
||||
} |
||||
return gl |
||||
} |
||||
|
||||
// GetBlockByHash returns the block corresponding to the hash or nil if not found
|
||||
func GetBlockByHash(db common.Database, hash common.Hash) *types.Block { |
||||
data, _ := db.Get(append(blockHashPre, hash[:]...)) |
||||
if len(data) == 0 { |
||||
return nil |
||||
} |
||||
var block types.StorageBlock |
||||
if err := rlp.Decode(bytes.NewReader(data), &block); err != nil { |
||||
glog.V(logger.Error).Infof("invalid block RLP for hash %x: %v", hash, err) |
||||
return nil |
||||
} |
||||
return (*types.Block)(&block) |
||||
} |
||||
|
||||
// GetBlockByHash returns the canonical block by number or nil if not found
|
||||
func GetBlockByNumber(db common.Database, number uint64) *types.Block { |
||||
key, _ := db.Get(append(blockNumPre, big.NewInt(int64(number)).Bytes()...)) |
||||
if len(key) == 0 { |
||||
return nil |
||||
} |
||||
|
||||
return GetBlockByHash(db, common.BytesToHash(key)) |
||||
} |
||||
|
||||
// WriteHead force writes the current head
|
||||
func WriteHead(db common.Database, block *types.Block) error { |
||||
key := append(blockNumPre, block.Number().Bytes()...) |
||||
err := db.Put(key, block.Hash().Bytes()) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
err = db.Put([]byte("LastBlock"), block.Hash().Bytes()) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
return nil |
||||
} |
@ -1 +1,17 @@ |
||||
// Copyright 2014 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum 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 Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package core |
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue