# hcaAdmin.setUpgradeApproval

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

Approves or revokes an implementation in the HCA upgrade set (role holders only). Options, result, errors and examples for hcaAdmin.setUpgradeApproval.

Source: https://ensforge.com/docs/reference/hca/hca-admin/set-upgrade-approval

<ApiMeta kind="Write" stability="experimental" since="1.0.0" source="packages/hca/src/actions/hcaAdmin/setUpgradeApproval/index.ts#L43" />

<Callout type="info" title="Experimental">
`@ensforge/hca` is experimental: its API can change in a minor release.
</Callout>

Approves or revokes an implementation in the HCA upgrade set (role holders only). Resolves once the transaction is submitted.

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

Use when the DAO allows existing HCAs to upgrade to an implementation, or withdraws that.

## Signature [#signature]

```ts
function setUpgradeApproval(
  client: Like,
  options: setUpgradeApproval.Options & Write.Options,
): Promise<setUpgradeApproval.ReturnType>
```

Call it as `ens.hcaAdmin.setUpgradeApproval(options)` on a client, or `Actions.hcaAdmin.setUpgradeApproval(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `implementation` (required) | `string` |  | HCA implementation. |
| `approved` (required) | `boolean` |  | `true` to approve, `false` to revoke. |

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_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS) | an invalid address. |
| [`HcaError`](/docs/reference/errors/hca-error) | [`HCA_UNAVAILABLE`](/docs/reference/errors/HCA_UNAVAILABLE) | on chains without an HCA deployment. |

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="Allowing an upgrade target"
const { hash } = await ens.hcaAdmin.setUpgradeApproval({ implementation, approved: true })
```
</Tab>

<Tab>
```ts title="Allowing an upgrade target with a standalone call"
import { Actions } from "@ensforge/hca"

await Actions.hcaAdmin.setUpgradeApproval(ens, { implementation, approved: true })
```
</Tab>

<Tab>
```ts title="Allowing an upgrade target in an Effect program"
import { Actions } from "@ensforge/hca/effect"

yield* Actions.hcaAdmin.setUpgradeApproval(ens, { implementation, approved: true })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `hcaAdmin.setUpgradeApproval` and sends nothing. See [Preview before sending](/docs/sdk/preview-before-sending).

| Method | Description |
| --- | --- |
| `hcaAdmin.setUpgradeApproval.prepare(options)` | Builds the plan without sending anything. |
| `hcaAdmin.setUpgradeApproval.simulate(options)` | Simulates the plan with `eth_call`, reporting each step. |
| `hcaAdmin.setUpgradeApproval.estimateGas(options)` | Estimates the gas and ETH the plan needs. |

## Wait for the receipt with `setUpgradeApprovalSync` [#wait-for-the-receipt-with-setupgradeapprovalsync]

Approves or revokes an implementation in the HCA upgrade set (role holders only). Resolves once the receipt is in.

Use when the next step depends on the change being on-chain.

`hcaAdmin.setUpgradeApprovalSync` 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="Allowing an upgrade target and waiting"
const { receipt } = await ens.hcaAdmin.setUpgradeApprovalSync({ implementation, approved: true })
```
</Tab>

<Tab>
```ts title="Allowing an upgrade target with a standalone call and waiting"
import { Actions } from "@ensforge/hca"

await Actions.hcaAdmin.setUpgradeApprovalSync(ens, { implementation, approved: true })
```
</Tab>

<Tab>
```ts title="Allowing an upgrade target in an Effect program and waiting"
import { Actions } from "@ensforge/hca/effect"

yield* Actions.hcaAdmin.setUpgradeApprovalSync(ens, { implementation, approved: true })
```
</Tab>
</Tabs>