Skip to content

Commit

Permalink
Update Code Examples (#236)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucemans authored May 29, 2024
1 parent 28db447 commit 75d3fb3
Show file tree
Hide file tree
Showing 35 changed files with 131 additions and 91 deletions.
4 changes: 2 additions & 2 deletions app/src/lib/mdxPageProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ export const mdxPagePropsSchema = z
*/
showDetailsSection: z.boolean().default(true),
/**
* Optional list of github usernames of contributors
* @example ['lucemans', 'svemat01']
* Optional list of ENS or github usernames of contributors
* @example ['luc.eth', 'lucemans', 'svemat01']
*/
contributors: z
.array(
Expand Down
4 changes: 2 additions & 2 deletions docs/bugs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: 'Bug Bounties',
description: 'ENS offers cash rewards to anyone who finds a bug in covered ENS smart contracts.',
emoji: '🪲',
contributors: [
'lucemans',
'gskril'
'luc.eth',
'gregskril.eth'
]
};

Expand Down
19 changes: 13 additions & 6 deletions docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@ import { WIP } from "@/components/wip/WIP";

{/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
export const meta = {
title: 'Changelog',
description: 'A list of changes and events that happened to the protocol.',
emoji: '📝',
contributors: []
title: 'Changelog',
description: 'A list of changes and events that happened to the protocol.',
emoji: '📝',
contributors: [
'luc.eth'
]
};

# 📝 Changelog

This file aims to include somewhat of a history of changes, deployments, bugs found, etc.
This page contains a list of changes and events that happened to the ENS protocol & ecosystem.

## ENSv2 Announcement

On March 28th, 2024 the ENS Labs team announced our plans and roadmap for scaling ENS to the entire internet and beyond.
This involves migrating .eth registrations to a brand new system, in addition to improving support for existing L2 solutions.
You can read more [on our blog](https://blog.ens.domains/post/ensv2), [on X](https://twitter.com/ensdomains/status/1795440186513576318), and [the forums](https://discuss.ens.domains/t/technical-feedback-thread-for-ensv2/19233).

<WIP />
6 changes: 3 additions & 3 deletions docs/dao/foundation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ export const meta = {
description: "The ENS DAO is represented in the real world by a Cayman Islands Foundation. This page describes why this is useful, how the foundation is structured, and what powers the DAO has over the Foundation.",
emoji: '🏛️',
contributors: [
'validatoreth',
'arachnid',
'lucemans',
'validator.eth',
'nick.eth',
'luc.eth',
]
};

Expand Down
4 changes: 2 additions & 2 deletions docs/dao/governance/moderator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
export const meta = {
description: "Process documentation and checklists for DAO moderators handling proposals",
contributors: [
'arachnid',
'lucemans'
'nick.eth',
'luc.eth'
]
};

Expand Down
4 changes: 2 additions & 2 deletions docs/dao/governance/process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
export const meta = {
description: "An overview of the ENS DAO's governance processes, and how you can get involved.",
contributors: [
'arachnid',
'lucemans'
'nick.eth',
'luc.eth'
]
};

Expand Down
6 changes: 3 additions & 3 deletions docs/dao/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ export const meta = {
showDetailsSection: false,
emoji: '👋',
contributors: [
'brantlymillegan',
'brantly.eth',
'dragonenergy',
'arachnid',
'lucemans',
'nick.eth',
'luc.eth',
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/dao/proposals/submit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: '',
emoji: '🧠',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/dao/proposals/voting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: '',
emoji: '🧠',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/dao/wg/rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: 'Current state of the Working Group Rules as created by EP0.4',
emoji: '',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/dns/tlds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const meta = {
title: 'Supported TLD List',
description: 'List of all supported DNS TLDs. Any DNS TLD that supports DNSSEC can be used with ENS.',
emoji: '📝',
contributors: ['lucemans', '0xPenryn']
contributors: ['luc.eth', '0xPenryn']
};

# Supported TLD List
Expand Down
2 changes: 1 addition & 1 deletion docs/ensip/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const meta = {
description: '',
emoji: '🧑‍🏫',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
export const meta = {
description: 'Frequently Asked Questions about the Ethereum Name Service',
contributors: ['lucemans']
contributors: ['luc.eth']
};

# FAQ
Expand Down
4 changes: 2 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ export const meta = {
emoji: '👋',
showDetailsSection: false,
contributors: [
'lucemans',
'arachnid',
'luc.eth',
'nick.eth',
]
};

Expand Down
10 changes: 8 additions & 2 deletions docs/learn/ccip-read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const meta = {

# Layer 2 & Offchain Resolution

All ENS resolution starts on Ethereum Mainnet.
All ENS resolution starts on Ethereum Mainnet (or testnet).
However, by leveraging the [CCIP Read](/resolvers/ccip-read), name resolution can be taken cross-chain, off-chain, and more.
This allows for a lot of flexibility in how you can use your ENS and for storage of your ENS records on your favourite Layer 2, or even off-chain.

Expand Down Expand Up @@ -42,7 +42,13 @@ Popular implementations of offchain names include but are not limited to:

Coinbase Wallet is one of the largest mobile wallets issuing free ENS subnames to their users.
These names are stored off-chain on coinbase servers, and can be registered from the Coinbase Wallet App or Browser Extension.
An example of a CB.ID is [lucemans.cb.id](https://enstate.rs/n/lucemans.cb.id).
An example of a cb.id is [lucemans.cb.id](https://enstate.rs/n/lucemans.cb.id).

### uni.eth

Uniswap Wallet is another popular mobile wallet that issues free ENS subnames to their users.
You can read more about the Uniswap Wallet ENS integration [here](https://blog.uniswap.org/introducing-uni-eth-your-unique-web3-username).
An example of a uni.eth is [lucemans.uni.eth](https://enstate.rs/n/lucemans.uni.eth).

### lens.xyz

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: 'ENS is multichain, but it all starts with Ethereum Mainnet. This page contains common addresses for ENS contracts.',
emoji: '📰',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/dns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: '',
emoji: '🌐',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export const meta = {
title: 'The Protocol',
emoji: '📖',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/resolution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: '',
emoji: '🔍',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
6 changes: 3 additions & 3 deletions docs/registry/dns.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
export const meta = {
description: 'Registrar responsible for all DNSSEC enabled names',
emoji: '🗒️',
contributors: ['lucemans', 'gskril']
description: 'Registrar responsible for all DNSSEC enabled names',
emoji: '🗒️',
contributors: ['luc.eth', 'gregskril.eth']
};

# DNS Registrar
Expand Down
2 changes: 1 addition & 1 deletion docs/registry/eth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { WIP } from "@/components/wip/WIP";
export const meta = {
description: 'Registrar responsible for the ".eth" TLD.',
emoji: '🗒️',
contributors: ['lucemans']
contributors: ['luc.eth']
};

# ETH Registrar
Expand Down
4 changes: 2 additions & 2 deletions docs/resolution/names.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ export const meta = {
description: '',
emoji: '⚙️',
contributors: [
'lucemans',
'serenae-fansubs'
'luc.eth',
'serenae.eth'
]
};

Expand Down
2 changes: 1 addition & 1 deletion docs/resolvers/ccip-read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
title: 'Offchain Resolvers (CCIP Read)',
description: 'Learn about how CCIP Read enables Offchain ENS Resolvers, how a gateway works, trust assumptions, and more.',
emoji: '⛓️',
contributors: ['lucemans'],
contributors: ['luc.eth'],
};

# Cross Chain / Offchain Resolvers
Expand Down
12 changes: 6 additions & 6 deletions docs/terminology.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
export const meta = {
description: 'A technical overview of all the terminology used in the ENS documentation.',
emoji: '📓',
contributors: [
'lucemans',
'serenae-fansubs'
]
description: 'A technical overview of all the terminology used in the ENS documentation.',
emoji: '📓',
contributors: [
'luc.eth',
'serenae.eth'
]
};

# Terminology
Expand Down
2 changes: 1 addition & 1 deletion docs/web/avatars.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: 'The \'Avatar\' record is a special record that allows for user profile pictures to be stored on ENS.',
emoji: '🔍',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand Down
10 changes: 5 additions & 5 deletions docs/web/enumerate.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
export const meta = {
description: 'List all names a user has, owns, or might have access to.',
contributors: [
'lucemans',
'gskril'
]
description: 'List all names a user has, owns, or might have access to.',
contributors: [
'luc.eth',
'gregskril.eth'
]
};

# Listing a Users Names
Expand Down
4 changes: 2 additions & 2 deletions docs/web/libraries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ export const meta = {
description: '',
emoji: '🛠️',
contributors: [
'lucemans',
'antony1060'
'luc.eth',
'antony1060.eth'
]
};

Expand Down
15 changes: 11 additions & 4 deletions docs/web/multichain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const meta = {
description: '',
emoji: '⛓️',
contributors: [
'lucemans'
'luc.eth'
]
};

Expand All @@ -13,16 +13,23 @@ export const meta = {
"the future is multichain"
</div>

Is what I heard some person say at some point at some conference and yeah that's how far we got.
## ENS L2

The ENS Labs team recently announced our plans and roadmap for scaling ENS to the entire internet and beyond.
You can read more [on our blog](https://blog.ens.domains/post/ensv2), [on X](https://twitter.com/ensdomains/status/1795440186513576318), and [the forums](https://discuss.ens.domains/t/technical-feedback-thread-for-ensv2/19233).
The roadmap involves migrating .eth registrations to a new system, in addition to improved support for existing L2 solutions.
You can findout more on the [changelog](/changelog).

## But isn't ENS on mainnet? {{ label: "ENS Multichain", navtitle: "Resolution" }}

Yes, technically. The resolution process always starts on mainnet. There needs to be, one source of truth after all. However, the name
resolution process can branch off to other chains, offchain gateways and much more. <br /> To read a more indepth explanation of how resolution works, checkout the [section dedicated to the Resolution Process](/resolution/).
resolution process can branch off to other chains, offchain gateways and much more.<br />
To read a more indepth explanation of how resolution works, checkout the [section dedicated to the Resolution Process](/resolution/).

## My dapp is on X but I want ENS {{ label: "dApp Multichain", navtitle: "dApps on other Chains" }}

The ENS Protocol can be used on/for any chain! If you are building a non-mainnet dApp and want to use ENS names simply [add a Mainnet RPC to your Wagmi config](/web/libraries) and specify `chainId: 1` in your config like so:
The ENS Protocol can be used on/for any chain!
If you are building a non-mainnet dApp and want to use ENS names simply [add a Mainnet RPC to your Wagmi config](/web/libraries) and specify `chainId: 1` in your config like so:

```tsx focus=6
import { useAccount, useEnsName, useEnsAvatar } from 'wagmi';
Expand Down
Loading

0 comments on commit 75d3fb3

Please sign in to comment.