README
¶
vdf-go-wrapper
A Verifiable Delay Function(https://github.com/poanetwork/vdf) wrapper for go
The project is built for bounty of harmony.one, which is my coding test of final round interview.
- Bounty issue: https://github.com/harmony-one/bounties/issues/4
- GitCoin: https://gitcoin.co/issue/harmony-one/bounties/4/100025313
Build & Test
Build VDF Rust FFI dynamic library
if lib/libvdf_ffi.so does exist, you can skip this step and go next
you need to install the latest stable version of Rust, then run command as follows:
make ffi
Build VDF FFI wrapper for golang
make build
Run VDF FFI wrapper test
make test
BenchMarks
Run command as follows:
# for test go and wrapper version
make gobench
Rust Wrapper Version:
BenchmarkVDFRustGenerateAndVerify-8 1 2525336300 ns/op 2424 B/op 11 allocs/op
BenchmarkVDFRustGenerate-8 1 1758575500 ns/op 1936 B/op 7 allocs/op
BenchmarkVDFRustVerify-8 2 921654200 ns/op 640 B/op 3 allocs/op
Go Version:
BenchmarkVDFGoGenerateAndVerify-8 1 22218883100 ns/op 22599355848 B/op 221366129 allocs/op
BenchmarkVDFGoGenerate-8 1 21885868400 ns/op 22204293240 B/op 217648324 allocs/op
BenchmarkVDFGoVerify-8 3 426695667 ns/op 95598194 B/op 946104 allocs/op
Run command as follows:
# for test pure rust vdf
make rustbench
Pure Rust Version:
Benchmarking vdf generate verify: Collecting 100 samples in estimated 254.63 s (100 iterations)
Benchmarking vdf generate verify: Analyzing
vdf generate verify time: [2.5783 s 2.5837 s 2.5892 s]
change: [-0.9282% -0.5185% -0.1339%] (p = 0.01 < 0.05)
Change within noise threshold.
Found 2 outliers among 100 measurements (2.00%)
2 (2.00%) high mild
mean [2.5783 s 2.5892 s] std. dev. [23.719 ms 32.048 ms]
median [2.5736 s 2.5867 s] med. abs. dev. [18.398 ms 33.491 ms]
Benchmarking vdf verify
Benchmarking vdf verify: Warming up for 3.0000 s
Warning: Unable to complete 100 samples in 5.0s. You may wish to increase target time to 95.4s, or reduce sample count to 10.
Benchmarking vdf verify: Collecting 100 samples in estimated 95.375 s (100 iterations)
Benchmarking vdf verify: Analyzing
vdf verify time: [960.19 ms 964.71 ms 969.97 ms]
Found 7 outliers among 100 measurements (7.00%)
5 (5.00%) high mild
2 (2.00%) high severe
mean [960.19 ms 969.97 ms] std. dev. [15.679 ms 34.025 ms]
median [953.27 ms 964.37 ms] med. abs. dev. [10.966 ms 20.064 ms]
According to the above benchmark test results, The compute method of the VDF Library of the Rust version CPU performance is a higher order of magnitude than the go version, but the verify method has the same level as the go version, so in general, the rate performance of the rust is faster.
Conclusion
So the Rust Version of VDF could replace current go version, but it is not faster than C++ version there https://github.com/Chia-Network/chiavdf.
How to use
Please see vdf_test.go, there are some examples and tests
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type VDF ¶
type VDF struct {
// contains filtered or unexported fields
}
VDF is the struct holding necessary state for a hash chain delay function.
func (*VDF) Execute ¶
func (vdf *VDF) Execute()
Execute runs the VDF until it's finished and put the result into output channel.
func (*VDF) GetOutput ¶
GetOutput returns the vdf output, which can be bytes of 0s is the vdf is not finished.
func (*VDF) GetOutputChannel ¶
GetOutputChannel returns the vdf output channel. VDF output consists of 258 bytes of serialized Y and 258 bytes of serialized Proof
func (*VDF) IsFinished ¶
IsFinished returns whether the vdf execution is finished or not.
Source Files