Update readme

This commit is contained in:
zzz
2024-01-03 08:33:38 -05:00
parent 913303aac5
commit 2d9f24b5d7
2 changed files with 53 additions and 0 deletions

19
LICENSE-Noise.txt Normal file
View File

@ -0,0 +1,19 @@
Copyright (C) 2016 Southern Storm Software, Pty Ltd.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

View File

@ -1,2 +1,36 @@
Java Equi-X
---------------------------
Tor-compatible PoW, Equi-X(60,3), and HashX.
References:
- https://spec.torproject.org/hspow-spec/index.html
- https://github.com/tevador/equix
- https://github.com/tevador/hashx
While PoW is well-specified, Equi-X and HashX are poorly undocumented,
and almost impossible to specify. All HashX program generation code,
including the deterministic RNG, must be reproduced exactly.
This is a fairly direct translation of tevador's C code to Java,
and is therefore licensed the same as that code, LGPLv3.
Equi-X and HashX test vectors are from those projects and all pass.
PoW test vectors are from Tor and licensed the same as Tor (BSD).
One test is failing for unknown reasons.
Interpreted hash rate is about 150K hashes/sec, which is a little
slower than the C interpreted speed.
HashX compilation is supported if ant and ECJ are available at runtime.
This provides about a 10X speedup after the compilation,
which takes about 750 ms.
Compiled hash rate is currently about 1.5 million hashes/sec, which is
about 2-3x slower than HashX compiled mode.
Equi-X requires 1.8 MB of heap to find solutions.
This implementation uses about the same, plus lots of Java overhead of course.
Blake2b code is adapted from Noise, see LICENSE-Noise.txt.