Skip to content

Latest commit

 

History

History
196 lines (142 loc) · 8.41 KB

README.md

File metadata and controls

196 lines (142 loc) · 8.41 KB
Raw

CZG-Keremony

Proto-danksharding requires a new cryptographic scheme: KZG Commitments. This client was created to participate in KZG Ceremony for Proto-danksharding (aka EIP-4844) in Ethereum.

For more information about KZG Ceremony, please read Announcing the KZG Ceremony at Ethereum foundation blog.

Which BLS library did the CZG-Keremony client use?

The BLS library used in the CZG-Keremony client is the noble-curves library.

Why do we make a client with JavaScript?

JavaScript is a versatile language that can run on a wide range of platforms and devices. While there are clients available for other programming languages such as Go, Rust, Java, and C++, there are currently no clients written in pure JavaScript. As a result, a client has been developed in JavaScript for the diversity of the client availability. Having clients written in multiple programming languages can help decentralize the ceremony and make it more robust and secure.

Dependencies

  1. Install Node.js v18+ and npm.
  2. Run npm install.

How to use CZG-Keremony client?

This CZG-Keremony client provides an interactive prompt to participate in KZG ceremony.

To participate in ceremony, you must have at least one that satisfies the following:

  • Ethereum - An Ethereum address is required to have sent at least 3 transactions before Jan. 13, 2023 (block number 16,394,155)
  • GitHub - A GitHub account that has a commit dated before 1 August 2022 00:00 UTC.

Contribution in one machine

Step 1. Start interactive prompt

If you want to participate in the actual contribution, please start.

~$ ./index.js start

If you want to start with a different sequencer address, use the -s or --sequncer flag.

~$ ./index.js start --sequencer https://kzg-ceremony-sequencer-dev.fly.dev

Step 2. Select authentication method

Choose the authentication method you want, Ethereum or GitHub.

Authentication
? Which method do you prefer for authentication? (Use arrow keys)
❯ ethereum 
  github

If you select either ethereum or github, you will receive a URL.

? Which method do you prefer for authentication? ethereum
https://oidc.signinwithethereum.org/authorize?xxxxxx

Step 3. Input your session ID

After accessing the given URL, you need to go through the authentication process and get a session ID, which you then need to input. Once you have inputted your session ID, you can start contributing.

If there is another contributor, the client retries every 30 seconds. Wait until your turn comes.

? Input your session ID:  <session ID>
2023-03-02 20:46:00 [ info ] Try and Wait...
2023-03-02 20:46:01 [ info ] another contribution in progress - retry after 30 seconds
2023-03-02 20:46:32 [ info ] another contribution in progress - retry after 30 seconds
2023-03-02 20:47:02 [ info ] another contribution in progress - retry after 30 seconds
2023-03-02 20:47:33 [ info ] another contribution in progress - retry after 30 seconds

When it's your turn, run the ceremony

2023-03-02 20:43:18 [ info ] Run Ceremony...
2023-03-02 20:43:18 [ info ] Decoding contributions....
2023-03-02 20:43:35 [ info ] Update Power of Tau...
2023-03-02 20:43:35 [ info ] Run contribute worker
2023-03-02 20:43:35 [ info ] Run contribute worker
2023-03-02 20:43:35 [ info ] Run contribute worker
2023-03-02 20:43:35 [ info ] Run contribute worker
2023-03-02 20:44:12 [ info ] Receive new contribution
2023-03-02 20:44:44 [ info ] Receive new contribution
2023-03-02 20:45:44 [ info ] Receive new contribution
2023-03-02 20:47:41 [ info ] Receive new contribution
2023-03-02 20:47:41 [ info ] Update Witnesses...
2023-03-02 20:47:41 [ info ] Encoding...
2023-03-02 20:47:42 [ info ] Send contributions
2023-03-02 20:47:50 [ info ] Successfully contributed!
2023-03-02 20:47:50 [ info ] {
  receipt: ...
  signature: ...
}

If the contribution is successful, you can obtain two files.

  • contributions.json: Contribution actually submitted to the sequencer.
  • receipt.json: Receipt received from sequencer for your contribution.

For Air-Gapped Contribution

There are additional command for air-gapped contribution.

Below steps will be procees with two separated machined and also recommended to use network blocked a machine, will calculate the contribution.

Step 1: Authenticate and download previous contribution files

First, on the network-connected machine, try below to retrieve previous contributions.

~$ ./index.js try-contribute 
2023-03-31 14:04:43 [ info ] Start try contribution
? Which method do you prefer for authentication? github
https://oidc.signinwithethereum.org/authorize?xxxxxx

? Input your session ID:  <session ID>
2023-03-31 14:04:56 [ info ] Try and Wait...
2023-03-31 14:04:59 [ info ] Previous contribution is written on contribution_<session ID>.json

You will get the new json file, which the name forms contribution_<session ID>.json.

Step 2: Move prev. contribution file to air-gapped machine

Then, copy the contribution file and copy it into air-gapped machine. You may use flash memory(USB memory) to copy the contribution file into air-gapped machine. I definitely recommend that do not connect air-gapped machine for copying the contribution file.

Step 3: Create new contribution

Now, try to calculate new contribution from air-gapped machine.

~$ ./index.js execute-ceremony -f ./contribution_<session ID>.json

2023-03-31 14:14:04 [ info ] Start Execute Ceremony
2023-03-31 14:14:04 [ info ] Run Ceremony...
2023-03-31 14:14:04 [ info ] Decoding contributions....
2023-03-31 14:14:14 [ info ] Update Power of Tau...
2023-03-31 14:14:14 [ info ] Run contribute worker
2023-03-31 14:14:14 [ info ] Run contribute worker
2023-03-31 14:14:14 [ info ] Run contribute worker
2023-03-31 14:14:14 [ info ] Run contribute worker
2023-03-31 14:14:35 [ info ] Receive new contribution
2023-03-31 14:14:48 [ info ] Receive new contribution
2023-03-31 14:15:17 [ info ] Receive new contribution
2023-03-31 14:16:14 [ info ] Receive new contribution
2023-03-31 14:16:14 [ info ] Update Witnesses...
2023-03-31 14:16:15 [ info ] Encoding...
2023-03-31 14:16:15 [ info ] Previous contribution is written on new_contribution.json

Step 4: Copy the new contribution file

Similary to Step 2, move the result file to internet-connected machine. I also recommend that do not connect internet.

Step 5: Upload new contribution file

If you copy the new contribution file into internet connected machine, the final step is uploading it to the sequencer.

~$ ./index.js contribute -f ./new_contribution.json --session_id <session ID>
2023-03-31 14:32:27 [ info ] Submit contribution
2023-03-31 14:32:27 [ info ] Send contributions
2023-03-31 14:33:29 [ info ] Successfully contributed!
2023-03-31 14:33:29 [ info ] {
  receipt: ...
  signature: ...
}

If the file is uploaded successfully, you will get receipt.json file.

Step 6: Destory the machine, which is used at Step 3

Most important step. Destory air-gapped machine!

Contact us

Please, contact us if you have any improvements and need any further information about CZG-Keremony.

DSRV is a blockchain infrastructure company that provides powerful and easy-to-use solutions to enable developers and enterprises to become architects of the future. Visit DSRV, if you are interested in various products we build for the Web 3.0 developers.

Homepage Medium Github Youtube Twitter