[Regression, 0.11, important] Inconsistent handling of homeDomain in Transaction object

Summary

0.11 seems to have introduced a regression were tx.operations[x].homeDomain is set to null instead of undefined when not defined. When this parameter is set to an empty string (to clear it), tx.operations[x].homeDomain is set to null as well. This introduce a confusion that could lead to a wrong interpretation of the transaction purpose, hence the important tag.

Expected behavior

The property at tx.operations[x].homeDomain should be set to undefined if it was not set among the setOptions operation options as for any other parameter. If the parameter were ‘’, it should properly reflect as well.

Reproduce

const StellarSdk = require('stellar-sdk')
const keypair = StellarSdk.Keypair.random()
const account = new StellarSdk.Account(keypair.publicKey(), '0')

// First operation do nothing.
const tx1 = new StellarSdk.TransactionBuilder(account)
	.addOperation(StellarSdk.Operation.setOptions({}))
	.build()

// Second operation unset homeDomain
const tx2 = new StellarSdk.TransactionBuilder(account)
	.addOperation(StellarSdk.Operation.setOptions({ homeDomain: ''}))
	.build()

// Both operations set tx.operations[0].homeDomain to `null`.
console.log(tx1.operations[0].homeDomain)
console.log(tx2.operations[0].homeDomain)

// However the `tx` tree remains consistent (first: undefined, second: '')
console.log(tx1.tx._attributes.operations[0]._attributes.body._value._attributes.homeDomain)
console.log(tx2.tx._attributes.operations[0]._attributes.body._value._attributes.homeDomain)

[bartekn]

Sorry, you are right. Fix ready in https://github.com/stellar/js-stellar-base/pull/144.

[bartekn]

Good point, changed.