Add some docs to the payment module #187
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evan-forbes
commented
Jan 19, 2022
x/payment/types/builder.go
Outdated
| func (k *KeyringSigner) BuildSignedTx(builder sdkclient.TxBuilder, msg sdktypes.Msg) (authsigning.Tx, error) { | ||
| func (k *KeyringSigner) BuildSignedTx(msg sdktypes.Msg, options ...TxBuilderOption) (authsigning.Tx, error) { |
There was a problem hiding this comment.
this slight refactor isn't really inside the scope of this PR, I decided to include it anyway, as it is very minor.
There was a problem hiding this comment.
can we pull this out or can we add this into the pr description. In the future if we need to reference this PR for this code it could get confusing.
There was a problem hiding this comment.
pulled this out, and will add it in a different PR
rach-id
reviewed
Jan 19, 2022
adlerjohn
reviewed
Jan 19, 2022
Co-authored-by: John Adler <[email protected]>
Co-authored-by: John Adler <[email protected]>
Co-authored-by: John Adler <[email protected]>
Co-authored-by: John Adler <[email protected]>
adlerjohn
reviewed
Jan 20, 2022
Co-authored-by: John Adler <[email protected]>
tac0turtle
reviewed
Jan 20, 2022
x/payment/spec/docs.md
Outdated
| There are tools to programmatically create, sign, and broadcast `MsgWirePayForMessages` | ||
| ```go | ||
| // use a keyring to sign messages programmatically | ||
| keyringSigner, err := NewKeyringSigner(keyring, "keyring account name", "chain-id-1") |
There was a problem hiding this comment.
Im guessing this is the keyringsinger of this module and not the general sdk. Would be good to mention as this is the most confusing part.
May be good to open a issue on how to delete this code too.
adlerjohn
approved these changes
Jan 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
adds some better docs to the payment module
closes: #178
rendered