-
-
Notifications
You must be signed in to change notification settings - Fork 746
/
getEnsAddress.ts
163 lines (150 loc) · 5.41 KB
/
getEnsAddress.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
import type { Address } from 'abitype'
import type { Client } from '../../clients/createClient.js'
import type { Transport } from '../../clients/transports/createTransport.js'
import {
addressResolverAbi,
universalResolverResolveAbi,
} from '../../constants/abis.js'
import type { ErrorType } from '../../errors/utils.js'
import type { Chain } from '../../types/chain.js'
import type { Prettify } from '../../types/utils.js'
import {
type DecodeFunctionResultErrorType,
decodeFunctionResult,
} from '../../utils/abi/decodeFunctionResult.js'
import {
type EncodeFunctionDataErrorType,
encodeFunctionData,
} from '../../utils/abi/encodeFunctionData.js'
import {
type GetChainContractAddressErrorType,
getChainContractAddress,
} from '../../utils/chain/getChainContractAddress.js'
import { type TrimErrorType, trim } from '../../utils/data/trim.js'
import { type ToHexErrorType, toHex } from '../../utils/encoding/toHex.js'
import { isNullUniversalResolverError } from '../../utils/ens/errors.js'
import { type NamehashErrorType, namehash } from '../../utils/ens/namehash.js'
import {
type PacketToBytesErrorType,
packetToBytes,
} from '../../utils/ens/packetToBytes.js'
import { getAction } from '../../utils/getAction.js'
import {
type ReadContractParameters,
readContract,
} from '../public/readContract.js'
export type GetEnsAddressParameters = Prettify<
Pick<ReadContractParameters, 'blockNumber' | 'blockTag'> & {
/** ENSIP-9 compliant coinType used to resolve addresses for other chains */
coinType?: number | undefined
/** Universal Resolver gateway URLs to use for resolving CCIP-read requests. */
gatewayUrls?: string[] | undefined
/** Name to get the address for. */
name: string
/** Whether or not to throw errors propagated from the ENS Universal Resolver Contract. */
strict?: boolean | undefined
/** Address of ENS Universal Resolver Contract. */
universalResolverAddress?: Address | undefined
}
>
export type GetEnsAddressReturnType = Address | null
export type GetEnsAddressErrorType =
| GetChainContractAddressErrorType
| EncodeFunctionDataErrorType
| NamehashErrorType
| ToHexErrorType
| PacketToBytesErrorType
| DecodeFunctionResultErrorType
| TrimErrorType
| ErrorType
/**
* Gets address for ENS name.
*
* - Docs: https://viem.sh/docs/ens/actions/getEnsAddress
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
*
* Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
*
* Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
*
* @param client - Client to use
* @param parameters - {@link GetEnsAddressParameters}
* @returns Address for ENS name or `null` if not found. {@link GetEnsAddressReturnType}
*
* @example
* import { createPublicClient, http } from 'viem'
* import { mainnet } from 'viem/chains'
* import { getEnsAddress, normalize } from 'viem/ens'
*
* const client = createPublicClient({
* chain: mainnet,
* transport: http(),
* })
* const ensAddress = await getEnsAddress(client, {
* name: normalize('wevm.eth'),
* })
* // '0xd2135CfB216b74109775236E36d4b433F1DF507B'
*/
export async function getEnsAddress<chain extends Chain | undefined>(
client: Client<Transport, chain>,
{
blockNumber,
blockTag,
coinType,
name,
gatewayUrls,
strict,
universalResolverAddress: universalResolverAddress_,
}: GetEnsAddressParameters,
): Promise<GetEnsAddressReturnType> {
let universalResolverAddress = universalResolverAddress_
if (!universalResolverAddress) {
if (!client.chain)
throw new Error(
'client chain not configured. universalResolverAddress is required.',
)
universalResolverAddress = getChainContractAddress({
blockNumber,
chain: client.chain,
contract: 'ensUniversalResolver',
})
}
try {
const functionData = encodeFunctionData({
abi: addressResolverAbi,
functionName: 'addr',
...(coinType != null
? { args: [namehash(name), BigInt(coinType)] }
: { args: [namehash(name)] }),
})
const readContractParameters = {
address: universalResolverAddress,
abi: universalResolverResolveAbi,
functionName: 'resolve',
args: [toHex(packetToBytes(name)), functionData],
blockNumber,
blockTag,
} as const
const readContractAction = getAction(client, readContract, 'readContract')
const res = gatewayUrls
? await readContractAction({
...readContractParameters,
args: [...readContractParameters.args, gatewayUrls],
})
: await readContractAction(readContractParameters)
if (res[0] === '0x') return null
const address = decodeFunctionResult({
abi: addressResolverAbi,
args: coinType != null ? [namehash(name), BigInt(coinType)] : undefined,
functionName: 'addr',
data: res[0],
})
if (address === '0x') return null
if (trim(address) === '0x00') return null
return address
} catch (err) {
if (strict) throw err
if (isNullUniversalResolverError(err, 'resolve')) return null
throw err
}
}