Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quicksilver-zone/quicksilver

Quicksilver
https://github.com/quicksilver-zone/quicksilver

Last synced: 2 months ago
JSON representation

Quicksilver

Host: GitHub
URL: https://github.com/quicksilver-zone/quicksilver
Owner: quicksilver-zone
License: other
Created: 2021-12-29T21:09:20.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-06-06T07:25:29.000Z (7 months ago)
Last Synced: 2024-06-07T08:51:19.661Z (7 months ago)
Language: Go
Homepage: https://app.quicksilver.zone
Size: 63.4 MB
Stars: 62
Watchers: 3
Forks: 55
Open Issues: 65
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Roadmap: ROADMAP.md

Awesome Lists containing this project

awesome-ccamel - quicksilver-zone/quicksilver - Quicksilver (Go)

README

# Quicksilver

| [![codecov](https://codecov.io/gh/ingenuity-build/quicksilver/branch/develop/graph/badge.svg)](https://codecov.io/gh/ingenuity-build/quicksilver) | [![Go Report Card](https://goreportcard.com/badge/github.com/quicksilver-zone/quicksilver)](https://goreportcard.com/report/github.com/quicksilver-zone/quicksilver) | [![license](https://img.shields.io/github/license/ingenuity-build/quicksilver.svg)](https://github.com/quicksilver-zone/quicksilver/blob/main/LICENSE) | [![GolangCI](https://github.com/quicksilver-zone/quicksilver/actions/workflows/golangci.yml/badge.svg)](https://github.com/quicksilver-zone/quicksilver/actions/workflows/golangci.yml) | [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/quicksilverprotocol) |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |

## Introduction

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.

## Table of Contents

- [Quicksilver App](https://app.quicksilver.zone)
- [Project Documentation](https://docs.quicksilver.zone)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Contributing](CONTRIBUTING.md)
- [Security/Bug Reporting](SECURITY.md)
- [Changelog](CHANGELOG.md)

## System Requirements

This system spec has been found to be optimal:

1. Quad Core AMD or Intel (amd64) CPU; higher clock speed is preferential to more cores, as Tendermint is largely single-threaded.
2. 32GB RAM
3. 1TB NVMe Storage (mechanical disk are insufficient)
4. 100Mbps bidirectional Internet connection

## Software Dependencies

1. The Go programming language -
2. Git distributed version control -
3. Docker -
4. GNU 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`

## 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/quicksilver-zone/quicksilver.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 (), under the terms of the Apache 2.0 License, and we are grateful for their contribution:

x/mint
x/epochs
test/e2e