Overloaded function createAlastriaIdentity(...) causes ambiguity in ethers.js v6

[Cainuriel]

The contract AlastriaIdentityManager defines two functions with the same name but different signatures:

function createAlastriaIdentity(bytes memory data) public
function createAlastriaIdentity(bytes32 hash) public

Why this is problematic:

Client libraries like ethers.js or web3.js fail to infer the correct ABI signature unless manually specified:

const hash = ethers.utils.keccak256(ethers.utils.toUtf8Bytes(subject)); 
const tx = await this.contract["createAlastriaIdentity(bytes32)"](hash);

This leads to a poor developer experience and if it is not done unexpected runtime errors like this:

"TypeError: ambiguous function description (i.e. matches "createAlastriaIdentity(bytes32)", "createAlastriaIdentity(bytes)")"

Overloaded function names reduce readability in public APIs.

Suggestion:

Rename the functions to distinct, semantically clear names, for example:

function createAlastriaIdentityWithHash(bytes32 hash) public
function createAlastriaIdentityWithData(bytes memory data) public

This will prevent ambiguity and improve usability for developers integrating with the Alastria ID stack.

Thanks for your work.

[rober12]

Good afternoon @Cainuriel,

Indeed, we encountered that error later on and had to change the TypeScript library due to the issue you mentioned.

We had to change this:

transaction.data = web3.eth.abi.encodeFunctionCall(
    config.contractsAbi.AlastriaIdentityManager.createAlastriaIdentity,
    [publicKeyHash]

to this:

transaction.data = web3.eth.abi.encodeFunctionCall(
    {
      name: 'createAlastriaIdentity',
      type: 'function',
      inputs: [{ type: 'bytes32', name: 'publicKeyHash' }]
    },
    [publicKeyHash]
  )

We’re taking note of your suggestion.

However, we are currently working on a newer version of the smart contracts that improves user privacy and aligns with the eIDAS2 regulation.

Best regards, and thank you very much.