Feat/sync dev with v1.8.0 #359
Conversation
WalkthroughThe pull request introduces updates for version 1.8.0 of the SDK, primarily altering the market initialization process in the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
pyproject.toml (1)
Line range hint
19-22: Remove INI files from package includesThe AI summary indicates that INI-based initializations have been deprecated and removed, but the package still includes "*.ini" files. This could lead to confusion and packaging of non-existent files.
Apply this diff to remove the INI files inclusion:
include = [ { path = "pyinjective/proto/**/*.py" }, - { path = "*.ini" }, ]CHANGELOG.md (1)
Line range hint
5-11: Consider marking breaking changes and adding migration guide.The changes in v1.8.0 appear to be breaking changes that could affect SDK users:
- Market initialization now uses chain endpoints instead of Indexer endpoints
- Removal of legacy INI files for market/token initialization
Consider:
- Adding a "BREAKING CHANGES" section to clearly highlight these changes
- Including a migration guide to help users transition from INI files to the new chain-based initialization
Example format:
## [1.8.0] - 2024-11-14 +### BREAKING CHANGES +- Market initialization in AsyncClient now uses chain endpoints instead of Indexer endpoints +- Removed legacy INI files for market/token initialization. See migration guide below. + +### Migration Guide +If you were using INI files for market/token initialization: +1. Update to use chain-based initialization: <example code> +2. Remove references to INI files: <steps> + ### Changed - The markets initialization in AsyncClient has been modified to get markets information from the chain endpoints instead of the Indexer endpoints ### Removed - Removed the legacy deprecated markets and tokens initialization using the denoms INI files in the SDK. Removed also the INI files from the SDK
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| All notable changes to this project will be documented in this file. | |||
|
|
|||
| ## [1.8.0] - 9999-99-99 | |||
| ## [1.8.0] - 2024-11-14 | |||
There was a problem hiding this comment.
💡 Codebase verification
Version numbers are inconsistent between files
The version numbers don't match across the codebase:
pyproject.toml: version = "1.9.0-pre"CHANGELOG.md: [1.8.0]
Please ensure version numbers are aligned:
- Either update CHANGELOG.md to reflect the pre-release version 1.9.0-pre
- Or update pyproject.toml to match the release version 1.8.0
🔗 Analysis chain
Version number inconsistency detected.
The changelog shows version 1.8.0, but according to the AI summary, pyproject.toml has been updated to version 1.9.0-pre. This inconsistency could cause confusion about which version is being released.
Please verify and align the version numbers across:
- CHANGELOG.md
- pyproject.toml
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check version numbers across files
echo "Version in pyproject.toml:"
cat pyproject.toml | grep -A1 '\[tool\.poetry\]' | grep version
echo -e "\nVersion in CHANGELOG.md:"
head -n 10 CHANGELOG.md | grep '\[.*\]'
Length of output: 259
Script:
#!/bin/bash
# Let's try a different approach to find the version in pyproject.toml
# Using rg for better pattern matching
rg "version\s*=\s*['\"].*['\"]" pyproject.toml
# Also check setup.py and setup.cfg if they exist
fd "setup\.(py|cfg)$" -x rg "version\s*=\s*['\"].*['\"]" {}
Length of output: 142
PR to sync the
devbranch with the changes introduced inmasterfor the v1.8.0 releaseSummary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores