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

Improve logging of sent signed transactions, and allow exporting logs as JSON for support #3039

Open
smaroudasunicorn opened this issue May 16, 2024 · 8 comments · May be fixed by #3408
Open
Assignees

Comments

@smaroudasunicorn
Copy link
Collaborator

smaroudasunicorn commented May 16, 2024

We would like to keep a log in the device of signed transactions. (timestamp, source, transaction information). Also in case there is an exception during signing of a transaction then this should be logged too (error timestamp, error code, error description). User shall be available through settings to export logs and use them for troubleshooting.

@peronczyk
Copy link
Collaborator

@smaroudasunicorn can you add some description here?

@onvisions do you have any designs for this?

@smaroudasunicorn
Copy link
Collaborator Author

@peronczyk @CedrikNikita @onvisions updated the story, kindly check

@onvisions
Copy link
Collaborator

onvisions commented Sep 23, 2024

@smaroudasunicorn @peronczyk Based on the user story described above

ACCEPTANCE CRITERIA:

  • Rename "Save error log" button to "Error log" in Dashboard/More/Wallet settings/;
  • Error log screen (../More/Wallet settings/Error log/) - update wording and design;
  • Add "Export and disable error log" modal;
  • Add "Export error log" button to all error templates.

Functionality:

  • error log is disabled by default but the user can enable it on the Error log screen;
  • the button "Export error log" is enabled only if there is already some saved error data;
  • if the user choses to disable the feature a modal is displayed informing them that Error log will be exported and feature disabled. All collected error data will be deleted from storage.
  • "The export error log" button in all Error modal templates should export not only log of the specific error but the whole Error log saved by Superhero wallet. So functionality is the same as the export button on Error log screen. The button is displayed only id the feature is enabled.

DESIGN:

Image
Image
Image
Image
Image
Image

Examples of error modals integration:

Image
Image
Image
Image

FIGMA REFERENCE: https://www.figma.com/design/3oGLWzSH0oJljo4RETZtur/Superhero-Wallet-UI-(%E2%9C%94%EF%B8%8FUpdated)?node-id=34473-242489&node-type=frame&t=Ci7dWQbVH2IkkvxC-0

@smaroudasunicorn
Copy link
Collaborator Author

About the Error Log Description

Superhero Wallet logs errors, when encountered in a log file in device storage (with maximum size?). File can be exported in json format for debugging or support from Superhero Wallet team.

When keep error log is enabled below, error log can be exported in .json format.

Also the export error log button shall be visible to modals only if keep error log is enabled. Besides that I am ok. Thanks

@onvisions
Copy link
Collaborator

@smaroudasunicorn Wording update for Keep Error log.

3 1 Error Log - not keeping
3 2 Error Log - Keeping

@smaroudasunicorn
Copy link
Collaborator Author

I am ok thanks

@Liubov-crypto
Copy link
Collaborator

  1. I was able to download error logs, but not able to get any error modals this time.

  2. I found that there is different wording compared to Figma. Image

  3. I enabled "Keep error log" but "Export error log" button is muted. I assume it's expected because wallet doesn't have any error logs yet. Correct?

@alex-k8
Copy link
Collaborator

alex-k8 commented Dec 3, 2024

@Liubov-crypto
2. I think the one I have is the newer one but it hasn't been updated on Figma @onvisions
3. Correct. If there are no logs, the button is disabled

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 a pull request may close this issue.

5 participants