Documentation for Event Emitter with topicSets omits required padding for addresses in topics

[josh-richardson]

The documentation for event emitters has an example whereby the following code is used:

topicSets = [
    utils.id("Transfer(address,address,uint256)"),
    null,
    [
        myAddress,
        myOtherAddress
    ]
]
provider.on(topicSets, (log, event) => {
    // Emitted any token is sent TO either address
})

Unfortunately, this causes an error which is addressed elsewhere in the documentation by the addition of the utils.hexZeroPad method. If this is indeed a mistake as I suspect, I'm happy to submit a PR to fix it.

Edit: I see when looking at the docs myOtherAddress is defined as AddressZero in events.wrm but as HashZero in provider.wrm, so it seems that everything would work as expected, however it might be clearer to end users if types were updated here to those which would more commonly be used in this situation (assuming users are more likely to pass a plain address as a string to this method rather than as a padded 32 byte hex string).

[zemse]

Yes, you are right hexZeroPad is to be used if you are passing addresses, as topics accept only bytes32 strings. I think this came up before in some previous issue but the example will be updated to make it clear.

[josh-richardson]

Opened a PR: #1538

[ricmoo]

Fixed and published.

Thanks! :)