# registry.setUri

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Sets the metadata URI of an ENSv2 registry. Parameters, return value, errors and examples for registry.setUri in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/registry/set-uri

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/registry/setUri/index.ts#L54" />

Sets the metadata URI of an ENSv2 registry. Resolves once the transaction is submitted.

## When to use [#when-to-use]

Use to point a registry's token metadata at your own service. Use [`setUriSync`](/docs/reference/sdk/registry/set-uri#wait-for-the-receipt-with-seturisync) to wait for the receipt.

## Details [#details]

- Keeps the current URI renderer unless `renderer` is given; `null` removes it.
- Needs the `setUri` root role.

## Signature [#signature]

```ts
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 [#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](/docs/reference/sdk/client#write-options).

## Returns [#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 [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS) | invalid input. |
| [`NotFoundError`](/docs/reference/errors/not-found-error) | [`REGISTRY_NOT_FOUND`](/docs/reference/errors/REGISTRY_NOT_FOUND) | the name has no subregistry. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`MISSING_ROLES`](/docs/reference/errors/MISSING_ROLES) | without the `setUri` root role. |
| [`UserRejectedError`](/docs/reference/errors/user-rejected-error) | [`USER_REJECTED`](/docs/reference/errors/USER_REJECTED) | the user rejects the request. |
| [`WalletError`](/docs/reference/errors/wallet-error) | [`CHAIN_MISMATCH`](/docs/reference/errors/CHAIN_MISMATCH), [`ACCOUNT_NOT_FOUND`](/docs/reference/errors/ACCOUNT_NOT_FOUND) | the wallet is on another chain or has no account to sign with. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`WALLET_BATCH_UNSUPPORTED`](/docs/reference/errors/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](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Setting a registry URI"
const { hash } = await ens.registry.setUri({ name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>

<Tab>
```ts title="Setting a registry URI with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.registry.setUri(ens, { name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>

<Tab>
```ts title="Setting a registry URI in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.registry.setUri(ens, { name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `registry.setUri` and sends nothing. See [Preview before sending](/docs/sdk/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` [#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`](/docs/reference/sdk/client#sync-options).

Resolves to `Write.SyncResult`. Receipts plus the submitted hashes and plan.

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Setting a registry URI and waiting"
const { receipt } = await ens.registry.setUriSync({ name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>

<Tab>
```ts title="Waiting with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.registry.setUriSync(ens, { name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>

<Tab>
```ts title="Waiting in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.registry.setUriSync(ens, { name: "alice.eth", uri: "https://alice.dev/names/{id}.json" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`registry.get`](/docs/reference/sdk/registry/get) to read it