ensdomains / ens

Implementations for ENS core functionality: The registry, registrars, and public resolvers.
https://ens.domains/
BSD 2-Clause "Simplified" License
1.16k stars 511 forks source link

ens X ethpm = <3 #335

Open njgheorghita opened 4 years ago

njgheorghita commented 4 years ago

Why?

To provide a resource for developers, tooling, protocols, etc. to have a trusted, content-addressed, machine-readable, accessible source for ENS contract assets & deployment data.

What's Included?

3 packages. 1 for each of ensdomains/ens, ensdomains/ethregistrar, ensdomains/resolvers. "pretty" versions of each package have been included for readability (note: these "pretty" versions are NOT valid ethPM packages - which must be tightly packed.)

It's not necessary to store these JSON files in a repository - since they live on IPFS. There is an ethPM scraping service that backs up all published packages and their assets hosted on IPFS. However, it's a good idea to keep a copy of the json files on github for backup.

ens@0.1.0a1

ethregistrar@0.1.0a1

resolvers@0.1.0a1

Registry

These packages been published to this registry. I'm currently the owner of the registry, but I'd love to hand ownership over to someone on your team. Only the owner is allowed to release packages on a registry. Just ping me with an address, and I'll transfer ownership. I'll also point the ENS name ens.ethpm.eth to the registry address once ownership is transferred, to make it more accessible for users.

Maintenance

I encourage you to carefully look through these packages, before taking ownership. AFAIK everything is accurate, but I could've missed something, or you might want to extend a package (i.e. add a deployment).

Currently, the easiest way to generate/consume/publish packages is with the ethpm-cli or web3.py. Truffle support for ethPM v2 is being actively implemented, and should be available within the coming months.

I'm sure some questions might arise, and I'm always happy to help answer questions. Just ping me on github or @njgheorghita on gitter.

Resources

Docs Spec ethpm-CLI

njgheorghita commented 4 years ago

ping @Arachnid I got a bit distracted with another project recently, but here are the ENS ethPM packages we talked about. Let me know if there's anything else I can help with!