Keccak-256 and Blake2b-224 (PLT-6305, PLT-6306, PLT-6311, PLT-6820) #5431

kwxm · 2023-07-20T18:33:18Z

This adds new builtins for keccak_256 (see this proposed CIP), which will help with Ethereum compatiblity, and blake2b_224, which will allow on-chain computation of ledger-compatible PubKeyHash hashes (see #5369, which should also lead to a CIP in the near future). This PR adds these functions to plutus-core, plutus-tx, plutus-metatheory and plutus-ledger-api.

The following remain to be done

Proper costing once we have a new benchmarking machine, For the time being I've re-used the cost model for blake2b_256 for blake2b_224 and the one for sha3_256 for keccak_256, which is a variant of sha3_256.
Conformance tests. These will be added as part of a revision of the tests for the hash functions to use authoritative standard test vectors.
End-to-end tests
Adding the functions to the PLC specification.

kwxm · 2023-07-20T19:57:16Z

plutus-core/plutus-core/src/PlutusCore/Crypto/Hash.hs

@@ -1,13 +1,16 @@
 -- | Hash functions for lazy [[Data.ByteString.ByteString]]s
 {-# LANGUAGE TypeApplications #-}
-module Data.ByteString.Hash


I decided to rename this because the other crypto stuff is in this directory already.

michaelpj

I guess we should probably have a CIP for blake2b-224, alas. Kenneth do you want to draft it?

michaelpj · 2023-07-21T10:26:09Z

plutus-core/plutus-core/src/PlutusCore/Crypto/Hash.hs

@@ -21,6 +24,14 @@ sha2_256 = digest (Proxy @SHA256)
 sha3_256 :: BS.ByteString -> BS.ByteString
 sha3_256 = digest (Proxy @SHA3_256)

+-- | Hash a [[BSL.ByteString]] using the Blake2B-256 hash function.


Suggested change

-- | Hash a [[BSL.ByteString]] using the Blake2B-256 hash function.

-- | Hash a [[BSL.ByteString]] using the Blake2B-224 hash function.

michaelpj · 2023-07-21T10:29:15Z

plutus-core/plutus-core/test/CostModelInterface/defaultCostModelParams.json

  "blake2b_256-cpu-arguments-intercept": 117366,
  "blake2b_256-cpu-arguments-slope": 10475,
  "blake2b_256-memory-arguments": 4,
+  "bls12_381_G1_add-cpu-arguments": 1046420,


hmmmm, weird that these were missing before??

Yes, I wondered about this.

Actually I think that's OK. This set of cost model parameters is used by the tests for the code that updates the cost model using the flattened parameters. That's the code that uses the JSON-y stuff and I think that I wrote the tests to convince myself that it was doing the right thing. The tests are self-contained and it doesn't matter exactly what cost model is used as long as it's sensible. It won't do any harm to extend it though.

michaelpj · 2023-07-21T10:30:47Z

plutus-ledger-api/test/Spec/CostModelParams.hs

    , testCase "context length" $ do
            let defaultCostValues = Map.elems $ fromJust defaultCostModelParams
            -- the defaultcostmodelparams reflects only the latest version V3, so this should succeed because the lengths match
            assertBool "wrong number of arguments in V2.mkContext" $ isRight $ runExcept $ runWriterT $ V3.mkEvaluationContext defaultCostValues
-            -- currently v2 args ==v3 args
+            -- currently v2 args == v3 args


Something is funny about these tests, should one of these be failing? @bezirg

I think PLT-5390 (which we were talking about yesterday) should cover that. I had to add some stuff to those tests for BLS12-381 a while ago and I wasn't totally confident that I'd got it right.

Oh, that comment's wrong. I corrected the spacing but I should probably just have deleted it.

kwxm · 2023-07-21T10:57:44Z

I guess we should probably have a CIP for blake2b-224, alas. Kenneth do you want to draft it?

See #5369 (like it says in the PR description!), especially this comment. Maybe we've got the cart before the horse here, but I don't think that'll be too controversial in this case.

effectfully

Great, pretty straightforward.

effectfully · 2023-07-21T18:41:41Z

plutus-core/plutus-core/src/PlutusCore/Crypto/Hash.hs

@@ -21,6 +24,14 @@ sha2_256 = digest (Proxy @SHA256)
 sha3_256 :: BS.ByteString -> BS.ByteString
 sha3_256 = digest (Proxy @SHA3_256)

+-- | Hash a [[BSL.ByteString]] using the Blake2B-224 hash function.


Pardon my ignorance, what is this [[...]] syntax in Haddock?

Ah, I asked about that before and no-one could tell me, then I just copied it without looking.

effectfully · 2023-07-21T18:44:27Z

plutus-core/plutus-core/src/PlutusCore/Crypto/Hash.hs

+-- | Hash a [[BSL.ByteString]] using the Blake2B-224 hash function.
+blake2b_224 :: BS.ByteString -> BS.ByteString
+blake2b_224 = digest (Proxy @Blake2b_224)
+
 -- | Hash a [[BSL.ByteString]] using the Blake2B-256 hash function.


Also it's not BSL.ByteString but rather BS.ByteString?

I just changed it to ByteString. The signature should tell us everything we need to know about the type.

mjaskelioff

Great job. I'm happy to see that there seems to be no pain in adding new builtins.

kwxm · 2023-07-26T13:35:15Z

there seems to be no pain in adding new builtins.

Yes, it's way easier than it used to be, so thanks for that.

adrian1-dot · 2024-01-11T16:00:35Z

Are there any updates to blake2b_224?
There is no mention of it in CIP101 where keccak256 is proposed. Does that mean it will not be implemented?

Also, it is wrongly defined. The inline version is exported by PlutusTx.Builtins.

blake2b_224 :: BuiltinByteString -> BuiltinByteString
blake2b_224 = BI.blake2b_256

blake2b_256 is used instead of blake2b_224

blake2b_224 :: BuiltinByteString -> BuiltinByteString
blake2b_224 = BI.blake2b_224

I suspect this is a typo, as it is correctly exported from PlutusTx.Builtins.Internal.

GeorgeFlerovsky · 2024-02-19T23:55:00Z

Are there any updates to blake2b_224?
There is no mention of it in CIP101 where keccak256 is proposed. Does that mean it will not be implemented?

Also, it is wrongly defined. The inline version is exported by PlutusTx.Builtins.

blake2b_224 :: BuiltinByteString -> BuiltinByteString
blake2b_224 = BI.blake2b_256

blake2b_256 is used instead of blake2b_224

blake2b_224 :: BuiltinByteString -> BuiltinByteString
blake2b_224 = BI.blake2b_224

I suspect this is a typo, as it is correctly exported from PlutusTx.Builtins.Internal.

@kwxm @michaelpj
Is the above indeed a typo?

zliu41 · 2024-02-20T01:20:15Z

Is the above indeed a typo?

It was a typo and has been fixed.

…ntersectMBO#5431) * WIP * keccak256 -> keccak_256 * Update plutus-metatheory * Add blake2b_224 * Add blake2b_224 * Add blake2b_224 * Merge update * Fix a couple of omissions * Add missing imports * Add keccak_256 and blake2b_224 to V3.ParamName * Add test for keccak_256 and blake2b_224 * Fake cost model for keccak_256 and blake2b_224 * Update json file for CostModelInterface tests * Add changelog entries * Add Keccak_256 and Blake2b_224 to Versions.hs in plutus-ledger-api * Typo in comment * Typo in comment * Fix dodgy Haddock * Fix dodgy Haddock * Add property test for hash sizes * Haddock for hash size tests * Formatting * Formatting * Fix some BLS-related comments (unrelated to this PR)

kwxm added 17 commits June 19, 2023 19:32

WIP

c5b0a1e

keccak256 -> keccak_256

9f84260

Update plutus-metatheory

364ae31

Add blake2b_224

e20a7e1

Add blake2b_224

5d474b2

Add blake2b_224

1925c6c

Merge branch 'master' into kwxm/builtins/keccak256

2a195eb

Merge update

dcc817e

Fix a couple of omissions

824b63d

Add missing imports

5413bef

Add keccak_256 and blake2b_224 to V3.ParamName

e464e23

Add test for keccak_256 and blake2b_224

f4bb2ef

Fake cost model for keccak_256 and blake2b_224

5d34828

Update json file for CostModelInterface tests

2b35645

Merge branch 'master' into kwxm/builtins/keccak256

f6c6097

Add changelog entries

3847cca

Add Keccak_256 and Blake2b_224 to Versions.hs in plutus-ledger-api

11a1d4c

kwxm requested review from bezirg, mjaskelioff, zliu41 and effectfully July 20, 2023 18:33

kwxm added Builtins Crypto labels Jul 20, 2023

kwxm commented Jul 20, 2023

View reviewed changes

michaelpj approved these changes Jul 21, 2023

View reviewed changes

michaelpj mentioned this pull request Jul 21, 2023

CIP-0101 | Integration of keccak256 into Plutus cardano-foundation/CIPs#524

Merged

kwxm added 2 commits July 21, 2023 12:28

Typo in comment

2213976

Typo in comment

f8d5adf

effectfully approved these changes Jul 21, 2023

View reviewed changes

kwxm added 7 commits July 21, 2023 23:32

Fix dodgy Haddock

470ee02

Fix dodgy Haddock

c74fe1a

Add property test for hash sizes

108aab8

Haddock for hash size tests

1893009

Formatting

5e75810

Formatting

6b0dc96

Fix some BLS-related comments (unrelated to this PR)

ae29519

mjaskelioff approved these changes Jul 26, 2023

View reviewed changes

kwxm merged commit 173dce5 into master Jul 26, 2023

kwxm deleted the kwxm/builtins/keccak256 branch July 26, 2023 20:08

catch-21 mentioned this pull request Aug 30, 2023

Add onchain checks for V3 hashing builtins blake2b_224 and keccak256 IntersectMBO/antaeus#43

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keccak-256 and Blake2b-224 (PLT-6305, PLT-6306, PLT-6311, PLT-6820) #5431

Keccak-256 and Blake2b-224 (PLT-6305, PLT-6306, PLT-6311, PLT-6820) #5431

kwxm commented Jul 20, 2023 •

edited

Loading

kwxm Jul 20, 2023

michaelpj left a comment

michaelpj Jul 21, 2023

michaelpj Jul 21, 2023

kwxm Jul 21, 2023

kwxm Jul 21, 2023 •

edited

Loading

michaelpj Jul 21, 2023

kwxm Jul 21, 2023 •

edited

Loading

kwxm Jul 21, 2023

kwxm commented Jul 21, 2023 •

edited

Loading

effectfully left a comment

effectfully Jul 21, 2023

kwxm Jul 21, 2023

effectfully Jul 21, 2023

kwxm Jul 21, 2023

mjaskelioff left a comment

kwxm commented Jul 26, 2023

adrian1-dot commented Jan 11, 2024

GeorgeFlerovsky commented Feb 19, 2024

zliu41 commented Feb 20, 2024

	-- \| Hash a [[BSL.ByteString]] using the Blake2B-256 hash function.
	-- \| Hash a [[BSL.ByteString]] using the Blake2B-224 hash function.

Keccak-256 and Blake2b-224 (PLT-6305, PLT-6306, PLT-6311, PLT-6820) #5431

Keccak-256 and Blake2b-224 (PLT-6305, PLT-6306, PLT-6311, PLT-6820) #5431

Conversation

kwxm commented Jul 20, 2023 • edited Loading

Choose a reason for hiding this comment

michaelpj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwxm Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwxm Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwxm commented Jul 21, 2023 • edited Loading

effectfully left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjaskelioff left a comment

Choose a reason for hiding this comment

kwxm commented Jul 26, 2023

adrian1-dot commented Jan 11, 2024

GeorgeFlerovsky commented Feb 19, 2024

zliu41 commented Feb 20, 2024

kwxm commented Jul 20, 2023 •

edited

Loading

kwxm Jul 21, 2023 •

edited

Loading

kwxm Jul 21, 2023 •

edited

Loading

kwxm commented Jul 21, 2023 •

edited

Loading