# SDK

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

Browse every action of @ensforge/sdk by domain, with the client, batching, utilities and indexers it exports, each with its signature and examples.

Source: https://ensforge.com/docs/reference/sdk

<ApiMeta summary="90 actions · 16 domains" since="1.0.0" source="packages/sdk/src" />

Every action of `@ensforge/sdk`, by domain. Each page lists its signature, options, result, errors and examples.

<Cards>
<Card title="Client" href="/docs/reference/sdk/client" description="Ensforge.create, the action groups, and the read, write and plan option types." />

<Card title="batch" href="/docs/reference/sdk/batch" description="Runs several reads together, in as few round trips as possible." />

<Card title="Utilities" href="/docs/reference/sdk/utilities" description="Name, coin type, content hash, duration, fuse, role and error helpers." />

<Card title="Indexers" href="/docs/reference/sdk/indexers" description="The indexers, query options and result types of @ensforge/sdk/indexer." />
</Cards>

## [approval](/docs/reference/sdk/approval) [#approval]

| Action | Description |
| --- | --- |
| [`getDelegate`](/docs/reference/sdk/approval/get-delegate) (batchable) | Checks whether a delegate may edit a name's records on its public resolver (`isApprovedFor`). |
| [`getOperator`](/docs/reference/sdk/approval/get-operator) (batchable) | Checks whether an operator may manage everything an owner holds on an ENS contract (`isApprovedForAll`). |
| [`getToken`](/docs/reference/sdk/approval/get-token) (batchable) | Reads the address approved to transfer one ENSv1 name token (`getApproved`). |
| [`setDelegate`](/docs/reference/sdk/approval/set-delegate) | Approves or revokes a delegate who may edit a name's records on its public resolver. |
| [`setOperator`](/docs/reference/sdk/approval/set-operator) | Approves or revokes an operator for everything the signer holds on an ENS contract (`setApprovalForAll`). |
| [`setToken`](/docs/reference/sdk/approval/set-token) | Approves one address to transfer one ENSv1 name token, or clears the approval. |

## [dns](/docs/reference/sdk/dns) [#dns]

| Action | Description |
| --- | --- |
| [`claim`](/docs/reference/sdk/dns/claim) | Imports a DNS name into ENS with a DNSSEC proof of its `_ens` TXT record. |
| [`getOffchainResolver`](/docs/reference/sdk/dns/get-offchain-resolver) (batchable) | Reads the gasless DNS resolver a DNS name sets in an `ENS1` TXT record. |
| [`getProof`](/docs/reference/sdk/dns/get-proof) (batchable) | Fetches the DNSSEC proof of a DNS name's `_ens` TXT record. |
| [`getRecords`](/docs/reference/sdk/dns/get-records) (batchable) | Reads DNS records and the zonehash a name stores on its resolver. |
| [`getStatus`](/docs/reference/sdk/dns/get-status) (batchable) | Reads whether a DNS name is imported into ENS, and what it needs to be. |
| [`setRecords`](/docs/reference/sdk/dns/set-records) | Sets DNS records or the zonehash of a name on its public resolver. |

## [event](/docs/reference/sdk/event) [#event]

| Action | Description |
| --- | --- |
| [`decode`](/docs/reference/sdk/event/decode) (batchable) | Normalizes the ENS events in logs or transaction receipts. |
| [`get`](/docs/reference/sdk/event/get) (batchable) | Reads the ENS events of one name over a block range, across ENSv1 and ENSv2. |
| [`watch`](/docs/reference/sdk/event/watch) | Watches one name's ENS events as new blocks arrive. |

## [indexer](/docs/reference/sdk/indexer) [#indexer]

| Action | Description |
| --- | --- |
| [`getEvents`](/docs/reference/sdk/indexer/get-events) (batchable) | Searches indexed ENS events by name, address, resolver, contract or block range. |
| [`getHistory`](/docs/reference/sdk/indexer/get-history) (batchable) | Reads the full history of a name, or of every name an address is related to. |
| [`getName`](/docs/reference/sdk/indexer/get-name) (batchable) | Reads one name from the indexer: owner, manager, expiry, resolver, records and protocol. |
| [`getNamesByExpiry`](/docs/reference/sdk/indexer/get-names-by-expiry) (batchable) | Lists names by when they expire or leave their grace period. |
| [`getNamesForAddress`](/docs/reference/sdk/indexer/get-names-for-address) (batchable) | Lists the names an address owns, manages, holds roles on, resolves to, or used to own. |
| [`getNamespace`](/docs/reference/sdk/indexer/get-namespace) (batchable) | Reads what the indexer serves for a namespace: its networks and which features are complete. |
| [`getPermissions`](/docs/reference/sdk/indexer/get-permissions) (batchable) | Lists who can do what over a name, a registration, an account or an ENSv2 registry. |
| [`getPrimaryName`](/docs/reference/sdk/indexer/get-primary-name) (batchable) | Reads an address's primary name from the indexer, verified on-chain when the indexer can. |
| [`getRecords`](/docs/reference/sdk/indexer/get-records) (batchable) | Reads a name's records and its record inventory from the indexer. |
| [`getRegistry`](/docs/reference/sdk/indexer/get-registry) (batchable) | Reads an ENSv2 registry: the name it serves, its parent registry, when it was created and its counts. |
| [`getRegistryLabels`](/docs/reference/sdk/indexer/get-registry-labels) (batchable) | Lists the labels of an ENSv2 registry, optionally only those an address holds or does not hold. |
| [`getResolver`](/docs/reference/sdk/indexer/get-resolver) (batchable) | Reads a resolver and one page of the names bound to it. |
| [`getResolverLinks`](/docs/reference/sdk/indexer/get-resolver-links) (batchable) | Lists the names linked to record sets on an ENSv2 resolver. |
| [`getResolverRoles`](/docs/reference/sdk/indexer/get-resolver-roles) (batchable) | Lists the role grants on an ENSv2 resolver. |
| [`getResolvers`](/docs/reference/sdk/indexer/get-resolvers) (batchable) | Lists the ENSv2 resolvers on which an address holds roles. |
| [`getStatus`](/docs/reference/sdk/indexer/get-status) (batchable) | Reads the indexer's health and how far each chain is indexed. |
| [`getSubnames`](/docs/reference/sdk/indexer/get-subnames) (batchable) | Lists the direct subnames of a name. |
| [`lookup`](/docs/reference/sdk/indexer/lookup) (batchable) | Reads up to 1,000 names and addresses in one request. |
| [`search`](/docs/reference/sdk/indexer/search) (batchable) | Searches names by text. |

## [migration](/docs/reference/sdk/migration) [#migration]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/migration/get) (batchable) | Reads whether an ENSv1 name can migrate to ENSv2, how, and what it becomes. |
| [`migrate`](/docs/reference/sdk/migration/migrate) | Migrates one or more ENSv1 names to ENSv2, carrying their resolver records and subnames. |

## [name](/docs/reference/sdk/name) [#name]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/name/get) (batchable) | Reads the full state of a name across ENSv1 and ENSv2: where it lives, who owns it, its resolver, expiry and whether it can be registered or renewed. |
| [`getLabel`](/docs/reference/sdk/name/get-label) (batchable) | Recovers a label from its labelhash through the ENSv2 LabelStore. |
| [`reclaim`](/docs/reference/sdk/name/reclaim) | Resets the ENSv1 registry owner (manager) of an unwrapped `.eth` name, as its registrant. |
| [`setManager`](/docs/reference/sdk/name/set-manager) | Sets the ENSv1 manager (registry owner) of a name. |
| [`setTtl`](/docs/reference/sdk/name/set-ttl) | Sets the ENSv1 registry TTL of a name. |
| [`transfer`](/docs/reference/sdk/name/transfer) | Sends a name to another account and resolves once the transaction is submitted. |

## [permission](/docs/reference/sdk/permission) [#permission]

| Action | Description |
| --- | --- |
| [`check`](/docs/reference/sdk/permission/check) (batchable) | Checks whether an account may perform one operation on an ENS name, and lists exactly what it lacks when it may not. |
| [`get`](/docs/reference/sdk/permission/get) (batchable) | Reads what an account may do with an ENS name: transfer it, change its resolver, edit records, create subnames and more, across ENSv1 ownership and ENSv2 roles. |
| [`setRecordAccess`](/docs/reference/sdk/permission/set-record-access) | Lets another account edit a name's records, or takes that access back. |

## [plan](/docs/reference/sdk/plan) [#plan]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/plan/get) (batchable) | Reads a saved plan and its progress. |
| [`list`](/docs/reference/sdk/plan/list) (batchable) | Lists the saved plans of this client's chain and of its `chains`, newest first. |
| [`reconcile`](/docs/reference/sdk/plan/reconcile) (batchable) | Records a transaction sent outside ensforge as a plan step's submission. |
| [`resume`](/docs/reference/sdk/plan/resume) | Continues a saved plan after a failure or a reload. |
| [`send`](/docs/reference/sdk/plan/send) | Sends any plan: one prepared by a write's `.prepare`, or several combined with `Plan.merge`. |

## [primaryName](/docs/reference/sdk/primary-name) [#primaryname]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/primary-name/get) (batchable) | Reads the primary name of an address (ENSIP-19 reverse resolution), verified against the name's address record. |
| [`set`](/docs/reference/sdk/primary-name/set) | Sets or clears the primary name (reverse record) of an address. |
| [`signClaim`](/docs/reference/sdk/primary-name/sign-claim) | Signs a claim to a primary name on one or more L2s, with one signature and no transaction. |

## [record](/docs/reference/sdk/record) [#record]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/record/get) (batchable) | Reads any mix of a name's records in one request: texts, addresses, content hash, ABI, public key, name record, interface implementers and data records. |
| [`getAddress`](/docs/reference/sdk/record/get-address) (batchable) | Reads one address record of an ENS name, for Ethereum by default or any coin (ENSIP-9, ENSIP-11). |
| [`getAvatar`](/docs/reference/sdk/record/get-avatar) (batchable) | Reads the avatar of an ENS name and resolves it to a URL a browser can load (ENSIP-12). |
| [`getContentHash`](/docs/reference/sdk/record/get-content-hash) (batchable) | Reads the content hash of an ENS name (ENSIP-7), decoded into its protocol, value and URI. |
| [`getText`](/docs/reference/sdk/record/get-text) (batchable) | Reads one text record of an ENS name, such as `url`, `avatar` or `com.twitter`. |
| [`set`](/docs/reference/sdk/record/set) | Writes records of an ENS name and resolves once the transaction is submitted. |

## [registration](/docs/reference/sdk/registration) [#registration]

| Action | Description |
| --- | --- |
| [`commit`](/docs/reference/sdk/registration/commit) | Commits to registering `.eth` names, the first half of a registration. |
| [`getCommitmentStatus`](/docs/reference/sdk/registration/get-commitment-status) (batchable) | Reads where a registration commitment is in its window. |
| [`getParameters`](/docs/reference/sdk/registration/get-parameters) (batchable) | Reads the `.eth` registration settings: contracts, commitment window, minimum duration, grace period and accepted payment tokens. |
| [`getPrice`](/docs/reference/sdk/registration/get-price) (batchable) | Quotes the price of registering a `.eth` name, in an ERC-20 payment token. |
| [`getRenewalPrice`](/docs/reference/sdk/registration/get-renewal-price) (batchable) | Quotes renewing one or more `.eth` names, in an ERC-20 payment token. |
| [`isAvailable`](/docs/reference/sdk/registration/is-available) (batchable) | Checks whether a `.eth` name can be registered now. |
| [`register`](/docs/reference/sdk/registration/register) | Registers one or more `.eth` names: approve, commit, wait, register, then records and primary name. |
| [`renew`](/docs/reference/sdk/registration/renew) | Renews one or more `.eth` names, ENSv1 or ENSv2, paying in an ERC-20 token. |

## [registry](/docs/reference/sdk/registry) [#registry]

| Action | Description |
| --- | --- |
| [`attach`](/docs/reference/sdk/registry/attach) | Sets or removes the subregistry of an ENSv2 name. |
| [`deploy`](/docs/reference/sdk/registry/deploy) | Deploys an ENSv2 UserRegistry, optionally attaching it as a name's subregistry. |
| [`get`](/docs/reference/sdk/registry/get) (batchable) | Reads an ENSv2 registry: its kind, implementation, parent, canonical name, URI, whether it is emancipated, and whether it can be upgraded. |
| [`setUri`](/docs/reference/sdk/registry/set-uri) | Sets the metadata URI of an ENSv2 registry. |
| [`upgrade`](/docs/reference/sdk/registry/upgrade) | Upgrades an ENSv2 registry to the deployment's latest implementation. |

## [resolver](/docs/reference/sdk/resolver) [#resolver]

| Action | Description |
| --- | --- |
| [`create`](/docs/reference/sdk/resolver/create) | Deploys an ENSv2 PermissionedResolver, optionally with records, and points a name at it. |
| [`get`](/docs/reference/sdk/resolver/get) (batchable) | Reads the resolver of an ENS name: its address, what kind of resolver it is, who may write to it and which record profiles it supports. |
| [`getLink`](/docs/reference/sdk/resolver/get-link) (batchable) | Reads which record set an ENS name uses on its PermissionedResolver. |
| [`link`](/docs/reference/sdk/resolver/link) | Links an ENS name to the records of another name on the same PermissionedResolver. |
| [`resolve`](/docs/reference/sdk/resolver/resolve) (batchable) | Calls the resolver of an ENS name with raw calldata through the Universal Resolver (ENSIP-10). |
| [`set`](/docs/reference/sdk/resolver/set) | Points an ENS name at a resolver. |
| [`upgrade`](/docs/reference/sdk/resolver/upgrade) | Upgrades the PermissionedResolver of an ENS name to a newer implementation. |

## [role](/docs/reference/sdk/role) [#role]

| Action | Description |
| --- | --- |
| [`get`](/docs/reference/sdk/role/get) (batchable) | Reads the ENSv2 roles an account holds on a name, or at the root of a registry or resolver. |
| [`grant`](/docs/reference/sdk/role/grant) | Grants ENSv2 roles to an account on a name, or at the root of a registry or resolver. |
| [`revoke`](/docs/reference/sdk/role/revoke) | Revokes ENSv2 roles from an account on a name, or at the root of a registry or resolver. |

## [subname](/docs/reference/sdk/subname) [#subname]

| Action | Description |
| --- | --- |
| [`create`](/docs/reference/sdk/subname/create) | Creates a subname, routed by its parent: an ENSv2 subregistry, the ENSv1 registry or the NameWrapper. |
| [`remove`](/docs/reference/sdk/subname/remove) | Removes a subname. |
| [`update`](/docs/reference/sdk/subname/update) | Changes a subname from its parent: owner, resolver or expiry, in one plan. |

## [wrapper](/docs/reference/sdk/wrapper) [#wrapper]

| Action | Description |
| --- | --- |
| [`getFuses`](/docs/reference/sdk/wrapper/get-fuses) (batchable) | Reads the NameWrapper owner, fuses and expiry of an ENSv1 name. |
| [`setChildFuses`](/docs/reference/sdk/wrapper/set-child-fuses) | Burns fuses on, or extends, a wrapped ENSv1 subname as its parent's owner. |
| [`setFuses`](/docs/reference/sdk/wrapper/set-fuses) | Burns owner-controlled fuses on a wrapped ENSv1 name. |
| [`unwrap`](/docs/reference/sdk/wrapper/unwrap) | Unwraps an ENSv1 name from the NameWrapper. |
| [`wrap`](/docs/reference/sdk/wrapper/wrap) | Wraps an ENSv1 name in the NameWrapper. |