Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanbratanov/chotto
Ethereum's Power of Tau client CLI implementation written in Java
https://github.com/stefanbratanov/chotto
eip4844 ethereum kzg powers-of-tau
Last synced: about 1 month ago
JSON representation
Ethereum's Power of Tau client CLI implementation written in Java
- Host: GitHub
- URL: https://github.com/stefanbratanov/chotto
- Owner: StefanBratanov
- License: apache-2.0
- Created: 2022-10-30T11:29:02.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T08:41:17.000Z (over 1 year ago)
- Last Synced: 2023-09-05T10:56:18.126Z (over 1 year ago)
- Topics: eip4844, ethereum, kzg, powers-of-tau
- Language: Java
- Homepage:
- Size: 27.4 MB
- Stars: 22
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chotto
## 🕯️🕯️🕯️ THE KZG CEREMONY IS CLOSED. THANKS FOR CONTRIBUTING. 🕯️🕯️🕯️ https://twitter.com/CarlBeek/status/1694566774375698789
[](https://github.com/StefanBratanov/chotto/blob/master/LICENSE)
[](https://github.com/StefanBratanov/chotto/actions/workflows/build.yml)
[](https://sonarcloud.io/summary/new_code?id=StefanBratanov_chotto)
[](https://www.codefactor.io/repository/github/stefanbratanov/chotto)
[](https://codecov.io/gh/StefanBratanov/chotto)
[](https://github.com/StefanBratanov/chotto/releases/latest)
Chotto can be used to participate in the KZG Ceremony which will
bring [EIP-4844](https://www.eip4844.com/) to life. It is an Ethereum's Powers of Tau
(PoT) client CLI implementation written in Java. It follows the spec defined in
the [KZG ceremony specs](https://github.com/ethereum/kzg-ceremony-specs).
🕯️🕯️🕯️ **The KZG Ceremony is live** and the url of the `sequencer`
is https://seq.ceremony.ethereum.org. Check
the [Install Instructions](#install-instructions) and [Usage](#usage) to see how to use Chotto
to contribute. After contributing, you can check your
contribution [here](https://ceremony.ethereum.org/#/record). 🕯️🕯️🕯️
## Install Instructions
### Install Prerequisites
- Java 11+
### Binary Releases
Binary releases are available from
the [releases page](https://github.com/StefanBratanov/chotto/releases).
Once downloaded and unzipped, executables will be available in the `bin/` folder.
### Manual Build
You can also manually build the code:
```bash
git clone https://github.com/StefanBratanov/chotto.git
cd chotto
./gradlew installDist
```
This will install ready to use executables in the `build/install/chotto/bin` folder.
## Generating randomness
Generating randomness is an important part of the KZG Ceremony. Each participant needs to generate 4
different random secrets. The user should not have a knowledge of these generated values and also
all secrets should be wiped out from memory after the contribution is complete. The way each random
secret is generated in Chotto is as follows:
* User provides an entropy of at least 6 characters when starting the client.
* An IKM (input keying material) with 256 bytes is initialised with the entropy bytes. (truncated or padded with
zeros)
* Half or more bytes (128 or 256 minus the length of the entropy) are replaced by random bytes. (
based on
`java.security.SecureRandom`)
* The IKM is passed to a [BLS KeyGen](https://github.com/ethereum/kzg-ceremony-specs/blob/master/docs/cryptography/BLS.md#keygen) function which ultimately generates
the secret.
The secrets will only live in the Java process, so won't be exposed when the browser is opened for
logging in and signing the contribution. After the
Java process is terminated, all secrets will be wiped out from memory.
## Usage
Required arguments:
* `sequencer`
See [CLI Arguments](#cli-arguments) for all available arguments.
### Sample Usage
Note: For Windows, use the `chotto.bat` executable.
#### Authenticate with Ethereum
```bash
./chotto --sequencer=https://seq.ceremony.ethereum.org/
```
#### Authenticate with GitHub
```bash
./chotto --sequencer=https://seq.ceremony.ethereum.org/ --authentication=github
```
#### Run against a local sequencer
```bash
./chotto --sequencer=http://localhost:3000/
```
You can start a local sequencer by following the setup instructions
at [KZG Ceremony Rest API](https://github.com/ethereum/kzg-ceremony-sequencer).
### CLI arguments
```bash
$ ./chotto --help
_____ _ _ _
/ ____| | | | | |
| | | |__ ___ | |_| |_ ___
| | | '_ \ / _ \| __| __/ _ \
| |____| | | | (_) | |_| || (_) |
\_____|_| |_|\___/ \__|\__\___/
Usage: chotto [-hV] [--bls-sign-sub-contributions] [--ecdsa-sign-contribution]
[--validate-receipt] [--verify-transcript]
[--authentication=]
[--callback-endpoint=]
[--contribution-attempt-period=]
[--output-directory=] --sequencer=
[--server-port=]
Ethereum's Power of Tau client implementation written in Java
--authentication=
The authentication provider which will be used for
logging in. Valid values: Ethereum, Github
Default: Ethereum
--bls-sign-sub-contributions
Sign your sub-contributions using your identity.
Doing so is RECOMMENDED.
Default: true
--callback-endpoint=
The URL of the server which is started by this
process. Specify this option ONLY if you decide
to login and sign from a browser on a different
computer. Make sure the URL is accessible from
that browser.
--contribution-attempt-period=
How often (in seconds) to attempt contribution once
authenticated
Default: 30
--ecdsa-sign-contribution
Sign your contribution using the Ethereum address
you logged in with. Doing so is RECOMMENDED. This
value is only applicable when you have
authenticated with Ethereum.
Default: true
-h, --help Show this help message and exit.
--output-directory=
The directory where the outputs of the ceremony
will be saved
Default: \kzg-ceremony
--sequencer=
The URL of the sequencer which would be used for
the ceremony
--server-port=
The port on which to start the local server
Default: 8080
-V, --version Print version information and exit.
--validate-receipt Whether to validate the receipt after contributing
against the sequencer transcript or not
Default: false
--verify-transcript Whether to verify the sequencer transcript at
startup or not
Default: false
```