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

Jump to bottom

Add 32 byte chainwork support #2884

Merged

josedahlquist merged 8 commits into master from 32-byte-chainwork-support-integration

Dec 12, 2024

+2,090 −182

Contributor

nathanieliov commented Dec 9, 2024 •

edited

Loading

Description

Add RSKIP454 activation
Bump bitcoinjThinVer version to 0.14.4-rsk-17-SNAPSHOT
Add the use of serializeCompactV2 method in RepositoryBtcBlockStoreWithCache
Add the use of deserializeCompactV2 method in RepositoryBtcBlockStoreWithCache
Add tests validating 32-byte chainwork checkpoints can be processed once RSKIP454 is activated

How Has This Been Tested?

Unit tests

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
Tests for the changes have been added (for bug fixes / features)
Requires Activation Code (Hard Fork)

nathanieliov requested a review from a team as a code owner

December 9, 2024 14:51

github-actions bot commented Dec 9, 2024 •

edited

Loading

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Manifest Files

github-advanced-security bot found potential problems

View reviewed changes

rskj-core/src/main/java/co/rsk/peg/RepositoryBtcBlockStoreWithCache.java

+                  private ByteBuffer serializeBlock(StoredBlock block) {
+                      if (shouldUseLegacy12ByteChainworkFormat()) {
+                          ByteBuffer byteBuffer = ByteBuffer.allocate(StoredBlock.COMPACT_SERIALIZED_SIZE_LEGACY);
+                          block.serializeCompactLegacy(byteBuffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/main/java/co/rsk/peg/RepositoryBtcBlockStoreWithCache.java

                   private StoredBlock byteArrayToStoredBlock(byte[] ba) {
                       ByteBuffer byteBuffer = ByteBuffer.wrap(ba);
-                      return StoredBlock.deserializeCompact(btcNetworkParams, byteBuffer);
+                      if (ba.length == StoredBlock.COMPACT_SERIALIZED_SIZE_LEGACY) {
+                          return deserializeCompactLegacy(btcNetworkParams, byteBuffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note

Invoking

StoredBlock.deserializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/test/java/co/rsk/peg/BridgeSupportIT.java

+                      BridgeConstants bridgeConstants) throws IOException {
+                      String checkpointToCreate = "/rskbitcoincheckpoints/" + bridgeConstants.getBtcParams().getId() + ".checkpoints";
+                      Path target = Paths.get(getClass().getResource(checkpointToCreate).getPath());

Check warning

Code scanning / CodeQL

Unsafe use of getResource Warning test

The idiom getClass().getResource() is unsafe for classes that may be extended.

rskj-core/src/test/java/co/rsk/peg/BridgeSupportIT.java


		Path target = Paths.get(getClass().getResource(checkpointToCreate).getPath());

		Path source = Paths.get(getClass().getResource("/checkpoints/" + checkpointFileName).getPath());

Check warning

Code scanning / CodeQL

Unsafe use of getResource Warning test

The idiom getClass().getResource() is unsafe for classes that may be extended.

rskj-core/src/test/java/co/rsk/peg/BridgeSupportIT.java

                               for (BtcBlock block : checkpoints) {
                                   storedBlock = storedBlock.build(block);
-                                  storedBlock.serializeCompact(buffer);
+                                  storedBlock.serializeCompactLegacy(buffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java Fixed Show fixed Hide fixed

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java

+                      int expectedCompactSerializedSize = COMPACT_SERIALIZED_SIZE_LEGACY;
+                      ByteBuffer byteBufferForExpectedBlock = ByteBuffer.allocate(expectedCompactSerializedSize);
+                      storedBlock.serializeCompactLegacy(byteBufferForExpectedBlock);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java

+                  private void arrangeRepositoryWithExpectedStoredBlock(StoredBlock expectedStoreBlock) {
+                      Sha256Hash expectedHash = expectedStoreBlock.getHeader().getHash();
+                      ByteBuffer byteBuffer = ByteBuffer.allocate(COMPACT_SERIALIZED_SIZE_LEGACY);
+                      expectedStoreBlock.serializeCompactLegacy(byteBuffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java

+                  private void arrangeRepositoryWithExpectedChainHead(StoredBlock expectedStoreBlock) {
+                      ByteBuffer byteBuffer = ByteBuffer.allocate(COMPACT_SERIALIZED_SIZE_LEGACY);
+                      expectedStoreBlock.serializeCompactLegacy(byteBuffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java

+                      // assert
+                      ByteBuffer byteBuffer = ByteBuffer.allocate(COMPACT_SERIALIZED_SIZE_LEGACY);
+                      expectedStoreBlock.serializeCompactLegacy(byteBuffer);

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

StoredBlock.serializeCompactLegacy

should be avoided because it has been deprecated.

nathanieliov changed the title ~~32 byte chainwork support integration~~ Add 32 byte chainwork support

nathanieliov added 7 commits

December 12, 2024 10:11


          Added RSKIP454 activation code

c29c954


          Added RSKIP438 to ActivationConfigsForTest

53e82c8


          - Add the use of serializeCompactV2

42beb6a

- Add the use of deserializeCompactV2


          Add tests validating 32 byte chainwork checkpoints can be processed o…

fc554ff

…nce RSKIP454 is activated


          - Reorganize tests

f74c132

- Put magical number into meaningful constant variable
- Put assertion blocks into methods with meaningful names


          Reorganize tests

f668fc7


          Bump version to 0.14.4-rsk-17-SNAPSHOT

b8aff0c

marcos-iov force-pushed the 32-byte-chainwork-support-integration branch from 85a9cba to b8aff0c Compare

December 12, 2024 13:11


          Rename constants in RepositoryBtcBlockStoreWithCacheChainWorkTest

ab2a578

github-advanced-security bot found potential problems

View reviewed changes

rskj-core/src/test/java/co/rsk/peg/RepositoryBtcBlockStoreWithCacheChainWorkTest.java

+                  // Just an arbitrary block
+                  private static final String BLOCK_HEADER = "00e00820925b77c9ff4d0036aa29f3238cde12e9af9d55c34ed30200000000000000000032a9fa3e12ef87a2327b55db6a16a1227bb381db8b269d90aa3a6e38cf39665f91b47766255d0317c1b1575f";
+                  private static final int BLOCK_HEIGHT = 849137;
+                  private static final BtcBlock BLOCK = new BtcBlock(mainneNetworkParameters, Hex.decode(BLOCK_HEADER));

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note test

Invoking

BtcBlock.BtcBlock

should be avoided because it has been deprecated.

sonarqubecloud bot commented Dec 12, 2024

Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

marcos-iov approved these changes

View reviewed changes

josedahlquist approved these changes

View reviewed changes

josedahlquist merged commit 1cf9ad6 into master

12 of 13 checks passed

marcos-iov deleted the 32-byte-chainwork-support-integration branch

December 12, 2024 15:21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet