feat: Transaction details page hints #331

janmichek · 2023-06-20T08:52:19Z

Description

resolves #231

Demo

Checklist:

I have read and followed the Contributing Guide
add transaction details hints

github-actions · 2023-06-20T08:56:25Z

Deployed to https://pr-331-aescan.stg.aepps.com

janmichek · 2023-06-27T09:06:18Z

@marc0olo I invited you for a review of the next large part of the hints

marc0olo · 2023-06-27T09:45:04Z

src/utils/hints/contractsHints.js

+  createdBy: 'Keyblock height and exact date and time when the smart contract was created.',
+  hash: 'The transaction hash of a ContractCreateTx that was executed to create the smart contract on the blockchain.',
+  creator: 'Account that created the smart contract on the blockchain.',
+  status: 'Status of the transaction',


Suggested change

status: 'Status of the transaction',

status: 'Status of the transaction.',

marc0olo · 2023-06-27T09:45:53Z

src/utils/hints/contractsHints.js

+  smartContract: 'Unique identifier for a smart contract instance that lives on the blockchain.',
+  caller: 'Account that called the smart contract.',
+  amount: 'Amount of AE coins that was transferred to smart contract address.',
+  entryPoint: 'The entry point of the smart contract that has been called.',


Suggested change

entryPoint: 'The entry point of the smart contract that has been called.',

entryPoint: 'The entrypoint of the smart contract that has been called.',

Fixed all over the app

marc0olo · 2023-06-27T10:07:33Z

src/utils/hints/contractsHints.js

+  caller: 'Account that called the smart contract.',
+  amount: 'Amount of AE coins that was transferred to smart contract address.',
+  entryPoint: 'The entry point of the smart contract that has been called.',
+  arguments: 'Arguments that was passed to entry point call with the call.',


Suggested change

arguments: 'Arguments that was passed to entry point call with the call.',

arguments: 'Arguments that were passed to the entrypoint.',

marc0olo · 2023-06-27T10:08:09Z

src/utils/hints/contractsHints.js

+  amount: 'Amount of AE coins that was transferred to smart contract address.',
+  entryPoint: 'The entry point of the smart contract that has been called.',
+  arguments: 'Arguments that was passed to entry point call with the call.',
+  return: 'Value that has been emitted after the call to entry point.',


Suggested change

return: 'Value that has been emitted after the call to entry point.',

return: 'Value that was returned by the entrypoint.',

marc0olo · 2023-06-27T10:09:05Z

src/utils/hints/contractsHints.js

+  entryPoint: 'The entry point of the smart contract that has been called.',
+  arguments: 'Arguments that was passed to entry point call with the call.',
+  return: 'Value that has been emitted after the call to entry point.',
+  gasLimit: 'Maximum amount of gas that will be paid for transaction.',


Suggested change

gasLimit: 'Maximum amount of gas that will be paid for transaction.',

gasLimit: 'Maximum amount of gas to be consumed by this transaction.',

marc0olo · 2023-06-27T10:35:04Z

src/utils/hints/transactionsHints.js

+  gaAttachTxStatus: 'Status of the transaction.',
+  gaAttachTxAccount: 'Account that was generalized.',
+  gaAttachTxSmartContractId: 'Unique identifier of the smart contract that was attached to the account.',
+  gaAttachTxGasLimit: 'Maximum amount of gas that will be paid for transaction.',


Suggested change

gaAttachTxGasLimit: 'Maximum amount of gas that will be paid for transaction.',

gaAttachTxGasLimit: 'Maximum amount of gas to be consumed by this transaction.',

marc0olo · 2023-06-27T10:35:53Z

src/utils/hints/transactionsHints.js

+  gaAttachTxAccount: 'Account that was generalized.',
+  gaAttachTxSmartContractId: 'Unique identifier of the smart contract that was attached to the account.',
+  gaAttachTxGasLimit: 'Maximum amount of gas that will be paid for transaction.',
+  gaAttachTxAuthFunction: 'Name of the smart contract function that was called to generalize the account.',


Suggested change

gaAttachTxAuthFunction: 'Name of the smart contract function that was called to generalize the account.',

gaAttachTxAuthFunction: 'Name of the smart contract entrypoint that in the future handles the authorization logic of the account.',

marc0olo · 2023-06-27T10:37:10Z

src/utils/hints/transactionsHints.js

+  gaAttachTxSmartContractId: 'Unique identifier of the smart contract that was attached to the account.',
+  gaAttachTxGasLimit: 'Maximum amount of gas that will be paid for transaction.',
+  gaAttachTxAuthFunction: 'Name of the smart contract function that was called to generalize the account.',
+  gaAttachTxArguments: 'Arguments that were passed to the smart contract call.',


Suggested change

gaAttachTxArguments: 'Arguments that were passed to the smart contract call.',

gaAttachTxArguments: 'Arguments that were passed to initialize the attached smart contract.',

marc0olo · 2023-06-27T10:38:00Z

src/utils/hints/transactionsHints.js

+  gaAttachTxAuthFunction: 'Name of the smart contract function that was called to generalize the account.',
+  gaAttachTxArguments: 'Arguments that were passed to the smart contract call.',
+  gaAttachTxGasPrice: 'Price for one unit of gas.',
+  gaAttachTxGasUsed: 'Amount of gas that was paid for interaction with the smart contract.',


Suggested change

gaAttachTxGasUsed: 'Amount of gas that was paid for interaction with the smart contract.',

gaAttachTxGasUsed: 'Amount of gas that was consumed for attaching the smart contract to the account.',

marc0olo · 2023-06-27T10:39:12Z

src/utils/hints/transactionsHints.js

+  gaAttachTxArguments: 'Arguments that were passed to the smart contract call.',
+  gaAttachTxGasPrice: 'Price for one unit of gas.',
+  gaAttachTxGasUsed: 'Amount of gas that was paid for interaction with the smart contract.',
+  gaAttachTxGasCost: 'Price in AE that was paid for interaction with the smart contract.',


Suggested change

gaAttachTxGasCost: 'Price in AE that was paid for interaction with the smart contract.',

gaAttachTxGasCost: 'The AE paid for attaching the smart contract to the account.',

marc0olo · 2023-06-27T10:42:13Z

@janmichek for the state channel tx-hints I think it would be good to let @velzevur and/or @uwiger have a look. I actually didn't review the state channel hints so far.

janmichek · 2023-06-27T11:12:01Z

@janmichek for the state channel tx-hints I think it would be good to let @velzevur and/or @uwiger have a look. I actually didn't review the state channel hints so far.

Thanks for the great suggestions, all accepted.
Yes please, that would be awesome. @velzevur @uwiger feel free to collaborate by providing the code review .)

marc0olo · 2023-06-27T13:21:59Z

@velzevur @uwiger: this is the file you need to check (you can ignore the rest I think 😅)

https://github.com/aeternity/aescan/pull/331/files#diff-720acf0511e27a8fa6ee7a840566647bf27e3896a32a9c2e8ec1c2b5f2b489e2

lukeromanowicz

Looks pretty good to me =)

velzevur · 2023-06-28T12:15:51Z

src/utils/hints/stateChannelsHints.js

+  responderCloseAmount: 'Final balance for the responder.',
+  responderSettleAmount: 'Unsigned amount of coins the responder gets from the channel.',
+  settledBy: 'Participant of the channel that posts the settling transaction.',
+  snapshotRound: 'Channel\'s next round.',


I am not sure if this is a bit misleading and it could be misleading, maybe try:

Suggested change

snapshotRound: 'Channel\'s next round.',

snapshotRound: 'Channel snapshot\'s round.',

velzevur · 2023-06-28T12:17:30Z

src/utils/hints/stateChannelsHints.js

+  slashedRound: 'The round in which the slash was triggered.',
+  slashedBy: 'The account that slashed (disputed) malicious ChannelCloseSoloTx or ChannelForceProgressTx.',
+  initiatorCreateAmount: 'Unsigned amount of coins the initiator commits to the channel.',
+  initiatorCloseAmount: 'Final balance for the initiator.',


What is the difference between initiatorCloseAmount and initiatorSettleAmount? In what context are they being used?

The context changes per tx type

SETTLE
https://pr-331-aescan.stg.aepps.com/transactions/th_sf174Sa4cYhivSebQVt3UEvnzjXHg5o6Le3ZZkSu7fLcbpciu

vs

CLOSE MUTUAL
https://pr-331-aescan.stg.aepps.com/transactions/th_2Fm4TFh1z8nMNhzBCLR62raVdnqKRjcQ2Gh8FH1fr2SUAyzUBB

velzevur · 2023-06-28T12:18:25Z

src/utils/hints/stateChannelsHints.js

+  forcedBy: 'Participant or a delegate of the channel that posts the force progress transaction.',
+  depositor: 'Account that deposited funds to the state channel.',
+  depositRound: 'The channel\'s internal round that applies the deposit.',
+  depositAmount: 'Amount deposited to the state channels.',


Suggested change

depositAmount: 'Amount deposited to the state channels.',

depositAmount: 'Amount deposited to the state channel.',

velzevur · 2023-06-28T12:22:22Z

src/utils/hints/stateChannelsHints.js

+  closeRound: 'The round in which the state channel was proposed to be closed.',
+  closeProposedBy: 'The participant of the channel that posts the closing transaction.',
+  sentBy: 'State channel participant or delegate that posts the slashing transaction.',
+  channelReserve: 'The minimum amount of AE coins that must remain locked in the channel.',


Suggested change

channelReserve: 'The minimum amount of AE coins that must remain locked in the channel.',

channelReserve: 'The minimum amount of AE coins that must remain locked in any of the off-chain accounts in the channel.',

It is not the total amount locked in the channel but a minimum threshold for both accounts independently

thanks, accepted

michele-franchi

Good job, I left some suggestions.

src/utils/hints/contractsHints.js

src/utils/hints/namesHints.js

src/utils/hints/oraclesHints.js

src/utils/hints/stateChannelsHints.js

janmichek · 2023-06-29T07:11:18Z

Good job, I left some suggestions.

Thank you, all fixed

michele-franchi

Thanks for the fixes and the really good job. 👏

janmichek added 4 commits June 22, 2023 09:56

add spendTx hints

5fb64a8

add contract hints

f0f6dff

add general transaction hints

ed530f4

implement contract hints

ffac685

janmichek force-pushed the Transaction_details_page_hints branch from 140a2c0 to ffac685 Compare June 22, 2023 07:59

janmichek added 7 commits June 22, 2023 10:41

add oracle transaction hints

3475dd3

add name transaction hints

2d3d431

add state channel transaction hints

9151971

fix imports

bcc5395

add ga related transactions hints

10e11f6

improve hints content

93f7766

improve wording

1383acb

janmichek requested review from lukeromanowicz, michele-franchi and marc0olo June 27, 2023 09:04

marc0olo suggested changes Jun 27, 2023

View reviewed changes

fix hints wording

c2cf5a2

lukeromanowicz approved these changes Jun 28, 2023

View reviewed changes

janmichek requested review from uwiger and velzevur June 28, 2023 09:41

velzevur reviewed Jun 28, 2023

View reviewed changes

fix state channels hints wording

482fb0a

michele-franchi requested changes Jun 29, 2023

View reviewed changes

fix wording of hints

18abaff

janmichek requested review from michele-franchi and CharisSiarampalis June 29, 2023 07:11

michele-franchi approved these changes Jun 29, 2023

View reviewed changes

CharisSiarampalis approved these changes Jun 29, 2023

View reviewed changes

janmichek merged commit 635e6ac into develop Jun 29, 2023

janmichek deleted the Transaction_details_page_hints branch June 29, 2023 09:11

aeternity-bot mentioned this pull request Jul 31, 2023

chore(release/0.4.0): release 0.4.0 #412

Merged

	status: 'Status of the transaction',
	status: 'Status of the transaction.',

	entryPoint: 'The entry point of the smart contract that has been called.',
	entryPoint: 'The entrypoint of the smart contract that has been called.',

	arguments: 'Arguments that was passed to entry point call with the call.',
	arguments: 'Arguments that were passed to the entrypoint.',

	return: 'Value that has been emitted after the call to entry point.',
	return: 'Value that was returned by the entrypoint.',

	gasLimit: 'Maximum amount of gas that will be paid for transaction.',
	gasLimit: 'Maximum amount of gas to be consumed by this transaction.',

	gaAttachTxGasLimit: 'Maximum amount of gas that will be paid for transaction.',
	gaAttachTxGasLimit: 'Maximum amount of gas to be consumed by this transaction.',

	gaAttachTxAuthFunction: 'Name of the smart contract function that was called to generalize the account.',
	gaAttachTxAuthFunction: 'Name of the smart contract entrypoint that in the future handles the authorization logic of the account.',

	gaAttachTxArguments: 'Arguments that were passed to the smart contract call.',
	gaAttachTxArguments: 'Arguments that were passed to initialize the attached smart contract.',

	gaAttachTxGasUsed: 'Amount of gas that was paid for interaction with the smart contract.',
	gaAttachTxGasUsed: 'Amount of gas that was consumed for attaching the smart contract to the account.',

	gaAttachTxGasCost: 'Price in AE that was paid for interaction with the smart contract.',
	gaAttachTxGasCost: 'The AE paid for attaching the smart contract to the account.',

	snapshotRound: 'Channel\'s next round.',
	snapshotRound: 'Channel snapshot\'s round.',

	depositAmount: 'Amount deposited to the state channels.',
	depositAmount: 'Amount deposited to the state channel.',

	channelReserve: 'The minimum amount of AE coins that must remain locked in the channel.',
	channelReserve: 'The minimum amount of AE coins that must remain locked in any of the off-chain accounts in the channel.',

feat: Transaction details page hints #331

feat: Transaction details page hints #331

Conversation

janmichek commented Jun 20, 2023 • edited Loading

Description

Demo

Checklist:

github-actions bot commented Jun 20, 2023

janmichek commented Jun 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marc0olo commented Jun 27, 2023

janmichek commented Jun 27, 2023

marc0olo commented Jun 27, 2023

lukeromanowicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michele-franchi left a comment

Choose a reason for hiding this comment

janmichek commented Jun 29, 2023

michele-franchi left a comment

Choose a reason for hiding this comment

janmichek commented Jun 20, 2023 •

edited

Loading