include_transaction_details usage

[CyberCyclone]

I may have a misunderstanding of how include_transaction_details works, but when it's enabled, it doesn't seem to pull in all the events. E.g, when I'm looking at the all events I can see ones like CIP 25, however when using include_transaction_details it's not listed as an object in the transaction.

Am I to expect all possible events to be included when using include_transaction_details or is this not supported? If not it's easy to work around, but I was just expecting it to include them.

Thanks!

[CyberCyclone]

On a side note, https://txpipe.github.io/oura/reference/data_dictionary.html doesn't seem to have an up to date list of Events. Not sure if there's a way to auto-document it.

[scarmuega]

I may have a misunderstanding of how include_transaction_details works, but when it's enabled, it doesn't seem to pull in all the events. E.g, when I'm looking at the all events I can see ones like CIP 25, however when using include_transaction_details it's not listed as an object in the transaction.

Am I to expect all possible events to be included when using include_transaction_details or is this not supported? If not it's easy to work around, but I was just expecting it to include them.

Thanks!

You're right, the scope of what is included as a transaction detail is arbitrary and not documented. It currently includes inputs, outputs, metadata and mints.

The goal was to strike a balance where enough information is provided while keeping the payload size manageable. Including "every" sub-event seemed excessive, but this arbitrary middle-ground isn't ideal.

I have some ideas on how to fix this in more scalable way, but it will require breaking changes. Throughout v1, my proposal is to keep pushing the same approach by adding some extra config values to allow further events to be included on a case-by-case basis. Thoughts?

On a side note, https://txpipe.github.io/oura/reference/data_dictionary.html doesn't seem to have an up to date list of Events. Not sure if there's a way to auto-document it.

Yes, data dictionary docs require an update. I was tracking this on #291 hoping to get some help from the community, but I'll get to that soon enough if nobody grabs it first. In the meantime, this is the source of truth for event data models:

https://github.com/txpipe/oura/blob/main/src/model.rs