merge release/v2.1.x #2886
merge release/v2.1.x #2886
Conversation
bump-up dependency and update changelog
WalkthroughThe project has undergone significant updates, including the addition of NFT-related APIs, interchain NFT transfer capabilities, and a consensus module. There's been a shift to modern import syntax in the documentation, enhanced command-line functionality with new parameters, and a move from IP addresses to domain names in configurations. No security changes were noted, but the updates suggest a focus on expanding functionality and improving user experience. Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (2)
- go.mod
- go.sum
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional comments: 2
CHANGELOG.md (2)
3-44: The
CHANGELOG.mdfile reflects substantial updates to the software, including API changes, state machine updates, new features like interchain NFT transfer, module updates, migrations, bug fixes, and security improvements. These changes align with the summary provided, indicating a major version update with significant enhancements and breaking changes.44-44: The summary mentions security-related changes, but there is no
### Securitysection or related content in the provided hunk ofCHANGELOG.md. This could be an oversight or an inconsistency between the summary and the actual changes.
* chore: fix doc * chore: fix doc * update docs to append mandatory cmd options (#2862) * Update nft.md * Update distribution.md * Update mt.md * Update service.md * Update state-sync.md (#2861) replace IP with domain name, sentry-0.mainnet.irisnet.org and sentry-1.mainnet.irisnet.org Co-authored-by: Dreamer <[email protected]> * fix dependabot alerts * update package-lock.json --------- Co-authored-by: aofengli <[email protected]> Co-authored-by: XB <[email protected]> Co-authored-by: Dreamer <[email protected]> Co-authored-by: jinbiao-bianjie <[email protected]>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to filter (2)
- docs/package-lock.json
- docs/package.json
Files selected for processing (8)
- docs/.vuepress/client.js (1 hunks)
- docs/.vuepress/config.js (4 hunks)
- docs/features/distribution.md (1 hunks)
- docs/features/mint.md (1 hunks)
- docs/features/mt.md (7 hunks)
- docs/features/nft.md (3 hunks)
- docs/features/service.md (6 hunks)
- docs/get-started/state-sync.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/get-started/state-sync.md
Additional comments: 26
docs/.vuepress/client.js (1)
- 1-1: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-5]
The code provided in the hunk appears to be a standard VuePress client configuration setup. There are no visible issues with the syntax or structure of the code. However, the
enhancefunction is empty, which might be intentional if there are no client-side enhancements needed, or it might be an oversight if enhancements were meant to be included.docs/.vuepress/config.js (5)
1-5: The updated import syntax from
requiretoimportis modern JavaScript practice and aligns with ES6 modules.20-46: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [7-28]
The
sidebarfunction now includes acollapsibleproperty, which is a useful feature for improving the navigation experience in the documentation.
32-33: The export syntax has been updated to use ES6 modules, which is a modern and cleaner approach compared to
module.exports.52-64: The theme configuration has been updated to reflect the new documentation structure and provide better support for community contributions.
74-80: The sidebar configuration has been updated to include new sections, which should make the documentation more organized and easier to navigate.
docs/features/distribution.md (1)
- 31-35: The documentation has been updated to reflect the new flags (
--from,--chain-id,--fees) for theiris tx distribution set-withdraw-addrcommand. Ensure that the documentation elsewhere and any scripts or automation that use this command are also updated to include these new flags.docs/features/mint.md (2)
31-32: The example provided is clear and helps users understand the practical application of the inflation calculation formula.
34-34: The documentation on the impact to users and how to query the total loose tokens amount remains informative and relevant.
docs/features/mt.md (7)
26-30: The addition of
--chain-idand--feesparameters to theissuecommand aligns with the PR objectives and summary provided. This change likely enhances transaction processing by allowing users to specify the chain ID and fees.39-39: The addition of
--chain-idand--feesparameters to themintcommand is consistent with the PR objectives and summary. This ensures that users can specify the chain ID and fees for minting transactions.49-49: The
mintcommand for increasing issuance also includes the new--chain-idand--feesparameters, which is in line with the PR objectives and summary. This maintains consistency across CLI commands.59-59: The
editcommand has been updated with--chain-idand--feesparameters, which is consistent with the PR objectives and summary. This change allows users to specify the chain ID and fees when editing asset metadata.70-70: The
transfercommand now includes--chain-idand--feesparameters, aligning with the PR objectives and summary. This update allows users to specify the chain ID and fees for asset transfer transactions.80-80: The
burncommand has been updated to include--chain-idand--feesparameters, which is consistent with the PR objectives and summary. This allows users to specify the chain ID and fees for burning assets.140-140: No changes are observed in the
tokensquery command, which is consistent with the PR objectives and summary that only mentioned updates to CLI commands related to asset management and not querying.docs/features/nft.md (3)
44-44: The addition of
--from,--chain-id, and--feesparameters to theissuecommand aligns with the PR objectives and summary, ensuring that users can specify the issuer, target chain, and transaction fees.54-54: The addition of
--from,--chain-id, and--feesparameters to thetransfer-denomcommand is consistent with the PR objectives and summary, allowing users to specify the sender, target chain, and transaction fees for transferring NFT classifications.84-84: The addition of
--from,--chain-id, and--feesparameters to thetransfercommand is consistent with the PR objectives and summary, allowing users to specify the sender, target chain, and transaction fees for transferring specific NFTs.docs/features/service.md (7)
58-62: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to theiris tx service definecommand aligns with the summary provided. This change will require users to specify the key name and chain ID when creating a new service definition, which is a significant change to the command's usage.115-133: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to various service binding commands is consistent with the summary. These changes will affect how users interact with the CLI to manage service bindings, making it necessary to specify the key name and chain ID for transactions.184-199: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to the service invocation commands is consistent with the summary. This change will affect how users create and manage request contexts, requiring them to specify the key name and chain ID for transactions.240-240: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to theiris tx service respondcommand is consistent with the summary. This change will affect how service providers respond to requests, requiring them to specify the key name and chain ID for transactions.264-267: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to theiris tx service set-withdraw-addrcommand is consistent with the summary. This change will affect how users set their withdrawal address, requiring them to specify the key name and chain ID for transactions.273-277: The addition of
--from=<key-name>and--chain-id=<chain-id>flags to theiris tx service withdraw-feescommand is consistent with the summary. This change will affect how users withdraw earned fees, requiring them to specify the key name and chain ID for transactions.112-133: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [58-277]
The summaries mention command renamings such as
update-bindingreplacingupdateandservice bindingsreplacingbindings, but these changes are not reflected in the provided hunks. It's important to ensure that these renamings are consistently applied throughout the documentation if they have indeed been made.
Verification result:
The documentation has been updated to reflect the renaming of commands, with
update-bindingandservice bindingsnow consistently used in the provided sections of the service documentation.
| blockInflationAmount = AnnualInflationAmount * blockCostTime / (year) | ||
| ``` | ||
|
|
||
| The value of `inflationBasement` is specified in genesis file. By default its value `2000000000iris`(2 billion iris, `1 iris` equals `1*10^18 uiris`), and its value will never be changed. | ||
| Suppose `blockCostTime` is 5000 millisecond, and `inflationRate` is `4%`, then the inflation amount will be `12675235125611580094uiris` (`12.675235125611580094iris`) | ||
| The value of `inflationBasement` is specified in genesis file. By default its value `2000000000iris`(2 billion iris, `1 iris` equals `1*10^6 uiris`), and its value will never be changed. | ||
| Suppose `blockCostTime` is 5000 millisecond, and `inflationRate` is `4%`, then the inflation amount will be `12683917uiris` (`12.683917iris`) |
There was a problem hiding this comment.
The documentation update provides clarity on how the blockInflationAmount is calculated, which is beneficial for understanding the inflation mechanism. However, it would be helpful to include a brief explanation of the blockCostTime variable, as it is a key component in the calculation. This would improve the documentation's comprehensiveness and help readers understand all parts of the equation.
Summary by CodeRabbit
New Features
Improvements
Bug Fixes
Documentation
Refactor