Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ocr3 - performance optimize msghasher #1115

Merged
merged 3 commits into from
Jun 28, 2024
Merged

ocr3 - performance optimize msghasher #1115

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a51d3c
performance optimize msghasher
dimkouv Jun 28, 2024
d9f446d
ref onchain code
dimkouv Jun 28, 2024
bdc8ef1
Merge branch 'ccip-develop' into dk/perf-optimize-msghasher
dimkouv Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 43 additions & 28 deletions core/services/ocr3/plugins/ccipevm/msghasher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,40 @@ import (
type MessageHasherV1 struct {
metaDataHash [32]byte
leafDomainSeparator [32]byte

bytesArrayType abi.Type
tokensAbi abi.ABI
fixedSizeValuesAbi abi.ABI
packedValuesAbi abi.ABI
}

func NewMessageHasherV1(metaDataHash [32]byte) *MessageHasherV1 {
bytesArray, err := abi.NewType("bytes[]", "bytes[]", nil)
if err != nil {
panic(fmt.Sprintf("failed to create bytes[] type: %v", err))
}

return &MessageHasherV1{
metaDataHash: metaDataHash,
leafDomainSeparator: [32]byte{},

bytesArrayType: bytesArray,
tokensAbi: mustParseInputsAbi(`[{"components": [{"name":"token","type":"address"},
{"name":"amount","type":"uint256"}], "type":"tuple[]"}]`),
fixedSizeValuesAbi: mustParseInputsAbi(`[{"name": "sender", "type":"address"},
{"name": "receiver", "type":"address"},
{"name": "sequenceNumber", "type":"uint64"},
{"name": "gasLimit", "type":"uint256"},
{"name": "strict", "type":"bool"},
{"name": "nonce", "type":"uint64"},
{"name": "feeToken","type": "address"},
{"name": "feeTokenAmount","type": "uint256"}]`),
packedValuesAbi: mustParseInputsAbi(`[{"name": "leafDomainSeparator","type":"bytes32"},
Comment on lines +43 to +53
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you reference the solidity code where these types are defined?

{"name": "metadataHash", "type":"bytes32"},
{"name": "fixedSizeValuesHash", "type":"bytes32"},
{"name": "dataHash", "type":"bytes32"},
{"name": "tokenAmountsHash", "type":"bytes32"},
{"name": "sourceTokenDataHash", "type":"bytes32"}]`),
}
}

Expand All @@ -41,31 +69,19 @@ func (h *MessageHasherV1) Hash(_ context.Context, msg cciptypes.CCIPMsg) (ccipty
Amount: ta.Amount,
}
}
encodedTokens, err := h.abiEncode(`[{"components": [{"name":"token","type":"address"},
{"name":"amount","type":"uint256"}], "type":"tuple[]"}]`, tokenAmounts)
encodedTokens, err := h.abiEncode(h.tokensAbi, tokenAmounts)
if err != nil {
return [32]byte{}, fmt.Errorf("abi encode token amounts: %w", err)
}

bytesArray, err := abi.NewType("bytes[]", "bytes[]", nil)
if err != nil {
return [32]byte{}, fmt.Errorf("new abi type bytes[]: %w", err)
}

encodedSourceTokenData, err := abi.Arguments{abi.Argument{Type: bytesArray}}.PackValues([]interface{}{msg.SourceTokenData})
encodedSourceTokenData, err := abi.Arguments{abi.Argument{Type: h.bytesArrayType}}.
PackValues([]interface{}{msg.SourceTokenData})
if err != nil {
return [32]byte{}, fmt.Errorf("pack source token data: %w", err)
}

packedFixedSizeValues, err := h.abiEncode(
`[{"name": "sender", "type":"address"},
{"name": "receiver", "type":"address"},
{"name": "sequenceNumber", "type":"uint64"},
{"name": "gasLimit", "type":"uint256"},
{"name": "strict", "type":"bool"},
{"name": "nonce", "type":"uint64"},
{"name": "feeToken","type": "address"},
{"name": "feeTokenAmount","type": "uint256"}]`,
h.fixedSizeValuesAbi,
common.HexToAddress(string(msg.Sender)),
common.HexToAddress(string(msg.Receiver)),
uint64(msg.SeqNum),
Expand All @@ -81,12 +97,7 @@ func (h *MessageHasherV1) Hash(_ context.Context, msg cciptypes.CCIPMsg) (ccipty
fixedSizeValuesHash := utils.Keccak256Fixed(packedFixedSizeValues)

packedValues, err := h.abiEncode(
`[{"name": "leafDomainSeparator","type":"bytes32"},
{"name": "metadataHash", "type":"bytes32"},
{"name": "fixedSizeValuesHash", "type":"bytes32"},
{"name": "dataHash", "type":"bytes32"},
{"name": "tokenAmountsHash", "type":"bytes32"},
{"name": "sourceTokenDataHash", "type":"bytes32"}]`,
h.packedValuesAbi,
h.leafDomainSeparator,
h.metaDataHash,
fixedSizeValuesHash,
Expand All @@ -101,17 +112,21 @@ func (h *MessageHasherV1) Hash(_ context.Context, msg cciptypes.CCIPMsg) (ccipty
return utils.Keccak256Fixed(packedValues), nil
}

func (h *MessageHasherV1) abiEncode(abiStr string, values ...interface{}) ([]byte, error) {
inDef := fmt.Sprintf(`[{ "name" : "method", "type": "function", "inputs": %s}]`, abiStr)
inAbi, err := abi.JSON(strings.NewReader(inDef))
func (h *MessageHasherV1) abiEncode(theAbi abi.ABI, values ...interface{}) ([]byte, error) {
res, err := theAbi.Pack("method", values...)
if err != nil {
return nil, err
}
res, err := inAbi.Pack("method", values...)
return res[4:], nil
}

func mustParseInputsAbi(s string) abi.ABI {
inDef := fmt.Sprintf(`[{ "name" : "method", "type": "function", "inputs": %s}]`, s)
inAbi, err := abi.JSON(strings.NewReader(inDef))
if err != nil {
return nil, err
panic(fmt.Errorf("failed to create %s ABI: %v", s, err))
}
return res[4:], nil
return inAbi
}

// Interface compliance check
Expand Down
35 changes: 34 additions & 1 deletion core/services/ocr3/plugins/ccipevm/msghasher_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ func testSetup(t *testing.T) *testSetupData {
func TestMessageHasher_Hash(t *testing.T) {
ctx := testutils.Context(t)

largeNumber, ok := big.NewInt(0).SetString("1000000000000000000", 10) //1e18
largeNumber, ok := big.NewInt(0).SetString("1000000000000000000", 10) // 1e18
require.True(t, ok)

msgData, err := hex.DecodeString("64617461")
Expand Down Expand Up @@ -294,3 +294,36 @@ func TestMessageHasher_Hash(t *testing.T) {
})
}
}

func BenchmarkMessageHasher_Hash(b *testing.B) {
ctx := testutils.Context(b)
msg := cciptypes.CCIPMsg{
CCIPMsgBaseDetails: cciptypes.CCIPMsgBaseDetails{
SourceChain: 1,
SeqNum: 1,
},
ChainFeeLimit: cciptypes.NewBigIntFromInt64(400000),
Nonce: 1,
Sender: types.Account(utils.RandomAddress().String()),
Receiver: types.Account(utils.RandomAddress().String()),
Strict: false,
FeeToken: types.Account(utils.RandomAddress().String()),
FeeTokenAmount: cciptypes.NewBigIntFromInt64(1234567890),
Data: make([]byte, 2048),
TokenAmounts: []cciptypes.TokenAmount{
{
Token: types.Account(utils.RandomAddress().String()),
Amount: utils.RandUint256(),
},
},
SourceTokenData: [][]byte{make([]byte, 2048)},
}
metadataHash := utils.RandomBytes32()

m := NewMessageHasherV1(metadataHash)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_, err := m.Hash(ctx, msg)
require.NoError(b, err)
}
}
Loading