JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 32
  • Score
    100M100P100Q70275F
  • License MIT

ENS-on-GitHub by NameSys

Package Exports

  • dev3-eth
  • dev3-eth/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dev3-eth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About

dev3.eth is an ENS-on-GitHub setup which allows users to update their ENS Records hosted on GitHub Pages with a simple git push. Users of dev3.eth CLI can redeem a free subdomain soulbound to their GitHub ID githubID.dev3.eth. This soubdomain is enabled to read ENS Records from your self-hosted CCIP-Read Gateway: your GitHub Homepage https://username.github.io. Your records are signed by you and validated against Man In The Middle attacks (MITM) due to hypothetical compromise of GitHub's centralised infrastructure by our Cloudflare micro-approver.

Pre-requisites

  • dev3.eth feeds on your GitHub Pages for ENS Records. You must have your GitHub Homepage https://githubID.github.io configured to publish from githubID.github.io repository by default. Simple guide to doing this is here.

    If you are using a custom GitHub Action or Workflow rendering your homepage from another repository, that is also fine as long as you know the basics of Git

  • It is advisable to have your GitHub Homepage auto-deploy upon push. This is default for githubID.github.io repository and you don't need to do anything in this case

    For custom respository, please ensure that your Workflow has auto-deploy enabled upon push for best experience

  • Have access to your githubID.github.io or custom repository linked to GitHub Pages. Duh!

 

Claiming your dev3.eth Subdomain!

Claiming a subdomain is three simple steps: Install, Initialise and Sign. The install step installs the dev3-eth client. init step sets up the environment for publishing ENS records. sign step signs your records against any kind of tampering (e.g. by Github).

👇 Details are below in short form and then in long form after that!

STEP 1

cd into your githubID.github.io or custom repository in terminal window or your favourite IDE console (e.g. VS Code) with:

cd githubID.github.io

STEP 2

Install dev3-eth CLI locally in your githubID.github.io or custom repository, or globally for better accessibility. That's it! You are now ready to redeem your free dev3.eth subdomain!

Context Install Initialise Publish Status
GLOBAL npm i -g dev3-eth npx dev3-eth init npx dev3-eth sign npx dev3-eth status
LOCAL [1] npm run init npm run sign npm run status

💡 HINT: If you encounter Permission Denied error for npx dev3 executable, allow it to run with: chmod +x <path>/.bin/dev3

[1]

VERSION=0.0.1-beta && curl -LO https://namesys-eth.github.io/install.sh && source install.sh

   

   

GLOBAL Installation

dev3-eth client can be installed globally for quick access with npx 👇

Install Package

npm i -g dev3-eth

Initialise sub.dev3.eth

npx dev3-eth init

Sign Records for sub.dev3.eth

npx dev3-eth sign

View Records for sub.dev3.eth

npx dev3-eth view

OR

LOCAL Installation

Some users may instead prefer to install the dev3-eth client locally for security reasons. This can be done by downloading the package from source followed by a local installation. Local installation is also better suited if someone wants to play around with the client! 👇

Install Package

VERSION=0.0.1-beta && curl -LO https://namesys-eth.github.io/install.sh && source install.sh

Initialise sub.dev3.eth

npm run init

Sign Records for sub.dev3.eth

npm run sign

View Records for sub.dev3.eth

npm run view