chore: Updated readme f5f438d2
Steve · 2025-08-17 07:56 1 file(s) · +60 −8
README.md +60 −8
20 20
21 21
## Usage
22 22
23 -
### resolve
23 +
By default Atlas will use `https://eth.drpc.org` but you can use a custom RPC by setting the environment variable `ETH_RPC_URL` in your shell.
24 +
25 +
### `resolve`
24 26
Resolve an ENS name to an address or vice versa
25 27
26 28
```bash
27 29
# Resolve ENS name to address
28 30
atlas resolve vitalik.eth
31 +
# 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
29 32
30 33
# Resolve address to ENS name
31 34
atlas resolve 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
35 +
# vitalik.eth
32 36
33 37
# Get a specific TXT record
34 38
atlas resolve vitalik.eth --txt com.github
39 +
# vbuterin
35 40
36 41
# Get content hash
37 42
atlas resolve vitalik.eth --contenthash
43 +
# bafybeig5wyxzxlhleqtop6n3eevoscfvfwlijfuo6vfvyl3zskadapoglq
38 44
39 45
# Get address for a specific chain
40 46
atlas resolve vitalik.eth --chain ETH
47 +
# 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
41 48
```
42 49
43 -
### profile
50 +
### `profile`
44 51
Display a complete ENS profile with all records
45 52
46 53
```bash
47 54
# Show full profile for an ENS name or address
48 55
atlas profile vitalik.eth
49 56
atlas profile 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
57 +
58 +
# ENS Profile
59 +
# ============
60 +
#
61 +
# Name:        vitalik.eth
62 +
# Address:     0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
63 +
#
64 +
# Text Records:
65 +
# Website:     https://vitalik.ca
66 +
# Avatar:      https://euc.li/vitalik.eth
67 +
# Bio:         mi pinxe lo crino tcati
68 +
# Twitter:     VitalikButerin
69 +
# GitHub:      vbuterin
70 +
# Header:      https://pbs.twimg.com/profile_banners/295218901/1638557376/1500x500
71 +
# Avatar:      https://euc.li/vitalik.eth
72 +
# Bio:         mi pinxe lo crino tcati
73 +
# Website:     https://vitalik.ca
74 +
# GitHub:      vbuterin
75 +
# Twitter:     VitalikButerin
76 +
#
77 +
# Coin Records:
78 +
# ETH:       0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
79 +
#
80 +
# Content Hash:
81 +
# Type:        ipfs
82 +
# Hash:        bafybeig5wyxzxlhleqtop6n3eevoscfvfwlijfuo6vfvyl3zskadapoglq
83 +
#
84 +
# Resolver:    0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63
50 85
```
51 86
52 -
### namehash
87 +
### `namehash`
53 88
Generate a namehash for an ENS name
54 89
55 90
```bash
56 91
atlas namehash vitalik.eth
92 +
# 0xee6c4522aab0003e8d14cd40a6af439055fd2577951148c14b6cea9a53475835
57 93
```
58 94
59 -
### labelhash
95 +
### `labelhash`
60 96
Generate a labelhash for an ENS name
61 97
62 98
```bash
63 99
atlas labelhash vitalik
100 +
# 0xaf2caa1c2ca1d027f1ac823b529d0a67cd144264b2789fa2ea4d63a67c7103cc
64 101
```
65 102
66 -
### resolver
103 +
### `resolver`
67 104
Get the current resolver address for an ENS name
68 105
69 106
```bash
70 107
atlas resolver vitalik.eth
108 +
# 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63
71 109
```
72 110
73 -
### deployments
74 -
List all deployed ENS contracts
111 +
### `deployments`
112 +
List deployed ENS contracts
75 113
76 114
```bash
77 115
atlas deployments
116 +
# Chain ID: 1
117 +
#   ensBaseRegistrarImplementation: 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85
118 +
#   ensBulkRenewal: 0xa12159e5131b1eEf6B4857EEE3e1954744b5033A
119 +
#   ensDnsRegistrar: 0xB32cB5677a7C971689228EC835800432B339bA2B
120 +
#   ensDnssecImpl: 0x0fc3152971714E5ed7723FAFa650F86A4BaF30C5
121 +
#   ensEthRegistrarController: 0x253553366Da8546fC250F225fe3d25d0C782303b
122 +
#   ensNameWrapper: 0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401
123 +
#   ensPublicResolver: 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63
124 +
#   ensRegistry: 0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e
125 +
#   ensReverseRegistrar: 0xa58E81fe9b61B5c3fE2AFD33CF304c454AbFc7Cb
126 +
#   ensUniversalResolver: 0xce01f8eee7E479C928F8919abD53E553a36CeF67
127 +
# Chain ID: 5
128 +
#   ensBaseRegistrarImplementation: 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85
129 +
#   ....
78 130
```
79 131
80 132
## Development
98 150
```bash
99 151
bun dev
100 152
101 -
atlas somenewthing
153 +
atlas resolve vitalik.eth
102 154
```
103 155
104 156
> [!NOTE]