## @aeternity/aepp-sdk/es/ae/aens Aens module - routines to interact with the æternity naming system The high-level description of the naming system is https://github.com/aeternity/protocol/blob/master/AENS.md in the protocol repository. **Example** ```js import Aens from '@aeternity/aepp-sdk/es/ae/aens' ``` * [@aeternity/aepp-sdk/es/ae/aens](#module_@aeternity/aepp-sdk/es/ae/aens) * [Aens([options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--Aens) ⇒ `Object` ⏏ * _instance_ * [.update(nameId, target, options)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--update) ⇒ `Object` ⏏ * [.query(name)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--query) ⇒ `Promise.<Object>` ⏏ * [.claim(name, salt, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--claim) ⇒ `Promise.<Object>` ⏏ * [.preclaim(name, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--preclaim) ⇒ `Promise.<Object>` ⏏ * _async_ * [.transfer(nameId, account, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--transfer) ⇒ `Promise.<Object>` ⏏ * [.revoke(nameId, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--revoke) ⇒ `Promise.<Object>` ⏏ ### Aens([options]) ⇒ `Object` ⏏ Aens Stamp Aens provides name-system related methods atop [Ae](#exp_module_@aeternity/aepp-sdk/es/ae--Ae) clients. **Kind**: Exported function **Returns**: `Object` - Aens instance **rtype**: `Stamp` | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | `Object` | {} | Initializer object | ### .update(nameId, target, options) ⇒ `Object` ⏏ Update an aens entry **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) | Param | Description | | --- | --- | | nameId | domain hash | | target | new target | | options | | ### .query(name) ⇒ `Promise.<Object>` ⏏ Query the status of an AENS registration **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) | Param | Type | | --- | --- | | name | `string` | ### .claim(name, salt, [options]) ⇒ `Promise.<Object>` ⏏ Claim a previously preclaimed registration. This can only be done after the preclaim step **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) **Returns**: `Promise.<Object>` - the result of the claim | Param | Type | Default | | --- | --- | --- | | name | `String` | | | salt | `String` | | | [options] | `Record` | {} | ### .preclaim(name, [options]) ⇒ `Promise.<Object>` ⏏ Preclaim a name. Sends a hash of the name and a random salt to the node **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) | Param | Type | Default | | --- | --- | --- | | name | `string` | | | [options] | `Record` | {} | ### .transfer(nameId, account, [options]) ⇒ `Promise.<Object>` ⏏ Transfer a domain to another account **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) **Category**: async | Param | Type | Default | | --- | --- | --- | | nameId | `String` | | | account | `String` | | | [options] | `Object` | {} | ### .revoke(nameId, [options]) ⇒ `Promise.<Object>` ⏏ Revoke a domain **Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens) **Category**: async | Param | Type | Default | | --- | --- | --- | | nameId | `String` | | | [options] | `Object` | {} |