Emit events as a top-level field in getTransaction response

[leighmcculloch]

What problem does your feature solve?

When interacting with a transaction via simulateTransaction an array of base64 xdr encoded events is returned.

When interacting with a transaction via getTransaction no array of events are provided. The events are in the transaction meta though.

What would you like to see?

A top-level events field like what we see with the simulationTransaction method.

Events should be easily accessible and first-class field in the API.

What alternatives are there?

Do nothing and folks can get the events out of the transaction meta.

[2opremio]

@leighmcculloch why not call getEvents directly instead? (I would rather not duplicate functionality)

[leighmcculloch]

why not call getEvents directly instead?

getEvents doesn't take a transaction hash as a filter.

[leighmcculloch]

Looking at this further, the simulateTransaction and getTransaction endpoints take such different shape.

getTransaction	simulateTransaction
ledger
createdAt
applicationOrder
feeBump
envelopeXdr
resultMetaXdr
resultXdr	results.xdr
	stateChanges
	events
	minResourceFee
	restorePreamble
	results.auth
	transactionData
	error

Much of that makes sense.

The presence of events and stateChanges on simulateTransaction is nice though. I assume their presence is because we don't have a transaction meta value as a whole to return. The APIs and workflow for interacting with both are just so different. I think it's worth some effort of normalising the experience of getting events or getting state changes across the two.

[Shaptic]

I mean, those endpoints are completely different, so it makes sense for their shapes to have minimal overlap (result.xdr != resultXdr, btw); their functionality is disjoint.

The amount of work for the user to parse events out of the resultMetaXdr is basically identical relative to from a list of diagnosticEventsXdr (as in, they only have to add .v3().sorobanMeta.diagnosticEvents() (in JS) to their code); I don't see a meaningful value add duplicating the payload in a top-level field.