Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeHCA

hcaAdmin.setUpgradeApproval

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

Writeexperimental
Since v1.0.0View source

Experimental

@ensforge/hca is experimental: its API can change in a minor release.

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

When to use

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

Signature

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

OptionTypeDefaultDescription
implementation (required)stringHCA implementation.
approved (required)booleantrue to approve, false to revoke.

Also takes the write options.

Returns

Resolves to Write.Result. Submitted transaction hashes and the plan that produced them.

FieldTypeDescription
hashHexHash of the last transaction.
hashesreadonly Hex[]Every submitted transaction, in order.
idstringEIP-5792 bundle id when the calls were sent as one batch.
planPlanThe plan the write executed: its steps, in order, as they were submitted.

Errors

ErrorCodesWhen
InvalidInputErrorINVALID_ADDRESSan invalid address.
HcaErrorHCA_UNAVAILABLEon 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.

Examples

Allowing an upgrade target
const { hash } = await ens.hcaAdmin.setUpgradeApproval({ implementation, approved: true })

Plan methods

Each method takes the same options as hcaAdmin.setUpgradeApproval and sends nothing. See Preview before sending.

MethodDescription
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

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.

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

Allowing an upgrade target and waiting
const { receipt } = await ens.hcaAdmin.setUpgradeApprovalSync({ implementation, approved: true })

Was this page helpful?