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.

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

adding ability to select notes in the transaction send command #4465

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

patnir
Copy link
Contributor

@patnir patnir commented Nov 29, 2023

Summary

Add ability to send notes in the transaction command.

After a lot of back and forth with these PRs (#4464 and #4459), I decided it was best to at least get this out there for our users and work on more UX improvements including warnings for larger transactions in subsequent PRs.

Testing Plan

Manual testing.

Documentation

Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference
)? If yes, link a
related documentation pull request for the website.

[ ] Yes

Breaking Change

Is this a breaking change? If yes, add notes below on why this is breaking and
what additional work is required, if any.

[ ] Yes

@patnir patnir requested a review from a team as a code owner November 29, 2023 21:31
@@ -90,6 +90,11 @@ export class Send extends IronfishCommand {
default: false,
description: 'Allow offline transaction creation',
}),
notes: Flags.string({
Copy link
Contributor

@NullSoldier NullSoldier Nov 29, 2023

Choose a reason for hiding this comment

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

If you are using the multiple flag, this should be note

This is what it is now

ironfish wallet:send \
    --notes 72e91d6672d79f9006f128a16cf52bbb585037fee2aea8385b56919c3ac9570b \
    --notes 4a5feb193d425fa73abfb108027a643eb027e46684c50e2bef5d66ea48ec3d2d \
    --notes f8b91f81caf4489c83734c2b29ad4587c9ba0c1080854a3f6da19f6fad49265e

this is what it should be

ironfish wallet:send \
    --note 72e91d6672d79f9006f128a16cf52bbb585037fee2aea8385b56919c3ac9570b \
    --note 4a5feb193d425fa73abfb108027a643eb027e46684c50e2bef5d66ea48ec3d2d \
    --note f8b91f81caf4489c83734c2b29ad4587c9ba0c1080854a3f6da19f6fad49265e

Copy link
Contributor Author

@patnir patnir Nov 29, 2023

Choose a reason for hiding this comment

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

I slightly prefer --notes because you can also do

--notes 72e91d6672d79f9006f128a16cf52bbb585037fee2aea8385b56919c3ac9570b 4a5feb193d425fa73abfb108027a643eb027e46684c50e2bef5d66ea48ec3d2d f8b91f81caf4489c83734c2b29ad4587c9ba0c1080854a3f6da19f6fad49265e

I don't feel strongly so I can change it to --note

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I looked at the docs and I think it seems singular naming conventions are standard, so I'll change it to --note

@@ -90,6 +90,11 @@ export class Send extends IronfishCommand {
default: false,
description: 'Allow offline transaction creation',
}),
notes: Flags.string({
char: 'n',
description: 'The notes to include in the transaction',
Copy link
Contributor

Choose a reason for hiding this comment

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

nit - maybe something like note hashes to include? just to be a little more explicit about what needs to be passed here

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah note hashes would be more explicit

@patnir patnir requested a review from hughy November 29, 2023 22:22
@patnir patnir merged commit 4fd517b into staging Nov 29, 2023
10 checks passed
@patnir patnir deleted the rahul/ifl-1845-add-n-notes-flag-to-send-transaction branch November 29, 2023 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants