Feature Request: Retrieve Token Holders

[Maxtho8]

Hello,

I would like to propose an enhancement to wagmi that would allow users to retrieve the holders of a token. I believe this could be useful for some developers who might, for example, want to integrate a ranking of holders into their dapp. What do you think?

I am very interested in implementing this feature, which could be implemented as follows:

const { data, isError, isLoading, getHolders } = useToken({
  address: '0xc18360217d8f7ab5e7c516566761ea12ce7f9d72',
});

useToken returns a getHolders function that can be called to retrieve the token holders in the following way:

getHolders({
  index,
  sort?,
  filter?,
  percent?,
});

• index: Passing the index of holders, for example, index: "10", index: "10:100", and index: "10:".
• sort: Optional parameter: "asc" or "desc", default is "desc".
• filter: Optional parameter, a function that is passed and will be applied to each entry to determine if it should be retrieved. For example:

filter: (holder) => {
  return holder.balance > 10000;
};

• percent: Optional parameter which is a boolean, default is false. If it is true, it returns for each the percentage of tokens owned in relation to the total supply.

I would like to get your feedback on this feature.