ConvertBytes and ConvertInterface use types like enums/constants

[leighmcculloch]

I think the interface created by ConvertBytes and ConvertInterface is a little odd.

Use looks like this in the stellar-rpc:

json, _ := xdr2json.ConvertBytes(xdr.TransactionResult{}, tx.Result)

Ref: https://github.com/stellar/stellar-rpc/blob/cd2ef199c70b19a8630a2c3059fd6dc4382223b6/cmd/stellar-rpc/internal/methods/json.go

json, _ := xdr2json.ConvertInterface(topic)

Ref: https://github.com/stellar/stellar-rpc/blob/cd2ef199c70b19a8630a2c3059fd6dc4382223b6/cmd/stellar-rpc/internal/methods/get_events.go

It encourages using the types defined outside the package as a name enum of sorts. Those types happen to be named the same, which is lucky given that if the Go types were named according to Go naming conventions they wouldn't match the Rust names encoded in the stellar-xdr Rust crate.

Instead of the approach taken today, this package could provide a list of constants for all the types, and that would provide the same amount of certainty if folks were wanting to avoid having hardcoded strings.

The above example would become:

json, _ := xdr2json.ConvertBytes(xdr2json.TRANSACTION_RESULT, tx.Result)

This issue was inspired by reviewing the code at:

• Karthik/fix deps #3 (comment)

[leighmcculloch]

A list of all names from the stellar-xdr crate can be generated using the crate itself, it exports a type TypeVariant which is a list of all the types supported:

• https://docs.rs/stellar-xdr/latest/stellar_xdr/curr/enum.TypeVariant.html

---

Alternatively, use the stellar-xdr CLI. The stellar-xdr CLI is built into the stellar-xdr crate, and has a sub-command that will output a list of all the types.

Install the stellar-xdr CLI that matches the version depended on by the Rust library in this Go package.

For example:

cargo install [email protected] --features cli

Or:

cargo install stellar-xdr@"$(cargo metadata --format-version 1 | jq -r '.packages.[] | select(.name == "stellar-xdr") | .version')" --features cli

Then get the list of types with:

stellar-xdr types list

Note that the stellar xdr command in the stellar-cli, is just a reexport of the stellar-xdr CLI, they're the same thing. But in this case it is better to use the stellar-xdr CLI directly because it's guaranteed to be available for any version of the stellar-xdr crate.