feat: add ledger signing to smart account module #8581

PaddyMc · 2024-08-02T14:53:17Z

What is the purpose of the change

The smart account AddAuthenticator and RemoveAuthenticator messages were missing the correct functions to satisfy the legacy message interface, thus ledger signing couldn't be used.

Also some weirdness around having a Type for the message and also needed to define a Type() function so I need to change that.

Sister PR here => osmosis-labs/osmosis-frontend#3656

Testing and Verifying

cd x/smart-account
go test ./...

coderabbitai · 2024-08-02T17:07:16Z

Walkthrough

The recent update enhances the smart account module by incorporating ledger signing functionality, thereby improving secure transaction capabilities. Additionally, the update restructures and renames message types for better clarity and maintainability. These changes collectively enhance the security and usability of smart accounts on the Osmosis platform, aligning with ongoing efforts to improve overall user experience.

Changes

File(s)	Change Summary
`CHANGELOG.md`	Added entry for ledger signing functionality in the smart account module.
`proto/osmosis/smartaccount/v1beta1/tx.proto`	Updated message names for clarity in `MsgAddAuthenticator`, `MsgRemoveAuthenticator`, and `MsgSetActiveState`. Renamed `type` to `authenticator_type` in `MsgAddAuthenticator`.
`x/smart-account/client/cli/tx.go`	Renamed field `Type` to `AuthenticatorType` in `MsgAddAuthenticator` structure for improved clarity.
`x/smart-account/keeper/msg_server.go`	Updated method to reference `AuthenticatorType` instead of `Type` for consistency in the `AddAuthenticator` method.
`x/smart-account/keeper/msg_server_test.go`	Updated test cases to reflect the renaming of `Type` to `AuthenticatorType` in various methods within the test suite.
`x/smart-account/types/msgs.go`	Introduced constants for message types and added methods for `MsgAddAuthenticator` and `MsgRemoveAuthenticator` for improved functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SmartAccount
    participant Ledger
    participant Keeper

    User->>SmartAccount: Request to add authenticator
    SmartAccount->>Keeper: AddAuthenticator(AuthType)
    Keeper-->>SmartAccount: Confirmation
    SmartAccount->>Ledger: Sign transaction
    Ledger-->>SmartAccount: Signed transaction
    SmartAccount->>User: Confirmation

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 57dae24 and 481480a.

Files selected for processing (1)

CHANGELOG.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

CHANGELOG.md

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

czarcas7ic · 2024-08-02T22:55:43Z

proto/osmosis/smartaccount/v1beta1/tx.proto

@@ -34,7 +34,7 @@ message MsgAddAuthenticatorResponse { bool success = 1; }
 // MsgRemoveAuthenticatorRequest defines the Msg/RemoveAuthenticator request
 // type.
 message MsgRemoveAuthenticator {
-  option (amino.name) = "osmosis/MsgRemoveAuthenticator";
+  option (amino.name) = "osmosis/smartaccount/remove-authenticator";


did we verify name length on this? sometimes ledger can only handle certain lengths

I signed with a ledger to make sure this works as well => https://osmosis-network.slack.com/archives/C027ELA290B/p1722618905776139?thread_ts=1722618892.008519&cid=C027ELA290B

czarcas7ic

High level ACK, we of course should test on v26 testnet prior to gov prop. Very excited for this!

ValarDragon

Nice

ValarDragon · 2024-08-04T09:49:30Z

Lets test that the character count for each of these names is sub-40 chars (IIRC thats the limit)

PaddyMc · 2024-08-04T17:09:32Z

Lets test that the character count for each of these names is sub-40 chars (IIRC thats the limit)

I signed with a ledger to make sure this works as well => https://osmosis-network.slack.com/archives/C027ELA290B/p1722618905776139?thread_ts=1722618892.008519&cid=C027ELA290B

feat: add ledger signing to smart account module

1b9e295

github-actions bot added the C:CLI label Aug 2, 2024

PaddyMc added the V:state/breaking State machine breaking PR label Aug 2, 2024

chore: add changelog

57dae24

PaddyMc marked this pull request as ready for review August 2, 2024 17:07

PaddyMc mentioned this pull request Aug 2, 2024

feat: adding ledger support to 1CT osmosis-labs/osmosis-frontend#3656

Closed

czarcas7ic reviewed Aug 2, 2024

View reviewed changes

czarcas7ic approved these changes Aug 2, 2024

View reviewed changes

ValarDragon approved these changes Aug 4, 2024

View reviewed changes

PaddyMc closed this Aug 4, 2024

PaddyMc reopened this Aug 4, 2024

Merge branch 'main' into feat/add-ledger-support-sa

481480a

PaddyMc merged commit 5cab5a9 into main Aug 5, 2024
1 check passed

PaddyMc deleted the feat/add-ledger-support-sa branch August 5, 2024 07:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add ledger signing to smart account module #8581

feat: add ledger signing to smart account module #8581

PaddyMc commented Aug 2, 2024 •

edited

Loading

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

czarcas7ic Aug 2, 2024

PaddyMc Aug 4, 2024

PaddyMc Aug 4, 2024

czarcas7ic left a comment

ValarDragon left a comment

ValarDragon commented Aug 4, 2024

PaddyMc commented Aug 4, 2024 •

edited

Loading

feat: add ledger signing to smart account module #8581

feat: add ledger signing to smart account module #8581

Conversation

PaddyMc commented Aug 2, 2024 • edited Loading

What is the purpose of the change

Testing and Verifying

coderabbitai bot commented Aug 2, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

czarcas7ic Aug 2, 2024

Choose a reason for hiding this comment

PaddyMc Aug 4, 2024

Choose a reason for hiding this comment

PaddyMc Aug 4, 2024

Choose a reason for hiding this comment

czarcas7ic left a comment

Choose a reason for hiding this comment

ValarDragon left a comment

Choose a reason for hiding this comment

ValarDragon commented Aug 4, 2024

PaddyMc commented Aug 4, 2024 • edited Loading

PaddyMc commented Aug 2, 2024 •

edited

Loading

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

PaddyMc commented Aug 4, 2024 •

edited

Loading