feat(sdk): token config update transition #2554
Conversation
WalkthroughA new Rust module has been introduced to the SDK, providing a builder struct for constructing and signing token configuration update state transitions. The builder encapsulates all necessary parameters and offers optional methods for additional settings, such as public notes and user fee increases. The core functionality is delivered via an asynchronous sign method, which prepares and signs the state transition. Additionally, the new module has been made publicly available by updating the parent module's exports. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Builder as TokenConfigUpdateTransitionBuilder
participant SDK
participant Signer
Client->>Builder: Initialize with contract, position, owner, etc.
Client->>Builder: Optionally add public note, fee, settings
Client->>Builder: Call sign(sdk, identity_public_key, signer, platform_version)
Builder->>SDK: Retrieve identity contract nonce
Builder->>Signer: Sign transition data
Builder-->>Client: Return signed StateTransition or error
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (8)
🪧 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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/rs-sdk/src/platform/transition/fungible_tokens/config_update.rs (1)
37-37: Documentation parameter mismatch.The documentation mentions a
distribution_typeparameter which doesn't exist in the actual method signature. Please update the documentation to accurately reflect the parameters being used.- /// * `distribution_type` - The token distribution type + /// * `update_token_configuration_item` - The token configuration changes
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/rs-sdk/src/platform/transition/fungible_tokens/config_update.rs(1 hunks)packages/rs-sdk/src/platform/transition/fungible_tokens/mod.rs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (dash-sdk) / Linting
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
- GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
- GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
- GitHub Check: Build JS packages / Build JS
🔇 Additional comments (4)
packages/rs-sdk/src/platform/transition/fungible_tokens/mod.rs (1)
5-5: Module addition looks good.The
config_updatemodule has been properly added to the public exports in alphabetical order, making the new token configuration update functionality accessible to users of the SDK.packages/rs-sdk/src/platform/transition/fungible_tokens/config_update.rs (3)
49-50: TODO needs to be addressed.There's a TODO comment about validating the token position, but no implementation. Consider adding validation logic before releasing this feature.
Since testing for this feature is pending, as mentioned in the PR description, please make sure to implement this validation and add appropriate tests before finalizing the PR.
123-157: Implementation of sign method looks good.The sign method correctly:
- Calculates the token ID from the data contract ID and token position
- Retrieves the identity contract nonce asynchronously
- Creates a batch transition with all required parameters
- Returns the signed state transition
The error handling and optional parameter management is also implemented correctly.
18-158: Overall builder implementation is well-structured.The builder pattern is implemented cleanly with:
- A clear initialization method
- Optional chainable methods for additional configuration
- Proper documentation
- Appropriate use of Rust idioms for handling optional values
This structure is consistent with other transition builders in the codebase and provides a flexible, user-friendly API for token configuration updates.
Issue being fixed or feature implemented
Implemented the TokenConfigUpdateTransition in the sdk
What was done?
How Has This Been Tested?
Not yet
Breaking Changes
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit