-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
fiamma-builder
committed
Oct 30, 2024
1 parent
0461154
commit bc00bcb
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
![](https://github.com/fiamma-chain/fiamma/blob/main/banner.png) | ||
|
||
# Fiamma | ||
|
||
[![Version](https://img.shields.io/github/v/tag/fiamma-chain/fiamma.svg?sort=semver&style=flat-square)](https://github.com/fiamma-chain/fiamma/releases/latest) | ||
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://pkg.go.dev/github.com/fiamma-chain/fiamma) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/fiamma-chain/fiamma)](https://goreportcard.com/report/github.com/fiamma-chain/fiamma) | ||
[![codecov](https://codecov.io/gh/fiamma-chain/fiamma/branch/master/graph/badge.svg)](https://codecov.io/gh/fiamma-chain/fiamma) | ||
[![License:Apache-2.0](https://img.shields.io/github/license/fiamma-chain/fiamma.svg?style=flat-square)](https://github.com/fiamma-chain/fiamma/LICENSE) | ||
|
||
Fiamma is emerging as a verification network that specializes in zero-knowledge (ZK) proofs, striving to provide a secure, decentralized, and economically efficient solution for universal blockchain integration. At its heart, Fiamma is engineered to leverage the robust cryptoeconomic and network security value of Bitcoin via the integration with Babylon and implementation of BitVM2. This combination enables Fiamma to introduce ZK capabilities into the Bitcoin ecosystem and secure ZK use cases in Ethereum and beyond, enhancing the scope and effectiveness of ZK technology. | ||
|
||
|
||
## System Requirements | ||
|
||
The following specifications have been found to work well: | ||
|
||
- Quad Core or larger AMD or Intel (amd64) CPU | ||
- 32GB RAM; | ||
- 1TB NVMe SSD Storage (disk i/o is crucial); | ||
- 100Mbps bi-directional Internet connection; | ||
|
||
## Software Dependencies | ||
|
||
The following software should be installed on the target system: | ||
|
||
- The Go Programming Language (<https://go.dev>) | ||
- Git Distributed Version Control (<https://git-scm.com>) | ||
- Docker (<https://www.docker.com>) | ||
- GNU Make (<https://www.gnu.org/software/make>) | ||
- Openssl <https://www.openssl.org/> | ||
- jq (https://jqlang.github.io/jq/) | ||
|
||
|
||
## Build from Source | ||
|
||
[Clone the repository](https://github.com/fiamma-chain/fiamma), checkout the `<release version>` branch and install: | ||
|
||
```sh | ||
cd fiamma | ||
git checkout <release version> | ||
make install | ||
``` | ||
|
||
This will install the `fiammad` binary to your `GOPATH`. | ||
|
||
## Dockerized Containers | ||
|
||
A docker image for production purposes (no shell access): | ||
|
||
[Packages: fiammad](https://github.com/fiamma-chain/fiamma/pkgs/container/fiamma) | ||
|
||
|
||
## Joining the testnet | ||
|
||
Please follow the instructions on the [Developer Guides](https://docs.fiammachain.io/developer-guides/set-up-a-node). | ||
|
||
|
||
## Documentation | ||
|
||
To learn more, please [visit the official fiamma documentation](https://docs.fiammachain.io). |