openzeppelin-network.js icon indicating copy to clipboard operation
openzeppelin-network.js copied to clipboard

Published 20 hours ago • verified publisher icon OpenZeppelin

Review naming

Open frangio opened this issue 5 years ago • 2 comments

There's a couple of names I think we should review.

  • Web3Context: This library will generally be used alongside React, where Context already has a meaning that is unrelated to how we're using the word.
  • web3Context.lib: The lib property on Web3Context instances holds the Web3 instance initialized with the provider. It's a very generic name. IMO, ideally the property would be web3.
  • useWeb3Network/fromConnection: This React hook and its corresponding factory have unrelated names, even though they are both wrappers around the same functionality.

frangio avatar Aug 01 '19 16:08 frangio

I'd love to swap Context for something more sound. Couldn't come up with anything better. Any ideas are welcome. Regarding renaming lib for web3. The issue with web3 is that a lot of things are called web3 and having Web3Context.web3 property seems as overkill. If we rename Web3Context to something different than web3 would be more viable option.

ylv-io avatar Aug 05 '19 14:08 ylv-io

For the first one, maybe Web3Env or Web3Environment or Web3Wrapper?

PaulRBerg avatar Aug 28 '19 18:08 PaulRBerg