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 documentation about external events #4091

Open
Neurone opened this issue Aug 28, 2024 · 0 comments
Open

Improve documentation about external events #4091

Neurone opened this issue Aug 28, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@Neurone
Copy link
Contributor

Neurone commented Aug 28, 2024

Problem description

The external events documentation seems not in sync with the actual code.

It is also not immediate to understand the acutaly payload from the format definition, so adding an example for each event would be appreciated.

From the code:

export enum ExternalMessageEvents {
    TOKEN_MINTED = 'external-events.token_minted',
    ERROR_LOG = 'external-events.error_logs',
    BLOCK_EVENTS = 'external-events.block_event',
    IPFS_ADDED_FILE = 'external-events.ipfs_added_file',
    IPFS_BEFORE_UPLOAD_CONTENT = 'external-events.ipfs_before_upload_content',
    IPFS_AFTER_READ_CONTENT = 'external-events.ipfs_after_read_content',
    IPFS_LOADED_FILE = 'external-events.ipfs_loaded_file',
}

From the doc:

  • external-events.token_minted
  • external-events.error_logs
  • external-events.block_run_action_event
  • externals-events.ipfs_added_file
  • external-events.ipfs_after_read_content
  • external-events.ipfs_before_upload_content

Differences:

  • external-events.block_run_action_event does not exist in the code
  • external-events.block_event is not mentioned in the doc
  • external-events.ipfs_added_file contains a typo in the doc (externalS-events.ipfs_added_file)
  • external-events.ipfs_before_upload_content is not mentioned in the doc
  • external-events.ipfs_loaded_file is not mentioned in the doc

Expected behavior

  • The documentation should list and describe all the available external events present in the source code
  • The documentation should include payload examples, not just format definitions, i.e.
external-events.token_minted: {
  tokenId: '0.0.4678707',
  tokenValue: 135,
  memo: '1724875475.946623551'
}
@Neurone Neurone added the bug Something isn't working label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants