Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 20e2d1c02d | |||
| 99aa9dd380 | |||
| 4e87116c5f | |||
| dcf0dd80e1 | |||
| 16723e5948 | |||
| 7d7ba167a2 | |||
| 1430f43a63 | |||
| 532d7b4471 | |||
| 88db4e6098 | |||
| 8c5e9b9f26 | |||
| ead33e2744 | |||
| 1afb64969c |
+1
-1
@@ -1,4 +1,4 @@
|
||||
_build
|
||||
c_src
|
||||
priv
|
||||
ebin
|
||||
ebin/*.beam
|
||||
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -12,10 +12,10 @@ dialyzer:
|
||||
$(REBAR) dialyzer
|
||||
|
||||
ct: all
|
||||
$(REBAR) ct --suite=test/aecuckoo_SUITE
|
||||
$(REBAR) ct --suite=test/gmcuckoo_SUITE
|
||||
|
||||
eunit:
|
||||
$(REBAR) eunit --module=aeminer_pow_tests,aeminer_pow_cuckoo_tests
|
||||
$(REBAR) eunit --module=gmminer_pow_tests,gmminer_pow_cuckoo_tests
|
||||
|
||||
clean:
|
||||
$(REBAR) clean
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# aeminer
|
||||
# gmminer
|
||||
|
||||
Erlang library to work with CPU and CUDA cuckoo miners.
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{application,gmminer,
|
||||
[{description,"Gajumaru Cuckoo Cycle mining support"},
|
||||
{vsn,"1.0.1"},
|
||||
{registered,[]},
|
||||
{applications,[kernel,stdlib,gmcuckoo]},
|
||||
{env,[]},
|
||||
{modules,[gmminer_blake2b_256,gmminer_pow,gmminer_pow_cuckoo,
|
||||
gmminer_siphash24]},
|
||||
{maintainers,[]},
|
||||
{licenses,[]},
|
||||
{links,[]}]}.
|
||||
+1
-6
@@ -1,5 +1,4 @@
|
||||
{deps, [
|
||||
{hut, "1.3.0"},
|
||||
|
||||
%% Cuckoo prebuilt CUDA binaries.
|
||||
{aecuckooprebuilt,
|
||||
@@ -8,11 +7,7 @@
|
||||
|
||||
%% Cuckoo CPU miners (not prebuilt).
|
||||
{aecuckoo, {git, "https://github.com/aeternity/aecuckoo.git",
|
||||
{ref, "996ffcd"}}},
|
||||
|
||||
%% This is used just in one place, just to get blake2b_256 hash.
|
||||
{enacl, {git, "https://github.com/aeternity/enacl.git",
|
||||
{ref, "67fceef"}}}
|
||||
{ref, "996ffcd"}}}
|
||||
]}.
|
||||
|
||||
{plugins, [{rebar_aecuckooprebuilt_dep, {git, "https://github.com/aeternity/rebar3-cuckoo-prebuilt-plugin.git",
|
||||
|
||||
+6
-4
@@ -1,4 +1,4 @@
|
||||
{"1.1.0",
|
||||
{"1.2.0",
|
||||
[{<<"aecuckoo">>,
|
||||
{git,"https://github.com/aeternity/aecuckoo.git",
|
||||
{ref,"996ffcdb336f1c2254ea8e1b1a657b05b7ea4a81"}},
|
||||
@@ -9,11 +9,13 @@
|
||||
{ref,"90afb699dc9cc41d033a7c8551179d32b3bd569d"}}},
|
||||
0},
|
||||
{<<"enacl">>,
|
||||
{git,"https://github.com/aeternity/enacl.git",
|
||||
{ref,"67fceef42c0d055570f2e67b571f8d1f8de2f204"}},
|
||||
{git,"https://git.qpq.swiss/QPQ-AG/enacl.git",
|
||||
{ref,"4eb7ec70084ba7c87b1af8797c4c4e90c84f95a2"}},
|
||||
0},
|
||||
{<<"hut">>,{pkg,<<"hut">>,<<"1.3.0">>},0}]}.
|
||||
[
|
||||
{pkg_hash,[
|
||||
{<<"hut">>, <<"71F2F054E657C03F959CF1ACC43F436EA87580696528CA2A55C8AFB1B06C85E7">>}]}
|
||||
{<<"hut">>, <<"71F2F054E657C03F959CF1ACC43F436EA87580696528CA2A55C8AFB1B06C85E7">>}]},
|
||||
{pkg_hash_ext,[
|
||||
{<<"hut">>, <<"7E15D28555D8A1F2B5A3A931EC120AF0753E4853A4C66053DB354F35BF9AB563">>}]}
|
||||
].
|
||||
|
||||
@@ -1,14 +1,11 @@
|
||||
{application, aeminer,
|
||||
[{description, "Aeternity miner"},
|
||||
{application, gmminer,
|
||||
[{description, "Gajumaru miner"},
|
||||
{vsn, "1.0.0"},
|
||||
{registered, []},
|
||||
{applications,
|
||||
[kernel,
|
||||
stdlib,
|
||||
enacl,
|
||||
hut,
|
||||
aecuckoo,
|
||||
aecuckooprebuilt
|
||||
gmcuckoo
|
||||
]},
|
||||
{env,[]},
|
||||
{modules, []},
|
||||
@@ -1,4 +1,4 @@
|
||||
-module(aeminer_blake2b_256).
|
||||
-module(gmminer_blake2b_256).
|
||||
|
||||
-export([hash/1]).
|
||||
|
||||
@@ -14,5 +14,5 @@
|
||||
|
||||
-spec hash(hashable()) -> hash().
|
||||
hash(Bin) ->
|
||||
enacl:generichash(?HASH_BYTES_SIZE, Bin).
|
||||
eblake2:blake2b(?HASH_BYTES_SIZE, Bin).
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
%%% Common functions and behaviour for Proof of Work
|
||||
%%% @end
|
||||
%%%=============================================================================
|
||||
-module(aeminer_pow).
|
||||
-module(gmminer_pow).
|
||||
|
||||
-export([integer_to_scientific/1,
|
||||
next_nonce/2,
|
||||
@@ -22,7 +22,7 @@
|
||||
instance/0
|
||||
]).
|
||||
|
||||
-include("aeminer.hrl").
|
||||
-include("gmminer.hrl").
|
||||
|
||||
-type nonce() :: ?MIN_NONCE..?MAX_NONCE.
|
||||
|
||||
@@ -38,7 +38,7 @@
|
||||
|
||||
-type instance() :: non_neg_integer().
|
||||
|
||||
-type config() :: aeminer_pow_cuckoo:config().
|
||||
-type config() :: gmminer_pow_cuckoo:config().
|
||||
|
||||
%%------------------------------------------------------------------------------
|
||||
%% Target threshold and difficulty
|
||||
@@ -114,7 +114,7 @@ target_to_difficulty(SciTgt) ->
|
||||
|
||||
-spec next_nonce(nonce(), config()) -> nonce().
|
||||
next_nonce(Nonce, Cfg) ->
|
||||
Nonce + aeminer_pow_cuckoo:repeats(Cfg).
|
||||
Nonce + gmminer_pow_cuckoo:repeats(Cfg).
|
||||
|
||||
-spec pick_nonce() -> nonce().
|
||||
pick_nonce() ->
|
||||
@@ -122,7 +122,7 @@ pick_nonce() ->
|
||||
|
||||
-spec trim_nonce(nonce(), config()) -> nonce().
|
||||
trim_nonce(Nonce, Cfg) ->
|
||||
case Nonce + aeminer_pow_cuckoo:repeats(Cfg) < ?MAX_NONCE of
|
||||
case Nonce + gmminer_pow_cuckoo:repeats(Cfg) < ?MAX_NONCE of
|
||||
true -> Nonce;
|
||||
false -> 0
|
||||
end.
|
||||
@@ -1,4 +1,5 @@
|
||||
%%%-------------------------------------------------------------------
|
||||
%%% @copyright (C) 2025, QPQ AG
|
||||
%%% @copyright (C) 2019, Aeternity Anstalt
|
||||
%%% @doc
|
||||
%%% A library providing Cuckoo Cycle PoW generation and verification.
|
||||
@@ -13,7 +14,7 @@
|
||||
%%%
|
||||
%%% @end
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(aeminer_pow_cuckoo).
|
||||
-module(gmminer_pow_cuckoo).
|
||||
|
||||
-export([config/7,
|
||||
addressed_instances/1,
|
||||
@@ -26,13 +27,18 @@
|
||||
|
||||
-export([hash_data/1,
|
||||
generate/5,
|
||||
generate_all/5,
|
||||
generate_from_hash/5,
|
||||
generate_from_hash/6,
|
||||
verify/5,
|
||||
verify_proof/4,
|
||||
verify_proof_from_hash/4,
|
||||
get_target/2
|
||||
get_target/2,
|
||||
test_target/3
|
||||
]).
|
||||
|
||||
-export([ set_edge_bits/2 ]).
|
||||
|
||||
-export_type([hashable/0,
|
||||
hash/0,
|
||||
exec/0,
|
||||
@@ -53,20 +59,20 @@
|
||||
]).
|
||||
-endif.
|
||||
|
||||
-include_lib("hut/include/hut.hrl").
|
||||
-include("aeminer.hrl").
|
||||
-include_lib("kernel/include/logger.hrl").
|
||||
-include("gmminer.hrl").
|
||||
|
||||
-type hashable() :: aeminer_blake2b_256:hashable().
|
||||
-type hashable() :: gmminer_blake2b_256:hashable().
|
||||
|
||||
-type hash() :: aeminer_blake2b_256:hash().
|
||||
-type hash() :: gmminer_blake2b_256:hash().
|
||||
|
||||
-type nonce() :: aeminer_pow:nonce().
|
||||
-type nonce() :: gmminer_pow:nonce().
|
||||
|
||||
-type int_target() :: aeminer_pow:int_target().
|
||||
-type int_target() :: gmminer_pow:int_target().
|
||||
|
||||
-type sci_target() :: aeminer_pow:sci_target().
|
||||
-type sci_target() :: gmminer_pow:sci_target().
|
||||
|
||||
-type instance() :: aeminer_pow:instance()
|
||||
-type instance() :: gmminer_pow:instance()
|
||||
| undefined.
|
||||
|
||||
-type exec() :: binary().
|
||||
@@ -81,10 +87,11 @@
|
||||
|
||||
-type edge_bits() :: pos_integer().
|
||||
|
||||
-type instances() :: [aeminer_pow:instance()]
|
||||
-type instances() :: [gmminer_pow:instance()]
|
||||
| undefined.
|
||||
|
||||
-type solution() :: [integer()].
|
||||
-type solutions() :: [{nonce(), solution()}].
|
||||
|
||||
-type output_parser_fun() :: fun(([string()], state()) ->
|
||||
{ok, term(), term()} | {error, term()}).
|
||||
@@ -102,12 +109,14 @@
|
||||
-opaque config() :: #config{}.
|
||||
|
||||
-record(state, {
|
||||
os_pid :: integer() | undefined,
|
||||
port :: port() | undefined,
|
||||
buffer = [] :: string(),
|
||||
target :: sci_target() | undefined,
|
||||
edge_bits :: edge_bits(),
|
||||
parser :: output_parser_fun()
|
||||
os_pid :: integer() | undefined,
|
||||
port :: port() | undefined,
|
||||
buffer = [] :: string(),
|
||||
solutions = [] :: solutions(),
|
||||
keep_going = false :: boolean(),
|
||||
target :: sci_target() | undefined,
|
||||
edge_bits :: edge_bits(),
|
||||
parser :: output_parser_fun()
|
||||
}).
|
||||
|
||||
-type state() :: #state{}.
|
||||
@@ -156,7 +165,12 @@ hex_enc_header(#config{hex_enc_header = HexEncHdr}) ->
|
||||
|
||||
-spec hash_data(hashable()) -> hash().
|
||||
hash_data(Data) ->
|
||||
aeminer_blake2b_256:hash(Data).
|
||||
gmminer_blake2b_256:hash(Data).
|
||||
|
||||
-spec set_edge_bits(edge_bits(), config()) -> config().
|
||||
set_edge_bits(Bits, Config)
|
||||
when is_integer(Bits), Bits > 0, is_record(Config, config) ->
|
||||
Config#config{edge_bits = Bits}.
|
||||
|
||||
%%------------------------------------------------------------------------------
|
||||
%% Proof of Work generation with default settings
|
||||
@@ -179,20 +193,35 @@ hash_data(Data) ->
|
||||
{ok, {nonce(), solution()}} | {error, no_solution} | {error, {runtime, term()}}.
|
||||
generate(Data, Target, Nonce, Config, Instance) when
|
||||
Nonce >= 0, Nonce =< ?MAX_NONCE ->
|
||||
Hash = aeminer_blake2b_256:hash(Data),
|
||||
Hash = gmminer_blake2b_256:hash(Data),
|
||||
generate_from_hash(Hash, Target, Nonce, Config, Instance).
|
||||
|
||||
-spec generate_all(hashable(), sci_target(), nonce(), config(), instance()) ->
|
||||
{ok, solutions()} | {error, no_solution} | {error, {runtime, term()}}.
|
||||
generate_all(Data, Target, Nonce, Config, Instance) when
|
||||
Nonce >= 0, Nonce =< ?MAX_NONCE ->
|
||||
Hash = gmminer_blake2b_256:hash(Data),
|
||||
generate_from_hash(Hash, Target, Nonce, Config, Instance, true).
|
||||
|
||||
-spec generate_from_hash(hash(), sci_target(), nonce(), config(), instance()) ->
|
||||
{ok, {nonce(), solution()}} | {error, no_solution} | {error, {runtime, term()}}.
|
||||
generate_from_hash(Hash, Target, Nonce, Config, Instance) ->
|
||||
generate_from_hash(Hash, Target, Nonce, Config, Instance, false).
|
||||
|
||||
|
||||
-spec generate_from_hash(hash(), sci_target(), nonce(), config(), instance(), boolean()) ->
|
||||
{ok, {nonce(), solution()}} | {ok, solutions()} | {error, no_solution} | {error, {runtime, term()}}.
|
||||
generate_from_hash(Hash, Target, Nonce, Config, Instance, KeepGoing) ->
|
||||
Hash64 = base64:encode_to_string(Hash),
|
||||
?log(debug, "Generating solution for data hash ~p and nonce ~p with target ~p.",
|
||||
?LOG_DEBUG("Generating solution for data hash ~p and nonce ~p with target ~p.",
|
||||
[Hash, Nonce, Target]),
|
||||
case generate_int(Hash64, Nonce, Target, Config, Instance) of
|
||||
case generate_int(Hash64, Nonce, Target, Config, Instance, KeepGoing) of
|
||||
{ok, Nonce1, Soln} ->
|
||||
{ok, {Nonce1, Soln}};
|
||||
{ok, _} = Ok ->
|
||||
Ok;
|
||||
{error, no_value} ->
|
||||
?log(debug, "No cuckoo solution found", []),
|
||||
?LOG_DEBUG("No cuckoo solution found", []),
|
||||
{error, no_solution};
|
||||
{error, Rsn} ->
|
||||
%% Exec failed (segfault, not found, etc.): let miner decide
|
||||
@@ -222,7 +251,7 @@ verify(Data, Nonce, Soln, Target, EdgeBits) when
|
||||
verify_proof(Data, Nonce, Solution, EdgeBits) ->
|
||||
%% Cuckoo has an 80 byte header, we have to use that as well
|
||||
%% packed Hash + Nonce = 56 bytes, add 24 bytes of 0:s
|
||||
Hash = aeminer_blake2b_256:hash(Data),
|
||||
Hash = gmminer_blake2b_256:hash(Data),
|
||||
verify_proof_from_hash(Hash, Nonce, Solution, EdgeBits).
|
||||
|
||||
-spec verify_proof_from_hash(hash(), nonce(), solution(), edge_bits()) -> boolean().
|
||||
@@ -235,7 +264,7 @@ verify_proof_from_hash(Hash, Nonce, Solution, EdgeBits) ->
|
||||
get_target(Soln, EdgeBits) when is_list(Soln), length(Soln) =:= ?SOLUTION_SIZE ->
|
||||
NodeSize = get_node_size(EdgeBits),
|
||||
Bin = solution_to_binary(lists:sort(Soln), NodeSize * 8, <<>>),
|
||||
Hash = aeminer_blake2b_256:hash(Bin),
|
||||
Hash = gmminer_blake2b_256:hash(Bin),
|
||||
<<Val:32/big-unsigned-integer-unit:8>> = Hash,
|
||||
Val.
|
||||
|
||||
@@ -243,7 +272,7 @@ get_target(Soln, EdgeBits) when is_list(Soln), length(Soln) =:= ?SOLUTION_SIZE -
|
||||
|
||||
generate_int(Hash, Nonce, Target,
|
||||
#config{exec = Exec0, extra_args = ExtraArgs0,
|
||||
hex_enc_header = HexEncHdr} = Config, Instance) ->
|
||||
hex_enc_header = HexEncHdr} = Config, Instance, KeepGoing) ->
|
||||
ExtraArgs =
|
||||
case is_miner_instance_addressation_enabled(Config) of
|
||||
true -> binary_to_list(ExtraArgs0) ++ " -d " ++ integer_to_list(Instance);
|
||||
@@ -256,13 +285,13 @@ generate_int(Hash, Nonce, Target,
|
||||
end,
|
||||
ExecBinDir = exec_bin_dir(Config),
|
||||
Exec = binary_to_list(Exec0),
|
||||
generate_int(EncodedHash, Nonce, Target, ExecBinDir, Exec, ExtraArgs, Config).
|
||||
generate_int(EncodedHash, Nonce, Target, ExecBinDir, Exec, ExtraArgs, Config, KeepGoing).
|
||||
|
||||
generate_int(Hash, Nonce, Target, MinerBinDir, MinerBin, MinerExtraArgs,
|
||||
#config{repeats = Repeats0, edge_bits = EdgeBits}) ->
|
||||
#config{repeats = Repeats0, edge_bits = EdgeBits}, KeepGoing) ->
|
||||
Repeats = integer_to_list(Repeats0),
|
||||
Args = ["-h", Hash, "-n", integer_to_list(Nonce), "-r", Repeats | string:tokens(MinerExtraArgs, " ")],
|
||||
?log(info, "Executing cmd '~s ~s'", [MinerBin, lists:concat(lists:join(" ", Args))]),
|
||||
?LOG_INFO("Executing cmd '~s ~s'", [MinerBin, lists:concat(lists:join(" ", Args))]),
|
||||
Old = process_flag(trap_exit, true),
|
||||
try exec_run(MinerBin, MinerBinDir, Args) of
|
||||
{ok, Port, OsPid} ->
|
||||
@@ -270,6 +299,7 @@ generate_int(Hash, Nonce, Target, MinerBinDir, MinerBin, MinerExtraArgs,
|
||||
port = Port,
|
||||
buffer = [],
|
||||
target = Target,
|
||||
keep_going = KeepGoing,
|
||||
edge_bits = EdgeBits,
|
||||
parser = fun parse_generation_result/2});
|
||||
{error, _Rsn} = Err ->
|
||||
@@ -297,8 +327,26 @@ is_miner_instance_addressation_enabled(#config{instances = Instances}) ->
|
||||
|
||||
exec_bin_dir(#config{exec_group = ExecGroup}) ->
|
||||
case ExecGroup of
|
||||
<<"aecuckoo">> -> aecuckoo:bin_dir();
|
||||
<<"aecuckooprebuilt">> -> code:priv_dir(aecuckooprebuilt)
|
||||
<<"aecuckoo">> -> gmcuckoo:bin_dir();
|
||||
<<"gmcuckoo">> -> gmcuckoo:bin_dir();
|
||||
<<"aecuckooprebuilt">> -> filename:join(priv_dir(gmcuckoo), "cuda");
|
||||
<<"cuda">> -> filename:join(priv_dir(gmcuckoo), "cuda")
|
||||
end.
|
||||
|
||||
priv_dir(App) ->
|
||||
case is_pid(whereis(zx_daemon)) of
|
||||
false ->
|
||||
code:priv_dir(App);
|
||||
true ->
|
||||
%% Running in Zomp context - priv_dir/1 won't work
|
||||
#{deps := Deps} = zx_daemon:meta(),
|
||||
case lists:keyfind(atom_to_list(App), 2, Deps) of
|
||||
false ->
|
||||
code:priv_dir(App);
|
||||
PId ->
|
||||
Lib = zx_lib:ppath(lib, PId),
|
||||
filename:join(Lib, "priv")
|
||||
end
|
||||
end.
|
||||
|
||||
-define(POW_TOO_BIG(Nonce), {error, {nonce_too_big, Nonce}}).
|
||||
@@ -309,7 +357,7 @@ exec_bin_dir(#config{exec_group = ExecGroup}) ->
|
||||
-define(POW_SHORT_CYCLE, {error, cycle_too_short}).
|
||||
|
||||
verify_proof_(Header, Solution, EdgeBits) ->
|
||||
{K0, K1, K2, K3} = aeminer_siphash24:create_keys(Header),
|
||||
{K0, K1, K2, K3} = gmminer_siphash24:create_keys(Header),
|
||||
|
||||
EdgeMask = (1 bsl EdgeBits) - 1,
|
||||
try
|
||||
@@ -340,12 +388,12 @@ verify_proof_(Header, Solution, EdgeBits) ->
|
||||
end
|
||||
catch
|
||||
throw:{error, Rsn} ->
|
||||
?log(info, "Proof verification failed for ~p: ~p", [Solution, Rsn]),
|
||||
?LOG_INFO("Proof verification failed for ~p: ~p", [Solution, Rsn]),
|
||||
false
|
||||
end.
|
||||
|
||||
sipnode(K0, K1, K2, K3, Proof, UOrV, EdgeMask) ->
|
||||
SipHash = aeminer_siphash24:hash(K0, K1, K2, K3, 2*Proof + UOrV) band EdgeMask,
|
||||
SipHash = gmminer_siphash24:hash(K0, K1, K2, K3, 2*Proof + UOrV) band EdgeMask,
|
||||
(SipHash bsl 1) bor UOrV.
|
||||
|
||||
check_cycle(Nodes0) ->
|
||||
@@ -398,7 +446,7 @@ find_node(X, [N1, N2 | Nodes], Acc) ->
|
||||
%% Since this hash is purely internal, we don't use api encoding.
|
||||
%% @end
|
||||
%%------------------------------------------------------------------------------
|
||||
-spec pack_header_and_nonce(binary(), aeminer_pow:nonce()) -> string().
|
||||
-spec pack_header_and_nonce(binary(), gmminer_pow:nonce()) -> string().
|
||||
pack_header_and_nonce(Hash, Nonce) when byte_size(Hash) == 32 ->
|
||||
%% Cuckoo originally uses 32-bit nonces inserted at the end of its 80-byte buffer.
|
||||
%% This buffer is hashed into the keys used by the main algorithm.
|
||||
@@ -445,7 +493,21 @@ wait_for_result(#state{os_pid = OsPid, port = Port, buffer = Buffer} = State) ->
|
||||
exit(shutdown);
|
||||
{'EXIT', Port, normal} ->
|
||||
%% Process ended but no value found
|
||||
{error, no_value};
|
||||
case State#state.solutions of
|
||||
[] ->
|
||||
{error, no_value};
|
||||
|
||||
[_|_] = Sols0 ->
|
||||
Sols = lists:reverse(Sols0),
|
||||
case State#state.keep_going of
|
||||
false ->
|
||||
%% For compatibility, pick the one first found
|
||||
[{N, S}|_] = Sols,
|
||||
{ok, N, S};
|
||||
true ->
|
||||
{ok, Sols}
|
||||
end
|
||||
end;
|
||||
_Other ->
|
||||
wait_for_result(State)
|
||||
end.
|
||||
@@ -487,28 +549,41 @@ handle_fragmented_lines(Str, Buffer) ->
|
||||
parse_generation_result([], State) ->
|
||||
wait_for_result(State);
|
||||
parse_generation_result(["Solution" ++ NonceValuesStr | Rest],
|
||||
#state{os_pid = OsPid, edge_bits = EdgeBits, target = Target} = State) ->
|
||||
#state{os_pid = OsPid, edge_bits = EdgeBits,
|
||||
target = Target, keep_going = KeepGoing} = State) ->
|
||||
[NonceStr | SolStrs] = string:tokens(NonceValuesStr, " "),
|
||||
Soln = [list_to_integer(string:trim(V, both, [$\r]), 16) || V <- SolStrs],
|
||||
case {length(Soln), test_target(Soln, Target, EdgeBits)} of
|
||||
{?SOLUTION_SIZE, true} ->
|
||||
stop_execution(OsPid),
|
||||
?LOG_DEBUG("Solution found, KeepGoing = ~p", [KeepGoing]),
|
||||
case KeepGoing of
|
||||
true -> ok;
|
||||
false ->
|
||||
stop_execution(OsPid)
|
||||
end,
|
||||
case parse_nonce_str(NonceStr) of
|
||||
{ok, Nonce} ->
|
||||
?log(debug, "Solution found: ~p", [Soln]),
|
||||
{ok, Nonce, Soln};
|
||||
?LOG_DEBUG("Solution found: ~p", [Soln]),
|
||||
case KeepGoing of
|
||||
true ->
|
||||
Sols = State#state.solutions,
|
||||
State1 = State#state{solutions = [{Nonce, Soln}|Sols]},
|
||||
parse_generation_result(Rest, State1);
|
||||
false ->
|
||||
{ok, Nonce, Soln}
|
||||
end;
|
||||
Err = {error, _} ->
|
||||
?log(debug, "Bad nonce: ~p", [Err]),
|
||||
?LOG_DEBUG("Bad nonce: ~p", [Err]),
|
||||
Err
|
||||
end;
|
||||
{N, _} when N /= ?SOLUTION_SIZE ->
|
||||
?log(debug, "Solution has wrong length (~p) should be ~p", [N, ?SOLUTION_SIZE]),
|
||||
?LOG_DEBUG("Solution has wrong length (~p) should be ~p", [N, ?SOLUTION_SIZE]),
|
||||
%% No nonce in solution, old miner exec?
|
||||
stop_execution(OsPid),
|
||||
{error, bad_miner};
|
||||
{_, false} ->
|
||||
%% failed to meet target: go on, we may find another solution
|
||||
?log(debug, "Failed to meet target (~p)", [Target]),
|
||||
?LOG_DEBUG("Failed to meet target (~p)", [Target]),
|
||||
parse_generation_result(Rest, State)
|
||||
end;
|
||||
parse_generation_result([_Msg | T], State) ->
|
||||
@@ -526,7 +601,7 @@ parse_nonce_str(S) ->
|
||||
%%------------------------------------------------------------------------------
|
||||
stop_execution(OsPid) ->
|
||||
exec_kill(OsPid),
|
||||
?log(debug, "Mining OS process ~p stopped", [OsPid]),
|
||||
?LOG_DEBUG("Mining OS process ~p stopped", [OsPid]),
|
||||
ok.
|
||||
|
||||
%%------------------------------------------------------------------------------
|
||||
@@ -558,10 +633,10 @@ exec_run(Cmd, Dir, Args) ->
|
||||
Port = erlang:open_port(PortName, PortSettings),
|
||||
case erlang:port_info(Port, os_pid) of
|
||||
{os_pid, OsPid} ->
|
||||
?log(debug, "External mining process started with OS pid ~p", [OsPid]),
|
||||
?LOG_DEBUG("External mining process started with OS pid ~p", [OsPid]),
|
||||
{ok, Port, OsPid};
|
||||
undefined ->
|
||||
?log(warning, "External mining process finished before ~p could acquire the OS pid", [?MODULE]),
|
||||
?LOG_WARNING("External mining process finished before ~p could acquire the OS pid", [?MODULE]),
|
||||
{ok, Port, undefined}
|
||||
end
|
||||
catch
|
||||
@@ -599,8 +674,8 @@ test_target(Soln, Target, EdgeBits) ->
|
||||
|
||||
test_target1(Soln, Target, NodeSize) ->
|
||||
Bin = solution_to_binary(lists:sort(Soln), NodeSize * 8),
|
||||
Hash = aeminer_blake2b_256:hash(Bin),
|
||||
aeminer_pow:test_target(Hash, Target).
|
||||
Hash = gmminer_blake2b_256:hash(Bin),
|
||||
gmminer_pow:test_target(Hash, Target).
|
||||
|
||||
%%------------------------------------------------------------------------------
|
||||
%% Convert solution (a list of 42 numbers) to a binary
|
||||
@@ -5,7 +5,7 @@
|
||||
%%% @end
|
||||
%%%=============================================================================
|
||||
|
||||
-module(aeminer_siphash24).
|
||||
-module(gmminer_siphash24).
|
||||
|
||||
-export([create_keys/1,
|
||||
hash/5]).
|
||||
@@ -28,12 +28,12 @@
|
||||
%%%=============================================================================
|
||||
|
||||
-spec create_keys(binary()) ->
|
||||
{aeminer_siphash24:siphash_key(),
|
||||
aeminer_siphash24:siphash_key(),
|
||||
aeminer_siphash24:siphash_key(),
|
||||
aeminer_siphash24:siphash_key()}.
|
||||
{gmminer_siphash24:siphash_key(),
|
||||
gmminer_siphash24:siphash_key(),
|
||||
gmminer_siphash24:siphash_key(),
|
||||
gmminer_siphash24:siphash_key()}.
|
||||
create_keys(Header) ->
|
||||
AuxHash = <<_:32/binary>> = aeminer_blake2b_256:hash(Header),
|
||||
AuxHash = <<_:32/binary>> = gmminer_blake2b_256:hash(Header),
|
||||
<<K0:64/little-unsigned,
|
||||
K1:64/little-unsigned,
|
||||
K2:64/little-unsigned,
|
||||
@@ -1,9 +1,10 @@
|
||||
%%%-------------------------------------------------------------------
|
||||
%%% @copyright (C) 2025, QPQ AG
|
||||
%%% @copyright (C) 2019, Aeternity Anstalt
|
||||
%%% @doc Basic sanity checks and examples on Cuckoo cycle PoW executables.
|
||||
%%% @end
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(aecuckoo_SUITE).
|
||||
-module(gmcuckoo_SUITE).
|
||||
|
||||
%% common_test exports
|
||||
-export(
|
||||
@@ -56,7 +57,7 @@ smoke_test(Config) ->
|
||||
HeaderEquivalent = <<0:(44*8), (base64:encode(<<Nonce:64/little-unsigned-integer>>))/binary, 0:(24*8)>>,
|
||||
|
||||
42 = length(Solution),
|
||||
true = aeminer_pow_cuckoo:verify_proof_(HeaderEquivalent, Solution, 15),
|
||||
true = gmminer_pow_cuckoo:verify_proof_(HeaderEquivalent, Solution, 15),
|
||||
|
||||
ok.
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
%%%=============================================================================
|
||||
%%% @copyright (C) 2025, QPQ AG
|
||||
%%% @copyright (C) 2019, Aeternity Anstalt
|
||||
%%% @doc
|
||||
%%% Unit tests for the aeminer_pow_cuckoo module
|
||||
%%% Unit tests for the gmminer_pow_cuckoo module
|
||||
%%% @end
|
||||
%%%=============================================================================
|
||||
-module(aeminer_pow_cuckoo_tests).
|
||||
-module(gmminer_pow_cuckoo_tests).
|
||||
|
||||
-include_lib("eunit/include/eunit.hrl").
|
||||
|
||||
-include("aeminer.hrl").
|
||||
-include("gmminer.hrl").
|
||||
|
||||
-define(TEST_MODULE, aeminer_pow_cuckoo).
|
||||
-define(POW_MODULE, aeminer_pow).
|
||||
-define(TEST_MODULE, gmminer_pow_cuckoo).
|
||||
-define(POW_MODULE, gmminer_pow).
|
||||
|
||||
-define(TEST_BIN, <<"wsffgujnjkqhduihsahswgdf">>).
|
||||
-define(TEST_HIGH_NONCE, 38). %% Nonce with solution with high target.
|
||||
@@ -1,16 +1,17 @@
|
||||
%%%=============================================================================
|
||||
%%% @copyright (C) 2025, QPQ AG
|
||||
%%% @copyright (C) 2019, Aeternity Anstalt
|
||||
%%% @doc
|
||||
%%% Unit tests for the aeminer_pow module
|
||||
%%% Unit tests for the gmminer_pow module
|
||||
%%% @end
|
||||
%%%=============================================================================
|
||||
-module(aeminer_pow_tests).
|
||||
-module(gmminer_pow_tests).
|
||||
|
||||
-include_lib("eunit/include/eunit.hrl").
|
||||
|
||||
-define(TEST_MODULE, aeminer_pow).
|
||||
-define(TEST_MODULE, gmminer_pow).
|
||||
|
||||
-include("aeminer.hrl").
|
||||
-include("gmminer.hrl").
|
||||
|
||||
conversion_test_() ->
|
||||
{setup,
|
||||
@@ -47,7 +48,7 @@ conversion_test_() ->
|
||||
?assertEqual(255, ?TEST_MODULE:scientific_to_integer(16#0200ff00)),
|
||||
?assertEqual(16#800000, ?TEST_MODULE:scientific_to_integer(16#04008000)),
|
||||
?assertEqual(?HIGHEST_TARGET_INT,
|
||||
aeminer_pow:scientific_to_integer(?HIGHEST_TARGET_SCI))
|
||||
gmminer_pow:scientific_to_integer(?HIGHEST_TARGET_SCI))
|
||||
end},
|
||||
{"Integer to scientific and back",
|
||||
fun() ->
|
||||
@@ -0,0 +1,17 @@
|
||||
{name,"gmminer"}.
|
||||
{type,lib}.
|
||||
{modules,[]}.
|
||||
{prefix,none}.
|
||||
{author,"QPQ AG"}.
|
||||
{desc,"Gajumaru Cuckoo Cycle mining support"}.
|
||||
{package_id,{"uwiger","gmminer",{1,0,1}}}.
|
||||
{deps,[{"uwiger","gmcuckoo",{1,1,0}}]}.
|
||||
{key_name,none}.
|
||||
{a_email,"ulf@wiger.net"}.
|
||||
{c_email,"ulf@wiger.net"}.
|
||||
{copyright,"QPQ AG"}.
|
||||
{file_exts,[]}.
|
||||
{license,"GPL-3.0-or-later"}.
|
||||
{repo_url,"https://git.qpq.swiss/QPQ-AG/gmminer"}.
|
||||
{tags,[]}.
|
||||
{ws_url,[]}.
|
||||
Executable
+12
@@ -0,0 +1,12 @@
|
||||
#!/bin/sh
|
||||
set -e
|
||||
|
||||
APP=$(basename "$PWD")
|
||||
SRC="_build/default/lib/$APP"
|
||||
DST="$PWD/_build/zomp/lib/$APP"
|
||||
mkdir -p "$DST"
|
||||
find "$SRC" -type l ! -exec test -e {} \; -delete
|
||||
cp -aR -L "$SRC/." "$DST/"
|
||||
cp "$PWD/zomp.meta" "$DST/"
|
||||
cp "$PWD/Emakefile" "$DST"
|
||||
rm "$DST"/ebin/*.beam
|
||||
Reference in New Issue
Block a user