registry.setUri
Sets the metadata URI of an ENSv2 registry. Parameters, return value, errors and examples for registry.setUri in @ensforge/sdk.
Sets the metadata URI of an ENSv2 registry. Resolves once the transaction is submitted.
When to use
Use to point a registry's token metadata at your own service. Use setUriSync to wait for the receipt.
Details
- Keeps the current URI renderer unless
rendereris given;nullremoves it. - Needs the
setUriroot role.
Signature
function setUri(
client: Like,
options: setUri.Options & Write.Options,
): Promise<setUri.ReturnType>Call it as ens.registry.setUri(options) on a client, or Actions.registry.setUri(client, options).
Parameters
With name and uri:
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ||
uri (required) | string | Metadata URI. | |
renderer | string | null | URI renderer contract, or null for none. |
With registry and uri:
| Option | Type | Default | Description |
|---|---|---|---|
registry (required) | string | ||
uri (required) | string | Metadata URI. | |
renderer | string | null | URI renderer contract, or null for none. |
Also takes the write options.
Returns
Resolves to Write.Result. Submitted transaction hashes and the plan that produced them.
| Field | Type | Description |
|---|---|---|
hash | Hex | Hash of the last transaction. |
hashes | readonly Hex[] | Every submitted transaction, in order. |
id | string | EIP-5792 bundle id when the calls were sent as one batch. |
plan | Plan | The plan the write executed: its steps, in order, as they were submitted. |
Errors
| Error | Codes | When |
|---|---|---|
InvalidInputError | INVALID_NAME, INVALID_ADDRESS | invalid input. |
NotFoundError | REGISTRY_NOT_FOUND | the name has no subregistry. |
UnauthorizedError | MISSING_ROLES | without the setUri root role. |
UserRejectedError | USER_REJECTED | the user rejects the request. |
WalletError | CHAIN_MISMATCH, ACCOUNT_NOT_FOUND | the wallet is on another chain or has no account to sign with. |
UnsupportedError | WALLET_BATCH_UNSUPPORTED | with mode: "batch" or a paymaster when the wallet cannot send calls as one batch. |
It can also fail with the errors every write can (Errors.WriteError: the common errors plus InsufficientFundsError, TransactionError, UnsupportedError, UserRejectedError, WalletError).
See How errors work.
Examples
const { hash } = await ens.registry.setUri({ name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })Plan methods
Each method takes the same options as registry.setUri and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
registry.setUri.prepare(options) | Builds the plan without sending anything. |
registry.setUri.simulate(options) | Simulates the plan with eth_call, reporting each step. |
registry.setUri.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with setUriSync
Sets the metadata URI of an ENSv2 registry. Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
registry.setUriSync takes the same options plus confirmations and timeout.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.registry.setUriSync({ name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })See also
registry.getto read it
Was this page helpful?