hcaAdmin.transferGovernance
Transfers ownership of the HCA factory (factory owner only). Parameters, return value, errors and examples for hcaAdmin.transferGovernance in @ensforge/hca.
Experimental
@ensforge/hca is experimental: its API can change in a minor release.
Transfers ownership of the HCA factory (factory owner only). Resolves once the transaction is submitted.
When to use
Use when governance of HCA deployments moves to another account, e.g. the DAO timelock.
Signature
function transferGovernance(
client: Like,
options: transferGovernance.Options & Write.Options,
): Promise<transferGovernance.ReturnType>Call it as ens.hcaAdmin.transferGovernance(options) on a client, or Actions.hcaAdmin.transferGovernance(client, options).
Parameters
| Option | Type | Default | Description |
|---|---|---|---|
newOwner (required) | string | New factory owner. |
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_ADDRESS | an invalid address. |
HcaError | 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.
Examples
const { hash } = await ens.hcaAdmin.transferGovernance({ newOwner })Plan methods
Each method takes the same options as hcaAdmin.transferGovernance and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
hcaAdmin.transferGovernance.prepare(options) | Builds the plan without sending anything. |
hcaAdmin.transferGovernance.simulate(options) | Simulates the plan with eth_call, reporting each step. |
hcaAdmin.transferGovernance.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with transferGovernanceSync
Transfers ownership of the HCA factory (factory owner only). Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
hcaAdmin.transferGovernanceSync takes the same options plus confirmations and timeout.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.hcaAdmin.transferGovernanceSync({ newOwner })Was this page helpful?