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.

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

STR-950 envelope changes #590

Merged
merged 19 commits into from
Jan 29, 2025
Merged

STR-950 envelope changes #590

merged 19 commits into from
Jan 29, 2025

Conversation

bewakes
Copy link
Contributor

@bewakes bewakes commented Jan 6, 2025

This PR primarily introduces the following changes:

  1. Changes the OP_IF..OP_ENDIF envelope structure. It still retains version and size of the payload.
  2. Support of multiple L1 payloads bundled as envelopes in a single reveal transaction.
  3. Corresponding db changes. Previously, it had 1-1 mapping between payload intent and L1 transaction, now it is many-to-one.
  4. Add a bundler task in btcio such that creates BundledPayloadEntry and stores in db, which is ultimately published to bitcoin. Currently, it just does 1-1 mapping like it was before, but the bundling logic can be advanced in future.
  5. Renames sequencer db to writer db, because actually it contains data related to payloads and bundles.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor
  • New or updated tests
  • Dependency Update

Notes to Reviewers

Checklist

  • I have performed a self-review of my code.
  • I have commented my code where necessary.
  • I have updated the documentation if needed.
  • My changes do not introduce new warnings.
  • I have added tests that prove my changes are effective or that my feature works.
  • New and existing tests pass with my changes.

Related Issues

@bewakes bewakes force-pushed the STR-807-inscription-changes branch 3 times, most recently from b5e3480 to 286799a Compare January 7, 2025 12:15
@john-light john-light changed the title Str 807 inscription changes STR-881 inscription changes Jan 8, 2025
@bewakes bewakes force-pushed the STR-807-inscription-changes branch from 286799a to 9e770e7 Compare January 9, 2025 11:38
@bewakes bewakes changed the base branch from main to refactor/btcio-config January 9, 2025 11:39
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Commit: c83493b

SP1 Performance Test Results

program cycles success
BTC_BLOCKSPACE 30,357,459
EL_BLOCK 98,534
CL_BLOCK 57,370
L1_BATCH 30,387,400
L2_BATCH 5,473
CHECKPOINT 15,895

@bewakes bewakes force-pushed the refactor/btcio-config branch 5 times, most recently from 54e228e to 7584ba8 Compare January 13, 2025 08:49
@bewakes bewakes force-pushed the STR-807-inscription-changes branch from 9e770e7 to 16a2890 Compare January 13, 2025 12:23
@bewakes bewakes force-pushed the refactor/btcio-config branch 2 times, most recently from 07fc70b to cc85da7 Compare January 14, 2025 09:29
@bewakes bewakes force-pushed the STR-807-inscription-changes branch from 16a2890 to 0528eff Compare January 14, 2025 11:18
@bewakes bewakes force-pushed the refactor/btcio-config branch from cc85da7 to 2eda45d Compare January 15, 2025 08:34
Base automatically changed from refactor/btcio-config to main January 15, 2025 09:31
@bewakes bewakes force-pushed the STR-807-inscription-changes branch from 0528eff to 727ef1a Compare January 15, 2025 10:58
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

Attention: Patch coverage is 63.07054% with 178 lines in your changes missing coverage. Please review.

Project coverage is 55.73%. Comparing base (0db65b9) to head (d7dc0a9).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
crates/btcio/src/writer/bundler.rs 0.00% 63 Missing ⚠️
crates/btcio/src/writer/task.rs 30.68% 61 Missing ⚠️
crates/rocksdb-store/src/writer/db.rs 87.05% 18 Missing ⚠️
crates/db/src/types.rs 22.72% 17 Missing ⚠️
bin/strata-client/src/main.rs 0.00% 5 Missing ⚠️
crates/l1tx/src/filter.rs 95.52% 3 Missing ⚠️
crates/l1tx/src/utils.rs 40.00% 3 Missing ⚠️
crates/rocksdb-store/src/lib.rs 0.00% 3 Missing ⚠️
crates/btcio/src/reader/query.rs 0.00% 2 Missing ⚠️
crates/l1tx/src/envelope/parser.rs 95.65% 2 Missing ⚠️
... and 1 more
@@            Coverage Diff             @@
##             main     #590      +/-   ##
==========================================
- Coverage   55.97%   55.73%   -0.25%     
==========================================
  Files         315      315              
  Lines       33428    33496      +68     
==========================================
- Hits        18712    18668      -44     
- Misses      14716    14828     +112     
Files with missing lines Coverage Δ
crates/btcio/src/test_utils.rs 56.09% <100.00%> (-0.18%) ⬇️
crates/btcio/src/writer/builder.rs 98.03% <100.00%> (-0.01%) ⬇️
crates/btcio/src/writer/signer.rs 100.00% <100.00%> (ø)
crates/btcio/src/writer/test_utils.rs 100.00% <100.00%> (ø)
crates/config/src/btcio.rs 100.00% <100.00%> (ø)
crates/config/src/config.rs 95.74% <100.00%> (+0.09%) ⬆️
crates/db/src/traits.rs 0.00% <ø> (ø)
crates/l1tx/src/envelope/builder.rs 100.00% <100.00%> (+20.00%) ⬆️
crates/primitives/src/l1/payload.rs 24.65% <ø> (+8.21%) ⬆️
crates/proof-impl/btc-blockspace/src/filter.rs 50.00% <100.00%> (ø)
... and 11 more

... and 5 files with indirect coverage changes

@bewakes bewakes force-pushed the STR-807-inscription-changes branch 2 times, most recently from 1fbb9a5 to 037c18f Compare January 17, 2025 13:06
@bewakes bewakes marked this pull request as ready for review January 17, 2025 13:11
@bewakes bewakes requested review from a team as code owners January 17, 2025 13:11
@bewakes bewakes force-pushed the STR-807-inscription-changes branch from 3eb992c to d7dc0a9 Compare January 24, 2025 05:53
@bewakes
Copy link
Contributor Author

bewakes commented Jan 24, 2025

@delbonis, As discussed in Core sync meeting, I've removed the version from envelope. This should be good to merge now.

@bewakes bewakes requested a review from delbonis January 27, 2025 06:19
Copy link
Contributor

@delbonis delbonis left a comment

Choose a reason for hiding this comment

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

This is good for now.

Copy link
Member

@storopoli storopoli left a comment

Choose a reason for hiding this comment

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

ACK d7dc0a9

@prajwolrg prajwolrg added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit 825c796 Jan 29, 2025
20 checks passed
@prajwolrg prajwolrg deleted the STR-807-inscription-changes branch January 29, 2025 05:44
@bewakes bewakes restored the STR-807-inscription-changes branch January 29, 2025 06:31
@bewakes bewakes deleted the STR-807-inscription-changes branch January 29, 2025 06:32
@bewakes bewakes restored the STR-807-inscription-changes branch January 29, 2025 06:32
@bewakes bewakes deleted the STR-807-inscription-changes branch January 29, 2025 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants