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

Jump to bottom

Improve DevnetClient docs #1415

Merged
merged 8 commits into from
Aug 8, 2024
Merged

Improve DevnetClient docs #1415

merged 8 commits into from
Aug 8, 2024

Conversation

kkawula
Copy link
Collaborator

@kkawula kkawula commented Aug 1, 2024 •
edited
Loading

Closes #1413

Introduced changes

  • Added guide for integration with L1

  • This PR contains breaking changes

@kkawula kkawula requested a review from ddoktorski August 1, 2024 14:40
@kkawula kkawula self-assigned this Aug 1, 2024
@kkawula kkawula marked this pull request as draft August 1, 2024 14:40
@kkawula kkawula marked this pull request as ready for review August 2, 2024 10:12
ddoktorski
ddoktorski requested changes Aug 2, 2024
View reviewed changes
Copy link
Collaborator

@ddoktorski ddoktorski left a comment

Choose a reason for hiding this comment

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

A few suggestions, but overall looks good 💪

docs/devnet_utils/mocking_interaction_with_l1.rst Outdated Show resolved Hide resolved
starknet_py/tests/e2e/mock/contracts_v2/src/l1_l2.cairo Outdated Show resolved Hide resolved
starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py Outdated Show resolved Hide resolved
starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py Outdated Show resolved Hide resolved
docs/devnet_utils/mocking_interaction_with_l1.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@kkawula kkawula requested a review from ddoktorski August 2, 2024 18:53
@codecov Codecov
Copy link

codecov bot commented Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.75%. Comparing base (345b0ba) to head (72df269).
Report is 25 commits behind head on development.

Additional details and impacted files 
@@               Coverage Diff               @@
##           development    #1415      +/-   ##
===============================================
- Coverage        96.97%   94.75%   -2.23%     
===============================================
  Files               93      105      +12     
  Lines             4766     5430     +664     
===============================================
+ Hits              4622     5145     +523     
- Misses             144      285     +141

see 14 files with indirect coverage changes

ddoktorski
ddoktorski approved these changes Aug 5, 2024
View reviewed changes
Copy link
Collaborator

@ddoktorski ddoktorski left a comment

Choose a reason for hiding this comment

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

LGTM

starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py Outdated Show resolved Hide resolved
starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py Outdated Show resolved Hide resolved
starknet_py/tests/e2e/docs/devnet_utils/test_l1_integration.py Outdated Show resolved Hide resolved
@kkawula kkawula merged commit 31347a2 into development Aug 8, 2024
16 checks passed
@kkawula kkawula deleted the kkawula/1413-devnet-docs branch August 26, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ddoktorski ddoktorski ddoktorski approved these changes

Assignees

@kkawula kkawula

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add examples in DevnetClient docs
2 participants
@kkawula @ddoktorski