feat: cache for signature verification #18422
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,72 @@ | ||||||
| package types | ||||||
|
|
||||||
| import ( | ||||||
| lru "github.com/hashicorp/golang-lru/v2" | ||||||
| ) | ||||||
|
|
||||||
| // SignatureCache is a cache of verified signatures | ||||||
| type SignatureCache struct { | ||||||
| data *lru.Cache[string, []byte] | ||||||
| } | ||||||
|
|
||||||
| // NewSignatureCache initializes the signature cache. | ||||||
| // signature verification is one of the most expensive parts in verification | ||||||
| // by caching it we avoid needing to verify the same signature multiple times | ||||||
| func NewSignatureCache() (*SignatureCache, error) { | ||||||
| // 500 * (32 + 42) = 37.5KB | ||||||
| cache, err := lru.New[string, []byte](500) | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &SignatureCache{data: cache}, nil | ||||||
| } | ||||||
|
|
||||||
| // Get returns the cached signature if it exists | ||||||
| func (c *SignatureCache) Get(key string) ([]byte, bool) { | ||||||
| if !c.validate(key) { | ||||||
| return nil, false | ||||||
| } | ||||||
|
|
||||||
| return c.data.Get(key) | ||||||
| } | ||||||
|
|
||||||
| // Add adds a signature to the cache | ||||||
| func (c *SignatureCache) Add(key string, value []byte) { | ||||||
| // validate | ||||||
| if !c.validate(key) { | ||||||
| return | ||||||
| } | ||||||
| c.data.Add(key, value) | ||||||
| } | ||||||
|
|
||||||
| // Remove removes a signature from the cache | ||||||
| func (c *SignatureCache) Remove(key string) { | ||||||
| // validate | ||||||
| if !c.validate(key) { | ||||||
| return | ||||||
| } | ||||||
| c.data.Remove(key) | ||||||
| } | ||||||
|
|
||||||
| // validate validates the key and cache | ||||||
| func (c *SignatureCache) validate(key string) bool { | ||||||
| return len(key) != 0 | ||||||
| } | ||||||
|
|
||||||
| // sigkey is the key used to store the signature in the cache | ||||||
| type sigkey struct { | ||||||
| signbytes []byte | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| sig []byte | ||||||
| } | ||||||
|
|
||||||
| func NewSigKey(signbytes, sig []byte) sigkey { | ||||||
| return sigkey{ | ||||||
| signbytes: signbytes, | ||||||
| sig: sig, | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func (s sigkey) String() string { | ||||||
| return string(append(s.signbytes, s.sig...)) | ||||||
| } | ||||||
tac0turtle marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -153,17 +153,30 @@ func (spkd SetPubKeyDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate b | |
| // CONTRACT: Pubkeys are set in context for all signers before this decorator runs | ||
| // CONTRACT: Tx must implement SigVerifiableTx interface | ||
| type SigVerificationDecorator struct { | ||
| ak AccountKeeper | ||
| signModeHandler *txsigning.HandlerMap | ||
| sigGasConsumer SignatureVerificationGasConsumer | ||
| cacheVerification *cryptotypes.SignatureCache | ||
| } | ||
|
|
||
| func NewSigVerificationDecorator(ak AccountKeeper, signModeHandler *txsigning.HandlerMap, sigGasConsumer SignatureVerificationGasConsumer, cacheVerification bool) SigVerificationDecorator { | ||
| svd := SigVerificationDecorator{ | ||
| ak: ak, | ||
| signModeHandler: signModeHandler, | ||
| sigGasConsumer: sigGasConsumer, | ||
| } | ||
|
|
||
| if cacheVerification { | ||
| sv, err := cryptotypes.NewSignatureCache() | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| svd.cacheVerification = sv | ||
|
|
||
| } | ||
|
|
||
| return svd | ||
| } | ||
|
|
||
| // OnlyLegacyAminoSigners checks SignatureData to see if all | ||
|
|
@@ -363,7 +376,7 @@ func (svd SigVerificationDecorator) verifySig(ctx sdk.Context, simulate bool, tx | |
| return fmt.Errorf("expected tx to implement V2AdaptableTx, got %T", tx) | ||
| } | ||
| txData := adaptableTx.GetSigningTxData() | ||
| err := authsigning.VerifySignature(ctx, pubKey, signerData, sig.Data, svd.signModeHandler, txData, svd.cacheVerification) | ||
| if err != nil { | ||
| var errMsg string | ||
| if OnlyLegacyAminoSigners(sig.Data) { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -179,7 +179,7 @@ func TestSigVerification(t *testing.T) { | |
| ) | ||
| require.NoError(t, err) | ||
| noOpGasConsume := func(_ storetypes.GasMeter, _ signing.SignatureV2, _ types.Params) error { return nil } | ||
| svd := ante.NewSigVerificationDecorator(suite.accountKeeper, anteTxConfig.SignModeHandler(), noOpGasConsume, true) | ||
| antehandler := sdk.ChainAnteDecorators(spkd, svd) | ||
| defaultSignMode, err := authsign.APISignModeToInternal(anteTxConfig.SignModeHandler().DefaultMode()) | ||
| require.NoError(t, err) | ||
|
|
@@ -314,7 +314,7 @@ func runSigDecorators(t *testing.T, params types.Params, _ bool, privs ...crypto | |
| require.NoError(t, err) | ||
|
|
||
| spkd := ante.NewSetPubKeyDecorator(suite.accountKeeper) | ||
| svd := ante.NewSigVerificationDecorator(suite.accountKeeper, suite.clientCtx.TxConfig.SignModeHandler(), ante.DefaultSigVerificationGasConsumer, false) | ||
| antehandler := sdk.ChainAnteDecorators(spkd, svd) | ||
|
|
||
| txBytes, err := suite.clientCtx.TxConfig.TxEncoder()(tx) | ||
|
|
@@ -371,7 +371,7 @@ func TestAnteHandlerChecks(t *testing.T) { | |
| } | ||
|
|
||
| setPubKeyDecorator := ante.NewSetPubKeyDecorator(suite.accountKeeper) | ||
| sigVerificationDecorator := ante.NewSigVerificationDecorator(suite.accountKeeper, anteTxConfig.SignModeHandler(), ante.DefaultSigVerificationGasConsumer, true) | ||
|
|
||
| anteHandler := sdk.ChainAnteDecorators(setPubKeyDecorator, sigVerificationDecorator) | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My only gripe with this is that I think
Addshould actually take acryptotypes.SIgKeyas an argument instead of astring. The reason I recommend this is that theSignatureCachedoesn't really pertain to a signature cache, the API suggests it can be used for any [string,[]byte] mapping. So I'd recommend either changing the argument.Note, this isn't to block, but just a suggestion.