README
¶
Quicksilver
 |
 |
 |
Quicksilver is the Cosmos Liquid Staking Zone.
Many existing Liquid Staking providers take power and agency away from delegators, permitting only a small whitelist of validators to delegate to, and stripping away users voting rights. Quicksilver aims to right these wrongs, with active measures to reward and incentivise decentralisation and governance participation.
System Requirements
This system spec has been found to be optimal:
- Quad Core AMD or Intel (amd64) CPU; higher clock speed is preferential to more cores, as Tendermint is largely single-threaded.
- 32GB RAM
- 1TB NVMe Storage (mechanical disk are insufficient)
- 100Mbps bidirectional Internet connection
Software Dependencies
- The Go programming language - https://go.dev/
- Git distributed version control - https://git-scm.com/
- Docker - https://www.docker.com/get-started/
- GNU Make - https://www.gnu.org/software/make/
Make sure that the above software is installed on your system. Follow the instructions for your particular platform or use your preferred platform package manager;
In addition, install jq (a command line JSON processor):
-
Debian based systems:
apt-get install jq -
Arch based systems:
pacman -S jq -
Mac based systems:
brew install jq -
Windows based systems (using Chocolatey NuGet):
chocolatey install jq
Clone & Run Quicksilver (dev)
NB!! Use a fork of the repository when you plan to create Pull Requests;
Clone the repository from GitHub and enter the directory:
git clone https://github.com/nephirim/blackfury.git
cd quicksilver
Then run:
make build-docker
make test-docker
For subsequent tests run the following if you want to start with fresh state:
make build-docker
make test-docker-regen
Origination and Attribution
Quicksilver utilises code and logic that originated from other projects; as an open-source project ourselves, we believe that appropriate attribution is necessary, in order to combat plagiarism.
The following modules and packages were lifted and reused in almost entirety from Osmosis (https://github.com/osmosis-labs/osmosis), under the terms of the Apache 2.0 License, and we are grateful for their contribution:
x/mint
x/epochs
x/tokenfactory
test/e2e
We're also using CosmWasm, developed over the course of years with lead from Confio and support from the whole of Cosmos.
Directories
¶
| Path | Synopsis |
|---|---|
|
client
|
|
|
docs/statik
Package statik contains static assets.
|
Package statik contains static assets. |
|
cmd
|
|
|
blackfuryd
command
|
|
|
internal
|
|
|
gamm
package gamm is a reverse proxy.
|
package gamm is a reverse proxy. |
|
gamm/pool-models/balancer
Package balancer implements weighted constant product AMMs, satisfying the AMM pool interface from x/gamm/types.
|
Package balancer implements weighted constant product AMMs, satisfying the AMM pool interface from x/gamm/types. |
|
lockup
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
osmoutils/partialord
package partialord allows one to define partial orderings, and derive a total ordering
|
package partialord allows one to define partial orderings, and derive a total ordering |
|
osmoutils/partialord/internal/dag
Package dag implements a simple Directed Acyclical Graph (DAG) for deterministic topological sorts
|
Package dag implements a simple Directed Acyclical Graph (DAG) for deterministic topological sorts |
|
server
|
|
|
test
|
|
|
interchaintest
module
|
|
|
x
|
|
|
airdrop/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
claimsmanager/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
epochs/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
interchainquery/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
interchainstaking/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
mint/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
participationrewards/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
tokenfactory
Package tokenfactory allows any account to create a new token with the name `factory/{creator address}/{subdenom}`.
|
Package tokenfactory allows any account to create a new token with the name `factory/{creator address}/{subdenom}`. |
|
tokenfactory/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |