|
1 | | -# fiamma |
2 | | -**fiamma** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli). |
| 1 | + |
3 | 2 |
|
4 | | -## Get started |
| 3 | +# Fiamma |
5 | 4 |
|
6 | | -``` |
7 | | -ignite chain serve |
8 | | -``` |
| 5 | +[](https://github.com/fiamma-chain/fiamma/releases/latest) |
| 6 | +[](https://pkg.go.dev/github.com/fiamma-chain/fiamma) |
| 7 | +[](https://goreportcard.com/report/github.com/fiamma-chain/fiamma) |
| 8 | +[](https://codecov.io/gh/fiamma-chain/fiamma) |
| 9 | +[](https://github.com/fiamma-chain/fiamma/LICENSE) |
9 | 10 |
|
10 | | -`serve` command installs dependencies, builds, initializes, and starts your blockchain in development. |
| 11 | +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. |
11 | 12 |
|
12 | | -### Configure |
13 | 13 |
|
14 | | -Your blockchain in development can be configured with `config.yml`. To learn more, see the [Ignite CLI docs](https://docs.ignite.com). |
| 14 | +## System Requirements |
15 | 15 |
|
16 | | -### Web Frontend |
| 16 | +The following specifications have been found to work well: |
17 | 17 |
|
18 | | -Additionally, Ignite CLI offers both Vue and React options for frontend scaffolding: |
| 18 | +- Quad Core or larger AMD or Intel (amd64) CPU |
| 19 | +- 32GB RAM; |
| 20 | +- 1TB NVMe SSD Storage (disk i/o is crucial); |
| 21 | +- 100Mbps bi-directional Internet connection; |
19 | 22 |
|
20 | | -For a Vue frontend, use: `ignite scaffold vue` |
21 | | -For a React frontend, use: `ignite scaffold react` |
22 | | -These commands can be run within your scaffolded blockchain project. |
| 23 | +## Software Dependencies |
23 | 24 |
|
| 25 | +The following software should be installed on the target system: |
24 | 26 |
|
25 | | -For more information see the [monorepo for Ignite front-end development](https://github.com/ignite/web). |
| 27 | +- The Go Programming Language (<https://go.dev>) |
| 28 | +- Git Distributed Version Control (<https://git-scm.com>) |
| 29 | +- Docker (<https://www.docker.com>) |
| 30 | +- GNU Make (<https://www.gnu.org/software/make>) |
| 31 | +- Openssl <https://www.openssl.org/> |
| 32 | +- jq (https://jqlang.github.io/jq/) |
26 | 33 |
|
27 | | -## Release |
28 | | -To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created. |
29 | 34 |
|
30 | | -``` |
31 | | -git tag v0.1 |
32 | | -git push origin v0.1 |
| 35 | +## Build from Source |
| 36 | + |
| 37 | +[Clone the repository](https://github.com/fiamma-chain/fiamma), checkout the `<release version>` branch and install: |
| 38 | + |
| 39 | +```sh |
| 40 | +cd fiamma |
| 41 | +git checkout <release version> |
| 42 | +make install |
33 | 43 | ``` |
34 | 44 |
|
35 | | -After a draft release is created, make your final changes from the release page and publish it. |
| 45 | +This will install the `fiammad` binary to your `GOPATH`. |
36 | 46 |
|
37 | | -### Install |
38 | | -To install the latest version of your blockchain node's binary, execute the following command on your machine: |
| 47 | +## Dockerized Containers |
| 48 | + |
| 49 | +A docker image for production purposes (no shell access): |
| 50 | + |
| 51 | +[Packages: fiammad](https://github.com/orgs/fiamma-chain/packages/container/package/fiammad) |
| 52 | + |
| 53 | + |
| 54 | +## Joining the testnet |
| 55 | + |
| 56 | +Please follow the instructions on the [User Guides](https://fiamma.gitbook.io/fiamma/). |
39 | 57 |
|
40 | | -``` |
41 | | -curl https://get.ignite.com/username/fiamma@latest! | sudo bash |
42 | | -``` |
43 | | -`username/fiamma` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer). |
44 | 58 |
|
45 | | -## Learn more |
| 59 | +## Documentation |
46 | 60 |
|
47 | | -- [Ignite CLI](https://ignite.com/cli) |
48 | | -- [Tutorials](https://docs.ignite.com/guide) |
49 | | -- [Ignite CLI docs](https://docs.ignite.com) |
50 | | -- [Cosmos SDK docs](https://docs.cosmos.network) |
51 | | -- [Developer Chat](https://discord.gg/ignite) |
| 61 | +To learn more, please [visit the official fiamma documentation](https://fiamma.gitbook.io/fiamma/). |
0 commit comments