README
¶
PolyCrypt's go utils
poly-go provides generic helper functionality for golang projects. It is most prominently used by PolyCrypt in go-perun and Erdstall. Besides that everyone is free to use it in their projects as well 🤗
Getting Started
Running poly-go requires a working Go distribution, see go.mod for the required version.
# Clone the repository into a directory of your choice
git clone https://github.com/perun-network/poly-go.git
# Or directly download it with go
# go get -d perun.network/poly-go
cd poly-go
# Run the unit tests
go test ./...
You can import poly-go in your project like this:
import "polycry.pt/poly-go/test"
Documentation
More in-depth documentation can be found on go doc.
Funding
This project has been started at the Chair of Applied Cryptography at Technische Universität Darmstadt, Germany, and is currently developed and maintained by PolyCrypt GmbH. We thank the German Federal Ministry of Education and Research (BMBF) for their funding through the StartUpSecure grants program as well as the German Science Foundation (DFG), the Foundation for Polish Science (FNP) and the Ethereum Foundation for their support of this implementation.
Copyright
Copyright 2021 - See NOTICE file for copyright holders. Use of the source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
Contact us at info@polycry.pt.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package context contains helper utilities regarding go contexts.
|
Package context contains helper utilities regarding go contexts. |
|
test
Package test tests the helper utilities regarding go contexts.
|
Package test tests the helper utilities regarding go contexts. |
|
Package errors contains functionality for simplifying and improving error handling.
|
Package errors contains functionality for simplifying and improving error handling. |
|
math
|
|
|
big
Package big contains helpers for package math/big.
|
Package big contains helpers for package math/big. |
|
Package random contains random generator utilities for primitives and types.
|
Package random contains random generator utilities for primitives and types. |
|
Package sortedkv defines a sorted key-value store abstraction.
|
Package sortedkv defines a sorted key-value store abstraction. |
|
key
Package key of sortedkv provides helper functions to manipulate db keys
|
Package key of sortedkv provides helper functions to manipulate db keys |
|
leveldb
Package leveldb implements the key-value database interface using LevelDB.
|
Package leveldb implements the key-value database interface using LevelDB. |
|
memorydb
Package memorydb provides an implementation of the sortedkv interfaces.
|
Package memorydb provides an implementation of the sortedkv interfaces. |
|
test
Package test implements a generic test for all implementations of the Database interface.
|
Package test implements a generic test for all implementations of the Database interface. |
|
Package sync contains a mutex that can be used in a select statement.
|
Package sync contains a mutex that can be used in a select statement. |
|
atomic
Package atomic contains extensions of "sync/atomic"
|
Package atomic contains extensions of "sync/atomic" |
|
Package test contains testing utilities.
|
Package test contains testing utilities. |