feat: extend `privval` to support signing raw bytes #5138

rach-id · May 27, 2025

Added a new method to the PrivValidator interface that enables validators to securely sign arbitrary raw bytes.

Implements #5126 in v0.38.x

I will open a PR for main after this one gets merged or when it's reviewed and the changes are agreed upon.

PR checklist

Tests written/updated
Changelog entry added in .changelog (we use unclog to manage our changelog)
Updated relevant documentation (docs/ or spec/) and code comments

…order + add test

ironbird-prod · May 27, 2025

Ironbird - launch a network

To use Ironbird, you can use the following commands:

/ironbird start OR /ironbird start --load-test-config= - Launch a testnet with the specified chain and load test configuration.
/ironbird chains - List of chain images that ironbird can use to spin-up testnet
/ironbird loadtests - List of load test modes that ironbird can run against testnet

Custom Load Test Configuration

You can provide a custom load test configuration using the `--load-test-config=` flag:

/ironbird start cosmos --load-test-config={
  "block_gas_limit_target": 0.75,
  "num_of_blocks": 50,
  "msgs": [
    {"weight": 0.3, "type": "MsgSend"},
    {"weight": 0.3, "type": "MsgMultiSend"},
	{"weight": 0.4, "type": "MsgArr", "ContainedType": "MsgSend", "NumMsgs": 3300}
  ]
}

Use /ironbird loadtests to see more examples.

zrbecker · May 27, 2025

This is added in v1.x. We are not planning on backporting this behavior to 0.38

types/priv_validator.go

privval/signer_client.go

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

types/priv_validator.go

Co-authored-by: Tony Arcieri (iqlusion) <tony@iqlusion.io>

github-actions · Jun 16, 2025

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

melekes

LGTM

Copilot

Pull Request Overview

Adds support for signing arbitrary raw byte messages in the PrivValidator API, including new request/response types, client/server handling, implementations, and tests.

Extend PrivValidator with SignRawBytes and implement canonical signing bytes (RawBytesMessageSignBytes)
Define new protobuf messages (SignRawBytesRequest, SignedRawBytesResponse) and wire them through client/server/retry logic
Provide FilePV, MockPV, and end-to-end tests for raw-bytes signing

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
types/priv_validator.go	Added `SignRawBytes` method and `RawBytesMessageSignBytes`
types/priv_validator_test.go	Tests for raw-bytes signing helper
proto/tendermint/privval/types.proto	Added `SignRawBytesRequest`/`SignedRawBytesResponse`
privval/signer_requestHandler.go	Handle `SignRawBytesRequest` in request handler
privval/signer_client.go	Implement `SignerClient.SignRawBytes`
privval/retry_signer_client.go	Retry logic for `SignRawBytes`
privval/msgs.go	Wrap raw-bytes messages in `mustWrapMsg`
privval/file.go	`FilePV.SignRawBytes` implementation
privval/signer_client_test.go	Added `TestSignerRawBytes`

Comments suppressed due to low confidence (2)

privval/retry_signer_client.go:98

There are no tests covering RetrySignerClient.SignRawBytes; consider adding unit tests to validate retry and error paths.

func (sc *RetrySignerClient) SignRawBytes(chainID, uniqueID string, rawBytes []byte) ([]byte, error) {

types/priv_validator.go:21

[nitpick] Add a doc comment for the new SignRawBytes interface method to explain its purpose, parameters, and return values.

	SignRawBytes(chainID, uniqueID string, rawBytes []byte) ([]byte, error)

types/priv_validator.go

privval/signer_requestHandler.go

privval/signer_client_test.go

privval/retry_signer_client.go

privval/file.go

rach-id · Jun 24, 2025

@zrbecker any update on when this can be merged? it's currently blocking our throughput increase work. Thanks 🙏

aljo242 · Jul 24, 2025

@rach-id looks like we have some CI failures

rach-id · Jul 25, 2025

@aljo242 Thanks. I updated the lines that are related to this PR. However, the rest seem to be from the rest of the repo and should be handled in a separate PR better. I can open that PR if you prefer.

For the test, it's a flake that also used to happen in celestia-core and had to fix. So it's not related to the changes. It just needs to be restarted a couple times.

…bytes

rach-id · Aug 4, 2025

@aljo242 any update on this? We would really like to know the status of this PR, if there are any concerns that we can discuss, any improvements we should add to speed up shipping it. Thanks.

Re-enables support for signing raw bytes using a consensus key, originally added in #969. That PR originally sourced its protos via git from: https://github.com/rach-id/tendermint-rs/commits/rachid/generate-latest-v38-protos To avoid the git dependency, this vendors the relevant protos, until such a time that they can be merged into CometBFT properly, i.e.: cometbft/cometbft#5138

rach-id added 10 commits May 16, 2025 09:35

feat: support privval digest signing

cf98f56

feat: implement the sign digest interface + swap digest and chain ID …

1d0c335

…order + add test

chore: add import

0fc6887

chore: implement the sign digest in file pv

6749b21

feat: update the privval implementation to support raw bytes

cc7fe86

chore: rename to raw bytes message sign bytes

d80cf3f

chore: update error message

e087812

chore: rename test to raw bytes

6e24a15

chore: update error message

a6487e9

chore: rename to raw bytes

d8f4ed5

rach-id requested review from a team as code owners May 27, 2025 12:05

melekes reviewed Jun 4, 2025

View reviewed changes

types/priv_validator.go Outdated Show resolved Hide resolved

privval/signer_client.go Show resolved Hide resolved

melekes requested a review from Copilot June 4, 2025 06:19

This comment was marked as outdated.

Sign in to view

Update types/priv_validator.go

fdec289

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

tony-iqlusion reviewed Jun 5, 2025

View reviewed changes

types/priv_validator.go Outdated Show resolved Hide resolved

Update types/priv_validator.go

37760be

Co-authored-by: Tony Arcieri (iqlusion) <tony@iqlusion.io>

github-actions bot added the stale For use by stalebot label Jun 16, 2025

melekes approved these changes Jun 16, 2025

View reviewed changes

Merge branch 'v0.38.x' into rachid/support-digest-signing

2ae93a4

zrbecker approved these changes Jun 16, 2025

View reviewed changes

zrbecker removed the stale For use by stalebot label Jun 16, 2025

mergify bot added 2 commits June 16, 2025 13:08

Merge branch 'v0.38.x' into rachid/support-digest-signing

dfef622

Merge branch 'v0.38.x' into rachid/support-digest-signing

8bf1b35

This was referenced Jun 23, 2025

feat: add types for signing raw digests #5232

Open

feat: support privval raw bytes signing #5233

Open

melekes requested a review from Copilot June 24, 2025 06:39

Merge branch 'v0.38.x' into rachid/support-digest-signing

6f46f2e

Copilot AI reviewed Jun 24, 2025

View reviewed changes

types/priv_validator.go Show resolved Hide resolved

privval/signer_requestHandler.go Show resolved Hide resolved

privval/signer_client_test.go Show resolved Hide resolved

privval/retry_signer_client.go Show resolved Hide resolved

privval/file.go Show resolved Hide resolved

mergify bot added 2 commits July 3, 2025 18:49

Merge branch 'v0.38.x' into rachid/support-digest-signing

a68a7a6

Merge branch 'v0.38.x' into rachid/support-digest-signing

d503f6d

rach-id mentioned this pull request Jul 7, 2025

chore: regenerate v0.38 protos using latest version cometbft/tendermint-rs#1506

Draft

5 tasks

chore: gofumpt

99d12f9

rach-id added 2 commits August 1, 2025 17:35

chore: use marshall delimited to have the separators part of the sign…

41c78f6

…bytes

chore: update test

fb05d65

mergify bot and others added 3 commits August 26, 2025 18:09

Merge branch 'v0.38.x' into rachid/support-digest-signing

c541944

Merge branch 'v0.38.x' into rachid/support-digest-signing

167b37a

Merge branch 'v0.38.x' into rachid/support-digest-signing

3e8248b

tschuyebuhl mentioned this pull request Sep 19, 2025

Implement Celestia's CometBFT privval extensions ChorusOne/nebula#6

Open

tony-iqlusion mentioned this pull request Oct 30, 2025

Vendor protos and re-enable Celestia SignRawBytes* extension iqlusioninc/tmkms#1134

Merged

Search code, repositories, users, issues, pull requests...

feat: extend privval to support signing raw bytes #5138

Are you sure you want to change the base?

feat: extend privval to support signing raw bytes #5138

Uh oh!

Conversation

rach-id commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

ironbird-prod bot commented May 27, 2025

Uh oh!

zrbecker commented May 27, 2025

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

github-actions bot commented Jun 16, 2025

Uh oh!

melekes left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rach-id commented Jun 24, 2025

Uh oh!

aljo242 commented Jul 24, 2025

Uh oh!

rach-id commented Jul 25, 2025

Uh oh!

rach-id commented Aug 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat: extend `privval` to support signing raw bytes #5138

feat: extend `privval` to support signing raw bytes #5138

rach-id commented May 27, 2025 •

edited

Loading