goal: Add asset optin command #3881
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
Goal should now give a more helpful error message when the user needs to opt in to using an ASA (by sending a 0 unit txn to themselves).
When a user wants to opt an account into using an ASA, they can now use this goal utility command to construct a 0 unit transaction from and to a given account in order to activate that asset for use.
|
|
shiqizng
reviewed
Apr 13, 2022
cmd/goal/asset.go
Outdated
| var optinAssetCmd = &cobra.Command{ | ||
| Use: "optin", | ||
| Short: "Optin to assets", | ||
| Long: "Opt an acocunt in to asset use. An account will begin accepting an asset by issuing a zero-amount asset transfer to itself.", |
There was a problem hiding this comment.
nit: maybe change Opt an acocunt in to asset use to Opt in to receive new assets?
There was a problem hiding this comment.
Updated to Opt in to receive a new asset.
libgoal/transactions.go
Outdated
| // | ||
| // Call FillUnsignedTxTemplate afterwards to fill out common fields in | ||
| // the resulting transaction template. | ||
| func (c *Client) MakeUnsignedAssetOptinTx(index uint64, account string) (transactions.Transaction, error) { |
There was a problem hiding this comment.
nit: you could also call MakeUnsignedAssetSendTx with correct parameters for opt in to reduce repeated code.
There was a problem hiding this comment.
Yeah I've updated to do this. Originally I was having some issues using this because I wasn't providing the correct empty argument for clawback address which was causing failures.
winder
reviewed
Apr 13, 2022
There was a problem hiding this comment.
Looks great. Here are some other tests that would be good to update (some of these, like the ones with -c, aren't optins):
$ rg "asset send.*-a 0"
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB -c $ACCOUNT
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB -c $ACCOUNT
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB -c $ACCOUNT
create_destroy_optin_optout.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB
asset-misc.sh:${gcmd} asset send --assetid ${ASSET_ID} -f ${ACCOUNTB} -t ${ACCOUNTB} -a 0
asset-misc.sh:${gcmd} asset send --assetid ${ASSET_ID} -f ${ACCOUNTC} -t ${ACCOUNTC} -a 0
asset-misc.sh:${gcmd} asset send --assetid ${ASSET_ID} -f ${ACCOUNTD} -t ${ACCOUNTD} -a 0
limit-swap-test.sh:${gcmd} asset send -o ${TEMPDIR}/b-asset-init.tx -a 0 --assetid ${ASSET_ID} -t $ACCOUNT_ASSET_TRADER -f $ACCOUNT_ASSET_TRADER --validrounds $((${SETUP_ROUND} - ${ROUND} - 1))
limit-swap-test.sh:${gcmd} asset send --assetid ${ASSET_ID} -t ${ZERO_ADDRESS} -a 0 -c ${ACCOUNT} -f ${ACCOUNT_ASSET_TRADER} -o ${TEMPDIR}/bclose.tx
limit-swap-test.sh:${gcmd} asset send -o ${TEMPDIR}/b-asset-init.tx -a 0 --assetid ${ASSET_ID} -t $ACCOUNT_ASSET_TRADER -f $ACCOUNT_ASSET_TRADER --validrounds $((${SETUP_ROUND} - ${ROUND} - 1))
dex.sh:${gcmd} asset send -a 0 -f "${ACCT_ACTOR}" -t "${ACCT_ACTOR}" --creator "${ACCT_CREATOR}" --assetid "${ASSETID}"
e2e-app-real-assets-round.sh:${gcmd} asset send --assetid $ASSET_ID -a 0 -f $ACCOUNTB -t $ACCOUNTB
app-assets.sh: ${gcmd} asset send -a 0 "$@"
winder
previously approved these changes
Apr 14, 2022
shiqizng
previously approved these changes
Apr 14, 2022
winder
reviewed
Apr 19, 2022
Co-authored-by: Will Winder <[email protected]>
winder
approved these changes
Apr 20, 2022
This was referenced Apr 27, 2022
This was referenced May 2, 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.
Summary
Add
goal asset optinsubcommandAdds a subcommand to simplify the opt in process for ASA via goal.
A lot of the command code is duplicated from the send command, but it looks like there is plenty of duplication across other commands as well so I've kept with that trend instead of factoring things out separately.
Test Plan
Replicated optin error and updated error message to more accurately reflect the needed actions. Then tested out the new optin command via these txns:
[Optin txn created on testnet] (https://testnet.algoexplorer.io/tx/CYBP2PPFMWMZZV63PWFYOU3MY2WPD2DNJ2UPCYNJH4Z7ECQA34KQ) via
goal asset optinSubsequent successful transfer of foobars