chore: update readme
50b23456
1 file(s) · +86 −0
| 129 | 129 | # .... |
|
| 130 | 130 | ``` |
|
| 131 | 131 | ||
| 132 | + | ## Edit Commands |
|
| 133 | + | ||
| 134 | + | Edit commands require setting the `ATLAS_PRIVATE_KEY` environment variable with your wallet's private key to sign transactions. A great way to do this is to use the Foundry `cast` utility within a shell session. |
|
| 135 | + | ||
| 136 | + | ```bash |
|
| 137 | + | # By running the command below you export the env variable into your shell session |
|
| 138 | + | ||
| 139 | + | export ATLAS_PRIVATE_KEY=$(cast wallet private-key --account someaccount) |
|
| 140 | + | ``` |
|
| 141 | + | ||
| 142 | + | > [!WARNING] |
|
| 143 | + | > I would **not** recommend making this environment variable permanent in your shell configurtation files! Use it during the session then close the session to keep the key encrypted locally |
|
| 144 | + | ||
| 145 | + | ### `edit txt` |
|
| 146 | + | Set or clear a text record for an ENS name |
|
| 147 | + | ||
| 148 | + | ```bash |
|
| 149 | + | # Set a text record |
|
| 150 | + | atlas edit txt myname.eth com.github myusername |
|
| 151 | + | ||
| 152 | + | # Set a Discord username |
|
| 153 | + | atlas edit txt myname.eth com.discord mydiscord#1234 |
|
| 154 | + | ||
| 155 | + | # Clear a text record by passing 'null' |
|
| 156 | + | atlas edit txt myname.eth com.github null |
|
| 157 | + | ||
| 158 | + | # Specify a custom resolver address |
|
| 159 | + | atlas edit txt myname.eth com.twitter myhandle --resolver 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63 |
|
| 160 | + | ``` |
|
| 161 | + | ||
| 162 | + | ### `edit address` |
|
| 163 | + | Set or clear an address record for a specific coin/chain |
|
| 164 | + | ||
| 165 | + | ```bash |
|
| 166 | + | # Set an ETH address |
|
| 167 | + | atlas edit address myname.eth ETH 0x1234567890123456789012345678901234567890 |
|
| 168 | + | ||
| 169 | + | # Set a Bitcoin address |
|
| 170 | + | atlas edit address myname.eth BTC bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh |
|
| 171 | + | ||
| 172 | + | # Set a Solana address |
|
| 173 | + | atlas edit address myname.eth SOL 7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV |
|
| 174 | + | ||
| 175 | + | # Clear an address record by passing 'null' |
|
| 176 | + | atlas edit address myname.eth BTC null |
|
| 177 | + | ||
| 178 | + | # Specify a custom resolver address |
|
| 179 | + | atlas edit address myname.eth ETH 0x1234... --resolver 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63 |
|
| 180 | + | ``` |
|
| 181 | + | ||
| 182 | + | ### `edit resolver` |
|
| 183 | + | Set the resolver for an ENS name |
|
| 184 | + | ||
| 185 | + | ```bash |
|
| 186 | + | # Set resolver using registry contract (default) |
|
| 187 | + | atlas edit resolver myname.eth 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63 |
|
| 188 | + | ||
| 189 | + | # Set resolver using nameWrapper contract |
|
| 190 | + | atlas edit resolver myname.eth 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63 --contract nameWrapper |
|
| 191 | + | ``` |
|
| 192 | + | ||
| 193 | + | ### `edit primary` |
|
| 194 | + | Set the primary ENS name for your address (reverse record) |
|
| 195 | + | ||
| 196 | + | ```bash |
|
| 197 | + | # Set primary name |
|
| 198 | + | atlas edit primary myname.eth |
|
| 199 | + | ``` |
|
| 200 | + | ||
| 201 | + | ### `edit abi` |
|
| 202 | + | Set or clear an ABI record for an ENS name |
|
| 203 | + | ||
| 204 | + | ```bash |
|
| 205 | + | # Set ABI from a JSON file |
|
| 206 | + | atlas edit abi myname.eth ./contract-abi.json |
|
| 207 | + | ||
| 208 | + | # Set ABI with specific encoding |
|
| 209 | + | atlas edit abi myname.eth ./contract-abi.json --encode zlib |
|
| 210 | + | ||
| 211 | + | # Clear an ABI record by passing 'null' |
|
| 212 | + | atlas edit abi myname.eth null |
|
| 213 | + | ||
| 214 | + | # Specify a custom resolver address |
|
| 215 | + | atlas edit abi myname.eth ./contract-abi.json --resolver 0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63 |
|
| 216 | + | ``` |
|
| 217 | + | ||
| 132 | 218 | ## Development |
|
| 133 | 219 | ||
| 134 | 220 | Make sure [Bun](https://bun.sh) is installed |