Skip to content

refactor: Change parameters format in genesis.json#5020

Merged
mversic merged 3 commits intohyperledger-iroha:mainfrom
dima74:diralik/change-parameter-genesis-json
Sep 9, 2024
Merged

refactor: Change parameters format in genesis.json#5020
mversic merged 3 commits intohyperledger-iroha:mainfrom
dima74:diralik/change-parameter-genesis-json

Conversation

@dima74
Copy link
Copy Markdown
Contributor

@dima74 dima74 commented Aug 29, 2024 •
edited
Loading

Context

Fixes #4813

Solution

Changes format of genesis.json from (full format):

{
  ...
  "parameters": [
    {
      "Sumeragi": {
        "BlockTimeMs": 2000
      }
    },
    {
      "Sumeragi": {
        "CommitTimeMs": 4000
      }
    },
    ...
    {
      "Transaction": {
        "MaxInstructions": 4096
      }
    },
    ...

to (full format):

{
  ...
  "parameters": {
    "sumeragi": {
      "block_time_ms": 2000,
      "commit_time_ms": 4000,
      ...
    },
    "transaction": {
      "max_instructions": 4096,
      ...
    },
    ...

Migration Guide (optional)

  • kagami genesis generate will generate genesis in the new format. Custom genesis generator tools should be changed to new format.
  • Note that schema.json has type entry RawGenesisTransaction corresponding to genesis.json file

Review notes (optional)

Checklist

  • I've read CONTRIBUTING.md.
  • (optional) I've written unit tests for the code changes.
  • All review comments have been resolved.

@dima74 dima74 self-assigned this Aug 29, 2024
@github-actions github-actions bot added api-changes Changes in the API for client libraries config-changes Changes in configuration and start up of the Iroha labels Aug 29, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 29, 2024

@BAStos525

dima74
dima74 commented Aug 29, 2024
View reviewed changes
Comment thread docs/source/references/schema.json
@dima74 dima74 mentioned this pull request Aug 29, 2024
Closed
@Erigara Erigara self-assigned this Aug 29, 2024
mversic
mversic reviewed Aug 30, 2024
View reviewed changes
Comment thread data_model/src/parameter.rs Outdated
mversic
mversic previously approved these changes Aug 30, 2024
View reviewed changes
@mversic mversic self-assigned this Aug 30, 2024
mversic
mversic requested changes Aug 31, 2024
View reviewed changes
Comment thread data_model/src/parameter.rs Outdated
@dima74 dima74 force-pushed the diralik/change-parameter-genesis-json branch from 31dea9a to 731d4c8 Compare September 2, 2024 14:59
Erigara
Erigara reviewed Sep 3, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@Erigara Erigara left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objections from codewise perspective and imo genesis this way looks more readable.

Let's see what SDK guys think: @Mingela @SamHSmith @0x009922

@mversic mversic force-pushed the diralik/change-parameter-genesis-json branch from 731d4c8 to a344382 Compare September 4, 2024 03:23
@mversic mversic requested a review from Erigara September 4, 2024 03:43
mversic
mversic reviewed Sep 4, 2024
View reviewed changes
Comment thread defaults/genesis.json
@mversic mversic enabled auto-merge (squash) September 4, 2024 07:57
@mversic mversic force-pushed the diralik/change-parameter-genesis-json branch from a344382 to 33decf3 Compare September 4, 2024 12:15
@dima74 @mversic
refactor: Change parameters format in genesis.json
52bc741 
Signed-off-by: Dmitry Murzin <diralik@yandex.ru>
@dima74 @mversic
Review fixes
44a378c 
Signed-off-by: Dmitry Murzin <diralik@yandex.ru>
@dima74 @mversic
Review fixes
6a8c4df 
Signed-off-by: Dmitry Murzin <diralik@yandex.ru>
@mversic mversic force-pushed the diralik/change-parameter-genesis-json branch from 33decf3 to 6a8c4df Compare September 9, 2024 06:19
@mversic mversic merged commit a60a1a0 into hyperledger-iroha:main Sep 9, 2024
@dima74 dima74 deleted the diralik/change-parameter-genesis-json branch September 9, 2024 11:39
@dima74
Copy link
Copy Markdown
Contributor Author

dima74 commented Sep 9, 2024

@BAStos525 @timofeevmd format of parameters in genesis.json has changed. Please see PR description for details of the new format.

@0x009922 0x009922 mentioned this pull request Sep 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mversic mversic mversic approved these changes

@s8sato s8sato Awaiting requested review from s8sato s8sato is a code owner

@SamHSmith SamHSmith Awaiting requested review from SamHSmith

@outoftardis outoftardis Awaiting requested review from outoftardis outoftardis is a code owner

@0x009922 0x009922 Awaiting requested review from 0x009922 0x009922 is a code owner

@DCNick3 DCNick3 Awaiting requested review from DCNick3 DCNick3 is a code owner

+1 more reviewer

@Erigara Erigara Erigara approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@dima74 dima74

@Erigara Erigara

@mversic mversic

Labels

api-changes Changes in the API for client libraries config-changes Changes in configuration and start up of the Iroha

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

refactor: how to represent parameters in genesis

3 participants

@dima74 @Erigara @mversic