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

docs: Contract listener topic isn't clear about which fields are required for multi-event listeners #1656

Closed
4 tasks done
matthew1001 opened this issue Mar 11, 2025 · 1 comment · Fixed by #1665
Closed
4 tasks done
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@matthew1001
Copy link
Contributor

matthew1001 commented Mar 11, 2025

Current State

A few areas could do with some improvement:

  • The complete example shows a single-filter example, and if you just drop a multi-filter example into it (which some users are likely to do) you end up with an invalid contract listener request. It would be better if this example was converted to use the multi-filter format (i.e. no top-level event field in the payload) even if it only contains one event
  • The example has both event ABI inline, and a reference to an interface. I don't think you need the latter if you have the former?
  • Also the FireFly Interface field is described as follows: Deprecated: Please use 'interface' in the array of 'filters' instead but it isn't described as optional, which I believe it is since it isn't needed if you pass the ABI of the event in the filter itself. So it might be useful to remove interface from the examples that include event ABI inline, and possibly have an example that does reference an interface later in the document
  • Similarly, the eventPath is only needed when a FireFly Interface is being referenced. So it could probably go in a later example, not the main one.

Desired State

See notes in current state for recommended changes

@matthew1001 matthew1001 added the documentation Improvements or additions to documentation label Mar 11, 2025
@EnriqueL8 EnriqueL8 added this to the v1.3.3 milestone Mar 14, 2025
@EnriqueL8
Copy link
Contributor

PR Raised, the confusion came from the fact that the example is actually the API Response of querying a listener! I've separated out the examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants