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

feat(client): add WithFromName to tx factory #18852

Merged
merged 2 commits into from
Dec 21, 2023
Merged

feat(client): add WithFromName to tx factory #18852

merged 2 commits into from
Dec 21, 2023

Conversation

gsai967
Copy link
Contributor

@gsai967 gsai967 commented Dec 21, 2023

Description

Closes: #XXXX

In recent 0.47.7 version tx.Factory added new feild fromName , but it is only only set by NewFactoryCLI
we need to set fromName using withFromName() because we need use this to simulate the txn without using NewFactoryCLI

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@github-actions github-actions bot added the C:CLI label Dec 21, 2023
@gsai967 gsai967 marked this pull request as ready for review December 21, 2023 07:52
@gsai967 gsai967 requested a review from a team as a code owner December 21, 2023 07:52
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 21, 2023 •
edited
Loading

Walkthrough

The factory.go file has been updated to enhance the Factory struct with additional functionality. A new method for setting the fromName field has been introduced, and existing methods for setting the sequence and timeoutHeight have been retained or slightly modified. These changes allow for more flexible configuration of the Factory instance, particularly by enabling the setting of a fromName value.

Changes

File Path Change Summary
client/tx/factory.go Added FromName and WithFromName methods.
Modified WithSequence method to return an updated Factory.

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 X ?

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

julienrbrt
julienrbrt approved these changes Dec 21, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Makes sense, one nit

client/tx/factory.go
@@ -189,6 +190,12 @@ func (f Factory) WithKeybase(keybase keyring.Keyring) Factory {
return f
}

// WithFromName returns a copy of the Factory with updated fromName
Copy link
Member

Choose a reason for hiding this comment

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

Can get this more descriptive and explain that it should most likely be clientCtx.FromName?

@julienrbrt julienrbrt added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Dec 21, 2023
@julienrbrt julienrbrt changed the title chore: adding withFromName to tx factory feat(client): add WithFromName to tx factory Dec 21, 2023
@julienrbrt
Copy link
Member

Can we add a changelog under Improvements as well?

coderabbitai[bot]
coderabbitai bot reviewed Dec 21, 2023
View reviewed changes
client/tx/factory.go
Comment on lines +193 to +194
// WithFromName returns a copy of the Factory with updated fromName
// fromName will be use for building a simulation tx.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider enhancing the comment for the WithFromName method to explain its use case more clearly, such as indicating that it is used for building simulation transactions, potentially with the clientCtx.FromName as the source of the name.

likhita-809
likhita-809 approved these changes Dec 21, 2023
View reviewed changes
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

lgtm

@atheeshp atheeshp added this pull request to the merge queue Dec 21, 2023
Merged via the queue into cosmos:main with commit 64dbee6 Dec 21, 2023
54 of 56 checks passed
mergify bot pushed a commit that referenced this pull request Dec 21, 2023
@gsai967 @mergify
feat(client): add WithFromName to tx factory (#18852)
1df733a 
(cherry picked from commit 64dbee6)

# Conflicts:
#	CHANGELOG.md
mergify bot pushed a commit that referenced this pull request Dec 21, 2023
@gsai967 @mergify
feat(client): add WithFromName to tx factory (#18852)
85eb15a 
(cherry picked from commit 64dbee6)

# Conflicts:
#	CHANGELOG.md
This was referenced Dec 21, 2023
Merged
Merged
atheeshp pushed a commit that referenced this pull request Dec 21, 2023
@mergify @gsai967 @julienrbrt
feat(client): add WithFromName to tx factory (backport #18852) (#18853
0930b39 
)

Co-authored-by: gsai967 <153279976+gsai967@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
atheeshp pushed a commit that referenced this pull request Dec 21, 2023
@mergify @gsai967 @julienrbrt
feat(client): add WithFromName to tx factory (backport #18852) (#18854
b912ccf 
)

Co-authored-by: gsai967 <153279976+gsai967@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
MSalopek pushed a commit to informalsystems/cosmos-sdk that referenced this pull request Feb 27, 2024
@mergify @gsai967
@julienrbrt @MSalopek
feat(client): add WithFromName to tx factory (backport cosmos#18852) (
358c86f 
cosmos#18854)

Co-authored-by: gsai967 <153279976+gsai967@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@faddat faddat mentioned this pull request Mar 20, 2024
Open
12 tasks
emidev98 pushed a commit to terra-money/cosmos-sdk that referenced this pull request Mar 21, 2024
@mergify @gsai967
@julienrbrt @emidev98
feat(client): add WithFromName to tx factory (backport cosmos#18852) (
3f1b1b3 
cosmos#18854)

Co-authored-by: gsai967 <153279976+gsai967@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@0xstepit 0xstepit mentioned this pull request Jul 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

@likhita-809 likhita-809 likhita-809 approved these changes

Assignees
No one assigned
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:CLI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gsai967 @julienrbrt @likhita-809 @atheeshp